Share via

az spring api-portal

  • Referenz

Hinweis

Diese Referenz ist Teil der Federerweiterung für die Azure CLI (Version 2.56.0 oder höher). Die Erweiterung wird automatisch installiert, wenn Sie einen az spring api-portal-Befehl zum ersten Mal ausführen. Weitere Informationen zu Erweiterungen

(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 Allgemein verfügbar
az spring api-portal create

Api-Portal erstellen.

 Erweiterung Allgemein verfügbar
az spring api-portal custom-domain

Befehle zum Verwalten von benutzerdefinierten Aufgaben Standard s für das API-Portal.

 Erweiterung Allgemein verfügbar
az spring api-portal custom-domain bind

Binden Sie eine benutzerdefinierte Do Standard mit dem API-Portal.

 Erweiterung Allgemein verfügbar
az spring api-portal custom-domain list

Listet alle benutzerdefinierten Do Standard s des API-Portals auf.

 Erweiterung Allgemein verfügbar
az spring api-portal custom-domain show

Details einer benutzerdefinierten Do anzeigen Standard.

 Erweiterung Allgemein verfügbar
az spring api-portal custom-domain unbind

Aufheben der Verknüpfung einer benutzerdefinierten Do Standard des API-Portals.

 Erweiterung Allgemein verfügbar
az spring api-portal custom-domain update

Aktualisieren Sie eine benutzerdefinierte Do Standard des API-Portals.

 Erweiterung Allgemein verfügbar
az spring api-portal delete

API-Portal löschen.

 Erweiterung Allgemein verfügbar
az spring api-portal show

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

 Erweiterung Allgemein verfügbar
az spring api-portal update

Aktualisieren Sie eine vorhandene API-Portaleigenschaften.

 Erweiterung Allgemein verfügbar

az spring api-portal clear

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

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

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

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az spring api-portal create

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

Optionale Parameter

--instance-count

Anzahl der Instanzen

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

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

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az spring api-portal delete

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

Optionale Parameter

--yes -y

Nicht zur Bestätigung auffordern

Standardwert: False
Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

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

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az spring api-portal show

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

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

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

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az spring api-portal update

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

Optionale Parameter

--assign-endpoint

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

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

Der öffentliche Bezeichner für die Anwendung.

--client-secret

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

--enable-api-try-out

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

Zulässige Werte: false, true
--https-only

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

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

Anzahl der Instanzen

--issuer-uri

Der URI des Ausstellerbezeichners.

--scope

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

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

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

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.