Batch Account - Regenerate Key

Service:

Batch Management

API Version:

2024-02-01

Återskapar den angivna kontonyckeln för Batch-kontot.
Den här åtgärden gäller endast för Batch-konton med allowedAuthenticationModes som innehåller "SharedKey". Om Batch-kontot inte innehåller "SharedKey" i dess allowedAuthenticationMode kan klienter inte använda delade nycklar för att autentisera och måste använda en annan allowedAuthenticationModes i stället. I det här fallet misslyckas återställningen av nycklarna.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
accountName	path	True	string	Namnet på Batch-kontot. Regex pattern: ^[a-zA-Z0-9]+$
resourceGroupName	path	True	string	Namnet på resursgruppen som innehåller Batch-kontot.
subscriptionId	path	True	string	Azure-prenumerations-ID:t. Detta är en GUID-formaterad sträng (t.ex. 000000000-0000-0000-0000-0000000000000000)
api-version	query	True	string	DEN API-version som ska användas med HTTP-begäran.

Begärandetext

Name	Obligatorisk	Typ	Description
keyName	True	AccountKeyType	Typ av kontonyckel som ska återskapas.

Svar

Name	Typ	Description
200 OK	BatchAccountKeys	Åtgärden lyckades. Svaret innehåller Batch-kontonycklarna.
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Microsoft Entra autentiseringskodflöde för OAuth 2.0

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

Scopes

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

BatchAccountRegenerateKey

Sample Request

HTTP

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

{
  "keyName": "Primary"
}

Java

import com.azure.resourcemanager.batch.models.AccountKeyType;
import com.azure.resourcemanager.batch.models.BatchAccountRegenerateKeyParameters;

/**
 * Samples for BatchAccount RegenerateKey.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/BatchAccountRegenerateKey.json
     */
    /**
     * Sample code: BatchAccountRegenerateKey.
     * 
     * @param manager Entry point to BatchManager.
     */
    public static void batchAccountRegenerateKey(com.azure.resourcemanager.batch.BatchManager manager) {
        manager.batchAccounts().regenerateKeyWithResponse("default-azurebatch-japaneast", "sampleacct",
            new BatchAccountRegenerateKeyParameters().withKeyName(AccountKeyType.PRIMARY),
            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_regenerate_key.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.regenerate_key(
        resource_group_name="default-azurebatch-japaneast",
        account_name="sampleacct",
        parameters={"keyName": "Primary"},
    )
    print(response)


# x-ms-original-file: specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/BatchAccountRegenerateKey.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/azcore/to"
	"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/BatchAccountRegenerateKey.json
func ExampleAccountClient_RegenerateKey() {
	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().RegenerateKey(ctx, "default-azurebatch-japaneast", "sampleacct", armbatch.AccountRegenerateKeyParameters{
		KeyName: to.Ptr(armbatch.AccountKeyTypePrimary),
	}, 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.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, regenerating 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, regenerating the keys will fail.
 * x-ms-original-file: specification/batch/resource-manager/Microsoft.Batch/stable/2024-02-01/examples/BatchAccountRegenerateKey.json
 */
async function batchAccountRegenerateKey() {
  const subscriptionId = process.env["BATCH_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["BATCH_RESOURCE_GROUP"] || "default-azurebatch-japaneast";
  const accountName = "sampleacct";
  const parameters = {
    keyName: "Primary",
  };
  const credential = new DefaultAzureCredential();
  const client = new BatchManagementClient(credential, subscriptionId);
  const result = await client.batchAccountOperations.regenerateKey(
    resourceGroupName,
    accountName,
    parameters,
  );
  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/BatchAccountRegenerateKey.json
// this example is just showing the usage of "BatchAccount_RegenerateKey" 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
BatchAccountRegenerateKeyContent content = new BatchAccountRegenerateKeyContent(BatchAccountKeyType.Primary);
BatchAccountKeys result = await batchAccount.RegenerateKeyAsync(content);

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

Sample Response

Status code:

200

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

Definitioner

Name	Description
AccountKeyType	Typ av kontonyckel som ska återskapas.
BatchAccountKeys	En uppsättning Azure Batch kontonycklar.
BatchAccountRegenerateKeyParameters	Parametrar som har angetts för åtgärden RegenerateKey.
CloudError	Ett felsvar från Batch-tjänsten.
CloudErrorBody	Ett felsvar från Batch-tjänsten.

AccountKeyType

Typ av kontonyckel som ska återskapas.

Name	Typ	Description
Primary	string	Den primära kontonyckeln.
Secondary	string	Den sekundära kontonyckeln.

BatchAccountKeys

En uppsättning Azure Batch kontonycklar.

Name	Typ	Description
accountName	string	Batch-kontonamnet.
primary	string	Primärnyckeln som är associerad med kontot.
secondary	string	Den sekundära nyckeln som är associerad med kontot.

BatchAccountRegenerateKeyParameters

Parametrar som har angetts för åtgärden RegenerateKey.

Name	Typ	Description
keyName	AccountKeyType	Typ av kontonyckel som ska återskapas.

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.