Microsoft.ApiManagement service/apis/schemas
Bicep resource definition
The service/apis/schemas resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ApiManagement/service/apis/schemas resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.ApiManagement/service/apis/schemas@2023-09-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
contentType: 'string'
document: {
components: any()
definitions: any()
value: 'string'
}
}
}
Property values
service/apis/schemas
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
string (required) Character limit: 1-80 Valid characters: Alphanumerics and hyphens. Start with letter and end with alphanumeric. |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: apis |
| properties | Properties of the API Schema. | SchemaContractProperties |
SchemaContractProperties
| Name | Description | Value |
|---|---|---|
| contentType | Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml). - Swagger Schema use application/vnd.ms-azure-apim.swagger.definitions+json - WSDL Schema use application/vnd.ms-azure-apim.xsd+xml - OpenApi Schema use application/vnd.oai.openapi.components+json - WADL Schema use application/vnd.ms-azure-apim.wadl.grammars+xml - OData Schema use application/vnd.ms-azure-apim.odata.schema - gRPC Schema use text/protobuf. |
string (required) |
| document | Create or update Properties of the API Schema Document. | SchemaDocumentProperties (required) |
SchemaDocumentProperties
| Name | Description | Value |
|---|---|---|
| components | Types definitions. Used for Swagger/OpenAPI v2/v3 schemas only, null otherwise. | For Bicep, you can use the any() function. |
| definitions | Types definitions. Used for Swagger/OpenAPI v1 schemas only, null otherwise. | For Bicep, you can use the any() function. |
| value | Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI. | string |
ARM template resource definition
The service/apis/schemas resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ApiManagement/service/apis/schemas resource, add the following JSON to your template.
{
"type": "Microsoft.ApiManagement/service/apis/schemas",
"apiVersion": "2023-09-01-preview",
"name": "string",
"properties": {
"contentType": "string",
"document": {
"components": {},
"definitions": {},
"value": "string"
}
}
}
Property values
service/apis/schemas
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.ApiManagement/service/apis/schemas' |
| apiVersion | The resource api version | '2023-09-01-preview' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) Character limit: 1-80 Valid characters: Alphanumerics and hyphens. Start with letter and end with alphanumeric. |
| properties | Properties of the API Schema. | SchemaContractProperties |
SchemaContractProperties
| Name | Description | Value |
|---|---|---|
| contentType | Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml). - Swagger Schema use application/vnd.ms-azure-apim.swagger.definitions+json - WSDL Schema use application/vnd.ms-azure-apim.xsd+xml - OpenApi Schema use application/vnd.oai.openapi.components+json - WADL Schema use application/vnd.ms-azure-apim.wadl.grammars+xml - OData Schema use application/vnd.ms-azure-apim.odata.schema - gRPC Schema use text/protobuf. |
string (required) |
| document | Create or update Properties of the API Schema Document. | SchemaDocumentProperties (required) |
SchemaDocumentProperties
| Name | Description | Value |
|---|---|---|
| components | Types definitions. Used for Swagger/OpenAPI v2/v3 schemas only, null otherwise. | |
| definitions | Types definitions. Used for Swagger/OpenAPI v1 schemas only, null otherwise. | |
| value | Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI. | string |
Terraform (AzAPI provider) resource definition
The service/apis/schemas resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ApiManagement/service/apis/schemas resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/apis/schemas@2023-09-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
contentType = "string"
document = {
value = "string"
}
}
})
}
Property values
service/apis/schemas
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.ApiManagement/service/apis/schemas@2023-09-01-preview" |
| name | The resource name | string (required) Character limit: 1-80 Valid characters: Alphanumerics and hyphens. Start with letter and end with alphanumeric. |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: apis |
| properties | Properties of the API Schema. | SchemaContractProperties |
SchemaContractProperties
| Name | Description | Value |
|---|---|---|
| contentType | Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml). - Swagger Schema use application/vnd.ms-azure-apim.swagger.definitions+json - WSDL Schema use application/vnd.ms-azure-apim.xsd+xml - OpenApi Schema use application/vnd.oai.openapi.components+json - WADL Schema use application/vnd.ms-azure-apim.wadl.grammars+xml - OData Schema use application/vnd.ms-azure-apim.odata.schema - gRPC Schema use text/protobuf. |
string (required) |
| document | Create or update Properties of the API Schema Document. | SchemaDocumentProperties (required) |
SchemaDocumentProperties
| Name | Description | Value |
|---|---|---|
| components | Types definitions. Used for Swagger/OpenAPI v2/v3 schemas only, null otherwise. | |
| definitions | Types definitions. Used for Swagger/OpenAPI v1 schemas only, null otherwise. | |
| value | Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI. | string |