Udostępnij za pośrednictwem

Microsoft.ApiManagement service/apis/schemas 2023-03-01-preview

  • Artykuł

Definicja zasobu Bicep

Typ zasobu service/apis/schemas można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

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@2023-03-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'
    }
  }
}

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)
rodzic 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ść
contentType 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żyj application/vnd.ms-azure-apim.odata.schema.		 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. struna

Definicja zasobu szablonu usługi ARM

Typ zasobu service/apis/schemas można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

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": "2023-03-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 "2023-03-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ść
contentType 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żyj application/vnd.ms-azure-apim.odata.schema.		 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. struna

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu service/apis/schemas można wdrożyć przy użyciu operacji docelowych:

  • grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

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@2023-03-01-preview"
  name = "string"
  body = jsonencode({
    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@2023-03-01-preview"

SchemaContractProperties

Nazwa Opis Wartość
contentType 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żyj application/vnd.ms-azure-apim.odata.schema.		 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. struna