Batch Account - Get Keys

Szolgáltatás:

Batch Management

API-verzió:

2025-06-01

Lekéri a megadott Batch-fiók fiókkulcsait.
Ez a művelet csak a "SharedKey" tartalmú engedélyezettAuthenticationModes batch-fiókokra vonatkozik. Ha a Batch-fiók nem tartalmazza a "SharedKey" értéket az engedélyezettAuthenticationMode-ban, az ügyfelek nem használhatnak megosztott kulcsokat a hitelesítéshez, és ehelyett egy másik engedélyezettAuthenticationModes-t kell használniuk. Ebben az esetben a kulcsok lekérése sikertelen lesz.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/listKeys?api-version=2025-06-01

URI-paraméterek

Name	In	Kötelező	Típus	Description
accountName	path	True	string minLength: 3 maxLength: 24 pattern: ^[a-zA-Z0-9]+$	Egy név a Batch fióknak, amelynek egyedinek kell lennie a régión belül. A csomagi számlanevek 3 és 24 karakter közötti hosszúságúak lehetnek, és csak számokat és kisbetűket kell használniuk. Ez a név a DNS név részeként szolgál, amely a Batch szolgáltatáshoz való hozzáférést szolgál abban a régióban, ahol a fiók létrejött. Például: http://accountname.region.batch.azure.com/.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
subscriptionId	path	True	string (uuid)	A cél-előfizetés azonosítója. Az értéknek UUID-nek kell lennie.
api-version	query	True	string minLength: 1	A művelethez használandó API-verzió.

Válaszok

Name	Típus	Description
200 OK	BatchAccountKeys	Az Azure-művelet sikeresen befejeződött.
Other Status Codes	CloudError	Váratlan hibaválasz.

Biztonság

azure_auth

Azure Active Directory OAuth2-folyamat.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

BatchAccountGetKeys

Mintakérelem

HTTP

POST https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/listKeys?api-version=2025-06-01

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_keys.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="SUBSCRIPTION_ID",
    )

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


# x-ms-original-file: 2025-06-01/BatchAccountGetKeys.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/v4"
)

// Generated from example definition: 2025-06-01/BatchAccountGetKeys.json
func ExampleAccountClient_GetKeys() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armbatch.NewClientFactory("12345678-1234-1234-1234-123456789012", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAccountClient().GetKeys(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 = armbatch.AccountClientGetKeysResponse{
	// 	AccountKeys: &armbatch.AccountKeys{
	// 		AccountName: to.Ptr("sampleacct"),
	// 		Primary: to.Ptr("AAAA=="),
	// 		Secondary: to.Ptr("BBBB=="),
	// 	},
	// }
}

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 this operation applies only to Batch accounts with allowedAuthenticationModes containing 'SharedKey'. If the Batch account doesn't contain 'SharedKey' in its allowedAuthenticationMode, clients cannot use shared keys to authenticate, and must use another allowedAuthenticationModes instead. In this case, getting the keys will fail.
 *
 * @summary this operation applies only to Batch accounts with allowedAuthenticationModes containing 'SharedKey'. If the Batch account doesn't contain 'SharedKey' in its allowedAuthenticationMode, clients cannot use shared keys to authenticate, and must use another allowedAuthenticationModes instead. In this case, getting the keys will fail.
 * x-ms-original-file: 2025-06-01/BatchAccountGetKeys.json
 */
async function batchAccountGetKeys() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "12345678-1234-1234-1234-123456789012";
  const client = new BatchManagementClient(credential, subscriptionId);
  const result = await client.batchAccount.getKeys("default-azurebatch-japaneast", "sampleacct");
  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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Batch.Models;
using Azure.ResourceManager.Batch;

// Generated from example definition: specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/BatchAccountGetKeys.json
// this example is just showing the usage of "BatchAccount_GetKeys" 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 = "12345678-1234-1234-1234-123456789012";
string resourceGroupName = "default-azurebatch-japaneast";
string accountName = "sampleacct";
ResourceIdentifier batchAccountResourceId = BatchAccountResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
BatchAccountResource batchAccount = client.GetBatchAccountResource(batchAccountResourceId);

// invoke the operation
BatchAccountKeys result = await batchAccount.GetKeysAsync();

Console.WriteLine($"Succeeded: {result}");

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

Mintaválasz

Állapotkód:

200

{
  "accountName": "sampleacct",
  "primary": "AAAA==",
  "secondary": "BBBB=="
}

Definíciók

Name	Description
BatchAccountKeys	Azure Batch-fiókkulcsok készlete.
CloudError	Hibaválasz a Batch szolgáltatástól.
CloudErrorBody	Hibaválasz a Batch szolgáltatástól.

BatchAccountKeys

Tárgy

Azure Batch-fiókkulcsok készlete.

Name	Típus	Description
accountName	string	A Batch-fiók neve.
primary	string	A fiókhoz társított elsődleges kulcs.
secondary	string	A fiókhoz társított másodlagos kulcs.

CloudError

Tárgy

Hibaválasz a Batch szolgáltatástól.

Name	Típus	Description
error	CloudErrorBody	A hibaválasz törzse.

CloudErrorBody

Tárgy

Hibaválasz a Batch szolgáltatástól.

Name	Típus	Description
code	string	A hiba azonosítója. A kódok invariánsak, és programozott módon használhatók.
details	CloudErrorBody[]	A hiba további részleteinek listája.
message	string	A hibát leíró üzenet, amely alkalmas a felhasználói felületen való megjelenítésre.
target	string	Az adott hiba célja. Például a tulajdonság neve hibás.