Workflows - Regenerate Access Key

Serviço:

App Service

Versão da API:

2023-12-01

Regenera a chave de acesso do URL de chamada de retorno para os acionadores de pedidos.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/regenerateAccessKey?api-version=2023-12-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
name	path	True	string	Nome do site.
resourceGroupName	path	True	string	Nome do grupo de recursos ao qual o recurso pertence. Padrão Regex: ^[-\w\._\(\)]+[^\.]$
subscriptionId	path	True	string	O seu ID de subscrição do Azure. Esta é uma cadeia formatada por GUID (por exemplo, 0000000000-0000-0000-0000-00000000000000).
workflowName	path	True	string	O nome do fluxo de trabalho.
api-version	query	True	string	Versão da API

Corpo do Pedido

Name	Tipo	Description
keyType	KeyType	O tipo de chave.

Respostas

Name	Tipo	Description
200 OK		OK
Other Status Codes	ErrorResponse	Resposta de erro que descreve a razão pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

Regenerate the callback URL access key for request triggers

Pedido de amostra

HTTP

POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Web/sites/test-name/hostruntime/runtime/webhooks/workflow/api/management/workflows/testWorkflowName/regenerateAccessKey?api-version=2023-12-01

{
  "keyType": "Primary"
}

Python

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python workflows_regenerate_access_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 = WebSiteManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
    )

    client.workflows.regenerate_access_key(
        resource_group_name="testResourceGroup",
        name="test-name",
        workflow_name="testWorkflowName",
        key_type={"keyType": "Primary"},
    )


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/Workflows_RegenerateAccessKey.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 armappservice_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/appservice/armappservice/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/de1f3772629b6f4d3ac01548a5f6d719bfb97c9e/specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/Workflows_RegenerateAccessKey.json
func ExampleWorkflowsClient_RegenerateAccessKey() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewWorkflowsClient().RegenerateAccessKey(ctx, "testResourceGroup", "test-name", "testWorkflowName", armappservice.RegenerateActionParameter{
		KeyType: to.Ptr(armappservice.KeyTypePrimary),
	}, 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 { WebSiteManagementClient } = require("@azure/arm-appservice");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Regenerates the callback URL access key for request triggers.
 *
 * @summary Regenerates the callback URL access key for request triggers.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/Workflows_RegenerateAccessKey.json
 */
async function regenerateTheCallbackUrlAccessKeyForRequestTriggers() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "testResourceGroup";
  const name = "test-name";
  const workflowName = "testWorkflowName";
  const keyType = { keyType: "Primary" };
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.workflows.regenerateAccessKey(
    resourceGroupName,
    name,
    workflowName,
    keyType,
  );
  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

Resposta da amostra

Código de estado:

200

Definições

Name	Description
ErrorProperties	As propriedades do erro indicam o motivo pelo qual o serviço Logic não conseguiu processar o pedido recebido. O motivo é fornecido na mensagem de erro.
ErrorResponse	A resposta a erros indica que o Serviço de lógica não consegue processar o pedido recebido. A propriedade de erro contém os detalhes do erro.
KeyType	O tipo de chave.
RegenerateActionParameter	A chave de acesso regenera o conteúdo de ação.

ErrorProperties

As propriedades do erro indicam o motivo pelo qual o serviço Logic não conseguiu processar o pedido recebido. O motivo é fornecido na mensagem de erro.

Name	Tipo	Description
code	string	Código de erro.
message	string	Mensagem de erro a indicar por que motivo a operação falhou.

ErrorResponse

A resposta a erros indica que o Serviço de lógica não consegue processar o pedido recebido. A propriedade de erro contém os detalhes do erro.

Name	Tipo	Description
error	ErrorProperties	As propriedades do erro.

KeyType

O tipo de chave.

Name	Tipo	Description
NotSpecified	string
Primary	string
Secondary	string

RegenerateActionParameter

A chave de acesso regenera o conteúdo de ação.

Name	Tipo	Description
keyType	KeyType	O tipo de chave.