Microsoft.ApiManagement service/workspaces/apis/schemas 2023-03-01-preview
Definición de recursos de Bicep
El tipo de recurso service/workspaces/apis/schemas 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/workspaces/apis/schemas, agregue el siguiente bicep a la plantilla.
resource symbolicname 'Microsoft.ApiManagement/service/workspaces/apis/schemas@2023-03-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
contentType: 'string'
document: {
components: any()
definitions: any()
value: 'string'
}
}
}
Valores de propiedad
service/workspaces/apis/schemas
| 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: APIs |
| properties | Propiedades del esquema de API. | SchemaContractProperties |
SchemaContractProperties
| Nombre | Descripción | Valor |
|---|---|---|
| contentType | Debe ser un tipo de medio válido que se use en un encabezado Content-Type tal y como se define en rfc 2616. Tipo de medio del documento de esquema (por ejemplo, application/json, application/xml). - Swagger Uso del esquema application/vnd.ms-azure-apim.swagger.definitions+json - WSDL Uso del esquema application/vnd.ms-azure-apim.xsd+xml - OpenApi Uso del esquema application/vnd.oai.openapi.components+json - WADL Schema Uso application/vnd.ms-azure-apim.wadl.grammars+xml - OData Schema use application/vnd.ms-azure-apim.odata.schema. |
string (obligatorio) |
| documento | Cree o actualice las propiedades del documento de esquema de API. | SchemaDocumentProperties (obligatorio) |
SchemaDocumentProperties
| Nombre | Descripción | Valor |
|---|---|---|
| components | Definiciones de tipos. Se usa solo para esquemas swagger/OpenAPI v2/v3; de lo contrario, null. | Para Bicep, puede usar la función any(). |
| definitions | Definiciones de tipos. Se usa solo para esquemas swagger/OpenAPI v1; de lo contrario, null. | Para Bicep, puede usar la función any(). |
| value | Cadena de escape json que define el documento que representa el esquema. Se usa para esquemas distintos de Swagger/OpenAPI. | string |
Definición de recursos de plantilla de ARM
El tipo de recurso service/workspaces/apis/schemas 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/workspaces/apis/schemas, agregue el siguiente json a la plantilla.
{
"type": "Microsoft.ApiManagement/service/workspaces/apis/schemas",
"apiVersion": "2023-03-01-preview",
"name": "string",
"properties": {
"contentType": "string",
"document": {
"components": {},
"definitions": {},
"value": "string"
}
}
}
Valores de propiedad
service/workspaces/apis/schemas
| Nombre | Descripción | Value |
|---|---|---|
| type | Tipo de recurso | "Microsoft.ApiManagement/service/workspaces/apis/schemas" |
| apiVersion | La versión de la API de recursos | "2023-03-01-preview" |
| 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 esquema de API. | SchemaContractProperties |
SchemaContractProperties
| Nombre | Descripción | Valor |
|---|---|---|
| contentType | Debe ser un tipo de medio válido que se use en un encabezado Content-Type tal y como se define en rfc 2616. Tipo de medio del documento de esquema (por ejemplo, application/json, application/xml). - Swagger Uso del esquema application/vnd.ms-azure-apim.swagger.definitions+json - WSDL Uso del esquema application/vnd.ms-azure-apim.xsd+xml - OpenApi Uso del esquema application/vnd.oai.openapi.components+json - WADL Schema Uso application/vnd.ms-azure-apim.wadl.grammars+xml - OData Schema use application/vnd.ms-azure-apim.odata.schema. |
string (obligatorio) |
| documento | Cree o actualice las propiedades del documento de esquema de API. | SchemaDocumentProperties (obligatorio) |
SchemaDocumentProperties
| Nombre | Descripción | Valor |
|---|---|---|
| components | Definiciones de tipos. Se usa solo para esquemas swagger/OpenAPI v2/v3; de lo contrario, null. | |
| definitions | Definiciones de tipos. Se usa solo para esquemas swagger/OpenAPI v1; de lo contrario, null. | |
| value | Cadena de escape json que define el documento que representa el esquema. Se usa para esquemas distintos de Swagger/OpenAPI. | string |
Definición de recursos de Terraform (proveedor AzAPI)
El tipo de recurso service/workspaces/apis/schemas 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/workspaces/apis/schemas, agregue el siguiente terraform a la plantilla.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/workspaces/apis/schemas@2023-03-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
contentType = "string"
document = {
value = "string"
}
}
})
}
Valores de propiedad
service/workspaces/apis/schemas
| Nombre | Descripción | Value |
|---|---|---|
| type | Tipo de recurso | "Microsoft.ApiManagement/service/workspaces/apis/schemas@2023-03-01-preview" |
| 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: APIs |
| properties | Propiedades del esquema de API. | SchemaContractProperties |
SchemaContractProperties
| Nombre | Descripción | Valor |
|---|---|---|
| contentType | Debe ser un tipo de medio válido que se use en un encabezado Content-Type tal y como se define en rfc 2616. Tipo de medio del documento de esquema (por ejemplo, application/json, application/xml). - Swagger Uso del esquema application/vnd.ms-azure-apim.swagger.definitions+json - WSDL Uso del esquema application/vnd.ms-azure-apim.xsd+xml - OpenApi Uso del esquema application/vnd.oai.openapi.components+json - WADL Schema Uso application/vnd.ms-azure-apim.wadl.grammars+xml - OData Schema use application/vnd.ms-azure-apim.odata.schema. |
string (obligatorio) |
| documento | Cree o actualice las propiedades del documento de esquema de API. | SchemaDocumentProperties (obligatorio) |
SchemaDocumentProperties
| Nombre | Descripción | Valor |
|---|---|---|
| components | Definiciones de tipos. Se usa solo para esquemas swagger/OpenAPI v2/v3; de lo contrario, null. | |
| definitions | Definiciones de tipos. Se usa solo para esquemas swagger/OpenAPI v1; de lo contrario, null. | |
| value | Cadena de escape json que define el documento que representa el esquema. Se usa para esquemas distintos de Swagger/OpenAPI. | string |