az apim product

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.	Core	ogólna dostępność
az apim product api add	Dodaj interfejs API do określonego produktu.	Core	ogólna dostępność
az apim product api check	Sprawdza, czy jednostka interfejsu API określona przez identyfikator jest skojarzona z jednostką Product.	Core	ogólna dostępność
az apim product api delete	Usuwa określony interfejs API z określonego produktu.	Core	ogólna dostępność
az apim product api list	Wyświetla kolekcję interfejsów API skojarzonych z produktem.	Core	ogólna dostępność
az apim product create	Tworzy produkt.	Core	ogólna dostępność
az apim product delete	Usuń produkt.	Core	ogólna dostępność
az apim product list	Wyświetla listę kolekcji produktów w określonym wystąpieniu usługi.	Core	ogólna dostępność
az apim product show	Pobiera szczegóły produktu określonego przez jego identyfikator.	Core	ogólna dostępność
az apim product update	Zaktualizuj istniejące szczegóły produktu.	Core	ogólna dostępność
az apim product wait	Umieść interfejs wiersza polecenia w stanie oczekiwania do momentu spełnienia warunku produktu apim.	Core	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 az configure --defaults group=<name>.

--service-name -n

Nazwa wystąpienia usługi API Management.

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

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

Właściwość	Wartość
Dopuszczalne 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.

Właściwość	Wartość
Domyślna wartość:	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".

Właściwość	Wartość
Dopuszczalne 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.

Właściwość	Wartość
Dopuszczalne 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.

Właściwość	Wartość
Domyślna wartość:	False

--help -h

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

--only-show-errors

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

Właściwość	Wartość
Domyślna wartość:	False

--output -o

Format danych wyjściowych.

Właściwość	Wartość
Domyślna wartość:	json
Dopuszczalne wartości:	json, jsonc, none, table, tsv, yaml, yamlc

--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 az account set -s NAME_OR_ID.

--verbose

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

Właściwość	Wartość
Domyślna wartość:	False

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 az configure --defaults group=<name>.

--service-name -n

Nazwa wystąpienia usługi API Management.

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

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

Właściwość	Wartość
Domyślna wartość:	False

--yes -y

Nie monituj o potwierdzenie.

Właściwość	Wartość
Domyślna wartość:	False

Parametry globalne

--debug

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

Właściwość	Wartość
Domyślna wartość:	False

--help -h

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

--only-show-errors

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

Właściwość	Wartość
Domyślna wartość:	False

--output -o

Format danych wyjściowych.

Właściwość	Wartość
Domyślna wartość:	json
Dopuszczalne wartości:	json, jsonc, none, table, tsv, yaml, yamlc

--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 az account set -s NAME_OR_ID.

--verbose

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

Właściwość	Wartość
Domyślna wartość:	False

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

Właściwość	Wartość
Domyślna wartość:	False

--help -h

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

--only-show-errors

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

Właściwość	Wartość
Domyślna wartość:	False

--output -o

Format danych wyjściowych.

Właściwość	Wartość
Domyślna wartość:	json
Dopuszczalne wartości:	json, jsonc, none, table, tsv, yaml, yamlc

--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 az account set -s NAME_OR_ID.

--verbose

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

Właściwość	Wartość
Domyślna wartość:	False

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

Właściwość	Wartość
Domyślna wartość:	False

--help -h

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

--only-show-errors

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

Właściwość	Wartość
Domyślna wartość:	False

--output -o

Format danych wyjściowych.

Właściwość	Wartość
Domyślna wartość:	json
Dopuszczalne wartości:	json, jsonc, none, table, tsv, yaml, yamlc

--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 az account set -s NAME_OR_ID.

--verbose

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

Właściwość	Wartość
Domyślna wartość:	False

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 az configure --defaults group=<name>.

--service-name -n

Nazwa wystąpienia usługi API Management.

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

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

Właściwość	Wartość
Grupa parametrów:	Generic Update Arguments
Domyślna wartość:	[]

--approval-required

Właściwość	Wartość
Dopuszczalne 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.

Właściwość	Wartość
Grupa parametrów:	Generic Update Arguments
Domyślna wartość:	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.

Właściwość	Wartość
Domyślna wartość:	False

--product-name

Nazwa produktu.

--remove

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

Właściwość	Wartość
Grupa parametrów:	Generic Update Arguments
Domyślna wartość:	[]

--set

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

Właściwość	Wartość
Grupa parametrów:	Generic Update Arguments
Domyślna wartość:	[]

--state

Właściwość	Wartość
Dopuszczalne 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.

Właściwość	Wartość
Dopuszczalne wartości:	false, true

--subscriptions-limit

Parametry globalne

--debug

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

Właściwość	Wartość
Domyślna wartość:	False

--help -h

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

--only-show-errors

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

Właściwość	Wartość
Domyślna wartość:	False

--output -o

Format danych wyjściowych.

Właściwość	Wartość
Domyślna wartość:	json
Dopuszczalne wartości:	json, jsonc, none, table, tsv, yaml, yamlc

--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 az account set -s NAME_OR_ID.

--verbose

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

Właściwość	Wartość
Domyślna wartość:	False

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. (autogenerated)

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 az configure --defaults group=<name>.

--service-name -n

Nazwa wystąpienia usługi API Management.

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--created

Zaczekaj na utworzenie polecenia "provisioningState" o godzinie "Succeeded".

Właściwość	Wartość
Grupa parametrów:	Wait Condition Arguments
Domyślna wartość:	False

--custom

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

Właściwość	Wartość
Grupa parametrów:	Wait Condition Arguments

--deleted

Poczekaj na usunięcie.

Właściwość	Wartość
Grupa parametrów:	Wait Condition Arguments
Domyślna wartość:	False

--exists

Zaczekaj, aż zasób istnieje.

Właściwość	Wartość
Grupa parametrów:	Wait Condition Arguments
Domyślna wartość:	False

--interval

Interwał sondowania w sekundach.

Właściwość	Wartość
Grupa parametrów:	Wait Condition Arguments
Domyślna wartość:	30

--timeout

Maksymalny czas oczekiwania w sekundach.

Właściwość	Wartość
Grupa parametrów:	Wait Condition Arguments
Domyślna wartość:	3600

--updated

Zaczekaj na zaktualizowanie stanu provisioningState o 'Powodzenie'.

Właściwość	Wartość
Grupa parametrów:	Wait Condition Arguments
Domyślna wartość:	False

Parametry globalne

--debug

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

Właściwość	Wartość
Domyślna wartość:	False

--help -h

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

--only-show-errors

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

Właściwość	Wartość
Domyślna wartość:	False

--output -o

Format danych wyjściowych.

Właściwość	Wartość
Domyślna wartość:	json
Dopuszczalne wartości:	json, jsonc, none, table, tsv, yaml, yamlc

--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 az account set -s NAME_OR_ID.

--verbose

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

Właściwość	Wartość
Domyślna wartość:	False

Sprzężenie zwrotne

Czy ta strona była pomocna?

Udostępnij przez

az apim product

Polecenia

az apim product create

Przykłady

Parametry wymagane

Parametry opcjonalne

az apim product delete

Przykłady

Parametry wymagane

Parametry opcjonalne

az apim product list

Przykłady

Parametry wymagane

az apim product show

Przykłady

Parametry wymagane

az apim product update

Przykłady

Parametry wymagane

Parametry opcjonalne

az apim product wait

Przykłady

Parametry wymagane

Parametry opcjonalne

Sprzężenie zwrotne