Microsoft.ApiManagement service/workspaces/apis/schemas 2023-03-01-preview
Bicep-Ressourcendefinition
Der Ressourcentyp service/workspaces/apis/schemas kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen – Siehe Bereitstellungsbefehle für Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.
Ressourcenformat
Um eine Ressource "Microsoft.ApiManagement/service/workspaces/apis/schemas" zu erstellen, fügen Sie ihrer Vorlage den folgenden Bicep hinzu.
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'
}
}
}
Eigenschaftswerte
service/workspaces/apis/schemas
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| name | Der Ressourcenname Weitere Informationen finden Sie unter Festlegen von Namen und Typen für untergeordnete Ressourcen in Bicep. |
Zeichenfolge (erforderlich) |
| parent | In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird. Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource. |
Symbolischer Name für Ressource vom Typ: apis |
| properties | Eigenschaften des API-Schemas. | SchemaContractProperties |
SchemaContractProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| contentType | Muss ein gültiger Medientyp sein, der in einem Content-Type-Header verwendet wird, wie in RFC 2616 definiert. Medientyp des Schemadokuments (z. B. application/json, application/xml). - Swagger Schemaverwendung application/vnd.ms-azure-apim.swagger.definitions+json - WSDL Schemaverwendung application/vnd.ms-azure-apim.xsd+xml - OpenApi Schemaverwendung application/vnd.oai.openapi.components+json - WADL Schema Verwenden application/vnd.ms-azure-apim.wadl.grammars+xml - OData Schema Verwenden Sie application/vnd.ms-azure-apim.odata.schema. |
Zeichenfolge (erforderlich) |
| Dokument | Erstellen oder Aktualisieren von Eigenschaften des API-Schemadokuments. | SchemaDocumentProperties (erforderlich) |
SchemaDocumentProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| components | Typendefinitionen. Wird nur für Swagger/OpenAPI v2/v3-Schemas verwendet, andernfalls NULL. | Für Bicep können Sie die funktion any() verwenden. |
| definitions | Typendefinitionen. Wird nur für Swagger/OpenAPI v1-Schemas verwendet, andernfalls NULL. | Für Bicep können Sie die funktion any() verwenden. |
| value | Json-Escapezeichenfolge, die das Dokument definiert, das das Schema darstellt. Wird für andere Schemas als Swagger/OpenAPI verwendet. | Zeichenfolge |
Ressourcendefinition mit einer ARM-Vorlage
Der Ressourcentyp service/workspaces/apis/schemas kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen – Siehe Bereitstellungsbefehle für Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.ApiManagement/service/workspaces/apis/schemas-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.
{
"type": "Microsoft.ApiManagement/service/workspaces/apis/schemas",
"apiVersion": "2023-03-01-preview",
"name": "string",
"properties": {
"contentType": "string",
"document": {
"components": {},
"definitions": {},
"value": "string"
}
}
}
Eigenschaftswerte
service/workspaces/apis/schemas
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Ressourcentyp | "Microsoft.ApiManagement/service/workspaces/apis/schemas" |
| apiVersion | Die Version der Ressourcen-API | "2023-03-01-preview" |
| name | Der Ressourcenname Weitere Informationen finden Sie unter Festlegen von Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen. |
Zeichenfolge (erforderlich) |
| properties | Eigenschaften des API-Schemas. | SchemaContractProperties |
SchemaContractProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| contentType | Muss ein gültiger Medientyp sein, der in einem Content-Type-Header verwendet wird, wie in RFC 2616 definiert. Medientyp des Schemadokuments (z. B. application/json, application/xml). - Swagger Schemaverwendung application/vnd.ms-azure-apim.swagger.definitions+json - WSDL Schemaverwendung application/vnd.ms-azure-apim.xsd+xml - OpenApi Schemaverwendung application/vnd.oai.openapi.components+json - WADL Schema Verwenden application/vnd.ms-azure-apim.wadl.grammars+xml - OData Schema Verwenden Sie application/vnd.ms-azure-apim.odata.schema. |
Zeichenfolge (erforderlich) |
| Dokument | Erstellen oder Aktualisieren von Eigenschaften des API-Schemadokuments. | SchemaDocumentProperties (erforderlich) |
SchemaDocumentProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| components | Typendefinitionen. Wird nur für Swagger/OpenAPI v2/v3-Schemas verwendet, andernfalls NULL. | |
| definitions | Typendefinitionen. Wird nur für Swagger/OpenAPI v1-Schemas verwendet, andernfalls NULL. | |
| value | Json-Escapezeichenfolge, die das Dokument definiert, das das Schema darstellt. Wird für andere Schemas als Swagger/OpenAPI verwendet. | Zeichenfolge |
Terraform-Ressourcendefinition (AzAPI-Anbieter)
Der Ressourcentyp service/workspaces/apis/schemas kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.ApiManagement/service/workspaces/apis/schemas-Ressource zu erstellen, fügen Sie der Vorlage die folgende Terraform-Ressource hinzu.
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"
}
}
})
}
Eigenschaftswerte
service/workspaces/apis/schemas
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Ressourcentyp | "Microsoft.ApiManagement/service/workspaces/apis/schemas@2023-03-01-preview" |
| name | Der Ressourcenname | Zeichenfolge (erforderlich) |
| parent_id | Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. | ID für Ressource vom Typ apis |
| properties | Eigenschaften des API-Schemas. | SchemaContractProperties |
SchemaContractProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| contentType | Muss ein gültiger Medientyp sein, der in einem Content-Type-Header verwendet wird, wie in RFC 2616 definiert. Medientyp des Schemadokuments (z. B. application/json, application/xml). - Swagger Schemaverwendung application/vnd.ms-azure-apim.swagger.definitions+json - WSDL Schemaverwendung application/vnd.ms-azure-apim.xsd+xml - OpenApi Schemaverwendung application/vnd.oai.openapi.components+json - WADL Schema Verwenden application/vnd.ms-azure-apim.wadl.grammars+xml - OData Schema Verwenden Sie application/vnd.ms-azure-apim.odata.schema. |
Zeichenfolge (erforderlich) |
| Dokument | Erstellen oder Aktualisieren von Eigenschaften des API-Schemadokuments. | SchemaDocumentProperties (erforderlich) |
SchemaDocumentProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| components | Typendefinitionen. Wird nur für Swagger/OpenAPI v2/v3-Schemas verwendet, andernfalls NULL. | |
| definitions | Typendefinitionen. Wird nur für Swagger/OpenAPI v1-Schemas verwendet, andernfalls NULL. | |
| value | Json-Escapezeichenfolge, die das Dokument definiert, das das Schema darstellt. Wird für andere Schemas als Swagger/OpenAPI verwendet. | Zeichenfolge |