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 product create
제품을 만듭니다.
az apim product create --product-name
--resource-group
--service-name
[--approval-required]
[--description]
[--legal-terms]
[--no-wait]
[--product-id]
[--state {notPublished, published}]
[--subscription]
[--subscription-required]
[--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"
필수 매개 변수
제품 이름입니다.
리소스 그룹의 이름입니다. az configure --defaults group=<name>을 사용하여 기본 그룹을 구성할 수 있습니다.
API Management 서비스 인스턴스의 이름입니다.
선택적 매개 변수
구독 승인이 필요한지 여부입니다. false이면 새 구독이 자동으로 승인되어 개발자가 구독 후 즉시 제품의 API를 호출할 수 있습니다. true이면 개발자가 제품의 API를 사용하려면 먼저 관리자가 구독을 수동으로 승인해야 합니다. subscriptionRequired 속성이 있고 값이 false인 경우에만 존재할 수 있습니다.
제품 설명입니다. HTML 서식 지정 태그를 포함할 수 있습니다.
제품 사용 약관입니다. 제품을 구독하려는 개발자에게 표시되며 구독 프로세스를 완료하기 전에 이러한 약관에 동의해야 합니다.
장기 실행 작업이 완료될 때까지 기다리지 마세요.
제품 ID입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
제품이 게시되었는지 여부입니다. 게시된 제품은 개발자 포털 사용자가 검색할 수 있습니다. 게시되지 않은 제품은 관리자에게만 표시됩니다. Product의 기본 상태는 게시되지 않습니다.
구독의 이름 또는 ID입니다. 를 사용하여 기본 구독을 구성할 수 az account set -s NAME_OR_ID 있습니다.
이 제품에 포함된 API에 액세스하기 위해 제품 구독이 필요한지 여부입니다.
사용자가 이 제품에 동시에 사용할 수 있는 구독 수입니다. 사용자별 구독을 무제한으로 허용하려면 null 또는 생략으로 설정합니다. subscriptionRequired 속성이 있고 값이 false인 경우에만 존재할 수 있습니다.
로깅의 자세한 정도를 늘려 모든 디버그 로그를 표시합니다.
이 도움말 메시지를 표시하고 종료합니다.
오류만 표시하고, 경고를 표시하지 않습니다.
출력 형식입니다.
JMESPath 쿼리 문자열입니다. 자세한 내용 및 예제는 http://jmespath.org/를 참조하세요.
로깅의 자세한 정도를 늘립니다. 전체 디버그 로그를 표시하려면 --debug를 사용합니다.
az apim product delete
제품을 삭제합니다.
az apim product delete --product-id
--resource-group
--service-name
[--delete-subscriptions]
[--if-match]
[--no-wait]
[--subscription]
[--yes]
예제
이 제품에 대한 모든 구독이 있는 제품을 삭제합니다.
az apim product delete --resource-group MyResourceGroup --service-name MyServiceName --product-id MyProductID --delete-subscriptions true
필수 매개 변수
제품 ID입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
리소스 그룹의 이름입니다. az configure --defaults group=<name>을 사용하여 기본 그룹을 구성할 수 있습니다.
API Management 서비스 인스턴스의 이름입니다.
선택적 매개 변수
제품과 연결된 기존 구독을 삭제합니다.
엔터티의 ETag입니다.
장기 실행 작업이 완료될 때까지 기다리지 마세요.
구독의 이름 또는 ID입니다. 를 사용하여 기본 구독을 구성할 수 az account set -s NAME_OR_ID 있습니다.
확인을 묻는 메시지를 표시하지 마세요.
로깅의 자세한 정도를 늘려 모든 디버그 로그를 표시합니다.
이 도움말 메시지를 표시하고 종료합니다.
오류만 표시하고, 경고를 표시하지 않습니다.
출력 형식입니다.
JMESPath 쿼리 문자열입니다. 자세한 내용 및 예제는 http://jmespath.org/를 참조하세요.
로깅의 자세한 정도를 늘립니다. 전체 디버그 로그를 표시하려면 --debug를 사용합니다.
az apim product list
지정된 서비스 인스턴스의 제품 컬렉션을 나열합니다.
az apim product list --resource-group
--service-name
[--query-examples]
[--subscription]
예제
이 APIM 인스턴스에 대한 모든 제품을 나열합니다.
az apim product list --resource-group MyResourceGroup --service-name MyServiceName
필수 매개 변수
리소스 그룹의 이름입니다. az configure --defaults group=<name>을 사용하여 기본 그룹을 구성할 수 있습니다.
API Management 서비스 인스턴스의 이름입니다.
선택적 매개 변수
JMESPath 문자열을 권장합니다. 쿼리 중 하나를 복사하여 큰따옴표 안에 --query 매개 변수를 붙여넣어 결과를 확인할 수 있습니다. 이러한 키워드를 기반으로 제안을 제공할 수 있도록 하나 이상의 위치 키워드를 추가할 수 있습니다.
구독의 이름 또는 ID입니다. 를 사용하여 기본 구독을 구성할 수 az account set -s NAME_OR_ID 있습니다.
로깅의 자세한 정도를 늘려 모든 디버그 로그를 표시합니다.
이 도움말 메시지를 표시하고 종료합니다.
오류만 표시하고, 경고를 표시하지 않습니다.
출력 형식입니다.
JMESPath 쿼리 문자열입니다. 자세한 내용 및 예제는 http://jmespath.org/를 참조하세요.
로깅의 자세한 정도를 늘립니다. 전체 디버그 로그를 표시하려면 --debug를 사용합니다.
az apim product show
식별자가 지정한 제품의 세부 정보를 가져옵니다.
az apim product show --product-id
--resource-group
--service-name
[--query-examples]
[--subscription]
예제
식별자가 지정한 제품의 세부 정보를 가져옵니다.
az apim product show --resource-group MyResourceGroup --service-name MyServiceName --product-id MyProductID
필수 매개 변수
제품 ID입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
리소스 그룹의 이름입니다. az configure --defaults group=<name>을 사용하여 기본 그룹을 구성할 수 있습니다.
API Management 서비스 인스턴스의 이름입니다.
선택적 매개 변수
JMESPath 문자열을 권장합니다. 쿼리 중 하나를 복사하여 큰따옴표 안에 --query 매개 변수를 붙여넣어 결과를 확인할 수 있습니다. 이러한 키워드를 기반으로 제안을 제공할 수 있도록 하나 이상의 위치 키워드를 추가할 수 있습니다.
구독의 이름 또는 ID입니다. 를 사용하여 기본 구독을 구성할 수 az account set -s NAME_OR_ID 있습니다.
로깅의 자세한 정도를 늘려 모든 디버그 로그를 표시합니다.
이 도움말 메시지를 표시하고 종료합니다.
오류만 표시하고, 경고를 표시하지 않습니다.
출력 형식입니다.
JMESPath 쿼리 문자열입니다. 자세한 내용 및 예제는 http://jmespath.org/를 참조하세요.
로깅의 자세한 정도를 늘립니다. 전체 디버그 로그를 표시하려면 --debug를 사용합니다.
az apim product update
기존 제품 세부 정보를 업데이트합니다.
az apim product update --product-id
--resource-group
--service-name
[--add]
[--approval-required]
[--description]
[--force-string]
[--if-match]
[--legal-terms]
[--no-wait]
[--product-name]
[--remove]
[--set]
[--state {notPublished, published}]
[--subscription]
[--subscription-required]
[--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"
필수 매개 변수
제품 ID입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
리소스 그룹의 이름입니다. az configure --defaults group=<name>을 사용하여 기본 그룹을 구성할 수 있습니다.
API Management 서비스 인스턴스의 이름입니다.
선택적 매개 변수
경로 및 키 값 쌍을 지정하여 개체를 개체 목록에 추가합니다. 예: --add property.listProperty <key=value, string 또는 JSON string>.
구독 승인이 필요한지 여부입니다. false이면 새 구독이 자동으로 승인되어 개발자가 구독 후 즉시 제품의 API를 호출할 수 있습니다. true이면 개발자가 제품의 API를 사용하려면 먼저 관리자가 구독을 수동으로 승인해야 합니다. subscriptionRequired 속성이 있고 값이 false인 경우에만 존재할 수 있습니다.
제품 설명입니다. HTML 서식 지정 태그를 포함할 수 있습니다.
'set' 또는 'add'를 사용하는 경우 JSON으로 변환하는 대신 문자열 리터럴을 유지합니다.
엔터티의 ETag입니다.
제품 사용 약관입니다. 제품을 구독하려는 개발자에게 표시되며 구독 프로세스를 완료하기 전에 이러한 약관에 동의해야 합니다.
장기 실행 작업이 완료될 때까지 기다리지 마세요.
제품 이름입니다.
목록에서 속성 또는 요소를 제거합니다. 예: --remove property.list OR --remove propertyToRemove.
설정할 속성 경로와 값을 지정하여 개체를 업데이트합니다. 예: --set property1.property2=.
제품이 게시되었는지 여부입니다. 게시된 제품은 개발자 포털 사용자가 검색할 수 있습니다. 게시되지 않은 제품은 관리자에게만 표시됩니다. Product의 기본 상태는 게시되지 않습니다.
구독의 이름 또는 ID입니다. 를 사용하여 기본 구독을 구성할 수 az account set -s NAME_OR_ID 있습니다.
이 제품에 포함된 API에 액세스하기 위해 제품 구독이 필요한지 여부입니다.
사용자가 이 제품에 동시에 사용할 수 있는 구독 수입니다. 사용자별 구독을 무제한으로 허용하려면 null 또는 생략으로 설정합니다. subscriptionRequired 속성이 있고 값이 false인 경우에만 존재할 수 있습니다.
로깅의 자세한 정도를 늘려 모든 디버그 로그를 표시합니다.
이 도움말 메시지를 표시하고 종료합니다.
오류만 표시하고, 경고를 표시하지 않습니다.
출력 형식입니다.
JMESPath 쿼리 문자열입니다. 자세한 내용 및 예제는 http://jmespath.org/를 참조하세요.
로깅의 자세한 정도를 늘립니다. 전체 디버그 로그를 표시하려면 --debug를 사용합니다.
az apim product wait
apim 제품의 조건이 충족될 때까지 CLI를 대기 상태로 하십시오.
az apim product wait --product-id
--resource-group
--service-name
[--created]
[--custom]
[--deleted]
[--exists]
[--interval]
[--subscription]
[--timeout]
[--updated]
예제
apim 조건이 충족될 때까지 CLI를 대기 상태로 하십시오. 자동 생성
az apim product wait --created --resource-group MyResourceGroup --service-name MyServiceName --product-id MyProductID
필수 매개 변수
제품 ID입니다. 현재 API Management 서비스 인스턴스에서 고유 해야 합니다.
리소스 그룹의 이름입니다. az configure --defaults group=<name>을 사용하여 기본 그룹을 구성할 수 있습니다.
Api management 서비스 인스턴스의 이름입니다.
선택적 매개 변수
' 성공 '에서 ' provisioningState '를 사용 하 여 만들 때까지 기다립니다.
조건이 사용자 지정 JMESPath 쿼리를 충족할 때까지 기다립니다. 예를 들어 provisioningState! = ' InProgress ', instanceView. 상태 [? code = = ' PowerState/running '].
삭제 될 때까지 기다립니다.
리소스가 있을 때까지 기다립니다.
폴링 간격 (초)입니다.
구독의 이름 또는 ID입니다. 을 사용 하 여 기본 구독을 구성할 수 있습니다 az account set -s NAME_OR_ID .
최대 대기 시간 (초)입니다.
' 성공 '으로 provisioningState으로 업데이트할 때까지 기다립니다.
로깅의 자세한 정도를 늘려 모든 디버그 로그를 표시합니다.
이 도움말 메시지를 표시하고 종료합니다.
오류만 표시하고, 경고를 표시하지 않습니다.
출력 형식입니다.
JMESPath 쿼리 문자열입니다. 자세한 내용 및 예제는 http://jmespath.org/를 참조하세요.
로깅의 자세한 정도를 늘립니다. 전체 디버그 로그를 표시하려면 --debug를 사용합니다.