次の方法で共有

Microsoft.ApiManagement サービス/openidConnectProviders 2023-09-01-preview

  • [アーティクル]

Bicep リソース定義

service/openidConnectProviders リソースの種類は、次を対象とする操作と共にデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.ApiManagement/service/openidConnectProviders リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.ApiManagement/service/openidConnectProviders@2023-09-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    clientId: 'string'
    clientSecret: 'string'
    description: 'string'
    displayName: 'string'
    metadataEndpoint: 'string'
    useInApiDocumentation: bool
    useInTestConsole: bool
  }
}

プロパティ値

service/openidConnectProviders

名前 形容 価値
名前 リソース名

Bicepで子リソースの名前と種類 設定する方法を参照してください。		 string (必須)

文字制限: 1 ~ 80

有効な文字:
英数字とハイフン。

文字で始まり、英数字で終わる。
親 Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「親リソースの外部 子リソース」を参照してください。		 種類のリソースのシンボリック名: サービス
プロパティ OpenId Connect プロバイダー のコントラクト プロパティ。 OpenidConnectProviderContractProperties

OpenidConnectProviderContractProperties

名前 形容 価値
clientId クライアント アプリケーションである開発者コンソールのクライアント ID。 string (必須)
clientSecret クライアント アプリケーションである開発者コンソールのクライアント シークレット。 糸

制約：
機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。
形容 OpenID Connect プロバイダーのわかりやすい説明。 糸
displayName わかりやすい OpenID Connect プロバイダー名。 string (必須)

制約：
最大長 = 50
metadataEndpoint メタデータ エンドポイント URI。 string (必須)
useInApiDocumentation true の場合、開発者ポータルの API ドキュメントで Open ID Connect プロバイダーが使用されます。 値が指定されていない場合、既定では False。 bool
useInTestConsole true の場合、開発者ポータルのテスト コンソールで Open ID Connect プロバイダーを使用できます。 値が指定されていない場合は、既定で True です。 bool

クイック スタート テンプレート

次のクイック スタート テンプレートでは、このリソースの種類をデプロイします。

テンプレート 形容
テンプレート を使用して API Management インスタンスとすべてのサブリソースを作成する

Azure にデプロイする 		このテンプレートでは、API Management サービスを作成し、サブエンティティを構成する方法を示します

ARM テンプレート リソース定義

service/openidConnectProviders リソースの種類は、次を対象とする操作と共にデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.ApiManagement/service/openidConnectProviders リソースを作成するには、テンプレートに次の JSON を追加します。

{
  "type": "Microsoft.ApiManagement/service/openidConnectProviders",
  "apiVersion": "2023-09-01-preview",
  "name": "string",
  "properties": {
    "clientId": "string",
    "clientSecret": "string",
    "description": "string",
    "displayName": "string",
    "metadataEndpoint": "string",
    "useInApiDocumentation": "bool",
    "useInTestConsole": "bool"
  }
}

プロパティ値

service/openidConnectProviders

名前 形容 価値
種類 リソースの種類 'Microsoft.ApiManagement/service/openidConnectProviders'
apiVersion リソース API のバージョン '2023-09-01-preview'
名前 リソース名

JSON ARM テンプレートで子リソースの名前と型 設定する方法を参照してください。		 string (必須)

文字制限: 1 ~ 80

有効な文字:
英数字とハイフン。

文字で始まり、英数字で終わる。
プロパティ OpenId Connect プロバイダー のコントラクト プロパティ。 OpenidConnectProviderContractProperties

OpenidConnectProviderContractProperties

名前 形容 価値
clientId クライアント アプリケーションである開発者コンソールのクライアント ID。 string (必須)
clientSecret クライアント アプリケーションである開発者コンソールのクライアント シークレット。 糸

制約：
機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。
形容 OpenID Connect プロバイダーのわかりやすい説明。 糸
displayName わかりやすい OpenID Connect プロバイダー名。 string (必須)

制約：
最大長 = 50
metadataEndpoint メタデータ エンドポイント URI。 string (必須)
useInApiDocumentation true の場合、開発者ポータルの API ドキュメントで Open ID Connect プロバイダーが使用されます。 値が指定されていない場合、既定では False。 bool
useInTestConsole true の場合、開発者ポータルのテスト コンソールで Open ID Connect プロバイダーを使用できます。 値が指定されていない場合は、既定で True です。 bool

クイック スタート テンプレート

次のクイック スタート テンプレートでは、このリソースの種類をデプロイします。

テンプレート 形容
テンプレート を使用して API Management インスタンスとすべてのサブリソースを作成する

Azure にデプロイする 		このテンプレートでは、API Management サービスを作成し、サブエンティティを構成する方法を示します

Terraform (AzAPI プロバイダー) リソース定義

service/openidConnectProviders リソースの種類は、次を対象とする操作と共にデプロイできます。

  • リソース グループの

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.ApiManagement/service/openidConnectProviders リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/openidConnectProviders@2023-09-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      clientId = "string"
      clientSecret = "string"
      description = "string"
      displayName = "string"
      metadataEndpoint = "string"
      useInApiDocumentation = bool
      useInTestConsole = bool
    }
  })
}

プロパティ値

service/openidConnectProviders

名前 形容 価値
種類 リソースの種類 "Microsoft.ApiManagement/service/openidConnectProviders@2023-09-01-preview"
名前 リソース名 string (必須)

文字制限: 1 ~ 80

有効な文字:
英数字とハイフン。

文字で始まり、英数字で終わる。
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: サービス
プロパティ OpenId Connect プロバイダー のコントラクト プロパティ。 OpenidConnectProviderContractProperties

OpenidConnectProviderContractProperties

名前 形容 価値
clientId クライアント アプリケーションである開発者コンソールのクライアント ID。 string (必須)
clientSecret クライアント アプリケーションである開発者コンソールのクライアント シークレット。 糸

制約：
機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。
形容 OpenID Connect プロバイダーのわかりやすい説明。 糸
displayName わかりやすい OpenID Connect プロバイダー名。 string (必須)

制約：
最大長 = 50
metadataEndpoint メタデータ エンドポイント URI。 string (必須)
useInApiDocumentation true の場合、開発者ポータルの API ドキュメントで Open ID Connect プロバイダーが使用されます。 値が指定されていない場合、既定では False。 bool
useInTestConsole true の場合、開発者ポータルのテスト コンソールで Open ID Connect プロバイダーを使用できます。 値が指定されていない場合は、既定で True です。 bool