Пакетная служба Microsoft.BatchAccounts 2023-05-01

Определение ресурсов Bicep

Тип ресурса batchAccounts можно развернуть с помощью операций, целевых:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.Batch/batchAccounts, добавьте следующий Bicep в шаблон.

resource symbolicname 'Microsoft.Batch/batchAccounts@2023-05-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    allowedAuthenticationModes: [
      'string'
    ]
    autoStorage: {
      authenticationMode: 'string'
      nodeIdentityReference: {
        resourceId: 'string'
      }
      storageAccountId: 'string'
    }
    encryption: {
      keySource: 'string'
      keyVaultProperties: {
        keyIdentifier: 'string'
      }
    }
    keyVaultReference: {
      id: 'string'
      url: 'string'
    }
    networkProfile: {
      accountAccess: {
        defaultAction: 'string'
        ipRules: [
          {
            action: 'Allow'
            value: 'string'
          }
        ]
      }
      nodeManagementAccess: {
        defaultAction: 'string'
        ipRules: [
          {
            action: 'Allow'
            value: 'string'
          }
        ]
      }
    }
    poolAllocationMode: 'string'
    publicNetworkAccess: 'string'
  }
}

Значения свойств

batchAccounts

Имя Описание Ценность
имя Имя ресурса строка (обязательно)

Ограничение символов: 3–24

Допустимые символы:
Строчные буквы и цифры.
местоположение Регион, в котором создается учетная запись. строка (обязательно)
Теги Указанные пользователем теги, связанные с учетной записью. Словарь имен и значений тегов. См. теги в шаблонах
тождество Удостоверение учетной записи пакетной службы. BatchAccountIdentity
свойства Свойства учетной записи пакетной службы. BatchAccountCreatePropertiesOrBatchAccountProperties

BatchAccountIdentity

Имя Описание Ценность
тип Тип удостоверения, используемого для учетной записи пакетной службы. "Нет"
SystemAssigned
UserAssigned (обязательно)
userAssignedIdentities Список удостоверений пользователей, связанных с учетной записью пакетной службы. BatchAccountIdentityUserAssignedIdentities

BatchAccountIdentityUserAssignedIdentities

Имя Описание Ценность
{настраиваемое свойство} UserAssignedIdentities

UserAssignedIdentities

Этот объект не содержит свойств, заданных во время развертывания. Все свойства — ReadOnly.

BatchAccountCreatePropertiesOrBatchAccountProperties

Имя Описание Ценность
allowedAuthenticationModes Список разрешенных режимов проверки подлинности для учетной записи пакетной службы, которую можно использовать для проверки подлинности с помощью плоскости данных. Это не влияет на проверку подлинности с помощью плоскости управления. Массив строк, содержащий любой из:
AAD
SharedKey
TaskAuthenticationToken
autoStorage Свойства, связанные с учетной записью автоматического хранения. AutoStorageBasePropertiesOrAutoStorageProperties
шифрование Настраивает шифрование данных клиента в учетной записи пакетной службы. По умолчанию учетные записи шифруются с помощью управляемого ключа Майкрософт. Для дополнительного управления вместо этого можно использовать управляемый клиентом ключ. EncryptionProperties
keyVaultReference Ссылка на хранилище ключей Azure, связанное с учетной записью пакетной службы. KeyVaultReference
networkProfile Сетевой профиль действует только при включении publicNetworkAccess. NetworkProfile
poolAllocationMode Режим выделения пула также влияет на то, как клиенты могут проходить проверку подлинности в API пакетной службы. Если режим — BatchService, клиенты могут пройти проверку подлинности с помощью ключей доступа или Azure Active Directory. Если режим — UserSubscription, клиенты должны использовать Azure Active Directory. Значением по умолчанию является BatchService. BatchService
UserSubscription
publicNetworkAccess Если значение не указано, значение по умолчанию "включено". "Отключено"
"Включено"

AutoStorageBasePropertiesOrAutoStorageProperties

Имя Описание Ценность
authenticationMode Режим проверки подлинности, используемый пакетной службой для управления учетной записью автоматического хранения. BatchAccountManagedIdentity
StorageKeys
nodeIdentityReference Удостоверение, на которое ссылается здесь, должно быть назначено пулам, имеющим вычислительные узлы, которым требуется доступ к автоматическому хранилищу. ComputeNodeIdentityReference
storageAccountId Идентификатор ресурса учетной записи хранения, используемой для учетной записи автоматического хранения. строка (обязательно)

ComputeNodeIdentityReference

Имя Описание Ценность
resourceId Идентификатор ресурса ARM назначенного пользователем удостоверения. струна

EncryptionProperties

Имя Описание Ценность
keySource Тип источника ключа. Microsoft.Batch
Microsoft.KeyVault
keyVaultProperties Дополнительные сведения об использовании Microsoft.KeyVault KeyVaultProperties

KeyVaultProperties

Имя Описание Ценность
keyIdentifier Полный путь к секрету с версией или без нее. Пример https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. или https://mykeyvault.vault.azure.net/keys/testkey. Чтобы обеспечить удобство использования следующих предварительных требований, необходимо выполнить следующее:

У учетной записи пакетной службы есть удостоверение, назначенное системой
Удостоверение учетной записи было предоставлено разрешения key/Get, Key/Unwrap and Key/Wrap
KeyVault включает обратимое удаление и защиту очистки
струна

KeyVaultReference

Имя Описание Ценность
идентификатор Идентификатор ресурса хранилища ключей Azure, связанного с учетной записью пакетной службы. строка (обязательно)
URL-адрес URL-адрес хранилища ключей Azure, связанного с учетной записью пакетной службы. строка (обязательно)

NetworkProfile

Имя Описание Ценность
accountAccess Профиль сетевого доступа для конечной точки batchAccount (API плоскости данных пакетной службы). EndpointAccessProfile
nodeManagementAccess Профиль сетевого доступа для конечной точки nodeManagement (пакетная служба управляет вычислительными узлами для пулов пакетной службы). EndpointAccessProfile

EndpointAccessProfile

Имя Описание Ценность
defaultAction Действие по умолчанию для доступа к конечной точке. Применимо только при включении publicNetworkAccess. "Разрешить"
"Запрет" (обязательно)
ipRules Массив диапазонов IP-адресов для фильтрации IP-адреса клиента. IPRule[]

IPRule

Имя Описание Ценность
действие Действие при сопоставлении IP-адреса клиента. "Разрешить" (обязательно)
ценность IPv4-адрес или диапазон адресов IPv4 в формате CIDR. строка (обязательно)

Шаблоны быстрого запуска

Следующие шаблоны быстрого запуска развертывают этот тип ресурса.

Шаблон Описание
пул пакетной службы Azure без общедоступных IP-адресов

развертывание в Azure
Этот шаблон создает упрощенный пул обмена данными с узлами пакетной службы Azure без общедоступных IP-адресов.
Создание учетной записи пакетной службы с помощью шаблона

развертывание в Azure
Этот шаблон создает учетную запись пакетной службы и учетную запись хранения.

Определение ресурса шаблона ARM

Тип ресурса batchAccounts можно развернуть с помощью операций, целевых:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.Batch/batchAccounts, добавьте следующий код JSON в шаблон.

{
  "type": "Microsoft.Batch/batchAccounts",
  "apiVersion": "2023-05-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "allowedAuthenticationModes": [ "string" ],
    "autoStorage": {
      "authenticationMode": "string",
      "nodeIdentityReference": {
        "resourceId": "string"
      },
      "storageAccountId": "string"
    },
    "encryption": {
      "keySource": "string",
      "keyVaultProperties": {
        "keyIdentifier": "string"
      }
    },
    "keyVaultReference": {
      "id": "string",
      "url": "string"
    },
    "networkProfile": {
      "accountAccess": {
        "defaultAction": "string",
        "ipRules": [
          {
            "action": "Allow",
            "value": "string"
          }
        ]
      },
      "nodeManagementAccess": {
        "defaultAction": "string",
        "ipRules": [
          {
            "action": "Allow",
            "value": "string"
          }
        ]
      }
    },
    "poolAllocationMode": "string",
    "publicNetworkAccess": "string"
  }
}

Значения свойств

batchAccounts

Имя Описание Ценность
тип Тип ресурса "Microsoft.Batch/batchAccounts"
apiVersion Версия API ресурсов '2023-05-01'
имя Имя ресурса строка (обязательно)

Ограничение символов: 3–24

Допустимые символы:
Строчные буквы и цифры.
местоположение Регион, в котором создается учетная запись. строка (обязательно)
Теги Указанные пользователем теги, связанные с учетной записью. Словарь имен и значений тегов. См. теги в шаблонах
тождество Удостоверение учетной записи пакетной службы. BatchAccountIdentity
свойства Свойства учетной записи пакетной службы. BatchAccountCreatePropertiesOrBatchAccountProperties

BatchAccountIdentity

Имя Описание Ценность
тип Тип удостоверения, используемого для учетной записи пакетной службы. "Нет"
SystemAssigned
UserAssigned (обязательно)
userAssignedIdentities Список удостоверений пользователей, связанных с учетной записью пакетной службы. BatchAccountIdentityUserAssignedIdentities

BatchAccountIdentityUserAssignedIdentities

Имя Описание Ценность
{настраиваемое свойство} UserAssignedIdentities

UserAssignedIdentities

Этот объект не содержит свойств, заданных во время развертывания. Все свойства — ReadOnly.

BatchAccountCreatePropertiesOrBatchAccountProperties

Имя Описание Ценность
allowedAuthenticationModes Список разрешенных режимов проверки подлинности для учетной записи пакетной службы, которую можно использовать для проверки подлинности с помощью плоскости данных. Это не влияет на проверку подлинности с помощью плоскости управления. Массив строк, содержащий любой из:
AAD
SharedKey
TaskAuthenticationToken
autoStorage Свойства, связанные с учетной записью автоматического хранения. AutoStorageBasePropertiesOrAutoStorageProperties
шифрование Настраивает шифрование данных клиента в учетной записи пакетной службы. По умолчанию учетные записи шифруются с помощью управляемого ключа Майкрософт. Для дополнительного управления вместо этого можно использовать управляемый клиентом ключ. EncryptionProperties
keyVaultReference Ссылка на хранилище ключей Azure, связанное с учетной записью пакетной службы. KeyVaultReference
networkProfile Сетевой профиль действует только при включении publicNetworkAccess. NetworkProfile
poolAllocationMode Режим выделения пула также влияет на то, как клиенты могут проходить проверку подлинности в API пакетной службы. Если режим — BatchService, клиенты могут пройти проверку подлинности с помощью ключей доступа или Azure Active Directory. Если режим — UserSubscription, клиенты должны использовать Azure Active Directory. Значением по умолчанию является BatchService. BatchService
UserSubscription
publicNetworkAccess Если значение не указано, значение по умолчанию "включено". "Отключено"
"Включено"

AutoStorageBasePropertiesOrAutoStorageProperties

Имя Описание Ценность
authenticationMode Режим проверки подлинности, используемый пакетной службой для управления учетной записью автоматического хранения. BatchAccountManagedIdentity
StorageKeys
nodeIdentityReference Удостоверение, на которое ссылается здесь, должно быть назначено пулам, имеющим вычислительные узлы, которым требуется доступ к автоматическому хранилищу. ComputeNodeIdentityReference
storageAccountId Идентификатор ресурса учетной записи хранения, используемой для учетной записи автоматического хранения. строка (обязательно)

ComputeNodeIdentityReference

Имя Описание Ценность
resourceId Идентификатор ресурса ARM назначенного пользователем удостоверения. струна

EncryptionProperties

Имя Описание Ценность
keySource Тип источника ключа. Microsoft.Batch
Microsoft.KeyVault
keyVaultProperties Дополнительные сведения об использовании Microsoft.KeyVault KeyVaultProperties

KeyVaultProperties

Имя Описание Ценность
keyIdentifier Полный путь к секрету с версией или без нее. Пример https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. или https://mykeyvault.vault.azure.net/keys/testkey. Чтобы обеспечить удобство использования следующих предварительных требований, необходимо выполнить следующее:

У учетной записи пакетной службы есть удостоверение, назначенное системой
Удостоверение учетной записи было предоставлено разрешения key/Get, Key/Unwrap and Key/Wrap
KeyVault включает обратимое удаление и защиту очистки
струна

KeyVaultReference

Имя Описание Ценность
идентификатор Идентификатор ресурса хранилища ключей Azure, связанного с учетной записью пакетной службы. строка (обязательно)
URL-адрес URL-адрес хранилища ключей Azure, связанного с учетной записью пакетной службы. строка (обязательно)

NetworkProfile

Имя Описание Ценность
accountAccess Профиль сетевого доступа для конечной точки batchAccount (API плоскости данных пакетной службы). EndpointAccessProfile
nodeManagementAccess Профиль сетевого доступа для конечной точки nodeManagement (пакетная служба управляет вычислительными узлами для пулов пакетной службы). EndpointAccessProfile

EndpointAccessProfile

Имя Описание Ценность
defaultAction Действие по умолчанию для доступа к конечной точке. Применимо только при включении publicNetworkAccess. "Разрешить"
"Запрет" (обязательно)
ipRules Массив диапазонов IP-адресов для фильтрации IP-адреса клиента. IPRule[]

IPRule

Имя Описание Ценность
действие Действие при сопоставлении IP-адреса клиента. "Разрешить" (обязательно)
ценность IPv4-адрес или диапазон адресов IPv4 в формате CIDR. строка (обязательно)

Шаблоны быстрого запуска

Следующие шаблоны быстрого запуска развертывают этот тип ресурса.

Шаблон Описание
пул пакетной службы Azure без общедоступных IP-адресов

развертывание в Azure
Этот шаблон создает упрощенный пул обмена данными с узлами пакетной службы Azure без общедоступных IP-адресов.
Создание учетной записи пакетной службы с помощью шаблона

развертывание в Azure
Этот шаблон создает учетную запись пакетной службы и учетную запись хранения.

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса batchAccounts можно развернуть с помощью операций, целевых:

  • групп ресурсов

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.Batch/batchAccounts, добавьте следующий объект Terraform в шаблон.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Batch/batchAccounts@2023-05-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      allowedAuthenticationModes = [
        "string"
      ]
      autoStorage = {
        authenticationMode = "string"
        nodeIdentityReference = {
          resourceId = "string"
        }
        storageAccountId = "string"
      }
      encryption = {
        keySource = "string"
        keyVaultProperties = {
          keyIdentifier = "string"
        }
      }
      keyVaultReference = {
        id = "string"
        url = "string"
      }
      networkProfile = {
        accountAccess = {
          defaultAction = "string"
          ipRules = [
            {
              action = "Allow"
              value = "string"
            }
          ]
        }
        nodeManagementAccess = {
          defaultAction = "string"
          ipRules = [
            {
              action = "Allow"
              value = "string"
            }
          ]
        }
      }
      poolAllocationMode = "string"
      publicNetworkAccess = "string"
    }
  })
}

Значения свойств

batchAccounts

Имя Описание Ценность
тип Тип ресурса "Microsoft.Batch/batchAccounts@2023-05-01"
имя Имя ресурса строка (обязательно)

Ограничение символов: 3–24

Допустимые символы:
Строчные буквы и цифры.
местоположение Регион, в котором создается учетная запись. строка (обязательно)
parent_id Чтобы развернуть в группе ресурсов, используйте идентификатор этой группы ресурсов. строка (обязательно)
Теги Указанные пользователем теги, связанные с учетной записью. Словарь имен и значений тегов.
тождество Удостоверение учетной записи пакетной службы. BatchAccountIdentity
свойства Свойства учетной записи пакетной службы. BatchAccountCreatePropertiesOrBatchAccountProperties

BatchAccountIdentity

Имя Описание Ценность
тип Тип удостоверения, используемого для учетной записи пакетной службы. SystemAssigned
UserAssigned (обязательно)
identity_ids Список удостоверений пользователей, связанных с учетной записью пакетной службы. Массив идентификаторов удостоверений пользователя.

BatchAccountIdentityUserAssignedIdentities

Имя Описание Ценность
{настраиваемое свойство} UserAssignedIdentities

UserAssignedIdentities

Этот объект не содержит свойств, заданных во время развертывания. Все свойства — ReadOnly.

BatchAccountCreatePropertiesOrBatchAccountProperties

Имя Описание Ценность
allowedAuthenticationModes Список разрешенных режимов проверки подлинности для учетной записи пакетной службы, которую можно использовать для проверки подлинности с помощью плоскости данных. Это не влияет на проверку подлинности с помощью плоскости управления. Массив строк, содержащий любой из:
AAD
SharedKey
TaskAuthenticationToken
autoStorage Свойства, связанные с учетной записью автоматического хранения. AutoStorageBasePropertiesOrAutoStorageProperties
шифрование Настраивает шифрование данных клиента в учетной записи пакетной службы. По умолчанию учетные записи шифруются с помощью управляемого ключа Майкрософт. Для дополнительного управления вместо этого можно использовать управляемый клиентом ключ. EncryptionProperties
keyVaultReference Ссылка на хранилище ключей Azure, связанное с учетной записью пакетной службы. KeyVaultReference
networkProfile Сетевой профиль действует только при включении publicNetworkAccess. NetworkProfile
poolAllocationMode Режим выделения пула также влияет на то, как клиенты могут проходить проверку подлинности в API пакетной службы. Если режим — BatchService, клиенты могут пройти проверку подлинности с помощью ключей доступа или Azure Active Directory. Если режим — UserSubscription, клиенты должны использовать Azure Active Directory. Значением по умолчанию является BatchService. BatchService
UserSubscription
publicNetworkAccess Если значение не указано, значение по умолчанию "включено". "Отключено"
"Включено"

AutoStorageBasePropertiesOrAutoStorageProperties

Имя Описание Ценность
authenticationMode Режим проверки подлинности, используемый пакетной службой для управления учетной записью автоматического хранения. BatchAccountManagedIdentity
"StorageKeys"
nodeIdentityReference Удостоверение, на которое ссылается здесь, должно быть назначено пулам, имеющим вычислительные узлы, которым требуется доступ к автоматическому хранилищу. ComputeNodeIdentityReference
storageAccountId Идентификатор ресурса учетной записи хранения, используемой для учетной записи автоматического хранения. строка (обязательно)

ComputeNodeIdentityReference

Имя Описание Ценность
resourceId Идентификатор ресурса ARM назначенного пользователем удостоверения. струна

EncryptionProperties

Имя Описание Ценность
keySource Тип источника ключа. "Microsoft.Batch"
"Microsoft.KeyVault"
keyVaultProperties Дополнительные сведения об использовании Microsoft.KeyVault KeyVaultProperties

KeyVaultProperties

Имя Описание Ценность
keyIdentifier Полный путь к секрету с версией или без нее. Пример https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. или https://mykeyvault.vault.azure.net/keys/testkey. Чтобы обеспечить удобство использования следующих предварительных требований, необходимо выполнить следующее:

У учетной записи пакетной службы есть удостоверение, назначенное системой
Удостоверение учетной записи было предоставлено разрешения key/Get, Key/Unwrap and Key/Wrap
KeyVault включает обратимое удаление и защиту очистки
струна

KeyVaultReference

Имя Описание Ценность
идентификатор Идентификатор ресурса хранилища ключей Azure, связанного с учетной записью пакетной службы. строка (обязательно)
URL-адрес URL-адрес хранилища ключей Azure, связанного с учетной записью пакетной службы. строка (обязательно)

NetworkProfile

Имя Описание Ценность
accountAccess Профиль сетевого доступа для конечной точки batchAccount (API плоскости данных пакетной службы). EndpointAccessProfile
nodeManagementAccess Профиль сетевого доступа для конечной точки nodeManagement (пакетная служба управляет вычислительными узлами для пулов пакетной службы). EndpointAccessProfile

EndpointAccessProfile

Имя Описание Ценность
defaultAction Действие по умолчанию для доступа к конечной точке. Применимо только при включении publicNetworkAccess. "Разрешить"
"Запретить" (обязательно)
ipRules Массив диапазонов IP-адресов для фильтрации IP-адреса клиента. IPRule[]

IPRule

Имя Описание Ценность
действие Действие при сопоставлении IP-адреса клиента. "Разрешить" (обязательно)
ценность IPv4-адрес или диапазон адресов IPv4 в формате CIDR. строка (обязательно)