az apim product

Odwołanie

Zarządzanie usługami Azure API Management Product.

Polecenia

az apim product api	Zarządzanie interfejsami API usługi Azure API Management Product.
az apim product api add	Dodaj interfejs API do określonego produktu.
az apim product api check	Sprawdza, czy jednostka interfejsu API określona przez identyfikator jest skojarzona z jednostką Product.
az apim product api delete	Usuwa określony interfejs API z określonego produktu.
az apim product api list	Wyświetla listę kolekcji interfejsów API skojarzonych z produktem.
az apim product create	Tworzy produkt.
az apim product delete	Usuń produkt.
az apim product list	Wyświetla listę kolekcji produktów w określonym wystąpieniu usługi.
az apim product show	Pobiera szczegóły produktu określonego przez jego identyfikator.
az apim product update	Zaktualizuj istniejące szczegóły produktu.
az apim product wait	Umieść interfejs wiersza polecenia w stanie oczekiwania do momentu spełnienia warunku produktu apim.

az apim product create

Edytuj

Tworzy produkt.

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]

Przykłady

Tworzy produkt.

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"

Parametry wymagane

--product-name

Nazwa produktu.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

--service-name -n

Nazwa wystąpienia usługi API Management.

Parametry opcjonalne

--approval-required

Niezależnie od tego, czy jest wymagane zatwierdzenie subskrypcji. Jeśli wartość false, nowe subskrypcje zostaną zatwierdzone automatycznie, umożliwiając deweloperom wywoływanie interfejsów API produktu natychmiast po zasubskrybowaniu. Jeśli to prawda, administratorzy muszą ręcznie zatwierdzić subskrypcję, zanim deweloper będzie mógł dowolnego z interfejsów API produktu. Może być obecny tylko wtedy, gdy właściwość subscriptionRequired jest obecna i ma wartość false.

akceptowane wartości: false, true

--description

Opis produktu. Może zawierać tagi formatowania HTML.

--legal-terms

Warunki użytkowania produktu. Deweloperzy próbujący zasubskrybować produkt będą prezentowani i zobowiązani do zaakceptowania tych warunków, zanim będą mogli ukończyć proces subskrypcji.

--no-wait

Nie czekaj na zakończenie długotrwałej operacji.

--product-id

Identyfikator produktu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

--state

Niezależnie od tego, czy produkt jest publikowany, czy nie. Opublikowane produkty są wykrywalne przez użytkowników portalu deweloperów. Nieopublikowane produkty są widoczne tylko dla administratorów. Domyślny stan produktu nie jestPublished.

akceptowane wartości: notPublished, published

--subscription-required -s

Czy subskrypcja produktu jest wymagana do uzyskiwania dostępu do interfejsów API uwzględnionych w tym produkcie.

akceptowane wartości: false, true

--subscriptions-limit

Określa, czy liczba subskrypcji, które użytkownik może mieć w tym samym czasie. Ustaw wartość null lub pominięto, aby zezwolić na nieograniczoną liczbę subskrypcji użytkownika. Może być obecny tylko wtedy, gdy właściwość subscriptionRequired jest obecna i ma wartość false.

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykłady.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debug, aby uzyskać pełne dzienniki debugowania.

az apim product delete

Edytuj

Usuń produkt.

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

Przykłady

Usuń produkt ze wszystkimi subskrypcjami tego produktu.

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

Parametry wymagane

--product-id

Identyfikator produktu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

--service-name -n

Nazwa wystąpienia usługi API Management.

Parametry opcjonalne

--delete-subscriptions

Usuń istniejące subskrypcje skojarzone z produktem lub nie.

--if-match

ETag jednostki.

--no-wait

Nie czekaj na zakończenie długotrwałej operacji.

--yes -y

Nie monituj o potwierdzenie.

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykłady.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debug, aby uzyskać pełne dzienniki debugowania.

az apim product list

Edytuj

Wyświetla listę kolekcji produktów w określonym wystąpieniu usługi.

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

Przykłady

Wyświetl listę wszystkich produktów dla tego wystąpienia usługi APIM.

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

Parametry wymagane

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

--service-name -n

Nazwa wystąpienia usługi API Management.

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykłady.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debug, aby uzyskać pełne dzienniki debugowania.

az apim product show

Edytuj

Pobiera szczegóły produktu określonego przez jego identyfikator.

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

Przykłady

Pobiera szczegóły produktu określonego przez jego identyfikator.

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

Parametry wymagane

--product-id

Identyfikator produktu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

--service-name -n

Nazwa wystąpienia usługi API Management.

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykłady.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debug, aby uzyskać pełne dzienniki debugowania.

az apim product update

Edytuj

Zaktualizuj istniejące szczegóły produktu.

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]

Przykłady

Zaktualizuj istniejące szczegóły produktu.

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"

Parametry wymagane

--product-id

Identyfikator produktu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

--service-name -n

Nazwa wystąpienia usługi API Management.

Parametry opcjonalne

--add

Dodaj obiekt do listy obiektów, określając pary ścieżki i wartości klucza. Przykład: --add property.listProperty <key=value, string lub JSON string>.

--approval-required

akceptowane wartości: false, true

--description

Opis produktu. Może zawierać tagi formatowania HTML.

--force-string

W przypadku używania polecenia "set" lub "add" zachowaj literały ciągu zamiast próbować przekonwertować na kod JSON.

--if-match

ETag jednostki.

--legal-terms

Warunki użytkowania produktu. Deweloperzy próbujący zasubskrybować produkt będą prezentowani i zobowiązani do zaakceptowania tych warunków, zanim będą mogli ukończyć proces subskrypcji.

--no-wait

Nie czekaj na zakończenie długotrwałej operacji.

--product-name

Nazwa produktu.

--remove

Usuń właściwość lub element z listy. Przykład: --remove property.list OR --remove propertyToRemove.

--set

Zaktualizuj obiekt, określając ścieżkę właściwości i wartość do ustawienia. Przykład: --set property1.property2=.

--state

akceptowane wartości: notPublished, published

--subscription-required -s

Czy subskrypcja produktu jest wymagana do uzyskiwania dostępu do interfejsów API uwzględnionych w tym produkcie.

akceptowane wartości: false, true

--subscriptions-limit

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykłady.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debug, aby uzyskać pełne dzienniki debugowania.

az apim product wait

Edytuj

Umieść interfejs wiersza polecenia w stanie oczekiwania do momentu spełnienia warunku produktu apim.

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

Przykłady

Umieść interfejs wiersza polecenia w stanie oczekiwania do momentu spełnienia warunku interfejsu APIm. (generowane automatycznie)

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

Parametry wymagane

--product-id

Identyfikator produktu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

--service-name -n

Nazwa wystąpienia usługi API Management.

Parametry opcjonalne

--created

Zaczekaj na utworzenie polecenia "provisioningState" w lokalizacji "Powodzenie".

--custom

Zaczekaj, aż warunek spełnia niestandardowe zapytanie JMESPath. Na przykład provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Zaczekaj na usunięcie.

--exists

Zaczekaj, aż zasób istnieje.

--interval

Interwał sondowania w sekundach.

wartość domyślna: 30

--timeout

Maksymalny czas oczekiwania w sekundach.

wartość domyślna: 3600

--updated

Zaczekaj na aktualizację za pomocą parametru provisioningState w lokalizacji "Powodzenie".

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykłady.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debug, aby uzyskać pełne dzienniki debugowania.