Compartir a través de

Microsoft.ApiManagement service/api-version-sets 2018-01-01

  • Artículo

Definición de recursos de Bicep

El tipo de recurso service/api-version-sets 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/api-version-sets, agregue el siguiente bicep a la plantilla.

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

Valores de propiedad

ApiVersionSetContractProperties

Nombre Descripción Valor
descripción Descripción del conjunto de versiones de API. cuerda
displayName Nombre del conjunto de versiones de API cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 1 (obligatorio)
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 = 1
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 = 1

Microsoft.ApiManagement/service/api-version-sets

Nombre Descripción Valor
nombre El nombre del recurso cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 1
Patrón = (^[\w]+$)|(^[\w][\w\-]+[\w]$) (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 del contrato Api VersionSet. ApiVersionSetContractProperties

Definición de recursos de plantilla de ARM

El tipo de recurso service/api-version-sets 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/api-version-sets, agregue el siguiente JSON a la plantilla.

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

Valores de propiedad

ApiVersionSetContractProperties

Nombre Descripción Valor
descripción Descripción del conjunto de versiones de API. cuerda
displayName Nombre del conjunto de versiones de API cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 1 (obligatorio)
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 = 1
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 = 1

Microsoft.ApiManagement/service/api-version-sets

Nombre Descripción Valor
apiVersion La versión de api '2018-01-01'
nombre El nombre del recurso cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 1
Patrón = (^[\w]+$)|(^[\w][\w\-]+[\w]$) (obligatorio)
Propiedades Propiedades del contrato Api VersionSet. ApiVersionSetContractProperties
tipo El tipo de recurso 'Microsoft.ApiManagement/service/api-version-sets'

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso service/api-version-sets 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/api-version-sets, agregue el siguiente terraform a la plantilla.

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

Valores de propiedad

ApiVersionSetContractProperties

Nombre Descripción Valor
descripción Descripción del conjunto de versiones de API. cuerda
displayName Nombre del conjunto de versiones de API cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 1 (obligatorio)
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 = 1
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 = 1

Microsoft.ApiManagement/service/api-version-sets

Nombre Descripción Valor
nombre El nombre del recurso cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 1
Patrón = (^[\w]+$)|(^[\w][\w\-]+[\w]$) (obligatorio)
parent_id Identificador del recurso que es el elemento primario de este recurso. Identificador del recurso de tipo: de servicio de
Propiedades Propiedades del contrato Api VersionSet. ApiVersionSetContractProperties
tipo El tipo de recurso "Microsoft.ApiManagement/service/api-version-sets@2018-01-01"