Aracılığıyla paylaş

Microsoft.ApiManagement hizmeti/identityProviders

  • Makale

Bicep kaynak tanımı

Service/identityProviders kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:

  • kaynak grupları - Bkz. kaynak grubu dağıtım komutları

Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.

Kaynak biçimi

Microsoft.ApiManagement/service/identityProviders kaynağı oluşturmak için şablonunuza aşağıdaki Bicep'i ekleyin.

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

Özellik değerleri

service/identityProviders

Ad Açıklama Değer
ad Kaynak adı

Bicep'nde alt kaynaklar için adları ve türleri ayarlamayı öğrenin.		 dize (gerekli)

Karakter sınırı: 1-80

Geçerli karakterler:
Alfasayısallar ve kısa çizgiler.

Harfle başlayın ve alfasayısal ile bitirin.
ebeveyn Bicep'te bir alt kaynak için üst kaynak belirtebilirsiniz. Bu özelliği yalnızca alt kaynak üst kaynağın dışında bildirildiğinde eklemeniz gerekir.

Daha fazla bilgi için bkz. Alt kaynaküst kaynak dışında.		 Kaynak türü için sembolik ad: hizmet
Özellikler Kimlik Sağlayıcısı sözleşme özellikleri. IdentityProviderCreateContractPropertiesOrIdentityPr...

IdentityProviderCreateContractPropertiesOrIdentityPr...

Ad Açıklama Değer
allowedTenants Azure Active Directory oturum açma bilgilerini yapılandırırken İzin Verilen Kiracıların listesi. string[]

Kısıtlama -ları:
Maksimum uzunluk = 32
otorite AAD veya AAD B2C için OpenID Connect bulma uç noktası ana bilgisayar adı. dizgi
clientId Dış Kimlik Sağlayıcısında Uygulamanın İstemci Kimliği. Bu, Facebook oturum açma için Uygulama Kimliği, Google oturum açma için İstemci Kimliği, Microsoft için Uygulama Kimliği'dir. dize (gerekli)

Kısıtlama -ları:
En az uzunluk = 1
clientLibrary Geliştirici portalında kullanılacak istemci kitaplığı. Yalnızca AAD ve AAD B2C Kimlik Sağlayıcısı için geçerlidir. dizgi

Kısıtlama -ları:
Maksimum uzunluk = 16
clientSecret Oturum açma isteğinin kimliğini doğrulamak için kullanılan dış Kimlik Sağlayıcısında Uygulamanın istemci gizli dizisi. Örneğin, Facebook oturum açma bilgileri için Uygulama Gizli Anahtarı, Google oturum açma için API Anahtarı, Microsoft için Ortak Anahtar şeklindedir. Bu özellik 'GET' işlemlerinde doldurulmayacak! Değeri almak için '/listSecrets' POST isteğini kullanın. dize (gerekli)

Kısıtlama -ları:
En az uzunluk = 1
Hassas değer. Güvenli parametre olarak geçirin.
passwordResetPolicyName Parola Sıfırlama İlkesi Adı. Yalnızca AAD B2C Kimlik Sağlayıcısı için geçerlidir. dizgi

Kısıtlama -ları:
En az uzunluk = 1
profileEditingPolicyName Profil Düzenleme İlkesi Adı. Yalnızca AAD B2C Kimlik Sağlayıcısı için geçerlidir. dizgi

Kısıtlama -ları:
En az uzunluk = 1
signinPolicyName oturum açma ilkesi adı. Yalnızca AAD B2C Kimlik Sağlayıcısı için geçerlidir. dizgi

Kısıtlama -ları:
En az uzunluk = 1
signinTenant Active Directory'de oturum açarken Ortak yerine kullanılacak TenantId dizgi
signupPolicyName Kaydolma İlkesi Adı. Yalnızca AAD B2C Kimlik Sağlayıcısı için geçerlidir. dizgi

Kısıtlama -ları:
En az uzunluk = 1
tür Kimlik Sağlayıcısı Türü tanımlayıcısı. 'aad'
'aadB2C'
'facebook'
'google'
'microsoft'
'twitter'

Hızlı başlangıç şablonları

Aşağıdaki hızlı başlangıç şablonları bu kaynak türünü dağıtır.

Şablon Açıklama
Şablon kullanarak API Management örneği ve tüm alt kaynakları oluşturma

Azure 'a dağıtma		 Bu şablon, API Management hizmeti oluşturma ve alt varlıkları yapılandırma adımlarını gösterir

ARM şablonu kaynak tanımı

Service/identityProviders kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:

  • kaynak grupları - Bkz. kaynak grubu dağıtım komutları

Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.

Kaynak biçimi

Microsoft.ApiManagement/service/identityProviders kaynağı oluşturmak için, şablonunuza aşağıdaki JSON'u ekleyin.

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

Özellik değerleri

service/identityProviders

Ad Açıklama Değer
tür Kaynak türü 'Microsoft.ApiManagement/service/identityProviders'
apiVersion Kaynak API'sinin sürümü '2023-09-01-preview'
ad Kaynak adı

JSON ARM şablonlarında alt kaynakların adlarını ve türlerini ayarlamayı öğrenin.		 dize (gerekli)

Karakter sınırı: 1-80

Geçerli karakterler:
Alfasayısallar ve kısa çizgiler.

Harfle başlayın ve alfasayısal ile bitirin.
Özellikler Kimlik Sağlayıcısı sözleşme özellikleri. IdentityProviderCreateContractPropertiesOrIdentityPr...

IdentityProviderCreateContractPropertiesOrIdentityPr...

Ad Açıklama Değer
allowedTenants Azure Active Directory oturum açma bilgilerini yapılandırırken İzin Verilen Kiracıların listesi. string[]

Kısıtlama -ları:
Maksimum uzunluk = 32
otorite AAD veya AAD B2C için OpenID Connect bulma uç noktası ana bilgisayar adı. dizgi
clientId Dış Kimlik Sağlayıcısında Uygulamanın İstemci Kimliği. Bu, Facebook oturum açma için Uygulama Kimliği, Google oturum açma için İstemci Kimliği, Microsoft için Uygulama Kimliği'dir. dize (gerekli)

Kısıtlama -ları:
En az uzunluk = 1
clientLibrary Geliştirici portalında kullanılacak istemci kitaplığı. Yalnızca AAD ve AAD B2C Kimlik Sağlayıcısı için geçerlidir. dizgi

Kısıtlama -ları:
Maksimum uzunluk = 16
clientSecret Oturum açma isteğinin kimliğini doğrulamak için kullanılan dış Kimlik Sağlayıcısında Uygulamanın istemci gizli dizisi. Örneğin, Facebook oturum açma bilgileri için Uygulama Gizli Anahtarı, Google oturum açma için API Anahtarı, Microsoft için Ortak Anahtar şeklindedir. Bu özellik 'GET' işlemlerinde doldurulmayacak! Değeri almak için '/listSecrets' POST isteğini kullanın. dize (gerekli)

Kısıtlama -ları:
En az uzunluk = 1
Hassas değer. Güvenli parametre olarak geçirin.
passwordResetPolicyName Parola Sıfırlama İlkesi Adı. Yalnızca AAD B2C Kimlik Sağlayıcısı için geçerlidir. dizgi

Kısıtlama -ları:
En az uzunluk = 1
profileEditingPolicyName Profil Düzenleme İlkesi Adı. Yalnızca AAD B2C Kimlik Sağlayıcısı için geçerlidir. dizgi

Kısıtlama -ları:
En az uzunluk = 1
signinPolicyName oturum açma ilkesi adı. Yalnızca AAD B2C Kimlik Sağlayıcısı için geçerlidir. dizgi

Kısıtlama -ları:
En az uzunluk = 1
signinTenant Active Directory'de oturum açarken Ortak yerine kullanılacak TenantId dizgi
signupPolicyName Kaydolma İlkesi Adı. Yalnızca AAD B2C Kimlik Sağlayıcısı için geçerlidir. dizgi

Kısıtlama -ları:
En az uzunluk = 1
tür Kimlik Sağlayıcısı Türü tanımlayıcısı. 'aad'
'aadB2C'
'facebook'
'google'
'microsoft'
'twitter'

Hızlı başlangıç şablonları

Aşağıdaki hızlı başlangıç şablonları bu kaynak türünü dağıtır.

Şablon Açıklama
Şablon kullanarak API Management örneği ve tüm alt kaynakları oluşturma

Azure 'a dağıtma		 Bu şablon, API Management hizmeti oluşturma ve alt varlıkları yapılandırma adımlarını gösterir

Terraform (AzAPI sağlayıcısı) kaynak tanımı

Service/identityProviders kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:

  • Kaynak grupları

Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.

Kaynak biçimi

Microsoft.ApiManagement/service/identityProviders kaynağı oluşturmak için, şablonunuza aşağıdaki Terraform'u ekleyin.

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

Özellik değerleri

service/identityProviders

Ad Açıklama Değer
tür Kaynak türü "Microsoft.ApiManagement/service/identityProviders@2023-09-01-preview"
ad Kaynak adı dize (gerekli)

Karakter sınırı: 1-80

Geçerli karakterler:
Alfasayısallar ve kısa çizgiler.

Harfle başlayın ve alfasayısal ile bitirin.
parent_id Bu kaynağın üst öğesi olan kaynağın kimliği. Kaynak türü için kimlik: hizmet
Özellikler Kimlik Sağlayıcısı sözleşme özellikleri. IdentityProviderCreateContractPropertiesOrIdentityPr...

IdentityProviderCreateContractPropertiesOrIdentityPr...

Ad Açıklama Değer
allowedTenants Azure Active Directory oturum açma bilgilerini yapılandırırken İzin Verilen Kiracıların listesi. string[]

Kısıtlama -ları:
Maksimum uzunluk = 32
otorite AAD veya AAD B2C için OpenID Connect bulma uç noktası ana bilgisayar adı. dizgi
clientId Dış Kimlik Sağlayıcısında Uygulamanın İstemci Kimliği. Bu, Facebook oturum açma için Uygulama Kimliği, Google oturum açma için İstemci Kimliği, Microsoft için Uygulama Kimliği'dir. dize (gerekli)

Kısıtlama -ları:
En az uzunluk = 1
clientLibrary Geliştirici portalında kullanılacak istemci kitaplığı. Yalnızca AAD ve AAD B2C Kimlik Sağlayıcısı için geçerlidir. dizgi

Kısıtlama -ları:
Maksimum uzunluk = 16
clientSecret Oturum açma isteğinin kimliğini doğrulamak için kullanılan dış Kimlik Sağlayıcısında Uygulamanın istemci gizli dizisi. Örneğin, Facebook oturum açma bilgileri için Uygulama Gizli Anahtarı, Google oturum açma için API Anahtarı, Microsoft için Ortak Anahtar şeklindedir. Bu özellik 'GET' işlemlerinde doldurulmayacak! Değeri almak için '/listSecrets' POST isteğini kullanın. dize (gerekli)

Kısıtlama -ları:
En az uzunluk = 1
Hassas değer. Güvenli parametre olarak geçirin.
passwordResetPolicyName Parola Sıfırlama İlkesi Adı. Yalnızca AAD B2C Kimlik Sağlayıcısı için geçerlidir. dizgi

Kısıtlama -ları:
En az uzunluk = 1
profileEditingPolicyName Profil Düzenleme İlkesi Adı. Yalnızca AAD B2C Kimlik Sağlayıcısı için geçerlidir. dizgi

Kısıtlama -ları:
En az uzunluk = 1
signinPolicyName oturum açma ilkesi adı. Yalnızca AAD B2C Kimlik Sağlayıcısı için geçerlidir. dizgi

Kısıtlama -ları:
En az uzunluk = 1
signinTenant Active Directory'de oturum açarken Ortak yerine kullanılacak TenantId dizgi
signupPolicyName Kaydolma İlkesi Adı. Yalnızca AAD B2C Kimlik Sağlayıcısı için geçerlidir. dizgi

Kısıtlama -ları:
En az uzunluk = 1
tür Kimlik Sağlayıcısı Türü tanımlayıcısı. "aad"
"aadB2C"
"facebook"
"google"
"microsoft"
"twitter"