Microsoft.ApiManagement サービス/identityProviders 2021-08-01

  • [アーティクル]

Bicep リソース定義

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

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

リソース形式

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

resource symbolicname 'Microsoft.ApiManagement/service/identityProviders@2021-08-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    allowedTenants: [
      'string'
    ]
    authority: 'string'
    clientId: 'string'
    clientSecret: 'string'
    passwordResetPolicyName: 'string'
    profileEditingPolicyName: 'string'
    signinPolicyName: 'string'
    signinTenant: 'string'
    signupPolicyName: 'string'
    type: 'string'
  }
}

プロパティ値

service/identityProviders

名前 説明 値
name リソース名

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

文字数制限: 1 から 80

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

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

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

IdentityProviderCreateContractPropertiesOrIdentityPr...

名前 説明 値
allowedTenants Azure Active Directory ログインを構成するときに許可されるテナントの一覧。 string[]
authority AAD または AAD B2C の OpenID Connect 検出エンドポイントホスト名。 string
clientId 外部 ID プロバイダー内のアプリケーションのクライアント ID。 これは、Facebook ログインのアプリ ID、Google ログインのクライアント ID、Microsoft のアプリ ID です。 string (必須)
clientSecret ログイン要求の認証に使用される、外部 ID プロバイダー内のアプリケーションのクライアント シークレット。 たとえば、Facebook ログインのアプリ シークレット、Google ログイン用 API キー、Microsoft の公開キーなどです。 このプロパティは 'GET' 操作では入力されません。 値を取得するには、'/listSecrets' POST 要求を使用します。 string (必須)
passwordResetPolicyName パスワード リセット ポリシー名。 AAD B2C ID プロバイダーにのみ適用されます。 string
profileEditingPolicyName プロファイル編集ポリシー名。 AAD B2C ID プロバイダーにのみ適用されます。 string
signinPolicyName サインイン ポリシー名。 AAD B2C ID プロバイダーにのみ適用されます。 string
signinTenant Active Directory にログインするときに Common ではなく使用する TenantId string
signupPolicyName サインアップ ポリシー名。 AAD B2C ID プロバイダーにのみ適用されます。 string
type ID プロバイダーの種類識別子。 'aad'
'aadB2C'
'facebook'
'google'
'microsoft'
'twitter'

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

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

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

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

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

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

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

リソース形式

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

{
  "type": "Microsoft.ApiManagement/service/identityProviders",
  "apiVersion": "2021-08-01",
  "name": "string",
  "properties": {
    "allowedTenants": [ "string" ],
    "authority": "string",
    "clientId": "string",
    "clientSecret": "string",
    "passwordResetPolicyName": "string",
    "profileEditingPolicyName": "string",
    "signinPolicyName": "string",
    "signinTenant": "string",
    "signupPolicyName": "string",
    "type": "string"
  }
}

プロパティ値

service/identityProviders

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

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

文字制限: 1 から 80

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

先頭は文字、末尾は英数字にします。
properties ID プロバイダーのコントラクト プロパティ。 IdentityProviderCreateContractPropertiesOrIdentityPr...

IdentityProviderCreateContractPropertiesOrIdentityPr...

名前 説明 値
allowedTenants Azure Active Directory ログインを構成するときの許可されるテナントの一覧。 string[]
authority AAD または AAD B2C の OpenID Connect 検出エンドポイントのホスト名。 string
clientId 外部 ID プロバイダー内のアプリケーションのクライアント ID。 これは、Facebook ログインのアプリ ID、Google ログインのクライアント ID、Microsoft のアプリ ID です。 string (必須)
clientSecret 外部 ID プロバイダーのアプリケーションのクライアント シークレット。ログイン要求の認証に使用されます。 たとえば、Facebook ログイン用のアプリ シークレット、Google ログイン用の API キー、Microsoft の公開キーです。 このプロパティは、'GET' 操作では入力されません。 値を取得するには、'/listSecrets' POST 要求を使用します。 string (必須)
passwordResetPolicyName パスワード リセット ポリシー名。 AAD B2C ID プロバイダーにのみ適用されます。 string
profileEditingPolicyName プロファイル編集ポリシー名。 AAD B2C ID プロバイダーにのみ適用されます。 string
signinPolicyName サインイン ポリシー名。 AAD B2C ID プロバイダーにのみ適用されます。 string
signinTenant Active Directory にログインするときに Common の代わりに使用する TenantId string
signupPolicyName サインアップ ポリシー名。 AAD B2C ID プロバイダーにのみ適用されます。 string
type ID プロバイダーの種類識別子。 'aad'
'aadB2C'
'facebook'
'google'
'microsoft'
'twitter'

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

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

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

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

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

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

  • リソース グループ

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

リソース形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/identityProviders@2021-08-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      allowedTenants = [
        "string"
      ]
      authority = "string"
      clientId = "string"
      clientSecret = "string"
      passwordResetPolicyName = "string"
      profileEditingPolicyName = "string"
      signinPolicyName = "string"
      signinTenant = "string"
      signupPolicyName = "string"
      type = "string"
    }
  })
}

プロパティ値

service/identityProviders

名前 説明 値
type リソースの種類 "Microsoft.ApiManagement/service/identityProviders@2021-08-01"
name リソース名 string (必須)

文字制限: 1 から 80

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

先頭は文字、末尾は英数字にします。
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: サービス
properties ID プロバイダーのコントラクト プロパティ。 IdentityProviderCreateContractPropertiesOrIdentityPr...

IdentityProviderCreateContractPropertiesOrIdentityPr...

名前 説明 値
allowedTenants Azure Active Directory ログインを構成するときに許可されるテナントの一覧。 string[]
authority AAD または AAD B2C の OpenID Connect 検出エンドポイントホスト名。 string
clientId 外部 ID プロバイダー内のアプリケーションのクライアント ID。 これは、Facebook ログインのアプリ ID、Google ログインのクライアント ID、Microsoft のアプリ ID です。 string (必須)
clientSecret ログイン要求の認証に使用される、外部 ID プロバイダー内のアプリケーションのクライアント シークレット。 たとえば、Facebook ログインのアプリ シークレット、Google ログイン用 API キー、Microsoft の公開キーなどです。 このプロパティは 'GET' 操作では入力されません。 値を取得するには、'/listSecrets' POST 要求を使用します。 string (必須)
passwordResetPolicyName パスワード リセット ポリシー名。 AAD B2C ID プロバイダーにのみ適用されます。 string
profileEditingPolicyName プロファイル編集ポリシー名。 AAD B2C ID プロバイダーにのみ適用されます。 string
signinPolicyName サインイン ポリシー名。 AAD B2C ID プロバイダーにのみ適用されます。 string
signinTenant Active Directory にログインするときに Common ではなく使用する TenantId string
signupPolicyName サインアップ ポリシー名。 AAD B2C ID プロバイダーにのみ適用されます。 string
type ID プロバイダーの種類識別子。 "aad"
"aadB2C"
"facebook"
"google"
"microsoft"
"twitter"