Microsoft.ApiManagement service/workspaces/apis/schemas 2023-09-01-preview
Bicep-resursdefinition
Resurstypen tjänst/arbetsytor/apis/scheman kan distribueras med åtgärder som mål:
- Resursgrupper – Se resursgruppsdistributionskommandon
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.ApiManagement/service/workspaces/apis/schemas-resurs lägger du till följande Bicep i mallen.
resource symbolicname 'Microsoft.ApiManagement/service/workspaces/apis/schemas@2023-09-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'
}
}
}
Egenskapsvärden
Microsoft.ApiManagement/service/workspaces/apis/schemas
| Namn | Beskrivning | Värde |
|---|---|---|
| Namn | Resursnamnet | sträng Begränsningar: Min längd = 1 Maximal längd = 1 (krävs) |
| förälder | I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen. Mer information finns i Underordnad resurs utanför den överordnade resursen. |
Symboliskt namn för resurs av typen: tjänst/arbetsytor/API:ar |
| Egenskaper | Egenskaper för API-schemat. | SchemaContractProperties |
SchemaContractProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| contentType | Måste vara en giltig medietyp som används i ett content-type-huvud enligt definitionen i RFC 2616. Medietyp för schemadokumentet (t.ex. application/json, application/xml). - Swagger schemaanvändning application/vnd.ms-azure-apim.swagger.definitions+json - WSDL schemaanvändning application/vnd.ms-azure-apim.xsd+xml - OpenApi schemaanvändning application/vnd.oai.openapi.components+json - WADL Schema använda application/vnd.ms-azure-apim.wadl.grammars+xml - OData Schema använda application/vnd.ms-azure-apim.odata.schema - gRPC Schema använda text/protobuf. |
sträng (krävs) |
| dokument | Skapa eller uppdatera egenskaper för API-schemadokumentet. | SchemaDocumentProperties (krävs) |
SchemaDocumentProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| Komponenter | Typer av definitioner. Används endast för Swagger/OpenAPI v2/v3-scheman, annars null. | någon |
| Definitioner | Typer av definitioner. Används endast för Swagger/OpenAPI v1-scheman, annars null. | någon |
| värde | Json-undantagen sträng som definierar dokumentet som representerar schemat. Används för andra scheman än Swagger/OpenAPI. | sträng |
Resursdefinition för ARM-mall
Resurstypen tjänst/arbetsytor/apis/scheman kan distribueras med åtgärder som mål:
- Resursgrupper – Se resursgruppsdistributionskommandon
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.ApiManagement/service/workspaces/apis/schemas-resurs lägger du till följande JSON i mallen.
{
"type": "Microsoft.ApiManagement/service/workspaces/apis/schemas",
"apiVersion": "2023-09-01-preview",
"name": "string",
"properties": {
"contentType": "string",
"document": {
"components": {},
"definitions": {},
"value": "string"
}
}
}
Egenskapsvärden
Microsoft.ApiManagement/service/workspaces/apis/schemas
| Namn | Beskrivning | Värde |
|---|---|---|
| apiVersion | API-versionen | "2023-09-01-preview" |
| Namn | Resursnamnet | sträng Begränsningar: Min längd = 1 Maximal längd = 1 (krävs) |
| Egenskaper | Egenskaper för API-schemat. | SchemaContractProperties |
| typ | Resurstypen | "Microsoft.ApiManagement/service/workspaces/apis/schemas" |
SchemaContractProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| contentType | Måste vara en giltig medietyp som används i ett content-type-huvud enligt definitionen i RFC 2616. Medietyp för schemadokumentet (t.ex. application/json, application/xml). - Swagger schemaanvändning application/vnd.ms-azure-apim.swagger.definitions+json - WSDL schemaanvändning application/vnd.ms-azure-apim.xsd+xml - OpenApi schemaanvändning application/vnd.oai.openapi.components+json - WADL Schema använda application/vnd.ms-azure-apim.wadl.grammars+xml - OData Schema använda application/vnd.ms-azure-apim.odata.schema - gRPC Schema använda text/protobuf. |
sträng (krävs) |
| dokument | Skapa eller uppdatera egenskaper för API-schemadokumentet. | SchemaDocumentProperties (krävs) |
SchemaDocumentProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| Komponenter | Typer av definitioner. Används endast för Swagger/OpenAPI v2/v3-scheman, annars null. | någon |
| Definitioner | Typer av definitioner. Används endast för Swagger/OpenAPI v1-scheman, annars null. | någon |
| värde | Json-undantagen sträng som definierar dokumentet som representerar schemat. Används för andra scheman än Swagger/OpenAPI. | sträng |
Resursdefinition för Terraform (AzAPI-provider)
Resurstypen tjänst/arbetsytor/apis/scheman kan distribueras med åtgärder som mål:
- Resursgrupper
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.ApiManagement/service/workspaces/apis/schemas-resurs lägger du till följande Terraform i mallen.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/workspaces/apis/schemas@2023-09-01-preview"
name = "string"
body = jsonencode({
properties = {
contentType = "string"
document = {
components = ?
definitions = ?
value = "string"
}
}
})
}
Egenskapsvärden
Microsoft.ApiManagement/service/workspaces/apis/schemas
| Namn | Beskrivning | Värde |
|---|---|---|
| Namn | Resursnamnet | sträng Begränsningar: Min längd = 1 Maximal längd = 1 (krävs) |
| parent_id | ID för resursen som är överordnad för den här resursen. | ID för resurs av typen: tjänst/arbetsytor/API:ar |
| Egenskaper | Egenskaper för API-schemat. | SchemaContractProperties |
| typ | Resurstypen | "Microsoft.ApiManagement/service/workspaces/apis/schemas@2023-09-01-preview" |
SchemaContractProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| contentType | Måste vara en giltig medietyp som används i ett content-type-huvud enligt definitionen i RFC 2616. Medietyp för schemadokumentet (t.ex. application/json, application/xml). - Swagger schemaanvändning application/vnd.ms-azure-apim.swagger.definitions+json - WSDL schemaanvändning application/vnd.ms-azure-apim.xsd+xml - OpenApi schemaanvändning application/vnd.oai.openapi.components+json - WADL Schema använda application/vnd.ms-azure-apim.wadl.grammars+xml - OData Schema använda application/vnd.ms-azure-apim.odata.schema - gRPC Schema använda text/protobuf. |
sträng (krävs) |
| dokument | Skapa eller uppdatera egenskaper för API-schemadokumentet. | SchemaDocumentProperties (krävs) |
SchemaDocumentProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| Komponenter | Typer av definitioner. Används endast för Swagger/OpenAPI v2/v3-scheman, annars null. | någon |
| Definitioner | Typer av definitioner. Används endast för Swagger/OpenAPI v1-scheman, annars null. | någon |
| värde | Json-undantagen sträng som definierar dokumentet som representerar schemat. Används för andra scheman än Swagger/OpenAPI. | sträng |