Microsoft. ApiManagement Service/identityProviders 2021-08-01

Bicep-resursdefinition

Resurstypen service/identityProviders kan distribueras till:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Skapa en Microsoft. ApiManagement/service/identityProviders-resursen lägger du till följande Bicep i mallen.

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'
  }
}

Egenskapsvärden

service/identityProviders

Name Beskrivning Värde
name Resursnamnet

Se hur du anger namn och typer för underordnade resurser i Bicep.
sträng (krävs)

Teckengräns: 1–80

Giltiga tecken:
Alfanumeriska tecken och bindestreck.

Börja med bokstav och slut med alfanumeriskt.
parent I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen.

Mer information finns i Underordnad resurs utanför överordnad resurs.
Symboliskt namn för resurs av typen: tjänst
properties Egenskaper för identitetsproviderkontrakt. IdentityProviderCreateContractPropertiesOrIdentityPr...

IdentityProviderCreateContractPropertiesOrIdentityPr...

Name Beskrivning Värde
allowedTenants Lista över tillåtna klientorganisationer när du konfigurerar Azure Active Directory-inloggning. string[]
Myndigheten OpenID Connect-värdnamnet för identifieringsslutpunkten för AAD eller AAD B2C. sträng
ClientID Klient-ID för programmet i den externa identitetsprovidern. Det är app-ID för Facebook-inloggning, klient-ID för Google-inloggning, app-ID för Microsoft. sträng (krävs)
clientSecret Klienthemlighet för programmet i den externa identitetsprovidern som används för att autentisera inloggningsbegäran. Det är till exempel apphemlighet för Facebook-inloggning, API-nyckel för Google-inloggning, offentlig nyckel för Microsoft. Den här egenskapen fylls inte i vid GET-åtgärder! Använd POST-begäran "/listSecrets" för att hämta värdet. sträng (krävs)
passwordResetPolicyName Namn på princip för lösenordsåterställning. Gäller endast för AAD B2C-identitetsprovider. sträng
profileEditingPolicyName Namn på profilredigeringsprincip. Gäller endast för AAD B2C-identitetsprovider. sträng
signinPolicyName Namn på inloggningsprincip. Gäller endast för AAD B2C-identitetsprovider. sträng
signinTenant TenantId som ska användas i stället för Vanligt när du loggar in på Active Directory sträng
signupPolicyName Namn på registreringsprincip. Gäller endast för AAD B2C-identitetsprovider. sträng
typ Typidentifierare för identitetsprovider. "aad"
"aadB2C"
"facebook"
"google"
"microsoft"
"twitter"

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall Description
Skapa en API Management-instans och alla underresurser med hjälp av mallen

Distribuera till Azure
Den här mallen visar hur du skapar en API Management-tjänst och konfigurerar underentiteter

Resursdefinition för ARM-mall

Resurstypen service/identityProviders kan distribueras till:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Skapa en Microsoft. ApiManagement/service/identityProviders-resursen lägger du till följande JSON i mallen.

{
  "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"
  }
}

Egenskapsvärden

service/identityProviders

Name Beskrivning Värde
typ Resurstypen "Microsoft. ApiManagement/service/identityProviders
apiVersion Resurs-API-versionen '2021-08-01'
name Resursnamnet

Se hur du anger namn och typer för underordnade resurser i JSON ARM-mallar.
sträng (krävs)

Teckengräns: 1–80

Giltiga tecken:
Alfanumeriska tecken och bindestreck.

Börja med bokstav och slut med alfanumeriskt.
properties Egenskaper för identitetsproviderkontrakt. IdentityProviderCreateContractPropertiesOrIdentityPr...

IdentityProviderCreateContractPropertiesOrIdentityPr...

Name Beskrivning Värde
allowedTenants Lista över tillåtna klientorganisationer när du konfigurerar Azure Active Directory-inloggning. string[]
Myndigheten OpenID Connect-värdnamnet för identifieringsslutpunkten för AAD eller AAD B2C. sträng
ClientID Klient-ID för programmet i den externa identitetsprovidern. Det är app-ID för Facebook-inloggning, klient-ID för Google-inloggning, app-ID för Microsoft. sträng (krävs)
clientSecret Klienthemlighet för programmet i den externa identitetsprovidern som används för att autentisera inloggningsbegäran. Det är till exempel apphemlighet för Facebook-inloggning, API-nyckel för Google-inloggning, offentlig nyckel för Microsoft. Den här egenskapen fylls inte i vid GET-åtgärder! Använd POST-begäran "/listSecrets" för att hämta värdet. sträng (krävs)
passwordResetPolicyName Namn på princip för lösenordsåterställning. Gäller endast för AAD B2C-identitetsprovider. sträng
profileEditingPolicyName Namn på profilredigeringsprincip. Gäller endast för AAD B2C-identitetsprovider. sträng
signinPolicyName Namn på inloggningsprincip. Gäller endast för AAD B2C-identitetsprovider. sträng
signinTenant TenantId som ska användas i stället för Vanligt när du loggar in på Active Directory sträng
signupPolicyName Namn på registreringsprincip. Gäller endast för AAD B2C-identitetsprovider. sträng
typ Typidentifierare för identitetsprovider. "aad"
"aadB2C"
"facebook"
"google"
"microsoft"
"twitter"

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall Description
Skapa en API Management-instans och alla underresurser med hjälp av mallen

Distribuera till Azure
Den här mallen visar hur du skapar en API Management-tjänst och konfigurerar underentiteter

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen service/identityProviders kan distribueras till:

  • Resursgrupper

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Skapa en Microsoft. ApiManagement/service/identityProviders-resursen lägger du till följande Terraform i mallen.

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"
    }
  })
}

Egenskapsvärden

service/identityProviders

Name Beskrivning Värde
typ Resurstypen "Microsoft. ApiManagement/service/identityProviders@2021-08-01"
name Resursnamnet sträng (krävs)

Teckengräns: 1–80

Giltiga tecken:
Alfanumeriska tecken och bindestreck.

Börja med bokstav och slut med alfanumeriskt.
parent_id ID för resursen som är överordnad för den här resursen. ID för resurs av typen: tjänst
properties Egenskaper för identitetsproviderkontrakt. IdentityProviderCreateContractPropertiesOrIdentityPr...

IdentityProviderCreateContractPropertiesOrIdentityPr...

Name Beskrivning Värde
allowedTenants Lista över tillåtna klientorganisationer när du konfigurerar Azure Active Directory-inloggning. string[]
Myndigheten OpenID Connect-värdnamnet för identifieringsslutpunkten för AAD eller AAD B2C. sträng
ClientID Klient-ID för programmet i den externa identitetsprovidern. Det är app-ID för Facebook-inloggning, klient-ID för Google-inloggning, app-ID för Microsoft. sträng (krävs)
clientSecret Klienthemlighet för programmet i den externa identitetsprovidern som används för att autentisera inloggningsbegäran. Det är till exempel apphemlighet för Facebook-inloggning, API-nyckel för Google-inloggning, offentlig nyckel för Microsoft. Den här egenskapen fylls inte i vid GET-åtgärder! Använd POST-begäran "/listSecrets" för att hämta värdet. sträng (krävs)
passwordResetPolicyName Namn på princip för lösenordsåterställning. Gäller endast för AAD B2C-identitetsprovider. sträng
profileEditingPolicyName Namn på profilredigeringsprincip. Gäller endast för AAD B2C-identitetsprovider. sträng
signinPolicyName Namn på inloggningsprincip. Gäller endast för AAD B2C-identitetsprovider. sträng
signinTenant TenantId som ska användas i stället för Vanligt när du loggar in på Active Directory sträng
signupPolicyName Namn på registreringsprincip. Gäller endast för AAD B2C-identitetsprovider. sträng
typ Typidentifierare för identitetsprovider. "aad"
"aadB2C"
"facebook"
"google"
"microsoft"
"twitter"