Aracılığıyla paylaş

Microsoft.ApiManagement hizmeti/abonelikleri 2018-01-01

  • Makale

Bicep kaynak tanımı

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

resource symbolicname 'Microsoft.ApiManagement/service/subscriptions@2018-01-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    displayName: 'string'
    primaryKey: 'string'
    productId: 'string'
    secondaryKey: 'string'
    state: 'string'
    userId: 'string'
  }
}

Özellik Değerleri

Microsoft.ApiManagement/service/subscriptions

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

Kısıtlama -ları:
Maksimum uzunluk = 80
Desen = (^[\w]+$)|(^[\w][\w\-]+[\w]$) (gerekli)
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 Abonelik sözleşmesi özellikleri. SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties

SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties

Ad Açıklama Değer
displayName Abonelik adı. dizgi

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 100 (gerekli)
primaryKey Birincil abonelik anahtarı. İstek anahtarı sırasında belirtilmezse otomatik olarak oluşturulur. dizgi

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 256
Productıd Aboneliğin /products/{productId} biçiminde oluşturulduğu ürün (ürün kimliği yolu) dize (gerekli)
secondaryKey İkincil abonelik anahtarı. İstek anahtarı sırasında belirtilmezse otomatik olarak oluşturulur. dizgi

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 256
devlet İlk abonelik durumu. Herhangi bir değer belirtilmezse, Abonelik Gönderildi durumuyla oluşturulur. Olası durumlar * etkindir – abonelik etkin, * askıya alınmış – abonelik engellenir ve abone ürünün api'lerini çağıramaz, * gönderildi – abonelik isteği geliştirici tarafından yapılmış, ancak henüz onaylanmamış veya reddedilmemiş, * reddedildi – abonelik isteği bir yönetici tarafından reddedildi, * iptal edildi – abonelik geliştirici veya yönetici tarafından iptal edildi, * süresi doldu – abonelik son kullanma tarihine ulaştı ve devre dışı bırakıldı. 'etkin'
'iptal edildi'
'süresi doldu'
'reddedildi'
'gönderildi'
'askıya alındı'
userId Aboneliğin /users/{uid} biçiminde oluşturulduğu kullanıcı (kullanıcı kimliği yolu) dize (gerekli)

ARM şablonu kaynak tanımı

Hizmet/abonelik 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/subscriptions kaynağı oluşturmak için şablonunuza aşağıdaki JSON dosyasını ekleyin.

{
  "type": "Microsoft.ApiManagement/service/subscriptions",
  "apiVersion": "2018-01-01",
  "name": "string",
  "properties": {
    "displayName": "string",
    "primaryKey": "string",
    "productId": "string",
    "secondaryKey": "string",
    "state": "string",
    "userId": "string"
  }
}

Özellik Değerleri

Microsoft.ApiManagement/service/subscriptions

Ad Açıklama Değer
apiVersion API sürümü '2018-01-01'
ad Kaynak adı dizgi

Kısıtlama -ları:
Maksimum uzunluk = 80
Desen = (^[\w]+$)|(^[\w][\w\-]+[\w]$) (gerekli)
Özellikler Abonelik sözleşmesi özellikleri. SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties
tür Kaynak türü 'Microsoft.ApiManagement/service/subscriptions'

SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties

Ad Açıklama Değer
displayName Abonelik adı. dizgi

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 100 (gerekli)
primaryKey Birincil abonelik anahtarı. İstek anahtarı sırasında belirtilmezse otomatik olarak oluşturulur. dizgi

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 256
Productıd Aboneliğin /products/{productId} biçiminde oluşturulduğu ürün (ürün kimliği yolu) dize (gerekli)
secondaryKey İkincil abonelik anahtarı. İstek anahtarı sırasında belirtilmezse otomatik olarak oluşturulur. dizgi

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 256
devlet İlk abonelik durumu. Herhangi bir değer belirtilmezse, Abonelik Gönderildi durumuyla oluşturulur. Olası durumlar * etkindir – abonelik etkin, * askıya alınmış – abonelik engellenir ve abone ürünün api'lerini çağıramaz, * gönderildi – abonelik isteği geliştirici tarafından yapılmış, ancak henüz onaylanmamış veya reddedilmemiş, * reddedildi – abonelik isteği bir yönetici tarafından reddedildi, * iptal edildi – abonelik geliştirici veya yönetici tarafından iptal edildi, * süresi doldu – abonelik son kullanma tarihine ulaştı ve devre dışı bırakıldı. 'etkin'
'iptal edildi'
'süresi doldu'
'reddedildi'
'gönderildi'
'askıya alındı'
userId Aboneliğin /users/{uid} biçiminde oluşturulduğu kullanıcı (kullanıcı kimliği yolu) dize (gerekli)

Kullanım Örnekleri

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/subscriptions@2018-01-01"
  name = "string"
  body = {
    properties = {
      displayName = "string"
      primaryKey = "string"
      productId = "string"
      secondaryKey = "string"
      state = "string"
      userId = "string"
    }
  }
}

Özellik Değerleri

Microsoft.ApiManagement/service/subscriptions

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

Kısıtlama -ları:
Maksimum uzunluk = 80
Desen = (^[\w]+$)|(^[\w][\w\-]+[\w]$) (gerekli)
parent_id Bu kaynağın üst öğesi olan kaynağın kimliği. Kaynak türü için kimlik: hizmet
Özellikler Abonelik sözleşmesi özellikleri. SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties
tür Kaynak türü "Microsoft.ApiManagement/service/subscriptions@2018-01-01"

SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties

Ad Açıklama Değer
displayName Abonelik adı. dizgi

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 100 (gerekli)
primaryKey Birincil abonelik anahtarı. İstek anahtarı sırasında belirtilmezse otomatik olarak oluşturulur. dizgi

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 256
Productıd Aboneliğin /products/{productId} biçiminde oluşturulduğu ürün (ürün kimliği yolu) dize (gerekli)
secondaryKey İkincil abonelik anahtarı. İstek anahtarı sırasında belirtilmezse otomatik olarak oluşturulur. dizgi

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 256
devlet İlk abonelik durumu. Herhangi bir değer belirtilmezse, Abonelik Gönderildi durumuyla oluşturulur. Olası durumlar * etkindir – abonelik etkin, * askıya alınmış – abonelik engellenir ve abone ürünün api'lerini çağıramaz, * gönderildi – abonelik isteği geliştirici tarafından yapılmış, ancak henüz onaylanmamış veya reddedilmemiş, * reddedildi – abonelik isteği bir yönetici tarafından reddedildi, * iptal edildi – abonelik geliştirici veya yönetici tarafından iptal edildi, * süresi doldu – abonelik son kullanma tarihine ulaştı ve devre dışı bırakıldı. 'etkin'
'iptal edildi'
'süresi doldu'
'reddedildi'
'gönderildi'
'askıya alındı'
userId Aboneliğin /users/{uid} biçiminde oluşturulduğu kullanıcı (kullanıcı kimliği yolu) dize (gerekli)