az apic

Odwołanie

Nuta

Ta dokumentacja jest częścią rozszerzenia apic-extension rozszerzenia 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.	Rozszerzenie	GA
az apic api create	Zarejestruj nowy interfejs API lub zaktualizuj istniejący interfejs API.	Rozszerzenie	GA
az apic api definition	Polecenia do zarządzania definicjami interfejsu API w Centrum interfejsu API.	Rozszerzenie	GA
az apic api definition create	Utwórz nową definicję interfejsu API lub zaktualizuj istniejącą definicję interfejsu API.	Rozszerzenie	GA
az apic api definition delete	Usuń określoną definicję interfejsu API.	Rozszerzenie	GA
az apic api definition export-specification	Eksportuje specyfikację interfejsu API.	Rozszerzenie	GA
az apic api definition import-specification	Importuje specyfikację interfejsu API.	Rozszerzenie	GA
az apic api definition list	Wyświetlanie listy kolekcji definicji interfejsu API.	Rozszerzenie	GA
az apic api definition show	Uzyskaj szczegółowe informacje o definicji interfejsu API.	Rozszerzenie	GA
az apic api definition update	Zaktualizuj istniejącą definicję interfejsu API.	Rozszerzenie	GA
az apic api delete	Usuń określony interfejs API.	Rozszerzenie	GA
az apic api deployment	Polecenia do zarządzania wdrożeniami interfejsu API w Centrum interfejsu API.	Rozszerzenie	GA
az apic api deployment create	Utwórz nowe wdrożenie interfejsu API lub zaktualizuj istniejące wdrożenie interfejsu API.	Rozszerzenie	GA
az apic api deployment delete	Usuwanie wdrożenia interfejsu API.	Rozszerzenie	GA
az apic api deployment list	Wyświetlanie listy kolekcji wdrożeń interfejsu API.	Rozszerzenie	GA
az apic api deployment show	Uzyskaj szczegółowe informacje o wdrożeniu interfejsu API.	Rozszerzenie	GA
az apic api deployment update	Aktualizowanie istniejącego wdrożenia interfejsu API.	Rozszerzenie	GA
az apic api list	Wyświetlanie listy kolekcji interfejsów API.	Rozszerzenie	GA
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.	Rozszerzenie	Prapremiera
az apic api show	Uzyskaj szczegółowe informacje o interfejsie API.	Rozszerzenie	GA
az apic api update	Aktualizowanie istniejącego interfejsu API.	Rozszerzenie	GA
az apic api version	Polecenia do zarządzania wersjami interfejsu API w Centrum interfejsu API.	Rozszerzenie	GA
az apic api version create	Utwórz nową wersję interfejsu API lub zaktualizuj istniejącą wersję interfejsu API.	Rozszerzenie	GA
az apic api version delete	Usuń określoną wersję interfejsu API.	Rozszerzenie	GA
az apic api version list	Wyświetlanie listy kolekcji wersji interfejsu API.	Rozszerzenie	GA
az apic api version show	Uzyskaj szczegółowe informacje o wersji interfejsu API.	Rozszerzenie	GA
az apic api version update	Zaktualizuj istniejącą wersję interfejsu API.	Rozszerzenie	GA
az apic create	Tworzy wystąpienie lub aktualizuje istniejące wystąpienie usługi Azure API Center.	Rozszerzenie	GA
az apic delete	Usuwa wystąpienie usługi Azure API Center.	Rozszerzenie	GA
az apic environment	Polecenia do zarządzania środowiskami w Centrum interfejsów API.	Rozszerzenie	GA
az apic environment create	Utwórz nowe środowisko lub zaktualizuj istniejące środowisko.	Rozszerzenie	GA
az apic environment delete	Usuń środowisko.	Rozszerzenie	GA
az apic environment list	Wyświetlanie listy kolekcji środowisk.	Rozszerzenie	GA
az apic environment show	Uzyskaj szczegółowe informacje o środowisku.	Rozszerzenie	GA
az apic environment update	Aktualizowanie istniejącego środowiska.	Rozszerzenie	GA
az apic import	Zarządzanie usługami Centrum interfejsów API platformy Azure.	Rozszerzenie	GA
az apic import-from-apim	Importuje interfejsy API z wystąpienia usługi Azure API Management.	Rozszerzenie	GA
az apic import aws	Zaimportuj źródło interfejsu API usługi Amazon API Gateway.	Rozszerzenie	Prapremiera
az apic integration	Zarządza integracją w Centrum interfejsów API platformy Azure.	Rozszerzenie	Prapremiera
az apic integration create	Zarządzanie usługami Centrum interfejsów API platformy Azure.	Rozszerzenie	Prapremiera
az apic integration create apim	Dodaj usługę Azure APIM jako źródło interfejsu API.	Rozszerzenie	Prapremiera
az apic integration create aws	Dodaj usługę Amazon API Gateway jako źródło interfejsu API.	Rozszerzenie	Prapremiera
az apic integration delete	Usuń określone źródło interfejsu API.	Rozszerzenie	Prapremiera
az apic integration list	Wyświetlanie listy kolekcji źródeł interfejsu API.	Rozszerzenie	Prapremiera
az apic integration show	Uzyskaj szczegółowe informacje o źródle interfejsu API.	Rozszerzenie	Prapremiera
az apic list	Wyświetla listę usług Azure API Center w ramach subskrypcji platformy Azure.	Rozszerzenie	GA
az apic metadata	Polecenia do zarządzania schematami metadanych w Centrum interfejsu API.	Rozszerzenie	GA
az apic metadata create	Utwórz nowy schemat metadanych lub zaktualizuj istniejący schemat metadanych.	Rozszerzenie	GA
az apic metadata delete	Usuń określony schemat metadanych.	Rozszerzenie	GA
az apic metadata export	Eksportuje schemat metadanych.	Rozszerzenie	GA
az apic metadata list	Wyświetlanie listy kolekcji schematów metadanych.	Rozszerzenie	GA
az apic metadata show	Uzyskaj szczegółowe informacje o schemacie metadanych.	Rozszerzenie	GA
az apic metadata update	Zaktualizuj istniejący schemat metadanych.	Rozszerzenie	GA
az apic show	Pokaż szczegóły wystąpienia usługi Azure API Center.	Rozszerzenie	GA
az apic update	Aktualizowanie wystąpienia usługi Azure API Center.	Rozszerzenie	GA

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

--name -n

Nazwa usługi API Center.

--resource-group -g

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

Parametry opcjonalne

--identity

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.

--location -l

Lokalizacja geograficzna, w której znajduje się zasób, gdy nie zostanie określony, zostanie użyta lokalizacja grupy zasobów.

--tags

Tagi zasobów. Obsługa skróconej składni, pliku json-file i yaml-file. Spróbuj "??", aby pokazać więcej.

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.

Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc

Domyślna wartość: json

--query

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

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

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

--ids

Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być pełny identyfikator zasobu zawierający wszystkie informacje o argumentach "Identyfikator zasobu". Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".

--name -n

Nazwa usługi API Center.

--resource-group -g

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

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--yes -y

Nie monituj o potwierdzenie.

Domyślna 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.

Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc

Domyślna wartość: json

--query

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

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

az apic import-from-apim

Importuje interfejsy API z wystąpienia usługi Azure API Management.

az apic import-from-apim --apim-apis
                         --apim-name
                         [--apim-resource-group]
                         [--apim-subscription]
                         [--ids]
                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                         [--resource-group]
                         [--service-name]
                         [--subscription]

Przykłady

Importowanie wszystkich interfejsów API z usługi APIM w tej samej grupie zasobów

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-name contoso-apim --apim-apis *

Importowanie wybranych interfejsów API z usługi APIM w tej samej grupie zasobów

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-name contoso-apim --apim-apis [echo,foo]

Importowanie wszystkich interfejsów API z usługi APIM w innej subskrypcji i grupie zasobów

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-subscription 00000000-0000-0000-0000-000000000000 --apim-resource-group apim-rg --apim-name contoso-apim --apim-apis *

Parametry wymagane

--apim-apis

Interfejsy API do zaimportowania. Obsługa skróconej składni, pliku json-file i yaml-file. Spróbuj "??", aby pokazać więcej.

--apim-name

Nazwa źródłowego wystąpienia usługi APIM.

Parametry opcjonalne

--apim-resource-group

Grupa zasobów źródłowego wystąpienia usługi APIM.

--apim-subscription

Identyfikator subskrypcji źródłowego wystąpienia usługi APIM.

--ids

--no-wait

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

Dopuszczalne wartości: 0, 1, f, false, n, no, t, true, y, yes

--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 usługi Azure API Center.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

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.

Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc

Domyślna wartość: json

--query

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

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

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

--max-items

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

--next-token

Token do określenia, gdzie rozpocząć stronicowanie. Jest to wartość tokenu z wcześniej obciętej odpowiedzi.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu 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.

Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc

Domyślna wartość: json

--query

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

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

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

--ids

--name -n

Nazwa usługi API Center.

--resource-group -g

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

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

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.

Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc

Domyślna wartość: json

--query

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

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

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

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

--force-string

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

Dopuszczalne wartości: 0, 1, f, false, n, no, t, true, y, yes

--identity

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.

--ids

--name -n

Nazwa usługi API Center.

--remove

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

--resource-group -g

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

--set

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

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--tags

Tagi zasobów. Obsługa skróconej składni, pliku json-file i yaml-file. Spróbuj "??", aby pokazać więcej.

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.

Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc

Domyślna wartość: json

--query

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

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

Udostępnij za pośrednictwem

az apic

Polecenia

az apic create

Przykłady

Parametry wymagane

Parametry opcjonalne

az apic delete

Przykłady

Parametry opcjonalne

az apic import-from-apim

Przykłady

Parametry wymagane

Parametry opcjonalne

az apic list

Przykłady

Parametry opcjonalne

az apic show

Przykłady

Parametry opcjonalne

az apic update

Przykłady

Parametry opcjonalne

Dodatkowe zasoby