Notatka
Dostęp do tej strony wymaga autoryzacji. Może spróbować zalogować się lub zmienić katalogi.
Dostęp do tej strony wymaga autoryzacji. Możesz spróbować zmienić katalogi.
- najnowsze
- 2025-09-01-podgląd
- 2025-03-01-preview
- 2024-10-01-preview
- 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-preview
- 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
Definicja zasobu Bicep
Typ zasobu service/apis/schemas można wdrożyć przy użyciu operacji docelowych:
- grupy zasobów — zobacz polecenia wdrażania grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.
Przykłady użycia
Przykłady Bicep
Podstawowy przykład wdrażania schematu interfejsu API w usłudze API Management.
param resourceName string = 'acctest0001'
param location string = 'westeurope'
resource service 'Microsoft.ApiManagement/service@2021-08-01' = {
name: resourceName
location: location
sku: {
capacity: 0
name: 'Consumption'
}
properties: {
certificates: []
customProperties: {
'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30': 'false'
'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10': 'false'
'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11': 'false'
'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10': 'false'
'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11': 'false'
}
disableGateway: false
publicNetworkAccess: 'Enabled'
publisherEmail: 'pub1@email.com'
publisherName: 'pub1'
virtualNetworkType: 'None'
}
}
resource api 'Microsoft.ApiManagement/service/apis@2021-08-01' = {
name: '${resourceName};rev=1'
parent: service
properties: {
apiRevisionDescription: ''
apiType: 'http'
apiVersion: ''
apiVersionDescription: ''
authenticationSettings: {}
description: ''
displayName: 'api1'
path: 'api1'
protocols: [
'https'
]
serviceUrl: ''
subscriptionRequired: true
type: 'http'
}
}
resource schema 'Microsoft.ApiManagement/service/apis/schemas@2021-08-01' = {
name: resourceName
parent: api
properties: {
contentType: 'application/vnd.ms-azure-apim.xsd+xml'
document: {
value: '''<!--
Copyright (c) HashiCorp, Inc.
SPDX-License-Identifier: MPL-2.0
-->
<s:schema elementFormDefault="qualified" targetNamespace="http://ws.cdyne.com/WeatherWS/" xmlns:tns="http://ws.cdyne.com/WeatherWS/" xmlns:s="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://schemas.xmlsoap.org/wsdl/soap12/" xmlns:mime="http://schemas.xmlsoap.org/wsdl/mime/" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:tm="http://microsoft.com/wsdl/mime/textMatching/" xmlns:http="http://schemas.xmlsoap.org/wsdl/http/" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:apim-wsdltns="http://ws.cdyne.com/WeatherWS/"> <s:element name="GetWeatherInformation"> <s:complexType /> </s:element> <s:element name="GetWeatherInformationResponse"> <s:complexType> <s:sequence> <s:element minOccurs="0" maxOccurs="1" name="GetWeatherInformationResult" type="tns:ArrayOfWeatherDescription" /> </s:sequence> </s:complexType> </s:element> <s:complexType name="ArrayOfWeatherDescription"> <s:sequence> <s:element minOccurs="0" maxOccurs="unbounded" name="WeatherDescription" type="tns:WeatherDescription" /> </s:sequence> </s:complexType> <s:complexType name="WeatherDescription"> <s:sequence> <s:element minOccurs="1" maxOccurs="1" name="WeatherID" type="s:short" /> <s:element minOccurs="0" maxOccurs="1" name="Description" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="PictureURL" type="s:string" /> </s:sequence> </s:complexType> <s:element name="GetCityForecastByZIP"> <s:complexType> <s:sequence> <s:element minOccurs="0" maxOccurs="1" name="ZIP" type="s:string" /> </s:sequence> </s:complexType> </s:element> <s:element name="GetCityForecastByZIPResponse"> <s:complexType> <s:sequence> <s:element minOccurs="0" maxOccurs="1" name="GetCityForecastByZIPResult" type="tns:ForecastReturn" /> </s:sequence> </s:complexType> </s:element> <s:complexType name="ForecastReturn"> <s:sequence> <s:element minOccurs="1" maxOccurs="1" name="Success" type="s:boolean" /> <s:element minOccurs="0" maxOccurs="1" name="ResponseText" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="State" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="City" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="WeatherStationCity" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="ForecastResult" type="tns:ArrayOfForecast" /> </s:sequence> </s:complexType> <s:complexType name="ArrayOfForecast"> <s:sequence> <s:element minOccurs="0" maxOccurs="unbounded" name="Forecast" nillable="true" type="tns:Forecast" /> </s:sequence> </s:complexType> <s:complexType name="Forecast"> <s:sequence> <s:element minOccurs="1" maxOccurs="1" name="Date" type="s:dateTime" /> <s:element minOccurs="1" maxOccurs="1" name="WeatherID" type="s:short" /> <s:element minOccurs="0" maxOccurs="1" name="Desciption" type="s:string" /> <s:element minOccurs="1" maxOccurs="1" name="Temperatures" type="tns:temp" /> <s:element minOccurs="1" maxOccurs="1" name="ProbabilityOfPrecipiation" type="tns:POP" /> </s:sequence> </s:complexType> <s:complexType name="temp"> <s:sequence> <s:element minOccurs="0" maxOccurs="1" name="MorningLow" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="DaytimeHigh" type="s:string" /> </s:sequence> </s:complexType> <s:complexType name="POP"> <s:sequence> <s:element minOccurs="0" maxOccurs="1" name="Nighttime" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="Daytime" type="s:string" /> </s:sequence> </s:complexType> <s:element name="GetCityWeatherByZIP"> <s:complexType> <s:sequence> <s:element minOccurs="0" maxOccurs="1" name="ZIP" type="s:string" /> </s:sequence> </s:complexType> </s:element> <s:element name="GetCityWeatherByZIPResponse"> <s:complexType> <s:sequence> <s:element minOccurs="1" maxOccurs="1" name="GetCityWeatherByZIPResult" type="tns:WeatherReturn" /> </s:sequence> </s:complexType> </s:element> <s:complexType name="WeatherReturn"> <s:sequence> <s:element minOccurs="1" maxOccurs="1" name="Success" type="s:boolean" /> <s:element minOccurs="0" maxOccurs="1" name="ResponseText" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="State" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="City" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="WeatherStationCity" type="s:string" /> <s:element minOccurs="1" maxOccurs="1" name="WeatherID" type="s:short" /> <s:element minOccurs="0" maxOccurs="1" name="Description" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="Temperature" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="RelativeHumidity" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="Wind" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="Pressure" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="Visibility" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="WindChill" type="s:string" /> <s:element minOccurs="0" maxOccurs="1" name="Remarks" type="s:string" /> </s:sequence> </s:complexType> <s:element name="ArrayOfWeatherDescription" nillable="true" type="tns:ArrayOfWeatherDescription" /> <s:element name="ForecastReturn" nillable="true" type="tns:ForecastReturn" /> <s:element name="WeatherReturn" type="tns:WeatherReturn" /> </s:schema>'''
}
}
}
Format zasobu
Aby utworzyć zasób Microsoft.ApiManagement/service/apis/schemas, dodaj następujący kod Bicep do szablonu.
resource symbolicname 'Microsoft.ApiManagement/service/apis/schemas@2024-06-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
contentType: 'string'
document: {
components: any(...)
definitions: any(...)
value: 'string'
}
}
}
Wartości właściwości
Microsoft.ApiManagement/service/apis/schemas
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa | Nazwa zasobu | struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 80 (wymagane) |
| nadrzędny | W Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym. Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym. |
Nazwa symboliczna zasobu typu: service/apis |
| Właściwości | Właściwości schematu interfejsu API. | SchemaContractProperties |
SchemaContractProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| typ treści | Musi być prawidłowym typem nośnika używanym w nagłówku Content-Type zgodnie z definicją w dokumencie RFC 2616. Typ nośnika dokumentu schematu (np. application/json, application/xml). - Swagger Schemat używać application/vnd.ms-azure-apim.swagger.definitions+json - WSDL Schemat używać application/vnd.ms-azure-apim.xsd+xml - OpenApi Schemat używać application/vnd.oai.openapi.components+json - WADL Schema używać application/vnd.ms-azure-apim.wadl.grammars+xml - OData Schema używać application/vnd.ms-azure-apim.odata.schema - gRPC Schema użyj text/protobuf. |
ciąg (wymagany) |
| dokument | Utwórz lub zaktualizuj właściwości dokumentu schematu interfejsu API. | SchemaDocumentProperties (wymagane) |
SchemaDocumentProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| Składniki | Definicje typów. Używany tylko w przypadku schematów struktury Swagger/OpenAPI v2/v3 o wartości null. | jakikolwiek |
| Definicje | Definicje typów. Używany tylko w przypadku schematów struktury Swagger/OpenAPI w wersji 1, wartość null. | jakikolwiek |
| wartość | Ciąg ucieczki Json definiujący dokument reprezentujący schemat. Używany do schematów innych niż Swagger/OpenAPI. | ciąg |
Definicja zasobu szablonu usługi ARM
Typ zasobu service/apis/schemas można wdrożyć przy użyciu operacji docelowych:
- Grupy zasobów – Zobacz polecenia wdrożenia grup zasobów Aby uzyskać listę zmienionych właściwości w każdej wersji API, zobacz log zmian.
Przykłady użycia
Format zasobu
Aby utworzyć zasób Microsoft.ApiManagement/service/apis/schemas, dodaj następujący kod JSON do szablonu.
{
"type": "Microsoft.ApiManagement/service/apis/schemas",
"apiVersion": "2024-06-01-preview",
"name": "string",
"properties": {
"contentType": "string",
"document": {
"components": {},
"definitions": {},
"value": "string"
}
}
}
Wartości właściwości
Microsoft.ApiManagement/service/apis/schemas
| Nazwa | Opis | Wartość |
|---|---|---|
| apiVersion | Wersja interfejsu API | "2024-06-01-preview" |
| nazwa | Nazwa zasobu | struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 80 (wymagane) |
| Właściwości | Właściwości schematu interfejsu API. | SchemaContractProperties |
| typ | Typ zasobu | "Microsoft.ApiManagement/service/apis/schemas" |
SchemaContractProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| typ treści | Musi być prawidłowym typem nośnika używanym w nagłówku Content-Type zgodnie z definicją w dokumencie RFC 2616. Typ nośnika dokumentu schematu (np. application/json, application/xml). - Swagger Schemat używać application/vnd.ms-azure-apim.swagger.definitions+json - WSDL Schemat używać application/vnd.ms-azure-apim.xsd+xml - OpenApi Schemat używać application/vnd.oai.openapi.components+json - WADL Schema używać application/vnd.ms-azure-apim.wadl.grammars+xml - OData Schema używać application/vnd.ms-azure-apim.odata.schema - gRPC Schema użyj text/protobuf. |
ciąg (wymagany) |
| dokument | Utwórz lub zaktualizuj właściwości dokumentu schematu interfejsu API. | SchemaDocumentProperties (wymagane) |
SchemaDocumentProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| Składniki | Definicje typów. Używany tylko w przypadku schematów struktury Swagger/OpenAPI v2/v3 o wartości null. | jakikolwiek |
| Definicje | Definicje typów. Używany tylko w przypadku schematów struktury Swagger/OpenAPI w wersji 1, wartość null. | jakikolwiek |
| wartość | Ciąg ucieczki Json definiujący dokument reprezentujący schemat. Używany do schematów innych niż Swagger/OpenAPI. | ciąg |
Definicja zasobu narzędzia Terraform (dostawcy AzAPI)
Typ zasobu service/apis/schemas można wdrożyć przy użyciu operacji docelowych:
- Grupy zasobów Listę zmienionych właściwości w każdej wersji API można znaleźć w dzienniku zmian.
Przykłady użycia
Przykłady programu Terraform
Podstawowy przykład wdrażania schematu interfejsu API w usłudze API Management.
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "resource_name" {
type = string
default = "acctest0001"
}
variable "location" {
type = string
default = "westeurope"
}
resource "azapi_resource" "resourceGroup" {
type = "Microsoft.Resources/resourceGroups@2020-06-01"
name = var.resource_name
location = var.location
}
resource "azapi_resource" "service" {
type = "Microsoft.ApiManagement/service@2021-08-01"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
body = {
properties = {
certificates = [
]
customProperties = {
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30" = "false"
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10" = "false"
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11" = "false"
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10" = "false"
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11" = "false"
}
disableGateway = false
publicNetworkAccess = "Enabled"
publisherEmail = "pub1@email.com"
publisherName = "pub1"
virtualNetworkType = "None"
}
sku = {
capacity = 0
name = "Consumption"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
resource "azapi_resource" "api" {
type = "Microsoft.ApiManagement/service/apis@2021-08-01"
parent_id = azapi_resource.service.id
name = "${var.resource_name};rev=1"
body = {
properties = {
apiRevisionDescription = ""
apiType = "http"
apiVersion = ""
apiVersionDescription = ""
authenticationSettings = {
}
description = ""
displayName = "api1"
path = "api1"
protocols = [
"https",
]
serviceUrl = ""
subscriptionRequired = true
type = "http"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
resource "azapi_resource" "schema" {
type = "Microsoft.ApiManagement/service/apis/schemas@2021-08-01"
parent_id = azapi_resource.api.id
name = var.resource_name
body = {
properties = {
contentType = "application/vnd.ms-azure-apim.xsd+xml"
document = {
value = "<!--\n Copyright (c) HashiCorp, Inc.\n SPDX-License-Identifier: MPL-2.0\n-->\n\n<s:schema elementFormDefault=\"qualified\" targetNamespace=\"http://ws.cdyne.com/WeatherWS/\" xmlns:tns=\"http://ws.cdyne.com/WeatherWS/\" xmlns:s=\"http://www.w3.org/2001/XMLSchema\" xmlns:soap12=\"http://schemas.xmlsoap.org/wsdl/soap12/\" xmlns:mime=\"http://schemas.xmlsoap.org/wsdl/mime/\" xmlns:soap=\"http://schemas.xmlsoap.org/wsdl/soap/\" xmlns:tm=\"http://microsoft.com/wsdl/mime/textMatching/\" xmlns:http=\"http://schemas.xmlsoap.org/wsdl/http/\" xmlns:soapenc=\"http://schemas.xmlsoap.org/soap/encoding/\" xmlns:wsdl=\"http://schemas.xmlsoap.org/wsdl/\" xmlns:apim-wsdltns=\"http://ws.cdyne.com/WeatherWS/\"> <s:element name=\"GetWeatherInformation\"> <s:complexType /> </s:element> <s:element name=\"GetWeatherInformationResponse\"> <s:complexType> <s:sequence> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"GetWeatherInformationResult\" type=\"tns:ArrayOfWeatherDescription\" /> </s:sequence> </s:complexType> </s:element> <s:complexType name=\"ArrayOfWeatherDescription\"> <s:sequence> <s:element minOccurs=\"0\" maxOccurs=\"unbounded\" name=\"WeatherDescription\" type=\"tns:WeatherDescription\" /> </s:sequence> </s:complexType> <s:complexType name=\"WeatherDescription\"> <s:sequence> <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"WeatherID\" type=\"s:short\" /> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Description\" type=\"s:string\" /> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"PictureURL\" type=\"s:string\" /> </s:sequence> </s:complexType> <s:element name=\"GetCityForecastByZIP\"> <s:complexType> <s:sequence> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"ZIP\" type=\"s:string\" /> </s:sequence> </s:complexType> </s:element> <s:element name=\"GetCityForecastByZIPResponse\"> <s:complexType> <s:sequence> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"GetCityForecastByZIPResult\" type=\"tns:ForecastReturn\" /> </s:sequence> </s:complexType> </s:element> <s:complexType name=\"ForecastReturn\"> <s:sequence> <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"Success\" type=\"s:boolean\" /> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"ResponseText\" type=\"s:string\" /> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"State\" type=\"s:string\" /> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"City\" type=\"s:string\" /> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"WeatherStationCity\" type=\"s:string\" /> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"ForecastResult\" type=\"tns:ArrayOfForecast\" /> </s:sequence> </s:complexType> <s:complexType name=\"ArrayOfForecast\"> <s:sequence> <s:element minOccurs=\"0\" maxOccurs=\"unbounded\" name=\"Forecast\" nillable=\"true\" type=\"tns:Forecast\" /> </s:sequence> </s:complexType> <s:complexType name=\"Forecast\"> <s:sequence> <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"Date\" type=\"s:dateTime\" /> <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"WeatherID\" type=\"s:short\" /> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Desciption\" type=\"s:string\" /> <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"Temperatures\" type=\"tns:temp\" /> <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"ProbabilityOfPrecipiation\" type=\"tns:POP\" /> </s:sequence> </s:complexType> <s:complexType name=\"temp\"> <s:sequence> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"MorningLow\" type=\"s:string\" /> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"DaytimeHigh\" type=\"s:string\" /> </s:sequence> </s:complexType> <s:complexType name=\"POP\"> <s:sequence> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Nighttime\" type=\"s:string\" /> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Daytime\" type=\"s:string\" /> </s:sequence> </s:complexType> <s:element name=\"GetCityWeatherByZIP\"> <s:complexType> <s:sequence> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"ZIP\" type=\"s:string\" /> </s:sequence> </s:complexType> </s:element> <s:element name=\"GetCityWeatherByZIPResponse\"> <s:complexType> <s:sequence> <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"GetCityWeatherByZIPResult\" type=\"tns:WeatherReturn\" /> </s:sequence> </s:complexType> </s:element> <s:complexType name=\"WeatherReturn\"> <s:sequence> <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"Success\" type=\"s:boolean\" /> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"ResponseText\" type=\"s:string\" /> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"State\" type=\"s:string\" /> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"City\" type=\"s:string\" /> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"WeatherStationCity\" type=\"s:string\" /> <s:element minOccurs=\"1\" maxOccurs=\"1\" name=\"WeatherID\" type=\"s:short\" /> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Description\" type=\"s:string\" /> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Temperature\" type=\"s:string\" /> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"RelativeHumidity\" type=\"s:string\" /> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Wind\" type=\"s:string\" /> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Pressure\" type=\"s:string\" /> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Visibility\" type=\"s:string\" /> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"WindChill\" type=\"s:string\" /> <s:element minOccurs=\"0\" maxOccurs=\"1\" name=\"Remarks\" type=\"s:string\" /> </s:sequence> </s:complexType> <s:element name=\"ArrayOfWeatherDescription\" nillable=\"true\" type=\"tns:ArrayOfWeatherDescription\" /> <s:element name=\"ForecastReturn\" nillable=\"true\" type=\"tns:ForecastReturn\" /> <s:element name=\"WeatherReturn\" type=\"tns:WeatherReturn\" /> </s:schema>"
}
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
Format zasobu
Aby utworzyć zasób Microsoft.ApiManagement/service/apis/schemas, dodaj następujący program Terraform do szablonu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/apis/schemas@2024-06-01-preview"
name = "string"
parent_id = "string"
body = {
properties = {
contentType = "string"
document = {
components = ?
definitions = ?
value = "string"
}
}
}
}
Wartości właściwości
Microsoft.ApiManagement/service/apis/schemas
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa | Nazwa zasobu | struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 80 (wymagane) |
| parent_id | Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. | Identyfikator zasobu typu: service/apis |
| Właściwości | Właściwości schematu interfejsu API. | SchemaContractProperties |
| typ | Typ zasobu | "Microsoft.ApiManagement/service/apis/schemas@2024-06-01-preview" |
SchemaContractProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| typ treści | Musi być prawidłowym typem nośnika używanym w nagłówku Content-Type zgodnie z definicją w dokumencie RFC 2616. Typ nośnika dokumentu schematu (np. application/json, application/xml). - Swagger Schemat używać application/vnd.ms-azure-apim.swagger.definitions+json - WSDL Schemat używać application/vnd.ms-azure-apim.xsd+xml - OpenApi Schemat używać application/vnd.oai.openapi.components+json - WADL Schema używać application/vnd.ms-azure-apim.wadl.grammars+xml - OData Schema używać application/vnd.ms-azure-apim.odata.schema - gRPC Schema użyj text/protobuf. |
ciąg (wymagany) |
| dokument | Utwórz lub zaktualizuj właściwości dokumentu schematu interfejsu API. | SchemaDocumentProperties (wymagane) |
SchemaDocumentProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| Składniki | Definicje typów. Używany tylko w przypadku schematów struktury Swagger/OpenAPI v2/v3 o wartości null. | jakikolwiek |
| Definicje | Definicje typów. Używany tylko w przypadku schematów struktury Swagger/OpenAPI w wersji 1, wartość null. | jakikolwiek |
| wartość | Ciąg ucieczki Json definiujący dokument reprezentujący schemat. Używany do schematów innych niż Swagger/OpenAPI. | ciąg |