Freigeben über

az apic environment

  • Referenz

Hinweis

Diese Referenz ist Teil der APIC-Erweiterungserweiterung für die Azure CLI (Version 2.57.0 oder höher). Die Erweiterung wird automatisch installiert, wenn Sie einen Az apic-Umgebungsbefehl zum ersten Mal ausführen. Weitere Informationen zu Erweiterungen

Befehle zum Verwalten von Umgebungen im API Center.

Befehle

Name Beschreibung Typ Status
az apic environment create

Erstellen Sie eine neue Umgebung, oder aktualisieren Sie eine vorhandene Umgebung.

 Erweiterung Allgemein verfügbar
az apic environment delete

Die Umgebung löschen.

 Erweiterung Allgemein verfügbar
az apic environment list

Listet eine Sammlung von Umgebungen auf.

 Erweiterung Allgemein verfügbar
az apic environment show

Rufen Sie Details zur Umgebung ab.

 Erweiterung Allgemein verfügbar
az apic environment update

Vorhandene Umgebung aktualisieren.

 Erweiterung Allgemein verfügbar

az apic environment create

Erstellen Sie eine neue Umgebung, oder aktualisieren Sie eine vorhandene Umgebung.

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

Beispiele

Umgebung erstellen

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

Erforderliche Parameter

--environment-id

Die ID der Umgebung.

--resource-group -g

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

--service --service-name -s

Der Name des API Center-Diensts.

--title

Titel der Umgebung.

--type

Umgebungstyp.

Zulässige Werte: development, production, staging, testing

Optionale Parameter

--custom-properties

Die benutzerdefinierten Metadaten, die für API-Katalogentitäten definiert sind. Unterstützen Sie json-file und yaml-file.

--description

Beschreibung der Umgebung.

--onboarding

Bereitstellen von Onboarding-Dokumentationen im Zusammenhang mit Ihrer Umgebung, z. B. {developerPortalUri:['https://developer.contoso.com'],instructions:'instructions markdown'} Unterstützung shorthand-syntax, json-file und yaml-file. Probieren Sie "??" aus, um mehr anzuzeigen.

--server

Serverinformationen der Umgebung. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

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

Die Umgebung löschen.

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

Beispiele

Umgebung löschen

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

Optionale Parameter

--environment-id

Die ID der Umgebung.

--ids

Eine oder mehrere Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der „Ressource id“-Argumente handeln. Sie sollten entweder „--ids“ oder andere „Resource Id“-Argumente angeben.

--resource-group -g

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

--service --service-name -s

Der Name des API Center-Diensts.

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

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

Listet eine Sammlung von Umgebungen auf.

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

Beispiele

Umgebungen auflisten

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

Erforderliche Parameter

--resource-group -g

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

--service --service-name -s

Der Name des API Center-Diensts.

Optionale Parameter

--filter

OData-Filterparameter.

--max-items

Die Gesamtanzahl der Elemente, die in der Ausgabe des Befehls zurückgegeben werden sollen. Wenn die Gesamtanzahl der verfügbaren Elemente größer als der angegebene Wert ist, wird ein Token in der Ausgabe des Befehls bereitgestellt. Um die Paginierung fortzusetzen, geben Sie den Tokenwert im --next-token Argument eines nachfolgenden Befehls an.

--next-token

Token, das angibt, wo die Paginierung beginnen soll. Dies ist der Tokenwert aus einer zuvor abgeschnittenen Antwort.

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

Rufen Sie Details zur Umgebung ab.

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

Beispiele

Anzeigen von Umgebungsdetails

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

Optionale Parameter

--environment-id

Die ID der Umgebung.

--ids

Eine oder mehrere Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der „Ressource id“-Argumente handeln. Sie sollten entweder „--ids“ oder andere „Resource Id“-Argumente angeben.

--resource-group -g

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

--service --service-name -s

Der Name des API Center-Diensts.

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

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

Vorhandene Umgebung aktualisieren.

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

Beispiele

Aktualisieren der Umgebung

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

Optionale Parameter

--add

Fügen Sie einer Liste von Objekten ein Objekt hinzu, indem Sie ein Pfad- und Schlüsselwertpaar angeben. Beispiel: --add property.listProperty <key=value, string or JSON string>.

--custom-properties

Die benutzerdefinierten Metadaten, die für API-Katalogentitäten definiert sind. Unterstützen Sie json-file und yaml-file.

--description

Beschreibung:

--environment-id

Die ID der Umgebung.

--force-string

Wenn Sie "set" oder "add" verwenden, behalten Sie Zeichenfolgenliterale bei, anstatt zu versuchen, in JSON zu konvertieren.

Zulässige Werte: 0, 1, f, false, n, no, t, true, y, yes
--ids

Eine oder mehrere Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der „Ressource id“-Argumente handeln. Sie sollten entweder „--ids“ oder andere „Resource Id“-Argumente angeben.

--onboarding

{developerPortalUri:['https://developer.contoso.com],instructions:'instructions markdown'} Unterstützen Sie kurzhand-Syntax, json-file und yaml-file. Probieren Sie "??" aus, um mehr anzuzeigen.

--remove

Entfernen sie eine Eigenschaft oder ein Element aus einer Liste. Beispiel: --remove property.list OR --remove propertyToRemove.

--resource-group -g

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

--server

Serverinformationen der Umgebung. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

--service --service-name -s

Der Name des API Center-Diensts.

--set

Aktualisieren Sie ein Objekt, indem Sie einen festzulegenden Eigenschaftspfad und -wert angeben. Beispiel: --set property1.property2=.

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

--title

Titel der Umgebung.

--type

Umgebungstyp.

Zulässige Werte: development, production, staging, testing
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.