az apim api

Azure API Management API's beheren.

Opdracht

az apim api create

Maak een API Management-API.

az apim api delete

Verwijder een API Management-API.

az apim api import

Importeer een API Management-API.

az apim api list

Lijst API Management API's.

az apim api operation

Azure API Management API-bewerkingen beheren.

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 release

Azure API Management API-release beheren.

az apim api release create

Hiermee maakt u een nieuwe release voor de API.

az apim api release delete

Hiermee verwijdert u de opgegeven release in de API.

az apim api release list

Een lijst met alle releases van een API.

az apim api release show

Retourneert de details van een API-release.

az apim api release update

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

az apim api revision

Azure API Management API-revisie beheren.

az apim api revision create

API-revisie maken.

az apim api revision list

Een lijst met alle revisies van een API.

az apim api show

Details van een API Management API.

az apim api update

Werk een API Management API bij.

az apim api versionset

Azure API Management API-versieset beheren.

az apim api versionset create

Hiermee maakt u een API-versieset.

az apim api versionset delete

Hiermee verwijdert u een specifieke API-versieset.

az apim api versionset list

Hiermee wordt een verzameling API-versiesets in het opgegeven service-exemplaar vermeld.

az apim api versionset show

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

az apim api versionset update

Werkt de details bij van de API-versieset die is opgegeven door de id.

az apim api wait

Plaats de CLI in een wachttoestand totdat aan een voorwaarde van een APIM-API wordt voldaan.

az apim api create

Maak een API Management-API.

az apim api create --api-id
                   --display-name
                   --path
                   --resource-group
                   --service-name
                   [--api-type {http, soap}]
                   [--authorization-scope]
                   [--authorization-server-id]
                   [--bearer-token-sending-methods]
                   [--description]
                   [--no-wait]
                   [--open-id-provider-id]
                   [--protocols {http, https}]
                   [--service-url]
                   [--subscription]
                   [--subscription-key-header-name]
                   [--subscription-key-query-param-name]
                   [--subscription-key-required]
                   [--subscription-required {false, true}]

Voorbeelden

Een basis-API maken.

az apim api create --service-name MyApim -g MyResourceGroup --api-id MyApi --path '/myapi' --display-name 'My API'

Vereiste parameters

--api-id

De unieke naam van de API die moet worden gemaakt.

--display-name

Weergavenaam van de API die moet worden gemaakt.

--path

Pad naar de API.

--resource-group -g

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

--service-name -n

De naam van het API Management service-exemplaar.

Optionele parameters

--api-type

Het type API.

geaccepteerde waarden: http, soap
--authorization-scope

Hiermee geeft u het bereik van OAuth-bewerkingen.

--authorization-server-id

Hiermee geeft u de OAuth-autorisatieserver-id op.

--bearer-token-sending-methods

Hiermee geeft u de verzendende methoden voor bearer-token.

--description

Beschrijving van de API. Kan HTML-opmaaktags bevatten.

--no-wait

Wacht niet tot de langlopende bewerking is uitgevoerd.

--open-id-provider-id

Hiermee geeft u de openid in de verificatie-instelling.

--protocols

Beschrijft op welke protocollen de bewerkingen in deze API kunnen worden aangeroepen.

geaccepteerde waarden: http, https
--service-url

Absolute URL van de back-endservice die deze API implementeert. Mag niet langer zijn dan 2000 tekens.

--subscription

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

--subscription-key-header-name

Hiermee geeft u de naam van de header van de abonnementssleutel op.

--subscription-key-query-param-name

Hiermee geeft u de naam van de queryreeks van de abonnementssleutel op.

--subscription-key-required

Hiermee geeft u op of de abonnementssleutel is vereist tijdens het aanroepen van deze API, waar - API is alleen opgenomen in gesloten producten, onwaar - API is alleen opgenomen in open producten, null - er is een combinatie van producten.

--subscription-required

Indien waar, vereist de API een abonnementssleutel voor aanvragen.

geaccepteerde waarden: false, true

az apim api delete

Verwijder een API Management-API.

az apim api delete --api-id
                   --resource-group
                   --service-name
                   [--delete-revisions]
                   [--if-match]
                   [--no-wait]
                   [--subscription]
                   [--yes]

Vereiste parameters

--api-id

API-revisie-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 az configure --defaults group=<name> behulp van .

--service-name -n

De naam van het API Management service-exemplaar.

Optionele parameters

--delete-revisions

Verwijder alle revisies van de API.

--if-match

ETag van de entiteit.

--no-wait

Wacht niet tot de langlopende bewerking is uitgevoerd.

--subscription

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

--yes -y

Niet vragen om bevestiging.

az apim api import

Importeer een API Management-API.

az apim api import --path
                   --resource-group
                   --service-name
                   --specification-format {OpenApi, OpenApiJson, Swagger, Wadl, Wsdl}
                   [--api-id]
                   [--api-revision]
                   [--api-type {http, soap}]
                   [--api-version]
                   [--api-version-set-id]
                   [--description]
                   [--display-name]
                   [--no-wait]
                   [--protocols {http, https}]
                   [--service-url]
                   [--soap-api-type]
                   [--specification-path]
                   [--specification-url]
                   [--subscription]
                   [--subscription-key-header-name]
                   [--subscription-key-query-param-name]
                   [--subscription-required {false, true}]
                   [--wsdl-endpoint-name]
                   [--wsdl-service-name]

Voorbeelden

Een API Management-API importeren uit een bestand of een URL

az apim api import -g MyResourceGroup --service-name MyApim --path MyApi --specification-url https://MySpecificationURL --specification-format OpenApiJson

Vereiste parameters

--path

Vereist. Relatieve URL die deze API en alle resourcepaden binnen het service API Management service-exemplaar uniek identificeert.

--resource-group -g

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

--service-name -n

De naam van het service-exemplaar van API Management.

--specification-format

Geef de indeling van de geïmporteerde API op.

geaccepteerde waarden: OpenApi, OpenApiJson, Swagger, Wadl, Wsdl

Optionele parameters

--api-id

API-revisie-id. Moet uniek zijn in het huidige API Management service-exemplaar. Niet-huidige revisie heeft ;rev=n als achtervoegsel waarbij n het revisienummer is.

--api-revision

Beschrijft de revisie van de API. Als er geen waarde is opgegeven, wordt standaard revisie 1 gemaakt.

--api-type

Het type API.

geaccepteerde waarden: http, soap
--api-version

Beschrijft de versie van de API. Als u een versie toevoegt aan een API zonder versie, wordt automatisch een oorspronkelijke versie gemaakt die reageert op de standaard-URL.

--api-version-set-id

Beschrijft de versieset die moet worden gebruikt met de API.

--description

Beschrijving van de API. Kan HTML-opmaaktags bevatten.

--display-name

Weergavenaam van deze API.

--no-wait

Wacht niet tot de langlopende bewerking is uitgevoerd.

--protocols

Beschrijft op welke protocollen (een of meer) de bewerkingen in deze API kunnen worden aangeroepen.

geaccepteerde waarden: http, https
--service-url

Absolute URL van de back-endservice die deze API implementeert. Mag niet langer zijn dan 2000 tekens.

--soap-api-type

Het type API wanneer de bestandsindeling WSDL is.

--specification-path

Bestandspad dat is opgegeven om de API te importeren.

--specification-url

URL die is opgegeven om de API te importeren.

--subscription

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

--subscription-key-header-name

Hiermee geeft u de naam van de header van de abonnementssleutel op.

--subscription-key-query-param-name

Hiermee geeft u de naam van de queryreeks van de abonnementssleutel op.

--subscription-required

Indien waar, vereist de API een abonnementssleutel voor aanvragen.

geaccepteerde waarden: false, true
--wsdl-endpoint-name

Lokale naam van het WSDL-eindpunt (poort) dat moet worden geïmporteerd.

--wsdl-service-name

Lokale naam van de WSDL-service die moet worden geïmporteerd.

az apim api list

Lijst API Management API's.

az apim api list --resource-group
                 --service-name
                 [--filter-display-name]
                 [--query-examples]
                 [--skip]
                 [--subscription]
                 [--top]

Vereiste parameters

--resource-group -g

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

--service-name -n

De naam van het API Management service-exemplaar.

Optionele parameters

--filter-display-name

Filter api's op displayName.

--query-examples

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

--skip

Aantal records dat moet worden overgeslagen.

--subscription

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

--top

Het aantal te retourneren records.

az apim api show

Details van een API Management API.

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

Vereiste parameters

--api-id

API-revisie-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 az configure --defaults group=<name> behulp van .

--service-name

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 deze na de parameter --query tussen dubbele aanhalingstekens plakken 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 behulp van az account set -s NAME_OR_ID .

az apim api update

Werk een API Management API bij.

az apim api update --api-id
                   --resource-group
                   --service-name
                   [--add]
                   [--api-type {http, soap}]
                   [--description]
                   [--display-name]
                   [--force-string]
                   [--if-match]
                   [--no-wait]
                   [--path]
                   [--protocols {http, https}]
                   [--remove]
                   [--service-url]
                   [--set]
                   [--subscription]
                   [--subscription-key-header-name]
                   [--subscription-key-query-param-name]
                   [--subscription-required {false, true}]
                   [--tags]

Voorbeelden

Maak een eenvoudige API.

az apim api update --service-name MyApim -g MyResourceGroup --api-id MyApi --description foo

Vereiste parameters

--api-id

De unieke naam van de API die moet worden gemaakt.

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

--api-type

Het type API.

geaccepteerde waarden: http, soap
--description

Beschrijving van de API. Kan HTML-opmaaktags bevatten.

--display-name

API-naam. Moet 1 tot 300 tekens lang zijn.

--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. Niet vereist bij het maken van een entiteit, maar vereist bij het bijwerken van een entiteit.

--no-wait

Wacht niet tot de langlopende bewerking is uitgevoerd.

--path

Vereist. Relatieve URL die deze API en alle resourcepaden binnen het service API Management service-exemplaar uniek identificeert.

--protocols

Beschrijft op welke protocollen de bewerkingen in deze API kunnen worden aangeroepen.

geaccepteerde waarden: http, https
--remove

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

--service-url

Absolute URL van de back-endservice die deze API implementeert. Mag niet langer zijn dan 2000 tekens.

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

--subscription-key-header-name

Hiermee geeft u de naam van de header van de abonnementssleutel op.

--subscription-key-query-param-name

Hiermee geeft u de naam van de tekenreeksparameter van de abonnementssleutel op.

--subscription-required

Indien waar, vereist de API een abonnementssleutel voor aanvragen.

geaccepteerde waarden: false, true
--tags

Door ruimte gescheiden tags: sleutel[=waarde] [sleutel[=waarde] ...]. Gebruik '' om bestaande tags te verwijderen.

az apim api wait

Plaats de CLI in een wachttoestand totdat aan een voorwaarde van een APIM-API wordt voldaan.

az apim api wait --api-id
                 --name
                 --resource-group
                 [--created]
                 [--custom]
                 [--deleted]
                 [--exists]
                 [--interval]
                 [--subscription]
                 [--timeout]
                 [--updated]

Voorbeelden

Plaats de CLI in een wachttoestand totdat aan een voorwaarde van een APIM-API wordt voldaan. (automatisch gegenereerd)

az apim api wait --created --api-id MyApi --name MyApim --resource-group MyResourceGroup

Vereiste parameters

--api-id

API-revisie-id. Moet uniek zijn in het huidige API Management service-exemplaar. Niet-huidige revisie heeft ;rev=n als achtervoegsel, waarbij n het revisienummer is.

--name -n

De naam van het service-exemplaar van API Management.

--resource-group -g

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

Optionele parameters

--created

Wacht tot u met provisioningState bij Succeeded hebt gemaakt.

--custom

Wacht totdat de voorwaarde voldoet aan een aangepaste JMESPath-query. Bijvoorbeeld provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wacht tot u deze hebt verwijderd.

--exists

Wacht totdat de resource bestaat.

--interval

Pollinginterval in seconden.

standaardwaarde: 30
--subscription

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

--timeout

Maximale wachttijd in seconden.

standaardwaarde: 3600
--updated

Wacht tot provisioningState is bijgewerkt bij Succeeded.