Aracılığıyla paylaş

Microsoft.ApiManagement hizmeti/kullanıcıları 2021-12-01-preview

  • Makale

Bicep kaynak tanımı

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

resource symbolicname 'Microsoft.ApiManagement/service/users@2021-12-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    appType: 'string'
    confirmation: 'string'
    email: 'string'
    firstName: 'string'
    identities: [
      {
        id: 'string'
        provider: 'string'
      }
    ]
    lastName: 'string'
    note: 'string'
    password: 'string'
    state: 'string'
  }
}

Özellik değerleri

hizmet/kullanıcılar

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ısallar ve kısa çizgiler.

Harfle başlayın ve alfasayısal ile bitirin.
Üst Bicep'te alt kaynak için üst kaynağı 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 Kullanıcı varlığı, sözleşme özellikleri oluşturur. UserCreateParameterPropertiesOrUserContractPropertie...

UserCreateParameterPropertiesOrUserContractPropertie...

Ad Açıklama Değer
appType Oluşturma kullanıcı isteğini gönderen uygulamanın türünü belirler. Varsayılan, eski portaldır. 'developerPortal'
'portal'
Onay Yeni oluşturulan kullanıcıya gönderilecek onay e-postasının türünü belirler. 'davet et'
'kaydolma'
e-posta E-posta adresi. Boş olmamalıdır ve hizmet örneğinde benzersiz olmalıdır. dize (gerekli)
firstName Adı. dize (gerekli)
Kimlik Kullanıcı kimlikleri koleksiyonu. UserIdentityContract[]
lastName Soyadı. dize (gerekli)
Not Yönetici tarafından ayarlanan bir kullanıcı hakkında isteğe bağlı not. string
password Kullanıcı Parolası. Değer sağlanmazsa, varsayılan bir parola oluşturulur. string
state Hesap durumu. Kullanıcının etkin olup olmadığını belirtir. Engellenen kullanıcılar geliştirici portalında oturum açamaz veya abone olunan ürünlerin API'lerini çağıramaz. Varsayılan durum Etkin'dir. 'etkin'
'engellendi'
'silindi'
'beklemede'

UserIdentityContract

Ad Açıklama Değer
kimlik Sağlayıcı içindeki tanımlayıcı değeri. string
Sağlayıcı Kimlik sağlayıcısı adı. string

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

ARM şablonu kaynak tanımı

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

{
  "type": "Microsoft.ApiManagement/service/users",
  "apiVersion": "2021-12-01-preview",
  "name": "string",
  "properties": {
    "appType": "string",
    "confirmation": "string",
    "email": "string",
    "firstName": "string",
    "identities": [
      {
        "id": "string",
        "provider": "string"
      }
    ],
    "lastName": "string",
    "note": "string",
    "password": "string",
    "state": "string"
  }
}

Özellik değerleri

hizmet/kullanıcılar

Ad Açıklama Değer
tür Kaynak türü 'Microsoft.ApiManagement/service/users'
apiVersion Kaynak API'sinin sürümü '2021-12-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 Kullanıcı varlığı sözleşme özellikleri oluşturur. UserCreateParameterPropertiesOrUserContractPropertie...

UserCreateParameterPropertiesOrUserContractPropertie...

Ad Açıklama Değer
appType Oluşturma kullanıcı isteğini gönderen uygulamanın türünü belirler. Varsayılan, eski portaldır. 'developerPortal'
'portal'
Onay Yeni oluşturulan kullanıcıya gönderilecek onay e-postasının türünü belirler. 'davet et'
'kayıt'
e-posta E-posta adresi. Boş olmamalıdır ve hizmet örneği içinde benzersiz olmalıdır. dize (gerekli)
firstName Adı. dize (gerekli)
Kimlik Kullanıcı kimlikleri koleksiyonu. UserIdentityContract[]
lastName Soyadı. dize (gerekli)
Not Yönetici tarafından ayarlanan kullanıcı hakkında isteğe bağlı not. string
password Kullanıcı Parolası. Değer sağlanmazsa, varsayılan bir parola oluşturulur. string
state Hesap durumu. Kullanıcının etkin olup olmadığını belirtir. Engellenen kullanıcılar geliştirici portalında oturum açamaz veya abone olunan ürünlerin API'lerini çağıramaz. Varsayılan durum Etkin'dir. 'etkin'
'engellendi'
'silindi'
'beklemede'

UserIdentityContract

Ad Açıklama Değer
kimlik Sağlayıcı içindeki tanımlayıcı değeri. string
Sağlayıcı Kimlik sağlayıcısı adı. string

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

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

Hizmet/kullanıcılar 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/users kaynağı oluşturmak için şablonunuza aşağıdaki Terraform'u ekleyin.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/users@2021-12-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      appType = "string"
      confirmation = "string"
      email = "string"
      firstName = "string"
      identities = [
        {
          id = "string"
          provider = "string"
        }
      ]
      lastName = "string"
      note = "string"
      password = "string"
      state = "string"
    }
  })
}

Özellik değerleri

hizmet/kullanıcılar

Ad Açıklama Değer
tür Kaynak türü "Microsoft.ApiManagement/service/users@2021-12-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 Kullanıcı varlığı, sözleşme özellikleri oluşturur. UserCreateParameterPropertiesOrUserContractPropertie...

UserCreateParameterPropertiesOrUserContractPropertie...

Ad Açıklama Değer
appType Oluşturma kullanıcı isteğini gönderen uygulamanın türünü belirler. Varsayılan, eski portaldır. "developerPortal"
"portal"
Onay Yeni oluşturulan kullanıcıya gönderilecek onay e-postasının türünü belirler. "davet et"
"kaydolma"
e-posta E-posta adresi. Boş olmamalıdır ve hizmet örneğinde benzersiz olmalıdır. dize (gerekli)
firstName Adı. dize (gerekli)
Kimlik Kullanıcı kimlikleri koleksiyonu. UserIdentityContract[]
lastName Soyadı. dize (gerekli)
Not Yönetici tarafından ayarlanan bir kullanıcı hakkında isteğe bağlı not. string
password Kullanıcı Parolası. Değer sağlanmazsa, varsayılan bir parola oluşturulur. string
state Hesap durumu. Kullanıcının etkin olup olmadığını belirtir. Engellenen kullanıcılar geliştirici portalında oturum açamaz veya abone olunan ürünlerin API'lerini çağıramaz. Varsayılan durum Etkin'dir. "etkin"
"engellendi"
"silindi"
"beklemede"

UserIdentityContract

Ad Açıklama Değer
kimlik Sağlayıcı içindeki tanımlayıcı değeri. string
Sağlayıcı Kimlik sağlayıcısı adı. string