Compartir a través de


Microsoft.Batch BatchAccounts 2023-05-01

Definición de recursos de Bicep

El tipo de recurso batchAccounts se puede implementar con operaciones destinadas a:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.Batch/batchAccounts, agregue la siguiente bicep a la plantilla.

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'
  }
}

Valores de propiedad

batchAccounts

Nombre Descripción Valor
nombre El nombre del recurso string (obligatorio)

Límite de caracteres: 3-24

Caracteres válidos:
Letras minúsculas y números.
ubicación Región en la que se va a crear la cuenta. string (obligatorio)
Etiquetas Etiquetas especificadas por el usuario asociadas a la cuenta. Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas
identidad Identidad de la cuenta de Batch. BatchAccountIdentity
Propiedades Propiedades de la cuenta de Batch. BatchAccountCreatePropertiesOrBatchAccountProperties

BatchAccountIdentity

Nombre Descripción Valor
tipo Tipo de identidad que se usa para la cuenta de Batch. 'Ninguno'
'SystemAssigned'
'UserAssigned' (obligatorio)
userAssignedIdentities Lista de identidades de usuario asociadas a la cuenta de Batch. BatchAccountIdentityUserAssignedIdentities

BatchAccountIdentityUserAssignedIdentities

Nombre Descripción Valor
{propiedad personalizada} UserAssignedIdentities

UserAssignedIdentities

Este objeto no contiene ninguna propiedad que se establezca durante la implementación. Todas las propiedades son ReadOnly.

BatchAccountCreatePropertiesOrBatchAccountProperties

Nombre Descripción Valor
allowedAuthenticationModes Lista de modos de autenticación permitidos para la cuenta de Batch que se puede usar para autenticarse con el plano de datos. Esto no afecta a la autenticación con el plano de control. Matriz de cadenas que contiene cualquiera de:
'AAD'
'SharedKey'
'TaskAuthenticationToken'
autoStorage Propiedades relacionadas con la cuenta de almacenamiento automático. AutoStorageBasePropertiesOrAutoStorageProperties
encriptación Configura cómo se cifran los datos del cliente dentro de la cuenta de Batch. De forma predeterminada, las cuentas se cifran mediante una clave administrada por Microsoft. Para un control adicional, se puede usar una clave administrada por el cliente en su lugar. EncryptionProperties
keyVaultReference Referencia al almacén de claves de Azure asociado a la cuenta de Batch. KeyVaultReference
networkProfile El perfil de red solo surte efecto cuando publicNetworkAccess está habilitado. networkProfile de
poolAllocationMode El modo de asignación del grupo también afecta a la forma en que los clientes se pueden autenticar en la API del servicio Batch. Si el modo es BatchService, los clientes pueden autenticarse mediante claves de acceso o Azure Active Directory. Si el modo es UserSubscription, los clientes deben usar Azure Active Directory. El valor predeterminado es BatchService. 'BatchService'
"UserSubscription"
publicNetworkAccess Si no se especifica, el valor predeterminado es "enabled". 'Deshabilitado'
'Habilitado'

AutoStorageBasePropertiesOrAutoStorageProperties

Nombre Descripción Valor
authenticationMode Modo de autenticación que usará el servicio Batch para administrar la cuenta de almacenamiento automático. 'BatchAccountManagedIdentity'
'StorageKeys'
nodeIdentityReference La identidad a la que se hace referencia aquí debe asignarse a los grupos que tienen nodos de proceso que necesitan acceso al almacenamiento automático. ComputeNodeIdentityReference
storageAccountId Identificador de recurso de la cuenta de almacenamiento que se va a usar para la cuenta de almacenamiento automático. string (obligatorio)

ComputeNodeIdentityReference

Nombre Descripción Valor
resourceId Identificador de recurso de ARM de la identidad asignada por el usuario. cuerda

EncryptionProperties

Nombre Descripción Valor
keySource Tipo del origen de la clave. "Microsoft.Batch"
"Microsoft.KeyVault"
keyVaultProperties Detalles adicionales al usar Microsoft.KeyVault KeyVaultProperties

KeyVaultProperties

Nombre Descripción Valor
keyIdentifier Ruta de acceso completa al secreto con o sin versión. Ejemplo https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. o https://mykeyvault.vault.azure.net/keys/testkey. Para poder usar los siguientes requisitos previos, debe cumplirse:

La cuenta de Batch tiene una identidad asignada por el sistema
A la identidad de la cuenta se le han concedido permisos Key/Get, Key/Unwrap y Key/Wrap.
KeyVault tiene habilitada la eliminación temporal y la protección de purga
cuerda

KeyVaultReference

Nombre Descripción Valor
identificación Identificador de recurso del almacén de claves de Azure asociado a la cuenta de Batch. string (obligatorio)
URL Dirección URL del almacén de claves de Azure asociado a la cuenta de Batch. string (obligatorio)

NetworkProfile

Nombre Descripción Valor
accountAccess Perfil de acceso de red para el punto de conexión batchAccount (API del plano de datos de la cuenta de Batch). endpointAccessProfile de
nodeManagementAccess Perfil de acceso de red para el punto de conexión nodeManagement (servicio Batch que administra nodos de proceso para grupos de Batch). endpointAccessProfile de

EndpointAccessProfile

Nombre Descripción Valor
defaultAction Acción predeterminada para el acceso al punto de conexión. Solo es aplicable cuando publicNetworkAccess está habilitado. 'Permitir'
'Deny' (obligatorio)
ipRules Matriz de intervalos IP para filtrar la dirección IP del cliente. IPRule []

IPRule

Nombre Descripción Valor
acción Acción cuando se coincide con la dirección IP del cliente. 'Allow' (obligatorio)
valor Dirección IPv4 o intervalo de direcciones IPv4 en formato CIDR. string (obligatorio)

Plantillas de inicio rápido

Las siguientes plantillas de inicio rápido implementan este tipo de recurso.

Plantilla Descripción
grupo de Azure Batch sin direcciones IP públicas

Implementación en Azure
Esta plantilla crea un grupo de comunicación de nodos simplificado de Azure Batch sin direcciones IP públicas.
Crear una cuenta de Batch con una plantilla

Implementación en Azure
Esta plantilla crea una cuenta de Batch y una cuenta de almacenamiento.

Definición de recursos de plantilla de ARM

El tipo de recurso batchAccounts se puede implementar con operaciones destinadas a:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.Batch/batchAccounts, agregue el siguiente JSON a la plantilla.

{
  "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"
  }
}

Valores de propiedad

batchAccounts

Nombre Descripción Valor
tipo El tipo de recurso "Microsoft.Batch/batchAccounts"
apiVersion La versión de la API de recursos '2023-05-01'
nombre El nombre del recurso string (obligatorio)

Límite de caracteres: 3-24

Caracteres válidos:
Letras minúsculas y números.
ubicación Región en la que se va a crear la cuenta. string (obligatorio)
Etiquetas Etiquetas especificadas por el usuario asociadas a la cuenta. Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas
identidad Identidad de la cuenta de Batch. BatchAccountIdentity
Propiedades Propiedades de la cuenta de Batch. BatchAccountCreatePropertiesOrBatchAccountProperties

BatchAccountIdentity

Nombre Descripción Valor
tipo Tipo de identidad que se usa para la cuenta de Batch. 'Ninguno'
'SystemAssigned'
'UserAssigned' (obligatorio)
userAssignedIdentities Lista de identidades de usuario asociadas a la cuenta de Batch. BatchAccountIdentityUserAssignedIdentities

BatchAccountIdentityUserAssignedIdentities

Nombre Descripción Valor
{propiedad personalizada} UserAssignedIdentities

UserAssignedIdentities

Este objeto no contiene ninguna propiedad que se establezca durante la implementación. Todas las propiedades son ReadOnly.

BatchAccountCreatePropertiesOrBatchAccountProperties

Nombre Descripción Valor
allowedAuthenticationModes Lista de modos de autenticación permitidos para la cuenta de Batch que se puede usar para autenticarse con el plano de datos. Esto no afecta a la autenticación con el plano de control. Matriz de cadenas que contiene cualquiera de:
'AAD'
'SharedKey'
'TaskAuthenticationToken'
autoStorage Propiedades relacionadas con la cuenta de almacenamiento automático. AutoStorageBasePropertiesOrAutoStorageProperties
encriptación Configura cómo se cifran los datos del cliente dentro de la cuenta de Batch. De forma predeterminada, las cuentas se cifran mediante una clave administrada por Microsoft. Para un control adicional, se puede usar una clave administrada por el cliente en su lugar. EncryptionProperties
keyVaultReference Referencia al almacén de claves de Azure asociado a la cuenta de Batch. KeyVaultReference
networkProfile El perfil de red solo surte efecto cuando publicNetworkAccess está habilitado. networkProfile de
poolAllocationMode El modo de asignación del grupo también afecta a la forma en que los clientes se pueden autenticar en la API del servicio Batch. Si el modo es BatchService, los clientes pueden autenticarse mediante claves de acceso o Azure Active Directory. Si el modo es UserSubscription, los clientes deben usar Azure Active Directory. El valor predeterminado es BatchService. 'BatchService'
"UserSubscription"
publicNetworkAccess Si no se especifica, el valor predeterminado es "enabled". 'Deshabilitado'
'Habilitado'

AutoStorageBasePropertiesOrAutoStorageProperties

Nombre Descripción Valor
authenticationMode Modo de autenticación que usará el servicio Batch para administrar la cuenta de almacenamiento automático. 'BatchAccountManagedIdentity'
'StorageKeys'
nodeIdentityReference La identidad a la que se hace referencia aquí debe asignarse a los grupos que tienen nodos de proceso que necesitan acceso al almacenamiento automático. ComputeNodeIdentityReference
storageAccountId Identificador de recurso de la cuenta de almacenamiento que se va a usar para la cuenta de almacenamiento automático. string (obligatorio)

ComputeNodeIdentityReference

Nombre Descripción Valor
resourceId Identificador de recurso de ARM de la identidad asignada por el usuario. cuerda

EncryptionProperties

Nombre Descripción Valor
keySource Tipo del origen de la clave. "Microsoft.Batch"
"Microsoft.KeyVault"
keyVaultProperties Detalles adicionales al usar Microsoft.KeyVault KeyVaultProperties

KeyVaultProperties

Nombre Descripción Valor
keyIdentifier Ruta de acceso completa al secreto con o sin versión. Ejemplo https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. o https://mykeyvault.vault.azure.net/keys/testkey. Para poder usar los siguientes requisitos previos, debe cumplirse:

La cuenta de Batch tiene una identidad asignada por el sistema
A la identidad de la cuenta se le han concedido permisos Key/Get, Key/Unwrap y Key/Wrap.
KeyVault tiene habilitada la eliminación temporal y la protección de purga
cuerda

KeyVaultReference

Nombre Descripción Valor
identificación Identificador de recurso del almacén de claves de Azure asociado a la cuenta de Batch. string (obligatorio)
URL Dirección URL del almacén de claves de Azure asociado a la cuenta de Batch. string (obligatorio)

NetworkProfile

Nombre Descripción Valor
accountAccess Perfil de acceso de red para el punto de conexión batchAccount (API del plano de datos de la cuenta de Batch). endpointAccessProfile de
nodeManagementAccess Perfil de acceso de red para el punto de conexión nodeManagement (servicio Batch que administra nodos de proceso para grupos de Batch). endpointAccessProfile de

EndpointAccessProfile

Nombre Descripción Valor
defaultAction Acción predeterminada para el acceso al punto de conexión. Solo es aplicable cuando publicNetworkAccess está habilitado. 'Permitir'
'Deny' (obligatorio)
ipRules Matriz de intervalos IP para filtrar la dirección IP del cliente. IPRule []

IPRule

Nombre Descripción Valor
acción Acción cuando se coincide con la dirección IP del cliente. 'Allow' (obligatorio)
valor Dirección IPv4 o intervalo de direcciones IPv4 en formato CIDR. string (obligatorio)

Plantillas de inicio rápido

Las siguientes plantillas de inicio rápido implementan este tipo de recurso.

Plantilla Descripción
grupo de Azure Batch sin direcciones IP públicas

Implementación en Azure
Esta plantilla crea un grupo de comunicación de nodos simplificado de Azure Batch sin direcciones IP públicas.
Crear una cuenta de Batch con una plantilla

Implementación en Azure
Esta plantilla crea una cuenta de Batch y una cuenta de almacenamiento.

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso batchAccounts se puede implementar con operaciones destinadas a:

  • grupos de recursos de

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.Batch/batchAccounts, agregue el siguiente Terraform a la plantilla.

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"
    }
  })
}

Valores de propiedad

batchAccounts

Nombre Descripción Valor
tipo El tipo de recurso "Microsoft.Batch/batchAccounts@2023-05-01"
nombre El nombre del recurso string (obligatorio)

Límite de caracteres: 3-24

Caracteres válidos:
Letras minúsculas y números.
ubicación Región en la que se va a crear la cuenta. string (obligatorio)
parent_id Para realizar la implementación en un grupo de recursos, use el identificador de ese grupo de recursos. string (obligatorio)
Etiquetas Etiquetas especificadas por el usuario asociadas a la cuenta. Diccionario de nombres y valores de etiqueta.
identidad Identidad de la cuenta de Batch. BatchAccountIdentity
Propiedades Propiedades de la cuenta de Batch. BatchAccountCreatePropertiesOrBatchAccountProperties

BatchAccountIdentity

Nombre Descripción Valor
tipo Tipo de identidad que se usa para la cuenta de Batch. "SystemAssigned"
"UserAssigned" (obligatorio)
identity_ids Lista de identidades de usuario asociadas a la cuenta de Batch. Matriz de identificadores de identidad de usuario.

BatchAccountIdentityUserAssignedIdentities

Nombre Descripción Valor
{propiedad personalizada} UserAssignedIdentities

UserAssignedIdentities

Este objeto no contiene ninguna propiedad que se establezca durante la implementación. Todas las propiedades son ReadOnly.

BatchAccountCreatePropertiesOrBatchAccountProperties

Nombre Descripción Valor
allowedAuthenticationModes Lista de modos de autenticación permitidos para la cuenta de Batch que se puede usar para autenticarse con el plano de datos. Esto no afecta a la autenticación con el plano de control. Matriz de cadenas que contiene cualquiera de:
"AAD"
"SharedKey"
"TaskAuthenticationToken"
autoStorage Propiedades relacionadas con la cuenta de almacenamiento automático. AutoStorageBasePropertiesOrAutoStorageProperties
encriptación Configura cómo se cifran los datos del cliente dentro de la cuenta de Batch. De forma predeterminada, las cuentas se cifran mediante una clave administrada por Microsoft. Para un control adicional, se puede usar una clave administrada por el cliente en su lugar. EncryptionProperties
keyVaultReference Referencia al almacén de claves de Azure asociado a la cuenta de Batch. KeyVaultReference
networkProfile El perfil de red solo surte efecto cuando publicNetworkAccess está habilitado. networkProfile de
poolAllocationMode El modo de asignación del grupo también afecta a la forma en que los clientes se pueden autenticar en la API del servicio Batch. Si el modo es BatchService, los clientes pueden autenticarse mediante claves de acceso o Azure Active Directory. Si el modo es UserSubscription, los clientes deben usar Azure Active Directory. El valor predeterminado es BatchService. "BatchService"
"UserSubscription"
publicNetworkAccess Si no se especifica, el valor predeterminado es "enabled". "Deshabilitado"
"Habilitado"

AutoStorageBasePropertiesOrAutoStorageProperties

Nombre Descripción Valor
authenticationMode Modo de autenticación que usará el servicio Batch para administrar la cuenta de almacenamiento automático. "BatchAccountManagedIdentity"
"StorageKeys"
nodeIdentityReference La identidad a la que se hace referencia aquí debe asignarse a los grupos que tienen nodos de proceso que necesitan acceso al almacenamiento automático. ComputeNodeIdentityReference
storageAccountId Identificador de recurso de la cuenta de almacenamiento que se va a usar para la cuenta de almacenamiento automático. string (obligatorio)

ComputeNodeIdentityReference

Nombre Descripción Valor
resourceId Identificador de recurso de ARM de la identidad asignada por el usuario. cuerda

EncryptionProperties

Nombre Descripción Valor
keySource Tipo del origen de la clave. "Microsoft.Batch"
"Microsoft.KeyVault"
keyVaultProperties Detalles adicionales al usar Microsoft.KeyVault KeyVaultProperties

KeyVaultProperties

Nombre Descripción Valor
keyIdentifier Ruta de acceso completa al secreto con o sin versión. Ejemplo https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. o https://mykeyvault.vault.azure.net/keys/testkey. Para poder usar los siguientes requisitos previos, debe cumplirse:

La cuenta de Batch tiene una identidad asignada por el sistema
A la identidad de la cuenta se le han concedido permisos Key/Get, Key/Unwrap y Key/Wrap.
KeyVault tiene habilitada la eliminación temporal y la protección de purga
cuerda

KeyVaultReference

Nombre Descripción Valor
identificación Identificador de recurso del almacén de claves de Azure asociado a la cuenta de Batch. string (obligatorio)
URL Dirección URL del almacén de claves de Azure asociado a la cuenta de Batch. string (obligatorio)

NetworkProfile

Nombre Descripción Valor
accountAccess Perfil de acceso de red para el punto de conexión batchAccount (API del plano de datos de la cuenta de Batch). endpointAccessProfile de
nodeManagementAccess Perfil de acceso de red para el punto de conexión nodeManagement (servicio Batch que administra nodos de proceso para grupos de Batch). endpointAccessProfile de

EndpointAccessProfile

Nombre Descripción Valor
defaultAction Acción predeterminada para el acceso al punto de conexión. Solo es aplicable cuando publicNetworkAccess está habilitado. "Permitir"
"Denegar" (obligatorio)
ipRules Matriz de intervalos IP para filtrar la dirección IP del cliente. IPRule []

IPRule

Nombre Descripción Valor
acción Acción cuando se coincide con la dirección IP del cliente. "Permitir" (obligatorio)
valor Dirección IPv4 o intervalo de direcciones IPv4 en formato CIDR. string (obligatorio)