次の方法で共有


Microsoft.ApiManagement サービス/authorizationProviders

Bicep リソース定義

service/authorizationProviders リソースの種類は、次をターゲットとする操作と共にデプロイできます。

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

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

リソースの形式

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

resource symbolicname 'Microsoft.ApiManagement/service/authorizationProviders@2023-09-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

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

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

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

AuthorizationProviderContractProperties

名前 形容 価値
displayName 承認プロバイダー名。 長さは 1 ~ 300 文字にする必要があります。

制約:
最小長 = 1
最大長 = 300
identityProvider ID プロバイダー名。 長さは 1 ~ 300 文字にする必要があります。
oauth2 OAuth2 の設定 AuthorizationProviderOAuth2Settings の

AuthorizationProviderOAuth2Settings

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

AuthorizationProviderOAuth2GrantTypes

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

AuthorizationProviderOAuth2GrantTypesAuthorizationCo...

名前 形容 価値
{カスタマイズされたプロパティ}

AuthorizationProviderOAuth2GrantTypesClientCredentia...

名前 形容 価値
{カスタマイズされたプロパティ}

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

service/authorizationProviders リソースの種類は、次をターゲットとする操作と共にデプロイできます。

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

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

リソースの形式

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

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

プロパティ値

service/authorizationProviders

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

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

AuthorizationProviderContractProperties

名前 形容 価値
displayName 承認プロバイダー名。 長さは 1 ~ 300 文字にする必要があります。

制約:
最小長 = 1
最大長 = 300
identityProvider ID プロバイダー名。 長さは 1 ~ 300 文字にする必要があります。
oauth2 OAuth2 の設定 AuthorizationProviderOAuth2Settings の

AuthorizationProviderOAuth2Settings

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

AuthorizationProviderOAuth2GrantTypes

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

AuthorizationProviderOAuth2GrantTypesAuthorizationCo...

名前 形容 価値
{カスタマイズされたプロパティ}

AuthorizationProviderOAuth2GrantTypesClientCredentia...

名前 形容 価値
{カスタマイズされたプロパティ}

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

service/authorizationProviders リソースの種類は、次をターゲットとする操作と共にデプロイできます。

  • リソース グループの

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

リソースの形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/authorizationProviders@2023-09-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

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

AuthorizationProviderContractProperties

名前 形容 価値
displayName 承認プロバイダー名。 長さは 1 ~ 300 文字にする必要があります。

制約:
最小長 = 1
最大長 = 300
identityProvider ID プロバイダー名。 長さは 1 ~ 300 文字にする必要があります。
oauth2 OAuth2 の設定 AuthorizationProviderOAuth2Settings の

AuthorizationProviderOAuth2Settings

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

AuthorizationProviderOAuth2GrantTypes

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

AuthorizationProviderOAuth2GrantTypesAuthorizationCo...

名前 形容 価値
{カスタマイズされたプロパティ}

AuthorizationProviderOAuth2GrantTypesClientCredentia...

名前 形容 価値
{カスタマイズされたプロパティ}