Dela via


Batch Account - Create

Skapar ett nytt Batch-konto med de angivna parametrarna. Det går inte att uppdatera befintliga konton med det här API:et och bör i stället uppdateras med API:et För att uppdatera Batch-kontot.

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

URI-parametrar

Name I Obligatorisk Typ Description
accountName
path True

string

Ett namn på Batch-kontot som måste vara unikt i regionen. Batch-kontonamn måste vara mellan 3 och 24 tecken långa och får endast innehålla siffror och gemener. Det här namnet används som en del av DNS-namnet som används för att komma åt Batch-tjänsten i den region där kontot skapas. Exempel: http://accountname.region.batch.azure.com/.

Regex pattern: ^[a-z0-9]+$

resourceGroupName
path True

string

Namnet på resursgruppen som innehåller Batch-kontot.

subscriptionId
path True

string

Prenumerations-ID:t för Azure. Det här är en GUID-formaterad sträng (t.ex. 00000000-0000-0000-0000-0000-000000000)

api-version
query True

string

DEN API-version som ska användas med HTTP-begäran.

Begärandetext

Name Obligatorisk Typ Description
location True

string

Den region där kontot ska skapas.

identity

BatchAccountIdentity

Identiteten för Batch-kontot.

properties.allowedAuthenticationModes

AuthenticationMode[]

Lista över tillåtna autentiseringslägen för Batch-kontot som kan användas för att autentisera med dataplanet. Detta påverkar inte autentisering med kontrollplanet.

properties.autoStorage

AutoStorageBaseProperties

Egenskaperna som är relaterade till det automatiska lagringskontot.

properties.encryption

EncryptionProperties

Krypteringskonfigurationen för Batch-kontot.
Konfigurerar hur kunddata krypteras i Batch-kontot. Som standard krypteras konton med hjälp av en Microsoft-hanterad nyckel. För ytterligare kontroll kan en kundhanterad nyckel användas i stället.

properties.keyVaultReference

KeyVaultReference

En referens till Azure-nyckelvalvet som är associerat med Batch-kontot.

properties.networkProfile

NetworkProfile

Nätverksprofil för Batch-konto, som innehåller nätverksregelinställningar för varje slutpunkt.
Nätverksprofilen börjar bara gälla när publicNetworkAccess är aktiverat.

properties.poolAllocationMode

PoolAllocationMode

Allokeringsläget som ska användas för att skapa pooler i Batch-kontot.
Poolallokeringsläget påverkar också hur klienter kan autentisera till Batch Service-API:et. Om läget är BatchService kan klienter autentisera med åtkomstnycklar eller Microsoft Entra ID. Om läget är UserSubscription måste klienterna använda Microsoft Entra ID. Standardvärdet är BatchService.

properties.publicNetworkAccess

PublicNetworkAccessType

Nätverksåtkomsttypen för åtkomst till Azure Batch-konto.
Om inget anges är standardvärdet "aktiverat".

tags

object

De användardefinierade taggarna som är associerade med kontot.

Svar

Name Typ Description
200 OK

BatchAccount

Åtgärden lyckades. Svaret innehåller Batch-kontoentiteten.

202 Accepted

Åtgärden slutförs asynkront.

Headers

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

CloudError

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Microsoft Entra OAuth 2.0-autentiseringskodflöde

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

BatchAccountCreate_BYOS
BatchAccountCreate_Default
BatchAccountCreate_SystemAssignedIdentity
BatchAccountCreate_UserAssignedIdentity
PrivateBatchAccountCreate

BatchAccountCreate_BYOS

Sample Request

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

Sample Response

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

Sample Request

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

Sample Response

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

Sample Request

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

Sample Response

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

Sample Request

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

Sample Response

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

Sample Request

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

Sample Response

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

Definitioner

Name Description
AuthenticationMode

Autentiseringsläget för Batch-kontot.

AutoStorageAuthenticationMode

Det autentiseringsläge som Batch-tjänsten ska använda för att hantera det automatiska lagringskontot.

AutoStorageBaseProperties

Egenskaperna som är relaterade till kontot för automatisk lagring.

AutoStorageProperties

Innehåller information om det automatiska lagringskontot som är associerat med ett Batch-konto.

BatchAccount

Innehåller information om ett Azure Batch konto.

BatchAccountCreateParameters

Parametrar som anges i åtgärden Skapa.

BatchAccountIdentity

Identiteten för Batch-kontot, om det är konfigurerat. Detta används när användaren anger "Microsoft.KeyVault" som konfiguration av Batch-kontokryptering eller när ManagedIdentity har valts som autentiseringsläge för automatisk lagring.

CloudError

Ett felsvar från Batch-tjänsten.

CloudErrorBody

Ett felsvar från Batch-tjänsten.

ComputeNodeIdentityReference

Referensen till en användartilldelad identitet som är associerad med den Batch-pool som en beräkningsnod ska använda.

EncryptionProperties

Konfigurerar hur kunddata krypteras i Batch-kontot. Som standard krypteras konton med hjälp av en Microsoft-hanterad nyckel. För ytterligare kontroll kan en kundhanterad nyckel användas i stället.

EndpointAccessDefaultAction

Standardåtgärden när ingen IPRule matchas.

EndpointAccessProfile

Nätverksåtkomstprofil för Batch-slutpunkt.

IPRule

Regel för att filtrera klientens IP-adress.

IPRuleAction

Åtgärd när klientens IP-adress matchas.

KeySource

Typ av nyckelkälla.

KeyVaultProperties

KeyVault-konfiguration när du använder en krypteringsnyckelkälla för Microsoft.KeyVault.

KeyVaultReference

Identifierar azure-nyckelvalvet som är associerat med ett Batch-konto.

NetworkProfile

Nätverksprofil för Batch-konto, som innehåller nätverksregelinställningar för varje slutpunkt.

PoolAllocationMode

Allokeringsläget för att skapa pooler i Batch-kontot.

PrivateEndpoint

Den privata slutpunkten för den privata slutpunktsanslutningen.

PrivateEndpointConnection

Innehåller information om en privat länkresurs.

PrivateEndpointConnectionProvisioningState

Etableringstillståndet för den privata slutpunktsanslutningen.

PrivateLinkServiceConnectionState

Anslutningstillståndet för tjänsten private link för den privata slutpunktsanslutningen

PrivateLinkServiceConnectionStatus

Status för den privata slutpunktsanslutningen i Batch

ProvisioningState

Resursens etablerade tillstånd

PublicNetworkAccessType

Nätverksåtkomsttypen för drift på resurserna i Batch-kontot.

ResourceIdentityType

Den typ av identitet som används för Batch-kontot.

UserAssignedIdentities

Listan över associerade användaridentiteter.

VirtualMachineFamilyCoreQuota

En VM-familj och dess associerade kärnkvot för Batch-kontot.

AuthenticationMode

Autentiseringsläget för Batch-kontot.

Name Typ Description
AAD

string

Autentiseringsläget med Microsoft Entra ID.

SharedKey

string

Autentiseringsläget med delade nycklar.

TaskAuthenticationToken

string

Autentiseringsläget med hjälp av aktivitetsautentiseringstoken.

AutoStorageAuthenticationMode

Det autentiseringsläge som Batch-tjänsten ska använda för att hantera det automatiska lagringskontot.

Name Typ Description
BatchAccountManagedIdentity

string

Batch-tjänsten autentiserar begäranden till automatisk lagring med hjälp av den hanterade identitet som tilldelats Batch-kontot.

StorageKeys

string

Batch-tjänsten autentiserar begäranden till automatisk lagring med lagringskontonycklar.

AutoStorageBaseProperties

Egenskaperna som är relaterade till kontot för automatisk lagring.

Name Typ Standardvärde Description
authenticationMode

AutoStorageAuthenticationMode

StorageKeys

Det autentiseringsläge som Batch-tjänsten ska använda för att hantera det automatiska lagringskontot.

nodeIdentityReference

ComputeNodeIdentityReference

Referensen till den användartilldelade identitet som beräkningsnoder använder för att få åtkomst till automatisk lagring.
Identiteten som refereras här måste tilldelas till pooler som har beräkningsnoder som behöver åtkomst till automatisk lagring.

storageAccountId

string

Resurs-ID för lagringskontot som ska användas för automatiskt lagringskonto.

AutoStorageProperties

Innehåller information om det automatiska lagringskontot som är associerat med ett Batch-konto.

Name Typ Standardvärde Description
authenticationMode

AutoStorageAuthenticationMode

StorageKeys

Det autentiseringsläge som Batch-tjänsten använder för att hantera det automatiska lagringskontot.

lastKeySync

string

UTC-tiden då lagringsnycklar senast synkroniserades med Batch-kontot.

nodeIdentityReference

ComputeNodeIdentityReference

Referensen till den användartilldelade identiteten som beräkningsnoder använder för att få åtkomst till automatisk lagring.
Identiteten som refereras här måste tilldelas till pooler som har beräkningsnoder som behöver åtkomst till automatisk lagring.

storageAccountId

string

Resurs-ID för lagringskontot som ska användas för automatiskt lagringskonto.

BatchAccount

Innehåller information om ett Azure Batch konto.

Name Typ Standardvärde Description
id

string

Resursens ID.

identity

BatchAccountIdentity

Batch-kontots identitet.

location

string

Platsen för resursen.

name

string

Namnet på resursen.

properties.accountEndpoint

string

Den kontoslutpunkt som används för att interagera med Batch-tjänsten.

properties.activeJobAndJobScheduleQuota

integer

Den aktiva jobb- och jobbschemakvoten för Batch-kontot.

properties.allowedAuthenticationModes

AuthenticationMode[]

Lista över tillåtna autentiseringslägen för Batch-kontot som kan användas för att autentisera med dataplanet. Detta påverkar inte autentisering med kontrollplanet.

properties.autoStorage

AutoStorageProperties

Egenskaper och status för alla automatiskt lagringskonton som är associerade med Batch-kontot.
Innehåller information om det konto för automatisk lagring som är associerat med ett Batch-konto.

properties.dedicatedCoreQuota

integer

Den dedikerade kärnkvoten för Batch-kontot.
För konton med PoolAllocationMode inställt på UserSubscription hanteras kvoten för prenumerationen så att det här värdet inte returneras.

properties.dedicatedCoreQuotaPerVMFamily

VirtualMachineFamilyCoreQuota[]

En lista över den dedikerade kärnkvoten per virtuell datorfamilj för Batch-kontot. För konton med PoolAllocationMode inställt på UserSubscription hanteras kvoten för prenumerationen så att det här värdet inte returneras.

properties.dedicatedCoreQuotaPerVMFamilyEnforced

boolean

Ett värde som anger om kärnkvoter per virtuell dator-familj tillämpas för det här kontot
Om den här flaggan är sann tillämpas dedikerad kärnkvot via både egenskaperna dedicatedCoreQuotaPerVMFamily och dedicatedCoreQuota på kontot. Om den här flaggan är falsk tillämpas den dedikerade kärnkvoten endast via egenskapen dedicatedCoreQuota för kontot och överväger inte virtual machine-familjen.

properties.encryption

EncryptionProperties

Krypteringskonfigurationen för Batch-kontot.
Konfigurerar hur kunddata krypteras i Batch-kontot. Som standard krypteras konton med hjälp av en Microsoft-hanterad nyckel. För ytterligare kontroll kan en kundhanterad nyckel användas i stället.

properties.keyVaultReference

KeyVaultReference

En referens till Azure-nyckelvalvet som är associerat med Batch-kontot.
Identifierar azure-nyckelvalvet som är associerat med ett Batch-konto.

properties.lowPriorityCoreQuota

integer

Kärnkvoten Spot/low-priority för Batch-kontot.
För konton med PoolAllocationMode inställt på UserSubscription hanteras kvoten för prenumerationen så att det här värdet inte returneras.

properties.networkProfile

NetworkProfile

Nätverksprofil för Batch-konto, som innehåller nätverksregelinställningar för varje slutpunkt.
Nätverksprofilen träder endast i kraft när publicNetworkAccess är aktiverat.

properties.nodeManagementEndpoint

string

Slutpunkten som används av beräkningsnoden för att ansluta till Batch-nodhanteringstjänsten.

properties.poolAllocationMode

PoolAllocationMode

Allokeringsläget som ska användas för att skapa pooler i Batch-kontot.
Allokeringsläget för att skapa pooler i Batch-kontot.

properties.poolQuota

integer

Poolkvoten för Batch-kontot.

properties.privateEndpointConnections

PrivateEndpointConnection[]

Lista över privata slutpunktsanslutningar som är associerade med Batch-kontot

properties.provisioningState

ProvisioningState

Resursens etablerade tillstånd

properties.publicNetworkAccess

PublicNetworkAccessType

Enabled

Nätverksgränssnittstypen för åtkomst till Azure Batch tjänst- och Batch-kontoåtgärder.
Om det inte anges är standardvärdet "aktiverat".

tags

object

Resursens taggar.

type

string

Resurstypen.

BatchAccountCreateParameters

Parametrar som anges i åtgärden Skapa.

Name Typ Standardvärde Description
identity

BatchAccountIdentity

Batch-kontots identitet.

location

string

Den region där kontot ska skapas.

properties.allowedAuthenticationModes

AuthenticationMode[]

Lista över tillåtna autentiseringslägen för Batch-kontot som kan användas för att autentisera med dataplanet. Detta påverkar inte autentisering med kontrollplanet.

properties.autoStorage

AutoStorageBaseProperties

Egenskaperna som är relaterade till kontot för automatisk lagring.

properties.encryption

EncryptionProperties

Krypteringskonfigurationen för Batch-kontot.
Konfigurerar hur kunddata krypteras i Batch-kontot. Som standard krypteras konton med hjälp av en Microsoft-hanterad nyckel. För ytterligare kontroll kan en kundhanterad nyckel användas i stället.

properties.keyVaultReference

KeyVaultReference

En referens till Azure-nyckelvalvet som är associerat med Batch-kontot.

properties.networkProfile

NetworkProfile

Nätverksprofil för Batch-konto, som innehåller nätverksregelinställningar för varje slutpunkt.
Nätverksprofilen träder endast i kraft när publicNetworkAccess är aktiverat.

properties.poolAllocationMode

PoolAllocationMode

Allokeringsläget som ska användas för att skapa pooler i Batch-kontot.
Poolallokeringsläget påverkar också hur klienter kan autentisera till Batch Service-API:et. Om läget är BatchService kan klienter autentisera med hjälp av åtkomstnycklar eller Microsoft Entra ID. Om läget är UserSubscription måste klienter använda Microsoft Entra ID. Standardvärdet är BatchService.

properties.publicNetworkAccess

PublicNetworkAccessType

Enabled

Nätverksåtkomsttypen för åtkomst till Azure Batch konto.
Om det inte anges är standardvärdet "aktiverat".

tags

object

De användardefinierade taggar som är associerade med kontot.

BatchAccountIdentity

Identiteten för Batch-kontot, om det är konfigurerat. Detta används när användaren anger "Microsoft.KeyVault" som konfiguration av Batch-kontokryptering eller när ManagedIdentity har valts som autentiseringsläge för automatisk lagring.

Name Typ Description
principalId

string

Huvud-ID för Batch-kontot. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet.

tenantId

string

Klient-ID:t som är associerat med Batch-kontot. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet.

type

ResourceIdentityType

Den typ av identitet som används för Batch-kontot.

userAssignedIdentities

object

Listan över användaridentiteter som är associerade med Batch-kontot.

CloudError

Ett felsvar från Batch-tjänsten.

Name Typ Description
error

CloudErrorBody

Brödtexten i felsvaret.

CloudErrorBody

Ett felsvar från Batch-tjänsten.

Name Typ Description
code

string

En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt.

details

CloudErrorBody[]

En lista med ytterligare information om felet.

message

string

Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt.

target

string

Målet för det specifika felet. Till exempel namnet på egenskapen i fel.

ComputeNodeIdentityReference

Referensen till en användartilldelad identitet som är associerad med den Batch-pool som en beräkningsnod ska använda.

Name Typ Description
resourceId

string

ARM-resurs-ID för den användartilldelade identiteten.

EncryptionProperties

Konfigurerar hur kunddata krypteras i Batch-kontot. Som standard krypteras konton med hjälp av en Microsoft-hanterad nyckel. För ytterligare kontroll kan en kundhanterad nyckel användas i stället.

Name Typ Description
keySource

KeySource

Typ av nyckelkälla.

keyVaultProperties

KeyVaultProperties

Ytterligare information när du använder Microsoft.KeyVault

EndpointAccessDefaultAction

Standardåtgärden när ingen IPRule matchas.

Name Typ Description
Allow

string

Tillåt klientåtkomst.

Deny

string

Neka klientåtkomst.

EndpointAccessProfile

Nätverksåtkomstprofil för Batch-slutpunkt.

Name Typ Description
defaultAction

EndpointAccessDefaultAction

Standardåtgärden när ingen IPRule matchas.
Standardåtgärd för slutpunktsåtkomst. Det gäller endast när publicNetworkAccess är aktiverat.

ipRules

IPRule[]

Matris med IP-intervall för att filtrera klientens IP-adress.

IPRule

Regel för att filtrera klientens IP-adress.

Name Typ Description
action

IPRuleAction

Åtgärd när klientens IP-adress matchas.

value

string

IP-adressen eller IP-adressintervallet som ska filtreras
IPv4-adress eller IPv4-adressintervall i CIDR-format.

IPRuleAction

Åtgärd när klientens IP-adress matchas.

Name Typ Description
Allow

string

Tillåt åtkomst för den matchade klientens IP-adress.

KeySource

Typ av nyckelkälla.

Name Typ Description
Microsoft.Batch

string

Batch skapar och hanterar de krypteringsnycklar som används för att skydda kontodata.

Microsoft.KeyVault

string

Krypteringsnycklarna som används för att skydda kontodata lagras i ett externt nyckelvalv. Om detta anges måste Batch-kontoidentiteten anges till SystemAssigned och en giltig nyckelidentifierare måste också anges under keyVaultProperties.

KeyVaultProperties

KeyVault-konfiguration när du använder en krypteringsnyckelkälla för Microsoft.KeyVault.

Name Typ Description
keyIdentifier

string

Fullständig sökväg till hemligheten med eller utan version. Exempel https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. eller https://mykeyvault.vault.azure.net/keys/testkey. För att kunna användas måste följande krav uppfyllas:

Batch-kontot har en systemtilldelad identitet Kontoidentiteten har beviljats behörigheterna Key/Get, Key/Unwrap och Key/Wrap. KeyVault har mjuk borttagning och rensningsskydd aktiverat

KeyVaultReference

Identifierar azure-nyckelvalvet som är associerat med ett Batch-konto.

Name Typ Description
id

string

Resurs-ID:t till det Azure-nyckelvalv som är associerat till Batch-kontot.

url

string

Webbadressen till det Azure-nyckelvalv som är associerat till Batch-kontot.

NetworkProfile

Nätverksprofil för Batch-konto, som innehåller nätverksregelinställningar för varje slutpunkt.

Name Typ Description
accountAccess

EndpointAccessProfile

Nätverksåtkomstprofil för batchAccount-slutpunkt (BATCH-kontodataplanets API).

nodeManagementAccess

EndpointAccessProfile

Nätverksåtkomstprofil för nodeManagement-slutpunkt (Batch-tjänst som hanterar beräkningsnoder för Batch-pooler).

PoolAllocationMode

Allokeringsläget för att skapa pooler i Batch-kontot.

Name Typ Description
BatchService

string

Pooler allokeras i prenumerationer som ägs av Batch-tjänsten.

UserSubscription

string

Pooler allokeras i en prenumeration som ägs av användaren.

PrivateEndpoint

Den privata slutpunkten för den privata slutpunktsanslutningen.

Name Typ Description
id

string

ARM-resursidentifieraren för den privata slutpunkten. Detta är av formatet /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}.

PrivateEndpointConnection

Innehåller information om en privat länkresurs.

Name Typ Description
etag

string

ETag för resursen som används för samtidighetsinstruktioner.

id

string

Resursens ID.

name

string

Namnet på resursen.

properties.groupIds

string[]

Grupp-ID för den privata slutpunktsanslutningen.
Värdet har ett och bara ett grupp-ID.

properties.privateEndpoint

PrivateEndpoint

ARM-resursidentifieraren för den privata slutpunkten.
Den privata slutpunkten för den privata slutpunktsanslutningen.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Anslutningstillståndet för tjänsten Private Link för den privata slutpunktsanslutningen.
Anslutningstillståndet för tjänsten private link för den privata slutpunktsanslutningen

properties.provisioningState

PrivateEndpointConnectionProvisioningState

Etableringstillståndet för den privata slutpunktsanslutningen.

type

string

Resurstypen.

PrivateEndpointConnectionProvisioningState

Etableringstillståndet för den privata slutpunktsanslutningen.

Name Typ Description
Cancelled

string

Användaren har avbrutit skapandet av anslutningen.

Creating

string

Anslutningen skapas.

Deleting

string

Anslutningen tas bort.

Failed

string

Användaren begärde att anslutningen skulle uppdateras och misslyckades. Du kan försöka uppdatera igen.

Succeeded

string

Anslutningsstatusen är slutgiltig och kan användas om Status är Godkänd.

Updating

string

Användaren har begärt att anslutningsstatusen ska uppdateras, men uppdateringsåtgärden har ännu inte slutförts. Du kanske inte refererar till anslutningen när du ansluter Batch-kontot.

PrivateLinkServiceConnectionState

Anslutningstillståndet för tjänsten private link för den privata slutpunktsanslutningen

Name Typ Description
actionsRequired

string

Åtgärd som krävs för det privata anslutningstillståndet

description

string

Beskrivning av det privata anslutningstillståndet

status

PrivateLinkServiceConnectionStatus

Status för den privata slutpunktsanslutningen för Batch-kontot

PrivateLinkServiceConnectionStatus

Status för den privata slutpunktsanslutningen i Batch

Name Typ Description
Approved

string

Den privata slutpunktsanslutningen är godkänd och kan användas för att komma åt Batch-kontot

Disconnected

string

Den privata slutpunktsanslutningen är frånkopplad och kan inte användas för att komma åt Batch-kontot

Pending

string

Den privata slutpunktsanslutningen väntar och kan inte användas för att komma åt Batch-kontot

Rejected

string

Den privata slutpunktsanslutningen avvisas och kan inte användas för att komma åt Batch-kontot

ProvisioningState

Resursens etablerade tillstånd

Name Typ Description
Cancelled

string

Den sista åtgärden för kontot avbryts.

Creating

string

Kontot skapas.

Deleting

string

Kontot tas bort.

Failed

string

Den senaste åtgärden för kontot misslyckades.

Invalid

string

Kontot är i ett ogiltigt tillstånd.

Succeeded

string

Kontot har skapats och är redo att användas.

PublicNetworkAccessType

Nätverksåtkomsttypen för drift på resurserna i Batch-kontot.

Name Typ Description
Disabled

string

Inaktiverar offentlig anslutning och aktiverar privat anslutning till Azure Batch Service via en privat slutpunktsresurs.

Enabled

string

Aktiverar anslutning till Azure Batch via offentlig DNS.

ResourceIdentityType

Den typ av identitet som används för Batch-kontot.

Name Typ Description
None

string

Batch-kontot har ingen associerad identitet. Om du anger None i uppdateringskontot tas befintliga identiteter bort.

SystemAssigned

string

Batch-kontot har en systemtilldelad identitet med sig.

UserAssigned

string

Batch-kontot har användartilldelade identiteter med sig.

UserAssignedIdentities

Listan över associerade användaridentiteter.

Name Typ Description
clientId

string

Klient-ID för användartilldelad identitet.

principalId

string

Huvud-ID för användartilldelad identitet.

VirtualMachineFamilyCoreQuota

En VM-familj och dess associerade kärnkvot för Batch-kontot.

Name Typ Description
coreQuota

integer

Kärnkvoten för VM-familjen för Batch-kontot.

name

string

Namnet på den virtuella datorns familj.