Udostępnij przez

az apic environment

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

Polecenia do zarządzania środowiskami w Centrum interfejsów API.

Polecenia

Nazwa Opis Typ Stan
az apic environment create

Utwórz nowe środowisko lub zaktualizuj istniejące środowisko.

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

Usuwanie środowiska.

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

Wyświetlanie listy kolekcji środowisk.

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

Uzyskaj szczegółowe informacje o środowisku.

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

Aktualizowanie istniejącego środowiska.

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

az apic environment create

Utwórz nowe środowisko lub zaktualizuj istniejące środowisko.

az apic environment create --environment-id
                           --resource-group
                           --service
                           --title
                           --type {development, production, staging, testing}
                           [--custom-properties]
                           [--description]
                           [--onboarding]
                           [--server]

Przykłady

Tworzenie środowiska

az apic environment create -g api-center-test -s contosoeuap --environment-id public --title "Public cloud" --type "development"

Parametry wymagane

--environment-id

Identyfikator środowiska.

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

Tytuł środowiska.

--type

Typ środowiska.

akceptowane wartości: development, production, staging, testing

Parametry opcjonalne

--custom-properties

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

--description

Opis środowiska.

--onboarding

Podaj dokumentację dołączania powiązaną ze środowiskiem, np. {developerPortalUri:['https://developer.contoso.com'],instructions:'instructions markdown'} Support shorthand-syntax, json-file and yaml-file. Spróbuj "??", aby pokazać więcej.

--server

Informacje o serwerze środowiska. 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.

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

Usuwanie środowiska.

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

Przykłady

Usuwanie środowiska

az apic environment delete -g api-center-test -s contosoeuap --environment-id public

Parametry opcjonalne

--environment-id

Identyfikator środowiska.

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

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

Wyświetlanie listy kolekcji środowisk.

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

Przykłady

Tworzenie listy środowisk

az apic environment list -g api-center-test -s contosoeuap

Parametry wymagane

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

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

Uzyskaj szczegółowe informacje o środowisku.

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

Przykłady

Pokaż szczegóły środowiska

az apic environment show -g api-center-test -s contosoeuap --environment-id public

Parametry opcjonalne

--environment-id

Identyfikator środowiska.

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

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

Aktualizowanie istniejącego środowiska.

az apic environment update [--add]
                           [--custom-properties]
                           [--description]
                           [--environment-id]
                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                           [--ids]
                           [--onboarding]
                           [--remove]
                           [--resource-group]
                           [--server]
                           [--service]
                           [--set]
                           [--subscription]
                           [--title]
                           [--type {development, production, staging, testing}]

Przykłady

Aktualizowanie środowiska

az apic environment update -g api-center-test -s contosoeuap --environment-id public --title "Public cloud"

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.

--custom-properties

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

--description

Opis.

--environment-id

Identyfikator środowiska.

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

--onboarding

{developerPortalUri:[''https://developer.contoso.com],instructions:'instructions markdown'} Support shorthand-syntax, json-file and yaml-file. Spróbuj "??", aby pokazać więcej.

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

--server

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

--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ł środowiska.

--type

Typ środowiska.

akceptowane wartości: development, production, staging, testing
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.