Microsoft Azure BatchAccount API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector BatchAccount API
schemes:
- https
tags:
- name: BatchAccount
paths:
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}:
    put:
      tags:
      - BatchAccount
      operationId: microsoftAzureBatchaccountCreate
      x-ms-examples:
        BatchAccountCreate_Default:
          $ref: ./examples/BatchAccountCreate_Default.json
        BatchAccountCreate_BYOS:
          $ref: ./examples/BatchAccountCreate_BYOS.json
        PrivateBatchAccountCreate:
          $ref: ./examples/PrivateBatchAccountCreate.json
        BatchAccountCreate_SystemAssignedIdentity:
          $ref: ./examples/BatchAccountCreate_SystemAssignedIdentity.json
        BatchAccountCreate_UserAssignedIdentity:
          $ref: ./examples/BatchAccountCreate_UserAssignedIdentity.json
      description: Creates a new Batch account with the specified parameters. Existing accounts cannot be updated with this API and should instead be updated with the Update Batch Account API.
      parameters:
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - name: accountName
        in: path
        required: true
        type: string
        pattern: ^[a-z0-9]+$
        minLength: 3
        maxLength: 24
        description: 'A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.'
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/BatchAccountCreateParameters'
        description: Additional parameters for account creation.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The operation was successful. The response contains the Batch account entity.
          schema:
            $ref: '#/definitions/BatchAccount'
        '202':
          description: The operation will be completed asynchronously.
          headers:
            Location:
              description: The URL of the resource used to check the status of the asynchronous operation.
              type: string
            Retry-After:
              description: Suggested delay to check the status of the asynchronous operation. The value is an integer that specifies the delay in seconds.
              type: integer
              format: int32
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname
    patch:
      tags:
      - BatchAccount
      operationId: microsoftAzureBatchaccountUpdate
      x-ms-examples:
        BatchAccountUpdate:
          $ref: ./examples/BatchAccountUpdate.json
      description: Updates the properties of an existing Batch account.
      parameters:
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/AccountNameParameter'
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/BatchAccountUpdateParameters'
        description: Additional parameters for account update.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The operation was successful. The response contains the Batch account entity.
          schema:
            $ref: '#/definitions/BatchAccount'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname
    delete:
      tags:
      - BatchAccount
      operationId: microsoftAzureBatchaccountDelete
      x-ms-examples:
        BatchAccountDelete:
          $ref: ./examples/BatchAccountDelete.json
      description: Deletes the specified Batch account.
      parameters:
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/AccountNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The operation was successful.
        '202':
          description: The operation will be completed asynchronously.
          headers:
            Location:
              description: The URL of the resource used to check the status of the asynchronous operation.
              type: string
            Retry-After:
              description: Suggested delay to check the status of the asynchronous operation. The value is an integer that specifies the delay in seconds.
              type: integer
              format: int32
        '204':
          description: NoContent -- account does not exist in the subscription.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname
    get:
      tags:
      - BatchAccount
      operationId: microsoftAzureBatchaccountGet
      x-ms-examples:
        BatchAccountGet:
          $ref: ./examples/BatchAccountGet.json
        PrivateBatchAccountGet:
          $ref: ./examples/PrivateBatchAccountGet.json
      description: Gets information about the specified Batch account.
      parameters:
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/AccountNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The operation was successful. The response contains the Batch account entity.
          schema:
            $ref: '#/definitions/BatchAccount'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname
  /subscriptions/{subscriptionId}/providers/Microsoft.Batch/batchAccounts:
    get:
      tags:
      - BatchAccount
      operationId: microsoftAzureBatchaccountList
      x-ms-examples:
        BatchAccountList:
          $ref: ./examples/BatchAccountList.json
      description: Gets information about the Batch accounts associated with the subscription.
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The operation was successful. The response contains a list of Batch account entities associated with the subscription.
          schema:
            $ref: '#/definitions/BatchAccountListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Batch Batchaccounts
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts:
    get:
      tags:
      - BatchAccount
      operationId: microsoftAzureBatchaccountListbyresourcegroup
      x-ms-examples:
        BatchAccountListByResourceGroup:
          $ref: ./examples/BatchAccountListByResourceGroup.json
      description: Gets information about the Batch accounts associated with the specified resource group.
      parameters:
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The operation was successful. The response contains a list of Batch account entities associated with the resource group.
          schema:
            $ref: '#/definitions/BatchAccountListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/syncAutoStorageKeys
  : post:
      tags:
      - BatchAccount
      operationId: microsoftAzureBatchaccountSynchronizeautostoragekeys
      x-ms-examples:
        BatchAccountSynchronizeAutoStorageKeys:
          $ref: ./examples/BatchAccountSynchronizeAutoStorageKeys.json
      description: Synchronizes access keys for the auto-storage account configured for the specified Batch account.
      parameters:
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/AccountNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '204':
          description: The operation was successful.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname Syncautostoragekeys
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/regenerateKeys
  : post:
      tags:
      - BatchAccount
      operationId: microsoftAzureBatchaccountRegeneratekey
      x-ms-examples:
        BatchAccountRegenerateKey:
          $ref: ./examples/BatchAccountRegenerateKey.json
      description: Regenerates the specified account key for the Batch account.
      parameters:
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/AccountNameParameter'
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/BatchAccountRegenerateKeyParameters'
        description: The type of key to regenerate.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The operation was successful. The response contains the Batch account keys.
          schema:
            $ref: '#/definitions/BatchAccountKeys'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname Regeneratekeys
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/listKeys
  : post:
      tags:
      - BatchAccount
      operationId: microsoftAzureBatchaccountGetkeys
      x-ms-examples:
        BatchAccountGetKeys:
          $ref: ./examples/BatchAccountGetKeys.json
      summary: Microsoft Azure Gets The Account Keys For The Specified Batch Account
      description: This operation applies only to Batch accounts created with a poolAllocationMode of 'BatchService'. If the Batch account was created with a poolAllocationMode of 'UserSubscription', clients cannot use access to keys to authenticate, and must use Azure Active Directory instead. In this case, getting the keys will fail.
      parameters:
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/AccountNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The operation was successful. The response contains the keys of the Batch account.
          schema:
            $ref: '#/definitions/BatchAccountKeys'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/outboundNetworkDependenciesEndpoints
  : get:
      tags:
      - BatchAccount
      operationId: microsoftAzureBatchaccountListoutboundnetworkdependenciesendpoints
      description: Lists the endpoints that a Batch Compute Node under this Batch Account may call as part of Batch service administration. If you are deploying a Pool inside of a virtual network that you specify, you must make sure your network allows outbound access to these endpoints. Failure to allow access to these endpoints may cause Batch to mark the affected nodes as unusable. For more information about creating a pool inside of a virtual network, see https://docs.microsoft.com/en-us/azure/batch/batch-virtual-network.
      x-ms-examples:
        ListOutboundNetworkDependencies:
          $ref: ./examples/BatchAccountListOutboundNetworkDependenciesEndpoints.json
      parameters:
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/AccountNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The operation was successful. The response contains a list of outbound network dependencies.
          schema:
            $ref: '#/definitions/OutboundEnvironmentEndpointCollection'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError_2'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Batch Batchaccounts Accountname Outboundnetworkdependenciesendpoints
definitions:
  ProxyResource:
    properties:
      id:
        readOnly: true
        type: string
        description: The ID of the resource.
      name:
        readOnly: true
        type: string
        description: The name of the resource.
      type:
        readOnly: true
        type: string
        description: The type of the resource.
      etag:
        readOnly: true
        type: string
        description: The ETag of the resource, used for concurrency statements.
    description: A definition of an Azure resource.
    x-ms-azure-resource: true
  EncryptionProperties:
    properties:
      keySource:
        type: string
        description: Type of the key source.
        enum:
        - Microsoft.Batch
        - Microsoft.KeyVault
        x-ms-enum:
          name: KeySource
          modelAsString: false
          values:
          - value: Microsoft.Batch
            description: Batch creates and manages the encryption keys used to protect the account data.
          - 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:
        $ref: '#/definitions/KeyVaultProperties'
        description: Additional details when using Microsoft.KeyVault
    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.
  PrivateEndpoint:
    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}.
        readOnly: true
    description: The private endpoint of the private endpoint connection.
  BatchAccount:
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/BatchAccountProperties'
        description: The properties associated with the account.
      identity:
        $ref: '#/definitions/BatchAccountIdentity'
        description: The identity of the Batch account.
    allOf:
    - $ref: '#/definitions/Resource'
    description: Contains information about an Azure Batch account.
  AutoStorageProperties:
    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: '#/definitions/AutoStorageBaseProperties'
    description: Contains information about the auto-storage account associated with a Batch account.
  CloudErrorBody:
    x-ms-external: true
    properties:
      code:
        type: string
        description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
      message:
        type: string
        description: A message describing the error, intended to be suitable for display in a user interface.
      target:
        type: string
        description: The target of the particular error. For example, the name of the property in error.
      details:
        type: array
        items:
          $ref: '#/definitions/CloudErrorBody'
        description: A list of additional details about the error.
    description: An error response from the Batch service.
  BatchAccountCreateProperties:
    properties:
      autoStorage:
        $ref: '#/definitions/AutoStorageBaseProperties'
        description: The properties related to the auto-storage account.
      poolAllocationMode:
        title: The allocation mode to use for creating pools in the Batch account.
        description: The pool allocation mode also affects how clients may authenticate to the Batch Service API. If the mode is BatchService, clients may authenticate using access keys or Azure Active Directory. If the mode is UserSubscription, clients must use Azure Active Directory. The default is BatchService.
        $ref: '#/definitions/PoolAllocationMode'
      keyVaultReference:
        $ref: '#/definitions/KeyVaultReference'
        description: A reference to the Azure key vault associated with the Batch account.
      publicNetworkAccess:
        title: The network access type for accessing Azure Batch account.
        description: If not specified, the default value is 'enabled'.
        $ref: '#/definitions/PublicNetworkAccessType'
      encryption:
        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.
        $ref: '#/definitions/EncryptionProperties'
    description: The properties of a Batch account.
  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:
      - value: BatchService
        description: Pools will be allocated in subscriptions owned by the Batch service.
      - value: UserSubscription
        description: Pools will be allocated in a subscription owned by the user.
  BatchAccountIdentity:
    properties:
      principalId:
        readOnly: true
        type: string
        description: The principal id of the Batch account. This property will only be provided for a system assigned identity.
      tenantId:
        readOnly: true
        type: string
        description: The tenant id associated with the Batch account. This property will only be provided for a system assigned identity.
      type:
        type: string
        description: The type of identity used for the Batch account.
        enum:
        - SystemAssigned
        - UserAssigned
        - None
        x-ms-enum:
          name: ResourceIdentityType
          modelAsString: false
          values:
          - value: SystemAssigned
            description: Batch account has a system assigned identity with it.
          - value: UserAssigned
            description: Batch account has user assigned identities with it.
          - value: None
            description: Batch account has no identity associated with it. Setting `None` in update account will remove existing identities.
      userAssignedIdentities:
        type: object
        additionalProperties:
          type: object
          properties:
            principalId:
              readOnly: true
              type: string
              description: The principal id of user assigned identity.
            clientId:
              readOnly: true
              type: string
              description: The client id of user assigned identity.
        description: 'The list of user identities associated with the Batch account. The user identity dictionary key references will be ARM resource ids in the form: ''/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}''.'
    description: The identity of the Batch account, if configured. This is only used when the user specifies 'Microsoft.KeyVault' as their Batch account encryption configuration.
    required:
    - type
  PrivateLinkServiceConnectionState:
    properties:
      status:
        $ref: '#/definitions/PrivateLinkServiceConnectionStatus'
        title: The status for the private endpoint connection of Batch account
      description:
        type: string
        title: Description of the private Connection state
      actionRequired:
        type: string
        title: Action required on the private connection state
        readOnly: true
    required:
    - status
    description: The private link service connection state of the private endpoint connection
  Resource:
    properties:
      id:
        readOnly: true
        type: string
        description: The ID of the resource.
      name:
        readOnly: true
        type: string
        description: The name of the resource.
      type:
        readOnly: true
        type: string
        description: The type of the resource.
      location:
        readOnly: true
        type: string
        description: The location of the resource.
      tags:
        readOnly: true
        type: object
        additionalProperties:
          type: string
        description: The tags of the resource.
    description: A definition of an Azure resource.
    x-ms-azure-resource: true
  BatchAccountProperties:
    properties:
      accountEndpoint:
        type: string
        readOnly: true
        description: The account endpoint used to interact with the Batch service.
      provisioningState:
        type: string
        readOnly: true
        x-nullable: false
        description: The provisioned state of the resource
        enum:
        - Invalid
        - Creating
        - Deleting
        - Succeeded
        - Failed
        - Cancelled
        x-ms-enum:
          name: ProvisioningState
          modelAsString: false
          values:
          - value: Invalid
            description: The account is in an invalid state.
          - value: Creating
            description: The account is being created.
          - value: Deleting
            description: The account is being deleted.
          - value: Succeeded
            description: The account has been created and is ready for use.
          - value: Failed
            description: The last operation for the account is failed.
          - value: Cancelled
            description: The last operation for the account is cancelled.
      poolAllocationMode:
        readOnly: true
        x-nullable: false
        title: The allocation mode to use for creating pools in the Batch account.
        $ref: '#/definitions/PoolAllocationMode'
      keyVaultReference:
        title: A reference to the Azure key vault associated with the Batch account.
        readOnly: true
        $ref: '#/definitions/KeyVaultReference'
      publicNetworkAccess:
        readOnly: true
        x-nullable: true
        title: The network interface type for accessing Azure Batch service and Batch account operations.
        description: If not specified, the default value is 'enabled'.
        $ref: '#/definitions/PublicNetworkAccessType'
      privateEndpointConnections:
        readOnly: true
        x-nullable: true
        type: array
        items:
          $ref: '#/definitions/PrivateEndpointConnection'
        description: List of private endpoint connections associated with the Batch account
      autoStorage:
        title: The properties and status of any auto-storage account associated with the Batch account.
        readOnly: true
        $ref: '#/definitions/AutoStorageProperties'
      encryption:
        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
        $ref: '#/definitions/EncryptionProperties'
      dedicatedCoreQuota:
        readOnly: true
        x-nullable: true
        type: integer
        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.
      lowPriorityCoreQuota:
        readOnly: true
        x-nullable: true
        type: integer
        format: int32
        title: The 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.
      dedicatedCoreQuotaPerVMFamily:
        readOnly: true
        x-nullable: true
        type: array
        items:
          $ref: '#/definitions/VirtualMachineFamilyCoreQuota'
        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.
      dedicatedCoreQuotaPerVMFamilyEnforced:
        readOnly: true
        x-nullable: false
        type: boolean
        title: A value indicating whether core quotas per Virtual Machine family are enforced for this account
        description: Batch is transitioning its core quota system for dedicated cores to be enforced per Virtual Machine family. During this transitional phase, the dedicated core quota per Virtual Machine family may not yet be enforced. If this flag is false, dedicated core quota is enforced via the old dedicatedCoreQuota property on the account and does not consider Virtual Machine family. If this flag is true, dedicated core quota is enforced via the dedicatedCoreQuotaPerVMFamily property on the account, and the old dedicatedCoreQuota does not apply.
      poolQuota:
        readOnly: true
        x-nullable: false
        type: integer
        format: int32
        title: The pool quota for the Batch account.
      activeJobAndJobScheduleQuota:
        readOnly: true
        x-nullable: false
        type: integer
        format: int32
        title: The active job and job schedule quota for the Batch account.
    description: Account specific properties.
  PrivateEndpointConnectionProperties:
    properties:
      provisioningState:
        type: string
        readOnly: true
        x-nullable: false
        title: The provisioning state of the private endpoint connection.
        enum:
        - Succeeded
        - Updating
        - Failed
        x-ms-enum:
          name: PrivateEndpointConnectionProvisioningState
          modelAsString: false
          values:
          - value: Succeeded
            description: The connection status is final and is ready for use if Status is Approved.
          - 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.
          - value: Failed
            description: The user requested that the connection be updated and it failed. You may retry the update operation.
      privateEndpoint:
        $ref: '#/definitions/PrivateEndpoint'
        title: The ARM resource identifier of the private endpoint.
      privateLinkServiceConnectionState:
        $ref: '#/definitions/PrivateLinkServiceConnectionState'
        title: The private link service connection state of the private endpoint connection.
    description: Private endpoint connection properties.
  KeyVaultReference:
    properties:
      id:
        type: string
        format: arm-id
        x-ms-arm-id-details:
          allowedResources:
          - type: Microsoft.KeyVault/vaults
        description: The resource ID of the Azure key vault associated with the Batch account.
      url:
        type: string
        description: The URL of the Azure key vault associated with the Batch account.
    required:
    - id
    - url
    description: Identifies the Azure key vault associated with a Batch account.
  AutoStorageBaseProperties:
    properties:
      storageAccountId:
        type: string
        format: arm-id
        x-ms-arm-id-details:
          allowedResources:
          - type: Microsoft.Storage/storageAccounts
        description: The resource ID of the storage account to be used for auto-storage account.
    required:
    - storageAccountId
    description: The properties related to the auto-storage account.
  KeyVaultProperties:
    properties:
      keyIdentifier:
        type: string
        description: "Full path to the versioned secret. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. To be usable the following prerequisites must be met:\n\n The Batch Account has a System Assigned identity\n The account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions\n The KeyVault has soft-delete and purge protection enabled"
    description: KeyVault configuration when using an encryption KeySource of Microsoft.KeyVault.
  EndpointDetail:
    type: object
    properties:
      port:
        type: integer
        format: int32
        readOnly: true
        description: The port an endpoint is connected to.
    description: Details about the connection between the Batch service and the endpoint.
  EndpointDependency:
    type: object
    properties:
      domainName:
        type: string
        readOnly: true
        description: The domain name of the dependency. Domain names may be fully qualified or may contain a * wildcard.
      description:
        type: string
        readOnly: true
        description: Human-readable supplemental information about the dependency and when it is applicable.
      endpointDetails:
        type: array
        readOnly: true
        items:
          $ref: '#/definitions/EndpointDetail'
        x-ms-identifiers:
        - port
        description: The list of connection details for this endpoint.
    description: A domain name and connection details used to access a dependency.
  BatchAccountKeys:
    properties:
      accountName:
        type: string
      

# --- truncated at 32 KB (40 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-batchaccount-api-openapi.yml