Microsoft.ApiManagement service/workspaces/apis/schemas 2023-05-01-preview
El tipo de recurso service/workspaces/apis/schemas se puede implementar con operaciones destinadas a:
- grupos de recursos: consulte comandos de implementación de grupos de recursos
Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.
Para crear un recurso Microsoft.ApiManagement/service/workspaces/apis/schemas, agregue la siguiente bicep a la plantilla.
Bicep
resource symbolicname 'Microsoft.ApiManagement/service/workspaces/apis/schemas@2023-05-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
contentType: 'string'
document: {
components: any(...)
definitions: any(...)
value: 'string'
}
}
}
| Nombre | Descripción | Valor |
|---|---|---|
| nombre | El nombre del recurso | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 80 (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/workspaces/apis |
| Propiedades | Propiedades del esquema de API. | 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) |
| 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 |
El tipo de recurso service/workspaces/apis/schemas se puede implementar con operaciones destinadas a:
- grupos de recursos: consulte comandos de implementación de grupos de recursos
Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.
Para crear un recurso Microsoft.ApiManagement/service/workspaces/apis/schemas, agregue el siguiente JSON a la plantilla.
JSON
{
"type": "Microsoft.ApiManagement/service/workspaces/apis/schemas",
"apiVersion": "2023-05-01-preview",
"name": "string",
"properties": {
"contentType": "string",
"document": {
"components": {},
"definitions": {},
"value": "string"
}
}
}
| 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 = 80 (obligatorio) |
| Propiedades | Propiedades del esquema de API. | schemaContractProperties |
| tipo | El tipo de recurso | "Microsoft.ApiManagement/service/workspaces/apis/schemas" |
| 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) |
| 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 |
El tipo de recurso service/workspaces/apis/schemas se puede implementar con operaciones destinadas a:
- grupos de recursos de
Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.
Para crear un recurso Microsoft.ApiManagement/service/workspaces/apis/schemas, agregue el siguiente terraform a la plantilla.
Terraform
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/workspaces/apis/schemas@2023-05-01-preview"
name = "string"
body = jsonencode({
properties = {
contentType = "string"
document = {
components = ?
definitions = ?
value = "string"
}
}
})
}
| Nombre | Descripción | Valor |
|---|---|---|
| nombre | El nombre del recurso | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 80 (obligatorio) |
| parent_id | Identificador del recurso que es el elemento primario de este recurso. | Identificador del recurso de tipo: service/workspaces/apis |
| Propiedades | Propiedades del esquema de API. | schemaContractProperties |
| tipo | El tipo de recurso | "Microsoft.ApiManagement/service/workspaces/apis/schemas@2023-05-01-preview" |
| 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) |
| 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 |