Aracılığıyla paylaş

Microsoft.ApiManagement hizmeti/openidConnectProviders

  • Makale

Bicep kaynak tanımı

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

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/openidConnectProviders kaynağı oluşturmak için şablonunuza aşağıdaki Bicep'i ekleyin.

resource symbolicname 'Microsoft.ApiManagement/service/openidConnectProviders@2023-05-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    clientId: 'string'
    clientSecret: 'string'
    description: 'string'
    displayName: 'string'
    metadataEndpoint: 'string'
    useInApiDocumentation: bool
    useInTestConsole: bool
  }
}

Özellik değerleri

service/openidConnectProviders

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

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

Karakter sınırı: 1-80

Geçerli karakterler:
Alfasayısal değerler ve kısa çizgiler.

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

Daha fazla bilgi için bkz . Üst kaynağın dışındaki alt kaynak.		 Şu tür kaynak için sembolik ad: hizmet
properties OpenId Connect Sağlayıcısı sözleşme özellikleri. OpenidConnectProviderContractProperties

OpenidConnectProviderContractProperties

Ad Açıklama Değer
clientId İstemci uygulaması olan geliştirici konsolunun istemci kimliği. dize (gerekli)
clientSecret İstemci uygulaması olan geliştirici konsolunun gizli anahtarı. string
açıklama OpenID Connect Sağlayıcısının kullanıcı dostu açıklaması. string
displayName Kullanıcı dostu OpenID Connect Sağlayıcısı adı. dize (gerekli)
metadataEndpoint Meta veri uç noktası URI'si. dize (gerekli)
useInApiDocumentation True ise, Open ID Connect sağlayıcısı geliştirici portalındaki API belgelerinde kullanılır. Değer sağlanmazsa varsayılan olarak false olur. bool
useInTestConsole Doğruysa, Open ID Connect sağlayıcısı geliştirici portalı test konsolunda kullanılabilir. Değer sağlanmazsa varsayılan olarak True olur. bool

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

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

Şablon Description
Şablon kullanarak bir API Management örneği ve alt kaynaklarını oluşturma

Azure’a dağıtın		 Bu şablonda API Management hizmeti oluşturma ve alt varlıkları yapılandırma işlemleri gösterilir

ARM şablonu kaynak tanımı

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

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/openidConnectProviders kaynağı oluşturmak için şablonunuza aşağıdaki JSON'u ekleyin.

{
  "type": "Microsoft.ApiManagement/service/openidConnectProviders",
  "apiVersion": "2023-05-01-preview",
  "name": "string",
  "properties": {
    "clientId": "string",
    "clientSecret": "string",
    "description": "string",
    "displayName": "string",
    "metadataEndpoint": "string",
    "useInApiDocumentation": "bool",
    "useInTestConsole": "bool"
  }
}

Özellik değerleri

service/openidConnectProviders

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

Bkz. JSON ARM şablonlarında alt kaynaklar için adları ve türleri ayarlama.		 dize (gerekli)

Karakter sınırı: 1-80

Geçerli karakterler:
Alfasayısal değerler ve kısa çizgiler.

Harfle başlayın ve alfasayısal ile bitirin.
properties OpenId Connect Sağlayıcısı sözleşme özellikleri. OpenidConnectProviderContractProperties

OpenidConnectProviderContractProperties

Ad Açıklama Değer
clientId İstemci uygulaması olan geliştirici konsolunun istemci kimliği. dize (gerekli)
clientSecret İstemci uygulaması olan geliştirici konsolunun gizli anahtarı. string
açıklama OpenID Connect Sağlayıcısının kullanıcı dostu açıklaması. string
displayName Kullanıcı dostu OpenID Connect Sağlayıcısı adı. dize (gerekli)
metadataEndpoint Meta veri uç noktası URI'si. dize (gerekli)
useInApiDocumentation Doğruysa, Open ID Connect sağlayıcısı geliştirici portalındaki API belgelerinde kullanılır. Değer sağlanmazsa varsayılan olarak false olur. bool
useInTestConsole Doğruysa, Open ID Connect sağlayıcısı geliştirici portalı test konsolunda kullanılabilir. Değer sağlanmazsa varsayılan olarak True değeri verilir. bool

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

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

Şablon Description
Şablon kullanarak bir API Management örneği ve alt kaynaklarını oluşturma

Azure’a dağıtın		 Bu şablonda API Management hizmeti oluşturma ve alt varlıkları yapılandırma işlemleri gösterilmektedir

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

Service/openidConnectProviders 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/openidConnectProviders kaynağı oluşturmak için şablonunuza aşağıdaki Terraform'u ekleyin.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/openidConnectProviders@2023-05-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      clientId = "string"
      clientSecret = "string"
      description = "string"
      displayName = "string"
      metadataEndpoint = "string"
      useInApiDocumentation = bool
      useInTestConsole = bool
    }
  })
}

Özellik değerleri

service/openidConnectProviders

Ad Açıklama Değer
tür Kaynak türü "Microsoft.ApiManagement/service/openidConnectProviders@2023-05-01-preview"
name 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ü: hizmet kimliği
properties OpenId Connect Sağlayıcısı sözleşme özellikleri. OpenidConnectProviderContractProperties

OpenidConnectProviderContractProperties

Ad Açıklama Değer
clientId İstemci uygulaması olan geliştirici konsolunun istemci kimliği. dize (gerekli)
clientSecret İstemci uygulaması olan geliştirici konsolunun gizli anahtarı. string
açıklama OpenID Connect Sağlayıcısının kullanıcı dostu açıklaması. string
displayName Kullanıcı dostu OpenID Connect Sağlayıcısı adı. dize (gerekli)
metadataEndpoint Meta veri uç noktası URI'si. dize (gerekli)
useInApiDocumentation Doğruysa, Open ID Connect sağlayıcısı geliştirici portalındaki API belgelerinde kullanılır. Değer sağlanmazsa varsayılan olarak false olur. bool
useInTestConsole Doğruysa, Open ID Connect sağlayıcısı geliştirici portalı test konsolunda kullanılabilir. Değer sağlanmazsa varsayılan olarak True değeri verilir. bool