Microsoft.ApiManagement hizmeti/kullanıcıları

  • Makale

Bicep kaynak tanımı

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

resource symbolicname 'Microsoft.ApiManagement/service/users@2023-09-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
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 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)

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 254
firstName Ad. dize (gerekli)

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 100
Kimlik Kullanıcı kimlikleri koleksiyonu. UserIdentityContract[]
lastName Soyadı. dize (gerekli)

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 100
not Yönetici tarafından ayarlanan bir kullanıcı hakkında isteğe bağlı not. dizgi
parola Kullanıcı Parolası. Değer sağlanmazsa, varsayılan bir parola oluşturulur. dizgi
devlet 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
Kimliği Sağlayıcı içindeki tanımlayıcı değeri. dizgi
Sağlayıcı Kimlik sağlayıcısı adı. dizgi

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ı

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

{
  "type": "Microsoft.ApiManagement/service/users",
  "apiVersion": "2023-09-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ü '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 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)

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 254
firstName Ad. dize (gerekli)

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 100
Kimlik Kullanıcı kimlikleri koleksiyonu. UserIdentityContract[]
lastName Soyadı. dize (gerekli)

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 100
not Yönetici tarafından ayarlanan bir kullanıcı hakkında isteğe bağlı not. dizgi
parola Kullanıcı Parolası. Değer sağlanmazsa, varsayılan bir parola oluşturulur. dizgi
devlet 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
Kimliği Sağlayıcı içindeki tanımlayıcı değeri. dizgi
Sağlayıcı Kimlik sağlayıcısı adı. dizgi

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ı

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@2023-09-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@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 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)

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 254
firstName Ad. dize (gerekli)

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 100
Kimlik Kullanıcı kimlikleri koleksiyonu. UserIdentityContract[]
lastName Soyadı. dize (gerekli)

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 100
not Yönetici tarafından ayarlanan bir kullanıcı hakkında isteğe bağlı not. dizgi
parola Kullanıcı Parolası. Değer sağlanmazsa, varsayılan bir parola oluşturulur. dizgi
devlet 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
Kimliği Sağlayıcı içindeki tanımlayıcı değeri. dizgi
Sağlayıcı Kimlik sağlayıcısı adı. dizgi