az apim

Zarządzanie usługami Azure API Management.

Polecenia

az apim api

Zarządzanie interfejsami API usługi Azure API Management.

az apim api create

Tworzenie interfejsu API API Management.

az apim api delete

Usuń interfejs API API Management.

az apim api import

Zaimportuj interfejs API API Management.

az apim api list

Wyświetl listę API Management interfejsów API.

az apim api operation

Zarządzanie operacjami interfejsu API usługi Azure API Management.

az apim api operation create

Tworzy nową operację w interfejsie API.

az apim api operation delete

Usuwa określoną operację w interfejsie API.

az apim api operation list

Wyświetlanie listy kolekcji operacji dla określonego interfejsu API.

az apim api operation show

Pobiera szczegóły operacji interfejsu API określonej przez jej identyfikator.

az apim api operation update

Aktualizacje szczegóły operacji w interfejsie API określonym przez jego identyfikator.

az apim api release

Zarządzanie wydaniem interfejsu API usługi Azure API Management.

az apim api release create

Tworzy nowe wydanie dla interfejsu API.

az apim api release delete

Usuwa określoną wersję w interfejsie API.

az apim api release list

Wyświetla listę wszystkich wydań interfejsu API.

az apim api release show

Zwraca szczegóły wydania interfejsu API.

az apim api release update

Aktualizacje szczegóły wydania interfejsu API określonego przez jego identyfikator.

az apim api revision

Zarządzanie poprawką interfejsu API usługi Azure API Management.

az apim api revision create

Utwórz poprawkę interfejsu API.

az apim api revision list

Wyświetla listę wszystkich poprawek interfejsu API.

az apim api schema

Zarządzanie schematami interfejsu API usługi Azure API Management.

az apim api schema create

Utwórz schemat interfejsu API API Management.

az apim api schema delete

Usuń schemat interfejsu API API Management.

az apim api schema get-etag

Pobierz element etag schematu interfejsu API API Management.

az apim api schema list

Wyświetl listę schematów interfejsu API API Management.

az apim api schema show

Pokaż szczegóły schematu interfejsu API API Management.

az apim api schema wait

Umieść interfejs wiersza polecenia w stanie oczekiwania do momentu spełnienia warunku schematu interfejsu APIm.

az apim api show

Pokaż szczegóły interfejsu API API Management.

az apim api update

Aktualizowanie interfejsu API API Management.

az apim api versionset

Zarządzanie zestawem wersji interfejsu API usługi Azure API Management.

az apim api versionset create

Tworzy zestaw wersji interfejsu API.

az apim api versionset delete

Usuwa określony zestaw wersji interfejsu API.

az apim api versionset list

Wyświetla listę kolekcji zestawów wersji interfejsu API w określonym wystąpieniu usługi.

az apim api versionset show

Pobiera szczegóły zestawu wersji interfejsu API określonego przez jego identyfikator.

az apim api versionset update

Aktualizacje szczegóły zestawu wersji interfejsu API określonego przez jego identyfikator.

az apim api wait

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

az apim apply-network-updates

Zaktualizuj zasób API Management uruchomiony w sieci wirtualnej, aby wybrać zaktualizowane ustawienia sieciowe.

az apim backup

Tworzy kopię zapasową usługi API Management dla danego konta usługi Azure Storage. Ta operacja trwa długo i może potrwać kilka minut.

az apim check-name

Sprawdza, czy nazwa usługi jest dostępna do użycia.

az apim create

Utwórz wystąpienie usługi API Management.

az apim delete

Usuwa usługę API Management.

az apim deletedservice

Zarządzanie usługami azure API Management usuniętymi nietrwale.

az apim deletedservice list

Wyświetl listę wszystkich nietrwałych wystąpień usług Api Management dostępnych do cofnięcia dla danej subskrypcji.

az apim deletedservice purge

Przeczyść nietrwale usunięte wystąpienie usługi Api Management (usuwa je bez opcji cofania).

az apim deletedservice show

Pobierz nietrwałe wystąpienia usługi Api Management dostępne do cofnięcia według nazwy.

az apim list

Wyświetl listę wystąpień usługi API Management.

az apim nv

Zarządzanie nazwanymi wartościami usługi Azure API Management.

az apim nv create

Utwórz API Management nazwaną wartość.

az apim nv delete

Usuń API Management nazwaną wartość.

az apim nv list

Lista API Management nazwanych wartości.

az apim nv show

Pokaż szczegóły API Management nazwanej wartości.

az apim nv show-secret

Pobiera wpis tajny API Management nazwanej wartości.

az apim nv update

Zaktualizuj API Management nazwaną wartość.

az apim nv wait

Umieść interfejs wiersza polecenia w stanie oczekiwania do momentu spełnienia warunku nazwanej wartości interfejsu APIM.

az apim product

Zarządzanie usługami Azure API Management Product.

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 restore

Przywraca kopię zapasową usługi API Management utworzonej przy użyciu operacji ApiManagementService_Backup w bieżącej usłudze. Jest to długotrwała operacja i może potrwać kilka minut.

az apim show

Pokaż szczegóły wystąpienia usługi API Management.

az apim update

Aktualizowanie wystąpienia usługi API Management.

az apim wait

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

az apim apply-network-updates

Zaktualizuj zasób API Management uruchomiony w sieci wirtualnej, aby wybrać zaktualizowane ustawienia sieciowe.

az apim apply-network-updates --name
                              --resource-group
                              [--location]
                              [--no-wait]

Przykłady

Aktualizowanie ustawień sieci wirtualnej wystąpienia usługi API Management

az apim apply-network-updates --name MyApim -g MyResourceGroup

Parametry wymagane

--name -n

Nazwa wystąpienia 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>.

Parametry opcjonalne

--location -l

Lokalizacja. Wartości z: az account list-locations. Lokalizację domyślną można skonfigurować przy użyciu polecenia az configure --defaults location=<location>.

--no-wait

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

az apim backup

Tworzy kopię zapasową usługi API Management dla danego konta usługi Azure Storage. Ta operacja trwa długo i może potrwać kilka minut.

az apim backup --backup-name
               --container-name
               --name
               --resource-group
               --storage-account-key
               --storage-account-name
               [--no-wait]

Przykłady

Tworzenie kopii zapasowej wystąpienia usługi API Management

az apim backup --name MyApim -g MyResourceGroup --backup-name myBackup              --storage-account-name mystorageaccount --storage-account-container backups              --storage-account-key Ay2ZbdxLnD4OJPT29F6jLPkB6KynOzx85YCObhrw==

Parametry wymagane

--backup-name

Nazwa pliku kopii zapasowej do utworzenia.

--container-name --storage-account-container

Nazwa kontenera konta magazynu używana do umieszczenia kopii zapasowej.

--name -n

Nazwa wystąpienia 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>.

--storage-account-key

Klucz dostępu konta magazynu używany do umieszczania kopii zapasowej.

--storage-account-name

Nazwa konta magazynu używanego do umieszczenia kopii zapasowej.

Parametry opcjonalne

--no-wait

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

az apim check-name

Sprawdza, czy nazwa usługi jest dostępna do użycia.

az apim check-name --name

Parametry wymagane

--name -n

Nazwa wystąpienia usługi API Management.

az apim create

Utwórz wystąpienie usługi API Management.

az apim create --name
               --publisher-email
               --publisher-name
               --resource-group
               [--enable-client-certificate {false, true}]
               [--enable-managed-identity {false, true}]
               [--location]
               [--no-wait]
               [--sku-capacity]
               [--sku-name {Basic, Consumption, Developer, Isolated, Premium, Standard}]
               [--tags]
               [--virtual-network {External, Internal, None}]

Przykłady

Utwórz usługę API Management warstwy dewelopera.

az apim create --name MyApim -g MyResourceGroup -l eastus --publisher-email email@mydomain.com --publisher-name Microsoft

Utwórz usługę API Management warstwy Zużycie.

az apim create --name MyApim -g MyResourceGroup -l eastus --sku-name Consumption --enable-client-certificate \
    --publisher-email email@mydomain.com --publisher-name Microsoft

Parametry wymagane

--name -n

Unikatowa nazwa wystąpienia usługi do utworzenia.

--publisher-email

Adres e-mail do odbierania wszystkich powiadomień systemowych.

--publisher-name

Nazwa organizacji do użycia w portalu dla deweloperów i powiadomienia e-mail.

--resource-group -g

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

Parametry opcjonalne

--enable-client-certificate

Wymusza prezentowanie certyfikatu klienta dla każdego żądania do bramy, a także umożliwia uwierzytelnianie certyfikatu w zasadach w bramie.

akceptowane wartości: false, true
--enable-managed-identity

Utwórz tożsamość zarządzaną dla usługi API Management w celu uzyskania dostępu do innych zasobów platformy Azure.

akceptowane wartości: false, true
--location -l

Lokalizacja. Wartości z: az account list-locations. Lokalizację domyślną można skonfigurować przy użyciu polecenia az configure --defaults location=<location>.

--no-wait

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

--sku-capacity

Liczba wdrożonych jednostek jednostki SKU.

wartość domyślna: 1
--sku-name

Jednostka SKU wystąpienia usługi API Management.

akceptowane wartości: Basic, Consumption, Developer, Isolated, Premium, Standard
wartość domyślna: Developer
--tags

Tagi rozdzielone spacjami: klucz[=wartość] [klucz[=wartość] ...]. Użyj ciągu "", aby wyczyścić istniejące tagi.

--virtual-network -v

Typ sieci wirtualnej.

akceptowane wartości: External, Internal, None
wartość domyślna: None

az apim delete

Usuwa usługę API Management.

az apim delete --name
               --resource-group
               [--no-wait]
               [--yes]

Przykłady

Usuń usługę API Management.

az apim delete -n MyApim -g MyResourceGroup

Parametry wymagane

--name -n

Nazwa wystąpienia 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>.

Parametry opcjonalne

--no-wait

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

--yes -y

Nie monituj o potwierdzenie.

az apim list

Wyświetl listę wystąpień usługi API Management.

az apim list [--resource-group]

Parametry opcjonalne

--resource-group -g

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

az apim restore

Przywraca kopię zapasową usługi API Management utworzonej przy użyciu operacji ApiManagementService_Backup w bieżącej usłudze. Jest to długotrwała operacja i może potrwać kilka minut.

az apim restore --backup-name
                --container-name
                --name
                --resource-group
                --storage-account-key
                --storage-account-name
                [--no-wait]

Przykłady

Przywraca kopię zapasową wystąpienia usługi API Management

az apim restore --name MyApim -g MyResourceGroup --backup-name myBackup              --storage-account-name mystorageaccount --storage-account-container backups              --storage-account-key Ay2ZbdxLnD4OJPT29F6jLPkB6KynOzx85YCObhrw==

Parametry wymagane

--backup-name

Nazwa pliku kopii zapasowej do przywrócenia.

--container-name --storage-account-container

Nazwa kontenera konta magazynu używana do pobierania kopii zapasowej.

--name -n

Nazwa wystąpienia 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>.

--storage-account-key

Klucz dostępu konta magazynu używany do pobierania kopii zapasowej.

--storage-account-name

Nazwa konta magazynu używanego do pobierania kopii zapasowej.

Parametry opcjonalne

--no-wait

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

az apim show

Pokaż szczegóły wystąpienia usługi API Management.

az apim show --name
             --resource-group

Parametry wymagane

--name -n

Nazwa wystąpienia 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>.

az apim update

Aktualizowanie wystąpienia usługi API Management.

az apim update --name
               --resource-group
               [--add]
               [--enable-client-certificate {false, true}]
               [--enable-managed-identity {false, true}]
               [--force-string]
               [--no-wait]
               [--publisher-email]
               [--publisher-name]
               [--remove]
               [--set]
               [--sku-capacity]
               [--sku-name {Basic, Consumption, Developer, Isolated, Premium, Standard}]
               [--tags]
               [--virtual-network {External, Internal, None}]

Parametry wymagane

--name -n

Nazwa wystąpienia 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>.

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 ciąg JSON>.

--enable-client-certificate

Wymusza prezentowanie certyfikatu klienta dla każdego żądania do bramy, a także umożliwia uwierzytelnianie certyfikatu w zasadach w bramie.

akceptowane wartości: false, true
--enable-managed-identity

Utwórz tożsamość zarządzaną dla usługi API Management w celu uzyskania dostępu do innych zasobów platformy Azure.

akceptowane wartości: false, true
--force-string

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

--no-wait

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

--publisher-email

Adres e-mail do odbierania wszystkich powiadomień systemowych.

--publisher-name

Nazwa organizacji do użycia w portalu dla deweloperów i powiadomienia e-mail.

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

--sku-capacity

Liczba wdrożonych jednostek jednostki SKU.

--sku-name

Jednostka SKU wystąpienia usługi API Management.

akceptowane wartości: Basic, Consumption, Developer, Isolated, Premium, Standard
--tags

Tagi rozdzielone spacjami: klucz[=wartość] [klucz[=wartość] ...]. Użyj ciągu "", aby wyczyścić istniejące tagi.

--virtual-network -v

Typ sieci wirtualnej.

akceptowane wartości: External, Internal, None

az apim wait

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

az apim wait --name
             --resource-group
             [--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 wait --created --name MyApim --resource-group MyResourceGroup

Parametry wymagane

--name -n

Nazwa wystąpienia 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>.

Parametry opcjonalne

--created

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

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