Microsoft.Batch batchAccounts 2023-05-01
Bicep-resursdefinition
Resurstypen batchAccounts kan distribueras med åtgärder som mål:
- Resursgrupper – Se resursgruppsdistributionskommandon
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.Batch/batchAccounts-resurs lägger du till följande Bicep i mallen.
resource symbolicname 'Microsoft.Batch/batchAccounts@2023-05-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
properties: {
allowedAuthenticationModes: [
'string'
]
autoStorage: {
authenticationMode: 'string'
nodeIdentityReference: {
resourceId: 'string'
}
storageAccountId: 'string'
}
encryption: {
keySource: 'string'
keyVaultProperties: {
keyIdentifier: 'string'
}
}
keyVaultReference: {
id: 'string'
url: 'string'
}
networkProfile: {
accountAccess: {
defaultAction: 'string'
ipRules: [
{
action: 'Allow'
value: 'string'
}
]
}
nodeManagementAccess: {
defaultAction: 'string'
ipRules: [
{
action: 'Allow'
value: 'string'
}
]
}
}
poolAllocationMode: 'string'
publicNetworkAccess: 'string'
}
}
Egenskapsvärden
batchAccounts
Namn | Beskrivning | Värde |
---|---|---|
Namn | Resursnamnet | sträng (krävs) Teckengräns: 3–24 Giltiga tecken: Gemener och siffror. |
plats | Den region där kontot ska skapas. | sträng (krävs) |
Taggar | De användardefinierade taggarna som är associerade med kontot. | Ordlista med taggnamn och värden. Se taggar i mallar |
identitet | Identiteten för Batch-kontot. | BatchAccountIdentity |
Egenskaper | Egenskaperna för Batch-kontot. | BatchAccountCreatePropertiesOrBatchAccountProperties |
BatchAccountIdentity
Namn | Beskrivning | Värde |
---|---|---|
typ | Den typ av identitet som används för Batch-kontot. | "Ingen" "SystemAssigned" "UserAssigned" (krävs) |
userAssignedIdentities | Listan över användaridentiteter som är associerade med Batch-kontot. | BatchAccountIdentityUserAssignedIdentiteter |
BatchAccountIdentityUserAssignedIdentiteter
Namn | Beskrivning | Värde |
---|---|---|
{anpassad egenskap} | UserAssignedIdentiteter |
UserAssignedIdentiteter
Det här objektet innehåller inga egenskaper som ska anges under distributionen. Alla egenskaper är ReadOnly.
BatchAccountCreatePropertiesOrBatchAccountProperties
Namn | Beskrivning | Värde |
---|---|---|
allowedAuthenticationModes | 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. | Strängmatris som innehåller något av: "AAD" "SharedKey" "TaskAuthenticationToken" |
autoStorage | Egenskaperna som är relaterade till kontot för automatisk lagring. | AutoStorageBasePropertiesOrAutoStorageProperties |
kryptering | 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. | EncryptionProperties |
keyVaultReference | En referens till Azure-nyckelvalvet som är associerat med Batch-kontot. | KeyVaultReference |
networkProfile | Nätverksprofilen träder endast i kraft när publicNetworkAccess är aktiverat. | NetworkProfile |
poolAllocationMode | 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 Azure Active Directory. Om läget är UserSubscription måste klienterna använda Azure Active Directory. Standardvärdet är BatchService. | "BatchService" "UserSubscription" |
publicNetworkAccess | Om det inte anges är standardvärdet "aktiverat". | "Inaktiverad" "Aktiverad" |
AutoStorageBasePropertiesOrAutoStorageProperties
Namn | Beskrivning | Värde |
---|---|---|
authenticationMode | Det autentiseringsläge som Batch-tjänsten ska använda för att hantera kontot för automatisk lagring. | "BatchAccountManagedIdentity" "StorageKeys" |
nodeIdentityReference | Identiteten som refereras här måste tilldelas till pooler som har beräkningsnoder som behöver åtkomst till automatisk lagring. | ComputeNodeIdentityReference |
storageAccountId | Resurs-ID för lagringskontot som ska användas för automatiskt lagringskonto. | sträng (krävs) |
ComputeNodeIdentityReference
Namn | Beskrivning | Värde |
---|---|---|
resourceId | ARM-resurs-ID för den användartilldelade identiteten. | sträng |
EncryptionProperties
Namn | Beskrivning | Värde |
---|---|---|
keySource | Typ av nyckelkälla. | "Microsoft.Batch" "Microsoft.KeyVault" |
keyVaultProperties | Ytterligare information när du använder Microsoft.KeyVault | KeyVaultProperties |
KeyVaultEgenskaper
Namn | Beskrivning | Värde |
---|---|---|
keyIdentifier | 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 |
sträng |
KeyVaultReference
Namn | Beskrivning | Värde |
---|---|---|
Id | Resurs-ID för Azure-nyckelvalvet som är associerat med Batch-kontot. | sträng (krävs) |
URL | URL:en för Azure-nyckelvalvet som är associerat med Batch-kontot. | sträng (krävs) |
NetworkProfile
Namn | Beskrivning | Värde |
---|---|---|
accountAccess | Nätverksåtkomstprofil för batchAccount-slutpunkt (Batch-kontodataplans-API). | EndpointAccessProfile |
nodeManagementAccess | Nätverksåtkomstprofil för nodeManagement-slutpunkt (Batch-tjänst som hanterar beräkningsnoder för Batch-pooler). | EndpointAccessProfile |
EndpointAccessProfile
Namn | Beskrivning | Värde |
---|---|---|
defaultAction | Standardåtgärd för slutpunktsåtkomst. Det gäller endast när publicNetworkAccess är aktiverat. | "Tillåt" "Neka" (krävs) |
ipRules | Matris med IP-intervall för att filtrera klientens IP-adress. | IPRule[] |
IPRule
Namn | Beskrivning | Värde |
---|---|---|
handling | Åtgärd när klientens IP-adress matchas. | "Tillåt" (krävs) |
värde | IPv4-adress eller IPv4-adressintervall i CIDR-format. | sträng (krävs) |
Snabbstartsmallar
Följande snabbstartsmallar distribuerar den här resurstypen.
Mall | Beskrivning |
---|---|
Azure Batch-pool utan offentliga IP-adresser |
Den här mallen skapar azure batch-förenklad nodkommunikationspool utan offentliga IP-adresser. |
Skapa ett Batch-konto med hjälp av en mall |
Den här mallen skapar ett Batch-konto och ett lagringskonto. |
Resursdefinition för ARM-mall
Resurstypen batchAccounts kan distribueras med åtgärder som mål:
- Resursgrupper – Se resursgruppsdistributionskommandon
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.Batch/batchAccounts-resurs lägger du till följande JSON i mallen.
{
"type": "Microsoft.Batch/batchAccounts",
"apiVersion": "2023-05-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"properties": {
"allowedAuthenticationModes": [ "string" ],
"autoStorage": {
"authenticationMode": "string",
"nodeIdentityReference": {
"resourceId": "string"
},
"storageAccountId": "string"
},
"encryption": {
"keySource": "string",
"keyVaultProperties": {
"keyIdentifier": "string"
}
},
"keyVaultReference": {
"id": "string",
"url": "string"
},
"networkProfile": {
"accountAccess": {
"defaultAction": "string",
"ipRules": [
{
"action": "Allow",
"value": "string"
}
]
},
"nodeManagementAccess": {
"defaultAction": "string",
"ipRules": [
{
"action": "Allow",
"value": "string"
}
]
}
},
"poolAllocationMode": "string",
"publicNetworkAccess": "string"
}
}
Egenskapsvärden
batchAccounts
Namn | Beskrivning | Värde |
---|---|---|
typ | Resurstypen | "Microsoft.Batch/batchAccounts" |
apiVersion | Resurs-API-versionen | '2023-05-01' |
Namn | Resursnamnet | sträng (krävs) Teckengräns: 3–24 Giltiga tecken: Gemener och siffror. |
plats | Den region där kontot ska skapas. | sträng (krävs) |
Taggar | De användardefinierade taggarna som är associerade med kontot. | Ordlista med taggnamn och värden. Se taggar i mallar |
identitet | Identiteten för Batch-kontot. | BatchAccountIdentity |
Egenskaper | Egenskaperna för Batch-kontot. | BatchAccountCreatePropertiesOrBatchAccountProperties |
BatchAccountIdentity
Namn | Beskrivning | Värde |
---|---|---|
typ | Den typ av identitet som används för Batch-kontot. | "Ingen" "SystemAssigned" "UserAssigned" (krävs) |
userAssignedIdentities | Listan över användaridentiteter som är associerade med Batch-kontot. | BatchAccountIdentityUserAssignedIdentiteter |
BatchAccountIdentityUserAssignedIdentiteter
Namn | Beskrivning | Värde |
---|---|---|
{anpassad egenskap} | UserAssignedIdentiteter |
UserAssignedIdentiteter
Det här objektet innehåller inga egenskaper som ska anges under distributionen. Alla egenskaper är ReadOnly.
BatchAccountCreatePropertiesOrBatchAccountProperties
Namn | Beskrivning | Värde |
---|---|---|
allowedAuthenticationModes | 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. | Strängmatris som innehåller något av: "AAD" "SharedKey" "TaskAuthenticationToken" |
autoStorage | Egenskaperna som är relaterade till kontot för automatisk lagring. | AutoStorageBasePropertiesOrAutoStorageProperties |
kryptering | 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. | EncryptionProperties |
keyVaultReference | En referens till Azure-nyckelvalvet som är associerat med Batch-kontot. | KeyVaultReference |
networkProfile | Nätverksprofilen träder endast i kraft när publicNetworkAccess är aktiverat. | NetworkProfile |
poolAllocationMode | 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 Azure Active Directory. Om läget är UserSubscription måste klienterna använda Azure Active Directory. Standardvärdet är BatchService. | "BatchService" "UserSubscription" |
publicNetworkAccess | Om det inte anges är standardvärdet "aktiverat". | "Inaktiverad" "Aktiverad" |
AutoStorageBasePropertiesOrAutoStorageProperties
Namn | Beskrivning | Värde |
---|---|---|
authenticationMode | Det autentiseringsläge som Batch-tjänsten ska använda för att hantera kontot för automatisk lagring. | "BatchAccountManagedIdentity" "StorageKeys" |
nodeIdentityReference | Identiteten som refereras här måste tilldelas till pooler som har beräkningsnoder som behöver åtkomst till automatisk lagring. | ComputeNodeIdentityReference |
storageAccountId | Resurs-ID för lagringskontot som ska användas för automatiskt lagringskonto. | sträng (krävs) |
ComputeNodeIdentityReference
Namn | Beskrivning | Värde |
---|---|---|
resourceId | ARM-resurs-ID för den användartilldelade identiteten. | sträng |
EncryptionProperties
Namn | Beskrivning | Värde |
---|---|---|
keySource | Typ av nyckelkälla. | "Microsoft.Batch" "Microsoft.KeyVault" |
keyVaultProperties | Ytterligare information när du använder Microsoft.KeyVault | KeyVaultProperties |
KeyVaultEgenskaper
Namn | Beskrivning | Värde |
---|---|---|
keyIdentifier | 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 |
sträng |
KeyVaultReference
Namn | Beskrivning | Värde |
---|---|---|
Id | Resurs-ID för Azure-nyckelvalvet som är associerat med Batch-kontot. | sträng (krävs) |
URL | URL:en för Azure-nyckelvalvet som är associerat med Batch-kontot. | sträng (krävs) |
NetworkProfile
Namn | Beskrivning | Värde |
---|---|---|
accountAccess | Nätverksåtkomstprofil för batchAccount-slutpunkt (Batch-kontodataplans-API). | EndpointAccessProfile |
nodeManagementAccess | Nätverksåtkomstprofil för nodeManagement-slutpunkt (Batch-tjänst som hanterar beräkningsnoder för Batch-pooler). | EndpointAccessProfile |
EndpointAccessProfile
Namn | Beskrivning | Värde |
---|---|---|
defaultAction | Standardåtgärd för slutpunktsåtkomst. Det gäller endast när publicNetworkAccess är aktiverat. | "Tillåt" "Neka" (krävs) |
ipRules | Matris med IP-intervall för att filtrera klientens IP-adress. | IPRule[] |
IPRule
Namn | Beskrivning | Värde |
---|---|---|
handling | Åtgärd när klientens IP-adress matchas. | "Tillåt" (krävs) |
värde | IPv4-adress eller IPv4-adressintervall i CIDR-format. | sträng (krävs) |
Snabbstartsmallar
Följande snabbstartsmallar distribuerar den här resurstypen.
Mall | Beskrivning |
---|---|
Azure Batch-pool utan offentliga IP-adresser |
Den här mallen skapar azure batch-förenklad nodkommunikationspool utan offentliga IP-adresser. |
Skapa ett Batch-konto med hjälp av en mall |
Den här mallen skapar ett Batch-konto och ett lagringskonto. |
Resursdefinition för Terraform (AzAPI-provider)
Resurstypen batchAccounts kan distribueras med åtgärder som mål:
- Resursgrupper
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.Batch/batchAccounts-resurs lägger du till följande Terraform i mallen.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Batch/batchAccounts@2023-05-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
allowedAuthenticationModes = [
"string"
]
autoStorage = {
authenticationMode = "string"
nodeIdentityReference = {
resourceId = "string"
}
storageAccountId = "string"
}
encryption = {
keySource = "string"
keyVaultProperties = {
keyIdentifier = "string"
}
}
keyVaultReference = {
id = "string"
url = "string"
}
networkProfile = {
accountAccess = {
defaultAction = "string"
ipRules = [
{
action = "Allow"
value = "string"
}
]
}
nodeManagementAccess = {
defaultAction = "string"
ipRules = [
{
action = "Allow"
value = "string"
}
]
}
}
poolAllocationMode = "string"
publicNetworkAccess = "string"
}
})
}
Egenskapsvärden
batchAccounts
Namn | Beskrivning | Värde |
---|---|---|
typ | Resurstypen | "Microsoft.Batch/batchAccounts@2023-05-01" |
Namn | Resursnamnet | sträng (krävs) Teckengräns: 3–24 Giltiga tecken: Gemener och siffror. |
plats | Den region där kontot ska skapas. | sträng (krävs) |
parent_id | Om du vill distribuera till en resursgrupp använder du ID:t för den resursgruppen. | sträng (krävs) |
Taggar | De användardefinierade taggarna som är associerade med kontot. | Ordlista med taggnamn och värden. |
identitet | Identiteten för Batch-kontot. | BatchAccountIdentity |
Egenskaper | Egenskaperna för Batch-kontot. | BatchAccountCreatePropertiesOrBatchAccountProperties |
BatchAccountIdentity
Namn | Beskrivning | Värde |
---|---|---|
typ | Den typ av identitet som används för Batch-kontot. | "SystemAssigned" "UserAssigned" (krävs) |
identity_ids | Listan över användaridentiteter som är associerade med Batch-kontot. | Matris med användaridentitets-ID:t. |
BatchAccountIdentityUserAssignedIdentiteter
Namn | Beskrivning | Värde |
---|---|---|
{anpassad egenskap} | UserAssignedIdentiteter |
UserAssignedIdentiteter
Det här objektet innehåller inga egenskaper som ska anges under distributionen. Alla egenskaper är ReadOnly.
BatchAccountCreatePropertiesOrBatchAccountProperties
Namn | Beskrivning | Värde |
---|---|---|
allowedAuthenticationModes | 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. | Strängmatris som innehåller något av: "AAD" "SharedKey" "TaskAuthenticationToken" |
autoStorage | Egenskaperna som är relaterade till kontot för automatisk lagring. | AutoStorageBasePropertiesOrAutoStorageProperties |
kryptering | 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. | EncryptionProperties |
keyVaultReference | En referens till Azure-nyckelvalvet som är associerat med Batch-kontot. | KeyVaultReference |
networkProfile | Nätverksprofilen träder endast i kraft när publicNetworkAccess är aktiverat. | NetworkProfile |
poolAllocationMode | 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 Azure Active Directory. Om läget är UserSubscription måste klienterna använda Azure Active Directory. Standardvärdet är BatchService. | "BatchService" "UserSubscription" |
publicNetworkAccess | Om det inte anges är standardvärdet "aktiverat". | "Inaktiverad" "Aktiverad" |
AutoStorageBasePropertiesOrAutoStorageProperties
Namn | Beskrivning | Värde |
---|---|---|
authenticationMode | Det autentiseringsläge som Batch-tjänsten ska använda för att hantera kontot för automatisk lagring. | "BatchAccountManagedIdentity" "StorageKeys" |
nodeIdentityReference | Identiteten som refereras här måste tilldelas till pooler som har beräkningsnoder som behöver åtkomst till automatisk lagring. | ComputeNodeIdentityReference |
storageAccountId | Resurs-ID för lagringskontot som ska användas för automatiskt lagringskonto. | sträng (krävs) |
ComputeNodeIdentityReference
Namn | Beskrivning | Värde |
---|---|---|
resourceId | ARM-resurs-ID för den användartilldelade identiteten. | sträng |
EncryptionProperties
Namn | Beskrivning | Värde |
---|---|---|
keySource | Typ av nyckelkälla. | "Microsoft.Batch" "Microsoft.KeyVault" |
keyVaultProperties | Ytterligare information när du använder Microsoft.KeyVault | KeyVaultProperties |
KeyVaultEgenskaper
Namn | Beskrivning | Värde |
---|---|---|
keyIdentifier | 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 |
sträng |
KeyVaultReference
Namn | Beskrivning | Värde |
---|---|---|
Id | Resurs-ID för Azure-nyckelvalvet som är associerat med Batch-kontot. | sträng (krävs) |
URL | URL:en för Azure-nyckelvalvet som är associerat med Batch-kontot. | sträng (krävs) |
NetworkProfile
Namn | Beskrivning | Värde |
---|---|---|
accountAccess | Nätverksåtkomstprofil för batchAccount-slutpunkt (Batch-kontodataplans-API). | EndpointAccessProfile |
nodeManagementAccess | Nätverksåtkomstprofil för nodeManagement-slutpunkt (Batch-tjänst som hanterar beräkningsnoder för Batch-pooler). | EndpointAccessProfile |
EndpointAccessProfile
Namn | Beskrivning | Värde |
---|---|---|
defaultAction | Standardåtgärd för slutpunktsåtkomst. Det gäller endast när publicNetworkAccess är aktiverat. | "Tillåt" "Neka" (krävs) |
ipRules | Matris med IP-intervall för att filtrera klientens IP-adress. | IPRule[] |
IPRule
Namn | Beskrivning | Värde |
---|---|---|
handling | Åtgärd när klientens IP-adress matchas. | "Tillåt" (krävs) |
värde | IPv4-adress eller IPv4-adressintervall i CIDR-format. | sträng (krävs) |