Delen via

az apim api operation

  • Referentie

Azure API Management API-bewerkingen beheren.

Opdracht

Name Description Type Status
az apim api operation create

Hiermee maakt u een nieuwe bewerking in de API.

 Basis GA
az apim api operation delete

Hiermee verwijdert u de opgegeven bewerking in de API.

 Basis GA
az apim api operation list

Een verzameling van de bewerkingen voor de opgegeven API weergeven.

 Basis GA
az apim api operation show

Hiermee haalt u de details op van de API-bewerking die is opgegeven met de id.

 Basis GA
az apim api operation update

Hiermee worden de details van de bewerking in de API bijgewerkt die is opgegeven met de id.

 Basis GA

az apim api operation create

Bewerken

Hiermee maakt u een nieuwe bewerking in de API.

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

Voorbeelden

Hiermee maakt u een nieuwe bewerking in de API met verschillende parameters

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"

Vereiste parameters

--api-id

API-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service. Niet-huidige herziening heeft ; rev=n als achtervoegsel waarbij n het revisienummer is.

--display-name

Vereist. Bewerkingsnaam.

--method

Vereist. Een geldige HTTP-bewerkingsmethode. Typische HTTP-methoden zoals GET, PUT, POST, maar niet beperkt door alleen deze methoden.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--service-name -n

De naam van het API Management-service-exemplaar.

--url-template

Relatieve URL-sjabloon waarmee de doelresource voor deze bewerking wordt geïdentificeerd. Kan parameters bevatten.

Optionele parameters

--description

Beschrijving van de bewerking. Kan HTML-opmaaktags bevatten.

--if-match

ETag van de entiteit.

--operation-id

Bewerkings-id binnen een API. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service.

--params --template-parameters -p

Verzameling url-sjabloonparameters.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az apim api operation delete

Bewerken

Hiermee verwijdert u de opgegeven bewerking in de API.

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

Voorbeelden

Hiermee verwijdert u de opgegeven bewerking in de API.

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

Vereiste parameters

--api-id

API-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service. Niet-huidige herziening heeft ; rev=n als achtervoegsel waarbij n het revisienummer is.

--operation-id

Bewerkings-id binnen een API. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--service-name -n

De naam van het API Management-service-exemplaar.

Optionele parameters

--if-match

ETag van de entiteit.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az apim api operation list

Bewerken

Een verzameling van de bewerkingen voor de opgegeven API weergeven.

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

Voorbeelden

Een verzameling van de bewerkingen voor de opgegeven API weergeven.

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

Vereiste parameters

--api-id

API-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service. Niet-huidige herziening heeft ; rev=n als achtervoegsel waarbij n het revisienummer is.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--service-name -n

De naam van het API Management-service-exemplaar.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az apim api operation show

Bewerken

Hiermee haalt u de details op van de API-bewerking die is opgegeven met de id.

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

Voorbeelden

Hiermee haalt u de details op van de API-bewerking die is opgegeven met de id.

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

Vereiste parameters

--api-id

API-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service. Niet-huidige herziening heeft ; rev=n als achtervoegsel waarbij n het revisienummer is.

--operation-id

Bewerkings-id binnen een API. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--service-name -n

De naam van het API Management-service-exemplaar.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az apim api operation update

Bewerken

Hiermee worden de details van de bewerking in de API bijgewerkt die is opgegeven met de id.

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]

Voorbeelden

Updatemethode, displayname, beschrijving van de bewerking in de API die is opgegeven door de id.

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

Vereiste parameters

--api-id

API-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service. Niet-huidige herziening heeft ; rev=n als achtervoegsel waarbij n het revisienummer is.

--operation-id

Bewerkings-id binnen een API. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service.

--resource-group -g

De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

--service-name -n

De naam van het API Management-service-exemplaar.

Optionele parameters

--add

Voeg een object toe aan een lijst met objecten door een pad- en sleutelwaardeparen op te geven. Voorbeeld: --add property.listProperty <key=value, string or JSON string>.

standaardwaarde: []
--description

Beschrijving van de bewerking. Kan HTML-opmaaktags bevatten.

--display-name

Vereist. Bewerkingsnaam.

--force-string

Wanneer u 'set' of 'toevoegen' gebruikt, behoudt u letterlijke tekenreeksen in plaats van te converteren naar JSON.

standaardwaarde: False
--if-match

ETag van de entiteit.

--method

Vereist. Een geldige HTTP-bewerkingsmethode. Typische HTTP-methoden zoals GET, PUT, POST, maar niet beperkt door alleen deze methoden.

--remove

Een eigenschap of element uit een lijst verwijderen. Voorbeeld: --remove property.list <indexToRemove> OF --remove propertyToRemove.

standaardwaarde: []
--set

Werk een object bij door een eigenschapspad en waarde op te geven die u wilt instellen. Voorbeeld: --set property1.property2=<value>.

standaardwaarde: []
--url-template

Relatieve URL-sjabloon waarmee de doelresource voor deze bewerking wordt geïdentificeerd. Kan parameters bevatten.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
standaardwaarde: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.