다음을 통해 공유

Global Schema - List By Service

  • 참조
서비스:
API Management
API 버전:
2021-08-01

서비스 instance 등록된 스키마 컬렉션을 나열합니다.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/schemas?api-version=2021-08-01
선택적 매개 변수: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/schemas?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2021-08-01

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
resourceGroupName
 path True

string

리소스 그룹의 이름.
serviceName
 path True

string

API Management 서비스의 이름입니다.

regex 패턴: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId
 path True

string

Microsoft Azure 구독을 고유하게 식별하는 구독 자격 증명 구독 ID는 모든 서비스 호출에 대한 URI의 파트를 형성합니다.
api-version
 query True

string

클라이언트 요청과 함께 사용할 API의 버전입니다.
$filter
 query

string

| 필드 | 사용량 | 지원되는 연산자 | 지원되는 함수 |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
$skip
 query

integer

int32

건너뛸 레코드의 수입니다.
$top
 query

integer

int32

반환할 레코드의 수입니다.

응답

Name 형식 Description
200 OK

GlobalSchemaCollection

스키마 엔터티의 컬렉션을 나열합니다.
Other Status Codes

ErrorResponse

작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name Description
user_impersonation 사용자 계정 가장

예제

ApiManagementListSchemas

샘플 요청

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas?api-version=2021-08-01

샘플 응답

상태 코드:
200 
{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema1",
      "type": "Microsoft.ApiManagement/service/schemas",
      "name": "schema1",
      "properties": {
        "description": "sample schema description",
        "schemaType": "xml",
        "value": "<xsd:schema xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"\r\n           xmlns:tns=\"http://tempuri.org/PurchaseOrderSchema.xsd\"\r\n           targetNamespace=\"http://tempuri.org/PurchaseOrderSchema.xsd\"\r\n           elementFormDefault=\"qualified\">\r\n <xsd:element name=\"PurchaseOrder\" type=\"tns:PurchaseOrderType\"/>\r\n <xsd:complexType name=\"PurchaseOrderType\">\r\n  <xsd:sequence>\r\n   <xsd:element name=\"ShipTo\" type=\"tns:USAddress\" maxOccurs=\"2\"/>\r\n   <xsd:element name=\"BillTo\" type=\"tns:USAddress\"/>\r\n  </xsd:sequence>\r\n  <xsd:attribute name=\"OrderDate\" type=\"xsd:date\"/>\r\n </xsd:complexType>\r\n\r\n <xsd:complexType name=\"USAddress\">\r\n  <xsd:sequence>\r\n   <xsd:element name=\"name\"   type=\"xsd:string\"/>\r\n   <xsd:element name=\"street\" type=\"xsd:string\"/>\r\n   <xsd:element name=\"city\"   type=\"xsd:string\"/>\r\n   <xsd:element name=\"state\"  type=\"xsd:string\"/>\r\n   <xsd:element name=\"zip\"    type=\"xsd:integer\"/>\r\n  </xsd:sequence>\r\n  <xsd:attribute name=\"country\" type=\"xsd:NMTOKEN\" fixed=\"US\"/>\r\n </xsd:complexType>\r\n</xsd:schema>"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/schemas/schema2",
      "type": "Microsoft.ApiManagement/service/schemas",
      "name": "schema2",
      "properties": {
        "description": "sample schema description",
        "schemaType": "json",
        "document": {
          "$id": "https://example.com/person.schema.json",
          "$schema": "https://json-schema.org/draft/2020-12/schema",
          "title": "Person",
          "type": "object",
          "properties": {
            "firstName": {
              "type": "string",
              "description": "The person's first name."
            },
            "lastName": {
              "type": "string",
              "description": "The person's last name."
            },
            "age": {
              "description": "Age in years which must be equal to or greater than zero.",
              "type": "integer",
              "minimum": 0
            }
          }
        }
      }
    }
  ],
  "count": 2,
  "nextLink": ""
}

정의

Name Description
ErrorFieldContract

오류 필드 계약.
ErrorResponse

오류 응답.
GlobalSchemaCollection

목록 스키마 작업의 응답입니다.
GlobalSchemaContract

전역 스키마 계약 세부 정보입니다.
SchemaType

스키마 유형입니다. 변경 불가

ErrorFieldContract

오류 필드 계약.

Name 형식 Description
code

string

속성 수준 오류 코드입니다.
message

string

사람이 읽을 수 있는 속성 수준 오류 표현입니다.
target

string

속성 이름입니다.

ErrorResponse

오류 응답.

Name 형식 Description
error.code

string

서비스에서 정의한 오류 코드입니다. 이 코드는 응답에 지정된 HTTP 오류 코드의 하위 상태로 사용됩니다.
error.details

ErrorFieldContract[]

유효성 검사 오류가 발생한 경우 요청에 잘못된 필드가 전송됩니다.
error.message

string

사람이 읽을 수 있는 오류 표현입니다.

GlobalSchemaCollection

목록 스키마 작업의 응답입니다.

Name 형식 Description
count

integer

총 레코드 수 수입니다.
nextLink

string

다음 페이지 링크(있는 경우).
value

GlobalSchemaContract[]

전역 스키마 계약 값입니다.

GlobalSchemaContract

전역 스키마 계약 세부 정보입니다.

Name 형식 Description
id

string

리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

리소스의 이름입니다.
properties.description

string

자유 형식 스키마 엔터티 설명입니다.
properties.schemaType

SchemaType

스키마 유형입니다. 변경 불가
properties.value

json 기반이 아닌 스키마에 대한 Json 인코딩 문자열입니다.
type

string

리소스 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts"

SchemaType

스키마 유형입니다. 변경 불가

Name 형식 Description
json

string

Json 스키마 형식입니다.
xml

string

Xml 스키마 유형입니다.