Microsoft.ApiManagement hizmeti/apiVersionSets 2022-08-01

Bicep kaynak tanımı

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

resource symbolicname 'Microsoft.ApiManagement/service/apiVersionSets@2022-08-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    description: 'string'
    displayName: 'string'
    versionHeaderName: 'string'
    versioningScheme: 'string'
    versionQueryName: 'string'
  }
}

Özellik değerleri

service/apiVersionSets

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: hizmet
Özellikler API VersionSet sözleşme özellikleri. ApiVersionSetContractProperties

ApiVersionSetContractProperties

Ad Açıklama Değer
Açıklama API Sürüm Kümesi açıklaması. dizgi
displayName API Sürüm Kümesinin Adı dize (gerekli)

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 100
versionHeaderName VersioningScheme headerolarak ayarlandıysa API Sürümünü gösteren HTTP üst bilgi parametresinin adı. dizgi

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 100
versioningScheme API Sürüm tanımlayıcısının HTTP isteğinde nerede bulunacağını belirleyen bir değer. 'Üst Bilgi'
'Sorgu'
'Segment' (gerekli)
versionQueryName VersioningScheme queryolarak ayarlandıysa API Sürümünü gösteren sorgu parametresinin adı. dizgi

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 100

ARM şablonu kaynak tanımı

Service/apiVersionSets 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/apiVersionSets kaynağı oluşturmak için şablonunuza aşağıdaki JSON'u ekleyin.

{
  "type": "Microsoft.ApiManagement/service/apiVersionSets",
  "apiVersion": "2022-08-01",
  "name": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "versionHeaderName": "string",
    "versioningScheme": "string",
    "versionQueryName": "string"
  }
}

Özellik değerleri

service/apiVersionSets

Ad Açıklama Değer
tür Kaynak türü 'Microsoft.ApiManagement/service/apiVersionSets'
apiVersion Kaynak API'sinin sürümü '2022-08-01'
ad Kaynak adı

JSON ARM şablonlarında alt kaynakların adlarını ve türlerini ayarlamayı öğrenin.
dize (gerekli)
Özellikler API VersionSet sözleşme özellikleri. ApiVersionSetContractProperties

ApiVersionSetContractProperties

Ad Açıklama Değer
Açıklama API Sürüm Kümesi açıklaması. dizgi
displayName API Sürüm Kümesinin Adı dize (gerekli)

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 100
versionHeaderName VersioningScheme headerolarak ayarlandıysa API Sürümünü gösteren HTTP üst bilgi parametresinin adı. dizgi

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 100
versioningScheme API Sürüm tanımlayıcısının HTTP isteğinde nerede bulunacağını belirleyen bir değer. 'Üst Bilgi'
'Sorgu'
'Segment' (gerekli)
versionQueryName VersioningScheme queryolarak ayarlandıysa API Sürümünü gösteren sorgu parametresinin adı. dizgi

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 100

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apiVersionSets@2022-08-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      description = "string"
      displayName = "string"
      versionHeaderName = "string"
      versioningScheme = "string"
      versionQueryName = "string"
    }
  })
}

Özellik değerleri

service/apiVersionSets

Ad Açıklama Değer
tür Kaynak türü "Microsoft.ApiManagement/service/apiVersionSets@2022-08-01"
ad Kaynak adı dize (gerekli)
parent_id Bu kaynağın üst öğesi olan kaynağın kimliği. Kaynak türü için kimlik: hizmet
Özellikler API VersionSet sözleşme özellikleri. ApiVersionSetContractProperties

ApiVersionSetContractProperties

Ad Açıklama Değer
Açıklama API Sürüm Kümesi açıklaması. dizgi
displayName API Sürüm Kümesinin Adı dize (gerekli)

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 100
versionHeaderName VersioningScheme headerolarak ayarlandıysa API Sürümünü gösteren HTTP üst bilgi parametresinin adı. dizgi

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 100
versioningScheme API Sürüm tanımlayıcısının HTTP isteğinde nerede bulunacağını belirleyen bir değer. "Üst Bilgi"
"Sorgu"
"Segment" (gerekli)
versionQueryName VersioningScheme queryolarak ayarlandıysa API Sürümünü gösteren sorgu parametresinin adı. dizgi

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 100