Compartir a través de

Microsoft.ApiManagement service/apiVersionSets

  • Artículo

Definición de recursos de Bicep

El tipo de recurso service/apiVersionSets se puede implementar con operaciones que tienen como destino:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.ApiManagement/service/apiVersionSets, agregue el siguiente bicep a la plantilla.

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'
  }
}

Valores de propiedad

service/apiVersionSets

Nombre Descripción Valor
nombre El nombre del recurso

Vea cómo establecer nombres y tipos para recursos secundarios en Bicep.		 string (obligatorio)
padre 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 obtener más información, consulte recurso secundario fuera del recurso primario.		 Nombre simbólico del recurso de tipo: de servicio de
Propiedades Propiedades de contrato de API VersionSet. ApiVersionSetContractProperties

ApiVersionSetContractProperties

Nombre Descripción Valor
descripción Descripción del conjunto de versiones de API. cuerda
displayName Nombre del conjunto de versiones de API string (obligatorio)

Restricciones:
Longitud mínima = 1
Longitud máxima = 100
versionHeaderName Nombre del parámetro de encabezado HTTP que indica la versión de API si versioningScheme está establecido en header. cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 100
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. cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 100

Definición de recursos de plantilla de ARM

El tipo de recurso service/apiVersionSets se puede implementar con operaciones que tienen como destino:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.ApiManagement/service/apiVersionSets, agregue el siguiente JSON a la plantilla.

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

Valores de propiedad

service/apiVersionSets

Nombre Descripción Valor
tipo El tipo de recurso 'Microsoft.ApiManagement/service/apiVersionSets'
apiVersion La versión de la API de recursos '2023-09-01-preview'
nombre El nombre del recurso

Vea cómo establecer nombres y tipos para recursos secundarios en plantillas de ARM json.		 string (obligatorio)
Propiedades Propiedades de contrato de API VersionSet. ApiVersionSetContractProperties

ApiVersionSetContractProperties

Nombre Descripción Valor
descripción Descripción del conjunto de versiones de API. cuerda
displayName Nombre del conjunto de versiones de API string (obligatorio)

Restricciones:
Longitud mínima = 1
Longitud máxima = 100
versionHeaderName Nombre del parámetro de encabezado HTTP que indica la versión de API si versioningScheme está establecido en header. cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 100
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. cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 100

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso service/apiVersionSets se puede implementar con operaciones que tienen como destino:

  • grupos de recursos de

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.ApiManagement/service/apiVersionSets, agregue el siguiente terraform a la plantilla.

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"
    }
  })
}

Valores de propiedad

service/apiVersionSets

Nombre Descripción Valor
tipo El tipo de recurso "Microsoft.ApiManagement/service/apiVersionSets@2023-09-01-preview"
nombre El nombre del recurso string (obligatorio)
parent_id Identificador del recurso que es el elemento primario de este recurso. Identificador del recurso de tipo: de servicio de
Propiedades Propiedades de contrato de API VersionSet. ApiVersionSetContractProperties

ApiVersionSetContractProperties

Nombre Descripción Valor
descripción Descripción del conjunto de versiones de API. cuerda
displayName Nombre del conjunto de versiones de API string (obligatorio)

Restricciones:
Longitud mínima = 1
Longitud máxima = 100
versionHeaderName Nombre del parámetro de encabezado HTTP que indica la versión de API si versioningScheme está establecido en header. cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 100
versioningScheme Valor que determina dónde se ubicará el identificador de la versión de LA API en una solicitud HTTP. "Encabezado"
"Consulta"
"Segment" (obligatorio)
versionQueryName Nombre del parámetro de consulta que indica la versión de API si versioningScheme está establecido en query. cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 100