Microsoft.ApiManagement service/identityProviders 2023-09-01-preview

  • [アーティクル]

Bicep リソース定義

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

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

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

リソースの形式

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

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

プロパティ値

service/identityProviders

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

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

文字制限: 1 ~ 80

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

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

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

IdentityProviderCreateContractPropertiesOrIdentityPr...

名前 形容 価値
allowedTenants Azure Active Directory ログインの構成時に許可されるテナントの一覧。 string[]

制約：
最大長 = 32
権限 AAD または AAD B2C の OpenID Connect 検出エンドポイントのホスト名。 糸
clientId 外部 ID プロバイダー内のアプリケーションのクライアント ID。 Facebook ログインのアプリ ID、Google ログインのクライアント ID、Microsoft のアプリ ID です。 string (必須)

制約：
最小長 = 1
clientLibrary 開発者ポータルで使用するクライアント ライブラリ。 AAD および AAD B2C ID プロバイダーにのみ適用されます。 糸

制約：
最大長 = 16
clientSecret 外部 ID プロバイダー内のアプリケーションのクライアント シークレット。ログイン要求の認証に使用されます。 たとえば、Facebook ログイン用のアプリ シークレット、Google ログイン用の API キー、Microsoft の公開キーなどです。 このプロパティは'GET' 操作では入力されません。 値を取得するには、'/listSecrets' POST 要求を使用します。 string (必須)

制約：
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。
passwordResetPolicyName パスワード リセット ポリシー名。 AAD B2C ID プロバイダーにのみ適用されます。 糸

制約：
最小長 = 1
profileEditingPolicyName プロファイル編集ポリシー名。 AAD B2C ID プロバイダーにのみ適用されます。 糸

制約：
最小長 = 1
signinPolicyName サインイン ポリシー名。 AAD B2C ID プロバイダーにのみ適用されます。 糸

制約：
最小長 = 1
signinTenant Active Directory にログインするときに Common の代わりに使用する TenantId 糸
signupPolicyName サインアップ ポリシー名。 AAD B2C ID プロバイダーにのみ適用されます。 糸

制約：
最小長 = 1
種類 ID プロバイダーの種類識別子。 'aad'
'aadB2C'
'facebook'
'google'
'microsoft'
'twitter'

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

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

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

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

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

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

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

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

リソースの形式

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

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

プロパティ値

service/identityProviders

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

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

文字制限: 1 ~ 80

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

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

IdentityProviderCreateContractPropertiesOrIdentityPr...

名前 形容 価値
allowedTenants Azure Active Directory ログインの構成時に許可されるテナントの一覧。 string[]

制約：
最大長 = 32
権限 AAD または AAD B2C の OpenID Connect 検出エンドポイントのホスト名。 糸
clientId 外部 ID プロバイダー内のアプリケーションのクライアント ID。 Facebook ログインのアプリ ID、Google ログインのクライアント ID、Microsoft のアプリ ID です。 string (必須)

制約：
最小長 = 1
clientLibrary 開発者ポータルで使用するクライアント ライブラリ。 AAD および AAD B2C ID プロバイダーにのみ適用されます。 糸

制約：
最大長 = 16
clientSecret 外部 ID プロバイダー内のアプリケーションのクライアント シークレット。ログイン要求の認証に使用されます。 たとえば、Facebook ログイン用のアプリ シークレット、Google ログイン用の API キー、Microsoft の公開キーなどです。 このプロパティは'GET' 操作では入力されません。 値を取得するには、'/listSecrets' POST 要求を使用します。 string (必須)

制約：
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。
passwordResetPolicyName パスワード リセット ポリシー名。 AAD B2C ID プロバイダーにのみ適用されます。 糸

制約：
最小長 = 1
profileEditingPolicyName プロファイル編集ポリシー名。 AAD B2C ID プロバイダーにのみ適用されます。 糸

制約：
最小長 = 1
signinPolicyName サインイン ポリシー名。 AAD B2C ID プロバイダーにのみ適用されます。 糸

制約：
最小長 = 1
signinTenant Active Directory にログインするときに Common の代わりに使用する TenantId 糸
signupPolicyName サインアップ ポリシー名。 AAD B2C ID プロバイダーにのみ適用されます。 糸

制約：
最小長 = 1
種類 ID プロバイダーの種類識別子。 'aad'
'aadB2C'
'facebook'
'google'
'microsoft'
'twitter'

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

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

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

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

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

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

  • リソース グループの

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

リソースの形式

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

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

プロパティ値

service/identityProviders

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

文字制限: 1 ~ 80

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

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

IdentityProviderCreateContractPropertiesOrIdentityPr...

名前 形容 価値
allowedTenants Azure Active Directory ログインの構成時に許可されるテナントの一覧。 string[]

制約：
最大長 = 32
権限 AAD または AAD B2C の OpenID Connect 検出エンドポイントのホスト名。 糸
clientId 外部 ID プロバイダー内のアプリケーションのクライアント ID。 Facebook ログインのアプリ ID、Google ログインのクライアント ID、Microsoft のアプリ ID です。 string (必須)

制約：
最小長 = 1
clientLibrary 開発者ポータルで使用するクライアント ライブラリ。 AAD および AAD B2C ID プロバイダーにのみ適用されます。 糸

制約：
最大長 = 16
clientSecret 外部 ID プロバイダー内のアプリケーションのクライアント シークレット。ログイン要求の認証に使用されます。 たとえば、Facebook ログイン用のアプリ シークレット、Google ログイン用の API キー、Microsoft の公開キーなどです。 このプロパティは'GET' 操作では入力されません。 値を取得するには、'/listSecrets' POST 要求を使用します。 string (必須)

制約：
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。
passwordResetPolicyName パスワード リセット ポリシー名。 AAD B2C ID プロバイダーにのみ適用されます。 糸

制約：
最小長 = 1
profileEditingPolicyName プロファイル編集ポリシー名。 AAD B2C ID プロバイダーにのみ適用されます。 糸

制約：
最小長 = 1
signinPolicyName サインイン ポリシー名。 AAD B2C ID プロバイダーにのみ適用されます。 糸

制約：
最小長 = 1
signinTenant Active Directory にログインするときに Common の代わりに使用する TenantId 糸
signupPolicyName サインアップ ポリシー名。 AAD B2C ID プロバイダーにのみ適用されます。 糸

制約：
最小長 = 1
種類 ID プロバイダーの種類識別子。 "aad"
"aadB2C"
"facebook"
"google"
"microsoft"
"twitter"