Aracılığıyla paylaş

Microsoft.ApiManagement hizmeti/çalışma alanları/abonelikler

  • Makale

Bicep kaynak tanımı

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

resource symbolicname 'Microsoft.ApiManagement/service/workspaces/subscriptions@2023-09-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    allowTracing: bool
    displayName: 'string'
    ownerId: 'string'
    primaryKey: 'string'
    scope: 'string'
    secondaryKey: 'string'
    state: 'string'
  }
}

Özellik değerleri

hizmet/çalışma alanları/abonelikler

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

Bicep'nde alt kaynaklar için adları ve türleri ayarlamayı öğrenin.		 dize (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: çalışma alanları
Özellikler Abonelik sözleşmesi özellikleri. SubscriptionCreateParameterPropertiesOrSubscriptionC...

SubscriptionCreateParameterPropertiesOrSubscriptionC...

Ad Açıklama Değer
allowTracing İzlemenin etkinleştirilip etkinleştirilmeyeceğini belirler Bool
displayName Abonelik adı. dize (gerekli)

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 100
ownerId Aboneliğin /users/{userId} biçiminde oluşturulduğu kullanıcı (kullanıcı kimliği yolu) dizgi
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
kapsam /products/{productId} veya /apis veya /apis/{apiId} gibi kapsam. 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ı'

ARM şablonu kaynak tanımı

Hizmet/çalışma alanları/abonelikler 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/workspaces/subscriptions kaynağı oluşturmak için şablonunuza aşağıdaki JSON'u ekleyin.

{
  "type": "Microsoft.ApiManagement/service/workspaces/subscriptions",
  "apiVersion": "2023-09-01-preview",
  "name": "string",
  "properties": {
    "allowTracing": "bool",
    "displayName": "string",
    "ownerId": "string",
    "primaryKey": "string",
    "scope": "string",
    "secondaryKey": "string",
    "state": "string"
  }
}

Özellik değerleri

hizmet/çalışma alanları/abonelikler

Ad Açıklama Değer
tür Kaynak türü 'Microsoft.ApiManagement/service/workspaces/subscriptions'
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)
Özellikler Abonelik sözleşmesi özellikleri. SubscriptionCreateParameterPropertiesOrSubscriptionC...

SubscriptionCreateParameterPropertiesOrSubscriptionC...

Ad Açıklama Değer
allowTracing İzlemenin etkinleştirilip etkinleştirilmeyeceğini belirler Bool
displayName Abonelik adı. dize (gerekli)

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 100
ownerId Aboneliğin /users/{userId} biçiminde oluşturulduğu kullanıcı (kullanıcı kimliği yolu) dizgi
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
kapsam /products/{productId} veya /apis veya /apis/{apiId} gibi kapsam. 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ı'

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/workspaces/subscriptions@2023-09-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      allowTracing = bool
      displayName = "string"
      ownerId = "string"
      primaryKey = "string"
      scope = "string"
      secondaryKey = "string"
      state = "string"
    }
  })
}

Özellik değerleri

hizmet/çalışma alanları/abonelikler

Ad Açıklama Değer
tür Kaynak türü "Microsoft.ApiManagement/service/workspaces/subscriptions@2023-09-01-preview"
ad Kaynak adı dize (gerekli)
parent_id Bu kaynağın üst öğesi olan kaynağın kimliği. Tür kaynağı kimliği: çalışma alanları
Özellikler Abonelik sözleşmesi özellikleri. SubscriptionCreateParameterPropertiesOrSubscriptionC...

SubscriptionCreateParameterPropertiesOrSubscriptionC...

Ad Açıklama Değer
allowTracing İzlemenin etkinleştirilip etkinleştirilmeyeceğini belirler Bool
displayName Abonelik adı. dize (gerekli)

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 100
ownerId Aboneliğin /users/{userId} biçiminde oluşturulduğu kullanıcı (kullanıcı kimliği yolu) dizgi
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
kapsam /products/{productId} veya /apis veya /apis/{apiId} gibi kapsam. 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ı"