Integration Runtimes - Regenerate Auth Key

Servicio:

Purview

Versión de la API:

2023-09-01

Regenera la clave de autenticación de un entorno de ejecución de integración.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string (url)	Punto de conexión de examen de la cuenta de purview. Ejemplo: https://{accountName}.purview.azure.com.
integrationRuntimeName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	Nombre del entorno de ejecución de integración.
api-version	query	True	string	Versión de api que se va a usar.

Cuerpo de la solicitud

Nombre	Tipo	Description
keyName	IntegrationRuntimeAuthKeyName	Nombre de la clave de autenticación que se va a regenerar.

Respuestas

Nombre	Tipo	Description
200 OK	IntegrationRuntimeAuthKeys	Éxito.
Other Status Codes	ErrorResponseModel	Respuesta de error recibida del servicio de examen. Encabezados x-ms-error-code: string

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

IntegrationRuntimes_RegenerateAuthKey

Solicitud de ejemplo

HTTP

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

{
  "keyName": "test-key"
}

Respuesta de muestra

status code:

200

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

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

Definiciones

Nombre	Description
ErrorModel	Modelo de error.
ErrorResponseModel	Modelo de respuesta de error.
IntegrationRuntimeAuthKeyName	Nombre de la clave de autenticación que se va a regenerar.
IntegrationRuntimeAuthKeys	Claves de autenticación de Integration Runtime.
IntegrationRuntimeRegenerateKeyParameters	Parámetros para regenerar la clave de autenticación.

ErrorModel

Object

Modelo de error.

Nombre	Tipo	Description
code	string	Código de error único que identifica el error específico.
details	ErrorModel[]	Matriz de objetos ErrorModel anidados que proporciona detalles de error adicionales.
message	string	Mensaje de error legible que proporciona más detalles sobre el error.
target	string	Componente específico al que está asociado el error.

ErrorResponseModel

Object

Modelo de respuesta de error.

Nombre	Tipo	Description
error	ErrorModel	Modelo de error.

IntegrationRuntimeAuthKeyName

Enumeración

Nombre de la clave de autenticación que se va a regenerar.

Valor	Description
authKey1
authKey2

IntegrationRuntimeAuthKeys

Object

Claves de autenticación de Integration Runtime.

Nombre	Tipo	Description
authKey1	string	Clave de autenticación principal del entorno de ejecución de integración.
authKey2	string	Clave de autenticación secundaria del entorno de ejecución de integración.

IntegrationRuntimeRegenerateKeyParameters

Object

Parámetros para regenerar la clave de autenticación.

Nombre	Tipo	Description
keyName	IntegrationRuntimeAuthKeyName	Nombre de la clave de autenticación que se va a regenerar.