Sdílet prostřednictvím


Služba Microsoft.ApiManagement /api-version-sets 2018-06-01-preview

Definice prostředku Bicep

Typ prostředku služby/api-version-sets je možné nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/api-version-sets, přidejte do šablony následující bicep.

resource symbolicname 'Microsoft.ApiManagement/service/api-version-sets@2018-06-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    description: 'string'
    displayName: 'string'
    versionHeaderName: 'string'
    versioningScheme: 'string'
    versionQueryName: 'string'
  }
}

Hodnoty vlastností

ApiVersionSetContractProperties

Jméno Popis Hodnota
popis Popis sady verzí rozhraní API řetězec
displayName Název sady verzí rozhraní API řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1 (povinné)
versionHeaderName Název parametru hlavičky HTTP, který označuje verzi rozhraní API, pokud je vlastnost versioningScheme nastavená na header. řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1
versioningScheme Hodnota, která určuje, kde se bude identifikátor verze rozhraní API nacházet v požadavku HTTP. Hlavička
Dotaz
Segment (povinné)
versionQueryName Název parametru dotazu, který označuje verzi rozhraní API, pokud je správa verzí nastavena na query. řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1

Microsoft.ApiManagement/service/api-version-sets

Jméno Popis Hodnota
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1
Model = ^[^*#&+:<>?]+$ (povinné)
rodič V bicep můžete zadat nadřazený prostředek pro podřízený prostředek. Tuto vlastnost je potřeba přidat pouze v případě, že je podřízený prostředek deklarován mimo nadřazený prostředek.

Další informace najdete v tématu Podřízený prostředek mimo nadřazený prostředek.
Symbolický název prostředku typu: služby
vlastnosti Vlastnosti kontraktu Api VersionSet apiVersionSetContractProperties

Definice prostředku šablony ARM

Typ prostředku služby/api-version-sets je možné nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/api-version-sets, přidejte do šablony následující JSON.

{
  "type": "Microsoft.ApiManagement/service/api-version-sets",
  "apiVersion": "2018-06-01-preview",
  "name": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "versionHeaderName": "string",
    "versioningScheme": "string",
    "versionQueryName": "string"
  }
}

Hodnoty vlastností

ApiVersionSetContractProperties

Jméno Popis Hodnota
popis Popis sady verzí rozhraní API řetězec
displayName Název sady verzí rozhraní API řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1 (povinné)
versionHeaderName Název parametru hlavičky HTTP, který označuje verzi rozhraní API, pokud je vlastnost versioningScheme nastavená na header. řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1
versioningScheme Hodnota, která určuje, kde se bude identifikátor verze rozhraní API nacházet v požadavku HTTP. Hlavička
Dotaz
Segment (povinné)
versionQueryName Název parametru dotazu, který označuje verzi rozhraní API, pokud je správa verzí nastavena na query. řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1

Microsoft.ApiManagement/service/api-version-sets

Jméno Popis Hodnota
apiVersion Verze rozhraní API 2018-06-01-preview
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1
Model = ^[^*#&+:<>?]+$ (povinné)
vlastnosti Vlastnosti kontraktu Api VersionSet apiVersionSetContractProperties
typ Typ prostředku Microsoft.ApiManagement/service/api-version-sets

Definice prostředku Terraformu (poskytovatel AzAPI)

Typ prostředku služby/api-version-sets je možné nasadit s operacemi, které cílí:

  • skupiny prostředků

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/api-version-sets, přidejte do šablony následující Terraform.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/api-version-sets@2018-06-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      description = "string"
      displayName = "string"
      versionHeaderName = "string"
      versioningScheme = "string"
      versionQueryName = "string"
    }
  })
}

Hodnoty vlastností

ApiVersionSetContractProperties

Jméno Popis Hodnota
popis Popis sady verzí rozhraní API řetězec
displayName Název sady verzí rozhraní API řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1 (povinné)
versionHeaderName Název parametru hlavičky HTTP, který označuje verzi rozhraní API, pokud je vlastnost versioningScheme nastavená na header. řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1
versioningScheme Hodnota, která určuje, kde se bude identifikátor verze rozhraní API nacházet v požadavku HTTP. Hlavička
Dotaz
Segment (povinné)
versionQueryName Název parametru dotazu, který označuje verzi rozhraní API, pokud je správa verzí nastavena na query. řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1

Microsoft.ApiManagement/service/api-version-sets

Jméno Popis Hodnota
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1
Model = ^[^*#&+:<>?]+$ (povinné)
parent_id ID prostředku, který je nadřazený pro tento prostředek. ID prostředku typu: služby
vlastnosti Vlastnosti kontraktu Api VersionSet apiVersionSetContractProperties
typ Typ prostředku Microsoft.ApiManagement/service/api-version-sets@2018-06-01-preview