Dela via

az apim api operation

Hantera API-åtgärder för Azure API Management.

Kommandon

Name Description Typ Status
az apim api operation create

Skapar en ny åtgärd i API:et.

 Core GA
az apim api operation delete

Tar bort den angivna åtgärden i API:et.

 Core GA
az apim api operation list

Lista en samling av åtgärderna för det angivna API:et.

 Core GA
az apim api operation show

Hämtar information om DEN API-åtgärd som anges av dess identifierare.

 Core GA
az apim api operation update

Uppdaterar informationen om åtgärden i API:et som anges av dess identifierare.

 Core GA

az apim api operation create

Redigera

Skapar en ny åtgärd i API:et.

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

Exempel

Skapar en ny åtgärd i API:et med flera parametrar

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"

Obligatoriska parametrar

--api-id

API-identifierare. Måste vara unikt i den aktuella API Management-tjänstinstansen. Icke-aktuell revision har ; rev=n som ett suffix där n är revisionsnumret.

Egenskap Värde
Parameter group: API Arguments
--display-name

Required. Åtgärdsnamn.

--method

Required. En giltig HTTP-åtgärdsmetod. Typiska Http-metoder som GET, PUT, POST men inte begränsas av bara dem.

--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

--service-name -n

Namnet på API Management-tjänstinstansen.

--url-template

Relativ URL-mall som identifierar målresursen för den här åtgärden. Kan innehålla parametrar.

Valfria parametrar

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

--description

Beskrivning av åtgärden. Kan innehålla HTML-formateringstaggar.

--if-match

ETag för entiteten.

--operation-id

Åtgärdsidentifierare i ett API. Måste vara unikt i den aktuella API Management-tjänstinstansen.

--params --template-parameters -p

Samling url-mallparametrar.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az apim api operation delete

Redigera

Tar bort den angivna åtgärden i API:et.

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

Exempel

Tar bort den angivna åtgärden i API:et.

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

Obligatoriska parametrar

--api-id

API-identifierare. Måste vara unikt i den aktuella API Management-tjänstinstansen. Icke-aktuell revision har ; rev=n som ett suffix där n är revisionsnumret.

Egenskap Värde
Parameter group: API Arguments
--operation-id

Åtgärdsidentifierare i ett API. Måste vara unikt i den aktuella API Management-tjänstinstansen.

--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

--service-name -n

Namnet på API Management-tjänstinstansen.

Valfria parametrar

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 för entiteten.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az apim api operation list

Redigera

Lista en samling av åtgärderna för det angivna API:et.

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

Exempel

Lista en samling av åtgärderna för det angivna API:et.

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

Obligatoriska parametrar

--api-id

API-identifierare. Måste vara unikt i den aktuella API Management-tjänstinstansen. Icke-aktuell revision har ; rev=n som ett suffix där n är revisionsnumret.

Egenskap Värde
Parameter group: API Arguments
--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

--service-name -n

Namnet på API Management-tjänstinstansen.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az apim api operation show

Redigera

Hämtar information om DEN API-åtgärd som anges av dess identifierare.

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

Exempel

Hämtar information om DEN API-åtgärd som anges av dess identifierare.

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

Obligatoriska parametrar

--api-id

API-identifierare. Måste vara unikt i den aktuella API Management-tjänstinstansen. Icke-aktuell revision har ; rev=n som ett suffix där n är revisionsnumret.

Egenskap Värde
Parameter group: API Arguments
--operation-id

Åtgärdsidentifierare i ett API. Måste vara unikt i den aktuella API Management-tjänstinstansen.

--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

--service-name -n

Namnet på API Management-tjänstinstansen.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az apim api operation update

Redigera

Uppdaterar informationen om åtgärden i API:et som anges av dess identifierare.

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]

Exempel

Uppdateringsmetod, visningsnamn, beskrivning av åtgärden i API:et som anges av dess identifierare.

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

Obligatoriska parametrar

--api-id

API-identifierare. Måste vara unikt i den aktuella API Management-tjänstinstansen. Icke-aktuell revision har ; rev=n som ett suffix där n är revisionsnumret.

Egenskap Värde
Parameter group: API Arguments
--operation-id

Åtgärdsidentifierare i ett API. Måste vara unikt i den aktuella API Management-tjänstinstansen.

--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

--service-name -n

Namnet på API Management-tjänstinstansen.

Valfria parametrar

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

--add

Lägg till ett objekt i en lista över objekt genom att ange en sökväg och nyckelvärdepar. Exempel: --add property.listProperty <key=value, string or JSON string>.

Egenskap Värde
Parameter group: Generic Update Arguments
Standardvärde: []
--description

Beskrivning av åtgärden. Kan innehålla HTML-formateringstaggar.

--display-name

Required. Åtgärdsnamn.

--force-string

När du använder "set" eller "add" bevarar du strängliteraler i stället för att försöka konvertera till JSON.

Egenskap Värde
Parameter group: Generic Update Arguments
Standardvärde: False
--if-match

ETag för entiteten.

--method

Required. En giltig HTTP-åtgärdsmetod. Typiska Http-metoder som GET, PUT, POST men inte begränsas av bara dem.

--remove

Ta bort en egenskap eller ett element från en lista. Exempel: --remove property.list <indexToRemove> ELLER --remove propertyToRemove.

Egenskap Värde
Parameter group: Generic Update Arguments
Standardvärde: []
--set

Uppdatera ett objekt genom att ange en egenskapssökväg och ett värde som ska anges. Exempel: --set property1.property2=<value>.

Egenskap Värde
Parameter group: Generic Update Arguments
Standardvärde: []
--url-template

Relativ URL-mall som identifierar målresursen för den här åtgärden. Kan innehålla parametrar.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False