Udostępnij za pośrednictwem

az apic api

  • 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 api. Dowiedz się więcej o rozszerzeniach.

Polecenia do zarządzania interfejsami API w Centrum interfejsów API.

Polecenia

Nazwa Opis Typ Stan
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 api create

Zarejestruj nowy interfejs API lub zaktualizuj istniejący interfejs API.

az apic api create --api-id
                   --resource-group
                   --service-name
                   --title
                   --type {graphql, grpc, rest, soap, webhook, websocket}
                   [--contacts]
                   [--custom-properties]
                   [--description]
                   [--external-documentation]
                   [--license]
                   [--summary]

Przykłady

Tworzenie interfejsu API

az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST

Tworzenie interfejsu API z właściwościami niestandardowymi

az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST --custom-properties '{"public-facing":true}'

Tworzenie interfejsu API z właściwościami niestandardowymi przy użyciu pliku json

az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST --custom-properties '@customProperties.json'

Parametry wymagane

--api-id

Identyfikator interfejsu API.

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

--title

Tytuł interfejsu API.

--type

Typ interfejsu API.

Dopuszczalne wartości: graphql, grpc, rest, soap, webhook, websocket

Parametry opcjonalne

--contacts

Informacje kontaktowe dotyczące interfejsu API. Obsługa skróconej składni, pliku json-file i yaml-file. Spróbuj "??", aby pokazać więcej.

--custom-properties

Niestandardowe metadane zdefiniowane dla jednostek wykazu interfejsów API. Obsługa plików json-file i yaml-file.

--description

Opis interfejsu API.

--external-documentation

Dodatkowa zewnętrzna dokumentacja interfejsu API. Obsługa skróconej składni, pliku json-file i yaml-file. Spróbuj "??", aby pokazać więcej.

--license

Informacje o licencji interfejsu API. Obsługa skróconej składni, pliku json-file i yaml-file. Spróbuj "??", aby pokazać więcej.

--summary

Krótki opis interfejsu API.

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

Usuń określony interfejs API.

az apic api delete [--api-id]
                   [--ids]
                   [--resource-group]
                   [--service-name]
                   [--subscription]
                   [--yes]

Przykłady

Usuwanie interfejsu API

az apic api delete -g contoso-resources -n contoso --api-id echo-api

Parametry opcjonalne

--api-id

Identyfikator interfejsu API.

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

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

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

Wyświetlanie listy kolekcji interfejsów API.

az apic api list --resource-group
                 --service-name
                 [--filter]
                 [--max-items]
                 [--next-token]

Przykłady

Wyświetlanie listy interfejsów API

az apic api list -g contoso-resources -n contoso

Wyświetlanie listy interfejsów API z filtrem

az apic api list -g contoso-resources -n contoso --filter "kind eq 'rest'"

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

Parametry opcjonalne

--filter

Parametr filtru OData.

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

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

Wersja zapoznawcza

To polecenie jest w wersji zapoznawczej i jest opracowywane. Poziomy referencyjne i pomocy technicznej: https://aka.ms/CLI_refstatus

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.

az apic api register --api-location
                     --resource-group
                     --service-name
                     [--environment-id]

Przykłady

Zarejestruj interfejs API, podając plik specyfikacji.

az apic api register -g api-center-test -n contosoeuap --api-location "examples/cli-examples/spec-examples/openai.json" --environment-id public
az apic api register -g api-center-test -n contosoeuap --api-location "examples/cli-examples/spec-examples/openai.yml" --environment-id public

Zarejestruj interfejs API, podając adres URL specyfikacji.

az apic api register -g api-center-test -n contosoeuap --api-location "https://petstore.swagger.io/v2/swagger.json" --environment-id public
az apic api register -g api-center-test -n contosoeuap --api-location "https://petstore.swagger.io/v2/swagger.yaml" --environment-id public

Parametry wymagane

--api-location -l

Lokalizacja pliku specyfikacji.

--resource-group -g

Nazwa grupy zasobów.

--service-name -n

Katalog interfejsu APICenter lub nazwa usługi.

Parametry opcjonalne

--environment-id

Identyfikator środowiska utworzonego wcześniej.

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

Uzyskaj szczegółowe informacje o interfejsie API.

az apic api show [--api-id]
                 [--ids]
                 [--resource-group]
                 [--service-name]
                 [--subscription]

Przykłady

Pokaż szczegóły interfejsu API

az apic api show -g contoso-resources -n contoso --api-id echo-api

Parametry opcjonalne

--api-id

Identyfikator interfejsu API.

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

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

Aktualizowanie istniejącego interfejsu API.

az apic api update [--add]
                   [--api-id]
                   [--contacts]
                   [--custom-properties]
                   [--description]
                   [--external-documentation]
                   [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                   [--ids]
                   [--license]
                   [--remove]
                   [--resource-group]
                   [--service-name]
                   [--set]
                   [--subscription]
                   [--summary]
                   [--title]
                   [--type {graphql, grpc, rest, soap, webhook, websocket}]

Przykłady

Aktualizowanie interfejsu API

az apic api update -g contoso-resources -n contoso --api-id echo-api --summary "Basic REST API service"

Aktualizowanie właściwości niestandardowych

az apic api update -g contoso-resources -n contoso --api-id echo-api --custom-properties '{"public-facing":true}'

Aktualizowanie właściwości niestandardowych przy użyciu pliku json

az apic api update -g contoso-resources -n contoso --api-id echo-api --custom-properties '@customProperities.json'

Aktualizowanie pojedynczych metadanych niestandardowych

az apic api update -g contoso-resources -n contoso --api-id echo-api --set customProperties.internal=false

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

--api-id

Identyfikator interfejsu API.

--contacts

Informacje kontaktowe dotyczące interfejsu API. Obsługa skróconej składni, pliku json-file i yaml-file. Spróbuj "??", aby pokazać więcej.

--custom-properties

Niestandardowe metadane zdefiniowane dla jednostek wykazu interfejsów API. Obsługa plików json-file i yaml-file.

--description

Opis interfejsu API.

--external-documentation

Dodatkowa zewnętrzna dokumentacja interfejsu API. Obsługa skróconej składni, pliku json-file i yaml-file. Spróbuj "??", aby pokazać więcej.

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

--license

Informacje o licencji interfejsu API. Obsługa skróconej składni, pliku json-file i yaml-file. Spróbuj "??", aby pokazać więcej.

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

--service-name -n

Nazwa usługi Azure API Center.

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

--summary

Krótki opis interfejsu API.

--title

Tytuł interfejsu API.

--type

Typ interfejsu API.

Dopuszczalne wartości: graphql, grpc, rest, soap, webhook, websocket
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.