az apim product

  • Odwołanie

Zarządzanie produktami usługi Azure API Management.

Polecenia

Nazwa Opis Typ Stan
az apim product api

Zarządzanie interfejsami API produktu Azure API Management.

 Podstawowe funkcje Ogólna dostępność
az apim product api add

Dodaj interfejs API do określonego produktu.

 Podstawowe funkcje Ogólna dostępność
az apim product api check

Sprawdza, czy jednostka interfejsu API określona przez identyfikator jest skojarzona z jednostką Product.

 Podstawowe funkcje Ogólna dostępność
az apim product api delete

Usuwa określony interfejs API z określonego produktu.

 Podstawowe funkcje Ogólna dostępność
az apim product api list

Wyświetla kolekcję interfejsów API skojarzonych z produktem.

 Podstawowe funkcje Ogólna dostępność
az apim product create

Tworzy produkt.

 Podstawowe funkcje Ogólna dostępność
az apim product delete

Usuń produkt.

 Podstawowe funkcje Ogólna dostępność
az apim product list

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

 Podstawowe funkcje Ogólna dostępność
az apim product show

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

 Podstawowe funkcje Ogólna dostępność
az apim product update

Zaktualizuj istniejące szczegóły produktu.

 Podstawowe funkcje Ogólna dostępność
az apim product wait

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

 Podstawowe funkcje Ogólna dostępność

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

Czy wymagane jest 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ł korzystać z dowolnego interfejsu 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ą przedstawiani i zobowiązani do zaakceptowania tych warunków przed ukończeniem procesu subskrypcji.

--no-wait

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

wartość domyślna: False
--product-id

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

--state

Czy produkt jest publikowany, czy nie. Opublikowane produkty są wykrywalne przez użytkowników portalu deweloperów. Niepublikowane produkty są widoczne tylko dla administratorów. Domyślny stan produktu nie jestPublished. Możliwe wartości to: "notPublished", "published".

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 pomiń, aby zezwolić na nieograniczoną liczbę subskrypcji użytkowników. 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.

akceptowane wartości: json, jsonc, none, table, tsv, yaml, yamlc
wartość domyślna: json
--query

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

--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 --debuguj, 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

Element ETag jednostki.

--no-wait

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

wartość domyślna: False
--yes -y

Nie monituj o potwierdzenie.

wartość domyślna: 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.

akceptowane wartości: json, jsonc, none, table, tsv, yaml, yamlc
wartość domyślna: json
--query

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

--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 --debuguj, 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.

akceptowane wartości: json, jsonc, none, table, tsv, yaml, yamlc
wartość domyślna: json
--query

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

--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 --debuguj, 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.

akceptowane wartości: json, jsonc, none, table, tsv, yaml, yamlc
wartość domyślna: json
--query

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

--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 --debuguj, 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 or JSON string>.

wartość domyślna: []
--approval-required

Czy wymagane jest 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ł korzystać z dowolnego interfejsu 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.

--force-string

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

wartość domyślna: False
--if-match

Element ETag jednostki.

--legal-terms

Warunki użytkowania produktu. Deweloperzy próbujący zasubskrybować produkt będą przedstawiani i zobowiązani do zaakceptowania tych warunków przed ukończeniem procesu subskrypcji.

--no-wait

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

wartość domyślna: False
--product-name

Nazwa produktu.

--remove

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

wartość domyślna: []
--set

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

wartość domyślna: []
--state

Czy produkt jest publikowany, czy nie. Opublikowane produkty są wykrywalne przez użytkowników portalu deweloperów. Niepublikowane produkty są widoczne tylko dla administratorów. Domyślny stan produktu nie jestPublished. Możliwe wartości to: "notPublished", "published".

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 pomiń, aby zezwolić na nieograniczoną liczbę subskrypcji użytkowników. 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.

akceptowane wartości: json, jsonc, none, table, tsv, yaml, yamlc
wartość domyślna: json
--query

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

--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 --debuguj, 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. (automatycznie wygenerowane)

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" o godzinie "Succeeded".

wartość domyślna: False
--custom

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

--deleted

Poczekaj na usunięcie.

wartość domyślna: False
--exists

Zaczekaj, aż zasób istnieje.

wartość domyślna: False
--interval

Interwał sondowania w sekundach.

wartość domyślna: 30
--timeout

Maksymalny czas oczekiwania w sekundach.

wartość domyślna: 3600
--updated

Zaczekaj na zaktualizowanie stanu provisioningState o 'Powodzenie'.

wartość domyślna: 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.

akceptowane wartości: json, jsonc, none, table, tsv, yaml, yamlc
wartość domyślna: json
--query

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

--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 --debuguj, aby uzyskać pełne dzienniki debugowania.