az apic api deployment

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

Polecenia do zarządzania wdrożeniami interfejsu API w Centrum interfejsu API.

Polecenia

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

Utwórz nowe wdrożenie interfejsu API lub zaktualizuj istniejące wdrożenie interfejsu API.

az apic api deployment create --api-id
                              --definition-id
                              --deployment-id
                              --environment-id
                              --resource-group
                              --server
                              --service-name
                              --title
                              [--custom-properties]
                              [--description]

Przykłady

Utwórz wdrożenie

az apic api deployment create -g api-center-test -n contoso --deployment-id production --title "Production deployment" --description "Public cloud production deployment." --api-id echo-api --environment-id "/workspaces/default/environments/production" --definition-id "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi" --server '{"runtimeUri":["https://example.com"]}'

Tworzenie wdrożenia przy użyciu pliku json serwera

az apic api deployment create -g api-center-test -n contoso --deployment-id production --title "Production deployment" --description "Public cloud production deployment." --api-id echo-api --environment-id "/workspaces/default/environments/production" --definition-id "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi" --server '@server.json'

Parametry wymagane

--api-id

Identyfikator interfejsu API.

--definition-id

Identyfikator zasobu definicji w zakresie centrum interfejsu API.

Właściwość	Wartość
Grupa parametrów:	Properties Arguments

--deployment-id

Identyfikator wdrożenia interfejsu API.

--environment-id

Identyfikator zasobu środowiska w zakresie centrum interfejsu API.

Właściwość	Wartość
Grupa parametrów:	Properties Arguments

--resource-group -g

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

--server

Server Support shorthand-syntax, json-file and yaml-file. Spróbuj "??", aby pokazać więcej.

Właściwość	Wartość
Grupa parametrów:	Properties Arguments

--service-name -n

Nazwa usługi Azure API Center.

--title

Tytuł wdrożenia.

Właściwość	Wartość
Grupa parametrów:	Properties Arguments

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.

--custom-properties

Niestandardowe metadane zdefiniowane dla jednostek wykazu interfejsów API. Obsługa skróconej składni, pliku json-file i yaml-file. Spróbuj "??", aby pokazać więcej.

Właściwość	Wartość
Grupa parametrów:	Properties Arguments

--description

Opis wdrożenia.

Właściwość	Wartość
Grupa parametrów:	Properties Arguments

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość	Wartość
Domyślna wartość:	False

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość	Wartość
Domyślna wartość:	False

--output -o

Format danych wyjściowych.

Właściwość	Wartość
Domyślna wartość:	json
Dopuszczalne wartości:	json, jsonc, none, table, tsv, yaml, yamlc

--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 az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość	Wartość
Domyślna wartość:	False

az apic api deployment delete

Usuwanie wdrożenia interfejsu API.

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

Przykłady

Usuwanie wdrożenia interfejsu API

az apic api deployment delete -g api-center-test -n contoso --deployment-id production --api-id echo-api

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.

--api-id

Identyfikator interfejsu API.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--deployment-id

Identyfikator wdrożenia interfejsu API.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--ids

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

--resource-group -g

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

--service-name -n

Nazwa usługi Azure API Center.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--subscription

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

--yes -y

Nie monituj o potwierdzenie.

Właściwość	Wartość
Domyślna wartość:	False

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość	Wartość
Domyślna wartość:	False

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość	Wartość
Domyślna wartość:	False

--output -o

Format danych wyjściowych.

Właściwość	Wartość
Domyślna wartość:	json
Dopuszczalne wartości:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość	Wartość
Domyślna wartość:	False

az apic api deployment list

Wyświetlanie listy kolekcji wdrożeń interfejsu API.

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

Przykłady

Wyświetlanie listy wdrożeń interfejsu API

az apic api deployment list -g api-center-test -n contoso --api-id echo-api

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.

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.

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

Właściwość	Wartość
Grupa parametrów:	Pagination Arguments

--next-token

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

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość	Wartość
Domyślna wartość:	False

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość	Wartość
Domyślna wartość:	False

--output -o

Format danych wyjściowych.

Właściwość	Wartość
Domyślna wartość:	json
Dopuszczalne wartości:	json, jsonc, none, table, tsv, yaml, yamlc

--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 az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość	Wartość
Domyślna wartość:	False

az apic api deployment show

Uzyskaj szczegółowe informacje o wdrożeniu interfejsu API.

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

Przykłady

Pokaż szczegóły wdrożenia interfejsu API

az apic api deployment show -g api-center-test -n contoso --deployment-id production --api-id echo-api

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.

--api-id

Identyfikator interfejsu API.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--deployment-id

Identyfikator wdrożenia interfejsu API.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--ids

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--resource-group -g

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

--service-name -n

Nazwa usługi Azure API Center.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--subscription

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

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość	Wartość
Domyślna wartość:	False

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość	Wartość
Domyślna wartość:	False

--output -o

Format danych wyjściowych.

Właściwość	Wartość
Domyślna wartość:	json
Dopuszczalne wartości:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość	Wartość
Domyślna wartość:	False

az apic api deployment update

Aktualizowanie istniejącego wdrożenia interfejsu API.

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

Przykłady

Aktualizowanie wdrożenia interfejsu API

az apic api deployment update -g api-center-test -n contoso --deployment-id production --title "Production deployment" --api-id echo-api

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.

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

Właściwość	Wartość
Grupa parametrów:	Generic Update Arguments

--api-id

Identyfikator interfejsu API.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--custom-properties

Niestandardowe metadane zdefiniowane dla jednostek wykazu interfejsów API. Obsługa skróconej składni, pliku json-file i yaml-file. Spróbuj "??", aby pokazać więcej.

Właściwość	Wartość
Grupa parametrów:	Properties Arguments

--definition-id

Identyfikator zasobu definicji o zakresie usługi.

Właściwość	Wartość
Grupa parametrów:	Properties Arguments

--deployment-id

Identyfikator wdrożenia interfejsu API.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--description

Opis wdrożenia.

Właściwość	Wartość
Grupa parametrów:	Properties Arguments

--environment-id

Identyfikator zasobu środowiska o zakresie usługi.

Właściwość	Wartość
Grupa parametrów:	Properties Arguments

--force-string

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

--ids

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--remove

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

--resource-group -g

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

--server

Server Support shorthand-syntax, json-file and yaml-file. Spróbuj "??", aby pokazać więcej.

Właściwość	Wartość
Grupa parametrów:	Properties Arguments

--service-name -n

Nazwa usługi Azure API Center.

Właściwość	Wartość
Grupa parametrów:	Resource Id Arguments

--set

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

--subscription

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

--title

Title.

Właściwość	Wartość
Grupa parametrów:	Properties Arguments

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość	Wartość
Domyślna wartość:	False

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość	Wartość
Domyślna wartość:	False

--output -o

Format danych wyjściowych.

Właściwość	Wartość
Domyślna wartość:	json
Dopuszczalne wartości:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość	Wartość
Domyślna wartość:	False

Sprzężenie zwrotne

Czy ta strona była pomocna?

Udostępnij za pomocą

az apic api deployment

Polecenia

az apic api deployment create

Przykłady

Parametry wymagane

Parametry opcjonalne

az apic api deployment delete

Przykłady

Parametry opcjonalne

az apic api deployment list

Przykłady

Parametry wymagane

Parametry opcjonalne

az apic api deployment show

Przykłady

Parametry opcjonalne

az apic api deployment update

Przykłady

Parametry opcjonalne

Sprzężenie zwrotne