Aracılığıyla paylaş

Microsoft.ApiManagement hizmeti/çalışma alanları/abonelikler 2022-09-01-preview

  • Makale

Bicep kaynak tanımı

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

resource symbolicname 'Microsoft.ApiManagement/service/workspaces/subscriptions@2022-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
name Kaynak adı

Bicep'te alt kaynaklar için adları ve türleri ayarlamayı öğrenin.		 dize (gerekli)
Ü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.		 Kaynak türü için sembolik ad: çalışma alanları
properties 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)
Ownerıd Aboneliğin /users/{userId} biçiminde oluşturulduğu kullanıcı (kullanıcı kimliği yolu) string
primaryKey Birincil abonelik anahtarı. İstek anahtarı sırasında belirtilmezse otomatik olarak oluşturulur. string
scope /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. string
state İlk abonelik durumu. Hiçbir değer belirtilmezse, abonelik Gönderildi durumuyla oluşturulur. Olası durumlar * etkindir – abonelik etkin, * askıya alındı – abonelik engellenir ve abone ürünün hiçbir API'sini ç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:

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": "2022-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ü '2022-09-01-preview'
name Kaynak adı

JSON ARM şablonlarında alt kaynaklar için adları ve türleri ayarlamayı öğrenin.		 dize (gerekli)
properties 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)
Ownerıd Aboneliğin /users/{userId} biçiminde oluşturulduğu kullanıcı (kullanıcı kimliği yolu) string
primaryKey Birincil abonelik anahtarı. İstek anahtarı sırasında belirtilmezse otomatik olarak oluşturulur. string
scope /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. string
state İlk abonelik durumu. Hiçbir değer belirtilmezse, abonelik Gönderildi durumuyla oluşturulur. Olası durumlar * etkindir – abonelik etkin, * askıya alındı – abonelik engellenir ve abone ürünün hiçbir API'sini ç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@2022-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@2022-09-01-preview"
name Kaynak adı dize (gerekli)
parent_id Bu kaynağın üst öğesi olan kaynağın kimliği. Kaynak türü: çalışma alanları kimliği
properties 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)
Ownerıd Aboneliğin /users/{userId} biçiminde oluşturulduğu kullanıcı (kullanıcı kimliği yolu) string
primaryKey Birincil abonelik anahtarı. İstek anahtarı sırasında belirtilmezse otomatik olarak oluşturulur. string
scope /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. string
state İlk abonelik durumu. Hiçbir değer belirtilmezse, abonelik Gönderildi durumuyla oluşturulur. Olası durumlar * etkindir – abonelik etkin, * askıya alındı – abonelik engellenir ve abone ürünün hiçbir API'sini ç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ı"