Integration Runtimes - Regenerate Auth Key

Serviço:

Purview

Versão da API:

2023-09-01

Regenera a chave de autenticação para um runtime de integração.

POST {endpoint}/scan/integrationruntimes/{integrationRuntimeName}:regenerateAuthKey?api-version=2023-09-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string (url)	O ponto de extremidade de verificação da sua conta do Purview. Exemplo: https://{accountName}.purview.azure.com.
integrationRuntimeName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	O nome do runtime de integração.
api-version	query	True	string	A versão da API a ser usada.

Corpo da solicitação

Nome	Tipo	Description
keyName	IntegrationRuntimeAuthKeyName	O nome da chave de autenticação a ser regenerada.

Respostas

Nome	Tipo	Description
200 OK	IntegrationRuntimeAuthKeys	Êxito.
Other Status Codes	ErrorResponseModel	Uma resposta de erro recebida do Serviço de Verificação. Cabeçalhos x-ms-error-code: string

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

IntegrationRuntimes_RegenerateAuthKey

Solicitação de exemplo

HTTP

POST {endpoint}/scan/integrationruntimes/myIntegrationRuntime:regenerateAuthKey?api-version=2023-09-01

{
  "keyName": "test-key"
}

Resposta de exemplo

Código de status:

200

x-ms-request-id: d5496da4-9c52-402f-b067-83cc9ddea888

{
  "authKey1": "authKey1",
  "authKey2": null
}

Definições

Nome	Description
ErrorModel	O modelo de erro.
ErrorResponseModel	O modelo de resposta de erro.
IntegrationRuntimeAuthKeyName	O nome da chave de autenticação a ser regenerada.
IntegrationRuntimeAuthKeys	As chaves de autenticação do integration runtime.
IntegrationRuntimeRegenerateKeyParameters	Parâmetros para regenerar a chave de autenticação.

ErrorModel

Objeto

O modelo de erro.

Nome	Tipo	Description
code	string	Um código de erro exclusivo que identifica o erro específico.
details	ErrorModel[]	Uma matriz de objetos ErrorModel aninhados que fornece detalhes adicionais de erro.
message	string	Uma mensagem de erro legível por humanos que fornece mais detalhes sobre o erro.
target	string	O componente específico ao qual o erro está associado.

ErrorResponseModel

Objeto

O modelo de resposta de erro.

Nome	Tipo	Description
error	ErrorModel	O modelo de erro.

IntegrationRuntimeAuthKeyName

Enumeração

O nome da chave de autenticação a ser regenerada.

Valor	Description
authKey1
authKey2

IntegrationRuntimeAuthKeys

Objeto

As chaves de autenticação do integration runtime.

Nome	Tipo	Description
authKey1	string	A chave de autenticação do runtime de integração primária.
authKey2	string	A chave de autenticação do runtime de integração secundária.

IntegrationRuntimeRegenerateKeyParameters

Objeto

Parâmetros para regenerar a chave de autenticação.

Nome	Tipo	Description
keyName	IntegrationRuntimeAuthKeyName	O nome da chave de autenticação a ser regenerada.