Servicio Microsoft.ApiManagement/apiVersionSets 2022-08-01
Definición de recursos de Bicep
El tipo de recurso service/apiVersionSets se puede implementar con operaciones destinadas a:
- Grupos de recursos: consulte los comandos de implementación del grupo de recursos.
Para obtener una lista de las propiedades modificadas en cada versión de api, consulte registro de cambios.
Formato de los recursos
Para crear un recurso Microsoft.ApiManagement/service/apiVersionSets, agregue el siguiente bicep a la plantilla.
resource symbolicname 'Microsoft.ApiManagement/service/apiVersionSets@2022-08-01' = {
name: 'string'
parent: resourceSymbolicName
properties: {
description: 'string'
displayName: 'string'
versionHeaderName: 'string'
versioningScheme: 'string'
versionQueryName: 'string'
}
}
Valores de propiedad
service/apiVersionSets
Nombre | Descripción | Value |
---|---|---|
name | El nombre del recurso Vea cómo establecer nombres y tipos para recursos secundarios en Bicep. |
string (obligatorio) |
primario | En Bicep, puede especificar el recurso primario para un recurso secundario. Solo tiene que agregar esta propiedad cuando el recurso secundario se declara fuera del recurso primario. Para más información, consulte Recurso secundario fuera del recurso primario. |
Nombre simbólico del recurso de tipo: servicio |
properties | Propiedades del contrato de API VersionSet. | ApiVersionSetContractProperties |
ApiVersionSetContractProperties
Nombre | Descripción | Valor |
---|---|---|
description | Descripción del conjunto de versiones de API. | string |
DisplayName | Nombre del conjunto de versiones de API | string (obligatorio) |
versionHeaderName | Nombre del parámetro de encabezado HTTP que indica la versión de la API si versioningScheme está establecido header en . |
string |
versioningScheme | Valor que determina dónde se ubicará el identificador de la versión de la API en una solicitud HTTP. | 'Encabezado' 'Query' 'Segment' (obligatorio) |
versionQueryName | Nombre del parámetro de consulta que indica la versión de la API si versioningScheme está establecido query en . |
string |
Definición de recursos de plantilla de ARM
El tipo de recurso service/apiVersionSets se puede implementar con operaciones destinadas a:
- Grupos de recursos: consulte los comandos de implementación del grupo de recursos.
Para obtener una lista de las propiedades modificadas en cada versión de api, consulte registro de cambios.
Formato de los recursos
Para crear un recurso Microsoft.ApiManagement/service/apiVersionSets, agregue el siguiente json a la plantilla.
{
"type": "Microsoft.ApiManagement/service/apiVersionSets",
"apiVersion": "2022-08-01",
"name": "string",
"properties": {
"description": "string",
"displayName": "string",
"versionHeaderName": "string",
"versioningScheme": "string",
"versionQueryName": "string"
}
}
Valores de propiedad
service/apiVersionSets
Nombre | Descripción | Value |
---|---|---|
type | Tipo de recurso | "Microsoft.ApiManagement/service/apiVersionSets" |
apiVersion | La versión de la API de recursos | '2022-08-01' |
name | El nombre del recurso Consulte cómo establecer nombres y tipos para recursos secundarios en plantillas de ARM json. |
string (obligatorio) |
properties | Propiedades del contrato de API VersionSet. | ApiVersionSetContractProperties |
ApiVersionSetContractProperties
Nombre | Descripción | Valor |
---|---|---|
description | Descripción del conjunto de versiones de API. | string |
DisplayName | Nombre del conjunto de versiones de API | string (obligatorio) |
versionHeaderName | Nombre del parámetro de encabezado HTTP que indica la versión de la API si versioningScheme está establecido header en . |
string |
versioningScheme | Valor que determina dónde se ubicará el identificador de la versión de la API en una solicitud HTTP. | 'Encabezado' 'Query' 'Segment' (obligatorio) |
versionQueryName | Nombre del parámetro de consulta que indica la versión de API si versioningScheme está establecido en query . |
string |
Definición de recursos de Terraform (proveedor AzAPI)
El tipo de recurso service/apiVersionSets se puede implementar con operaciones destinadas a:
- Grupos de recursos
Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.
Formato de los recursos
Para crear un recurso Microsoft.ApiManagement/service/apiVersionSets, agregue el siguiente terraform a la plantilla.
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"
}
})
}
Valores de propiedad
service/apiVersionSets
Nombre | Descripción | Value |
---|---|---|
type | Tipo de recurso | "Microsoft.ApiManagement/service/apiVersionSets@2022-08-01" |
name | El nombre del recurso | string (obligatorio) |
parent_id | Identificador del recurso que es el elemento primario de este recurso. | Identificador del recurso de tipo: servicio |
properties | Propiedades del contrato de API VersionSet. | ApiVersionSetContractProperties |
ApiVersionSetContractProperties
Nombre | Descripción | Valor |
---|---|---|
description | Descripción del conjunto de versiones de API. | string |
DisplayName | Nombre del conjunto de versiones de API | string (obligatorio) |
versionHeaderName | Nombre del parámetro de encabezado HTTP que indica la versión de la API si versioningScheme está establecido header en . |
string |
control de versionesScheme | Valor que determina dónde se ubicará el identificador de la versión de API en una solicitud HTTP. | "Header" "Consulta" "Segmento" (obligatorio) |
versionQueryName | Nombre del parámetro de consulta que indica la versión de API si versioningScheme está establecido en query . |
string |