Freigeben über

az spring api-portal

  • Als veraltet markiert

Hinweis

Diese Referenz ist Teil der Spring-Erweiterung für die Azure CLI (Version 2.56.0 oder höher). Die Erweiterung wird automatisch installiert, wenn Sie ein az spring api-portal Befehl ausführen. Erfahren Sie mehr über Erweiterungen.

Diese Befehlsgruppe ist implizit veraltet, da die Befehlsgruppe "spring" veraltet ist und in einer zukünftigen Version entfernt wird.

(Nur Enterprise-Ebene) Befehle zum Verwalten des API-Portals in Azure Spring Apps.

Befehle

Name Beschreibung Typ Status
az spring api-portal clear

Löschen Sie alle Einstellungen des API-Portals.

 Erweiterung Deprecated
az spring api-portal create

Api-Portal erstellen.

 Erweiterung Deprecated
az spring api-portal custom-domain

Befehle zum Verwalten von benutzerdefinierten Domänen für das API-Portal.

 Erweiterung Deprecated
az spring api-portal custom-domain bind

Binden Sie eine benutzerdefinierte Domäne mit dem API-Portal.

 Erweiterung Deprecated
az spring api-portal custom-domain list

Auflisten aller benutzerdefinierten Domänen des API-Portals.

 Erweiterung Deprecated
az spring api-portal custom-domain show

Details einer benutzerdefinierten Domäne anzeigen.

 Erweiterung Deprecated
az spring api-portal custom-domain unbind

Aufheben der Verknüpfung einer benutzerdefinierten Domäne des API-Portals.

 Erweiterung Deprecated
az spring api-portal custom-domain update

Aktualisieren Sie eine benutzerdefinierte Domäne des API-Portals.

 Erweiterung Deprecated
az spring api-portal delete

API-Portal löschen.

 Erweiterung Deprecated
az spring api-portal show

Zeigen Sie die Einstellungen, den Bereitstellungsstatus und den Laufzeitstatus des API-Portals an.

 Erweiterung Deprecated
az spring api-portal update

Aktualisieren Sie eine vorhandene API-Portaleigenschaften.

 Erweiterung Deprecated

az spring api-portal clear

Als veraltet markiert

Dieser Befehl ist implizit veraltet, da die Befehlsgruppe "spring" veraltet ist und in einer zukünftigen Version entfernt wird.

Löschen Sie alle Einstellungen des API-Portals.

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

Erforderliche Parameter

--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

--service -s

Der Name der Azure Spring Apps-Instanz, sie können den Standarddienst mithilfe von az configure --defaults spring=<name>konfigurieren.

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az spring api-portal create

Als veraltet markiert

Dieser Befehl ist implizit veraltet, da die Befehlsgruppe "spring" veraltet ist und in einer zukünftigen Version entfernt wird.

Api-Portal erstellen.

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

Beispiele

Api-Portal erstellen.

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

Erforderliche Parameter

--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

--service -s

Der Name der Azure Spring Apps-Instanz, sie können den Standarddienst mithilfe von az configure --defaults spring=<name>konfigurieren.

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--instance-count

Anzahl der Instanzen.

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az spring api-portal delete

Als veraltet markiert

Dieser Befehl ist implizit veraltet, da die Befehlsgruppe "spring" veraltet ist und in einer zukünftigen Version entfernt wird.

API-Portal löschen.

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

Erforderliche Parameter

--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

--service -s

Der Name der Azure Spring Apps-Instanz, sie können den Standarddienst mithilfe von az configure --defaults spring=<name>konfigurieren.

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--yes -y

Zur Bestätigung nicht auffordern.

Eigenschaft Wert
Standardwert: False
Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az spring api-portal show

Als veraltet markiert

Dieser Befehl ist implizit veraltet, da die Befehlsgruppe "spring" veraltet ist und in einer zukünftigen Version entfernt wird.

Zeigen Sie die Einstellungen, den Bereitstellungsstatus und den Laufzeitstatus des API-Portals an.

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

Erforderliche Parameter

--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

--service -s

Der Name der Azure Spring Apps-Instanz, sie können den Standarddienst mithilfe von az configure --defaults spring=<name>konfigurieren.

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az spring api-portal update

Als veraltet markiert

Dieser Befehl ist implizit veraltet, da die Befehlsgruppe "spring" veraltet ist und in einer zukünftigen Version entfernt wird.

Aktualisieren Sie eine vorhandene API-Portaleigenschaften.

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]

Beispiele

Api-Portaleigenschaft aktualisieren.

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

Erforderliche Parameter

--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

--service -s

Der Name der Azure Spring Apps-Instanz, sie können den Standarddienst mithilfe von az configure --defaults spring=<name>konfigurieren.

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--assign-endpoint

Wenn true, weisen Sie endpunkt-URL für den direkten Zugriff zu.

Eigenschaft Wert
Zulässige Werte: false, true
--client-id

Der öffentliche Bezeichner für die Anwendung.

Eigenschaft Wert
Parametergruppe: Single Sign On (SSO) Arguments
--client-secret

Der geheime Schlüssel, der nur für die Anwendung und den Autorisierungsserver bekannt ist.

Eigenschaft Wert
Parametergruppe: Single Sign On (SSO) Arguments
--enable-api-try-out

Testen Sie die API, indem Sie Anforderungen senden und Antworten im API-Portal anzeigen.

Eigenschaft Wert
Parametergruppe: Try out API Arguments
Zulässige Werte: false, true
--https-only

Bei "true" greifen Sie über https auf den Endpunkt zu.

Eigenschaft Wert
Zulässige Werte: false, true
--instance-count

Anzahl der Instanzen.

--issuer-uri

Der URI des Ausstellerbezeichners.

Eigenschaft Wert
Parametergruppe: Single Sign On (SSO) Arguments
--scope

Durch Trennzeichen getrennte Liste der spezifischen Aktionen können Anwendungen im Namen eines Benutzers ausführen können.

Eigenschaft Wert
Parametergruppe: Single Sign On (SSO) Arguments
Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False