다음을 통해 공유

az apic api definition

  • 참조

참고 항목

이 참조는 Azure CLI(버전 2.57.0 이상)에 대한 apic 확장 확장의 일부입니다. az apic api definition 명령을 처음 실행할 때 확장이 자동으로 설치됩니다. 확장 프로그램에 대해 자세히 알아보세요.

API 센터에서 API 정의를 관리하는 명령입니다.

명령

Name Description 형식 상태
az apic api definition create

새 API 정의를 만들거나 기존 API 정의를 업데이트합니다.

 내선 번호 GA
az apic api definition delete

지정된 API 정의를 삭제합니다.

 내선 번호 GA
az apic api definition export-specification

API 사양을 내보냅니다.

 내선 번호 GA
az apic api definition import-specification

API 사양을 가져옵니다.

 내선 번호 GA
az apic api definition list

API 정의 컬렉션을 나열합니다.

 내선 번호 GA
az apic api definition show

API 정의에 대한 세부 정보를 가져옵니다.

 내선 번호 GA
az apic api definition update

기존 API 정의를 업데이트합니다.

 내선 번호 GA

az apic api definition create

새 API 정의를 만들거나 기존 API 정의를 업데이트합니다.

az apic api definition create --api-id
                              --definition-id
                              --resource-group
                              --service-name
                              --title
                              --version-id
                              [--description]

예제

API 정의 만들기

az apic api definition create -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi" --title "OpenAPI"

필수 매개 변수

--api-id

API의 ID입니다.

--definition-id

API 정의의 ID입니다.

--resource-group -g

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

--service-name -n

Azure API Center 서비스의 이름입니다.

--title

API 버전

--version-id

API 버전의 ID입니다.

선택적 매개 변수

--description

API 정의 설명입니다.

전역 매개 변수
--debug

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

--help -h

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

--only-show-errors

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

--output -o

출력 형식입니다.

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

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

--subscription

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

--verbose

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

az apic api definition delete

지정된 API 정의를 삭제합니다.

az apic api definition delete [--api-id]
                              [--definition-id]
                              [--ids]
                              [--resource-group]
                              [--service-name]
                              [--subscription]
                              [--version-id]
                              [--yes]

예제

API 정의 삭제

az apic api definition delete -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi"

선택적 매개 변수

--api-id

API의 ID입니다.

--definition-id

API 정의의 ID입니다.

--ids

하나 이상의 리소스 ID(공백으로 구분)입니다. '리소스 ID' 인수의 모든 정보를 포함하는 완전한 리소스 ID여야 합니다. --ids 또는 기타 '리소스 ID' 인수를 제공해야 합니다.

--resource-group -g

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

--service-name -n

Azure API Center 서비스의 이름입니다.

--subscription

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

--version-id

API 버전의 ID입니다.

--yes -y

확인을 묻는 메시지를 표시하지 마세요.

Default value: False
전역 매개 변수
--debug

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

--help -h

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

--only-show-errors

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

--output -o

출력 형식입니다.

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

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

--subscription

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

--verbose

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

az apic api definition export-specification

API 사양을 내보냅니다.

az apic api definition export-specification --file-name
                                            [--api-id]
                                            [--definition-id]
                                            [--ids]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--resource-group]
                                            [--service-name]
                                            [--subscription]
                                            [--version-id]

예제

내보내기 사양

az apic api definition export-specification -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id default --file-name filename.json

필수 매개 변수

--file-name

사양을 내보낼 파일의 이름입니다.

선택적 매개 변수

--api-id

API의 ID입니다.

--definition-id

API 정의의 ID입니다.

--ids

하나 이상의 리소스 ID(공백으로 구분)입니다. '리소스 ID' 인수의 모든 정보를 포함하는 완전한 리소스 ID여야 합니다. --ids 또는 기타 '리소스 ID' 인수를 제공해야 합니다.

--no-wait

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

허용되는 값: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

--service-name -n

Azure API Center 서비스의 이름입니다.

--subscription

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

--version-id

API 버전의 ID입니다.

전역 매개 변수
--debug

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

--help -h

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

--only-show-errors

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

--output -o

출력 형식입니다.

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

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

--subscription

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

--verbose

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

az apic api definition import-specification

API 사양을 가져옵니다.

az apic api definition import-specification --format {inline, link}
                                            --specification
                                            --value
                                            [--api-id]
                                            [--definition-id]
                                            [--ids]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--resource-group]
                                            [--service-name]
                                            [--subscription]
                                            [--version-id]

예제

가져오기 사양 예제 1

az apic api definition import-specification -g api-center-test -n contosoeuap --api-id echo-api-2 --version-id 2023-08-01 --definition-id openapi3 --format "inline" --value '{"openapi":"3.0.1","info":{"title":"httpbin.org","description":"API Management facade for a very handy and free online HTTP tool.","version":"1.0"}}' --specification '{"name":"openapi","version":"3.0.0"}'

가져오기 사양 예제 2

az apic api definition import-specification -g api-center-test -n contoso --api-id echo-api --version-id 2023-11-01 --definition-id openapi --format "link" --value 'https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json' --specification '{"name":"openapi","version":"3.0.0"}'

필수 매개 변수

--format

API 사양 원본의 형식입니다.

허용되는 값: inline, link
--specification

API 사양 세부 정보입니다. 약식 구문, json-file 및 yaml-file을 지원합니다. 더 많은 것을 표시하려면 "??"를 시도해 보세요.

--value

API 사양 원본의 값입니다.

선택적 매개 변수

--api-id

API의 ID입니다.

--definition-id

API 정의의 ID입니다.

--ids

하나 이상의 리소스 ID(공백으로 구분)입니다. '리소스 ID' 인수의 모든 정보를 포함하는 완전한 리소스 ID여야 합니다. --ids 또는 기타 '리소스 ID' 인수를 제공해야 합니다.

--no-wait

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

허용되는 값: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

--service-name -n

Azure API Center 서비스의 이름입니다.

--subscription

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

--version-id

API 버전의 ID입니다.

전역 매개 변수
--debug

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

--help -h

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

--only-show-errors

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

--output -o

출력 형식입니다.

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

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

--subscription

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

--verbose

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

az apic api definition list

API 정의 컬렉션을 나열합니다.

az apic api definition list --api-id
                            --resource-group
                            --service-name
                            --version-id
                            [--filter]
                            [--max-items]
                            [--next-token]

예제

API 정의 나열

az apic api definition list -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01

필수 매개 변수

--api-id

API의 ID입니다.

--resource-group -g

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

--service-name -n

Azure API Center 서비스의 이름입니다.

--version-id

API 버전의 ID입니다.

선택적 매개 변수

--filter

OData 필터 매개 변수입니다.

--max-items

명령의 출력에서 반환할 총 항목 수입니다. 사용 가능한 총 항목 수가 지정된 값보다 많으면 명령의 출력에 토큰이 제공됩니다. 페이지 매김을 다시 시작하려면 후속 명령의 인수에 --next-token 토큰 값을 제공합니다.

--next-token

페이지 매김을 시작할 위치를 지정하는 토큰입니다. 이는 이전에 잘린 응답의 토큰 값입니다.

전역 매개 변수
--debug

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

--help -h

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

--only-show-errors

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

--output -o

출력 형식입니다.

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

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

--subscription

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

--verbose

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

az apic api definition show

API 정의에 대한 세부 정보를 가져옵니다.

az apic api definition show [--api-id]
                            [--definition-id]
                            [--ids]
                            [--resource-group]
                            [--service-name]
                            [--subscription]
                            [--version-id]

예제

API 정의 세부 정보 표시

az apic api definition show -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi"

선택적 매개 변수

--api-id

API의 ID입니다.

--definition-id

API 정의의 ID입니다.

--ids

하나 이상의 리소스 ID(공백으로 구분)입니다. '리소스 ID' 인수의 모든 정보를 포함하는 완전한 리소스 ID여야 합니다. --ids 또는 기타 '리소스 ID' 인수를 제공해야 합니다.

--resource-group -g

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

--service-name -n

Azure API Center 서비스의 이름입니다.

--subscription

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

--version-id

API 버전의 ID입니다.

전역 매개 변수
--debug

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

--help -h

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

--only-show-errors

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

--output -o

출력 형식입니다.

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

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

--subscription

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

--verbose

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

az apic api definition update

기존 API 정의를 업데이트합니다.

az apic api definition update [--add]
                              [--api-id]
                              [--definition-id]
                              [--description]
                              [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                              [--ids]
                              [--remove]
                              [--resource-group]
                              [--service-name]
                              [--set]
                              [--subscription]
                              [--title]
                              [--version-id]

예제

API 정의 업데이트

az apic api definition update -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi" --title "OpenAPI"

선택적 매개 변수

--add

경로 및 키 값 쌍을 지정하여 개체 목록에 개체를 추가합니다. 예: --add property.listProperty <key=value, string 또는 JSON 문자열>.

--api-id

API의 ID입니다.

--definition-id

API 정의의 ID입니다.

--description

API 정의 설명입니다.

--force-string

'set' 또는 'add'를 사용하는 경우 JSON으로 변환하는 대신 문자열 리터럴을 유지합니다.

허용되는 값: 0, 1, f, false, n, no, t, true, y, yes
--ids

하나 이상의 리소스 ID(공백으로 구분)입니다. '리소스 ID' 인수의 모든 정보를 포함하는 완전한 리소스 ID여야 합니다. --ids 또는 기타 '리소스 ID' 인수를 제공해야 합니다.

--remove

목록에서 속성 또는 요소를 제거합니다. 예: --remove property.list OR --remove propertyToRemove.

--resource-group -g

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

--service-name -n

Azure API Center 서비스의 이름입니다.

--set

설정할 속성 경로와 값을 지정하여 개체를 업데이트합니다. 예: --set property1.property2=.

--subscription

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

--title

API 버전 제목입니다.

--version-id

API 버전의 ID입니다.

전역 매개 변수
--debug

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

--help -h

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

--only-show-errors

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

--output -o

출력 형식입니다.

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

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

--subscription

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

--verbose

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