Udostępnij za pośrednictwem

az apim

  • Odwołanie

Zarządzanie usługami Azure API Management.

Polecenia

Nazwa Opis Typ Stan
az apim api

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

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

Tworzenie interfejsu API usługi API Management.

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

Usuwanie interfejsu API usługi API Management.

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

Eksportowanie interfejsu API usługi API Management.

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

Importowanie interfejsu API usługi API Management.

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

Wyświetlanie listy interfejsów API usługi API Management.

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

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

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

Tworzy nową operację w interfejsie API.

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

Usuwa określoną operację w interfejsie API.

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

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

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

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

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

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

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

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

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

Tworzy nową wersję dla interfejsu API.

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

Usuwa określoną wersję w interfejsie API.

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

Wyświetla listę wszystkich wydań interfejsu API.

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

Zwraca szczegóły wydania interfejsu API.

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

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

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

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

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

Utwórz poprawkę interfejsu API.

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

Wyświetla listę wszystkich poprawek interfejsu API.

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

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

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

Tworzenie schematu interfejsu API usługi API Management.

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

Usuwanie schematu interfejsu API usługi API Management.

 Podstawowe funkcje Ogólna dostępność
az apim api schema get-etag

Pobierz element etag schematu interfejsu API usługi API Management.

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

Wyświetlanie listy schematów interfejsu API usługi API Management.

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

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

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

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

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

Pokaż szczegóły interfejsu API usługi API Management.

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

Aktualizowanie interfejsu API usługi API Management.

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

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

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

Tworzy zestaw wersji interfejsu API.

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

Usuwa określony zestaw wersji interfejsu API.

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

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

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

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

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

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

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

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

 Podstawowe funkcje Ogólna dostępność
az apim apply-network-updates

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

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

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

 Podstawowe funkcje Ogólna dostępność
az apim check-name

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

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

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

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

Usuwa usługę API Management.

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

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

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

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

 Podstawowe funkcje Ogólna dostępność
az apim deletedservice purge

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

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

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

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

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

 Podstawowe funkcje Ogólna dostępność
az apim graphql resolver

Zarządzanie narzędziami rozpoznawania interfejsu API GraphQL usługi Azure API Management.

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

Utwórz nowy program rozpoznawania nazw w interfejsie API GraphQL lub zaktualizuj istniejący.

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

Usuń określony program rozpoznawania w interfejsie API GraphQL.

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

Wyświetl listę kolekcji funkcji rozpoznawania dla określonego interfejsu API graphQL.

 Podstawowe funkcje Ogólna dostępność
az apim graphql resolver policy

Zarządzanie zasadami rozpoznawania nazw interfejsu API GraphQL usługi Azure API Management.

 Podstawowe funkcje Ogólna dostępność
az apim graphql resolver policy create

Utwórz lub zaktualizuj konfigurację zasad dla poziomu rozpoznawania interfejsu API GraphQL.

 Podstawowe funkcje Ogólna dostępność
az apim graphql resolver policy delete

Usuń konfigurację zasad w narzędziu GraphQL Api Resolver.

 Podstawowe funkcje Ogólna dostępność
az apim graphql resolver policy list

Pobierz listę konfiguracji zasad na poziomie programu GraphQL API Resolver.

 Podstawowe funkcje Ogólna dostępność
az apim graphql resolver policy show

Pobierz konfigurację zasad na poziomie narzędzia rozpoznawania interfejsu API GraphQL.

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

Uzyskaj szczegółowe informacje o narzędziu GraphQL API Resolver określonym przez jego identyfikator.

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

Wyświetlanie listy wystąpień usługi API Management.

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

Zarządzanie nazwami wartości usługi Azure API Management.

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

Utwórz wartość nazwaną usługi API Management.

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

Usuń nazwaną wartość usługi API Management.

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

Wyświetlanie listy wartości nazwanych usługi API Management.

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

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

 Podstawowe funkcje Ogólna dostępność
az apim nv show-secret

Pobiera wpis tajny nazwanej wartości usługi API Management.

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

Zaktualizuj wartość nazwaną usługi API Management.

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

Umieść interfejs wiersza polecenia w stanie oczekiwania do momentu spełnienia warunku nazwy apim o nazwie value.

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

Zarządzanie produktami usługi Azure API Management.

 Podstawowe funkcje Ogólna dostępność
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 restore

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

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

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

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

Aktualizowanie wystąpienia usługi API Management.

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

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

 Podstawowe funkcje Ogólna dostępność

az apim apply-network-updates

Edytuj

Zaktualizuj zasób usługi 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.

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 backup

Edytuj

Tworzy kopię zapasową usługi API Management dla danego konta usługi Azure Storage. Ta długotrwała operacja 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 umieszczania 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żywanego do umieszczania kopii zapasowej.

--storage-account-name

Nazwa konta magazynu używanego do umieszczania kopii zapasowej.

Parametry opcjonalne

--no-wait

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

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 check-name

Edytuj

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.

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 create

Edytuj

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

az apim create --name
               --publisher-email
               --publisher-name
               --resource-group
               [--disable-gateway {false, true}]
               [--enable-client-certificate {false, true}]
               [--enable-managed-identity {false, true}]
               [--location]
               [--no-wait]
               [--public-network-access {false, true}]
               [--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 w warstwie 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.

Nazwa musi być globalnie unikatowa, ponieważ zostanie dołączona jako nazwa hosta bramy, na przykład " https://my-api-servicename.azure-api.net. Zobacz przykłady.

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

--disable-gateway

Wyłącz bramę w regionie głównym. Prawidłowe tylko dla usługi Api Management wdrożonej w wielu lokalizacjach.

akceptowane wartości: false, true
--enable-client-certificate

Wymusza prezentowanie certyfikatu klienta na każdym żądaniu 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, aby uzyskać dostęp do innych zasobów platformy Azure. Przeznaczone tylko do użycia w przypadku usługi sku zużycie.

akceptowane wartości: false, true
wartość domyślna: False
--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.

wartość domyślna: False
--public-network-access

Określa, czy dostęp do publicznego punktu końcowego jest dozwolony dla tej usługi API Management. Jeśli ustawiono wartość true, prywatne punkty końcowe są wyłączną metodą dostępu.

akceptowane wartości: false, true
--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ść] [key[=value] ...]. 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
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 delete

Edytuj

Usuwa usługę API Management.

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

Przykłady

Usuwanie usługi 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.

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 list

Edytuj

Wyświetlanie listy 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>.

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 restore

Edytuj

Przywraca kopię zapasową usługi API Management utworzoną 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żywanego 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.

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 show

Edytuj

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

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 update

Edytuj

Aktualizowanie wystąpienia usługi API Management.

az apim update --name
               --resource-group
               [--add]
               [--disable-gateway {false, true}]
               [--enable-client-certificate {false, true}]
               [--enable-managed-identity {false, true}]
               [--force-string]
               [--no-wait]
               [--public-network-access {false, true}]
               [--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 or JSON string>.

wartość domyślna: []
--disable-gateway

Wyłącz bramę w regionie głównym. Prawidłowe tylko dla usługi Api Management wdrożonej w wielu lokalizacjach.

akceptowane wartości: false, true
--enable-client-certificate

Wymusza prezentowanie certyfikatu klienta na każdym żądaniu 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, aby uzyskać dostęp do innych zasobów platformy Azure. Przeznaczone tylko do użycia w przypadku usługi sku zużycie.

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.

wartość domyślna: False
--no-wait

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

wartość domyślna: False
--public-network-access

Określa, czy dostęp do publicznego punktu końcowego jest dozwolony dla tej usługi API Management. Jeśli ustawiono wartość true, prywatne punkty końcowe są wyłączną metodą dostępu.

akceptowane wartości: false, true
--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 <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: []
--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ść] [key[=value] ...]. Użyj ciągu "", aby wyczyścić istniejące tagi.

--virtual-network -v

Typ sieci wirtualnej.

akceptowane wartości: External, Internal, None
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 wait

Edytuj

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