Microsoft.ApiManagement service/workspaces/apis/schemas 2023-09-01-preview
Bicep-resourcedefinitie
Het resourcetype service/werkruimten/apis/schema's kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen - Zie opdrachten voor de implementatie van resourcegroepen
Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Resource microsoft.ApiManagement/service/workspaces/apis/schemas wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.
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'
}
}
}
Eigenschapswaarden
Microsoft.ApiManagement/service/workspaces/apis/schema's
| Naam | Beschrijving | Waarde |
|---|---|---|
| naam | De resourcenaam | string Beperkingen: Minimale lengte = 1 Maximale lengte = 1 (vereist) |
| ouder | In Bicep kunt u de bovenliggende resource voor een onderliggende resource opgeven. U hoeft deze eigenschap alleen toe te voegen wanneer de onderliggende resource buiten de bovenliggende resource wordt gedeclareerd. Zie onderliggende resource buiten de bovenliggende resourcevoor meer informatie. |
Symbolische naam voor resource van het type: service/werkruimten/api's |
| Eigenschappen | Eigenschappen van het API-schema. | SchemaContractProperties- |
SchemaContractProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| contentType | Moet een geldig mediatype zijn dat wordt gebruikt in een Content-Type-header, zoals gedefinieerd in rfc 2616. Mediatype van het schemadocument (bijvoorbeeld application/json, application/xml). - Swagger schema gebruiken application/vnd.ms-azure-apim.swagger.definitions+json - WSDL schema gebruiken application/vnd.ms-azure-apim.xsd+xml - OpenApi schema gebruiken application/vnd.oai.openapi.components+json - WADL Schema
application/vnd.ms-azure-apim.wadl.grammars+xml gebruiken - OData Schema
application/vnd.ms-azure-apim.odata.schema gebruiken - gRPC Schema
text/protobufgebruiken. |
tekenreeks (vereist) |
| document | Eigenschappen van het API-schemadocument maken of bijwerken. | SchemaDocumentProperties- (vereist) |
SchemaDocumentProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| Onderdelen | Typen definities. Wordt alleen gebruikt voor Swagger/OpenAPI v2/v3-schema's, anders null. | enig |
| definities | Typen definities. Wordt alleen gebruikt voor Swagger/OpenAPI v1-schema's, anders null. | enig |
| waarde | Json-tekenreeks met escape-tekenreeks die het document definieert dat het schema vertegenwoordigt. Wordt gebruikt voor andere schema's dan Swagger/OpenAPI. | snaar |
Resourcedefinitie van ARM-sjabloon
Het resourcetype service/werkruimten/apis/schema's kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen - Zie opdrachten voor de implementatie van resourcegroepen
Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een resource voor Microsoft.ApiManagement/service/workspaces/apis/schema's wilt maken, voegt u de volgende JSON toe aan uw sjabloon.
{
"type": "Microsoft.ApiManagement/service/workspaces/apis/schemas",
"apiVersion": "2023-09-01-preview",
"name": "string",
"properties": {
"contentType": "string",
"document": {
"components": {},
"definitions": {},
"value": "string"
}
}
}
Eigenschapswaarden
Microsoft.ApiManagement/service/workspaces/apis/schema's
| Naam | Beschrijving | Waarde |
|---|---|---|
| apiVersion | De API-versie | '2023-09-01-preview' |
| naam | De resourcenaam | string Beperkingen: Minimale lengte = 1 Maximale lengte = 1 (vereist) |
| Eigenschappen | Eigenschappen van het API-schema. | SchemaContractProperties- |
| type | Het resourcetype | 'Microsoft.ApiManagement/service/workspaces/apis/schema's' |
SchemaContractProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| contentType | Moet een geldig mediatype zijn dat wordt gebruikt in een Content-Type-header, zoals gedefinieerd in rfc 2616. Mediatype van het schemadocument (bijvoorbeeld application/json, application/xml). - Swagger schema gebruiken application/vnd.ms-azure-apim.swagger.definitions+json - WSDL schema gebruiken application/vnd.ms-azure-apim.xsd+xml - OpenApi schema gebruiken application/vnd.oai.openapi.components+json - WADL Schema
application/vnd.ms-azure-apim.wadl.grammars+xml gebruiken - OData Schema
application/vnd.ms-azure-apim.odata.schema gebruiken - gRPC Schema
text/protobufgebruiken. |
tekenreeks (vereist) |
| document | Eigenschappen van het API-schemadocument maken of bijwerken. | SchemaDocumentProperties- (vereist) |
SchemaDocumentProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| Onderdelen | Typen definities. Wordt alleen gebruikt voor Swagger/OpenAPI v2/v3-schema's, anders null. | enig |
| definities | Typen definities. Wordt alleen gebruikt voor Swagger/OpenAPI v1-schema's, anders null. | enig |
| waarde | Json-tekenreeks met escape-tekenreeks die het document definieert dat het schema vertegenwoordigt. Wordt gebruikt voor andere schema's dan Swagger/OpenAPI. | snaar |
Resourcedefinitie van Terraform (AzAPI-provider)
Het resourcetype service/werkruimten/apis/schema's kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- resourcegroepen
Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een resource voor Microsoft.ApiManagement/service/workspaces/apis/schema's wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.
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"
}
}
})
}
Eigenschapswaarden
Microsoft.ApiManagement/service/workspaces/apis/schema's
| Naam | Beschrijving | Waarde |
|---|---|---|
| naam | De resourcenaam | string Beperkingen: Minimale lengte = 1 Maximale lengte = 1 (vereist) |
| parent_id | De id van de resource die het bovenliggende item voor deze resource is. | Id voor resource van het type: service/werkruimten/api's |
| Eigenschappen | Eigenschappen van het API-schema. | SchemaContractProperties- |
| type | Het resourcetype | "Microsoft.ApiManagement/service/workspaces/apis/schemas@2023-09-01-preview" |
SchemaContractProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| contentType | Moet een geldig mediatype zijn dat wordt gebruikt in een Content-Type-header, zoals gedefinieerd in rfc 2616. Mediatype van het schemadocument (bijvoorbeeld application/json, application/xml). - Swagger schema gebruiken application/vnd.ms-azure-apim.swagger.definitions+json - WSDL schema gebruiken application/vnd.ms-azure-apim.xsd+xml - OpenApi schema gebruiken application/vnd.oai.openapi.components+json - WADL Schema
application/vnd.ms-azure-apim.wadl.grammars+xml gebruiken - OData Schema
application/vnd.ms-azure-apim.odata.schema gebruiken - gRPC Schema
text/protobufgebruiken. |
tekenreeks (vereist) |
| document | Eigenschappen van het API-schemadocument maken of bijwerken. | SchemaDocumentProperties- (vereist) |
SchemaDocumentProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| Onderdelen | Typen definities. Wordt alleen gebruikt voor Swagger/OpenAPI v2/v3-schema's, anders null. | enig |
| definities | Typen definities. Wordt alleen gebruikt voor Swagger/OpenAPI v1-schema's, anders null. | enig |
| waarde | Json-tekenreeks met escape-tekenreeks die het document definieert dat het schema vertegenwoordigt. Wordt gebruikt voor andere schema's dan Swagger/OpenAPI. | snaar |