BatchAccountListResult

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-azure-batch/json-schema/microsoft-azure-batch-batch-account-list-result-schema.json",
  "title": "BatchAccountListResult",
  "description": "Paged collection of BatchAccount items",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_superseded/microsoft-azure-batch-batchaccount-api-openapi.yml#/components/schemas/BatchAccountListResult",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "description": "The BatchAccount items on this page",
      "items": {
        "$ref": "#/$defs/BatchAccount"
      },
      "x-ms-identifiers": [
        "/properties/accountEndpoint"
      ]
    },
    "nextLink": {
      "type": "string",
      "format": "uri",
      "description": "The link to the next page of items"
    }
  },
  "required": [
    "value"
  ],
  "$defs": {
    "AuthenticationMode": {
      "type": "string",
      "description": "The authentication mode for the Batch account.",
      "enum": [
        "SharedKey",
        "AAD",
        "TaskAuthenticationToken"
      ],
      "x-ms-enum": {
        "name": "AuthenticationMode",
        "modelAsString": false,
        "values": [
          {
            "name": "SharedKey",
            "value": "SharedKey",
            "description": "The authentication mode using shared keys."
          },
          {
            "name": "AAD",
            "value": "AAD",
            "description": "The authentication mode using Microsoft Entra ID."
          },
          {
            "name": "TaskAuthenticationToken",
            "value": "TaskAuthenticationToken",
            "description": "The authentication mode using task authentication tokens."
          }
        ]
      }
    },
    "AutoStorageBaseProperties": {
      "type": "object",
      "description": "The properties related to the auto-storage account.",
      "properties": {
        "storageAccountId": {
          "type": "string",
          "format": "arm-id",
          "description": "The resource ID of the storage account to be used for auto-storage account.",
          "x-ms-arm-id-details": {
            "allowedResources": [
              {
                "type": "Microsoft.Storage/storageAccounts"
              }
            ]
          }
        },
        "authenticationMode": {
          "type": "string",
          "description": "The authentication mode which the Batch service will use to manage the auto-storage account.",
          "default": "StorageKeys",
          "enum": [
            "StorageKeys",
            "BatchAccountManagedIdentity"
          ],
          "x-ms-enum": {
            "name": "AutoStorageAuthenticationMode",
            "modelAsString": false,
            "values": [
              {
                "name": "StorageKeys",
                "value": "StorageKeys",
                "description": "The Batch service will authenticate requests to auto-storage using storage account keys."
              },
              {
                "name": "BatchAccountManagedIdentity",
                "value": "BatchAccountManagedIdentity",
                "description": "The Batch service will authenticate requests to auto-storage using the managed identity assigned to the Batch account."
              }
            ]
          }
        },
        "nodeIdentityReference": {
          "$ref": "#/$defs/ComputeNodeIdentityReference",
          "title": "The reference to the user assigned identity which compute nodes will use to access auto-storage.",
          "description": "The identity referenced here must be assigned to pools which have compute nodes that need access to auto-storage."
        }
      },
      "required": [
        "storageAccountId"
      ]
    },
    "AutoStorageProperties": {
      "type": "object",
      "description": "Contains information about the auto-storage account associated with a Batch account.",
      "properties": {
        "lastKeySync": {
          "type": "string",
          "format": "date-time",
          "description": "The UTC time at which storage keys were last synchronized with the Batch account."
        }
      },
      "required": [
        "lastKeySync"
      ],
      "allOf": [
        {
          "$ref": "#/$defs/AutoStorageBaseProperties"
        }
      ]
    },
    "BatchAccount": {
      "type": "object",
      "description": "Contains information about an Azure Batch account.",
      "properties": {
        "properties": {
          "$ref": "#/$defs/BatchAccountProperties",
          "description": "The properties associated with the account.",
          "x-ms-client-flatten": true
        },
        "identity": {
          "$ref": "#/$defs/BatchAccountIdentity",
          "description": "The identity of the Batch account."
        }
      },
      "allOf": [
        {
          "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource"
        }
      ]
    },
    "BatchAccountIdentity": {
      "type": "object",
      "description": "The identity of the Batch account, if configured. This is used when the user specifies 'Microsoft.KeyVault' as their Batch account encryption configuration or when `ManagedIdentity` is selected as the auto-storage authentication mode.",
      "properties": {
        "principalId": {
          "type": "string",
          "description": "The principal id of the Batch account. This property will only be provided for a system assigned identity.",
          "readOnly": true
        },
        "tenantId": {
          "type": "string",
          "description": "The tenant id associated with the Batch account. This property will only be provided for a system assigned identity.",
          "readOnly": true
        },
        "type": {
          "$ref": "#/$defs/ResourceIdentityType",
          "description": "The type of identity used for the Batch account."
        },
        "userAssignedIdentities": {
          "type": "object",
          "description": "The list of user identities associated with the Batch account.",
          "additionalProperties": {
            "$ref": "#/$defs/UserAssignedIdentities"
          }
        }
      },
      "required": [
        "type"
      ]
    },
    "BatchAccountProperties": {
      "type": "object",
      "description": "Account specific properties.",
      "properties": {
        "accountEndpoint": {
          "type": "string",
          "description": "The account endpoint used to interact with the Batch service.",
          "readOnly": true
        },
        "nodeManagementEndpoint": {
          "type": "string",
          "description": "The endpoint used by compute node to connect to the Batch node management service.",
          "readOnly": true
        },
        "provisioningState": {
          "$ref": "#/$defs/ProvisioningState",
          "description": "The provisioned state of the resource",
          "readOnly": true
        },
        "poolAllocationMode": {
          "$ref": "#/$defs/PoolAllocationMode",
          "title": "The allocation mode to use for creating pools in the Batch account.",
          "description": "The allocation mode for creating pools in the Batch account.",
          "readOnly": true
        },
        "keyVaultReference": {
          "$ref": "#/$defs/KeyVaultReference",
          "title": "A reference to the Azure key vault associated with the Batch account.",
          "description": "Identifies the Azure key vault associated with a Batch account.",
          "readOnly": true
        },
        "publicNetworkAccess": {
          "type": [
            "string",
            "null"
          ],
          "title": "The network interface type for accessing Azure Batch service and Batch account operations.",
          "description": "The network access type for operating on the resources in the Batch account.",
          "default": "Enabled",
          "enum": [
            "Enabled",
            "Disabled",
            "SecuredByPerimeter"
          ],
          "x-ms-enum": {
            "name": "PublicNetworkAccessType",
            "modelAsString": false,
            "values": [
              {
                "name": "Enabled",
                "value": "Enabled",
                "description": "Enables connectivity to Azure Batch through public DNS."
              },
              {
                "name": "Disabled",
                "value": "Disabled",
                "description": "Disables public connectivity and enables private connectivity to Azure Batch Service through private endpoint resource."
              },
              {
                "name": "SecuredByPerimeter",
                "value": "SecuredByPerimeter",
                "description": "Secures connectivity to Azure Batch through NSP configuration."
              }
            ]
          }
        },
        "networkProfile": {
          "$ref": "#/$defs/NetworkProfile",
          "title": "Network profile for Batch account, which contains network rule settings for each endpoint.",
          "description": "The network profile only takes effect when publicNetworkAccess is enabled."
        },
        "privateEndpointConnections": {
          "type": [
            "array",
            "null"
          ],
          "description": "List of private endpoint connections associated with the Batch account",
          "items": {
            "$ref": "#/$defs/PrivateEndpointConnection"
          },
          "readOnly": true
        },
        "autoStorage": {
          "$ref": "#/$defs/AutoStorageProperties",
          "title": "The properties and status of any auto-storage account associated with the Batch account.",
          "description": "Contains information about the auto-storage account associated with a Batch account.",
          "readOnly": true
        },
        "encryption": {
          "$ref": "#/$defs/EncryptionProperties",
          "title": "The encryption configuration for the Batch account.",
          "description": "Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead.",
          "readOnly": true
        },
        "dedicatedCoreQuota": {
          "type": [
            "integer",
            "null"
          ],
          "format": "int32",
          "title": "The dedicated core quota for the Batch account.",
          "description": "For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.",
          "readOnly": true
        },
        "lowPriorityCoreQuota": {
          "type": [
            "integer",
            "null"
          ],
          "format": "int32",
          "title": "The Spot/low-priority core quota for the Batch account.",
          "description": "For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.",
          "readOnly": true
        },
        "dedicatedCoreQuotaPerVMFamily": {
          "type": [
            "array",
            "null"
          ],
          "description": "A list of the dedicated core quota per Virtual Machine family for the Batch account. For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.",
          "items": {
            "$ref": "#/$defs/VirtualMachineFamilyCoreQuota"
          },
          "readOnly": true,
          "x-ms-identifiers": [
            "name"
          ]
        },
        "dedicatedCoreQuotaPerVMFamilyEnforced": {
          "type": "boolean",
          "title": "A value indicating whether core quotas per Virtual Machine family are enforced for this account",
          "description": "If this flag is true, dedicated core quota is enforced via both the dedicatedCoreQuotaPerVMFamily and dedicatedCoreQuota properties on the account. If this flag is false, dedicated core quota is enforced only via the dedicatedCoreQuota property on the account and does not consider Virtual Machine family.",
          "readOnly": true
        },
        "poolQuota": {
          "type": "integer",
          "format": "int32",
          "title": "The pool quota for the Batch account.",
          "description": "The pool quota for the Batch account.",
          "readOnly": true
        },
        "activeJobAndJobScheduleQuota": {
          "type": "integer",
          "format": "int32",
          "title": "The active job and job schedule quota for the Batch account.",
          "description": "The active job and job schedule quota for the Batch account.",
          "readOnly": true
        },
        "allowedAuthenticationModes": {
          "type": [
            "array",
            "null"
          ],
          "description": "List of allowed authentication modes for the Batch account that can be used to authenticate with the data plane. This does not affect authentication with the control plane.",
          "items": {
            "$ref": "#/$defs/AuthenticationMode"
          },
          "readOnly": true
        }
      }
    },
    "ComputeNodeIdentityReference": {
      "type": "object",
      "description": "The reference to a user assigned identity associated with the Batch pool which a compute node will use.",
      "properties": {
        "resourceId": {
          "type": "string",
          "description": "The ARM resource id of the user assigned identity."
        }
      }
    },
    "EncryptionProperties": {
      "type": "object",
      "description": "Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead.",
      "properties": {
        "keySource": {
          "$ref": "#/$defs/KeySource",
          "description": "Type of the key source."
        },
        "keyVaultProperties": {
          "$ref": "#/$defs/KeyVaultProperties",
          "description": "Additional details when using Microsoft.KeyVault"
        }
      }
    },
    "EndpointAccessDefaultAction": {
      "type": "string",
      "description": "Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled.",
      "enum": [
        "Allow",
        "Deny"
      ],
      "x-ms-enum": {
        "name": "EndpointAccessDefaultAction",
        "modelAsString": false,
        "values": [
          {
            "name": "Allow",
            "value": "Allow",
            "description": "Allow client access."
          },
          {
            "name": "Deny",
            "value": "Deny",
            "description": "Deny client access."
          }
        ]
      }
    },
    "EndpointAccessProfile": {
      "type": "object",
      "description": "Network access profile for Batch endpoint.",
      "properties": {
        "defaultAction": {
          "$ref": "#/$defs/EndpointAccessDefaultAction",
          "title": "The default action when there is no IPRule matched.",
          "description": "Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled."
        },
        "ipRules": {
          "type": "array",
          "description": "Array of IP ranges to filter client IP address.",
          "items": {
            "$ref": "#/$defs/IPRule"
          },
          "x-ms-identifiers": [
            "action"
          ]
        }
      },
      "required": [
        "defaultAction"
      ]
    },
    "IPRule": {
      "type": "object",
      "description": "Rule to filter client IP address.",
      "properties": {
        "action": {
          "$ref": "#/$defs/IPRuleAction",
          "description": "Action when client IP address is matched."
        },
        "value": {
          "type": "string",
          "title": "The IP address or IP address range to filter",
          "description": "IPv4 address, or IPv4 address range in CIDR format."
        }
      },
      "required": [
        "action",
        "value"
      ]
    },
    "IPRuleAction": {
      "type": "string",
      "description": "The action when client IP address is matched.",
      "enum": [
        "Allow"
      ],
      "x-ms-enum": {
        "name": "IPRuleAction",
        "modelAsString": false,
        "values": [
          {
            "name": "Allow",
            "value": "Allow",
            "description": "Allow access for the matched client IP address."
          }
        ]
      }
    },
    "KeySource": {
      "type": "string",
      "description": "Type of the key source.",
      "enum": [
        "Microsoft.Batch",
        "Microsoft.KeyVault"
      ],
      "x-ms-enum": {
        "name": "KeySource",
        "modelAsString": false,
        "values": [
          {
            "name": "Microsoft.Batch",
            "value": "Microsoft.Batch",
            "description": "Batch creates and manages the encryption keys used to protect the account data."
          },
          {
            "name": "Microsoft.KeyVault",
            "value": "Microsoft.KeyVault",
            "description": "The encryption keys used to protect the account data are stored in an external key vault. If this is set then the Batch Account identity must be set to `SystemAssigned` and a valid Key Identifier must also be supplied under the keyVaultProperties."
          }
        ]
      }
    },
    "KeyVaultProperties": {
      "type": "object",
      "description": "KeyVault configuration when using an encryption KeySource of Microsoft.KeyVault.",
      "properties": {
        "keyIdentifier": {
          "type": "string",
          "description": "Full path to the secret with or without version. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. or https://mykeyvault.vault.azure.net/keys/testkey. To be usable the following prerequisites must be met:\n\nThe Batch Account has a System Assigned identity\nThe account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions\nThe KeyVault has soft-delete and purge protection enabled"
        }
      }
    },
    "KeyVaultReference": {
      "type": "object",
      "description": "Identifies the Azure key vault associated with a Batch account.",
      "properties": {
        "id": {
          "type": "string",
          "format": "arm-id",
          "description": "The resource ID of the Azure key vault associated with the Batch account.",
          "x-ms-arm-id-details": {
            "allowedResources": [
              {
                "type": "Microsoft.KeyVault/vaults"
              }
            ]
          }
        },
        "url": {
          "type": "string",
          "description": "The URL of the Azure key vault associated with the Batch account."
        }
      },
      "required": [
        "id",
        "url"
      ]
    },
    "NetworkProfile": {
      "type": "object",
      "description": "Network profile for Batch account, which contains network rule settings for each endpoint.",
      "properties": {
        "accountAccess": {
          "$ref": "#/$defs/EndpointAccessProfile",
          "description": "Network access profile for batchAccount endpoint (Batch account data plane API)."
        },
        "nodeManagementAccess": {
          "$ref": "#/$defs/EndpointAccessProfile",
          "description": "Network access profile for nodeManagement endpoint (Batch service managing compute nodes for Batch pools)."
        }
      }
    },
    "PoolAllocationMode": {
      "type": "string",
      "description": "The allocation mode for creating pools in the Batch account.",
      "enum": [
        "BatchService",
        "UserSubscription"
      ],
      "x-ms-enum": {
        "name": "PoolAllocationMode",
        "modelAsString": false,
        "values": [
          {
            "name": "BatchService",
            "value": "BatchService",
            "description": "Pools will be allocated in subscriptions owned by the Batch service."
          },
          {
            "name": "UserSubscription",
            "value": "UserSubscription",
            "description": "Pools will be allocated in a subscription owned by the user."
          }
        ]
      }
    },
    "PrivateEndpoint": {
      "type": "object",
      "description": "The private endpoint of the private endpoint connection.",
      "properties": {
        "id": {
          "type": "string",
          "title": "The ARM resource identifier of the private endpoint. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}.",
          "description": "The ARM resource identifier of the private endpoint. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}.",
          "readOnly": true
        }
      }
    },
    "PrivateEndpointConnection": {
      "type": "object",
      "description": "Contains information about a private link resource.",
      "properties": {
        "properties": {
          "$ref": "#/$defs/PrivateEndpointConnectionProperties",
          "description": "The properties associated with the private endpoint connection.",
          "x-ms-client-flatten": true
        },
        "etag": {
          "type": "string",
          "description": "The ETag of the resource, used for concurrency statements.",
          "readOnly": true
        },
        "tags": {
          "type": "object",
          "description": "The tags of the resource.",
          "additionalProperties": {
            "type": "string"
          }
        }
      },
      "allOf": [
        {
          "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
        }
      ]
    },
    "PrivateEndpointConnectionProperties": {
      "type": "object",
      "description": "Private endpoint connection properties.",
      "properties": {
        "provisioningState": {
          "$ref": "#/$defs/PrivateEndpointConnectionProvisioningState",
          "title": "The provisioning state of the private endpoint connection.",
          "description": "The provisioning state of the private endpoint connection.",
          "readOnly": true
        },
        "privateEndpoint": {
          "$ref": "#/$defs/PrivateEndpoint",
          "title": "The ARM resource identifier of the private endpoint.",
          "description": "The private endpoint of the private endpoint connection.",
          "readOnly": true
        },
        "groupIds": {
          "type": "array",
          "title": "The group id of the private endpoint connection.",
          "description": "The value has one and only one group id.",
          "items": {
            "type": "string"
          },
          "readOnly": true
        },
        "privateLinkServiceConnectionState": {
          "$ref": "#/$defs/PrivateLinkServiceConnectionState",
          "title": "The private link service connection state of the private endpoint connection.",
          "description": "The private link service connection state of the private endpoint connection."
        }
      }
    },
    "PrivateEndpointConnectionProvisioningState": {
      "type": "string",
      "description": "The provisioning state of the private endpoint connection.",
      "enum": [
        "Creating",
        "Updating",
        "Deleting",
        "Succeeded",
        "Failed",
        "Cancelled"
      ],
      "x-ms-enum": {
        "name": "PrivateEndpointConnectionProvisioningState",
        "modelAsString": false,
        "values": [
          {
            "name": "Creating",
            "value": "Creating",
            "description": "The connection is creating."
          },
          {
            "name": "Updating",
            "value": "Updating",
            "description": "The user has requested that the connection status be updated, but the update operation has not yet completed. You may not reference the connection when connecting the Batch account."
          },
          {
            "name": "Deleting",
            "value": "Deleting",
            "description": "The connection is deleting."
          },
          {
            "name": "Succeeded",
            "value": "Succeeded",
            "description": "The connection status is final and is ready for use if Status is Approved."
          },
          {
            "name": "Failed",
            "value": "Failed",
            "description": "The user requested that the connection be updated and it failed. You may retry the update operation."
          },
          {
            "name": "Cancelled",
            "value": "Cancelled",
            "description": "The user has cancelled the connection creation."
          }
        ]
      },
      "readOnly": true
    },
    "PrivateLinkServiceConnectionState": {
      "type": "object",
      "description": "The private link service connection state of the private endpoint connection",
      "properties": {
        "status": {
          "$ref": "#/$defs/PrivateLinkServiceConnectionStatus",
          "title": "The status of the Batch private endpoint connection",
          "description": "The status of the Batch private endpoint connection"
        },
        "description": {
          "type": "string",
          "title": "Description of the private Connection state",
          "description": "Description of the private Connection state"
        },
        "actionsRequired": {
          "type": "string",
          "title": "Action required on the private connection state",
          "description": "Action required on the private connection state",
          "readOnly": true
        }
      },
      "required": [
        "status"
      ]
    },
    "PrivateLinkServiceConnectionStatus": {
      "type": "string",
      "description": "The status of the Batch private endpoint connection",
      "enum": [
        "Approved",
        "Pending",
        "Rejected",
        "Disconnected"
      ],
      "x-ms-enum": {
        "name": "PrivateLinkServiceConnectionStatus",
        "modelAsString": false,
        "values": [
          {
            "name": "Approved",
            "value": "Approved",
            "description": "The private endpoint connection is approved and can be used to access Batch account"
          },
          {
            "name": "Pending",
            "value": "Pending",
            "description": "The private endpoint connection is pending and cannot be used to access Batch account"
          },
          {
            "name": "Rejected",
            "value": "Rejected",
            "description": "The private endpoint connection is rejected and cannot be used to access Batch account"
          },
          {
            "name": "Disconnected",
            "value": "Disconnected",
            "description": "The private endpoint connection is disconnected and cannot be used to access Batch account"
          }
        ]
      }
    },
    "ProvisioningState": {
      "type": "string",
      "description": "The provisioned state of the resource",
      "enum": [
        "Invalid",
        "Creating",
        "Deleting",
        "Succeeded",
        "Failed",
        "Cancelled"
      ],
      "x-ms-enum": {
        "name": "ProvisioningState",
        "modelAsString": false,
        "values": [
          {
            "name": "Invalid",
            "value": "Invalid",
            "description": "The account is in an invalid state."
          },
          {
            "name": "Creating",
            "value": "Creating",
            "description": "The account is being created."
          },
          {
            "name": "Deleting",
            "value": "Deleting",
            "description": "The account is being deleted."
          },
          {
            "name": "Succeeded",
            "value": "Succeeded",
            "description": "The account has been created and is ready for use."
          },
          {
            "name": "Failed",
            "value": "Failed",
            "description": "The last operation for the account is failed."
          },
          {
            "name": "Cancelled",
            "value": "Cancelled",
            "description": "The last operation for the account is cancelled."
          }
        ]
      },
      "readOnly": true
    },
    "ResourceIdentityType": {
      "type": "string",
      "description": "The type of identity used for the Batch account.",
      "enum": [
        "SystemAssigned",
        "UserAssigned",
        "None"
      ],
      "x-ms-enum": {
        "name": "ResourceIdentityType",
        "modelAsString": false,
        "values": [
          {
            "name": "SystemAssigned",
            "value": "SystemAssigned",
            "description": "Batch account has a system assigned identity with it."
          },
          {
            "name": "UserAssigned",
            "value": "UserAssigned",
            "description": "Batch account has user assigned identities with it."
          },
          {
            "name": "None",
            "value": "None",
            "description": "Batch account has no identity associated with it. Setting `None` in update account will remove existing identities."
          }
        ]
      }
    },
    "UserAssignedIdentities": {
      "type": "object",
      "description": "The list of associated user identities.",
      "properties": {
        "principalId": {
          "type": "string",
          "description": "The principal id of user assigned identity.",
          "readOnly": true
        },
        "clientId": {
          "type": "string",
          "description": "The client id of user assigned identity.",
          "readOnly": true
        }
      }
    },
    "VirtualMachineFamilyCoreQuota": {
      "type": "object",
      "description": "A VM Family and its associated core quota for the Batch account.",
      "properties": {
        "name": {
          "type": "string",
          "description": "The Virtual Machine family name.",
          "readOnly": true
        },
        "coreQuota": {
          "type": "integer",
          "format": "int32",
          "description": "The core quota for the VM family for the Batch account.",
          "readOnly": true
        }
      }
    }
  }
}