az apim

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

명령

az apim api

Azure API Management API를 관리합니다.

az apim api create

API Management API를 만듭니다.

az apim api delete

API Management API를 삭제합니다.

az apim api import

API Management API를 가져옵니다.

az apim api list

API Management API를 나열합니다.

az apim api operation

Azure API Management API 작업을 관리 합니다.

az apim api operation create

API에서 새 작업을 만듭니다.

az apim api operation delete

API에서 지정된 작업을 삭제합니다.

az apim api operation list

지정 된 API에 대 한 작업 컬렉션을 나열 합니다.

az apim api operation show

해당 식별자로 지정 된 API 작업에 대 한 세부 정보를 가져옵니다.

az apim api operation update

해당 식별자로 지정 된 API의 작업 세부 정보를 업데이트 합니다.

az apim api release

Azure API Management API 릴리스를 관리 합니다.

az apim api release create

API에 대한 새 릴리스를 만듭니다.

az apim api release delete

API에서 지정 된 릴리스를 삭제 합니다.

az apim api release list

API의 모든 릴리스를 나열합니다.

az apim api release show

API 릴리스의 세부 정보를 반환 합니다.

az apim api release update

식별자로 지정 된 API 릴리스의 세부 정보를 업데이트 합니다.

az apim api revision

Azure API Management API 수정 버전을 관리합니다.

az apim api revision create

API 수정 버전을 만듭니다.

az apim api revision list

API의 모든 수정 버전을 나열합니다.

az apim api show

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

az apim api update

API Management API를 업데이트합니다.

az apim api versionset

Azure API Management API 버전 집합을 관리합니다.

az apim api versionset create

API 버전 집합을 만듭니다.

az apim api versionset delete

특정 API 버전 집합을 삭제합니다.

az apim api versionset list

지정된 서비스 인스턴스의 API 버전 집합 컬렉션을 나열합니다.

az apim api versionset show

식별자가 지정한 API 버전 집합의 세부 정보를 가져옵니다.

az apim api versionset update

식별자가 지정한 Api VersionSet의 세부 정보를 업데이트합니다.

az apim api wait

apim API의 조건이 충족될 때까지 CLI를 대기 상태로 하십시오.

az apim apply-network-updates

API Management 서비스를 구성된 스토리지 계정에 백업합니다.

az apim backup

지정된 Azure Storage 계정에 API Management 서비스의 백업을 만듭니다. 이 작업은 장기 실행 작업이며 완료하는 데 몇 분 정도 걸릴 수 있습니다.

az apim check-name

서비스 이름을 사용할 수 있는지 확인합니다.

az apim create

API Management 서비스 인스턴스 만들기

az apim delete

API Management 서비스를 삭제합니다.

az apim list

API Management 서비스 인스턴스를 나열합니다.

az apim nv

Azure API Management 명명된 값을 관리합니다.

az apim nv create

명명된 API Management 만듭니다.

az apim nv delete

API Management 명명된 값을 삭제합니다.

az apim nv list

명명된 값을 API Management 나열합니다.

az apim nv show

API Management 명명된 값의 세부 정보를 표시합니다.

az apim nv show-secret

API Management 명명된 값의 비밀을 가져옵니다.

az apim nv update

API Management 명명된 값을 업데이트합니다.

az apim product

Azure API Management 제품을 관리합니다.

az apim product api

Azure API Management 제품의 Api를 관리 합니다.

az apim product api add

지정 된 제품에 API를 추가 합니다.

az apim product api check

식별자로 지정 된 API 엔터티가 Product 엔터티와 연결 되어 있는지 확인 합니다.

az apim product api delete

지정된 제품에서 지정된 API를 삭제합니다.

az apim product api list

제품과 연결된 API의 컬렉션을 나열합니다.

az apim product create

제품을 만듭니다.

az apim product delete

제품을 삭제합니다.

az apim product list

지정된 서비스 인스턴스의 제품 컬렉션을 나열합니다.

az apim product show

식별자가 지정한 제품의 세부 정보를 가져옵니다.

az apim product update

기존 제품 세부 정보를 업데이트합니다.

az apim product wait

apim 제품의 조건이 충족될 때까지 CLI를 대기 상태로 하십시오.

az apim restore

현재 서비스의 ApiManagementService_Backup 작업을 사용하여 만든 API Management 서비스의 백업을 복원합니다. 이는 장기 실행 작업이며 완료하는 데 몇 분 정도 걸릴 수 있습니다.

az apim show

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

az apim update

API Management 서비스 인스턴스를 업데이트합니다.

az apim wait

apim 조건이 충족될 때까지 CLI를 대기 상태로 유지합니다.

az apim apply-network-updates

API Management 서비스를 구성된 스토리지 계정에 백업합니다.

az apim apply-network-updates --name
                              --resource-group
                              [--location]
                              [--no-wait]
                              [--subscription]

필수 매개 변수

--name -n

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

--resource-group -g

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

선택적 매개 변수

--location -l

위치입니다. 값 출처: az account list-locations. az configure --defaults location=<location>을 사용하여 기본 위치를 구성할 수 있습니다.

--no-wait

장기 실행 작업이 완료될 때까지 기다리지 마세요.

--subscription

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

az apim backup

지정된 Azure Storage 계정에 API Management 서비스의 백업을 만듭니다. 이 작업은 장기 실행 작업이며 완료하는 데 몇 분 정도 걸릴 수 있습니다.

az apim backup --backup-name
               --container-name
               --name
               --resource-group
               --storage-account-key
               --storage-account-name
               [--no-wait]
               [--subscription]

예제

API Management 서비스 인스턴스의 백업 만들기

az apim backup --name MyApim -g MyResourceGroup --backup-name myBackup              --storage-account-name mystorageaccount --storage-account-container backups              --storage-account-key Ay2ZbdxLnD4OJPT29F6jLPkB6KynOzx85YCObhrw==

필수 매개 변수

--backup-name

만들 백업 파일의 이름입니다.

--container-name --storage-account-container

백업을 배치하는 데 사용되는 스토리지 계정 컨테이너의 이름입니다.

--name -n

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

--resource-group -g

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

--storage-account-key

백업을 배치하는 데 사용되는 스토리지 계정의 액세스 키입니다.

--storage-account-name

백업을 배치하는 데 사용되는 스토리지 계정의 이름입니다.

선택적 매개 변수

--no-wait

장기 실행 작업이 완료될 때까지 기다리지 마세요.

--subscription

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

az apim check-name

서비스 이름을 사용할 수 있는지 확인합니다.

az apim check-name --name
                   [--subscription]

필수 매개 변수

--name -n

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

선택적 매개 변수

--subscription

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

az apim create

API Management 서비스 인스턴스 만들기

az apim create --name
               --publisher-email
               --publisher-name
               --resource-group
               [--enable-client-certificate {false, true}]
               [--enable-managed-identity {false, true}]
               [--location]
               [--no-wait]
               [--sku-capacity]
               [--sku-name {Basic, Consumption, Developer, Premium, Standard}]
               [--subscription]
               [--tags]
               [--virtual-network {External, Internal, None}]

예제

개발자 계층 API Management 서비스를 만듭니다.

az apim create --name MyApim -g MyResourceGroup -l eastus --publisher-email email@mydomain.com --publisher-name Microsoft

소비 계층 API Management 서비스를 만듭니다.

az apim create --name MyApim -g MyResourceGroup -l eastus --sku-name Consumption --enable-client-certificate \
    --publisher-email email@mydomain.com --publisher-name Microsoft

필수 매개 변수

--name -n

만들 서비스 인스턴스의 고유한 이름입니다.

--publisher-email

모든 시스템 알림을 받을 전자 메일 주소입니다.

--publisher-name

개발자 포털 및 전자 메일 알림에서 사용할 조직의 이름입니다.

--resource-group -g

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

선택적 매개 변수

--enable-client-certificate

게이트웨이에 대한 각 요청에 대해 클라이언트 인증서를 표시하도록 적용하고 게이트웨이의 정책에서 인증서를 인증하는 기능도 사용하도록 설정합니다.

허용되는 값: false, true
--enable-managed-identity

API Management 서비스에 대한 관리 ID를 만들어 다른 Azure 리소스에 액세스합니다.

허용되는 값: false, true
--location -l

위치입니다. 값 출처: az account list-locations. az configure --defaults location=<location>을 사용하여 기본 위치를 구성할 수 있습니다.

--no-wait

장기 실행 작업이 완료될 때까지 기다리지 마세요.

--sku-capacity

SKU의 배포된 단위 수입니다.

기본값: 1
--sku-name

API Management 인스턴스의 sku입니다.

허용되는 값: Basic, Consumption, Developer, Premium, Standard
기본값: Developer
--subscription

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

--tags

공백으로 구분된 태그: key[=value] [key[=value] ...]. ""를 사용하여 기존 태그를 지웁니다.

--virtual-network -v

가상 네트워크 유형입니다.

허용되는 값: External, Internal, None
기본값: None

az apim delete

API Management 서비스를 삭제합니다.

az apim delete --name
               --resource-group
               [--no-wait]
               [--subscription]
               [--yes]

예제

API Management 서비스를 삭제합니다.

az apim delete -n MyApim -g MyResourceGroup

필수 매개 변수

--name -n

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

--resource-group -g

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

선택적 매개 변수

--no-wait

장기 실행 작업이 완료될 때까지 기다리지 마세요.

--subscription

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

--yes -y

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

az apim list

API Management 서비스 인스턴스를 나열합니다.

az apim list [--query-examples]
             [--resource-group]
             [--subscription]

선택적 매개 변수

--query-examples

JMESPath 문자열을 권장합니다. 쿼리 중 하나를 복사하여 큰따옴표 안에 --query 매개 변수를 붙여넣어 결과를 확인할 수 있습니다. 이러한 키워드를 기반으로 제안을 제공할 수 있도록 하나 이상의 위치 키워드를 추가할 수 있습니다.

--resource-group -g

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

--subscription

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

az apim restore

현재 서비스의 ApiManagementService_Backup 작업을 사용하여 만든 API Management 서비스의 백업을 복원합니다. 이는 장기 실행 작업이며 완료하는 데 몇 분 정도 걸릴 수 있습니다.

az apim restore --backup-name
                --container-name
                --name
                --resource-group
                --storage-account-key
                --storage-account-name
                [--no-wait]
                [--subscription]

예제

API Management 서비스 인스턴스의 백업을 복원합니다.

az apim restore --name MyApim -g MyResourceGroup --backup-name myBackup              --storage-account-name mystorageaccount --storage-account-container backups              --storage-account-key Ay2ZbdxLnD4OJPT29F6jLPkB6KynOzx85YCObhrw==

필수 매개 변수

--backup-name

복원할 백업 파일의 이름입니다.

--container-name --storage-account-container

백업을 검색하는 데 사용되는 스토리지 계정 컨테이너의 이름입니다.

--name -n

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

--resource-group -g

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

--storage-account-key

백업을 검색하는 데 사용되는 스토리지 계정의 액세스 키입니다.

--storage-account-name

백업을 검색하는 데 사용되는 스토리지 계정의 이름입니다.

선택적 매개 변수

--no-wait

장기 실행 작업이 완료될 때까지 기다리지 마세요.

--subscription

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

az apim show

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

az apim show --name
             --resource-group
             [--query-examples]
             [--subscription]

필수 매개 변수

--name -n

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

--resource-group -g

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

선택적 매개 변수

--query-examples

JMESPath 문자열을 권장합니다. 쿼리 중 하나를 복사하여 큰따옴표 안에 --query 매개 변수를 붙여넣어 결과를 확인할 수 있습니다. 이러한 키워드를 기반으로 제안을 제공할 수 있도록 하나 이상의 위치 키워드를 추가할 수 있습니다.

--subscription

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

az apim update

API Management 서비스 인스턴스를 업데이트합니다.

az apim update --name
               --resource-group
               [--add]
               [--enable-client-certificate {false, true}]
               [--enable-managed-identity {false, true}]
               [--force-string]
               [--no-wait]
               [--publisher-email]
               [--publisher-name]
               [--remove]
               [--set]
               [--sku-capacity]
               [--sku-name {Basic, Consumption, Developer, Premium, Standard}]
               [--subscription]
               [--tags]
               [--virtual-network {External, Internal, None}]

필수 매개 변수

--name -n

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

--resource-group -g

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

선택적 매개 변수

--add

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

--enable-client-certificate

게이트웨이에 대한 각 요청에 대해 클라이언트 인증서를 표시하도록 적용하고 게이트웨이의 정책에서 인증서를 인증하는 기능도 사용하도록 설정합니다.

허용되는 값: false, true
--enable-managed-identity

API Management 서비스에 대한 관리 ID를 만들어 다른 Azure 리소스에 액세스합니다.

허용되는 값: false, true
--force-string

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

--no-wait

장기 실행 작업이 완료될 때까지 기다리지 마세요.

--publisher-email

모든 시스템 알림을 받을 전자 메일 주소입니다.

--publisher-name

개발자 포털 및 전자 메일 알림에서 사용할 조직의 이름입니다.

--remove

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

--set

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

--sku-capacity

SKU의 배포된 단위 수입니다.

--sku-name

API Management 인스턴스의 sku입니다.

허용되는 값: Basic, Consumption, Developer, Premium, Standard
--subscription

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

--tags

공백으로 구분된 태그: key[=value] [key[=value] ...]. ""를 사용하여 기존 태그를 지웁니다.

--virtual-network -v

가상 네트워크 유형입니다.

허용되는 값: External, Internal, None

az apim wait

apim 조건이 충족될 때까지 CLI를 대기 상태로 유지합니다.

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

예제

apim 조건이 충족될 때까지 CLI를 대기 상태로 유지합니다. (자동 생성)

az apim wait --created --name MyApim --resource-group MyResourceGroup

필수 매개 변수

--name -n

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

--resource-group -g

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

선택적 매개 변수

--created

'Succeeded'에서 'provisioningState'를 통해 생성될 때까지 기다립니다.

--custom

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

--deleted

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

--exists

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

--interval

폴링 간격(초)입니다.

기본값: 30
--subscription

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

--timeout

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

기본값: 3600
--updated

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