Batch Account - List
Obtiene información sobre las cuentas de Batch asociadas a la suscripción.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Batch/batchAccounts?api-version=2024-07-01
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
subscription
|
path | True |
string |
Identificador de suscripción de Azure. Se trata de una cadena con formato GUID (por ejemplo, 000000000-00000-0000-00000-00000000000000) |
api-version
|
query | True |
string |
Versión de la API que se va a usar con la solicitud HTTP. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
La operación se realizó correctamente. La respuesta contiene una lista de entidades de cuenta de Batch asociadas a la suscripción. |
|
Other Status Codes |
Respuesta de error que describe por qué se produjo un error en la operación. |
Seguridad
azure_auth
Flujo de código de autenticación de Microsoft Entra OAuth 2.0
Tipo:
oauth2
Flujo:
implicit
Dirección URL de autorización:
https://login.microsoftonline.com/common/oauth2/authorize
Ámbitos
Nombre | Description |
---|---|
user_impersonation | suplantar la cuenta de usuario |
Ejemplos
BatchAccountList
Solicitud de ejemplo
Respuesta de muestra
{
"value": [
{
"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"
}
]
}
Definiciones
Nombre | Description |
---|---|
Authentication |
Modo de autenticación para la cuenta de Batch. |
Auto |
Modo de autenticación que usará el servicio Batch para administrar la cuenta de almacenamiento automático. |
Auto |
Contiene información sobre la cuenta de almacenamiento automático asociada a una cuenta de Batch. |
Batch |
Contiene información sobre una cuenta de Azure Batch. |
Batch |
Identidad de la cuenta de Batch, si está configurada. Esto se usa cuando el usuario especifica "Microsoft.KeyVault" como configuración de cifrado de cuenta de Batch o cuando se selecciona |
Batch |
Valores devueltos por la operación List. |
Cloud |
Respuesta de error del servicio Batch. |
Cloud |
Respuesta de error del servicio Batch. |
Compute |
Referencia a una identidad asignada por el usuario asociada al grupo de Batch que usará un nodo de proceso. |
Encryption |
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. |
Endpoint |
Acción predeterminada cuando no hay ninguna coincidencia de IPRule. |
Endpoint |
Perfil de acceso de red para el punto de conexión de Batch. |
IPRule |
Regla para filtrar la dirección IP del cliente. |
IPRule |
Acción cuando se coincide con la dirección IP del cliente. |
Key |
Tipo del origen de la clave. |
Key |
Configuración de KeyVault al usar un keySource de cifrado de Microsoft.KeyVault. |
Key |
Identifica el almacén de claves de Azure asociado a una cuenta de Batch. |
Network |
Perfil de red para la cuenta de Batch, que contiene la configuración de reglas de red para cada punto de conexión. |
Pool |
Modo de asignación para crear grupos en la cuenta de Batch. |
Private |
Punto de conexión privado de la conexión del punto de conexión privado. |
Private |
Contiene información sobre un recurso de vínculo privado. |
Private |
Estado de aprovisionamiento de la conexión del punto de conexión privado. |
Private |
Estado de conexión del servicio private link de la conexión del punto de conexión privado |
Private |
Estado de la conexión del punto de conexión privado de Batch |
Provisioning |
Estado aprovisionado del recurso |
Public |
Tipo de acceso de red para operar en los recursos de la cuenta de Batch. |
Resource |
Tipo de identidad que se usa para la cuenta de Batch. |
User |
Lista de identidades de usuario asociadas. |
Virtual |
Familia de máquinas virtuales y su cuota de núcleos asociada para la cuenta de Batch. |
AuthenticationMode
Modo de autenticación para la cuenta de Batch.
Valor | Description |
---|---|
AAD |
Modo de autenticación mediante el identificador de Entra de Microsoft. |
SharedKey |
Modo de autenticación mediante claves compartidas. |
TaskAuthenticationToken |
Modo de autenticación mediante tokens de autenticación de tareas. |
AutoStorageAuthenticationMode
Modo de autenticación que usará el servicio Batch para administrar la cuenta de almacenamiento automático.
Valor | Description |
---|---|
BatchAccountManagedIdentity |
El servicio Batch autenticará las solicitudes de almacenamiento automático mediante la identidad administrada asignada a la cuenta de Batch. |
StorageKeys |
El servicio Batch autenticará las solicitudes de almacenamiento automático mediante claves de cuenta de almacenamiento. |
AutoStorageProperties
Contiene información sobre la cuenta de almacenamiento automático asociada a una cuenta de Batch.
Nombre | Tipo | Valor predeterminado | Description |
---|---|---|---|
authenticationMode | StorageKeys |
Modo de autenticación que usará el servicio Batch para administrar la cuenta de almacenamiento automático. |
|
lastKeySync |
string (date-time) |
Hora UTC a la que las claves de almacenamiento se sincronizaron por última vez con la cuenta de Batch. |
|
nodeIdentityReference |
Referencia a la identidad asignada por el usuario que usarán los nodos de proceso para acceder al almacenamiento automático. |
||
storageAccountId |
string (arm-id) |
Identificador de recurso de la cuenta de almacenamiento que se va a usar para la cuenta de almacenamiento automático. |
BatchAccount
Contiene información sobre una cuenta de Azure Batch.
Nombre | Tipo | Valor predeterminado | Description |
---|---|---|---|
id |
string |
Identificador del recurso. |
|
identity |
Identidad de la cuenta de Batch. |
||
location |
string |
Ubicación del recurso. |
|
name |
string |
Nombre del recurso. |
|
properties.accountEndpoint |
string |
Punto de conexión de cuenta que se usa para interactuar con el servicio Batch. |
|
properties.activeJobAndJobScheduleQuota |
integer (int32) |
Cuota de programación de trabajos y trabajos activos para la cuenta de Batch. |
|
properties.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. |
||
properties.autoStorage |
Propiedades y estado de cualquier cuenta de almacenamiento automático asociada a la cuenta de Batch. |
||
properties.dedicatedCoreQuota |
integer (int32) |
Cuota de núcleo dedicada para la cuenta de Batch. |
|
properties.dedicatedCoreQuotaPerVMFamily |
Lista de la cuota de núcleos dedicada por familia de máquinas virtuales para la cuenta de Batch. En el caso de las cuentas con PoolAllocationMode establecida en UserSubscription, la cuota se administra en la suscripción para que este valor no se devuelva. |
||
properties.dedicatedCoreQuotaPerVMFamilyEnforced |
boolean |
Valor que indica si se aplican cuotas de núcleos por familia de máquinas virtuales para esta cuenta. |
|
properties.encryption |
Configuración de cifrado de la cuenta de Batch. |
||
properties.keyVaultReference |
Referencia al almacén de claves de Azure asociado a la cuenta de Batch. |
||
properties.lowPriorityCoreQuota |
integer (int32) |
Cuota de núcleos de prioridad baja o de acceso puntual para la cuenta de Batch. |
|
properties.networkProfile |
Perfil de red para la cuenta de Batch, que contiene la configuración de reglas de red para cada punto de conexión. |
||
properties.nodeManagementEndpoint |
string |
Punto de conexión usado por el nodo de proceso para conectarse al servicio de administración de nodos de Batch. |
|
properties.poolAllocationMode |
Modo de asignación que se va a usar para crear grupos en la cuenta de Batch. |
||
properties.poolQuota |
integer (int32) |
Cuota de grupo para la cuenta de Batch. |
|
properties.privateEndpointConnections |
Lista de conexiones de punto de conexión privado asociadas a la cuenta de Batch |
||
properties.provisioningState |
Estado aprovisionado del recurso |
||
properties.publicNetworkAccess | Enabled |
El tipo de interfaz de red para acceder al servicio Azure Batch y a las operaciones de cuenta de Batch. |
|
tags |
object |
Etiquetas del recurso. |
|
type |
string |
Tipo del recurso. |
BatchAccountIdentity
Identidad de la cuenta de Batch, si está configurada. Esto se usa cuando el usuario especifica "Microsoft.KeyVault" como configuración de cifrado de cuenta de Batch o cuando se selecciona ManagedIdentity
como modo de autenticación de almacenamiento automático.
Nombre | Tipo | Description |
---|---|---|
principalId |
string |
Identificador de entidad de seguridad de la cuenta de Batch. Esta propiedad solo se proporcionará para una identidad asignada por el sistema. |
tenantId |
string |
Identificador de inquilino asociado a la cuenta de Batch. Esta propiedad solo se proporcionará para una identidad asignada por el sistema. |
type |
Tipo de identidad que se usa para la cuenta de Batch. |
|
userAssignedIdentities |
<string,
User |
Lista de identidades de usuario asociadas a la cuenta de Batch. |
BatchAccountListResult
Valores devueltos por la operación List.
Nombre | Tipo | Description |
---|---|---|
nextLink |
string |
Token de continuación. |
value |
Colección de cuentas de Batch devueltas por la operación de lista. |
CloudError
Respuesta de error del servicio Batch.
Nombre | Tipo | Description |
---|---|---|
error |
Cuerpo de la respuesta de error. |
CloudErrorBody
Respuesta de error del servicio Batch.
Nombre | Tipo | Description |
---|---|---|
code |
string |
Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación. |
details |
Lista de detalles adicionales sobre el error. |
|
message |
string |
Mensaje que describe el error, diseñado para ser adecuado para mostrarse en una interfaz de usuario. |
target |
string |
Destino del error concreto. Por ejemplo, el nombre de la propiedad en error. |
ComputeNodeIdentityReference
Referencia a una identidad asignada por el usuario asociada al grupo de Batch que usará un nodo de proceso.
Nombre | Tipo | Description |
---|---|---|
resourceId |
string |
Identificador de recurso de ARM de la identidad asignada por el usuario. |
EncryptionProperties
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.
Nombre | Tipo | Description |
---|---|---|
keySource |
Tipo del origen de la clave. |
|
keyVaultProperties |
Detalles adicionales al usar Microsoft.KeyVault |
EndpointAccessDefaultAction
Acción predeterminada cuando no hay ninguna coincidencia de IPRule.
Valor | Description |
---|---|
Allow |
Permitir el acceso de cliente. |
Deny |
Denegar el acceso de cliente. |
EndpointAccessProfile
Perfil de acceso de red para el punto de conexión de Batch.
Nombre | Tipo | Description |
---|---|---|
defaultAction |
Acción predeterminada cuando no hay ninguna coincidencia de IPRule. |
|
ipRules |
IPRule[] |
Matriz de intervalos IP para filtrar la dirección IP del cliente. |
IPRule
Regla para filtrar la dirección IP del cliente.
Nombre | Tipo | Description |
---|---|---|
action |
Acción cuando se coincide con la dirección IP del cliente. |
|
value |
string |
La dirección IP o el intervalo de direcciones IP que se van a filtrar |
IPRuleAction
Acción cuando se coincide con la dirección IP del cliente.
Valor | Description |
---|---|
Allow |
Permita el acceso a la dirección IP del cliente coincidente. |
KeySource
Tipo del origen de la clave.
Valor | Description |
---|---|
Microsoft.Batch |
Batch crea y administra las claves de cifrado usadas para proteger los datos de la cuenta. |
Microsoft.KeyVault |
Las claves de cifrado usadas para proteger los datos de la cuenta se almacenan en un almacén de claves externo. Si se establece, la identidad de la cuenta de Batch debe establecerse en |
KeyVaultProperties
Configuración de KeyVault al usar un keySource de cifrado de Microsoft.KeyVault.
Nombre | Tipo | Description |
---|---|---|
keyIdentifier |
string |
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 La identidad de la cuenta se le ha concedido los permisos Key/Get, Key/Unwrap y Key/Wrap. KeyVault tiene habilitada la protección de eliminación temporal y purga. |
KeyVaultReference
Identifica el almacén de claves de Azure asociado a una cuenta de Batch.
Nombre | Tipo | Description |
---|---|---|
id |
string (arm-id) |
Identificador de recurso del almacén de claves de Azure asociado a la cuenta de Batch. |
url |
string |
Dirección URL del almacén de claves de Azure asociado a la cuenta de Batch. |
NetworkProfile
Perfil de red para la cuenta de Batch, que contiene la configuración de reglas de red para cada punto de conexión.
Nombre | Tipo | Description |
---|---|---|
accountAccess |
Perfil de acceso de red para el punto de conexión batchAccount (API del plano de datos de la cuenta de Batch). |
|
nodeManagementAccess |
Perfil de acceso de red para el punto de conexión nodeManagement (servicio Batch que administra nodos de proceso para grupos de Batch). |
PoolAllocationMode
Modo de asignación para crear grupos en la cuenta de Batch.
Valor | Description |
---|---|
BatchService |
Los grupos se asignarán en suscripciones propiedad del servicio Batch. |
UserSubscription |
Los grupos se asignarán en una suscripción propiedad del usuario. |
PrivateEndpoint
Punto de conexión privado de la conexión del punto de conexión privado.
Nombre | Tipo | Description |
---|---|---|
id |
string |
Identificador de recurso de ARM del punto de conexión privado. Este es el formato /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}. |
PrivateEndpointConnection
Contiene información sobre un recurso de vínculo privado.
Nombre | Tipo | Description |
---|---|---|
etag |
string |
ETag del recurso, que se usa para las instrucciones de simultaneidad. |
id |
string |
Identificador del recurso. |
name |
string |
Nombre del recurso. |
properties.groupIds |
string[] |
Identificador de grupo de la conexión de punto de conexión privado. |
properties.privateEndpoint |
Identificador de recurso de ARM del punto de conexión privado. |
|
properties.privateLinkServiceConnectionState |
Estado de conexión del servicio private link de la conexión del punto de conexión privado. |
|
properties.provisioningState |
Estado de aprovisionamiento de la conexión del punto de conexión privado. |
|
tags |
object |
Etiquetas del recurso. |
type |
string |
Tipo del recurso. |
PrivateEndpointConnectionProvisioningState
Estado de aprovisionamiento de la conexión del punto de conexión privado.
Valor | Description |
---|---|
Cancelled |
El usuario ha cancelado la creación de la conexión. |
Creating |
La conexión se está creando. |
Deleting |
La conexión se está eliminando. |
Failed |
El usuario solicitó que se actualice la conexión y se produjo un error. Puede reintentar la operación de actualización. |
Succeeded |
El estado de conexión es final y está listo para su uso si el estado es Aprobado. |
Updating |
El usuario ha solicitado que se actualice el estado de conexión, pero la operación de actualización aún no se ha completado. Es posible que no haga referencia a la conexión al conectar la cuenta de Batch. |
PrivateLinkServiceConnectionState
Estado de conexión del servicio private link de la conexión del punto de conexión privado
Nombre | Tipo | Description |
---|---|---|
actionsRequired |
string |
Acción necesaria en el estado de conexión privada |
description |
string |
Descripción del estado de conexión privado |
status |
Estado de la conexión de punto de conexión privado de la cuenta de Batch |
PrivateLinkServiceConnectionStatus
Estado de la conexión del punto de conexión privado de Batch
Valor | Description |
---|---|
Approved |
Se aprueba la conexión del punto de conexión privado y se puede usar para acceder a la cuenta de Batch. |
Disconnected |
La conexión del punto de conexión privado está desconectada y no se puede usar para acceder a la cuenta de Batch. |
Pending |
La conexión del punto de conexión privado está pendiente y no se puede usar para acceder a la cuenta de Batch. |
Rejected |
Se rechaza la conexión del punto de conexión privado y no se puede usar para acceder a la cuenta de Batch. |
ProvisioningState
Estado aprovisionado del recurso
Valor | Description |
---|---|
Cancelled |
Se cancela la última operación de la cuenta. |
Creating |
La cuenta se está creando. |
Deleting |
La cuenta se está eliminando. |
Failed |
Error en la última operación de la cuenta. |
Invalid |
La cuenta está en un estado no válido. |
Succeeded |
La cuenta se ha creado y está lista para su uso. |
PublicNetworkAccessType
Tipo de acceso de red para operar en los recursos de la cuenta de Batch.
Valor | Description |
---|---|
Disabled |
Deshabilita la conectividad pública y habilita la conectividad privada con el servicio Azure Batch a través del recurso de punto de conexión privado. |
Enabled |
Habilita la conectividad a Azure Batch a través de DNS público. |
SecuredByPerimeter |
Protege la conectividad con Azure Batch mediante la configuración de NSP. |
ResourceIdentityType
Tipo de identidad que se usa para la cuenta de Batch.
Valor | Description |
---|---|
None |
La cuenta de Batch no tiene ninguna identidad asociada. Al establecer |
SystemAssigned |
La cuenta de Batch tiene una identidad asignada por el sistema con ella. |
UserAssigned |
La cuenta de Batch tiene identidades asignadas por el usuario con ella. |
UserAssignedIdentities
Lista de identidades de usuario asociadas.
Nombre | Tipo | Description |
---|---|---|
clientId |
string |
Identificador de cliente de la identidad asignada por el usuario. |
principalId |
string |
Identificador principal de la identidad asignada por el usuario. |
VirtualMachineFamilyCoreQuota
Familia de máquinas virtuales y su cuota de núcleos asociada para la cuenta de Batch.
Nombre | Tipo | Description |
---|---|---|
coreQuota |
integer (int32) |
Cuota de núcleos de la familia de máquinas virtuales para la cuenta de Batch. |
name |
string |
Nombre de familia de la máquina virtual. |