Freigeben über

az apim api operation

Verwalten von Azure-API-Verwaltungs-API-Vorgängen

Befehle

Name Beschreibung Typ Status
az apim api operation create

Erstellt einen neuen Vorgang in der API.

 Core GA
az apim api operation delete

Löscht den angegebenen Vorgang in der API.

 Core GA
az apim api operation list

Listet eine Auflistung der Vorgänge für die angegebene API auf.

 Core GA
az apim api operation show

Ruft die Details des API-Vorgangs ab, der durch seinen Bezeichner angegeben wird.

 Core GA
az apim api operation update

Aktualisiert die Details des Vorgangs in der api, die durch den Bezeichner angegeben wird.

 Core GA

az apim api operation create

Bearbeiten

Erstellt einen neuen Vorgang in der API.

az apim api operation create --api-id
                             --display-name
                             --method
                             --resource-group
                             --service-name
                             --url-template
                             [--description]
                             [--if-match]
                             [--operation-id]
                             [--params --template-parameters]

Beispiele

Erstellt einen neuen Vorgang in der API mit mehreren Parametern.

az apim api operation create --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --url-template "/session/{param1}/{param2}" --method "GET" --display-name MyOperationName --description MyDescription --template-parameters name=param1 description=descriptionContent type=paramType required="true" --template-parameters name=param2 required="false" type="string"

Erforderliche Parameter

--api-id

API-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein. Die nicht aktuelle Überarbeitung hat ; rev=n als Suffix, wobei n die Revisionsnummer ist.

Eigenschaft Wert
Parameter group: API Arguments
--display-name

Required. Vorgangsname.

--method

Required. Eine gültige HTTP-Vorgangsmethode. Typische HTTP-Methoden wie GET, PUT, POST, aber nicht nur durch sie beschränkt.

--resource-group -g

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

--service-name -n

Der Name der API-Verwaltungsdienstinstanz.

--url-template

Relative URL-Vorlage, die die Zielressource für diesen Vorgang identifiziert. Kann Parameter enthalten.

Optionale Parameter

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--description

Beschreibung des Vorgangs. Kann HTML-Formatierungstags enthalten.

--if-match

ETag der Entität.

--operation-id

Vorgangsbezeichner innerhalb einer API. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

--params --template-parameters -p

Sammlung von URL-Vorlagenparametern.

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 apim api operation delete

Bearbeiten

Löscht den angegebenen Vorgang in der API.

az apim api operation delete --api-id
                             --operation-id
                             --resource-group
                             --service-name
                             [--if-match]

Beispiele

Löscht den angegebenen Vorgang in der API.

az apim api operation delete --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --operation-id MyOperationId

Erforderliche Parameter

--api-id

API-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein. Die nicht aktuelle Überarbeitung hat ; rev=n als Suffix, wobei n die Revisionsnummer ist.

Eigenschaft Wert
Parameter group: API Arguments
--operation-id

Vorgangsbezeichner innerhalb einer API. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

--resource-group -g

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

--service-name -n

Der Name der API-Verwaltungsdienstinstanz.

Optionale Parameter

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--if-match

ETag der Entität.

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 apim api operation list

Bearbeiten

Listet eine Auflistung der Vorgänge für die angegebene API auf.

az apim api operation list --api-id
                           --resource-group
                           --service-name

Beispiele

Listet eine Auflistung der Vorgänge für die angegebene API auf.

az apim api operation list --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId

Erforderliche Parameter

--api-id

API-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein. Die nicht aktuelle Überarbeitung hat ; rev=n als Suffix, wobei n die Revisionsnummer ist.

Eigenschaft Wert
Parameter group: API Arguments
--resource-group -g

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

--service-name -n

Der Name der API-Verwaltungsdienstinstanz.

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 apim api operation show

Bearbeiten

Ruft die Details des API-Vorgangs ab, der durch seinen Bezeichner angegeben wird.

az apim api operation show --api-id
                           --operation-id
                           --resource-group
                           --service-name

Beispiele

Ruft die Details des API-Vorgangs ab, der durch seinen Bezeichner angegeben wird.

az apim api operation show --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --operation-id MyOperationId

Erforderliche Parameter

--api-id

API-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein. Die nicht aktuelle Überarbeitung hat ; rev=n als Suffix, wobei n die Revisionsnummer ist.

Eigenschaft Wert
Parameter group: API Arguments
--operation-id

Vorgangsbezeichner innerhalb einer API. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

--resource-group -g

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

--service-name -n

Der Name der API-Verwaltungsdienstinstanz.

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 apim api operation update

Bearbeiten

Aktualisiert die Details des Vorgangs in der api, die durch den Bezeichner angegeben wird.

az apim api operation update --api-id
                             --operation-id
                             --resource-group
                             --service-name
                             [--add]
                             [--description]
                             [--display-name]
                             [--force-string]
                             [--if-match]
                             [--method]
                             [--remove]
                             [--set]
                             [--url-template]

Beispiele

Aktualisiert methode, displayname, description of the operation in the API specified by its identifier.

az apim api operation update --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --operation-id MyOperationId --method "PUT" --display-name NewDisplayName --description NewDescription

Erforderliche Parameter

--api-id

API-ID. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein. Die nicht aktuelle Überarbeitung hat ; rev=n als Suffix, wobei n die Revisionsnummer ist.

Eigenschaft Wert
Parameter group: API Arguments
--operation-id

Vorgangsbezeichner innerhalb einer API. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

--resource-group -g

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

--service-name -n

Der Name der API-Verwaltungsdienstinstanz.

Optionale Parameter

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--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
Parameter group: Generic Update Arguments
Standardwert: []
--description

Beschreibung des Vorgangs. Kann HTML-Formatierungstags enthalten.

--display-name

Required. Vorgangsname.

--force-string

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

Eigenschaft Wert
Parameter group: Generic Update Arguments
Standardwert: False
--if-match

ETag der Entität.

--method

Required. Eine gültige HTTP-Vorgangsmethode. Typische HTTP-Methoden wie GET, PUT, POST, aber nicht nur durch sie beschränkt.

--remove

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

Eigenschaft Wert
Parameter group: Generic Update Arguments
Standardwert: []
--set

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

Eigenschaft Wert
Parameter group: Generic Update Arguments
Standardwert: []
--url-template

Relative URL-Vorlage, die die Zielressource für diesen Vorgang identifiziert. Kann Parameter enthalten.

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