OpenId Connect Provider - Create Or Update

サービス:

API Management

API バージョン:

2024-05-01

OpenID Connect プロバイダーを作成または更新します。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/openidConnectProviders/{opid}?api-version=2024-05-01

URI パラメーター

名前	/	必須	型	説明
opid	path	True	string maxLength: 256 pattern: ^[^*#&+:<>?]+$	OpenID Connect プロバイダーの識別子。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソース グループの名前。 名前では大文字と小文字が区別されません。
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	API Management サービスの名前。
subscriptionId	path	True	string (uuid)	ターゲット サブスクリプションの ID。 値は UUID である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求ヘッダー

名前	必須	型	説明
If-Match		string	エンティティの ETag。 エンティティを作成する場合は必要ありませんが、エンティティを更新する場合は必須です。

要求本文

名前	必須	型	説明
properties.clientId	True	string	クライアント アプリケーションである開発者コンソールのクライアント ID。
properties.displayName	True	string maxLength: 50	わかりやすい OpenID Connect プロバイダー名。
properties.metadataEndpoint	True	string	メタデータ エンドポイント URI。
properties.clientSecret		string	クライアント アプリケーションである開発者コンソールのクライアント シークレット。
properties.description		string	OpenID Connect プロバイダーのわかりやすい説明。
properties.useInApiDocumentation		boolean	true の場合、開発者ポータルの API ドキュメントで Open ID Connect プロバイダーが使用されます。 値が指定されていない場合、既定では False。
properties.useInTestConsole		boolean	true の場合、開発者ポータルのテスト コンソールで Open ID Connect プロバイダーを使用できます。 値が指定されていない場合は、既定で True です。

応答

名前	型	説明
200 OK	OpenidConnectProviderContract	OpenIdConnect プロバイダーが正常に更新されました。 ヘッダー ETag: string
201 Created	OpenidConnectProviderContract	OpenIdConnect プロバイダーが正常に作成されました。 ヘッダー ETag: string
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

スコープ

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

例

ApiManagementCreateOpenIdConnectProvider

要求のサンプル

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect3?api-version=2024-05-01

{
  "properties": {
    "displayName": "templateoidprovider3",
    "metadataEndpoint": "https://oidprovider-template3.net",
    "clientId": "oidprovidertemplate3",
    "clientSecret": "x",
    "useInTestConsole": false,
    "useInApiDocumentation": true
  }
}

応答のサンプル

状態コード:

201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect3",
  "type": "Microsoft.ApiManagement/service/openidconnectproviders",
  "name": "templateOpenIdConnect3",
  "properties": {
    "displayName": "templateoidprovider3",
    "metadataEndpoint": "https://oidprovider-template3.net",
    "clientId": "oidprovidertemplate3",
    "useInTestConsole": false,
    "useInApiDocumentation": true
  }
}

状態コード:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect3",
  "type": "Microsoft.ApiManagement/service/openidconnectproviders",
  "name": "templateOpenIdConnect3",
  "properties": {
    "displayName": "templateoidprovider3",
    "metadataEndpoint": "https://oidprovider-template3.net",
    "clientId": "oidprovidertemplate3",
    "useInTestConsole": false,
    "useInApiDocumentation": true
  }
}

定義

名前	説明
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
OpenidConnectProviderContract	OpenId Connect プロバイダーの詳細。

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラー メッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラー オブジェクト。

OpenidConnectProviderContract

Object

OpenId Connect プロバイダーの詳細。

名前	型	説明
id	string	リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.clientId	string	クライアント アプリケーションである開発者コンソールのクライアント ID。
properties.clientSecret	string	クライアント アプリケーションである開発者コンソールのクライアント シークレット。
properties.description	string	OpenID Connect プロバイダーのわかりやすい説明。
properties.displayName	string maxLength: 50	わかりやすい OpenID Connect プロバイダー名。
properties.metadataEndpoint	string	メタデータ エンドポイント URI。
properties.useInApiDocumentation	boolean	true の場合、開発者ポータルの API ドキュメントで Open ID Connect プロバイダーが使用されます。 値が指定されていない場合、既定では False。
properties.useInTestConsole	boolean	true の場合、開発者ポータルのテスト コンソールで Open ID Connect プロバイダーを使用できます。 値が指定されていない場合は、既定で True です。
type	string	リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"