Partilhar via


Batch Account - Create

Cria uma nova conta do Batch com os parâmetros especificados. As contas existentes não podem ser atualizadas com esta API e devem ser atualizadas com a API Atualizar Conta do Batch.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}?api-version=2024-02-01

Parâmetros do URI

Name Em Necessário Tipo Description
accountName
path True

string

Um nome para a conta do Batch que tem de ser exclusivo na região. Os nomes de contas do Batch têm de ter entre 3 e 24 carateres de comprimento e têm de utilizar apenas números e letras minúsculas. Este nome é utilizado como parte do nome DNS que é utilizado para aceder ao serviço Batch na região em que a conta é criada. Por exemplo: http://accountname.region.batch.azure.com/.

Padrão Regex: ^[a-z0-9]+$

resourceGroupName
path True

string

O nome do grupo de recursos que contém a conta do Batch.

subscriptionId
path True

string

O ID da subscrição do Azure. Esta é uma cadeia formatada com GUID (por exemplo, 000000000-0000-0000-0000-000000000000)

api-version
query True

string

A versão da API a ser utilizada com o pedido HTTP.

Corpo do Pedido

Name Necessário Tipo Description
location True

string

A região na qual criar a conta.

identity

BatchAccountIdentity

A identidade da conta do Batch.

properties.allowedAuthenticationModes

AuthenticationMode[]

Lista de modos de autenticação permitidos para a conta do Batch que podem ser utilizados para autenticar com o plano de dados. Isto não afeta a autenticação com o plano de controlo.

properties.autoStorage

AutoStorageBaseProperties

As propriedades relacionadas com a conta de armazenamento automático.

properties.encryption

EncryptionProperties

A configuração de encriptação para a conta do Batch.
Configura a forma como os dados do cliente são encriptados dentro da conta do Batch. Por predefinição, as contas são encriptadas com uma chave gerida pela Microsoft. Para um controlo adicional, pode ser utilizada uma chave gerida pelo cliente.

properties.keyVaultReference

KeyVaultReference

Uma referência ao cofre de chaves do Azure associado à conta do Batch.

properties.networkProfile

NetworkProfile

Perfil de rede da conta do Batch, que contém definições de regras de rede para cada ponto final.
O perfil de rede só entra em vigor quando publicNetworkAccess está ativado.

properties.poolAllocationMode

PoolAllocationMode

O modo de alocação a utilizar para criar conjuntos na conta do Batch.
O modo de alocação de conjuntos também afeta a forma como os clientes podem autenticar-se na API do Serviço Batch. Se o modo for BatchService, os clientes podem autenticar-se com chaves de acesso ou Microsoft Entra ID. Se o modo for UserSubscription, os clientes têm de utilizar Microsoft Entra ID. A predefinição é BatchService.

properties.publicNetworkAccess

PublicNetworkAccessType

O tipo de acesso de rede para aceder Azure Batch conta.
Se não for especificado, o valor predefinido é "ativado".

tags

object

As etiquetas especificadas pelo utilizador associadas à conta.

Respostas

Name Tipo Description
200 OK

BatchAccount

A operação foi efetuada com êxito. A resposta contém a entidade conta do Batch.

202 Accepted

A operação será concluída de forma assíncrona.

Cabeçalhos

  • Location: string
  • Retry-After: integer
Other Status Codes

CloudError

Resposta de erro que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Microsoft Entra fluxo de código de autenticação OAuth 2.0

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation representar a sua conta de utilizador

Exemplos

BatchAccountCreate_BYOS
BatchAccountCreate_Default
BatchAccountCreate_SystemAssignedIdentity
BatchAccountCreate_UserAssignedIdentity
PrivateBatchAccountCreate

BatchAccountCreate_BYOS

Pedido de amostra

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct?api-version=2024-02-01

{
  "location": "japaneast",
  "properties": {
    "autoStorage": {
      "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage"
    },
    "poolAllocationMode": "UserSubscription",
    "keyVaultReference": {
      "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample",
      "url": "http://sample.vault.azure.net/"
    }
  }
}

Resposta da amostra

{
  "name": "sampleacct",
  "location": "japaneast",
  "properties": {
    "accountEndpoint": "sampleacct.japaneast.batch.azure.com",
    "provisioningState": "Succeeded",
    "poolAllocationMode": "UserSubscription",
    "dedicatedCoreQuota": 20,
    "lowPriorityCoreQuota": 20,
    "poolQuota": 20,
    "activeJobAndJobScheduleQuota": 20,
    "autoStorage": {
      "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage",
      "lastKeySync": "2016-03-10T23:48:38.9878479Z"
    },
    "keyVaultReference": {
      "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample",
      "url": "http://sample.vault.azure.net/"
    },
    "publicNetworkAccess": "Enabled"
  },
  "identity": {
    "type": "None"
  },
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct",
  "type": "Microsoft.Batch/batchAccounts"
}

BatchAccountCreate_Default

Pedido de amostra

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct?api-version=2024-02-01

{
  "location": "japaneast",
  "properties": {
    "autoStorage": {
      "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage"
    }
  }
}

Resposta da amostra

{
  "name": "sampleacct",
  "location": "japaneast",
  "properties": {
    "accountEndpoint": "sampleacct.japaneast.batch.azure.com",
    "provisioningState": "Succeeded",
    "poolAllocationMode": "BatchService",
    "dedicatedCoreQuota": 20,
    "lowPriorityCoreQuota": 20,
    "poolQuota": 20,
    "activeJobAndJobScheduleQuota": 20,
    "autoStorage": {
      "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage",
      "lastKeySync": "2016-03-10T23:48:38.9878479Z"
    },
    "publicNetworkAccess": "Enabled"
  },
  "identity": {
    "type": "None"
  },
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct",
  "type": "Microsoft.Batch/batchAccounts"
}

BatchAccountCreate_SystemAssignedIdentity

Pedido de amostra

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct?api-version=2024-02-01

{
  "location": "japaneast",
  "properties": {
    "autoStorage": {
      "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage"
    }
  },
  "identity": {
    "type": "SystemAssigned"
  }
}

Resposta da amostra

{
  "name": "sampleacct",
  "location": "japaneast",
  "properties": {
    "accountEndpoint": "sampleacct.japaneast.batch.azure.com",
    "provisioningState": "Succeeded",
    "poolAllocationMode": "BatchService",
    "dedicatedCoreQuota": 20,
    "lowPriorityCoreQuota": 20,
    "poolQuota": 20,
    "activeJobAndJobScheduleQuota": 20,
    "autoStorage": {
      "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage",
      "lastKeySync": "2016-03-10T23:48:38.9878479Z"
    },
    "publicNetworkAccess": "Enabled"
  },
  "identity": {
    "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7",
    "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd",
    "type": "SystemAssigned"
  },
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct",
  "type": "Microsoft.Batch/batchAccounts"
}

BatchAccountCreate_UserAssignedIdentity

Pedido de amostra

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct?api-version=2024-02-01

{
  "location": "japaneast",
  "properties": {
    "autoStorage": {
      "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage"
    }
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {}
    }
  }
}

Resposta da amostra

{
  "name": "sampleacct",
  "location": "japaneast",
  "properties": {
    "accountEndpoint": "sampleacct.japaneast.batch.azure.com",
    "provisioningState": "Succeeded",
    "poolAllocationMode": "BatchService",
    "dedicatedCoreQuota": 20,
    "lowPriorityCoreQuota": 20,
    "poolQuota": 20,
    "activeJobAndJobScheduleQuota": 20,
    "autoStorage": {
      "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage",
      "lastKeySync": "2016-03-10T23:48:38.9878479Z"
    },
    "publicNetworkAccess": "Enabled"
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {
        "principalId": "principalId1",
        "clientId": "clientId1"
      }
    }
  },
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct",
  "type": "Microsoft.Batch/batchAccounts"
}

PrivateBatchAccountCreate

Pedido de amostra

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct?api-version=2024-02-01

{
  "location": "japaneast",
  "properties": {
    "autoStorage": {
      "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage"
    },
    "keyVaultReference": {
      "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample",
      "url": "http://sample.vault.azure.net/"
    },
    "publicNetworkAccess": "Disabled"
  }
}

Resposta da amostra

{
  "name": "sampleacct",
  "location": "japaneast",
  "properties": {
    "accountEndpoint": "sampleacct.japaneast.batch.azure.com",
    "provisioningState": "Succeeded",
    "poolAllocationMode": "UserSubscription",
    "dedicatedCoreQuota": 20,
    "lowPriorityCoreQuota": 20,
    "poolQuota": 20,
    "activeJobAndJobScheduleQuota": 20,
    "autoStorage": {
      "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage",
      "lastKeySync": "2016-03-10T23:48:38.9878479Z"
    },
    "keyVaultReference": {
      "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample",
      "url": "http://sample.vault.azure.net/"
    },
    "publicNetworkAccess": "Disabled"
  },
  "identity": {
    "type": "None"
  },
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct",
  "type": "Microsoft.Batch/batchAccounts"
}

Definições

Name Description
AuthenticationMode

O modo de autenticação da conta do Batch.

AutoStorageAuthenticationMode

O modo de autenticação que o serviço Batch irá utilizar para gerir a conta de armazenamento automático.

AutoStorageBaseProperties

As propriedades relacionadas com a conta de armazenamento automático.

AutoStorageProperties

Contém informações sobre a conta de armazenamento automático associada a uma conta do Batch.

BatchAccount

Contém informações sobre uma conta Azure Batch.

BatchAccountCreateParameters

Parâmetros fornecidos para a operação Criar.

BatchAccountIdentity

A identidade da conta do Batch, se configurada. Isto é utilizado quando o utilizador especifica "Microsoft.KeyVault" como a configuração de encriptação da conta do Batch ou quando ManagedIdentity é selecionado como o modo de autenticação de armazenamento automático.

CloudError

Uma resposta de erro do serviço Batch.

CloudErrorBody

Uma resposta de erro do serviço Batch.

ComputeNodeIdentityReference

A referência a uma identidade atribuída pelo utilizador associada ao conjunto do Batch que um nó de computação irá utilizar.

EncryptionProperties

Configura a forma como os dados do cliente são encriptados dentro da conta do Batch. Por predefinição, as contas são encriptadas com uma chave gerida pela Microsoft. Para um controlo adicional, pode ser utilizada uma chave gerida pelo cliente.

EndpointAccessDefaultAction

A ação predefinida quando não existe nenhum IPRule correspondida.

EndpointAccessProfile

Perfil de acesso de rede para o ponto final do Batch.

IPRule

Regra para filtrar o endereço IP do cliente.

IPRuleAction

Ação quando o endereço IP do cliente é correspondido.

KeySource

Tipo da origem da chave.

KeyVaultProperties

Configuração do KeyVault ao utilizar um KeySource de encriptação do Microsoft.KeyVault.

KeyVaultReference

Identifica o cofre de chaves do Azure associado a uma conta do Batch.

NetworkProfile

Perfil de rede da conta do Batch, que contém definições de regras de rede para cada ponto final.

PoolAllocationMode

O modo de alocação para criar conjuntos na conta do Batch.

PrivateEndpoint

O ponto final privado da ligação de ponto final privado.

PrivateEndpointConnection

Contém informações sobre um recurso de ligação privada.

PrivateEndpointConnectionProvisioningState

O estado de aprovisionamento da ligação de ponto final privado.

PrivateLinkServiceConnectionState

O estado de ligação do serviço de ligação do private link da ligação do ponto final privado

PrivateLinkServiceConnectionStatus

O estado da ligação do ponto final privado do Batch

ProvisioningState

O estado aprovisionado do recurso

PublicNetworkAccessType

O tipo de acesso de rede para operar nos recursos na conta do Batch.

ResourceIdentityType

O tipo de identidade utilizado para a conta do Batch.

UserAssignedIdentities

A lista de identidades de utilizador associadas.

VirtualMachineFamilyCoreQuota

Uma Família de VMs e a respetiva quota principal associada para a conta do Batch.

AuthenticationMode

O modo de autenticação da conta do Batch.

Name Tipo Description
AAD

string

O modo de autenticação com Microsoft Entra ID.

SharedKey

string

O modo de autenticação com chaves partilhadas.

TaskAuthenticationToken

string

O modo de autenticação com tokens de autenticação de tarefas.

AutoStorageAuthenticationMode

O modo de autenticação que o serviço Batch irá utilizar para gerir a conta de armazenamento automático.

Name Tipo Description
BatchAccountManagedIdentity

string

O serviço Batch autenticará os pedidos de armazenamento automático com a identidade gerida atribuída à conta do Batch.

StorageKeys

string

O serviço Batch autenticará pedidos de armazenamento automático com chaves de conta de armazenamento.

AutoStorageBaseProperties

As propriedades relacionadas com a conta de armazenamento automático.

Name Tipo Default value Description
authenticationMode

AutoStorageAuthenticationMode

StorageKeys

O modo de autenticação que o serviço Batch irá utilizar para gerir a conta de armazenamento automático.

nodeIdentityReference

ComputeNodeIdentityReference

A referência à identidade atribuída pelo utilizador que os nós de computação utilizarão para aceder ao armazenamento automático.
A identidade aqui referenciada tem de ser atribuída a conjuntos que têm nós de computação que precisam de acesso ao armazenamento automático.

storageAccountId

string

O ID de recurso da conta de armazenamento a utilizar para a conta de armazenamento automático.

AutoStorageProperties

Contém informações sobre a conta de armazenamento automático associada a uma conta do Batch.

Name Tipo Default value Description
authenticationMode

AutoStorageAuthenticationMode

StorageKeys

O modo de autenticação que o serviço Batch irá utilizar para gerir a conta de armazenamento automático.

lastKeySync

string

A hora UTC em que as chaves de armazenamento foram sincronizadas pela última vez com a conta do Batch.

nodeIdentityReference

ComputeNodeIdentityReference

A referência à identidade atribuída pelo utilizador que os nós de computação utilizarão para aceder ao armazenamento automático.
A identidade aqui referenciada tem de ser atribuída a conjuntos que têm nós de computação que precisam de acesso ao armazenamento automático.

storageAccountId

string

O ID de recurso da conta de armazenamento a utilizar para a conta de armazenamento automático.

BatchAccount

Contém informações sobre uma conta Azure Batch.

Name Tipo Default value Description
id

string

O ID do recurso.

identity

BatchAccountIdentity

A identidade da conta do Batch.

location

string

A localização do recurso.

name

string

O nome do recurso.

properties.accountEndpoint

string

O ponto final da conta utilizado para interagir com o serviço Batch.

properties.activeJobAndJobScheduleQuota

integer

A quota de agendamento de tarefas e tarefas ativas para a conta do Batch.

properties.allowedAuthenticationModes

AuthenticationMode[]

Lista de modos de autenticação permitidos para a conta do Batch que podem ser utilizados para autenticar com o plano de dados. Isto não afeta a autenticação com o plano de controlo.

properties.autoStorage

AutoStorageProperties

As propriedades e o estado de qualquer conta de armazenamento automático associada à conta do Batch.
Contém informações sobre a conta de armazenamento automático associada a uma conta do Batch.

properties.dedicatedCoreQuota

integer

A quota de núcleo dedicado para a conta do Batch.
Para contas com PoolAllocationMode definido como UserSubscription, a quota é gerida na subscrição, pelo que este valor não é devolvido.

properties.dedicatedCoreQuotaPerVMFamily

VirtualMachineFamilyCoreQuota[]

Uma lista da quota de núcleo dedicado por família de Máquinas Virtuais para a conta do Batch. Para contas com PoolAllocationMode definido como UserSubscription, a quota é gerida na subscrição, pelo que este valor não é devolvido.

properties.dedicatedCoreQuotaPerVMFamilyEnforced

boolean

Um valor que indica se as quotas principais por família de Máquinas Virtuais são impostas para esta conta
Se este sinalizador for verdadeiro, a quota de núcleo dedicado é imposta através das propriedades dedicatedCoreQuotaPerVMFamily e dedicatedCoreQuota na conta. Se este sinalizador for falso, a quota de núcleo dedicado é imposta apenas através da propriedade dedicatedCoreQuota na conta e não considera a família de Máquinas Virtuais.

properties.encryption

EncryptionProperties

A configuração de encriptação para a conta do Batch.
Configura a forma como os dados do cliente são encriptados dentro da conta do Batch. Por predefinição, as contas são encriptadas com uma chave gerida pela Microsoft. Para um controlo adicional, pode ser utilizada uma chave gerida pelo cliente.

properties.keyVaultReference

KeyVaultReference

Uma referência ao cofre de chaves do Azure associado à conta do Batch.
Identifica o cofre de chaves do Azure associado a uma conta do Batch.

properties.lowPriorityCoreQuota

integer

A quota de núcleo spot/de baixa prioridade para a conta do Batch.
Para contas com PoolAllocationMode definido como UserSubscription, a quota é gerida na subscrição, pelo que este valor não é devolvido.

properties.networkProfile

NetworkProfile

Perfil de rede da conta do Batch, que contém definições de regras de rede para cada ponto final.
O perfil de rede só entra em vigor quando publicNetworkAccess está ativado.

properties.nodeManagementEndpoint

string

O ponto final utilizado pelo nó de computação para ligar ao serviço de gestão de nós do Batch.

properties.poolAllocationMode

PoolAllocationMode

O modo de alocação a utilizar para criar conjuntos na conta do Batch.
O modo de alocação para criar conjuntos na conta do Batch.

properties.poolQuota

integer

A quota do conjunto para a conta do Batch.

properties.privateEndpointConnections

PrivateEndpointConnection[]

Lista de ligações de pontos finais privados associadas à conta do Batch

properties.provisioningState

ProvisioningState

O estado aprovisionado do recurso

properties.publicNetworkAccess

PublicNetworkAccessType

Enabled

O tipo de interface de rede para aceder às operações Azure Batch serviço e conta do Batch.
Se não for especificado, o valor predefinido é "ativado".

tags

object

As etiquetas do recurso.

type

string

O tipo do recurso.

BatchAccountCreateParameters

Parâmetros fornecidos para a operação Criar.

Name Tipo Default value Description
identity

BatchAccountIdentity

A identidade da conta do Batch.

location

string

A região na qual criar a conta.

properties.allowedAuthenticationModes

AuthenticationMode[]

Lista de modos de autenticação permitidos para a conta do Batch que podem ser utilizados para autenticar com o plano de dados. Isto não afeta a autenticação com o plano de controlo.

properties.autoStorage

AutoStorageBaseProperties

As propriedades relacionadas com a conta de armazenamento automático.

properties.encryption

EncryptionProperties

A configuração de encriptação para a conta do Batch.
Configura a forma como os dados do cliente são encriptados dentro da conta do Batch. Por predefinição, as contas são encriptadas com uma chave gerida pela Microsoft. Para um controlo adicional, pode ser utilizada uma chave gerida pelo cliente.

properties.keyVaultReference

KeyVaultReference

Uma referência ao cofre de chaves do Azure associado à conta do Batch.

properties.networkProfile

NetworkProfile

Perfil de rede da conta do Batch, que contém definições de regras de rede para cada ponto final.
O perfil de rede só entra em vigor quando publicNetworkAccess está ativado.

properties.poolAllocationMode

PoolAllocationMode

O modo de alocação a utilizar para criar conjuntos na conta do Batch.
O modo de alocação de conjuntos também afeta a forma como os clientes podem autenticar-se na API do Serviço Batch. Se o modo for BatchService, os clientes podem autenticar-se com chaves de acesso ou Microsoft Entra ID. Se o modo for UserSubscription, os clientes têm de utilizar Microsoft Entra ID. A predefinição é BatchService.

properties.publicNetworkAccess

PublicNetworkAccessType

Enabled

O tipo de acesso de rede para aceder Azure Batch conta.
Se não for especificado, o valor predefinido é "ativado".

tags

object

As etiquetas especificadas pelo utilizador associadas à conta.

BatchAccountIdentity

A identidade da conta do Batch, se configurada. Isto é utilizado quando o utilizador especifica "Microsoft.KeyVault" como a configuração de encriptação da conta do Batch ou quando ManagedIdentity é selecionado como o modo de autenticação de armazenamento automático.

Name Tipo Description
principalId

string

O ID principal da conta do Batch. Esta propriedade só será fornecida para uma identidade atribuída pelo sistema.

tenantId

string

O ID do inquilino associado à conta do Batch. Esta propriedade só será fornecida para uma identidade atribuída pelo sistema.

type

ResourceIdentityType

O tipo de identidade utilizado para a conta do Batch.

userAssignedIdentities

<string,  UserAssignedIdentities>

A lista de identidades de utilizador associadas à conta do Batch.

CloudError

Uma resposta de erro do serviço Batch.

Name Tipo Description
error

CloudErrorBody

O corpo da resposta do erro.

CloudErrorBody

Uma resposta de erro do serviço Batch.

Name Tipo Description
code

string

Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.

details

CloudErrorBody[]

Uma lista de detalhes adicionais sobre o erro.

message

string

Uma mensagem que descreve o erro, que se destina a ser adequada para ser apresentada numa interface de utilizador.

target

string

O destino do erro específico. Por exemplo, o nome da propriedade em erro.

ComputeNodeIdentityReference

A referência a uma identidade atribuída pelo utilizador associada ao conjunto do Batch que um nó de computação irá utilizar.

Name Tipo Description
resourceId

string

O ID de recurso do ARM da identidade atribuída pelo utilizador.

EncryptionProperties

Configura a forma como os dados do cliente são encriptados dentro da conta do Batch. Por predefinição, as contas são encriptadas com uma chave gerida pela Microsoft. Para um controlo adicional, pode ser utilizada uma chave gerida pelo cliente.

Name Tipo Description
keySource

KeySource

Tipo da origem da chave.

keyVaultProperties

KeyVaultProperties

Detalhes adicionais ao utilizar Microsoft.KeyVault

EndpointAccessDefaultAction

A ação predefinida quando não existe nenhum IPRule correspondida.

Name Tipo Description
Allow

string

Permitir o acesso do cliente.

Deny

string

Negar o acesso de cliente.

EndpointAccessProfile

Perfil de acesso de rede para o ponto final do Batch.

Name Tipo Description
defaultAction

EndpointAccessDefaultAction

A ação predefinida quando não existe nenhum IPRule correspondida.
Ação predefinida para acesso a pontos finais. Só é aplicável quando publicNetworkAccess está ativado.

ipRules

IPRule[]

Matriz de intervalos de IP para filtrar o endereço IP do cliente.

IPRule

Regra para filtrar o endereço IP do cliente.

Name Tipo Description
action

IPRuleAction

Ação quando o endereço IP do cliente é correspondido.

value

string

O endereço IP ou intervalo de endereços IP a filtrar
Endereço IPv4 ou intervalo de endereços IPv4 no formato CIDR.

IPRuleAction

Ação quando o endereço IP do cliente é correspondido.

Name Tipo Description
Allow

string

Permitir o acesso ao endereço IP do cliente correspondente.

KeySource

Tipo da origem da chave.

Name Tipo Description
Microsoft.Batch

string

O Batch cria e gere as chaves de encriptação utilizadas para proteger os dados da conta.

Microsoft.KeyVault

string

As chaves de encriptação utilizadas para proteger os dados da conta são armazenadas num cofre de chaves externo. Se esta opção estiver definida, a identidade da Conta do Batch tem de ser definida como SystemAssigned e um Identificador de Chave válido também tem de ser fornecido em keyVaultProperties.

KeyVaultProperties

Configuração do KeyVault ao utilizar um KeySource de encriptação do Microsoft.KeyVault.

Name Tipo Description
keyIdentifier

string

Caminho completo para o segredo com ou sem versão. Exemplo de https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. ou https://mykeyvault.vault.azure.net/keys/testkey. Para ser utilizável, têm de ser cumpridos os seguintes pré-requisitos:

A Conta do Batch tem uma identidade Atribuída pelo Sistema A identidade da conta recebeu as permissões Chave/Obter, Chave/Desembrulhar e Chave/Moldar O KeyVault tem a eliminação recuperável e a proteção contra remoção ativada

KeyVaultReference

Identifica o cofre de chaves do Azure associado a uma conta do Batch.

Name Tipo Description
id

string

O ID de recurso do cofre de chaves do Azure associado à conta do Batch.

url

string

O URL do cofre de chaves do Azure associado à conta do Batch.

NetworkProfile

Perfil de rede da conta do Batch, que contém definições de regras de rede para cada ponto final.

Name Tipo Description
accountAccess

EndpointAccessProfile

Perfil de acesso de rede para o ponto final batchAccount (API do plano de dados da conta do Batch).

nodeManagementAccess

EndpointAccessProfile

Perfil de acesso de rede para o ponto final nodeManagement (serviço batch que gere nós de computação para conjuntos do Batch).

PoolAllocationMode

O modo de alocação para criar conjuntos na conta do Batch.

Name Tipo Description
BatchService

string

Os conjuntos serão alocados em subscrições pertencentes ao serviço Batch.

UserSubscription

string

Os conjuntos serão alocados numa subscrição propriedade do utilizador.

PrivateEndpoint

O ponto final privado da ligação de ponto final privado.

Name Tipo Description
id

string

O identificador do recurso ARM do ponto final privado. Este é do formulário /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}.

PrivateEndpointConnection

Contém informações sobre um recurso de ligação privada.

Name Tipo Description
etag

string

A ETag do recurso, utilizada para instruções de simultaneidade.

id

string

O ID do recurso.

name

string

O nome do recurso.

properties.groupIds

string[]

O ID de grupo da ligação de ponto final privado.
O valor tem um e apenas um ID de grupo.

properties.privateEndpoint

PrivateEndpoint

O identificador do recurso ARM do ponto final privado.
O ponto final privado da ligação de ponto final privado.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

O estado de ligação do serviço de ligação de ligação privada da ligação de ponto final privado.
O estado de ligação do serviço de ligação do private link da ligação do ponto final privado

properties.provisioningState

PrivateEndpointConnectionProvisioningState

O estado de aprovisionamento da ligação de ponto final privado.

type

string

O tipo do recurso.

PrivateEndpointConnectionProvisioningState

O estado de aprovisionamento da ligação de ponto final privado.

Name Tipo Description
Cancelled

string

O utilizador cancelou a criação da ligação.

Creating

string

A ligação está a ser criada.

Deleting

string

A ligação está a ser eliminado.

Failed

string

O utilizador pediu que a ligação fosse atualizada e falhou. Pode repetir a operação de atualização.

Succeeded

string

O estado da ligação é final e está pronto para ser utilizado se o Estado for Aprovado.

Updating

string

O utilizador pediu que o estado da ligação fosse atualizado, mas a operação de atualização ainda não foi concluída. Pode não referenciar a ligação ao ligar a conta do Batch.

PrivateLinkServiceConnectionState

O estado de ligação do serviço de ligação do private link da ligação do ponto final privado

Name Tipo Description
actionsRequired

string

Ação necessária no estado da ligação privada

description

string

Descrição do estado da Ligação privada

status

PrivateLinkServiceConnectionStatus

O estado da ligação de ponto final privado da conta do Batch

PrivateLinkServiceConnectionStatus

O estado da ligação do ponto final privado do Batch

Name Tipo Description
Approved

string

A ligação de ponto final privado é aprovada e pode ser utilizada para aceder à conta do Batch

Disconnected

string

A ligação de ponto final privado está desligada e não pode ser utilizada para aceder à conta do Batch

Pending

string

A ligação de ponto final privado está pendente e não pode ser utilizada para aceder à conta do Batch

Rejected

string

A ligação de ponto final privado é rejeitada e não pode ser utilizada para aceder à conta do Batch

ProvisioningState

O estado aprovisionado do recurso

Name Tipo Description
Cancelled

string

A última operação para a conta foi cancelada.

Creating

string

A conta está a ser criada.

Deleting

string

A conta está a ser eliminada.

Failed

string

A última operação para a conta falhou.

Invalid

string

A conta está num estado inválido.

Succeeded

string

A conta foi criada e está pronta para ser utilizada.

PublicNetworkAccessType

O tipo de acesso de rede para operar nos recursos na conta do Batch.

Name Tipo Description
Disabled

string

Desativa a conectividade pública e permite a conectividade privada ao serviço Azure Batch através do recurso de ponto final privado.

Enabled

string

Permite a conectividade a Azure Batch através do DNS público.

ResourceIdentityType

O tipo de identidade utilizado para a conta do Batch.

Name Tipo Description
None

string

A conta do Batch não tem nenhuma identidade associada à mesma. A definição None na conta de atualização removerá as identidades existentes.

SystemAssigned

string

A conta do Batch tem uma identidade atribuída pelo sistema.

UserAssigned

string

A conta do Batch tem identidades atribuídas pelo utilizador.

UserAssignedIdentities

A lista de identidades de utilizador associadas.

Name Tipo Description
clientId

string

O ID de cliente da identidade atribuída pelo utilizador.

principalId

string

O ID principal da identidade atribuída pelo utilizador.

VirtualMachineFamilyCoreQuota

Uma Família de VMs e a respetiva quota principal associada para a conta do Batch.

Name Tipo Description
coreQuota

integer

A quota principal da família de VMs para a conta do Batch.

name

string

O nome da família da Máquina Virtual.