Udostępnij za pośrednictwem

Microsoft.BatchAccounts 2023-11-01

  • Artykuł

Definicja zasobu Bicep

Typ zasobu batchAccounts można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Batch/batchAccounts, dodaj następujący kod Bicep do szablonu.

resource symbolicname 'Microsoft.Batch/batchAccounts@2023-11-01' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  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'
  }
  tags: {
    {customized property}: 'string'
  }
}

Wartości właściwości

AutoStorageBasePropertiesOrAutoStorageProperties

Nazwa Opis Wartość
authenticationMode Tryb uwierzytelniania używany przez usługę Batch do zarządzania kontem automatycznego magazynu. "BatchAccountManagedIdentity"
"StorageKeys"
nodeIdentityReference Tożsamość, do której odwołuje się tutaj, musi być przypisana do pul, które mają węzły obliczeniowe wymagające dostępu do automatycznego magazynu. ComputeNodeIdentityReference
storageAccountId Identyfikator zasobu konta magazynu, który ma być używany dla konta magazynu automatycznego. ciąg (wymagany)

BatchAccountCreateParametersTags

Nazwa Opis Wartość

BatchAccountCreatePropertiesOrBatchAccountProperties

Nazwa Opis Wartość
allowedAuthenticationModes Lista dozwolonych trybów uwierzytelniania dla konta usługi Batch, których można użyć do uwierzytelniania za pomocą płaszczyzny danych. Nie ma to wpływu na uwierzytelnianie za pomocą płaszczyzny sterowania. Tablica ciągów zawierająca dowolną z:
"AAD"
"SharedKey"
"TaskAuthenticationToken"
autoStorage Właściwości związane z kontem automatycznego magazynu. AutoStorageBasePropertiesOrAutoStorageProperties
szyfrowanie Konfiguruje sposób szyfrowania danych klienta wewnątrz konta usługi Batch. Domyślnie konta są szyfrowane przy użyciu klucza zarządzanego przez firmę Microsoft. Aby uzyskać dodatkową kontrolę, można zamiast tego użyć klucza zarządzanego przez klienta. EncryptionProperties
keyVaultReference Odwołanie do magazynu kluczy platformy Azure skojarzonego z kontem usługi Batch. KeyVaultReference
networkProfile Profil sieciowy ma zastosowanie tylko wtedy, gdy funkcja publicNetworkAccess jest włączona. NetworkProfile
poolAllocationMode Tryb alokacji puli wpływa również na sposób uwierzytelniania klientów w interfejsie API usługi Batch. Jeśli tryb to BatchService, klienci mogą uwierzytelniać się przy użyciu kluczy dostępu lub identyfikatora Entra firmy Microsoft. Jeśli tryb to UserSubscription, klienci muszą używać identyfikatora Entra firmy Microsoft. Wartość domyślna to BatchService. "BatchService"
"UserSubscription"
publicNetworkAccess Jeśli nie zostanie określona, wartość domyślna to "włączone". "Wyłączone"
"Włączone"

BatchAccountIdentity

Nazwa Opis Wartość
typ Typ tożsamości używany dla konta usługi Batch. "Brak"
"SystemAssigned"
"UserAssigned" (wymagane)
userAssignedIdentities Lista tożsamości użytkowników skojarzonych z kontem usługi Batch. BatchAccountIdentityUserAssignedIdentities

BatchAccountIdentityUserAssignedIdentities

Nazwa Opis Wartość

ComputeNodeIdentityReference

Nazwa Opis Wartość
resourceId Identyfikator zasobu usługi ARM tożsamości przypisanej przez użytkownika. struna

Właściwości szyfrowania

Nazwa Opis Wartość
keySource Typ źródła klucza. "Microsoft.Batch"
"Microsoft.KeyVault"
keyVaultProperties Dodatkowe szczegóły dotyczące korzystania z usługi Microsoft.KeyVault KeyVaultProperties

EndpointAccessProfile

Nazwa Opis Wartość
defaultAction Domyślna akcja dostępu do punktu końcowego. Ma zastosowanie tylko wtedy, gdy funkcja publicNetworkAccess jest włączona. "Zezwalaj"
"Odmów" (wymagane)
ipRules Tablica zakresów adresów IP do filtrowania adresu IP klienta. IPRule []

Adres IPRule

Nazwa Opis Wartość
akcja Akcja w przypadku dopasowania adresu IP klienta. "Zezwalaj" (wymagane)
wartość Adres IPv4 lub zakres adresów IPv4 w formacie CIDR. ciąg (wymagany)

KeyVaultProperties

Nazwa Opis Wartość
keyIdentifier Pełna ścieżka do wpisu tajnego z wersją lub bez tej wersji. Przykład https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. lub https://mykeyvault.vault.azure.net/keys/testkey. Aby można było używać następujących wymagań wstępnych, należy spełnić następujące wymagania wstępne:

Konto usługi Batch ma tożsamość przypisaną przez system
Tożsamość konta ma przyznane uprawnienia Klucz/Get, Klucz/Odpakowywanie i Klucz/Zawijanie
Usługa KeyVault ma włączoną ochronę przed usuwaniem nietrwałym i przeczyszczaniem		 struna

KeyVaultReference

Nazwa Opis Wartość
id Identyfikator zasobu magazynu kluczy platformy Azure skojarzony z kontem usługi Batch. ciąg (wymagany)
adres URL Adres URL magazynu kluczy platformy Azure skojarzony z kontem usługi Batch. ciąg (wymagany)

Microsoft.Batch/batchAccounts

Nazwa Opis Wartość
tożsamość Tożsamość konta usługi Batch. BatchAccountIdentity
lokalizacja Region, w którym ma zostać utworzone konto. ciąg (wymagany)
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 3
Maksymalna długość = 3
Wzorzec = ^[a-z0-9]+$ (wymagane)
Właściwości Właściwości konta usługi Batch. BatchAccountCreatePropertiesOrBatchAccountProperties
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach

NetworkProfile

Nazwa Opis Wartość
accountAccess Profil dostępu do sieci dla punktu końcowego batchAccount (interfejs API płaszczyzny danych konta usługi Batch). endpointAccessProfile
nodeManagementAccess Profil dostępu do sieci dla punktu końcowego nodeManagement (usługa Batch zarządzająca węzłami obliczeniowymi dla pul usługi Batch). endpointAccessProfile

UserAssignedIdentities

Nazwa Opis Wartość

Przykłady z przewodnika Szybki start

W poniższych przykładach szybkiego startu wdrożono ten typ zasobu.

Plik Bicep Opis
puli usługi Azure Batch bez publicznych adresów IP Ten szablon tworzy uproszczoną pulę komunikacji węzłów usługi Azure Batch bez publicznych adresów IP.
tworzenie konta usługi Batch przy użyciu szablonu Ten szablon tworzy konto usługi Batch i konto magazynu.

Definicja zasobu szablonu usługi ARM

Typ zasobu batchAccounts można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Batch/batchAccounts, dodaj następujący kod JSON do szablonu.

{
  "type": "Microsoft.Batch/batchAccounts",
  "apiVersion": "2023-11-01",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "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"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Wartości właściwości

AutoStorageBasePropertiesOrAutoStorageProperties

Nazwa Opis Wartość
authenticationMode Tryb uwierzytelniania używany przez usługę Batch do zarządzania kontem automatycznego magazynu. "BatchAccountManagedIdentity"
"StorageKeys"
nodeIdentityReference Tożsamość, do której odwołuje się tutaj, musi być przypisana do pul, które mają węzły obliczeniowe wymagające dostępu do automatycznego magazynu. ComputeNodeIdentityReference
storageAccountId Identyfikator zasobu konta magazynu, który ma być używany dla konta magazynu automatycznego. ciąg (wymagany)

BatchAccountCreateParametersTags

Nazwa Opis Wartość

BatchAccountCreatePropertiesOrBatchAccountProperties

Nazwa Opis Wartość
allowedAuthenticationModes Lista dozwolonych trybów uwierzytelniania dla konta usługi Batch, których można użyć do uwierzytelniania za pomocą płaszczyzny danych. Nie ma to wpływu na uwierzytelnianie za pomocą płaszczyzny sterowania. Tablica ciągów zawierająca dowolną z:
"AAD"
"SharedKey"
"TaskAuthenticationToken"
autoStorage Właściwości związane z kontem automatycznego magazynu. AutoStorageBasePropertiesOrAutoStorageProperties
szyfrowanie Konfiguruje sposób szyfrowania danych klienta wewnątrz konta usługi Batch. Domyślnie konta są szyfrowane przy użyciu klucza zarządzanego przez firmę Microsoft. Aby uzyskać dodatkową kontrolę, można zamiast tego użyć klucza zarządzanego przez klienta. EncryptionProperties
keyVaultReference Odwołanie do magazynu kluczy platformy Azure skojarzonego z kontem usługi Batch. KeyVaultReference
networkProfile Profil sieciowy ma zastosowanie tylko wtedy, gdy funkcja publicNetworkAccess jest włączona. NetworkProfile
poolAllocationMode Tryb alokacji puli wpływa również na sposób uwierzytelniania klientów w interfejsie API usługi Batch. Jeśli tryb to BatchService, klienci mogą uwierzytelniać się przy użyciu kluczy dostępu lub identyfikatora Entra firmy Microsoft. Jeśli tryb to UserSubscription, klienci muszą używać identyfikatora Entra firmy Microsoft. Wartość domyślna to BatchService. "BatchService"
"UserSubscription"
publicNetworkAccess Jeśli nie zostanie określona, wartość domyślna to "włączone". "Wyłączone"
"Włączone"

BatchAccountIdentity

Nazwa Opis Wartość
typ Typ tożsamości używany dla konta usługi Batch. "Brak"
"SystemAssigned"
"UserAssigned" (wymagane)
userAssignedIdentities Lista tożsamości użytkowników skojarzonych z kontem usługi Batch. BatchAccountIdentityUserAssignedIdentities

BatchAccountIdentityUserAssignedIdentities

Nazwa Opis Wartość

ComputeNodeIdentityReference

Nazwa Opis Wartość
resourceId Identyfikator zasobu usługi ARM tożsamości przypisanej przez użytkownika. struna

Właściwości szyfrowania

Nazwa Opis Wartość
keySource Typ źródła klucza. "Microsoft.Batch"
"Microsoft.KeyVault"
keyVaultProperties Dodatkowe szczegóły dotyczące korzystania z usługi Microsoft.KeyVault KeyVaultProperties

EndpointAccessProfile

Nazwa Opis Wartość
defaultAction Domyślna akcja dostępu do punktu końcowego. Ma zastosowanie tylko wtedy, gdy funkcja publicNetworkAccess jest włączona. "Zezwalaj"
"Odmów" (wymagane)
ipRules Tablica zakresów adresów IP do filtrowania adresu IP klienta. IPRule []

Adres IPRule

Nazwa Opis Wartość
akcja Akcja w przypadku dopasowania adresu IP klienta. "Zezwalaj" (wymagane)
wartość Adres IPv4 lub zakres adresów IPv4 w formacie CIDR. ciąg (wymagany)

KeyVaultProperties

Nazwa Opis Wartość
keyIdentifier Pełna ścieżka do wpisu tajnego z wersją lub bez tej wersji. Przykład https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. lub https://mykeyvault.vault.azure.net/keys/testkey. Aby można było używać następujących wymagań wstępnych, należy spełnić następujące wymagania wstępne:

Konto usługi Batch ma tożsamość przypisaną przez system
Tożsamość konta ma przyznane uprawnienia Klucz/Get, Klucz/Odpakowywanie i Klucz/Zawijanie
Usługa KeyVault ma włączoną ochronę przed usuwaniem nietrwałym i przeczyszczaniem		 struna

KeyVaultReference

Nazwa Opis Wartość
id Identyfikator zasobu magazynu kluczy platformy Azure skojarzony z kontem usługi Batch. ciąg (wymagany)
adres URL Adres URL magazynu kluczy platformy Azure skojarzony z kontem usługi Batch. ciąg (wymagany)

Microsoft.Batch/batchAccounts

Nazwa Opis Wartość
apiVersion Wersja interfejsu API '2023-11-01'
tożsamość Tożsamość konta usługi Batch. BatchAccountIdentity
lokalizacja Region, w którym ma zostać utworzone konto. ciąg (wymagany)
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 3
Maksymalna długość = 3
Wzorzec = ^[a-z0-9]+$ (wymagane)
Właściwości Właściwości konta usługi Batch. BatchAccountCreatePropertiesOrBatchAccountProperties
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach
typ Typ zasobu "Microsoft.Batch/batchAccounts"

NetworkProfile

Nazwa Opis Wartość
accountAccess Profil dostępu do sieci dla punktu końcowego batchAccount (interfejs API płaszczyzny danych konta usługi Batch). endpointAccessProfile
nodeManagementAccess Profil dostępu do sieci dla punktu końcowego nodeManagement (usługa Batch zarządzająca węzłami obliczeniowymi dla pul usługi Batch). endpointAccessProfile

UserAssignedIdentities

Nazwa Opis Wartość

Szablony szybkiego startu

Następujące szablony szybkiego startu wdrażają ten typ zasobu.

Szablon Opis
puli usługi Azure Batch bez publicznych adresów IP

Wdrażanie do Azure 		Ten szablon tworzy uproszczoną pulę komunikacji węzłów usługi Azure Batch bez publicznych adresów IP.
tworzenie konta usługi Batch przy użyciu szablonu

Wdrażanie do Azure 		Ten szablon tworzy konto usługi Batch i konto magazynu.

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu batchAccounts można wdrożyć przy użyciu operacji docelowych:

  • grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Batch/batchAccounts, dodaj następujący program Terraform do szablonu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Batch/batchAccounts@2023-11-01"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  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"
    }
  })
}

Wartości właściwości

AutoStorageBasePropertiesOrAutoStorageProperties

Nazwa Opis Wartość
authenticationMode Tryb uwierzytelniania używany przez usługę Batch do zarządzania kontem automatycznego magazynu. "BatchAccountManagedIdentity"
"StorageKeys"
nodeIdentityReference Tożsamość, do której odwołuje się tutaj, musi być przypisana do pul, które mają węzły obliczeniowe wymagające dostępu do automatycznego magazynu. ComputeNodeIdentityReference
storageAccountId Identyfikator zasobu konta magazynu, który ma być używany dla konta magazynu automatycznego. ciąg (wymagany)

BatchAccountCreateParametersTags

Nazwa Opis Wartość

BatchAccountCreatePropertiesOrBatchAccountProperties

Nazwa Opis Wartość
allowedAuthenticationModes Lista dozwolonych trybów uwierzytelniania dla konta usługi Batch, których można użyć do uwierzytelniania za pomocą płaszczyzny danych. Nie ma to wpływu na uwierzytelnianie za pomocą płaszczyzny sterowania. Tablica ciągów zawierająca dowolną z:
"AAD"
"SharedKey"
"TaskAuthenticationToken"
autoStorage Właściwości związane z kontem automatycznego magazynu. AutoStorageBasePropertiesOrAutoStorageProperties
szyfrowanie Konfiguruje sposób szyfrowania danych klienta wewnątrz konta usługi Batch. Domyślnie konta są szyfrowane przy użyciu klucza zarządzanego przez firmę Microsoft. Aby uzyskać dodatkową kontrolę, można zamiast tego użyć klucza zarządzanego przez klienta. EncryptionProperties
keyVaultReference Odwołanie do magazynu kluczy platformy Azure skojarzonego z kontem usługi Batch. KeyVaultReference
networkProfile Profil sieciowy ma zastosowanie tylko wtedy, gdy funkcja publicNetworkAccess jest włączona. NetworkProfile
poolAllocationMode Tryb alokacji puli wpływa również na sposób uwierzytelniania klientów w interfejsie API usługi Batch. Jeśli tryb to BatchService, klienci mogą uwierzytelniać się przy użyciu kluczy dostępu lub identyfikatora Entra firmy Microsoft. Jeśli tryb to UserSubscription, klienci muszą używać identyfikatora Entra firmy Microsoft. Wartość domyślna to BatchService. "BatchService"
"UserSubscription"
publicNetworkAccess Jeśli nie zostanie określona, wartość domyślna to "włączone". "Wyłączone"
"Włączone"

BatchAccountIdentity

Nazwa Opis Wartość
typ Typ tożsamości używany dla konta usługi Batch. "Brak"
"SystemAssigned"
"UserAssigned" (wymagane)
userAssignedIdentities Lista tożsamości użytkowników skojarzonych z kontem usługi Batch. BatchAccountIdentityUserAssignedIdentities

BatchAccountIdentityUserAssignedIdentities

Nazwa Opis Wartość

ComputeNodeIdentityReference

Nazwa Opis Wartość
resourceId Identyfikator zasobu usługi ARM tożsamości przypisanej przez użytkownika. struna

Właściwości szyfrowania

Nazwa Opis Wartość
keySource Typ źródła klucza. "Microsoft.Batch"
"Microsoft.KeyVault"
keyVaultProperties Dodatkowe szczegóły dotyczące korzystania z usługi Microsoft.KeyVault KeyVaultProperties

EndpointAccessProfile

Nazwa Opis Wartość
defaultAction Domyślna akcja dostępu do punktu końcowego. Ma zastosowanie tylko wtedy, gdy funkcja publicNetworkAccess jest włączona. "Zezwalaj"
"Odmów" (wymagane)
ipRules Tablica zakresów adresów IP do filtrowania adresu IP klienta. IPRule []

Adres IPRule

Nazwa Opis Wartość
akcja Akcja w przypadku dopasowania adresu IP klienta. "Zezwalaj" (wymagane)
wartość Adres IPv4 lub zakres adresów IPv4 w formacie CIDR. ciąg (wymagany)

KeyVaultProperties

Nazwa Opis Wartość
keyIdentifier Pełna ścieżka do wpisu tajnego z wersją lub bez tej wersji. Przykład https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. lub https://mykeyvault.vault.azure.net/keys/testkey. Aby można było używać następujących wymagań wstępnych, należy spełnić następujące wymagania wstępne:

Konto usługi Batch ma tożsamość przypisaną przez system
Tożsamość konta ma przyznane uprawnienia Klucz/Get, Klucz/Odpakowywanie i Klucz/Zawijanie
Usługa KeyVault ma włączoną ochronę przed usuwaniem nietrwałym i przeczyszczaniem		 struna

KeyVaultReference

Nazwa Opis Wartość
id Identyfikator zasobu magazynu kluczy platformy Azure skojarzony z kontem usługi Batch. ciąg (wymagany)
adres URL Adres URL magazynu kluczy platformy Azure skojarzony z kontem usługi Batch. ciąg (wymagany)

Microsoft.Batch/batchAccounts

Nazwa Opis Wartość
tożsamość Tożsamość konta usługi Batch. BatchAccountIdentity
lokalizacja Region, w którym ma zostać utworzone konto. ciąg (wymagany)
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 3
Maksymalna długość = 3
Wzorzec = ^[a-z0-9]+$ (wymagane)
Właściwości Właściwości konta usługi Batch. BatchAccountCreatePropertiesOrBatchAccountProperties
Tagi Tagi zasobów Słownik nazw tagów i wartości.
typ Typ zasobu "Microsoft.Batch/batchAccounts@2023-11-01"

NetworkProfile

Nazwa Opis Wartość
accountAccess Profil dostępu do sieci dla punktu końcowego batchAccount (interfejs API płaszczyzny danych konta usługi Batch). endpointAccessProfile
nodeManagementAccess Profil dostępu do sieci dla punktu końcowego nodeManagement (usługa Batch zarządzająca węzłami obliczeniowymi dla pul usługi Batch). endpointAccessProfile

UserAssignedIdentities

Nazwa Opis Wartość