Integration Runtimes - Regenerate Auth Key

サービス:

Purview

API バージョン:

2023-09-01

統合ランタイムの認証キーを再生成します。

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

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string (url)	purview アカウントのスキャン エンドポイント。 例: https://{accountName}.purview.azure.com。
integrationRuntimeName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	統合ランタイム名。
api-version	query	True	string	使用する API バージョン。

要求本文

名前	型	説明
keyName	IntegrationRuntimeAuthKeyName	再生成する認証キーの名前。

応答

名前	型	説明
200 OK	IntegrationRuntimeAuthKeys	成功。
Other Status Codes	ErrorResponseModel	スキャン サービスから受信したエラー応答。 ヘッダー x-ms-error-code: string

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

IntegrationRuntimes_RegenerateAuthKey

要求のサンプル

HTTP

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

{
  "keyName": "test-key"
}

応答のサンプル

状態コード:

200

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

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

定義

名前	説明
ErrorModel	エラー モデル。
ErrorResponseModel	エラー応答モデル。
IntegrationRuntimeAuthKeyName	再生成する認証キーの名前。
IntegrationRuntimeAuthKeys	統合ランタイム認証キー。
IntegrationRuntimeRegenerateKeyParameters	認証キーを再生成するためのパラメーター。

ErrorModel

Object

エラー モデル。

名前	型	説明
code	string	特定のエラーを識別する一意のエラー コード。
details	ErrorModel[]	追加のエラーの詳細を提供する入れ子になった ErrorModel オブジェクトの配列。
message	string	エラーの詳細を示す、人間が判読できるエラー メッセージ。
target	string	エラーが関連付けられている特定のコンポーネント。

ErrorResponseModel

Object

エラー応答モデル。

名前	型	説明
error	ErrorModel	エラー モデル。

IntegrationRuntimeAuthKeyName

列挙

再生成する認証キーの名前。

値	説明
authKey1
authKey2

IntegrationRuntimeAuthKeys

Object

統合ランタイム認証キー。

名前	型	説明
authKey1	string	プライマリ統合ランタイム認証キー。
authKey2	string	セカンダリ統合ランタイム認証キー。

IntegrationRuntimeRegenerateKeyParameters

Object

認証キーを再生成するためのパラメーター。

名前	型	説明
keyName	IntegrationRuntimeAuthKeyName	再生成する認証キーの名前。