Subscription - Regenerate Secondary Key

Hizmet:

API Management

API Sürümü:

2022-08-01

API Management hizmet örneğinin mevcut aboneliğinin ikincil anahtarını yeniden oluşturur.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}/regenerateSecondaryKey?api-version=2022-08-01

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
resourceGroupName	path	True	string	Kaynak grubunun adı. Ad büyük/küçük harfe duyarlı değildir.
serviceName	path	True	string	API Management hizmetinin adı. Normal ifade deseni: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
sid	path	True	string	Abonelik varlığı Tanımlayıcısı. Varlık, bir kullanıcı ile API Management'deki bir ürün arasındaki ilişkiyi temsil eder. Normal ifade deseni: ^[^*#&+:<>?]+$
subscriptionId	path	True	string	Hedef aboneliğin kimliği.
api-version	query	True	string	Bu işlem için kullanılacak API sürümü.

Yanıtlar

Name	Tür	Description
204 No Content		İkincil anahtar başarıyla yeniden oluşturuldu.
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow.

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

ApiManagementSubscriptionRegenerateSecondaryKey

Örnek isteği

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/testsub/regenerateSecondaryKey?api-version=2022-08-01

Java

/** Samples for Subscription RegenerateSecondaryKey. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementSubscriptionRegenerateSecondaryKey.json
     */
    /**
     * Sample code: ApiManagementSubscriptionRegenerateSecondaryKey.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementSubscriptionRegenerateSecondaryKey(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .subscriptions()
            .regenerateSecondaryKeyWithResponse("rg1", "apimService1", "testsub", 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.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_subscription_regenerate_secondary_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 = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    client.subscription.regenerate_secondary_key(
        resource_group_name="rg1",
        service_name="apimService1",
        sid="testsub",
    )


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementSubscriptionRegenerateSecondaryKey.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 armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementSubscriptionRegenerateSecondaryKey.json
func ExampleSubscriptionClient_RegenerateSecondaryKey() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewSubscriptionClient().RegenerateSecondaryKey(ctx, "rg1", "apimService1", "testsub", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

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 { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Regenerates secondary key of existing subscription of the API Management service instance.
 *
 * @summary Regenerates secondary key of existing subscription of the API Management service instance.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementSubscriptionRegenerateSecondaryKey.json
 */
async function apiManagementSubscriptionRegenerateSecondaryKey() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const sid = "testsub";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.subscription.regenerateSecondaryKey(
    resourceGroupName,
    serviceName,
    sid
  );
  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

Örnek yanıt

Durum kodu:

204

Tanımlar

Name	Description
ErrorFieldContract	Hata Alanı sözleşmesi.
ErrorResponse	Hata Yanıtı.

ErrorFieldContract

Hata Alanı sözleşmesi.

Name	Tür	Description
code	string	Özellik düzeyi hata kodu.
message	string	Özellik düzeyi hatanın insan tarafından okunabilir gösterimi.
target	string	Özellik adı.

ErrorResponse

Hata Yanıtı.

Name	Tür	Description
error.code	string	Hizmet tanımlı hata kodu. Bu kod, yanıtta belirtilen HTTP hata kodu için bir alt durum görevi görür.
error.details	ErrorFieldContract[]	Doğrulama hatası durumunda istekte gönderilen geçersiz alanların listesi.
error.message	string	Hatanın insan tarafından okunabilen gösterimi.