Batch Account - Get

Služba:

Batch Management

Verze rozhraní API:

2024-02-01

Získá informace o zadaném účtu Batch.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
accountName	path	True	string	Název účtu Batch. Vzor regulárního výrazu: ^[a-zA-Z0-9]+$
resourceGroupName	path	True	string	Název skupiny prostředků, která obsahuje účet Batch.
subscriptionId	path	True	string	ID předplatného Azure. Jedná se o řetězec ve formátu GUID (např. 00000000-0000-0000-0000-00000000000000000000000000000).
api-version	query	True	string	Verze rozhraní API, která se má použít s požadavkem HTTP.

Odpovědi

Name	Typ	Description
200 OK	BatchAccount	Operace byla úspěšná. Odpověď obsahuje entitu účtu Batch.
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Microsoft Entra tok kódu ověřování OAuth 2.0

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

BatchAccountGet

PrivateBatchAccountGet

BatchAccountGet

Ukázkový požadavek

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct?api-version=2024-02-01

Java

/**
 * Samples for BatchAccount GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/BatchAccountGet.json
     */
    /**
     * Sample code: BatchAccountGet.
     * 
     * @param manager Entry point to BatchManager.
     */
    public static void batchAccountGet(com.azure.resourcemanager.batch.BatchManager manager) {
        manager.batchAccounts().getByResourceGroupWithResponse("default-azurebatch-japaneast", "sampleacct",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.batch import BatchManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-batch
# USAGE
    python batch_account_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = BatchManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.batch_account.get(
        resource_group_name="default-azurebatch-japaneast",
        account_name="sampleacct",
    )
    print(response)


# x-ms-original-file: specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/BatchAccountGet.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armbatch_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/batch/armbatch/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/BatchAccountGet.json
func ExampleAccountClient_Get_batchAccountGet() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armbatch.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAccountClient().Get(ctx, "default-azurebatch-japaneast", "sampleacct", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Account = armbatch.Account{
	// 	Name: to.Ptr("sampleacct"),
	// 	Type: to.Ptr("Microsoft.Batch/batchAccounts"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct"),
	// 	Location: to.Ptr("japaneast"),
	// 	Identity: &armbatch.AccountIdentity{
	// 		Type: to.Ptr(armbatch.ResourceIdentityTypeNone),
	// 	},
	// 	Properties: &armbatch.AccountProperties{
	// 		AccountEndpoint: to.Ptr("sampleacct.japaneast.batch.azure.com"),
	// 		ActiveJobAndJobScheduleQuota: to.Ptr[int32](20),
	// 		AutoStorage: &armbatch.AutoStorageProperties{
	// 			StorageAccountID: to.Ptr("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage"),
	// 			LastKeySync: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2016-03-10T23:48:38.987Z"); return t}()),
	// 		},
	// 		DedicatedCoreQuota: to.Ptr[int32](20),
	// 		LowPriorityCoreQuota: to.Ptr[int32](20),
	// 		PoolAllocationMode: to.Ptr(armbatch.PoolAllocationModeBatchService),
	// 		PoolQuota: to.Ptr[int32](20),
	// 		ProvisioningState: to.Ptr(armbatch.ProvisioningStateSucceeded),
	// 		PublicNetworkAccess: to.Ptr(armbatch.PublicNetworkAccessTypeEnabled),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { BatchManagementClient } = require("@azure/arm-batch");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets information about the specified Batch account.
 *
 * @summary Gets information about the specified Batch account.
 * x-ms-original-file: specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/BatchAccountGet.json
 */
async function batchAccountGet() {
  const subscriptionId = process.env["BATCH_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["BATCH_RESOURCE_GROUP"] || "default-azurebatch-japaneast";
  const accountName = "sampleacct";
  const credential = new DefaultAzureCredential();
  const client = new BatchManagementClient(credential, subscriptionId);
  const result = await client.batchAccountOperations.get(resourceGroupName, accountName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Batch;
using Azure.ResourceManager.Batch.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/BatchAccountGet.json
// this example is just showing the usage of "BatchAccount_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this BatchAccountResource created on azure
// for more information of creating BatchAccountResource, please refer to the document of BatchAccountResource
string subscriptionId = "subid";
string resourceGroupName = "default-azurebatch-japaneast";
string accountName = "sampleacct";
ResourceIdentifier batchAccountResourceId = BatchAccountResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
BatchAccountResource batchAccount = client.GetBatchAccountResource(batchAccountResourceId);

// invoke the operation
BatchAccountResource result = await batchAccount.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
BatchAccountData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Ukázková odpověď

Stavový kód:

200

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

PrivateBatchAccountGet

Ukázkový požadavek

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct?api-version=2024-02-01

Java

/**
 * Samples for BatchAccount GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/PrivateBatchAccountGet.json
     */
    /**
     * Sample code: PrivateBatchAccountGet.
     * 
     * @param manager Entry point to BatchManager.
     */
    public static void privateBatchAccountGet(com.azure.resourcemanager.batch.BatchManager manager) {
        manager.batchAccounts().getByResourceGroupWithResponse("default-azurebatch-japaneast", "sampleacct",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.batch import BatchManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-batch
# USAGE
    python private_batch_account_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = BatchManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.batch_account.get(
        resource_group_name="default-azurebatch-japaneast",
        account_name="sampleacct",
    )
    print(response)


# x-ms-original-file: specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/PrivateBatchAccountGet.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armbatch_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/batch/armbatch/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/PrivateBatchAccountGet.json
func ExampleAccountClient_Get_privateBatchAccountGet() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armbatch.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAccountClient().Get(ctx, "default-azurebatch-japaneast", "sampleacct", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Account = armbatch.Account{
	// 	Name: to.Ptr("sampleacct"),
	// 	Type: to.Ptr("Microsoft.Batch/batchAccounts"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct"),
	// 	Location: to.Ptr("japaneast"),
	// 	Properties: &armbatch.AccountProperties{
	// 		AccountEndpoint: to.Ptr("sampleacct.japaneast.batch.azure.com"),
	// 		ActiveJobAndJobScheduleQuota: to.Ptr[int32](20),
	// 		AutoStorage: &armbatch.AutoStorageProperties{
	// 			StorageAccountID: to.Ptr("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage"),
	// 			LastKeySync: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2016-03-10T23:48:38.987Z"); return t}()),
	// 		},
	// 		DedicatedCoreQuota: to.Ptr[int32](20),
	// 		LowPriorityCoreQuota: to.Ptr[int32](20),
	// 		PoolAllocationMode: to.Ptr(armbatch.PoolAllocationModeBatchService),
	// 		PoolQuota: to.Ptr[int32](20),
	// 		PrivateEndpointConnections: []*armbatch.PrivateEndpointConnection{
	// 			{
	// 				Name: to.Ptr("testprivateEndpointConnection.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0"),
	// 				Type: to.Ptr("Microsoft.Batch/batchAccounts/privateEndpointConnections"),
	// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnections/testprivateEndpointConnection.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0"),
	// 				Properties: &armbatch.PrivateEndpointConnectionProperties{
	// 					PrivateEndpoint: &armbatch.PrivateEndpoint{
	// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Network/privateEndpoints/testprivateEndpoint"),
	// 					},
	// 					PrivateLinkServiceConnectionState: &armbatch.PrivateLinkServiceConnectionState{
	// 						Description: to.Ptr("Approved by xyz.abc@company.com"),
	// 						Status: to.Ptr(armbatch.PrivateLinkServiceConnectionStatusApproved),
	// 					},
	// 				},
	// 		}},
	// 		ProvisioningState: to.Ptr(armbatch.ProvisioningStateSucceeded),
	// 		PublicNetworkAccess: to.Ptr(armbatch.PublicNetworkAccessTypeDisabled),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { BatchManagementClient } = require("@azure/arm-batch");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets information about the specified Batch account.
 *
 * @summary Gets information about the specified Batch account.
 * x-ms-original-file: specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/PrivateBatchAccountGet.json
 */
async function privateBatchAccountGet() {
  const subscriptionId = process.env["BATCH_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["BATCH_RESOURCE_GROUP"] || "default-azurebatch-japaneast";
  const accountName = "sampleacct";
  const credential = new DefaultAzureCredential();
  const client = new BatchManagementClient(credential, subscriptionId);
  const result = await client.batchAccountOperations.get(resourceGroupName, accountName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Batch;
using Azure.ResourceManager.Batch.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/PrivateBatchAccountGet.json
// this example is just showing the usage of "BatchAccount_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this BatchAccountResource created on azure
// for more information of creating BatchAccountResource, please refer to the document of BatchAccountResource
string subscriptionId = "subid";
string resourceGroupName = "default-azurebatch-japaneast";
string accountName = "sampleacct";
ResourceIdentifier batchAccountResourceId = BatchAccountResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
BatchAccountResource batchAccount = client.GetBatchAccountResource(batchAccountResourceId);

// invoke the operation
BatchAccountResource result = await batchAccount.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
BatchAccountData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Ukázková odpověď

Stavový kód:

200

{
  "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": "Disabled",
    "privateEndpointConnections": [
      {
        "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnections/testprivateEndpointConnection.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0",
        "name": "testprivateEndpointConnection.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0",
        "type": "Microsoft.Batch/batchAccounts/privateEndpointConnections",
        "properties": {
          "privateEndpoint": {
            "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Network/privateEndpoints/testprivateEndpoint"
          },
          "privateLinkServiceConnectionState": {
            "status": "Approved",
            "description": "Approved by xyz.abc@company.com"
          }
        }
      }
    ]
  },
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct",
  "type": "Microsoft.Batch/batchAccounts"
}

Definice

Name	Description
AuthenticationMode	Režim ověřování pro účet Batch.
AutoStorageAuthenticationMode	Režim ověřování, který bude služba Batch používat ke správě účtu automatického úložiště.
AutoStorageProperties	Obsahuje informace o účtu automatického úložiště přidruženého k účtu Batch.
BatchAccount	Obsahuje informace o účtu Azure Batch.
BatchAccountIdentity	Identita účtu Batch, pokud je nakonfigurovaný. Používá se, když uživatel jako konfiguraci šifrování účtu Batch zadá Microsoft.KeyVault nebo když ManagedIdentity je vybraný jako režim ověřování automatického úložiště.
CloudError	Chybová odpověď ze služby Batch.
CloudErrorBody	Chybová odpověď ze služby Batch.
ComputeNodeIdentityReference	Odkaz na identitu přiřazenou uživatelem přidruženou k fondu služby Batch, který bude používat výpočetní uzel.
EncryptionProperties	Konfiguruje způsob šifrování zákaznických dat v rámci účtu Batch. Ve výchozím nastavení se účty šifrují pomocí klíče spravovaného Microsoftem. Pro další kontrolu je možné místo toho použít klíč spravovaný zákazníkem.
EndpointAccessDefaultAction	Výchozí akce, pokud není shoda s žádným pravidlem IPRule.
EndpointAccessProfile	Profil přístupu k síti pro koncový bod služby Batch.
IPRule	Pravidlo pro filtrování IP adresy klienta
IPRuleAction	Akce při shodě IP adresy klienta
KeySource	Typ zdroje klíče.
KeyVaultProperties	Konfigurace služby KeyVault při použití šifrovacího zdroje klíčů Microsoft.KeyVault.
KeyVaultReference	Identifikuje trezor klíčů Azure přidružený k účtu Batch.
NetworkProfile	Profil sítě pro účet Batch, který obsahuje nastavení pravidel sítě pro každý koncový bod.
PoolAllocationMode	Režim přidělování pro vytváření fondů v účtu Batch.
PrivateEndpoint	Privátní koncový bod připojení privátního koncového bodu.
PrivateEndpointConnection	Obsahuje informace o prostředku privátního propojení.
PrivateEndpointConnectionProvisioningState	Stav zřizování připojení privátního koncového bodu.
PrivateLinkServiceConnectionState	Stav připojení služby Private Link připojení privátního koncového bodu
PrivateLinkServiceConnectionStatus	Stav připojení privátního koncového bodu Služby Batch
ProvisioningState	Stav zřízeného prostředku
PublicNetworkAccessType	Typ síťového přístupu pro provoz s prostředky v účtu Batch.
ResourceIdentityType	Typ identity použitý pro účet Batch.
UserAssignedIdentities	Seznam přidružených identit uživatelů.
VirtualMachineFamilyCoreQuota	Řada virtuálních počítačů a její přidružená kvóta jader pro účet Batch.

AuthenticationMode

Režim ověřování pro účet Batch.

Name	Typ	Description
AAD	string	Režim ověřování pomocí Microsoft Entra ID.
SharedKey	string	Režim ověřování s využitím sdílených klíčů.
TaskAuthenticationToken	string	Režim ověřování využívající ověřovací tokeny úloh.

AutoStorageAuthenticationMode

Režim ověřování, který bude služba Batch používat ke správě účtu automatického úložiště.

Name	Typ	Description
BatchAccountManagedIdentity	string	Služba Batch ověří požadavky na automatické úložiště pomocí spravované identity přiřazené k účtu Batch.
StorageKeys	string	Služba Batch bude ověřovat požadavky na automatické úložiště pomocí klíčů účtu úložiště.

AutoStorageProperties

Obsahuje informace o účtu automatického úložiště přidruženého k účtu Batch.

Name	Typ	Default value	Description
authenticationMode	AutoStorageAuthenticationMode	StorageKeys	Režim ověřování, který bude služba Batch používat ke správě účtu automatického úložiště.
lastKeySync	string		Čas UTC, kdy se klíče úložiště naposledy synchronizovaly s účtem Batch.
nodeIdentityReference	ComputeNodeIdentityReference		Odkaz na identitu přiřazenou uživatelem, kterou budou výpočetní uzly používat pro přístup k automatickému úložišti. Identita, na kterou se odkazuje, musí být přiřazená fondům, které mají výpočetní uzly, které potřebují přístup k automatickému úložišti.
storageAccountId	string		ID prostředku účtu úložiště, který se má použít pro účet automatického úložiště.

BatchAccount

Obsahuje informace o účtu Azure Batch.

Name	Typ	Default value	Description
id	string		ID prostředku.
identity	BatchAccountIdentity		Identita účtu Batch.
location	string		Umístění prostředku.
name	string		Název prostředku.
properties.accountEndpoint	string		Koncový bod účtu použitý k interakci se službou Batch.
properties.activeJobAndJobScheduleQuota	integer		Kvóta aktivních úloh a plánů úloh pro účet Batch.
properties.allowedAuthenticationModes	AuthenticationMode[]		Seznam povolených režimů ověřování pro účet Batch, které se dají použít k ověření v rovině dat To nemá vliv na ověřování pomocí řídicí roviny.
properties.autoStorage	AutoStorageProperties		Vlastnosti a stav libovolného účtu automatického úložiště přidruženého k účtu Batch. Obsahuje informace o účtu automatického úložiště přidruženého k účtu Batch.
properties.dedicatedCoreQuota	integer		Kvóta vyhrazených jader pro účet Batch. U účtů s PoolAllocationMode nastaveným na UserSubscription se kvóta spravuje pro předplatné, takže se tato hodnota nevrací.
properties.dedicatedCoreQuotaPerVMFamily	VirtualMachineFamilyCoreQuota[]		Seznam kvóty vyhrazených jader na řadu virtuálních počítačů pro účet Batch. U účtů s PoolAllocationMode nastaveným na UserSubscription se kvóta spravuje pro předplatné, takže se tato hodnota nevrací.
properties.dedicatedCoreQuotaPerVMFamilyEnforced	boolean		Hodnota označující, jestli se pro tento účet vynucují kvóty jader na řadu virtuálních počítačů. Pokud je tento příznak pravdivý, kvóta vyhrazených jader se vynucuje prostřednictvím vlastností dedicatedCoreQuotaPerVMFamily i dedicatedCoreQuota na účtu. Pokud má tento příznak hodnotu false, kvóta vyhrazených jader se vynucuje pouze prostřednictvím vlastnosti dedicatedCoreQuota v účtu a nebere v úvahu řadu virtuálních počítačů.
properties.encryption	EncryptionProperties		Konfigurace šifrování pro účet Batch. Konfiguruje způsob šifrování zákaznických dat v rámci účtu Batch. Ve výchozím nastavení se účty šifrují pomocí klíče spravovaného Microsoftem. Pro další kontrolu je možné místo toho použít klíč spravovaný zákazníkem.
properties.keyVaultReference	KeyVaultReference		Odkaz na trezor klíčů Azure přidružený k účtu Batch. Identifikuje trezor klíčů Azure přidružený k účtu Batch.
properties.lowPriorityCoreQuota	integer		Kvóta spotových jader nebo jádra s nízkou prioritou pro účet Batch. U účtů s PoolAllocationMode nastaveným na UserSubscription se kvóta spravuje pro předplatné, takže se tato hodnota nevrací.
properties.networkProfile	NetworkProfile		Profil sítě pro účet Batch, který obsahuje nastavení pravidel sítě pro každý koncový bod. Profil sítě se projeví pouze v případech, kdy je povolená technologie publicNetworkAccess.
properties.nodeManagementEndpoint	string		Koncový bod používaný výpočetním uzlem pro připojení ke službě pro správu uzlů Batch.
properties.poolAllocationMode	PoolAllocationMode		Režim přidělení pro použití při vytváření fondů v účtu Batch. Režim přidělování pro vytváření fondů v účtu Batch.
properties.poolQuota	integer		Kvóta fondu pro účet Batch.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Seznam připojení privátních koncových bodů přidružených k účtu Batch
properties.provisioningState	ProvisioningState		Stav zřízeného prostředku
properties.publicNetworkAccess	PublicNetworkAccessType	Enabled	Typ síťového rozhraní pro přístup k operacím Azure Batch služby a účtu Batch. Pokud není zadaný, výchozí hodnota je "povoleno".
tags	object		Značky prostředku.
type	string		Typ prostředku.

BatchAccountIdentity

Identita účtu Batch, pokud je nakonfigurovaný. Používá se, když uživatel jako konfiguraci šifrování účtu Batch zadá Microsoft.KeyVault nebo když ManagedIdentity je vybraný jako režim ověřování automatického úložiště.

Name	Typ	Description
principalId	string	ID objektu zabezpečení účtu Batch. Tato vlastnost bude poskytnuta pouze pro identitu přiřazenou systémem.
tenantId	string	ID tenanta přidruženého k účtu Batch. Tato vlastnost bude poskytnuta pouze pro identitu přiřazenou systémem.
type	ResourceIdentityType	Typ identity použitý pro účet Batch.
userAssignedIdentities	<string,  UserAssignedIdentities>	Seznam identit uživatelů přidružených k účtu Batch.

CloudError

Chybová odpověď ze služby Batch.

Name	Typ	Description
error	CloudErrorBody	Tělo chybové odpovědi.

CloudErrorBody

Chybová odpověď ze služby Batch.

Name	Typ	Description
code	string	Identifikátor chyby. Kódy jsou invariantní a mají být využívány programově.
details	CloudErrorBody[]	Seznam dalších podrobností o chybě
message	string	Zpráva popisující chybu, která má být vhodná pro zobrazení v uživatelském rozhraní.
target	string	Cíl konkrétní chyby. Například název vlastnosti v chybě.

ComputeNodeIdentityReference

Odkaz na identitu přiřazenou uživatelem přidruženou k fondu služby Batch, který bude používat výpočetní uzel.

Name	Typ	Description
resourceId	string	ID prostředku ARM identity přiřazené uživatelem.

EncryptionProperties

Konfiguruje způsob šifrování zákaznických dat v rámci účtu Batch. Ve výchozím nastavení se účty šifrují pomocí klíče spravovaného Microsoftem. Pro další kontrolu je možné místo toho použít klíč spravovaný zákazníkem.

Name	Typ	Description
keySource	KeySource	Typ zdroje klíče.
keyVaultProperties	KeyVaultProperties	Další podrobnosti při použití Microsoft.KeyVault

EndpointAccessDefaultAction

Výchozí akce, pokud není shoda s žádným pravidlem IPRule.

Name	Typ	Description
Allow	string	Povolit klientský přístup.
Deny	string	Odepřít klientský přístup.

EndpointAccessProfile

Profil přístupu k síti pro koncový bod služby Batch.

Name	Typ	Description
defaultAction	EndpointAccessDefaultAction	Výchozí akce, pokud není shoda s žádným pravidlem IPRule. Výchozí akce pro přístup ke koncovému bodu Platí jenom v případě, že je povolená technologie publicNetworkAccess.
ipRules	IPRule[]	Pole rozsahů IP adres pro filtrování IP adres klienta

IPRule

Pravidlo pro filtrování IP adresy klienta

Name	Typ	Description
action	IPRuleAction	Akce při shodě IP adresy klienta
value	string	IP adresa nebo rozsah IP adres, které se mají filtrovat IPv4 adresa nebo rozsah IPv4 adres ve formátu CIDR.

IPRuleAction

Akce při shodě IP adresy klienta

Name	Typ	Description
Allow	string	Povolte přístup pro odpovídající IP adresu klienta.

KeySource

Typ zdroje klíče.

Name	Typ	Description
Microsoft.Batch	string	Batch vytvoří a spravuje šifrovací klíče používané k ochraně dat účtu.
Microsoft.KeyVault	string	Šifrovací klíče použité k ochraně dat účtu jsou uložené v externím trezoru klíčů. Pokud je tato možnost nastavená, musí být identita účtu Batch nastavená na SystemAssigned hodnotu a v části keyVaultProperties musí být také zadán platný identifikátor klíče.

KeyVaultProperties

Konfigurace služby KeyVault při použití šifrovacího zdroje klíčů Microsoft.KeyVault.

Name	Typ	Description
keyIdentifier	string	Úplná cesta k tajnému kódu s verzí nebo bez. Příklad https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053: nebo https://mykeyvault.vault.azure.net/keys/testkey. Aby byly použitelné, musí být splněny následující požadavky: Účet Batch má identitu přiřazenou systémem. Identita účtu má udělená oprávnění Klíč/Získání, Klíč/Rozbalení a Klíč/Zalamování. Služba KeyVault má povolenou ochranu proti obnovitelnému odstranění a vymazání.

KeyVaultReference

Identifikuje trezor klíčů Azure přidružený k účtu Batch.

Name	Typ	Description
id	string	ID prostředku trezoru klíčů Azure přidruženého k účtu Batch
url	string	Adresa URL trezoru klíčů Azure přidruženého k účtu Batch

NetworkProfile

Profil sítě pro účet Batch, který obsahuje nastavení pravidel sítě pro každý koncový bod.

Name	Typ	Description
accountAccess	EndpointAccessProfile	Profil přístupu k síti pro koncový bod batchAccount (rozhraní API roviny dat účtu Batch).
nodeManagementAccess	EndpointAccessProfile	Profil přístupu k síti pro koncový bod nodeManagement (služba Batch spravující výpočetní uzly pro fondy Batch).

PoolAllocationMode

Režim přidělování pro vytváření fondů v účtu Batch.

Name	Typ	Description
BatchService	string	Fondy se přidělují v předplatných vlastněných službou Batch.
UserSubscription	string	Fondy se přidělují v předplatném vlastněné uživatelem.

PrivateEndpoint

Privátní koncový bod připojení privátního koncového bodu.

Name	Typ	Description
id	string	Identifikátor prostředku ARM privátního koncového bodu. Toto je ve formátu /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}.

PrivateEndpointConnection

Obsahuje informace o prostředku privátního propojení.

Name	Typ	Description
etag	string	Značka ETag prostředku, která se používá pro příkazy souběžnosti.
id	string	ID prostředku.
name	string	Název prostředku.
properties.groupIds	string[]	ID skupiny připojení privátního koncového bodu. Hodnota má jedno a jenom jedno ID skupiny.
properties.privateEndpoint	PrivateEndpoint	Identifikátor prostředku ARM privátního koncového bodu. Privátní koncový bod připojení privátního koncového bodu.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Stav připojení služby Private Link připojení privátního koncového bodu. Stav připojení služby Private Link připojení privátního koncového bodu
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Stav zřizování připojení privátního koncového bodu.
type	string	Typ prostředku.

PrivateEndpointConnectionProvisioningState

Stav zřizování připojení privátního koncového bodu.

Name	Typ	Description
Cancelled	string	Uživatel zrušil vytvoření připojení.
Creating	string	Připojení se vytváří.
Deleting	string	Připojení se odstraňuje.
Failed	string	Uživatel požádal, aby se připojení aktualizovalo, a to se nezdařilo. Operaci aktualizace můžete zkusit zopakovat.
Succeeded	string	Stav připojení je konečný a je připravený k použití, pokud je stav Schváleno.
Updating	string	Uživatel požádal o aktualizaci stavu připojení, ale operace aktualizace ještě nebyla dokončena. Při připojování účtu Batch nesmíte na připojení odkazovat.

PrivateLinkServiceConnectionState

Stav připojení služby Private Link připojení privátního koncového bodu

Name	Typ	Description
actionsRequired	string	Akce vyžadovaná pro stav privátního připojení
description	string	Popis stavu privátního připojení
status	PrivateLinkServiceConnectionStatus	Stav připojení privátního koncového bodu účtu Batch

PrivateLinkServiceConnectionStatus

Stav připojení privátního koncového bodu Služby Batch

Name	Typ	Description
Approved	string	Připojení privátního koncového bodu je schválené a dá se použít pro přístup k účtu Batch.
Disconnected	string	Připojení privátního koncového bodu je odpojené a nedá se použít pro přístup k účtu Batch.
Pending	string	Připojení privátního koncového bodu čeká na vyřízení a nedá se použít pro přístup k účtu Batch.
Rejected	string	Připojení privátního koncového bodu se odmítlo a nedá se použít pro přístup k účtu Batch.

ProvisioningState

Stav zřízeného prostředku

Name	Typ	Description
Cancelled	string	Poslední operace pro účet je zrušena.
Creating	string	Účet se právě vytváří.
Deleting	string	Účet se odstraňuje.
Failed	string	Poslední operace pro účet selhala.
Invalid	string	Účet je v neplatném stavu.
Succeeded	string	Účet byl vytvořen a je připravený k použití.

PublicNetworkAccessType

Typ síťového přístupu pro provoz s prostředky v účtu Batch.

Name	Typ	Description
Disabled	string	Zakáže veřejné připojení a povolí privátní připojení ke službě Azure Batch Service prostřednictvím prostředku privátního koncového bodu.
Enabled	string	Umožňuje připojení k Azure Batch prostřednictvím veřejného DNS.

ResourceIdentityType

Typ identity použitý pro účet Batch.

Name	Typ	Description
None	string	Účet Batch nemá přidruženou žádnou identitu. Nastavení None v aktualizačním účtu odebere existující identity.
SystemAssigned	string	Účet Batch má identitu přiřazenou systémem.
UserAssigned	string	Účet Batch má identity přiřazené uživatelem.

UserAssignedIdentities

Seznam přidružených identit uživatelů.

Name	Typ	Description
clientId	string	ID klienta identity přiřazené uživatelem.
principalId	string	ID objektu zabezpečení identity přiřazené uživatelem.

VirtualMachineFamilyCoreQuota

Řada virtuálních počítačů a její přidružená kvóta jader pro účet Batch.

Name	Typ	Description
coreQuota	integer	Kvóta jader pro řadu virtuálních počítačů pro účet Batch.
name	string	Název rodiny virtuálních počítačů.