az apic
Note
Ta dokumentacja jest częścią rozszerzenia apic-extension dla interfejsu wiersza polecenia platformy Azure (wersja 2.57.0 lub nowsza). Rozszerzenie zostanie automatycznie zainstalowane przy pierwszym uruchomieniu polecenia az apic . Dowiedz się więcej o rozszerzeniach.
Zarządzanie usługami Centrum interfejsów API platformy Azure.
Polecenia
| Nazwa | Opis | Typ | Stan |
|---|---|---|---|
| az apic api |
Polecenia do zarządzania interfejsami API w Centrum interfejsów API. |
Extension | ogólna dostępność |
| az apic api-analysis |
Zarządzanie funkcjami analizy interfejsu API usługi Azure API Center. |
Extension | Preview |
| az apic api-analysis create |
Utwórz nową lub zaktualizuj istniejącą konfigurację analizatora interfejsu API. |
Extension | Preview |
| az apic api-analysis delete |
Usuwanie usuwa konfigurację analizatora interfejsu API. |
Extension | Preview |
| az apic api-analysis export-ruleset |
Eksportuje zestaw reguł analizatora interfejsu API. |
Extension | Preview |
| az apic api-analysis import-ruleset |
Importuje zestaw reguł analizatora interfejsu API. |
Extension | Preview |
| az apic api-analysis list |
Wyświetlanie listy konfiguracji analizatora interfejsu API. |
Extension | Preview |
| az apic api-analysis show |
Uzyskaj szczegółowe informacje o konfiguracji analizatora interfejsu API. |
Extension | Preview |
| az apic api-analysis update |
Zaktualizuj nową lub zaktualizuj istniejącą konfigurację analizatora interfejsu API. |
Extension | Preview |
| az apic api create |
Zarejestruj nowy interfejs API lub zaktualizuj istniejący interfejs API. |
Extension | ogólna dostępność |
| az apic api definition |
Polecenia do zarządzania definicjami interfejsu API w Centrum interfejsu API. |
Extension | ogólna dostępność |
| az apic api definition create |
Utwórz nową definicję interfejsu API lub zaktualizuj istniejącą definicję interfejsu API. |
Extension | ogólna dostępność |
| az apic api definition delete |
Usuń określoną definicję interfejsu API. |
Extension | ogólna dostępność |
| az apic api definition export-specification |
Eksportuje specyfikację interfejsu API. |
Extension | ogólna dostępność |
| az apic api definition import-specification |
Importuje specyfikację interfejsu API. |
Extension | ogólna dostępność |
| az apic api definition list |
Wyświetlanie listy kolekcji definicji interfejsu API. |
Extension | ogólna dostępność |
| az apic api definition show |
Uzyskaj szczegółowe informacje o definicji interfejsu API. |
Extension | ogólna dostępność |
| az apic api definition update |
Zaktualizuj istniejącą definicję interfejsu API. |
Extension | ogólna dostępność |
| az apic api delete |
Usuń określony interfejs API. |
Extension | ogólna dostępność |
| az apic api deployment |
Polecenia do zarządzania wdrożeniami interfejsu API w Centrum interfejsu API. |
Extension | ogólna dostępność |
| az apic api deployment create |
Utwórz nowe wdrożenie interfejsu API lub zaktualizuj istniejące wdrożenie interfejsu API. |
Extension | ogólna dostępność |
| az apic api deployment delete |
Usuwanie wdrożenia interfejsu API. |
Extension | ogólna dostępność |
| az apic api deployment list |
Wyświetlanie listy kolekcji wdrożeń interfejsu API. |
Extension | ogólna dostępność |
| az apic api deployment show |
Uzyskaj szczegółowe informacje o wdrożeniu interfejsu API. |
Extension | ogólna dostępność |
| az apic api deployment update |
Aktualizowanie istniejącego wdrożenia interfejsu API. |
Extension | ogólna dostępność |
| az apic api list |
Wyświetlanie listy kolekcji interfejsów API. |
Extension | ogólna dostępność |
| az apic api register |
Rejestruje nowy interfejs API z wersją, definicją i skojarzonymi wdrożeniami przy użyciu pliku specyfikacji jako źródła prawdy. Na razie obsługujemy tylko format JSON/YAML interfejsu OpenAPI. |
Extension | Preview |
| az apic api show |
Uzyskaj szczegółowe informacje o interfejsie API. |
Extension | ogólna dostępność |
| az apic api update |
Aktualizowanie istniejącego interfejsu API. |
Extension | ogólna dostępność |
| az apic api version |
Polecenia do zarządzania wersjami interfejsu API w Centrum interfejsu API. |
Extension | ogólna dostępność |
| az apic api version create |
Utwórz nową wersję interfejsu API lub zaktualizuj istniejącą wersję interfejsu API. |
Extension | ogólna dostępność |
| az apic api version delete |
Usuń określoną wersję interfejsu API. |
Extension | ogólna dostępność |
| az apic api version list |
Wyświetlanie listy kolekcji wersji interfejsu API. |
Extension | ogólna dostępność |
| az apic api version show |
Uzyskaj szczegółowe informacje o wersji interfejsu API. |
Extension | ogólna dostępność |
| az apic api version update |
Zaktualizuj istniejącą wersję interfejsu API. |
Extension | ogólna dostępność |
| az apic create |
Tworzy wystąpienie lub aktualizuje istniejące wystąpienie usługi Azure API Center. |
Extension | ogólna dostępność |
| az apic delete |
Usuwa wystąpienie usługi Azure API Center. |
Extension | ogólna dostępność |
| az apic environment |
Polecenia do zarządzania środowiskami w Centrum interfejsów API. |
Extension | ogólna dostępność |
| az apic environment create |
Utwórz nowe środowisko lub zaktualizuj istniejące środowisko. |
Extension | ogólna dostępność |
| az apic environment delete |
Usuwanie środowiska. |
Extension | ogólna dostępność |
| az apic environment list |
Wyświetlanie listy kolekcji środowisk. |
Extension | ogólna dostępność |
| az apic environment show |
Uzyskaj szczegółowe informacje o środowisku. |
Extension | ogólna dostępność |
| az apic environment update |
Aktualizowanie istniejącego środowiska. |
Extension | ogólna dostępność |
| az apic integration |
Zarządza integracją w Centrum interfejsów API platformy Azure. |
Extension | ogólna dostępność |
| az apic integration create |
Zarządzanie usługami Centrum interfejsów API platformy Azure. |
Extension | ogólna dostępność |
| az apic integration create apim |
Dodaj usługę Azure APIM jako źródło interfejsu API. |
Extension | ogólna dostępność |
| az apic integration create aws |
Dodaj usługę Amazon API Gateway jako źródło interfejsu API. |
Extension | ogólna dostępność |
| az apic integration delete |
Usuń określone źródło interfejsu API. |
Extension | ogólna dostępność |
| az apic integration list |
Wyświetlanie listy kolekcji źródeł interfejsu API. |
Extension | ogólna dostępność |
| az apic integration show |
Uzyskaj szczegółowe informacje o źródle interfejsu API. |
Extension | ogólna dostępność |
| az apic list |
Wyświetla listę usług Azure API Center w ramach subskrypcji platformy Azure. |
Extension | ogólna dostępność |
| az apic metadata |
Polecenia do zarządzania schematami metadanych w Centrum interfejsu API. |
Extension | ogólna dostępność |
| az apic metadata create |
Utwórz nowy schemat metadanych lub zaktualizuj istniejący schemat metadanych. |
Extension | ogólna dostępność |
| az apic metadata delete |
Usuń określony schemat metadanych. |
Extension | ogólna dostępność |
| az apic metadata export |
Eksportuje schemat metadanych. |
Extension | ogólna dostępność |
| az apic metadata list |
Wyświetlanie listy kolekcji schematów metadanych. |
Extension | ogólna dostępność |
| az apic metadata show |
Uzyskaj szczegółowe informacje o schemacie metadanych. |
Extension | ogólna dostępność |
| az apic metadata update |
Zaktualizuj istniejący schemat metadanych. |
Extension | ogólna dostępność |
| az apic show |
Pokaż szczegóły wystąpienia usługi Azure API Center. |
Extension | ogólna dostępność |
| az apic update |
Aktualizowanie wystąpienia usługi Azure API Center. |
Extension | ogólna dostępność |
az apic create
Tworzy wystąpienie lub aktualizuje istniejące wystąpienie usługi Azure API Center.
az apic create --name
--resource-group
[--identity]
[--location]
[--tags]
Przykłady
Przykład tworzenia usługi
az apic create -g contoso-resources -n contoso -l eastus
Przykład tworzenia usługi z tożsamością przypisaną przez system
az apic create -g contoso-resources -n contoso -l eastus --identity '{type:systemassigned}'
Parametry wymagane
Nazwa usługi API Center.
Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu az configure --defaults group=<name>.
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.
Tożsamości usługi zarządzanej przypisane do tego zasobu. Obsługa skróconej składni, pliku json-file i yaml-file. Spróbuj "??", aby pokazać więcej.
Lokalizacja geograficzna, w której znajduje się zasób, gdy nie zostanie określony, zostanie użyta lokalizacja grupy zasobów.
Tagi zasobów. Obsługa skróconej składni, pliku json-file i yaml-file. Spróbuj "??", aby pokazać więcej.
Parametry globalne
Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.
| Właściwość | Wartość |
|---|---|
| Domyślna wartość: | False |
Pokaż ten komunikat pomocy i zakończ pracę.
Pokaż tylko błędy, pomijając ostrzeżenia.
| Właściwość | Wartość |
|---|---|
| Domyślna wartość: | False |
Format danych wyjściowych.
| Właściwość | Wartość |
|---|---|
| Domyślna wartość: | json |
| Dopuszczalne wartości: | json, jsonc, none, table, tsv, yaml, yamlc |
Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.
Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.
Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.
| Właściwość | Wartość |
|---|---|
| Domyślna wartość: | False |
az apic delete
Usuwa wystąpienie usługi Azure API Center.
az apic delete [--ids]
[--name]
[--resource-group]
[--subscription]
[--yes]
Przykłady
Usuwanie usługi
az apic delete -n contoso -g contoso-resources
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.
Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być kompletny identyfikator zasobu, zawierający wszystkie informacje dotyczące argumentów „Identyfikator zasobu”. Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".
| Właściwość | Wartość |
|---|---|
| Grupa parametrów: | Resource Id Arguments |
Nazwa usługi API Center.
| Właściwość | Wartość |
|---|---|
| Grupa parametrów: | Resource Id Arguments |
Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu az configure --defaults group=<name>.
| Właściwość | Wartość |
|---|---|
| Grupa parametrów: | Resource Id Arguments |
Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.
| Właściwość | Wartość |
|---|---|
| Grupa parametrów: | Resource Id Arguments |
Nie monituj o potwierdzenie.
| Właściwość | Wartość |
|---|---|
| Domyślna wartość: | False |
Parametry globalne
Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.
| Właściwość | Wartość |
|---|---|
| Domyślna wartość: | False |
Pokaż ten komunikat pomocy i zakończ pracę.
Pokaż tylko błędy, pomijając ostrzeżenia.
| Właściwość | Wartość |
|---|---|
| Domyślna wartość: | False |
Format danych wyjściowych.
| Właściwość | Wartość |
|---|---|
| Domyślna wartość: | json |
| Dopuszczalne wartości: | json, jsonc, none, table, tsv, yaml, yamlc |
Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.
Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.
| Właściwość | Wartość |
|---|---|
| Domyślna wartość: | False |
az apic list
Wyświetla listę usług Azure API Center w ramach subskrypcji platformy Azure.
Istnieje znany problem polegający na tym, że wyświetlanie listy wszystkich zasobów w ramach subskrypcji nie działa. Wyświetl listę zasobów według grupy zasobów.
az apic list [--max-items]
[--next-token]
[--resource-group]
Przykłady
Wyświetlanie listy usług w grupie zasobów
az apic list -g contoso-resources
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.
Łączna liczba elementów do zwrócenia w danych wyjściowych polecenia. Jeśli łączna liczba dostępnych elementów jest większa niż określona wartość, token jest udostępniany w danych wyjściowych polecenia. Aby wznowić stronicowanie, podaj wartość tokenu w --next-token argumentu kolejnego polecenia.
| Właściwość | Wartość |
|---|---|
| Grupa parametrów: | Pagination Arguments |
Token do określenia, gdzie rozpocząć stronicowanie. Jest to wartość tokenu z wcześniej obciętej odpowiedzi.
| Właściwość | Wartość |
|---|---|
| Grupa parametrów: | Pagination Arguments |
Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu az configure --defaults group=<name>.
Parametry globalne
Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.
| Właściwość | Wartość |
|---|---|
| Domyślna wartość: | False |
Pokaż ten komunikat pomocy i zakończ pracę.
Pokaż tylko błędy, pomijając ostrzeżenia.
| Właściwość | Wartość |
|---|---|
| Domyślna wartość: | False |
Format danych wyjściowych.
| Właściwość | Wartość |
|---|---|
| Domyślna wartość: | json |
| Dopuszczalne wartości: | json, jsonc, none, table, tsv, yaml, yamlc |
Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.
Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.
Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.
| Właściwość | Wartość |
|---|---|
| Domyślna wartość: | False |
az apic show
Pokaż szczegóły wystąpienia usługi Azure API Center.
az apic show [--ids]
[--name]
[--resource-group]
[--subscription]
Przykłady
Pokaż szczegóły usługi
az apic show -g contoso-resources -n contoso
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.
Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być kompletny identyfikator zasobu, zawierający wszystkie informacje dotyczące argumentów „Identyfikator zasobu”. Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".
| Właściwość | Wartość |
|---|---|
| Grupa parametrów: | Resource Id Arguments |
Nazwa usługi API Center.
| Właściwość | Wartość |
|---|---|
| Grupa parametrów: | Resource Id Arguments |
Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu az configure --defaults group=<name>.
| Właściwość | Wartość |
|---|---|
| Grupa parametrów: | Resource Id Arguments |
Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.
| Właściwość | Wartość |
|---|---|
| Grupa parametrów: | Resource Id Arguments |
Parametry globalne
Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.
| Właściwość | Wartość |
|---|---|
| Domyślna wartość: | False |
Pokaż ten komunikat pomocy i zakończ pracę.
Pokaż tylko błędy, pomijając ostrzeżenia.
| Właściwość | Wartość |
|---|---|
| Domyślna wartość: | False |
Format danych wyjściowych.
| Właściwość | Wartość |
|---|---|
| Domyślna wartość: | json |
| Dopuszczalne wartości: | json, jsonc, none, table, tsv, yaml, yamlc |
Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.
Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.
| Właściwość | Wartość |
|---|---|
| Domyślna wartość: | False |
az apic update
Aktualizowanie wystąpienia usługi Azure API Center.
az apic update [--add]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--identity]
[--ids]
[--name]
[--remove]
[--resource-group]
[--set]
[--subscription]
[--tags]
Przykłady
Aktualizowanie szczegółów usługi
az apic update -g contoso-resources -n contoso
Przykład aktualizacji usługi z tożsamością przypisaną przez system
az apic update -g contoso-resources -n contoso --identity '{type:systemassigned}'
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.
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 |
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 |
| Dopuszczalne wartości: | 0, 1, f, false, n, no, t, true, y, yes |
Tożsamości usługi zarządzanej przypisane do tego zasobu. Obsługa skróconej składni, pliku json-file i yaml-file. Spróbuj "??", aby pokazać więcej.
Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być kompletny identyfikator zasobu, zawierający wszystkie informacje dotyczące argumentów „Identyfikator zasobu”. Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".
| Właściwość | Wartość |
|---|---|
| Grupa parametrów: | Resource Id Arguments |
Nazwa usługi API Center.
| Właściwość | Wartość |
|---|---|
| Grupa parametrów: | Resource Id Arguments |
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 |
Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu az configure --defaults group=<name>.
| Właściwość | Wartość |
|---|---|
| Grupa parametrów: | Resource Id Arguments |
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 |
Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.
| Właściwość | Wartość |
|---|---|
| Grupa parametrów: | Resource Id Arguments |
Tagi zasobów. Obsługa skróconej składni, pliku json-file i yaml-file. Spróbuj "??", aby pokazać więcej.
Parametry globalne
Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.
| Właściwość | Wartość |
|---|---|
| Domyślna wartość: | False |
Pokaż ten komunikat pomocy i zakończ pracę.
Pokaż tylko błędy, pomijając ostrzeżenia.
| Właściwość | Wartość |
|---|---|
| Domyślna wartość: | False |
Format danych wyjściowych.
| Właściwość | Wartość |
|---|---|
| Domyślna wartość: | json |
| Dopuszczalne wartości: | json, jsonc, none, table, tsv, yaml, yamlc |
Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.
Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.
| Właściwość | Wartość |
|---|---|
| Domyślna wartość: | False |