Microsoft.ApiManagement service/workspaces/apis/schemas 2023-05-01-preview
Bicep-resursdefinition
Resurstypen service/workspaces/apis/schemas kan distribueras med åtgärder som mål:
- Resursgrupper – Se distributionskommandon för 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 Bicep i mallen.
resource symbolicname 'Microsoft.ApiManagement/service/workspaces/apis/schemas@2023-05-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
contentType: 'string'
document: {
components: any()
definitions: any()
value: 'string'
}
}
}
Egenskapsvärden
service/workspaces/apis/scheman
Name | Beskrivning | Värde |
---|---|---|
name | Resursnamnet Se hur du anger namn och typer för underordnade resurser i Bicep. |
sträng (krävs) |
parent | 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 överordnad resurs. |
Symboliskt namn för resurs av typen: apis |
properties | Egenskaper för API-schemat. | SchemaContractEgenskaper |
SchemaContractEgenskaper
Name | Beskrivning | Värde |
---|---|---|
Contenttype | Måste vara en giltig medietyp som används i ett innehållstypshuvud 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änd text/protobuf . |
sträng (krävs) |
dokument | Skapa eller uppdatera egenskaper för API-schemadokumentet. | SchemaDocumentProperties (krävs) |
SchemaDocumentEgenskaper
Name | Beskrivning | Värde |
---|---|---|
Komponenter | Typer av definitioner. Används endast för Swagger/OpenAPI v2/v3-scheman, annars null. | För Bicep kan du använda funktionen any(). |
definitioner | Typer av definitioner. Används endast för Swagger/OpenAPI v1-scheman, annars null. | För Bicep kan du använda funktionen any(). |
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 service/workspaces/apis/schemas kan distribueras med åtgärder som mål:
- Resursgrupper – Se distributionskommandon för resursgrupper
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Resurs för Microsoft.ApiManagement/service/workspaces/apis/schemas lägger du till följande JSON i mallen.
{
"type": "Microsoft.ApiManagement/service/workspaces/apis/schemas",
"apiVersion": "2023-05-01-preview",
"name": "string",
"properties": {
"contentType": "string",
"document": {
"components": {},
"definitions": {},
"value": "string"
}
}
}
Egenskapsvärden
service/workspaces/apis/scheman
Name | Beskrivning | Värde |
---|---|---|
typ | Resurstypen | "Microsoft.ApiManagement/service/workspaces/apis/schemas" |
apiVersion | Resurs-API-versionen | "2023-05-01-preview" |
name | Resursnamnet Se hur du anger namn och typer för underordnade resurser i JSON ARM-mallar. |
sträng (krävs) |
properties | Egenskaper för API-schemat. | SchemaContractEgenskaper |
SchemaContractEgenskaper
Name | Beskrivning | Värde |
---|---|---|
Contenttype | Måste vara en giltig medietyp som används i ett innehållstypshuvud 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änd text/protobuf . |
sträng (krävs) |
dokument | Skapa eller uppdatera egenskaper för API-schemadokumentet. | SchemaDocumentProperties (krävs) |
SchemaDocumentEgenskaper
Name | Beskrivning | Värde |
---|---|---|
Komponenter | Typer av definitioner. Används endast för Swagger/OpenAPI v2/v3-scheman, annars null. | |
definitioner | Typer av definitioner. Används endast för Swagger/OpenAPI v1-scheman, annars null. | |
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 service/workspaces/apis/schemas 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 Resurs för Microsoft.ApiManagement/service/workspaces/apis/schemas lägger du till följande Terraform i mallen.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/workspaces/apis/schemas@2023-05-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
contentType = "string"
document = {
value = "string"
}
}
})
}
Egenskapsvärden
service/workspaces/apis/scheman
Name | Beskrivning | Värde |
---|---|---|
typ | Resurstypen | "Microsoft.ApiManagement/service/workspaces/apis/schemas@2023-05-01-preview" |
name | Resursnamnet | sträng (krävs) |
parent_id | ID:t för resursen som är överordnad för den här resursen. | ID för resurs av typen: apis |
properties | Egenskaper för API-schemat. | SchemaContractEgenskaper |
SchemaContractEgenskaper
Name | Beskrivning | Värde |
---|---|---|
Contenttype | Måste vara en giltig medietyp som används i ett innehållstypshuvud 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änd text/protobuf . |
sträng (krävs) |
dokument | Skapa eller uppdatera egenskaper för API-schemadokumentet. | SchemaDocumentProperties (krävs) |
SchemaDocumentEgenskaper
Name | Beskrivning | Värde |
---|---|---|
Komponenter | Typer av definitioner. Används endast för Swagger/OpenAPI v2/v3-scheman, annars null. | |
definitioner | Typer av definitioner. Används endast för Swagger/OpenAPI v1-scheman, annars null. | |
värde | Json-undantagen sträng som definierar dokumentet som representerar schemat. Används för andra scheman än Swagger/OpenAPI. | sträng |
Feedback
https://aka.ms/ContentUserFeedback.
Kommer snart: Under hela 2024 kommer vi att fasa ut GitHub-problem som feedbackmekanism för innehåll och ersätta det med ett nytt feedbacksystem. Mer information finns i:Skicka och visa feedback för