Microsoft.ApiManagement service/identityProviders

• senaste
• 2023-09-01-preview
• 2022-08-01
• 2021-08-01

Bicep-resursdefinition

Resurstypen service/identityProviders kan distribueras med åtgärder som mål:

• Resursgrupper – Se resursgruppsdistributionskommandon

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

Resursformat

Om du vill skapa en Microsoft.ApiManagement/service/identityProviders-resurs lägger du till följande Bicep i mallen.

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

Egenskapsvärden

service/identityProviders

Namn	Beskrivning	Värde
Namn	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.
förälder	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 den överordnade resursen.	Symboliskt namn för resurs av typen: tjänst
Egenskaper	Egenskaper för identitetsproviderkontrakt.	IdentityProviderCreateContractPropertiesOrIdentityPr...

IdentityProviderCreateContractPropertiesOrIdentityPr...

Namn	Beskrivning	Värde
allowedTenants	Lista över tillåtna klienter när du konfigurerar Azure Active Directory-inloggning.	string[] Begränsningar: Max längd = 32
auktoritet	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) Begränsningar: Min längd = 1
clientLibrary	Klientbiblioteket som ska användas i utvecklarportalen. Gäller endast för AAD- och AAD B2C-identitetsprovider.	sträng Begränsningar: Max längd = 16
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 för GET-åtgärder! Använd POST-begäran för "/listSecrets" för att hämta värdet.	sträng (krävs) Begränsningar: Min längd = 1 Känsligt värde. Skicka in som en säker parameter.
passwordResetPolicyName	Namn på lösenordsåterställningsprincip. Gäller endast för AAD B2C-identitetsprovider.	sträng Begränsningar: Min längd = 1
profileEditingPolicyName	Namn på profilredigeringsprincip. Gäller endast för AAD B2C-identitetsprovider.	sträng Begränsningar: Min längd = 1
signinPolicyName	Namn på inloggningsprincip. Gäller endast för AAD B2C-identitetsprovider.	sträng Begränsningar: Min längd = 1
signinTenant	TenantId som ska användas i stället för Common när du loggar in på Active Directory	sträng
signupPolicyName	Namn på registreringsprincip. Gäller endast för AAD B2C-identitetsprovider.	sträng Begränsningar: Min längd = 1
typ	Identitetsproviderns typidentifierare.	"aad" "aadB2C" "facebook" "google" "microsoft" "twitter"

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall	Beskrivning
Skapa en API Management-instans och alla underresurser med hjälp av mallen	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 med åtgärder som mål:

• Resursgrupper – Se resursgruppsdistributionskommandon

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

Resursformat

Om du vill skapa en Microsoft.ApiManagement/service/identityProviders-resurs lägger du till följande JSON i mallen.

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

Egenskapsvärden

service/identityProviders

Namn	Beskrivning	Värde
typ	Resurstypen	"Microsoft.ApiManagement/service/identityProviders"
apiVersion	Resurs-API-versionen	"2023-09-01-preview"
Namn	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.
Egenskaper	Egenskaper för identitetsproviderkontrakt.	IdentityProviderCreateContractPropertiesOrIdentityPr...

IdentityProviderCreateContractPropertiesOrIdentityPr...

Namn	Beskrivning	Värde
allowedTenants	Lista över tillåtna klienter när du konfigurerar Azure Active Directory-inloggning.	string[] Begränsningar: Max längd = 32
auktoritet	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) Begränsningar: Min längd = 1
clientLibrary	Klientbiblioteket som ska användas i utvecklarportalen. Gäller endast för AAD- och AAD B2C-identitetsprovider.	sträng Begränsningar: Max längd = 16
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 för GET-åtgärder! Använd POST-begäran för "/listSecrets" för att hämta värdet.	sträng (krävs) Begränsningar: Min längd = 1 Känsligt värde. Skicka in som en säker parameter.
passwordResetPolicyName	Namn på lösenordsåterställningsprincip. Gäller endast för AAD B2C-identitetsprovider.	sträng Begränsningar: Min längd = 1
profileEditingPolicyName	Namn på profilredigeringsprincip. Gäller endast för AAD B2C-identitetsprovider.	sträng Begränsningar: Min längd = 1
signinPolicyName	Namn på inloggningsprincip. Gäller endast för AAD B2C-identitetsprovider.	sträng Begränsningar: Min längd = 1
signinTenant	TenantId som ska användas i stället för Common när du loggar in på Active Directory	sträng
signupPolicyName	Namn på registreringsprincip. Gäller endast för AAD B2C-identitetsprovider.	sträng Begränsningar: Min längd = 1
typ	Identitetsproviderns typidentifierare.	"aad" "aadB2C" "facebook" "google" "microsoft" "twitter"

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall	Beskrivning
Skapa en API Management-instans och alla underresurser med hjälp av mallen	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 med åtgärder som mål:

• Resursgrupper

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

Resursformat

Om du vill skapa en Microsoft.ApiManagement/service/identityProviders-resurs lägger du till följande Terraform i mallen.

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

Egenskapsvärden

service/identityProviders

Namn	Beskrivning	Värde
typ	Resurstypen	"Microsoft.ApiManagement/service/identityProviders@2023-09-01-preview"
Namn	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
Egenskaper	Egenskaper för identitetsproviderkontrakt.	IdentityProviderCreateContractPropertiesOrIdentityPr...

IdentityProviderCreateContractPropertiesOrIdentityPr...

Namn	Beskrivning	Värde
allowedTenants	Lista över tillåtna klienter när du konfigurerar Azure Active Directory-inloggning.	string[] Begränsningar: Max längd = 32
auktoritet	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) Begränsningar: Min längd = 1
clientLibrary	Klientbiblioteket som ska användas i utvecklarportalen. Gäller endast för AAD- och AAD B2C-identitetsprovider.	sträng Begränsningar: Max längd = 16
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 för GET-åtgärder! Använd POST-begäran för "/listSecrets" för att hämta värdet.	sträng (krävs) Begränsningar: Min längd = 1 Känsligt värde. Skicka in som en säker parameter.
passwordResetPolicyName	Namn på lösenordsåterställningsprincip. Gäller endast för AAD B2C-identitetsprovider.	sträng Begränsningar: Min längd = 1
profileEditingPolicyName	Namn på profilredigeringsprincip. Gäller endast för AAD B2C-identitetsprovider.	sträng Begränsningar: Min längd = 1
signinPolicyName	Namn på inloggningsprincip. Gäller endast för AAD B2C-identitetsprovider.	sträng Begränsningar: Min längd = 1
signinTenant	TenantId som ska användas i stället för Common när du loggar in på Active Directory	sträng
signupPolicyName	Namn på registreringsprincip. Gäller endast för AAD B2C-identitetsprovider.	sträng Begränsningar: Min längd = 1
typ	Identitetsproviderns typidentifierare.	"aad" "aadB2C" "facebook" "google" "microsoft" "twitter"