az apic api definition

  • Odwołanie

Uwaga

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

Polecenia do zarządzania definicjami interfejsu API w Centrum interfejsu API.

Polecenia

Nazwa Opis Typ Stan
az apic api definition create

Utwórz nową definicję interfejsu API lub zaktualizuj istniejącą definicję interfejsu API.

 Numer wewnętrzny Ogólna dostępność
az apic api definition delete

Usuń określoną definicję interfejsu API.

 Numer wewnętrzny Ogólna dostępność
az apic api definition export-specification

Eksportuje specyfikację interfejsu API.

 Numer wewnętrzny Ogólna dostępność
az apic api definition import-specification

Importuje specyfikację interfejsu API.

 Numer wewnętrzny Ogólna dostępność
az apic api definition list

Wyświetlanie listy kolekcji definicji interfejsu API.

 Numer wewnętrzny Ogólna dostępność
az apic api definition show

Uzyskaj szczegółowe informacje o definicji interfejsu API.

 Numer wewnętrzny Ogólna dostępność
az apic api definition update

Zaktualizuj istniejącą definicję interfejsu API.

 Numer wewnętrzny Ogólna dostępność

az apic api definition create

Utwórz nową definicję interfejsu API lub zaktualizuj istniejącą definicję interfejsu API.

az apic api definition create --api-id
                              --definition-id
                              --resource-group
                              --service
                              --title
                              --version-id
                              [--description]

Przykłady

Tworzenie definicji interfejsu API

az apic api definition create -g api-center-test -s contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi" --title "OpenAPI"

Parametry wymagane

--api-id

Identyfikator interfejsu API.

--definition-id

Identyfikator definicji interfejsu API.

--resource-group -g

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

--service --service-name -s

Nazwa usługi API Center.

--title

Wersja interfejsu API.

--version-id

Identyfikator wersji interfejsu API.

Parametry opcjonalne

--description

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

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

Usuń określoną definicję interfejsu API.

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

Przykłady

Usuwanie definicji interfejsu API

az apic api definition delete -g api-center-test -s contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi"

Parametry opcjonalne

--api-id

Identyfikator interfejsu API.

--definition-id

Identyfikator definicji 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 polecenia az configure --defaults group=<name>.

--service --service-name -s

Nazwa usługi API Center.

--subscription

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

--version-id

Identyfikator wersji interfejsu API.

--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 apic api definition export-specification

Eksportuje specyfikację interfejsu API.

az apic api definition export-specification --file-name
                                            [--api-id]
                                            [--definition-id]
                                            [--ids]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--resource-group]
                                            [--service]
                                            [--subscription]
                                            [--version-id]

Przykłady

Specyfikacja eksportu

az apic api version definition export-specification -g api-center-test -s contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id default

Parametry wymagane

--file-name

Nazwa pliku, do którego ma być eksportowana specyfikacja.

Parametry opcjonalne

--api-id

Identyfikator interfejsu API.

--definition-id

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

--no-wait

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

akceptowane 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 polecenia az configure --defaults group=<name>.

--service --service-name -s

Nazwa usługi API Center.

--subscription

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

--version-id

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

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 apic api definition import-specification

Importuje specyfikację interfejsu API.

az apic api definition import-specification [--api-id]
                                            [--definition-id]
                                            [--file-name]
                                            [--format {inline, link}]
                                            [--ids]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--resource-group]
                                            [--service]
                                            [--specification]
                                            [--subscription]
                                            [--value]
                                            [--version-id]

Przykłady

Przykład specyfikacji importu 1

az apic api definition import-specification -g api-center-test -s contosoeuap --api-id echo-api-2 --version-id 2023-08-01 --definition-id openapi3 --format "inline" --value '{"openapi":"3.0.1","info":{"title":"httpbin.org","description":"API Management facade for a very handy and free online HTTP tool.","version":"1.0"}}' --specification '{"name":"openapi","version":"3.0.0"}'

Przykład specyfikacji importu 2

az apic api definition import-specification -g api-center-test -s contoso --api-id echo-api --version-id 2023-11-01 --definition-id openapi --format "link" --value 'https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json' --specification '{"name":"openapi","version":"3.0.0"}'

Parametry opcjonalne

--api-id

Identyfikator interfejsu API.

--definition-id

Identyfikator definicji interfejsu API.

--file-name

Nazwa pliku, z którego ma być importowane specyfikacje.

--format

Format źródła specyfikacji interfejsu API.

akceptowane wartości: inline, link
--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".

--no-wait

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

akceptowane 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 polecenia az configure --defaults group=<name>.

--service --service-name -s

Nazwa usługi API Center.

--specification

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

--subscription

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

--value

Wartość źródła specyfikacji interfejsu API.

--version-id

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

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

Wyświetlanie listy kolekcji definicji interfejsu API.

az apic api definition list --api-id
                            --resource-group
                            --service
                            --version-id
                            [--filter]
                            [--max-items]
                            [--next-token]

Przykłady

Wyświetlanie listy definicji interfejsu API

az apic api definition list -g api-center-test -s contosoeuap --api-id echo-api --version-id 2023-01-01

Parametry wymagane

--api-id

Identyfikator interfejsu API.

--resource-group -g

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

--service --service-name -s

Nazwa usługi API Center.

--version-id

Identyfikator wersji interfejsu API.

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

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

Uzyskaj szczegółowe informacje o definicji interfejsu API.

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

Przykłady

Pokaż szczegóły definicji interfejsu API

az apic api definition show -g api-center-test -s contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi"

Parametry opcjonalne

--api-id

Identyfikator interfejsu API.

--definition-id

Identyfikator definicji 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 polecenia az configure --defaults group=<name>.

--service --service-name -s

Nazwa usługi API Center.

--subscription

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

--version-id

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

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

Zaktualizuj istniejącą definicję interfejsu API.

az apic api definition update [--add]
                              [--api-id]
                              [--definition-id]
                              [--description]
                              [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                              [--ids]
                              [--remove]
                              [--resource-group]
                              [--service]
                              [--set]
                              [--subscription]
                              [--title]
                              [--version-id]

Przykłady

Aktualizowanie definicji interfejsu API

az apic api definition update -g api-center-test -s contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi" --title "OpenAPI"

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.

--api-id

Identyfikator interfejsu API.

--definition-id

Identyfikator definicji interfejsu API.

--description

Opis definicji interfejsu API.

--force-string

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

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

--remove

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

--resource-group -g

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

--service --service-name -s

Nazwa usługi API Center.

--set

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

--subscription

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

--title

Tytuł wersji interfejsu API.

--version-id

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

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.