Повторно создает указанный ключ учетной записи для учетной записи пакетной службы.
Эта операция применяется только к учетным записям пакетной службы с разрешенной службойAuthenticationModes, содержащей SharedKey. Если учетная запись пакетной службы не содержит SharedKey в разрешенной службеAuthenticationMode, клиенты не могут использовать общие ключи для проверки подлинности и вместо этого должны использовать другой разрешенный параметрAuthenticationModes. В этом случае повторное создание ключей завершится ошибкой.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/regenerateKeys?api-version=2024-07-01
Параметры URI
Имя |
В |
Обязательно |
Тип |
Описание |
accountName
|
path |
True
|
string
minLength: 3 maxLength: 24 pattern: ^[a-zA-Z0-9]+$
|
Имя учетной записи пакетной службы.
|
resourceGroupName
|
path |
True
|
string
|
Имя группы ресурсов, содержащей учетную запись пакетной службы.
|
subscriptionId
|
path |
True
|
string
|
Идентификатор подписки Azure. Это строка с форматом GUID (например, 000000000-0000-0000-0000-0000-000000000000000000000)
|
api-version
|
query |
True
|
string
|
Версия API, используемая с HTTP-запросом.
|
Текст запроса
Имя |
Обязательно |
Тип |
Описание |
keyName
|
True
|
AccountKeyType
|
Тип ключа учетной записи для повторного создания.
|
Ответы
Имя |
Тип |
Описание |
200 OK
|
BatchAccountKeys
|
Операция прошла успешно. Ответ содержит ключи учетной записи пакетной службы.
|
Other Status Codes
|
CloudError
|
Ответ на ошибку, описывающий причину сбоя операции.
|
Безопасность
azure_auth
Поток кода проверки подлинности Microsoft Entra OAuth 2.0
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
Имя |
Описание |
user_impersonation
|
олицетворения учетной записи пользователя
|
Примеры
BatchAccountRegenerateKey
Образец запроса
POST https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/regenerateKeys?api-version=2024-07-01
{
"keyName": "Primary"
}
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-07-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
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-07-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
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/v3"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e79d9ef3e065f2dcb6bd1db51e29c62a99dff5cb/specification/batch/resource-manager/Microsoft.Batch/stable/2024-07-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
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-07-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
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.Resources;
using Azure.ResourceManager.Batch;
// Generated from example definition: specification/batch/resource-manager/Microsoft.Batch/stable/2024-07-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
Пример ответа
{
"accountName": "sampleacct",
"primary": "AAAA==",
"secondary": "BBBB=="
}
Определения
AccountKeyType
Перечисление
Тип ключа учетной записи для повторного создания.
Значение |
Описание |
Primary
|
Ключ первичной учетной записи.
|
Secondary
|
Ключ вторичной учетной записи.
|
BatchAccountKeys
Object
Набор ключей учетной записи пакетной службы Azure.
Имя |
Тип |
Описание |
accountName
|
string
|
Имя учетной записи пакетной службы.
|
primary
|
string
|
Первичный ключ, связанный с учетной записью.
|
secondary
|
string
|
Вторичный ключ, связанный с учетной записью.
|
BatchAccountRegenerateKeyParameters
Object
Параметры, предоставленные операции "Повторное создание ключей".
Имя |
Тип |
Описание |
keyName
|
AccountKeyType
|
Тип ключа учетной записи для повторного создания.
|
CloudError
Object
Ответ на ошибку из пакетной службы.
CloudErrorBody
Object
Ответ на ошибку из пакетной службы.
Имя |
Тип |
Описание |
code
|
string
|
Идентификатор ошибки. Коды являются инвариантными и предназначены для программного использования.
|
details
|
CloudErrorBody[]
|
Список дополнительных сведений об ошибке.
|
message
|
string
|
Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе.
|
target
|
string
|
Целевой объект конкретной ошибки. Например, имя свойства в ошибке.
|