az apim api operation

Azure API Management API-bewerkingen beheren.

Opdracht

az apim api operation create

Hiermee maakt u een nieuwe bewerking in de API.

az apim api operation delete

Hiermee verwijdert u de opgegeven bewerking in de API.

az apim api operation list

Een lijst met een verzameling van de bewerkingen voor de opgegeven API.

az apim api operation show

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

az apim api operation update

Werkt de details bij van de bewerking in de API die is opgegeven door de id.

az apim api operation create

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]
                             [--subscription]

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 API Management service-exemplaar. Niet-huidige revisie 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 die de doelresource voor deze bewerking identificeert. 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 API Management service-exemplaar.

--params --template-parameters -p

Verzameling URL-sjabloonparameters.

--subscription

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

az apim api operation delete

Hiermee verwijdert u de opgegeven bewerking in de API.

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

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 API Management service-exemplaar. Niet-huidige revisie heeft ;rev=n als achtervoegsel, waarbij n het revisienummer is.

--operation-id

Bewerkings-id binnen een API. Moet uniek zijn in het huidige API Management service-exemplaar.

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

--subscription

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

az apim api operation list

Een lijst met een verzameling van de bewerkingen voor de opgegeven API.

az apim api operation list --api-id
                           --resource-group
                           --service-name
                           [--query-examples]
                           [--subscription]

Voorbeelden

Een lijst met een verzameling van de bewerkingen voor de opgegeven API.

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 API Management service-exemplaar. Niet-huidige revisie 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.

Optionele parameters

--query-examples

JMESPath-tekenreeks voor u aanbevelen. U kunt een van de query's kopiƫren en plakken na de parameter --query tussen dubbele aanhalingstekens om de resultaten te bekijken. U kunt een of meer positionele trefwoorden toevoegen, zodat we suggesties kunnen geven op basis van deze sleutelwoorden.

--subscription

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

az apim api operation show

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

az apim api operation show --api-id
                           --operation-id
                           --resource-group
                           --service-name
                           [--query-examples]
                           [--subscription]

Voorbeelden

Hiermee haalt u de details op van de API-bewerking die is opgegeven door 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 API Management service-exemplaar. Niet-huidige revisie heeft ;rev=n als achtervoegsel, waarbij n het revisienummer is.

--operation-id

Bewerkings-id binnen een API. Moet uniek zijn in het huidige API Management service-exemplaar.

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

--query-examples

JMESPath-tekenreeks voor u aanbevelen. U kunt een van de query's kopiƫren en plakken na de parameter --query tussen dubbele aanhalingstekens om de resultaten te bekijken. U kunt een of meer positionele trefwoorden toevoegen, zodat we suggesties kunnen geven op basis van deze sleutelwoorden.

--subscription

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

az apim api operation update

Werkt de details bij van de bewerking in de API die is opgegeven door 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]
                             [--subscription]
                             [--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 API Management service-exemplaar. Niet-huidige revisie heeft ;rev=n als achtervoegsel, waarbij n het revisienummer is.

--operation-id

Bewerkings-id binnen een API. Moet uniek zijn in het huidige API Management service-exemplaar.

--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 of JSON string>.

--description

Beschrijving van de bewerking. Kan HTML-opmaaktags bevatten.

--display-name

Vereist. Bewerkingsnaam.

--force-string

Wanneer u 'set' of 'add' gebruikt, moet u letterlijke tekenreeksen bewaren in plaats van te proberen te converteren naar JSON.

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

Verwijder een eigenschap of een element uit een lijst. Voorbeeld: --remove property.list OR --remove propertyToRemove.

--set

Werk een object bij door een eigenschapspad en waarde op te geven die moeten worden ingesteld. Voorbeeld: --set property1.property2=.

--subscription

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

--url-template

Relatieve URL-sjabloon die de doelresource voor deze bewerking identificeert. Kan parameters bevatten.