Microsoft.ApiManagement service/apis/schemas 2021-04-01-preview
- neueste
- 2024-06-01-Preview-
- 2024-05-01
- 2023-09-01-Preview-
- 2023-05-01-Preview-
- 2023-03-01-Preview-
- 2022-09-01-Preview-
- 2022-08-01
- 2022-04-01-Vorschau-
- 2021-12-01-Preview-
- 2021-08-01
- 2021-04-01-preview
- 2021-01-01-Preview-
- 2020-12-01
- 2020-06-01-Preview-
- 2019-12-01
- 2019-12-01-Preview-
- 2019-01-01
- 2018-06-01-Preview-
- 2018-01-01
- 2017-03-01
Bicep-Ressourcendefinition
Der Ressourcentyp "service/apis/schemas" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.ApiManagement/service/apis/schemas-Ressource zu erstellen, fügen Sie ihrer Vorlage die folgende Bicep hinzu.
resource symbolicname 'Microsoft.ApiManagement/service/apis/schemas@2021-04-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'
}
}
}
Eigenschaftswerte
ApiSchemaContractProperties
| 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 Schema verwenden application/vnd.ms-azure-apim.swagger.definitions+json - WSDL Schema verwenden application/vnd.ms-azure-apim.xsd+xml - OpenApi Schema verwenden application/vnd.oai.openapi.components+json - WADL Schema
application/vnd.ms-azure-apim.wadl.grammars+xmlverwenden. |
Zeichenfolge (erforderlich) |
| Dokument | Erstellen oder Aktualisieren von Eigenschaften des API-Schemadokuments. | ApiSchemaDocumentProperties- |
ApiSchemaDocumentProperties
| Name | Beschreibung | Wert |
|---|---|---|
| Komponenten | Typendefinitionen. Wird nur für Swagger/OpenAPI v2/v3-Schemas verwendet, andernfalls null. | jegliche |
| Definitionen | Typendefinitionen. Wird nur für Swagger/OpenAPI v1-Schemas verwendet, andernfalls null. | jegliche |
| Wert | Json-Escapezeichenfolge, die das Dokument definiert, das das Schema darstellt. Wird für andere Schemas als Swagger/OpenAPI verwendet. | Schnur |
Microsoft.ApiManagement/service/apis/schemas
| Name | Beschreibung | Wert |
|---|---|---|
| Name | Der Ressourcenname | Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 (erforderlich) |
| Elternteil | 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: Dienst/APIs |
| Eigenschaften | Eigenschaften des API-Schemas. | ApiSchemaContractProperties |
ARM-Vorlagenressourcendefinition
Der Ressourcentyp "service/apis/schemas" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.ApiManagement/service/apis/schemas-Ressource zu erstellen, fügen Sie Der Vorlage den folgenden JSON-Code hinzu.
{
"type": "Microsoft.ApiManagement/service/apis/schemas",
"apiVersion": "2021-04-01-preview",
"name": "string",
"properties": {
"contentType": "string",
"document": {
"components": {},
"definitions": {},
"value": "string"
}
}
}
Eigenschaftswerte
ApiSchemaContractProperties
| 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 Schema verwenden application/vnd.ms-azure-apim.swagger.definitions+json - WSDL Schema verwenden application/vnd.ms-azure-apim.xsd+xml - OpenApi Schema verwenden application/vnd.oai.openapi.components+json - WADL Schema
application/vnd.ms-azure-apim.wadl.grammars+xmlverwenden. |
Zeichenfolge (erforderlich) |
| Dokument | Erstellen oder Aktualisieren von Eigenschaften des API-Schemadokuments. | ApiSchemaDocumentProperties- |
ApiSchemaDocumentProperties
| Name | Beschreibung | Wert |
|---|---|---|
| Komponenten | Typendefinitionen. Wird nur für Swagger/OpenAPI v2/v3-Schemas verwendet, andernfalls null. | jegliche |
| Definitionen | Typendefinitionen. Wird nur für Swagger/OpenAPI v1-Schemas verwendet, andernfalls null. | jegliche |
| Wert | Json-Escapezeichenfolge, die das Dokument definiert, das das Schema darstellt. Wird für andere Schemas als Swagger/OpenAPI verwendet. | Schnur |
Microsoft.ApiManagement/service/apis/schemas
| Name | Beschreibung | Wert |
|---|---|---|
| apiVersion | Die API-Version | "2021-04-01-preview" |
| Name | Der Ressourcenname | Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 (erforderlich) |
| Eigenschaften | Eigenschaften des API-Schemas. | ApiSchemaContractProperties |
| Art | Der Ressourcentyp | "Microsoft.ApiManagement/service/apis/schemas" |
Terraform -Ressourcendefinition (AzAPI-Anbieter)
Der Ressourcentyp "service/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 unter Änderungsprotokoll.
Ressourcenformat
Um eine Ressource "Microsoft.ApiManagement/service/apis/schemas" zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/apis/schemas@2021-04-01-preview"
name = "string"
body = jsonencode({
properties = {
contentType = "string"
document = {
components = ?
definitions = ?
value = "string"
}
}
})
}
Eigenschaftswerte
ApiSchemaContractProperties
| 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 Schema verwenden application/vnd.ms-azure-apim.swagger.definitions+json - WSDL Schema verwenden application/vnd.ms-azure-apim.xsd+xml - OpenApi Schema verwenden application/vnd.oai.openapi.components+json - WADL Schema
application/vnd.ms-azure-apim.wadl.grammars+xmlverwenden. |
Zeichenfolge (erforderlich) |
| Dokument | Erstellen oder Aktualisieren von Eigenschaften des API-Schemadokuments. | ApiSchemaDocumentProperties- |
ApiSchemaDocumentProperties
| Name | Beschreibung | Wert |
|---|---|---|
| Komponenten | Typendefinitionen. Wird nur für Swagger/OpenAPI v2/v3-Schemas verwendet, andernfalls null. | jegliche |
| Definitionen | Typendefinitionen. Wird nur für Swagger/OpenAPI v1-Schemas verwendet, andernfalls null. | jegliche |
| Wert | Json-Escapezeichenfolge, die das Dokument definiert, das das Schema darstellt. Wird für andere Schemas als Swagger/OpenAPI verwendet. | Schnur |
Microsoft.ApiManagement/service/apis/schemas
| Name | Beschreibung | Wert |
|---|---|---|
| Name | Der Ressourcenname | Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 (erforderlich) |
| parent_id | Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. | ID für Ressource des Typs: Dienst/APIs |
| Eigenschaften | Eigenschaften des API-Schemas. | ApiSchemaContractProperties |
| Art | Der Ressourcentyp | "Microsoft.ApiManagement/service/apis/schemas@2021-04-01-preview" |