다음을 통해 공유

Microsoft.ApiManagement 서비스/api/schemas 2023-09-01-preview

  • 아티클

Bicep 리소스 정의

다음을 대상으로 하는 작업으로 서비스/api/스키마 리소스 유형을 배포할 수 있습니다.

각 API 버전에서 변경된 속성 목록은 변경 로그참조하세요.

리소스 형식

Microsoft.ApiManagement/service/api/schemas 리소스를 만들려면 템플릿에 다음 Bicep을 추가합니다.

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'
    }
  }
}

속성 값

service/api/schemas

이름 묘사 값
이름 리소스 이름

Bicep자식 리소스의 이름과 형식을 설정하는 방법을 알아보세요.		 string(필수)

문자 제한: 1-80

유효한 문자:
영숫자 및 하이픈

문자로 시작하고 영숫자로 끝납니다.
부모 Bicep에서 자식 리소스에 대한 부모 리소스를 지정할 수 있습니다. 자식 리소스가 부모 리소스 외부에서 선언된 경우에만 이 속성을 추가해야 합니다.

자세한 내용은 부모 리소스외부의 자식 리소스 참조하세요.		 형식의 리소스에 대한 기호 이름: api
속성 API 스키마의 속성입니다. SchemaContractProperties

SchemaContractProperties

이름 묘사 값
contentType RFC 2616에 정의된 대로 Content-Type 헤더에 사용되는 유효한 미디어 형식이어야 합니다. 스키마 문서의 미디어 형식(예: application/json, application/xml)입니다.
- Swagger 스키마 사용 application/vnd.ms-azure-apim.swagger.definitions+json
- WSDL 스키마 사용 application/vnd.ms-azure-apim.xsd+xml
- OpenApi 스키마 사용 application/vnd.oai.openapi.components+json
- WADL Schema application/vnd.ms-azure-apim.wadl.grammars+xml 사용
- OData Schema application/vnd.ms-azure-apim.odata.schema 사용
- gRPC Schema text/protobuf사용합니다.		 string(필수)
문서 API 스키마 문서의 속성을 만들거나 업데이트합니다. SchemaDocumentProperties(필수)

SchemaDocumentProperties

이름 묘사 값
구성 요소 형식 정의입니다. Swagger/OpenAPI v2/v3 스키마에만 사용되며, 그렇지 않으면 null입니다. Bicep의 경우 any() 함수를 사용할 수 있습니다.
정의 형식 정의입니다. Swagger/OpenAPI v1 스키마에만 사용되며, 그렇지 않으면 null입니다. Bicep의 경우 any() 함수를 사용할 수 있습니다.
값 스키마를 나타내는 문서를 정의하는 Json 이스케이프 문자열입니다. Swagger/OpenAPI 이외의 스키마에 사용됩니다. 문자열

ARM 템플릿 리소스 정의

다음을 대상으로 하는 작업으로 서비스/api/스키마 리소스 유형을 배포할 수 있습니다.

각 API 버전에서 변경된 속성 목록은 변경 로그참조하세요.

리소스 형식

Microsoft.ApiManagement/service/api/schemas 리소스를 만들려면 템플릿에 다음 JSON을 추가합니다.

{
  "type": "Microsoft.ApiManagement/service/apis/schemas",
  "apiVersion": "2023-09-01-preview",
  "name": "string",
  "properties": {
    "contentType": "string",
    "document": {
      "components": {},
      "definitions": {},
      "value": "string"
    }
  }
}

속성 값

service/api/schemas

이름 묘사 값
형 리소스 종류 'Microsoft.ApiManagement/service/api/schemas'
apiVersion 리소스 api 버전 '2023-09-01-preview'
이름 리소스 이름

JSON ARM 템플릿자식 리소스의 이름과 형식을 설정하는 방법을 참조하세요.		 string(필수)

문자 제한: 1-80

유효한 문자:
영숫자 및 하이픈

문자로 시작하고 영숫자로 끝납니다.
속성 API 스키마의 속성입니다. SchemaContractProperties

SchemaContractProperties

이름 묘사 값
contentType RFC 2616에 정의된 대로 Content-Type 헤더에 사용되는 유효한 미디어 형식이어야 합니다. 스키마 문서의 미디어 형식(예: application/json, application/xml)입니다.
- Swagger 스키마 사용 application/vnd.ms-azure-apim.swagger.definitions+json
- WSDL 스키마 사용 application/vnd.ms-azure-apim.xsd+xml
- OpenApi 스키마 사용 application/vnd.oai.openapi.components+json
- WADL Schema application/vnd.ms-azure-apim.wadl.grammars+xml 사용
- OData Schema application/vnd.ms-azure-apim.odata.schema 사용
- gRPC Schema text/protobuf사용합니다.		 string(필수)
문서 API 스키마 문서의 속성을 만들거나 업데이트합니다. SchemaDocumentProperties(필수)

SchemaDocumentProperties

이름 묘사 값
구성 요소 형식 정의입니다. Swagger/OpenAPI v2/v3 스키마에만 사용되며, 그렇지 않으면 null입니다.
정의 형식 정의입니다. Swagger/OpenAPI v1 스키마에만 사용되며, 그렇지 않으면 null입니다.
값 스키마를 나타내는 문서를 정의하는 Json 이스케이프 문자열입니다. Swagger/OpenAPI 이외의 스키마에 사용됩니다. 문자열

Terraform(AzAPI 공급자) 리소스 정의

다음을 대상으로 하는 작업으로 서비스/api/스키마 리소스 유형을 배포할 수 있습니다.

  • 리소스 그룹

각 API 버전에서 변경된 속성 목록은 변경 로그참조하세요.

리소스 형식

Microsoft.ApiManagement/service/api/schemas 리소스를 만들려면 템플릿에 다음 Terraform을 추가합니다.

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"
      }
    }
  })
}

속성 값

service/api/schemas

이름 묘사 값
형 리소스 종류 "Microsoft.ApiManagement/service/api/schemas@2023-09-01-preview"
이름 리소스 이름 string(필수)

문자 제한: 1-80

유효한 문자:
영숫자 및 하이픈

문자로 시작하고 영숫자로 끝납니다.
parent_id 이 리소스의 부모인 리소스의 ID입니다. 형식의 리소스 ID: api
속성 API 스키마의 속성입니다. SchemaContractProperties

SchemaContractProperties

이름 묘사 값
contentType RFC 2616에 정의된 대로 Content-Type 헤더에 사용되는 유효한 미디어 형식이어야 합니다. 스키마 문서의 미디어 형식(예: application/json, application/xml)입니다.
- Swagger 스키마 사용 application/vnd.ms-azure-apim.swagger.definitions+json
- WSDL 스키마 사용 application/vnd.ms-azure-apim.xsd+xml
- OpenApi 스키마 사용 application/vnd.oai.openapi.components+json
- WADL Schema application/vnd.ms-azure-apim.wadl.grammars+xml 사용
- OData Schema application/vnd.ms-azure-apim.odata.schema 사용
- gRPC Schema text/protobuf사용합니다.		 string(필수)
문서 API 스키마 문서의 속성을 만들거나 업데이트합니다. SchemaDocumentProperties(필수)

SchemaDocumentProperties

이름 묘사 값
구성 요소 형식 정의입니다. Swagger/OpenAPI v2/v3 스키마에만 사용되며, 그렇지 않으면 null입니다.
정의 형식 정의입니다. Swagger/OpenAPI v1 스키마에만 사용되며, 그렇지 않으면 null입니다.
값 스키마를 나타내는 문서를 정의하는 Json 이스케이프 문자열입니다. Swagger/OpenAPI 이외의 스키마에 사용됩니다. 문자열