Freigeben über

az apic api deployment

Note

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-API-Bereitstellungsbefehl zum ersten Mal ausführen. Erfahren Sie mehr über Erweiterungen.

Befehle zum Verwalten von API-Bereitstellungen im API Center.

Befehle

Name Beschreibung Typ Status
az apic api deployment create

Erstellen Sie eine neue API-Bereitstellung, oder aktualisieren Sie eine vorhandene API-Bereitstellung.

 Extension GA
az apic api deployment delete

Api-Bereitstellung löschen.

 Extension GA
az apic api deployment list

Listet eine Sammlung von API-Bereitstellungen auf.

 Extension GA
az apic api deployment show

Rufen Sie Details der API-Bereitstellung ab.

 Extension GA
az apic api deployment update

Aktualisieren sie die vorhandene API-Bereitstellung.

 Extension GA

az apic api deployment create

Erstellen Sie eine neue API-Bereitstellung, oder aktualisieren Sie eine vorhandene API-Bereitstellung.

az apic api deployment create --api-id
                              --definition-id
                              --deployment-id
                              --environment-id
                              --resource-group
                              --server
                              --service-name
                              --title
                              [--custom-properties]
                              [--description]

Beispiele

Bereitstellung erstellen

az apic api deployment create -g api-center-test -n contoso --deployment-id production --title "Production deployment" --description "Public cloud production deployment." --api-id echo-api --environment-id "/workspaces/default/environments/production" --definition-id "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi" --server '{"runtimeUri":["https://example.com"]}'

Erstellen der Bereitstellung mithilfe der Json-Datei des Servers

az apic api deployment create -g api-center-test -n contoso --deployment-id production --title "Production deployment" --description "Public cloud production deployment." --api-id echo-api --environment-id "/workspaces/default/environments/production" --definition-id "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi" --server '@server.json'

Erforderliche Parameter

--api-id

Die ID der API.

--definition-id

API-zentrierte Definitionsressourcen-ID.

Eigenschaft Wert
Parametergruppe: Properties Arguments
--deployment-id

Die ID der API-Bereitstellung.

--environment-id

API-zentrierte Umgebungsressourcen-ID.

Eigenschaft Wert
Parametergruppe: Properties Arguments
--resource-group -g

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

--server

Server support shorthand-syntax, json-file and yaml-file. Probieren Sie "??" aus, um mehr anzuzeigen.

Eigenschaft Wert
Parametergruppe: Properties Arguments
--service-name -n

Der Name des Azure API Center-Diensts.

--title

Bereitstellungstitel.

Eigenschaft Wert
Parametergruppe: Properties Arguments

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.

--custom-properties

Die benutzerdefinierten Metadaten, die für API-Katalogentitäten definiert sind. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

Eigenschaft Wert
Parametergruppe: Properties Arguments
--description

Beschreibung der Bereitstellung.

Eigenschaft Wert
Parametergruppe: Properties 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

az apic api deployment delete

Api-Bereitstellung löschen.

az apic api deployment delete [--api-id]
                              [--deployment-id]
                              [--ids]
                              [--resource-group]
                              [--service-name]
                              [--subscription]
                              [--yes]

Beispiele

Löschen der API-Bereitstellung

az apic api deployment delete -g api-center-test -n contoso --deployment-id production --api-id echo-api

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.

--api-id

Die ID der API.

Eigenschaft Wert
Parametergruppe: Resource Id Arguments
--deployment-id

Die ID der API-Bereitstellung.

Eigenschaft Wert
Parametergruppe: Resource Id Arguments
--ids

Mindestens eine Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

Eigenschaft Wert
Parametergruppe: Resource Id Arguments
--resource-group -g

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

Eigenschaft Wert
Parametergruppe: Resource Id Arguments
--service-name -n

Der Name des Azure API Center-Diensts.

Eigenschaft Wert
Parametergruppe: Resource Id Arguments
--subscription

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

Eigenschaft Wert
Parametergruppe: Resource Id Arguments
--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/.

--verbose

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

Eigenschaft Wert
Standardwert: False

az apic api deployment list

Listet eine Sammlung von API-Bereitstellungen auf.

az apic api deployment list --api-id
                            --resource-group
                            --service-name
                            [--filter]
                            [--max-items]
                            [--next-token]

Beispiele

Api-Bereitstellungen auflisten

az apic api deployment list -g api-center-test -n contoso --api-id echo-api

Erforderliche Parameter

--api-id

Die ID der API.

--resource-group -g

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

--service-name -n

Der Name des Azure API Center-Diensts.

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.

--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 in --next-token Argument eines nachfolgenden Befehls an.

Eigenschaft Wert
Parametergruppe: Pagination Arguments
--next-token

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

Eigenschaft Wert
Parametergruppe: Pagination 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

az apic api deployment show

Rufen Sie Details der API-Bereitstellung ab.

az apic api deployment show [--api-id]
                            [--deployment-id]
                            [--ids]
                            [--resource-group]
                            [--service-name]
                            [--subscription]

Beispiele

Api-Bereitstellungsdetails anzeigen

az apic api deployment show -g api-center-test -n contoso --deployment-id production --api-id echo-api

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.

--api-id

Die ID der API.

Eigenschaft Wert
Parametergruppe: Resource Id Arguments
--deployment-id

Die ID der API-Bereitstellung.

Eigenschaft Wert
Parametergruppe: Resource Id Arguments
--ids

Mindestens eine Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

Eigenschaft Wert
Parametergruppe: Resource Id Arguments
--resource-group -g

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

Eigenschaft Wert
Parametergruppe: Resource Id Arguments
--service-name -n

Der Name des Azure API Center-Diensts.

Eigenschaft Wert
Parametergruppe: Resource Id Arguments
--subscription

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

Eigenschaft Wert
Parametergruppe: Resource Id 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/.

--verbose

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

Eigenschaft Wert
Standardwert: False

az apic api deployment update

Aktualisieren sie die vorhandene API-Bereitstellung.

az apic api deployment update [--add]
                              [--api-id]
                              [--custom-properties]
                              [--definition-id]
                              [--deployment-id]
                              [--description]
                              [--environment-id]
                              [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                              [--ids]
                              [--remove]
                              [--resource-group]
                              [--server]
                              [--service-name]
                              [--set]
                              [--subscription]
                              [--title]

Beispiele

Aktualisieren der API-Bereitstellung

az apic api deployment update -g api-center-test -n contoso --deployment-id production --title "Production deployment" --api-id echo-api

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.

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

Eigenschaft Wert
Parametergruppe: Generic Update Arguments
--api-id

Die ID der API.

Eigenschaft Wert
Parametergruppe: Resource Id Arguments
--custom-properties

Die benutzerdefinierten Metadaten, die für API-Katalogentitäten definiert sind. Unterstützung von Shorthand-Syntax, JSON-Datei und Yaml-Datei. Probieren Sie "??" aus, um mehr anzuzeigen.

Eigenschaft Wert
Parametergruppe: Properties Arguments
--definition-id

Ressourcen-ID der Dienstdefinition.

Eigenschaft Wert
Parametergruppe: Properties Arguments
--deployment-id

Die ID der API-Bereitstellung.

Eigenschaft Wert
Parametergruppe: Resource Id Arguments
--description

Beschreibung der Bereitstellung.

Eigenschaft Wert
Parametergruppe: Properties Arguments
--environment-id

Ressourcen-ID der Dienstbereichsumgebung.

Eigenschaft Wert
Parametergruppe: Properties Arguments
--force-string

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

Eigenschaft Wert
Parametergruppe: Generic Update Arguments
Zulässige Werte: 0, 1, f, false, n, no, t, true, y, yes
--ids

Mindestens eine Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

Eigenschaft Wert
Parametergruppe: Resource Id Arguments
--remove

Entfernen sie eine Eigenschaft oder ein Element aus einer Liste. Beispiel: --remove property.list <indexToRemove> ODER --remove propertyToRemove.

Eigenschaft Wert
Parametergruppe: Generic Update Arguments
--resource-group -g

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

Eigenschaft Wert
Parametergruppe: Resource Id Arguments
--server

Server support shorthand-syntax, json-file and yaml-file. Probieren Sie "??" aus, um mehr anzuzeigen.

Eigenschaft Wert
Parametergruppe: Properties Arguments
--service-name -n

Der Name des Azure API Center-Diensts.

Eigenschaft Wert
Parametergruppe: Resource Id Arguments
--set

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

Eigenschaft Wert
Parametergruppe: Generic Update Arguments
--subscription

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

Eigenschaft Wert
Parametergruppe: Resource Id Arguments
--title

Title.

Eigenschaft Wert
Parametergruppe: Properties 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/.

--verbose

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

Eigenschaft Wert
Standardwert: False