次の方法で共有


Batch Account - Create

指定したパラメーターを使用して、新しい Batch アカウントを作成します。 既存のアカウントはこの API では更新できないため、代わりに Update Batch Account API で更新する必要があります。

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

URI パラメーター

名前 / 必須 説明
accountName
path True

string

リージョン内で一意である必要がある Batch アカウントの名前。 バッチ アカウント名の長さは 3 ~ 24 文字で、数字と小文字のみを使用する必要があります。 この名前は、アカウントが作成されたリージョンの Batch サービスにアクセスするために使用される DNS 名の一部として使用されます。 (例: http://accountname.region.batch.azure.com/)。

正規表現パターン: ^[a-z0-9]+$

resourceGroupName
path True

string

Batch アカウントを含むリソース グループの名前。

subscriptionId
path True

string

Azure サブスクリプション ID。 これは GUID 形式の文字列です (例: 00000000-0000-0000-0000-000000000000)

api-version
query True

string

HTTP 要求で使用される API バージョン。

要求本文

名前 必須 説明
location True

string

アカウントを作成するリージョン。

identity

BatchAccountIdentity

Batch アカウントの ID。

properties.allowedAuthenticationModes

AuthenticationMode[]

データ プレーンでの認証に使用できる Batch アカウントで許可される認証モードの一覧。 これは、コントロール プレーンでの認証には影響しません。

properties.autoStorage

AutoStorageBaseProperties

自動ストレージ アカウントに関連するプロパティ。

properties.encryption

EncryptionProperties

Batch アカウントの暗号化構成。
Batch アカウント内で顧客データを暗号化する方法を構成します。 既定では、アカウントは Microsoft マネージド キーを使用して暗号化されます。 追加の制御のために、代わりにカスタマー マネージド キーを使用できます。

properties.keyVaultReference

KeyVaultReference

Batch アカウントに関連付けられている Azure キー コンテナーへの参照。

properties.networkProfile

NetworkProfile

Batch アカウントのネットワーク プロファイル。各エンドポイントのネットワーク ルール設定が含まれます。
ネットワーク プロファイルは、publicNetworkAccess が有効になっている場合にのみ有効になります。

properties.poolAllocationMode

PoolAllocationMode

Batch アカウントでプールを作成するために使用する割り当てモード。
プール割り当てモードは、クライアントが Batch Service API に対して認証する方法にも影響します。 モードが BatchService の場合、クライアントはアクセス キーまたはMicrosoft Entra IDを使用して認証できます。 モードが UserSubscription の場合、クライアントは Microsoft Entra IDを使用する必要があります。 既定値は BatchService です。

properties.publicNetworkAccess

PublicNetworkAccessType

Azure Batch アカウントにアクセスするためのネットワーク アクセスの種類。
指定しない場合、既定値は 'enabled' です。

tags

object

アカウントに関連付けられているユーザー指定のタグ。

応答

名前 説明
200 OK

BatchAccount

操作に成功しました。 応答には Batch アカウント エンティティが含まれています。

202 Accepted

操作は非同期的に完了します。

ヘッダー

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

CloudError

操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Microsoft Entra OAuth 2.0 認証コード フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
user_impersonation ユーザー アカウントの借用

BatchAccountCreate_BYOS
BatchAccountCreate_Default
BatchAccountCreate_SystemAssignedIdentity
BatchAccountCreate_UserAssignedIdentity
PrivateBatchAccountCreate

BatchAccountCreate_BYOS

要求のサンプル

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

応答のサンプル

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

要求のサンプル

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

応答のサンプル

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

要求のサンプル

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

応答のサンプル

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

要求のサンプル

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

応答のサンプル

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

要求のサンプル

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

応答のサンプル

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

定義

名前 説明
AuthenticationMode

Batch アカウントの認証モード。

AutoStorageAuthenticationMode

Batch サービスが自動ストレージ アカウントの管理に使用する認証モード。

AutoStorageBaseProperties

自動ストレージ アカウントに関連するプロパティ。

AutoStorageProperties

Batch アカウントに関連付けられている自動ストレージ アカウントに関する情報が含まれます。

BatchAccount

Azure Batch アカウントに関する情報が含まれます。

BatchAccountCreateParameters

作成操作に指定されたパラメーター。

BatchAccountIdentity

Batch アカウントの ID (構成されている場合)。 これは、ユーザーが Batch アカウント暗号化構成として "Microsoft.KeyVault" を指定する場合、または自動ストレージ認証モードとして選択されている場合 ManagedIdentity に使用されます。

CloudError

Batch サービスからのエラー応答。

CloudErrorBody

Batch サービスからのエラー応答。

ComputeNodeIdentityReference

コンピューティング ノードが使用する Batch プールに関連付けられているユーザー割り当て ID への参照。

EncryptionProperties

Batch アカウント内で顧客データを暗号化する方法を構成します。 既定では、アカウントは Microsoft マネージド キーを使用して暗号化されます。 追加の制御のために、代わりにカスタマー マネージド キーを使用できます。

EndpointAccessDefaultAction

IPRule が一致しない場合の既定のアクション。

EndpointAccessProfile

Batch エンドポイントのネットワーク アクセス プロファイル。

IPRule

クライアント IP アドレスをフィルター処理する規則。

IPRuleAction

クライアント IP アドレスが一致したときのアクション。

KeySource

キー ソースの種類。

KeyVaultProperties

Microsoft.KeyVault の暗号化 KeySource を使用する場合の KeyVault 構成。

KeyVaultReference

Batch アカウントに関連付けられている Azure キー コンテナーを識別します。

NetworkProfile

Batch アカウントのネットワーク プロファイル。各エンドポイントのネットワーク ルール設定が含まれます。

PoolAllocationMode

Batch アカウントでプールを作成するための割り当てモード。

PrivateEndpoint

プライベート エンドポイント接続のプライベート エンドポイント。

PrivateEndpointConnection

プライベート リンク リソースに関する情報が含まれます。

PrivateEndpointConnectionProvisioningState

プライベート エンドポイント接続のプロビジョニング状態。

PrivateLinkServiceConnectionState

プライベート エンドポイント接続のプライベート リンク サービス接続状態

PrivateLinkServiceConnectionStatus

Batch プライベート エンドポイント接続の状態

ProvisioningState

リソースのプロビジョニング済み状態

PublicNetworkAccessType

Batch アカウント内のリソースで動作するためのネットワーク アクセスの種類。

ResourceIdentityType

Batch アカウントに使用される ID の種類。

UserAssignedIdentities

関連付けられているユーザー ID の一覧。

VirtualMachineFamilyCoreQuota

Batch アカウントの VM ファミリとそれに関連付けられているコア クォータ。

AuthenticationMode

Batch アカウントの認証モード。

名前 説明
AAD

string

Microsoft Entra IDを使用した認証モード。

SharedKey

string

共有キーを使用する認証モード。

TaskAuthenticationToken

string

タスク認証トークンを使用する認証モード。

AutoStorageAuthenticationMode

Batch サービスが自動ストレージ アカウントの管理に使用する認証モード。

名前 説明
BatchAccountManagedIdentity

string

Batch サービスは、Batch アカウントに割り当てられたマネージド ID を使用して、自動ストレージに対する要求を認証します。

StorageKeys

string

Batch サービスは、ストレージ アカウント キーを使用して自動ストレージへの要求を認証します。

AutoStorageBaseProperties

自動ストレージ アカウントに関連するプロパティ。

名前 規定値 説明
authenticationMode

AutoStorageAuthenticationMode

StorageKeys

Batch サービスが自動ストレージ アカウントの管理に使用する認証モード。

nodeIdentityReference

ComputeNodeIdentityReference

自動ストレージへのアクセスにコンピューティング ノードが使用するユーザー割り当て ID への参照。
ここで参照される ID は、自動ストレージへのアクセスを必要とするコンピューティング ノードを持つプールに割り当てる必要があります。

storageAccountId

string

自動ストレージ アカウントに使用するストレージ アカウントのリソース ID。

AutoStorageProperties

Batch アカウントに関連付けられている自動ストレージ アカウントに関する情報が含まれます。

名前 規定値 説明
authenticationMode

AutoStorageAuthenticationMode

StorageKeys

Batch サービスが自動ストレージ アカウントの管理に使用する認証モード。

lastKeySync

string

ストレージ キーが Batch アカウントと最後に同期された UTC 時刻。

nodeIdentityReference

ComputeNodeIdentityReference

自動ストレージへのアクセスにコンピューティング ノードが使用するユーザー割り当て ID への参照。
ここで参照される ID は、自動ストレージへのアクセスを必要とするコンピューティング ノードを持つプールに割り当てる必要があります。

storageAccountId

string

自動ストレージ アカウントに使用するストレージ アカウントのリソース ID。

BatchAccount

Azure Batch アカウントに関する情報が含まれます。

名前 規定値 説明
id

string

リソースの ID。

identity

BatchAccountIdentity

Batch アカウントの ID。

location

string

リソースの場所。

name

string

リソースの名前。

properties.accountEndpoint

string

Batch サービスとの対話に使用されるアカウント エンドポイント。

properties.activeJobAndJobScheduleQuota

integer

Batch アカウントのアクティブなジョブとジョブ スケジュールのクォータ。

properties.allowedAuthenticationModes

AuthenticationMode[]

データ プレーンでの認証に使用できる Batch アカウントで許可される認証モードの一覧。 これは、コントロール プレーンでの認証には影響しません。

properties.autoStorage

AutoStorageProperties

Batch アカウントに関連付けられている自動ストレージ アカウントのプロパティと状態。
Batch アカウントに関連付けられている自動ストレージ アカウントに関する情報が含まれます。

properties.dedicatedCoreQuota

integer

Batch アカウントの専用コア クォータ。
PoolAllocationMode が UserSubscription に設定されているアカウントの場合、クォータはサブスクリプションで管理されるため、この値は返されません。

properties.dedicatedCoreQuotaPerVMFamily

VirtualMachineFamilyCoreQuota[]

Batch アカウントの仮想マシン ファミリごとの専用コア クォータの一覧。 PoolAllocationMode が UserSubscription に設定されているアカウントの場合、クォータはサブスクリプションで管理されるため、この値は返されません。

properties.dedicatedCoreQuotaPerVMFamilyEnforced

boolean

このアカウントに対して仮想マシン ファミリごとのコア クォータが適用されるかどうかを示す値
このフラグが true の場合、専用コア クォータは、アカウントの dedicatedCoreQuotaPerVMFamily プロパティと dedicatedCoreQuota プロパティの両方を介して適用されます。 このフラグが false の場合、専用コア クォータはアカウントの dedicatedCoreQuota プロパティを介してのみ適用され、仮想マシン ファミリは考慮されません。

properties.encryption

EncryptionProperties

Batch アカウントの暗号化構成。
Batch アカウント内で顧客データを暗号化する方法を構成します。 既定では、アカウントは Microsoft マネージド キーを使用して暗号化されます。 追加の制御のために、代わりにカスタマー マネージド キーを使用できます。

properties.keyVaultReference

KeyVaultReference

Batch アカウントに関連付けられている Azure キー コンテナーへの参照。
Batch アカウントに関連付けられている Azure キー コンテナーを識別します。

properties.lowPriorityCoreQuota

integer

Batch アカウントのスポット/低優先度コア クォータ。
PoolAllocationMode が UserSubscription に設定されているアカウントの場合、クォータはサブスクリプションで管理されるため、この値は返されません。

properties.networkProfile

NetworkProfile

Batch アカウントのネットワーク プロファイル。各エンドポイントのネットワーク ルール設定が含まれます。
ネットワーク プロファイルは、publicNetworkAccess が有効になっている場合にのみ有効になります。

properties.nodeManagementEndpoint

string

Batch ノード管理サービスに接続するためにコンピューティング ノードによって使用されるエンドポイント。

properties.poolAllocationMode

PoolAllocationMode

Batch アカウントでプールを作成するために使用する割り当てモード。
Batch アカウントでプールを作成するための割り当てモード。

properties.poolQuota

integer

Batch アカウントのプール クォータ。

properties.privateEndpointConnections

PrivateEndpointConnection[]

Batch アカウントに関連付けられているプライベート エンドポイント接続の一覧

properties.provisioningState

ProvisioningState

リソースのプロビジョニング済み状態

properties.publicNetworkAccess

PublicNetworkAccessType

Enabled

Azure Batch サービスおよび Batch アカウント操作にアクセスするためのネットワーク インターフェイスの種類。
指定しない場合、既定値は 'enabled' です。

tags

object

リソースのタグ。

type

string

リソースの型。

BatchAccountCreateParameters

作成操作に指定されたパラメーター。

名前 規定値 説明
identity

BatchAccountIdentity

Batch アカウントの ID。

location

string

アカウントを作成するリージョン。

properties.allowedAuthenticationModes

AuthenticationMode[]

データ プレーンでの認証に使用できる Batch アカウントで許可される認証モードの一覧。 これは、コントロール プレーンでの認証には影響しません。

properties.autoStorage

AutoStorageBaseProperties

自動ストレージ アカウントに関連するプロパティ。

properties.encryption

EncryptionProperties

Batch アカウントの暗号化構成。
Batch アカウント内で顧客データを暗号化する方法を構成します。 既定では、アカウントは Microsoft マネージド キーを使用して暗号化されます。 追加の制御のために、代わりにカスタマー マネージド キーを使用できます。

properties.keyVaultReference

KeyVaultReference

Batch アカウントに関連付けられている Azure キー コンテナーへの参照。

properties.networkProfile

NetworkProfile

Batch アカウントのネットワーク プロファイル。各エンドポイントのネットワーク ルール設定が含まれます。
ネットワーク プロファイルは、publicNetworkAccess が有効になっている場合にのみ有効になります。

properties.poolAllocationMode

PoolAllocationMode

Batch アカウントでプールを作成するために使用する割り当てモード。
プール割り当てモードは、クライアントが Batch Service API に対して認証する方法にも影響します。 モードが BatchService の場合、クライアントはアクセス キーまたはMicrosoft Entra IDを使用して認証できます。 モードが UserSubscription の場合、クライアントは Microsoft Entra IDを使用する必要があります。 既定値は BatchService です。

properties.publicNetworkAccess

PublicNetworkAccessType

Enabled

Azure Batch アカウントにアクセスするためのネットワーク アクセスの種類。
指定しない場合、既定値は 'enabled' です。

tags

object

アカウントに関連付けられているユーザー指定のタグ。

BatchAccountIdentity

Batch アカウントの ID (構成されている場合)。 これは、ユーザーが Batch アカウント暗号化構成として "Microsoft.KeyVault" を指定する場合、または自動ストレージ認証モードとして選択されている場合 ManagedIdentity に使用されます。

名前 説明
principalId

string

Batch アカウントのプリンシパル ID。 このプロパティは、システム割り当て ID に対してのみ提供されます。

tenantId

string

Batch アカウントに関連付けられているテナント ID。 このプロパティは、システム割り当て ID に対してのみ提供されます。

type

ResourceIdentityType

Batch アカウントに使用される ID の種類。

userAssignedIdentities

<string,  UserAssignedIdentities>

Batch アカウントに関連付けられているユーザー ID の一覧。

CloudError

Batch サービスからのエラー応答。

名前 説明
error

CloudErrorBody

エラー応答の本文。

CloudErrorBody

Batch サービスからのエラー応答。

名前 説明
code

string

エラーの識別子。 コードは不変であり、プログラムによって使用されることを意図しています。

details

CloudErrorBody[]

エラーに関する追加の詳細の一覧。

message

string

ユーザー インターフェイスでの表示に適したエラーを説明するメッセージ。

target

string

特定のエラーのターゲット。 たとえば、エラーが発生したプロパティの名前です。

ComputeNodeIdentityReference

コンピューティング ノードが使用する Batch プールに関連付けられているユーザー割り当て ID への参照。

名前 説明
resourceId

string

ユーザー割り当て ID の ARM リソース ID。

EncryptionProperties

Batch アカウント内で顧客データを暗号化する方法を構成します。 既定では、アカウントは Microsoft マネージド キーを使用して暗号化されます。 追加の制御のために、代わりにカスタマー マネージド キーを使用できます。

名前 説明
keySource

KeySource

キー ソースの種類。

keyVaultProperties

KeyVaultProperties

Microsoft.KeyVault を使用する場合の追加の詳細

EndpointAccessDefaultAction

IPRule が一致しない場合の既定のアクション。

名前 説明
Allow

string

クライアント アクセスを許可します。

Deny

string

クライアント アクセスを拒否します。

EndpointAccessProfile

Batch エンドポイントのネットワーク アクセス プロファイル。

名前 説明
defaultAction

EndpointAccessDefaultAction

IPRule が一致しない場合の既定のアクション。
エンドポイント アクセスの既定のアクション。 publicNetworkAccess が有効になっている場合にのみ適用されます。

ipRules

IPRule[]

クライアント IP アドレスをフィルター処理する IP 範囲の配列。

IPRule

クライアント IP アドレスをフィルター処理する規則。

名前 説明
action

IPRuleAction

クライアント IP アドレスが一致したときのアクション。

value

string

フィルター処理する IP アドレスまたは IP アドレス範囲
IPv4 アドレス、または CIDR 形式の IPv4 アドレス範囲。

IPRuleAction

クライアント IP アドレスが一致したときのアクション。

名前 説明
Allow

string

一致したクライアント IP アドレスへのアクセスを許可します。

KeySource

キー ソースの種類。

名前 説明
Microsoft.Batch

string

Batch は、アカウント データの保護に使用される暗号化キーを作成および管理します。

Microsoft.KeyVault

string

アカウント データを保護するために使用される暗号化キーは、外部キー コンテナーに格納されます。 これを設定する場合は、Batch アカウント ID を に SystemAssigned 設定し、keyVaultProperties の下に有効なキー識別子も指定する必要があります。

KeyVaultProperties

Microsoft.KeyVault の暗号化 KeySource を使用する場合の KeyVault 構成。

名前 説明
keyIdentifier

string

バージョンの有無にかかわらず、シークレットへの完全なパス。 例: https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053。 または https://mykeyvault.vault.azure.net/keys/testkey。 使用できるようにするには、次の前提条件を満たす必要があります。

Batch アカウントにシステム割り当て ID がある アカウント ID には、キー/取得、キー/ラップ解除、キー/ラップのアクセス許可が付与されています。KeyVault には論理的な削除と消去の保護が有効になっています

KeyVaultReference

Batch アカウントに関連付けられている Azure キー コンテナーを識別します。

名前 説明
id

string

Batch アカウントに関連付けられている Azure キー コンテナーのリソース ID。

url

string

Batch アカウントに関連付けられている Azure キー コンテナーの URL。

NetworkProfile

Batch アカウントのネットワーク プロファイル。各エンドポイントのネットワーク ルール設定が含まれます。

名前 説明
accountAccess

EndpointAccessProfile

batchAccount エンドポイントのネットワーク アクセス プロファイル (Batch アカウント データ プレーン API)。

nodeManagementAccess

EndpointAccessProfile

nodeManagement エンドポイントのネットワーク アクセス プロファイル (Batch プールのコンピューティング ノードを管理する Batch サービス)。

PoolAllocationMode

Batch アカウントでプールを作成するための割り当てモード。

名前 説明
BatchService

string

プールは、Batch サービスが所有するサブスクリプションに割り当てられます。

UserSubscription

string

プールは、ユーザーが所有するサブスクリプションに割り当てられます。

PrivateEndpoint

プライベート エンドポイント接続のプライベート エンドポイント。

名前 説明
id

string

プライベート エンドポイントの ARM リソース識別子。 これは、/subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint} の形式です。

PrivateEndpointConnection

プライベート リンク リソースに関する情報が含まれます。

名前 説明
etag

string

コンカレンシー ステートメントに使用されるリソースの ETag。

id

string

リソースの ID。

name

string

リソースの名前。

properties.groupIds

string[]

プライベート エンドポイント接続のグループ ID。
値のグループ ID は 1 つだけです。

properties.privateEndpoint

PrivateEndpoint

プライベート エンドポイントの ARM リソース識別子。
プライベート エンドポイント接続のプライベート エンドポイント。

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

プライベート エンドポイント接続のプライベート リンク サービス接続状態。
プライベート エンドポイント接続のプライベート リンク サービス接続状態

properties.provisioningState

PrivateEndpointConnectionProvisioningState

プライベート エンドポイント接続のプロビジョニング状態。

type

string

リソースの型。

PrivateEndpointConnectionProvisioningState

プライベート エンドポイント接続のプロビジョニング状態。

名前 説明
Cancelled

string

ユーザーが接続の作成を取り消しました。

Creating

string

接続が作成されています。

Deleting

string

接続が削除されています。

Failed

string

ユーザーが接続を更新することを要求し、失敗しました。 更新操作を再試行できます。

Succeeded

string

[状態] が [承認済み] の場合、接続の状態は最終的であり、使用できる状態になります。

Updating

string

ユーザーは接続状態を更新することを要求しましたが、更新操作はまだ完了していません。 Batch アカウントを接続するときに、接続を参照することはできません。

PrivateLinkServiceConnectionState

プライベート エンドポイント接続のプライベート リンク サービス接続状態

名前 説明
actionsRequired

string

プライベート接続状態で必要なアクション

description

string

プライベート接続状態の説明

status

PrivateLinkServiceConnectionStatus

Batch アカウントのプライベート エンドポイント接続の状態

PrivateLinkServiceConnectionStatus

Batch プライベート エンドポイント接続の状態

名前 説明
Approved

string

プライベート エンドポイント接続が承認され、Batch アカウントへのアクセスに使用できます

Disconnected

string

プライベート エンドポイント接続は切断されており、Batch アカウントへのアクセスに使用できません

Pending

string

プライベート エンドポイント接続は保留中であり、Batch アカウントへのアクセスに使用できません

Rejected

string

プライベート エンドポイント接続は拒否され、Batch アカウントへのアクセスに使用できません

ProvisioningState

リソースのプロビジョニング済み状態

名前 説明
Cancelled

string

アカウントの最後の操作は取り消されます。

Creating

string

アカウントが作成されています。

Deleting

string

アカウントが削除されています。

Failed

string

アカウントの最後の操作は失敗しました。

Invalid

string

アカウントが無効な状態です。

Succeeded

string

アカウントが作成され、使用する準備ができました。

PublicNetworkAccessType

Batch アカウント内のリソースで動作するためのネットワーク アクセスの種類。

名前 説明
Disabled

string

パブリック接続を無効にし、プライベート エンドポイント リソースを介してAzure Batch サービスへのプライベート接続を有効にします。

Enabled

string

パブリック DNS を介したAzure Batchへの接続を有効にします。

ResourceIdentityType

Batch アカウントに使用される ID の種類。

名前 説明
None

string

Batch アカウントには、関連付けられている ID がありません。 更新アカウントで を設定 None すると、既存の ID が削除されます。

SystemAssigned

string

Batch アカウントには、システム割り当て ID が含まれています。

UserAssigned

string

Batch アカウントには、ユーザー割り当て ID があります。

UserAssignedIdentities

関連付けられているユーザー ID の一覧。

名前 説明
clientId

string

ユーザー割り当て ID のクライアント ID。

principalId

string

ユーザー割り当て ID のプリンシパル ID。

VirtualMachineFamilyCoreQuota

Batch アカウントの VM ファミリとそれに関連付けられているコア クォータ。

名前 説明
coreQuota

integer

Batch アカウントの VM ファミリのコア クォータ。

name

string

仮想マシンファミリ名。