az apim product

참조

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

명령

Name	Description	형식	상태
az apim product api	Azure API Management 제품의 API를 관리합니다.	핵심	GA
az apim product api add	지정된 제품에 API를 추가합니다.	핵심	GA
az apim product api check	식별자가 지정한 API 엔터티가 Product 엔터티와 연결되어 있는지 확인합니다.	핵심	GA
az apim product api delete	지정된 제품에서 지정된 API를 삭제합니다.	핵심	GA
az apim product api list	제품과 연결된 API 컬렉션을 나열합니다.	핵심	GA
az apim product create	제품을 만듭니다.	핵심	GA
az apim product delete	제품을 삭제합니다.	핵심	GA
az apim product list	지정된 서비스 인스턴스의 제품 컬렉션을 나열합니다.	핵심	GA
az apim product show	식별자가 지정한 제품의 세부 정보를 가져옵니다.	핵심	GA
az apim product update	기존 제품 세부 정보를 업데이트합니다.	핵심	GA
az apim product wait	apim 제품의 조건이 충족될 때까지 CLI를 대기 상태로 하십시오.	핵심	GA

az apim product create

편집

제품을 만듭니다.

az apim product create --product-name
                       --resource-group
                       --service-name
                       [--approval-required {false, true}]
                       [--description]
                       [--legal-terms]
                       [--no-wait]
                       [--product-id]
                       [--state {notPublished, published}]
                       [--subscription-required {false, true}]
                       [--subscriptions-limit]

예제

제품을 만듭니다.

az apim product create --resource-group MyResourceGroup  --service-name MyServiceName --product-id MyProductID --product-name MyProductName --description MyDescription --legal-terms MyTerms --subscription-required true --approval-required true --subscriptions-limit 8 --state "published"

필수 매개 변수

--product-name

제품 이름

--resource-group -g

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

--service-name -n

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

선택적 매개 변수

--approval-required

구독 승인이 필요한지 여부입니다. false이면 개발자가 구독 직후 제품의 API를 호출할 수 있도록 새 구독이 자동으로 승인됩니다. true이면 개발자가 제품의 API를 사용하려면 먼저 관리자가 구독을 수동으로 승인해야 합니다. subscriptionRequired 속성이 있고 값이 false인 경우에만 존재할 수 있습니다.

허용되는 값: false, true

--description

제품 설명입니다. HTML 서식 태그를 포함할 수 있습니다.

--legal-terms

제품 사용 약관. 제품을 구독하려는 개발자는 구독 프로세스를 완료하기 전에 이러한 약관에 동의해야 합니다.

--no-wait

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

기본값: False

--product-id

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

--state

제품이 게시되었는지 여부입니다. 게시된 제품은 개발자 포털 사용자가 검색할 수 있습니다. 게시되지 않은 제품은 관리자에게만 표시됩니다. 제품의 기본 상태는 NotPublished입니다. 가능한 값은 'notPublished', 'published'입니다.

허용되는 값: notPublished, published

--subscription-required -s

이 제품에 포함된 API에 액세스하기 위해 제품 구독이 필요한지 여부입니다.

허용되는 값: false, true

--subscriptions-limit

사용자가 이 제품에 동시에 사용할 수 있는 구독 수입니다. 사용자 구독당 무제한을 허용하려면 null로 설정하거나 생략합니다. subscriptionRequired 속성이 있고 값이 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 product delete

편집

제품을 삭제합니다.

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

예제

이 제품에 대한 모든 구독이 있는 제품을 삭제합니다.

az apim product delete --resource-group MyResourceGroup  --service-name MyServiceName --product-id MyProductID --delete-subscriptions true

필수 매개 변수

--product-id

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

--resource-group -g

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

--service-name -n

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

선택적 매개 변수

--delete-subscriptions

제품과 연결된 기존 구독을 삭제합니다.

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

편집

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

az apim product list --resource-group
                     --service-name

예제

이 APIM 인스턴스에 대한 모든 제품을 나열합니다.

az apim product list --resource-group MyResourceGroup --service-name MyServiceName

필수 매개 변수

--resource-group -g

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

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

편집

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

az apim product show --product-id
                     --resource-group
                     --service-name

예제

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

az apim product show --resource-group MyResourceGroup --service-name MyServiceName  --product-id MyProductID

필수 매개 변수

--product-id

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

--resource-group -g

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

--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 product update

편집

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

az apim product update --product-id
                       --resource-group
                       --service-name
                       [--add]
                       [--approval-required {false, true}]
                       [--description]
                       [--force-string]
                       [--if-match]
                       [--legal-terms]
                       [--no-wait]
                       [--product-name]
                       [--remove]
                       [--set]
                       [--state {notPublished, published}]
                       [--subscription-required {false, true}]
                       [--subscriptions-limit]

예제

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

az apim product update --resource-group MyResourceGroup  --service-name MyServiceName --product-id MyProductID --product-name MyNewProductName --description MyNewDescription --legal-terms MyNewTerms --subscription-required false --state "notPublished"

필수 매개 변수

--product-id

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

--resource-group -g

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

--service-name -n

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

선택적 매개 변수

--add

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

기본값: []

--approval-required

허용되는 값: false, true

--description

제품 설명입니다. HTML 서식 태그를 포함할 수 있습니다.

--force-string

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

기본값: False

--if-match

엔터티의 ETag입니다.

--legal-terms

제품 사용 약관. 제품을 구독하려는 개발자는 구독 프로세스를 완료하기 전에 이러한 약관에 동의해야 합니다.

--no-wait

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

기본값: False

--product-name

제품 이름

--remove

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

기본값: []

--set

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

기본값: []

--state

허용되는 값: notPublished, published

--subscription-required -s

이 제품에 포함된 API에 액세스하기 위해 제품 구독이 필요한지 여부입니다.

허용되는 값: false, true

--subscriptions-limit

전역 매개 변수

--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 product wait

편집

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

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

예제

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

az apim product wait --created --resource-group MyResourceGroup --service-name MyServiceName --product-id MyProductID

필수 매개 변수

--product-id

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

--resource-group -g

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

--service-name -n

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

다음을 통해 공유

az apim product

명령

az apim product create

예제

필수 매개 변수

선택적 매개 변수

az apim product delete

예제

필수 매개 변수

선택적 매개 변수

az apim product list

예제

필수 매개 변수

az apim product show

예제

필수 매개 변수

az apim product update

예제

필수 매개 변수

선택적 매개 변수

az apim product wait

예제

필수 매개 변수

선택적 매개 변수

추가 리소스