Microsoft.ApiManagement-tjänsten/apiVersionSets 2023-09-01-preview
Bicep-resursdefinition
Resurstypen service/apiVersionSets kan distribueras med åtgärder som mål:
- Resursgrupper – Se resursgruppsdistributionskommandon
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.ApiManagement/service/apiVersionSets-resurs lägger du till följande Bicep i mallen.
resource symbolicname 'Microsoft.ApiManagement/service/apiVersionSets@2023-09-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
description: 'string'
displayName: 'string'
versionHeaderName: 'string'
versioningScheme: 'string'
versionQueryName: 'string'
}
}
Egenskapsvärden
service/apiVersionSets
| Namn | Beskrivning | Värde |
|---|---|---|
| Namn | Resursnamnet Se hur du anger namn och typer för underordnade resurser i Bicep. |
sträng (krävs) |
| förälder | I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen. Mer information finns i Underordnad resurs utanför den överordnade resursen. |
Symboliskt namn för resurs av typen: tjänst |
| Egenskaper | API-versionUppsättningskontraktegenskaper. | ApiVersionSetContractProperties |
ApiVersionSetContractProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| beskrivning | Beskrivning av API-versionsuppsättning. | sträng |
| displayName | Namn på API-versionsuppsättning | sträng (krävs) Begränsningar: Min längd = 1 Maxlängd = 100 |
| versionHeaderName | Namnet på HTTP-huvudparametern som anger API-versionen om versionshanteringScheme är inställt på header. |
sträng Begränsningar: Min längd = 1 Maxlängd = 100 |
| versionshanteringScheme | Ett värde som avgör var API-versionsidentifieraren ska finnas i en HTTP-begäran. | "Rubrik" "Fråga" Segment (krävs) |
| versionQueryName | Namnet på frågeparametern som anger API-versionen om versionshanteringScheme är inställt på query. |
sträng Begränsningar: Min längd = 1 Maxlängd = 100 |
Resursdefinition för ARM-mall
Resurstypen service/apiVersionSets kan distribueras med åtgärder som mål:
- Resursgrupper – Se resursgruppsdistributionskommandon
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.ApiManagement/service/apiVersionSets-resurs lägger du till följande JSON i mallen.
{
"type": "Microsoft.ApiManagement/service/apiVersionSets",
"apiVersion": "2023-09-01-preview",
"name": "string",
"properties": {
"description": "string",
"displayName": "string",
"versionHeaderName": "string",
"versioningScheme": "string",
"versionQueryName": "string"
}
}
Egenskapsvärden
service/apiVersionSets
| Namn | Beskrivning | Värde |
|---|---|---|
| typ | Resurstypen | "Microsoft.ApiManagement/service/apiVersionSets" |
| apiVersion | Resurs-API-versionen | "2023-09-01-preview" |
| Namn | Resursnamnet Se hur du anger namn och typer för underordnade resurser i JSON ARM-mallar. |
sträng (krävs) |
| Egenskaper | API-versionUppsättningskontraktegenskaper. | ApiVersionSetContractProperties |
ApiVersionSetContractProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| beskrivning | Beskrivning av API-versionsuppsättning. | sträng |
| displayName | Namn på API-versionsuppsättning | sträng (krävs) Begränsningar: Min längd = 1 Maxlängd = 100 |
| versionHeaderName | Namnet på HTTP-huvudparametern som anger API-versionen om versionshanteringScheme är inställt på header. |
sträng Begränsningar: Min längd = 1 Maxlängd = 100 |
| versionshanteringScheme | Ett värde som avgör var API-versionsidentifieraren ska finnas i en HTTP-begäran. | "Rubrik" "Fråga" Segment (krävs) |
| versionQueryName | Namnet på frågeparametern som anger API-versionen om versionshanteringScheme är inställt på query. |
sträng Begränsningar: Min längd = 1 Maxlängd = 100 |
Resursdefinition för Terraform (AzAPI-provider)
Resurstypen service/apiVersionSets kan distribueras med åtgärder som mål:
- Resursgrupper
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.ApiManagement/service/apiVersionSets-resurs lägger du till följande Terraform i mallen.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/apiVersionSets@2023-09-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
description = "string"
displayName = "string"
versionHeaderName = "string"
versioningScheme = "string"
versionQueryName = "string"
}
})
}
Egenskapsvärden
service/apiVersionSets
| Namn | Beskrivning | Värde |
|---|---|---|
| typ | Resurstypen | "Microsoft.ApiManagement/service/apiVersionSets@2023-09-01-preview" |
| Namn | Resursnamnet | sträng (krävs) |
| parent_id | ID för resursen som är överordnad för den här resursen. | ID för resurs av typen: tjänst |
| Egenskaper | API-versionUppsättningskontraktegenskaper. | ApiVersionSetContractProperties |
ApiVersionSetContractProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| beskrivning | Beskrivning av API-versionsuppsättning. | sträng |
| displayName | Namn på API-versionsuppsättning | sträng (krävs) Begränsningar: Min längd = 1 Maxlängd = 100 |
| versionHeaderName | Namnet på HTTP-huvudparametern som anger API-versionen om versionshanteringScheme är inställt på header. |
sträng Begränsningar: Min längd = 1 Maxlängd = 100 |
| versionshanteringScheme | Ett värde som avgör var API-versionsidentifieraren ska finnas i en HTTP-begäran. | "Rubrik" "Fråga" "Segment" (krävs) |
| versionQueryName | Namnet på frågeparametern som anger API-versionen om versionshanteringScheme är inställt på query. |
sträng Begränsningar: Min längd = 1 Maxlängd = 100 |