az spring api-portal

  • Odwołanie

Uwaga

Ta dokumentacja jest częścią rozszerzenia spring dla interfejsu wiersza polecenia platformy Azure (wersja 2.56.0 lub nowsza). Rozszerzenie zostanie automatycznie zainstalowane przy pierwszym uruchomieniu polecenia az spring api-portal . Dowiedz się więcej o rozszerzeniach.

(Tylko warstwa przedsiębiorstwa) Polecenia do zarządzania portalem interfejsu API w usłudze Azure Spring Apps.

Polecenia

Nazwa Opis Typ Stan
az spring api-portal clear

Wyczyść wszystkie ustawienia portalu interfejsu API.

 Numer wewnętrzny Ogólna dostępność
az spring api-portal create

Tworzenie portalu interfejsu API.

 Numer wewnętrzny Ogólna dostępność
az spring api-portal custom-domain

Polecenia do zarządzania domenami niestandardowymi dla portalu interfejsu API.

 Numer wewnętrzny Ogólna dostępność
az spring api-portal custom-domain bind

Wiązanie domeny niestandardowej z portalem interfejsu API.

 Numer wewnętrzny Ogólna dostępność
az spring api-portal custom-domain list

Wyświetl listę wszystkich domen niestandardowych portalu interfejsu API.

 Numer wewnętrzny Ogólna dostępność
az spring api-portal custom-domain show

Pokaż szczegóły domeny niestandardowej.

 Numer wewnętrzny Ogólna dostępność
az spring api-portal custom-domain unbind

Usuń powiązanie domeny niestandardowej portalu interfejsu API.

 Numer wewnętrzny Ogólna dostępność
az spring api-portal custom-domain update

Zaktualizuj domenę niestandardową portalu interfejsu API.

 Numer wewnętrzny Ogólna dostępność
az spring api-portal delete

Usuń portal interfejsu API.

 Numer wewnętrzny Ogólna dostępność
az spring api-portal show

Pokaż ustawienia, stan aprowizacji i stan środowiska uruchomieniowego portalu interfejsu API.

 Numer wewnętrzny Ogólna dostępność
az spring api-portal update

Zaktualizuj istniejące właściwości portalu interfejsu API.

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

az spring api-portal clear

Wyczyść wszystkie ustawienia portalu interfejsu API.

az spring api-portal clear --resource-group
                           --service

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

Nazwa wystąpienia usługi Azure Spring Apps można skonfigurować usługę domyślną przy użyciu polecenia az configure --defaults spring=.

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 spring api-portal create

Tworzenie portalu interfejsu API.

az spring api-portal create --resource-group
                            --service
                            [--instance-count]

Przykłady

Tworzenie portalu interfejsu API.

az spring api-portal create -s MyService -g MyResourceGroup --instance-count 1

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

Nazwa wystąpienia usługi Azure Spring Apps można skonfigurować usługę domyślną przy użyciu polecenia az configure --defaults spring=.

Parametry opcjonalne

--instance-count

Liczba wystąpień.

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

Usuń portal interfejsu API.

az spring api-portal delete --resource-group
                            --service
                            [--yes]

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

Nazwa wystąpienia usługi Azure Spring Apps można skonfigurować usługę domyślną przy użyciu polecenia az configure --defaults spring=.

Parametry opcjonalne

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

Pokaż ustawienia, stan aprowizacji i stan środowiska uruchomieniowego portalu interfejsu API.

az spring api-portal show --resource-group
                          --service

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

Nazwa wystąpienia usługi Azure Spring Apps można skonfigurować usługę domyślną przy użyciu polecenia az configure --defaults spring=.

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

Zaktualizuj istniejące właściwości portalu interfejsu API.

az spring api-portal update --resource-group
                            --service
                            [--assign-endpoint {false, true}]
                            [--client-id]
                            [--client-secret]
                            [--enable-api-try-out {false, true}]
                            [--https-only {false, true}]
                            [--instance-count]
                            [--issuer-uri]
                            [--scope]

Przykłady

Zaktualizuj właściwość portalu interfejsu API.

az spring api-portal update -s MyService -g MyResourceGroup --assign-endpoint true --https-only true

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

Nazwa wystąpienia usługi Azure Spring Apps można skonfigurować usługę domyślną przy użyciu polecenia az configure --defaults spring=.

Parametry opcjonalne

--assign-endpoint

Jeśli wartość true, przypisz adres URL punktu końcowego w celu uzyskania bezpośredniego dostępu.

akceptowane wartości: false, true
--client-id

Identyfikator publiczny aplikacji.

--client-secret

Wpis tajny znany tylko aplikacji i serwera autoryzacji.

--enable-api-try-out

Wypróbuj interfejs API, wysyłając żądania i wyświetlając odpowiedzi w portalu interfejsu API.

akceptowane wartości: false, true
--https-only

Jeśli wartość true, uzyskaj dostęp do punktu końcowego za pośrednictwem protokołu https.

akceptowane wartości: false, true
--instance-count

Liczba wystąpień.

--issuer-uri

Identyfikator URI identyfikatora wystawcy.

--scope

Rozdzielona przecinkami lista określonych akcji aplikacji może być dozwolona w imieniu użytkownika.

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.