次の方法で共有

Microsoft.ApiManagement サービス/authorizationProviders

  • [アーティクル]

Bicep リソース定義

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

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

リソース形式

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

resource symbolicname 'Microsoft.ApiManagement/service/authorizationProviders@2023-05-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    displayName: 'string'
    identityProvider: 'string'
    oauth2: {
      grantTypes: {
        authorizationCode: {
          {customized property}: 'string'
        }
        clientCredentials: {
          {customized property}: 'string'
        }
      }
      redirectUrl: 'string'
    }
  }
}

プロパティ値

service/authorizationProviders

名前 説明 値
name リソース名

Bicep で子リソースの名前と型を設定する方法を参照してください。		 string (必須)
parent Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「 親リソースの外部の子リソース」を参照してください。		 種類のリソースのシンボル名: service
properties 承認プロバイダー コントラクトのプロパティ。 AuthorizationProviderContractProperties

AuthorizationProviderContractProperties

名前 説明 値
displayName 承認プロバイダー名。 長さは 1 ~ 300 文字にする必要があります。 string
identityProvider ID プロバイダー名。 長さは 1 ~ 300 文字にする必要があります。 string
oauth2 OAuth2 の設定 AuthorizationProviderOAuth2Settings

AuthorizationProviderOAuth2Settings

名前 説明 値
grantTypes OAuth2 の設定 AuthorizationProviderOAuth2GrantTypes
redirectUrl OAuth アプリケーションで設定するリダイレクト URL。 string

AuthorizationProviderOAuth2GrantTypes

名前 説明 値
authorizationCode OAuth2 承認コードの許可パラメーター AuthorizationProviderOAuth2GrantTypesAuthorizationCo...
clientCredentials OAuth2 クライアント資格情報の付与パラメーター AuthorizationProviderOAuth2GrantTypesClientCredentia...

AuthorizationProviderOAuth2GrantTypesAuthorizationCo...

名前 説明 値
{カスタマイズされたプロパティ} string

AuthorizationProviderOAuth2GrantTypesClientCredentia...

名前 説明 値
{カスタマイズされたプロパティ} string

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

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

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

リソース形式

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

{
  "type": "Microsoft.ApiManagement/service/authorizationProviders",
  "apiVersion": "2023-05-01-preview",
  "name": "string",
  "properties": {
    "displayName": "string",
    "identityProvider": "string",
    "oauth2": {
      "grantTypes": {
        "authorizationCode": {
          "{customized property}": "string"
        },
        "clientCredentials": {
          "{customized property}": "string"
        }
      },
      "redirectUrl": "string"
    }
  }
}

プロパティ値

service/authorizationProviders

名前 説明 値
type リソースの種類 'Microsoft.ApiManagement/service/authorizationProviders'
apiVersion リソース API のバージョン '2023-05-01-preview'
name リソース名

JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。		 string (必須)
properties 承認プロバイダー コントラクトのプロパティ。 AuthorizationProviderContractProperties

AuthorizationProviderContractProperties

名前 説明 値
displayName 承認プロバイダー名。 長さは 1 ~ 300 文字にする必要があります。 string
identityProvider ID プロバイダー名。 長さは 1 ~ 300 文字にする必要があります。 string
oauth2 OAuth2 の設定 AuthorizationProviderOAuth2Settings

AuthorizationProviderOAuth2Settings

名前 説明 値
grantTypes OAuth2 の設定 AuthorizationProviderOAuth2GrantTypes
redirectUrl OAuth アプリケーションで設定するリダイレクト URL。 string

AuthorizationProviderOAuth2GrantTypes

名前 説明 値
authorizationCode OAuth2 承認コードの許可パラメーター AuthorizationProviderOAuth2GrantTypesAuthorizationCo...
clientCredentials OAuth2 クライアント資格情報の付与パラメーター AuthorizationProviderOAuth2GrantTypesClientCredentia...

AuthorizationProviderOAuth2GrantTypesAuthorizationCo...

名前 説明 値
{カスタマイズされたプロパティ} string

AuthorizationProviderOAuth2GrantTypesClientCredentia...

名前 説明 値
{カスタマイズされたプロパティ} string

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

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

  • リソース グループ

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

リソース形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/authorizationProviders@2023-05-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      displayName = "string"
      identityProvider = "string"
      oauth2 = {
        grantTypes = {
          authorizationCode = {
            {customized property} = "string"
          }
          clientCredentials = {
            {customized property} = "string"
          }
        }
        redirectUrl = "string"
      }
    }
  })
}

プロパティ値

service/authorizationProviders

名前 説明 値
type リソースの種類 "Microsoft.ApiManagement/service/authorizationProviders@2023-05-01-preview"
name リソース名 string (必須)
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: サービス
properties 承認プロバイダー コントラクトのプロパティ。 AuthorizationProviderContractProperties

AuthorizationProviderContractProperties

名前 説明 値
displayName 承認プロバイダー名。 長さは 1 ~ 300 文字にする必要があります。 string
identityProvider ID プロバイダー名。 長さは 1 ~ 300 文字にする必要があります。 string
oauth2 OAuth2 の設定 AuthorizationProviderOAuth2Settings

AuthorizationProviderOAuth2Settings

名前 説明 値
grantTypes OAuth2 の設定 AuthorizationProviderOAuth2GrantTypes
redirectUrl OAuth アプリケーションで設定するリダイレクト URL。 string

AuthorizationProviderOAuth2GrantTypes

名前 説明 値
authorizationCode OAuth2 承認コード付与パラメーター AuthorizationProviderOAuth2GrantTypesAuthorizationCo...
clientCredentials OAuth2 クライアント資格情報付与パラメーター AuthorizationProviderOAuth2GrantTypesClientCredentia...

AuthorizationProviderOAuth2GrantTypesAuthorizationCo...

名前 説明 値
{カスタマイズされたプロパティ} string

AuthorizationProviderOAuth2GrantTypesClientCredentia...

名前 説明 値
{カスタマイズされたプロパティ} string