다음을 통해 공유

az apim api schema

  • 참조

Azure API Management API 스키마를 관리합니다.

명령

Name Description 형식 상태
az apim api schema create

API Management API 스키마를 만듭니다.

 핵심 GA
az apim api schema delete

API Management API 스키마를 삭제합니다.

 핵심 GA
az apim api schema get-etag

API Management API 스키마의 etag를 가져옵니다.

 핵심 GA
az apim api schema list

API Management API 스키마를 나열합니다.

 핵심 GA
az apim api schema show

API Management API 스키마의 세부 정보를 표시합니다.

 핵심 GA
az apim api schema wait

apim api 스키마의 조건이 충족될 때까지 CLI를 대기 상태로 설정합니다.

 핵심 GA

az apim api schema create

편집

API Management API 스키마를 만듭니다.

az apim api schema create --api-id
                          --resource-group
                          --schema-id
                          --schema-type
                          --service-name
                          [--no-wait]
                          [--resource-type]
                          [--schema-content]
                          [--schema-name]
                          [--schema-path]

예제

API 스키마를 만듭니다.

az apim api schema create --service-name MyApim -g MyResourceGroup --api-id MyApi --schema-id schemaId --schema-type schemaType --schema-path schemaFilePath

필수 매개 변수

--api-id

스키마를 만들어야 하는 API의 고유 이름입니다.

API 수정 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 다음이 있습니다. rev=n은 접미사로, n은 수정 번호입니다.

--resource-group -g

리소스 그룹의 이름입니다. 를 사용하여 az configure --defaults group=<name>기본 그룹을 구성할 수 있습니다.

--schema-id

만들 API 스키마의 고유 이름입니다.

스키마 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.

--schema-type

스키마 유형(예: application/json, application/vnd.ms-azure-apim.graphql.schema).

RFC 2616에 정의된 대로 Content-Type 헤더에 사용되는 유효한 미디어 형식이어야 합니다. 스키마 문서의 미디어 형식입니다.

--service-name -n

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

선택적 매개 변수

--no-wait

장기 실행 작업이 완료되기를 기다리지 마세요.

기본값: False
--resource-type

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

--schema-content

스키마를 나타내는 문서를 정의하는 Json 이스케이프 문자열입니다.

둘 다 아닌 --schema-path 또는 --schema-content를 지정합니다.

--schema-name

스키마 리소스의 이름입니다.

--schema-path

API의 스키마를 가져오기 위해 지정된 파일 경로입니다.

둘 다 아닌 --schema-path 또는 --schema-content를 지정합니다.

전역 매개 변수
--debug

로깅의 자세한 정도를 늘려 모든 디버그 로그를 표시합니다.

--help -h

이 도움말 메시지를 표시하고 종료합니다.

--only-show-errors

경고를 표시하지 않고 오류만 표시합니다.

--output -o

출력 형식입니다.

허용되는 값: json, jsonc, none, table, tsv, yaml, yamlc
기본값: json
--query

JMESPath 쿼리 문자열입니다. 자세한 내용과 예제는 http://jmespath.org/를 참조하세요.

--subscription

구독의 이름 또는 ID입니다. 를 사용하여 az account set -s NAME_OR_ID기본 구독을 구성할 수 있습니다.

--verbose

로깅의 자세한 정도를 늘립니다. 전체 디버그 로그를 표시하려면 --debug를 사용합니다.

az apim api schema delete

편집

API Management API 스키마를 삭제합니다.

az apim api schema delete --api-id
                          --resource-group
                          --schema-id
                          --service-name
                          [--if-match]
                          [--no-wait]
                          [--yes]

예제

API 스키마를 삭제합니다.

az apim api schema delete --service-name MyApim -g MyResourceGroup --api-id MyApi --schema-id schemaId

필수 매개 변수

--api-id

API 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 다음이 있습니다. rev=n은 접미사로, n은 수정 번호입니다.

--resource-group -g

리소스 그룹의 이름입니다. 를 사용하여 az configure --defaults group=<name>기본 그룹을 구성할 수 있습니다.

--schema-id

스키마 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 다음이 있습니다. rev=n은 접미사로, n은 수정 번호입니다.

--service-name -n

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

선택적 매개 변수

--if-match

엔터티의 ETag입니다.

--no-wait

장기 실행 작업이 완료되기를 기다리지 마세요.

기본값: False
--yes -y

확인 메시지를 표시하지 않습니다.

기본값: False
전역 매개 변수
--debug

로깅의 자세한 정도를 늘려 모든 디버그 로그를 표시합니다.

--help -h

이 도움말 메시지를 표시하고 종료합니다.

--only-show-errors

경고를 표시하지 않고 오류만 표시합니다.

--output -o

출력 형식입니다.

허용되는 값: json, jsonc, none, table, tsv, yaml, yamlc
기본값: json
--query

JMESPath 쿼리 문자열입니다. 자세한 내용과 예제는 http://jmespath.org/를 참조하세요.

--subscription

구독의 이름 또는 ID입니다. 를 사용하여 az account set -s NAME_OR_ID기본 구독을 구성할 수 있습니다.

--verbose

로깅의 자세한 정도를 늘립니다. 전체 디버그 로그를 표시하려면 --debug를 사용합니다.

az apim api schema get-etag

편집

API Management API 스키마의 etag를 가져옵니다.

az apim api schema get-etag --api-id
                            --resource-group
                            --schema-id
                            --service-name

예제

스키마 엔터티 태그를 가져옵니다.

az apim api schema get-etag --service-name MyApim -g MyResourceGroup --api-id MyApi --schema-id schemaId

필수 매개 변수

--api-id

API 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 다음이 있습니다. rev=n은 접미사로, n은 수정 번호입니다.

--resource-group -g

리소스 그룹의 이름입니다. 를 사용하여 az configure --defaults group=<name>기본 그룹을 구성할 수 있습니다.

--schema-id

스키마 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 다음이 있습니다. rev=n은 접미사로, n은 수정 번호입니다.

--service-name -n

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

전역 매개 변수
--debug

로깅의 자세한 정도를 늘려 모든 디버그 로그를 표시합니다.

--help -h

이 도움말 메시지를 표시하고 종료합니다.

--only-show-errors

경고를 표시하지 않고 오류만 표시합니다.

--output -o

출력 형식입니다.

허용되는 값: json, jsonc, none, table, tsv, yaml, yamlc
기본값: json
--query

JMESPath 쿼리 문자열입니다. 자세한 내용과 예제는 http://jmespath.org/를 참조하세요.

--subscription

구독의 이름 또는 ID입니다. 를 사용하여 az account set -s NAME_OR_ID기본 구독을 구성할 수 있습니다.

--verbose

로깅의 자세한 정도를 늘립니다. 전체 디버그 로그를 표시하려면 --debug를 사용합니다.

az apim api schema list

편집

API Management API 스키마를 나열합니다.

az apim api schema list --api-id
                        --resource-group
                        --service-name
                        [--filter-display-name]
                        [--skip]
                        [--top]

예제

api ID와 연결된 스키마 목록을 가져옵니다.

az apim api schema list --service-name MyApim -g MyResourceGroup --api-id MyApi

필수 매개 변수

--api-id

API 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 다음이 있습니다. rev=n은 접미사로, n은 수정 번호입니다.

--resource-group -g

리소스 그룹의 이름입니다. 를 사용하여 az configure --defaults group=<name>기본 그룹을 구성할 수 있습니다.

--service-name -n

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

선택적 매개 변수

--filter-display-name

displayName별 API 필터입니다.

--skip

건너뛸 레코드 수입니다.

--top

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

전역 매개 변수
--debug

로깅의 자세한 정도를 늘려 모든 디버그 로그를 표시합니다.

--help -h

이 도움말 메시지를 표시하고 종료합니다.

--only-show-errors

경고를 표시하지 않고 오류만 표시합니다.

--output -o

출력 형식입니다.

허용되는 값: json, jsonc, none, table, tsv, yaml, yamlc
기본값: json
--query

JMESPath 쿼리 문자열입니다. 자세한 내용과 예제는 http://jmespath.org/를 참조하세요.

--subscription

구독의 이름 또는 ID입니다. 를 사용하여 az account set -s NAME_OR_ID기본 구독을 구성할 수 있습니다.

--verbose

로깅의 자세한 정도를 늘립니다. 전체 디버그 로그를 표시하려면 --debug를 사용합니다.

az apim api schema show

편집

API Management API 스키마의 세부 정보를 표시합니다.

az apim api schema show --api-id
                        --resource-group
                        --schema-id
                        --service-name

예제

API 스키마를 가져옵니다.

az apim api schema show --service-name MyApim -g MyResourceGroup --api-id MyApi --schema-id schemaId

필수 매개 변수

--api-id

API 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 다음이 있습니다. rev=n은 접미사로, n은 수정 번호입니다.

--resource-group -g

리소스 그룹의 이름입니다. 를 사용하여 az configure --defaults group=<name>기본 그룹을 구성할 수 있습니다.

--schema-id

스키마 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 다음이 있습니다. rev=n은 접미사로, n은 수정 번호입니다.

--service-name -n

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

전역 매개 변수
--debug

로깅의 자세한 정도를 늘려 모든 디버그 로그를 표시합니다.

--help -h

이 도움말 메시지를 표시하고 종료합니다.

--only-show-errors

경고를 표시하지 않고 오류만 표시합니다.

--output -o

출력 형식입니다.

허용되는 값: json, jsonc, none, table, tsv, yaml, yamlc
기본값: json
--query

JMESPath 쿼리 문자열입니다. 자세한 내용과 예제는 http://jmespath.org/를 참조하세요.

--subscription

구독의 이름 또는 ID입니다. 를 사용하여 az account set -s NAME_OR_ID기본 구독을 구성할 수 있습니다.

--verbose

로깅의 자세한 정도를 늘립니다. 전체 디버그 로그를 표시하려면 --debug를 사용합니다.

az apim api schema wait

편집

apim api 스키마의 조건이 충족될 때까지 CLI를 대기 상태로 설정합니다.

az apim api schema wait --api-id
                        --name
                        --resource-group
                        --schema-id
                        [--created]
                        [--custom]
                        [--deleted]
                        [--exists]
                        [--interval]
                        [--timeout]
                        [--updated]

예제

apim api 스키마의 조건이 충족될 때까지 CLI를 대기 상태로 설정합니다.

az apim api schema wait --created --api-id MyApi --name MyApim --schema-id schemaId -g MyResourceGroup

필수 매개 변수

--api-id

API 수정 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 다음이 있습니다. rev=n은 접미사로, n은 수정 번호입니다. 필수입니다.

--name -n

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

--resource-group -g

리소스 그룹의 이름입니다. 를 사용하여 az configure --defaults group=<name>기본 그룹을 구성할 수 있습니다.

--schema-id

스키마 ID 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다. 필수입니다.

선택적 매개 변수

--created

'Succeeded'에서 'provisioningState'를 사용하여 생성될 때까지 기다립니다.

기본값: False
--custom

조건이 사용자 지정 JMESPath 쿼리를 충족할 때까지 기다립니다. 예: provisioningState!='InProgress', instanceView. 상태es[?code=='PowerState/running'].

--deleted

삭제될 때까지 기다립니다.

기본값: False
--exists

리소스가 존재할 때까지 기다립니다.

기본값: False
--interval

폴링 간격(초)입니다.

기본값: 30
--timeout

최대 대기 시간(초)입니다.

기본값: 3600
--updated

'Succeeded'에서 provisioningState로 업데이트될 때까지 기다립니다.

기본값: False
전역 매개 변수
--debug

로깅의 자세한 정도를 늘려 모든 디버그 로그를 표시합니다.

--help -h

이 도움말 메시지를 표시하고 종료합니다.

--only-show-errors

경고를 표시하지 않고 오류만 표시합니다.

--output -o

출력 형식입니다.

허용되는 값: json, jsonc, none, table, tsv, yaml, yamlc
기본값: json
--query

JMESPath 쿼리 문자열입니다. 자세한 내용과 예제는 http://jmespath.org/를 참조하세요.

--subscription

구독의 이름 또는 ID입니다. 를 사용하여 az account set -s NAME_OR_ID기본 구독을 구성할 수 있습니다.

--verbose

로깅의 자세한 정도를 늘립니다. 전체 디버그 로그를 표시하려면 --debug를 사용합니다.