Služba Microsoft.ApiManagement/identityProviders 2021-04-01-preview

  • Článek

Definice prostředku Bicep

Typ prostředku service/identityProviders je možné nasadit s operacemi, které cílí na:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/identityProviders, přidejte do šablony následující bicep.

resource symbolicname 'Microsoft.ApiManagement/service/identityProviders@2021-04-01-preview' = {
  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'
  }
}

Hodnoty vlastností

service/identityProviders

Název Description Hodnota
name Název prostředku

Podívejte se, jak nastavit názvy a typy pro podřízené prostředky v nástroji Bicep.		 string (povinné)

Omezení počtu znaků: 1–80

Platné znaky:
Alfanumerické znaky a pomlčky.

Začněte písmenem a končíte alfanumerickými znaky.
Nadřazené V nástroji Bicep můžete zadat nadřazený prostředek podřízeného prostředku. Tuto vlastnost stačí přidat pouze v případě, že je podřízený prostředek deklarován mimo nadřazený prostředek.

Další informace najdete v tématu Podřízený prostředek mimo nadřazený prostředek.		 Symbolický název prostředku typu service
properties Vlastnosti kontraktu zprostředkovatele identity IdentityProviderCreateContractPropertiesOrIdentityPr...

IdentityProviderCreateContractPropertiesOrIdentityPr...

Název Description Hodnota
allowedTenants Seznam povolených tenantů při konfiguraci přihlášení k Azure Active Directory string[]
Orgán OpenID Connect název hostitele koncového bodu zjišťování pro AAD nebo AAD B2C. řetězec
clientId ID klienta aplikace v externím zprostředkovateli identity. Je to ID aplikace pro přihlášení k Facebooku, ID klienta pro přihlášení ke Googlu, ID aplikace pro Microsoft. string (povinné)
clientSecret Tajný klíč klienta aplikace v externím zprostředkovateli identity, který se používá k ověření žádosti o přihlášení. Jedná se například o tajný kód aplikace pro přihlášení k Facebooku, klíč rozhraní API pro přihlášení ke Googlu a veřejný klíč pro Microsoft. Tato vlastnost nebude vyplněna při operacích GET! K získání hodnoty použijte požadavek POST /listSecrets. string (povinné)
passwordResetPolicyName Název zásady resetování hesla. Platí pouze pro zprostředkovatele identity AAD B2C. řetězec
profileEditingPolicyName Název zásady úpravy profilu. Platí pouze pro zprostředkovatele identity AAD B2C. řetězec
signinNázev zásady Název zásad přihlašování. Platí pouze pro zprostředkovatele identity AAD B2C. řetězec
signinTenant Id tenanta, které se použije místo common při přihlašování ke službě Active Directory řetězec
signupPolicyName Název zásad registrace. Platí pouze pro zprostředkovatele identity AAD B2C. řetězec
typ Identifikátor typu zprostředkovatele identity. "aad"
"aadB2C"
'facebook'
'google'
microsoft
"twitter"

Šablony pro rychlý start

Následující šablony pro rychlý start nasadí tento typ prostředku.

Template (Šablona) Description
Vytvoření instance služby API Management a všech dílčích prostředků pomocí šablony

Nasazení do Azure		 Tato šablona ukazuje, jak vytvořit službu API Management a nakonfigurovat dílčí entity.

Definice prostředku šablony ARM

Typ prostředku service/identityProviders je možné nasadit s operacemi, které cílí na:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/identityProviders, přidejte do šablony následující kód JSON.

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

Hodnoty vlastností

service/identityProviders

Název Description Hodnota
typ Typ prostředku Microsoft.ApiManagement/service/identityProviders
apiVersion Verze rozhraní API prostředku 2021-04-01-preview
name Název prostředku

Podívejte se, jak nastavit názvy a typy pro podřízené prostředky v šablonách JSON ARM.		 string (povinné)

Omezení počtu znaků: 1–80

Platné znaky:
Alfanumerické znaky a pomlčky.

Začněte písmenem a končíte alfanumerickými znaky.
properties Vlastnosti kontraktu zprostředkovatele identity IdentityProviderCreateContractPropertiesOrIdentityPr...

IdentityProviderCreateContractPropertiesOrIdentityPr...

Název Description Hodnota
allowedTenants Seznam povolených tenantů při konfiguraci přihlášení k Azure Active Directory string[]
Orgán OpenID Connect název hostitele koncového bodu zjišťování pro AAD nebo AAD B2C. řetězec
clientId ID klienta aplikace v externím zprostředkovateli identity. Je to ID aplikace pro přihlášení k Facebooku, ID klienta pro přihlášení ke Googlu, ID aplikace pro Microsoft. string (povinné)
clientSecret Tajný klíč klienta aplikace v externím zprostředkovateli identity, který se používá k ověření žádosti o přihlášení. Jedná se například o tajný kód aplikace pro přihlášení k Facebooku, klíč rozhraní API pro přihlášení ke Googlu a veřejný klíč pro Microsoft. Tato vlastnost nebude vyplněna při operacích GET! K získání hodnoty použijte požadavek POST /listSecrets. string (povinné)
passwordResetPolicyName Název zásady resetování hesla. Platí pouze pro zprostředkovatele identity AAD B2C. řetězec
profileEditingPolicyName Název zásady úpravy profilu. Platí pouze pro zprostředkovatele identity AAD B2C. řetězec
signinNázev zásady Název zásad přihlašování. Platí pouze pro zprostředkovatele identity AAD B2C. řetězec
signinTenant Id tenanta, které se použije místo common při přihlašování ke službě Active Directory řetězec
signupPolicyName Název zásad registrace. Platí pouze pro zprostředkovatele identity AAD B2C. řetězec
typ Identifikátor typu zprostředkovatele identity. "aad"
"aadB2C"
'facebook'
'google'
microsoft
"twitter"

Šablony pro rychlý start

Následující šablony pro rychlý start nasadí tento typ prostředku.

Template (Šablona) Description
Vytvoření instance služby API Management a všech dílčích prostředků pomocí šablony

Nasazení do Azure		 Tato šablona ukazuje, jak vytvořit službu API Management a nakonfigurovat dílčí entity.

Definice prostředku Terraform (poskytovatel AzAPI)

Typ prostředku service/identityProviders je možné nasadit s operacemi, které cílí na:

  • Skupiny prostředků

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/identityProviders, přidejte do šablony následující Terraform.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/identityProviders@2021-04-01-preview"
  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"
    }
  })
}

Hodnoty vlastností

service/identityProviders

Název Description Hodnota
typ Typ prostředku Microsoft.ApiManagement/service/identityProviders@2021-04-01-preview
name Název prostředku string (povinné)

Omezení počtu znaků: 1–80

Platné znaky:
Alfanumerické znaky a pomlčky.

Začněte písmenem a končíte alfanumerickými znaky.
parent_id ID prostředku, který je nadřazený pro tento prostředek. ID prostředku typu service
properties Vlastnosti smlouvy zprostředkovatele identity. IdentityProviderCreateContractPropertiesOrIdentityPr...

IdentityProviderCreateContractPropertiesOrIdentityPr...

Název Description Hodnota
allowedTenants Seznam povolených tenantů při konfiguraci přihlášení k Azure Active Directory string[]
Orgán OpenID Connect Název hostitele koncového bodu zjišťování pro AAD nebo AAD B2C řetězec
clientId ID klienta aplikace v externím zprostředkovateli identity. Jedná se o ID aplikace pro přihlášení k Facebooku, ID klienta pro přihlášení Google a ID aplikace pro Microsoft. string (povinné)
clientSecret Tajný klíč klienta aplikace v externím zprostředkovateli identity, který slouží k ověření žádosti o přihlášení. Jedná se například o tajný kód aplikace pro přihlášení k Facebooku, klíč rozhraní API pro přihlášení Google, veřejný klíč pro Microsoft. Tato vlastnost nebude vyplněna při operacích GET! K získání hodnoty použijte požadavek POST /listSecrets. string (povinné)
passwordResetPolicyName Název zásady resetování hesla. Platí jenom pro zprostředkovatele identity AAD B2C. řetězec
profileEditingPolicyName Název zásady úpravy profilu. Platí jenom pro zprostředkovatele identity AAD B2C. řetězec
signinPolicyName Název zásady přihlášení. Platí jenom pro zprostředkovatele identity AAD B2C. řetězec
signinTenant Id tenanta, které se má při přihlašování ke službě Active Directory použít místo běžného řetězec
signupPolicyName Název zásady registrace. Platí jenom pro zprostředkovatele identity AAD B2C. řetězec
typ Identifikátor typu zprostředkovatele identity. "aad"
"aadB2C"
"facebook"
"google"
"microsoft"
"twitter"