az apic

참고 항목

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

Azure API Center 서비스를 관리합니다.

명령

Name	Description	형식	상태
az apic api	API 센터에서 API를 관리하는 명령입니다.	내선 번호	GA
az apic api create	새 API를 등록하거나 기존 API를 업데이트합니다.	내선 번호	GA
az apic api definition	API 센터에서 API 정의를 관리하는 명령입니다.	내선 번호	GA
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 delete	지정된 API를 삭제합니다.	내선 번호	GA
az apic api deployment	API 센터에서 API 배포를 관리하는 명령입니다.	내선 번호	GA
az apic api deployment create	새 API 배포를 만들거나 기존 API 배포를 업데이트합니다.	내선 번호	GA
az apic api deployment delete	API 배포를 삭제합니다.	내선 번호	GA
az apic api deployment list	API 배포의 컬렉션을 나열합니다.	내선 번호	GA
az apic api deployment show	API 배포에 대한 세부 정보를 가져옵니다.	내선 번호	GA
az apic api deployment update	기존 API 배포를 업데이트합니다.	내선 번호	GA
az apic api list	API 컬렉션을 나열합니다.	내선 번호	GA
az apic api register	사양 파일을 진리 원본으로 사용하여 버전, 정의 및 관련 배포에 새 API를 등록합니다. 지금은 OpenAPI JSON/YAML 형식만 지원합니다.	내선 번호	프리뷰
az apic api show	API의 세부 정보를 가져옵니다.	내선 번호	GA
az apic api update	기존 API를 업데이트합니다.	내선 번호	GA
az apic api version	API 센터에서 API 버전을 관리하는 명령입니다.	내선 번호	GA
az apic api version create	새 API 버전을 만들거나 기존 API 버전을 업데이트합니다.	내선 번호	GA
az apic api version delete	지정된 API 버전을 삭제합니다.	내선 번호	GA
az apic api version list	API 버전의 컬렉션을 나열합니다.	내선 번호	GA
az apic api version show	API 버전의 세부 정보를 가져옵니다.	내선 번호	GA
az apic api version update	기존 API 버전을 업데이트합니다.	내선 번호	GA
az apic create	인스턴스를 만들거나 Azure API Center 서비스의 기존 인스턴스를 업데이트합니다.	내선 번호	GA
az apic delete	Azure API Center 서비스의 인스턴스를 삭제합니다.	내선 번호	GA
az apic environment	API 센터에서 환경을 관리하는 명령입니다.	내선 번호	GA
az apic environment create	새 환경을 만들거나 기존 환경을 업데이트합니다.	내선 번호	GA
az apic environment delete	환경을 삭제합니다.	내선 번호	GA
az apic environment list	환경 컬렉션을 나열합니다.	내선 번호	GA
az apic environment show	환경의 세부 정보를 가져옵니다.	내선 번호	GA
az apic environment update	기존 환경을 업데이트합니다.	내선 번호	GA
az apic import-from-apim	Azure API Management 서비스 인스턴스에서 API를 가져옵니다.	내선 번호	GA
az apic list	Azure 구독 내의 Azure API Center 서비스를 나열합니다.	내선 번호	GA
az apic metadata	API 센터에서 메타데이터 스키마를 관리하는 명령입니다.	내선 번호	GA
az apic metadata create	새 메타데이터 스키마를 만들거나 기존 메타데이터 스키마를 업데이트합니다.	내선 번호	GA
az apic metadata delete	지정된 메타데이터 스키마를 삭제합니다.	내선 번호	GA
az apic metadata export	메타데이터 스키마를 내보냅니다.	내선 번호	GA
az apic metadata list	메타데이터 스키마 컬렉션을 나열합니다.	내선 번호	GA
az apic metadata show	메타데이터 스키마의 세부 정보를 가져옵니다.	내선 번호	GA
az apic metadata update	기존 메타데이터 스키마를 업데이트합니다.	내선 번호	GA
az apic show	Azure API Center 서비스 인스턴스의 세부 정보를 표시합니다.	내선 번호	GA
az apic update	Azure API Center 서비스의 인스턴스를 업데이트합니다.	내선 번호	GA

az apic create

인스턴스를 만들거나 Azure API Center 서비스의 기존 인스턴스를 업데이트합니다.

az apic create --name
               --resource-group
               [--identity]
               [--location]
               [--tags]

예제

서비스 만들기 예제 1

az apic create -g contoso-resources -n contoso -l eastus

서비스 예제 2 만들기

az apic create --resource-group contoso-resources --name contoso --location eastus

필수 매개 변수

--name -n

API 센터 서비스의 이름입니다.

--resource-group -g

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

선택적 매개 변수

--identity

이 리소스에 할당된 관리 서비스 ID입니다. 약식 구문, json-file 및 yaml-file을 지원합니다. 더 많은 것을 표시하려면 "??"를 시도해 보세요.

--location -l

리소스가 있는 지리적 위치(지정되지 않은 경우) 리소스 그룹의 위치가 사용됩니다.

--tags

리소스 태그. 약식 구문, json-file 및 yaml-file을 지원합니다. 더 많은 것을 표시하려면 "??"를 시도해 보세요.

전역 매개 변수

--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 delete

Azure API Center 서비스의 인스턴스를 삭제합니다.

az apic delete [--ids]
               [--name]
               [--resource-group]
               [--subscription]
               [--yes]

예제

서비스 삭제

az apic delete -n contoso -g contoso-resources

선택적 매개 변수

--ids

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

--name -n

API 센터 서비스의 이름입니다.

--resource-group -g

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

--subscription

구독의 이름 또는 ID입니다. az account set -s NAME_OR_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 import-from-apim

Azure API Management 서비스 인스턴스에서 API를 가져옵니다.

az apic import-from-apim --apim-apis
                         --apim-name
                         [--apim-resource-group]
                         [--apim-subscription]
                         [--ids]
                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                         [--resource-group]
                         [--service-name]
                         [--subscription]

예제

동일한 리소스 그룹의 API에서 모든 API 가져오기

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-name contoso-apim --apim-apis *

동일한 리소스 그룹의 APIM에서 선택한 API 가져오기

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-name contoso-apim --apim-apis [echo,foo]

다른 구독 및 리소스 그룹의 API에서 모든 API 가져오기

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-subscription 00000000-0000-0000-0000-000000000000 --apim-resource-group apim-rg --apim-name contoso-apim --apim-apis *

필수 매개 변수

--apim-apis

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

--apim-name

원본 APIM 인스턴스의 이름입니다.

선택적 매개 변수

--apim-resource-group

원본 APIM 인스턴스의 리소스 그룹입니다.

--apim-subscription

원본 APIM 인스턴스의 구독 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를 사용하여 기본 위치를 구성할 수 있습니다.

전역 매개 변수

--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 list

Azure 구독 내의 Azure API Center 서비스를 나열합니다.

구독에 있는 모든 리소스가 작동하지 않는 알려진 문제가 있습니다. 리소스 그룹별로 리소스를 나열하세요.

az apic list [--max-items]
             [--next-token]
             [--resource-group]

예제

리소스 그룹의 서비스 나열

az apic list -g contoso-resources

선택적 매개 변수

--max-items

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

--next-token

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

--resource-group -g

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

전역 매개 변수

--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 show

Azure API Center 서비스 인스턴스의 세부 정보를 표시합니다.

az apic show [--ids]
             [--name]
             [--resource-group]
             [--subscription]

예제

서비스 세부 정보 표시

az apic show -g contoso-resources -n contoso

선택적 매개 변수

--ids

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

--name -n

API 센터 서비스의 이름입니다.

--resource-group -g

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

--subscription

구독의 이름 또는 ID입니다. az account set -s NAME_OR_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 update

Azure API Center 서비스의 인스턴스를 업데이트합니다.

az apic update [--add]
               [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
               [--identity]
               [--ids]
               [--name]
               [--remove]
               [--resource-group]
               [--set]
               [--subscription]
               [--tags]

예제

서비스 세부 정보 업데이트

az apic update -g contoso-resources -n contoso

선택적 매개 변수

--add

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

--force-string

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

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

--identity

이 리소스에 할당된 관리 서비스 ID입니다. 약식 구문, json-file 및 yaml-file을 지원합니다. 더 많은 것을 표시하려면 "??"를 시도해 보세요.

--ids

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

--name -n

API 센터 서비스의 이름입니다.

--remove

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

--resource-group -g

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

--set

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

--subscription

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

--tags

리소스 태그. 약식 구문, json-file 및 yaml-file을 지원합니다. 더 많은 것을 표시하려면 "??"를 시도해 보세요.

전역 매개 변수

--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를 사용합니다.