OpenId Connect Provider - List By Service

リファレンス

サービス:: API Management

API バージョン:: 2024-05-01

すべての OpenId Connect プロバイダーの一覧。

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

省略可能なパラメーターを含む:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/openidConnectProviders?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2024-05-01

URI パラメーター

名前	/	必須	型	説明
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 バージョン。
$filter	query		string	\|フィールド \|使用法 \|サポートされる演算子 \|サポートされている関数 \| \|-------------\|-------------\|-------------\|-------------\| \|name \|filter \|ge、le、eq、ne、gt、lt \|substringof、contains、startswith、endswith \| \|displayName \|filter \|ge、le、eq、ne、gt、lt \|substringof、contains、startswith、endswith \|
$skip	query		integer (int32) minimum: 0	スキップするレコードの数。
$top	query		integer (int32) minimum: 1	返されるレコードの数。

応答

名前	型	説明
200 OK	OpenIdConnectProviderCollection	すべての OpenId Connect プロバイダーの一覧。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

スコープ

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

例

ApiManagementListOpenIdConnectProviders

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect2",
      "type": "Microsoft.ApiManagement/service/openidconnectproviders",
      "name": "templateOpenIdConnect2",
      "properties": {
        "displayName": "templateoidprovider2",
        "description": "open id provider template2",
        "metadataEndpoint": "https://oidprovider-template2.net",
        "clientId": "oidprovidertemplate2",
        "useInTestConsole": false,
        "useInApiDocumentation": true
      }
    }
  ],
  "count": 1,
  "nextLink": ""
}

定義

名前	説明
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
OpenIdConnectProviderCollection	Paged OpenIdProviders リスト表現。
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	エラーオブジェクト。

OpenIdConnectProviderCollection

Object

Paged OpenIdProviders リスト表現。

名前	型	説明
count	integer (int64)	すべてのページの合計レコード数。
nextLink	string	次のページリンク (ある場合)。
value	OpenidConnectProviderContract[]	ページ値。

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"

次の方法で共有

OpenId Connect Provider - List By Service

URI パラメーター

応答

セキュリティ

azure_auth

スコープ

例

ApiManagementListOpenIdConnectProviders

要求のサンプル

応答のサンプル

定義

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

OpenIdConnectProviderCollection

OpenidConnectProviderContract

その他のリソース