Compartir a través de

Microsoft.ApiManagement service/apis/schemas 2023-05-01-preview

  • Artículo

Definición de recursos de Bicep

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

resource symbolicname 'Microsoft.ApiManagement/service/apis/schemas@2023-05-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    contentType: 'string'
    document: {
      components: any(Azure.Bicep.Types.Concrete.AnyType)
      definitions: any(Azure.Bicep.Types.Concrete.AnyType)
      value: 'string'
    }
  }
}

Valores de propiedad

Microsoft.ApiManagement/service/apis/schemas

Nombre Descripción Valor
nombre El nombre del recurso cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 1 (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: service/apis
Propiedades Propiedades del esquema de API. schemaContractProperties

SchemaContractProperties

Nombre Descripción Valor
contentType Debe ser un tipo de medio válido que se usa en un encabezado Content-Type tal como se define en RFC 2616. Tipo de medio del documento de esquema (por ejemplo, application/json, application/xml).
- Swagger esquema application/vnd.ms-azure-apim.swagger.definitions+json
- WSDL esquema application/vnd.ms-azure-apim.xsd+xml
- OpenApi esquema application/vnd.oai.openapi.components+json
- WADL Schema usar application/vnd.ms-azure-apim.wadl.grammars+xml
- OData Schema usar application/vnd.ms-azure-apim.odata.schema
- gRPC Schema usar text/protobuf.		 string (obligatorio)
documento Cree o actualice las propiedades del documento de esquema de API. schemaDocumentProperties (obligatorio)

SchemaDocumentProperties

Nombre Descripción Valor
Componentes Definiciones de tipos. Se usa solo para esquemas swagger/OpenAPI v2/v3; de lo contrario, es NULL. cualquier
Definiciones Definiciones de tipos. Se usa solo para esquemas swagger/OpenAPI v1; de lo contrario, es NULL. cualquier
valor Cadena de escape json que define el documento que representa el esquema. Se usa para esquemas distintos de Swagger/OpenAPI. cuerda

Definición de recursos de plantilla de ARM

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

{
  "type": "Microsoft.ApiManagement/service/apis/schemas",
  "apiVersion": "2023-05-01-preview",
  "name": "string",
  "properties": {
    "contentType": "string",
    "document": {
      "components": {},
      "definitions": {},
      "value": "string"
    }
  }
}

Valores de propiedad

Microsoft.ApiManagement/service/apis/schemas

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

Restricciones:
Longitud mínima = 1
Longitud máxima = 1 (obligatorio)
Propiedades Propiedades del esquema de API. schemaContractProperties
tipo El tipo de recurso 'Microsoft.ApiManagement/service/apis/schemas'

SchemaContractProperties

Nombre Descripción Valor
contentType Debe ser un tipo de medio válido que se usa en un encabezado Content-Type tal como se define en RFC 2616. Tipo de medio del documento de esquema (por ejemplo, application/json, application/xml).
- Swagger esquema application/vnd.ms-azure-apim.swagger.definitions+json
- WSDL esquema application/vnd.ms-azure-apim.xsd+xml
- OpenApi esquema application/vnd.oai.openapi.components+json
- WADL Schema usar application/vnd.ms-azure-apim.wadl.grammars+xml
- OData Schema usar application/vnd.ms-azure-apim.odata.schema
- gRPC Schema usar text/protobuf.		 string (obligatorio)
documento Cree o actualice las propiedades del documento de esquema de API. schemaDocumentProperties (obligatorio)

SchemaDocumentProperties

Nombre Descripción Valor
Componentes Definiciones de tipos. Se usa solo para esquemas swagger/OpenAPI v2/v3; de lo contrario, es NULL. cualquier
Definiciones Definiciones de tipos. Se usa solo para esquemas swagger/OpenAPI v1; de lo contrario, es NULL. cualquier
valor Cadena de escape json que define el documento que representa el esquema. Se usa para esquemas distintos de Swagger/OpenAPI. cuerda

Definición de recursos de Terraform (proveedor AzAPI)

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis/schemas@2023-05-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      contentType = "string"
      document = {
        components = ?
        definitions = ?
        value = "string"
      }
    }
  })
}

Valores de propiedad

Microsoft.ApiManagement/service/apis/schemas

Nombre Descripción Valor
nombre El nombre del recurso cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 1 (obligatorio)
parent_id Identificador del recurso que es el elemento primario de este recurso. Identificador del recurso de tipo: service/apis
Propiedades Propiedades del esquema de API. schemaContractProperties
tipo El tipo de recurso "Microsoft.ApiManagement/service/apis/schemas@2023-05-01-preview"

SchemaContractProperties

Nombre Descripción Valor
contentType Debe ser un tipo de medio válido que se usa en un encabezado Content-Type tal como se define en RFC 2616. Tipo de medio del documento de esquema (por ejemplo, application/json, application/xml).
- Swagger esquema application/vnd.ms-azure-apim.swagger.definitions+json
- WSDL esquema application/vnd.ms-azure-apim.xsd+xml
- OpenApi esquema application/vnd.oai.openapi.components+json
- WADL Schema usar application/vnd.ms-azure-apim.wadl.grammars+xml
- OData Schema usar application/vnd.ms-azure-apim.odata.schema
- gRPC Schema usar text/protobuf.		 string (obligatorio)
documento Cree o actualice las propiedades del documento de esquema de API. schemaDocumentProperties (obligatorio)

SchemaDocumentProperties

Nombre Descripción Valor
Componentes Definiciones de tipos. Se usa solo para esquemas swagger/OpenAPI v2/v3; de lo contrario, es NULL. cualquier
Definiciones Definiciones de tipos. Se usa solo para esquemas swagger/OpenAPI v1; de lo contrario, es NULL. cualquier
valor Cadena de escape json que define el documento que representa el esquema. Se usa para esquemas distintos de Swagger/OpenAPI. cuerda