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
De unieke naam van de API die moet worden gemaakt.
Weergavenaam van de API die moet worden gemaakt.
Pad naar de API.
De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .
De naam van het API Management service-exemplaar.
Optionele parameters
Het type API.
Hiermee geeft u het bereik van OAuth-bewerkingen.
Hiermee geeft u de OAuth-autorisatieserver-id op.
Hiermee geeft u de verzendende methoden voor bearer-token.
Beschrijving van de API. Kan HTML-opmaaktags bevatten.
Wacht niet tot de langlopende bewerking is uitgevoerd.
Hiermee geeft u de openid in de verificatie-instelling.
Beschrijft op welke protocollen de bewerkingen in deze API kunnen worden aangeroepen.
Absolute URL van de back-endservice die deze API implementeert. Mag niet langer zijn dan 2000 tekens.
Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID .
Hiermee geeft u de naam van de header van de abonnementssleutel op.
Hiermee geeft u de naam van de queryreeks van de abonnementssleutel op.
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.
Indien waar, vereist de API een abonnementssleutel voor aanvragen.
Vergroot de logboekregistratie om alle logboeken voor foutopsporing weer te geven.
Laat dit Help-bericht zien en sluit af.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Vergroot de logboekregistratie. Gebruik --debug voor volledige logboeken voor foutopsporing.
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-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.
De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .
De naam van het API Management service-exemplaar.
Optionele parameters
Verwijder alle revisies van de API.
ETag van de entiteit.
Wacht niet tot de langlopende bewerking is uitgevoerd.
Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID .
Niet vragen om bevestiging.
Vergroot de logboekregistratie om alle logboeken voor foutopsporing weer te geven.
Laat dit Help-bericht zien en sluit af.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Vergroot de logboekregistratie. Gebruik --debug voor volledige logboeken voor foutopsporing.
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
Vereist. Relatieve URL die deze API en alle resourcepaden binnen het service API Management service-exemplaar uniek identificeert.
De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .
De naam van het service-exemplaar van API Management.
Geef de indeling van de geïmporteerde API op.
Optionele parameters
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.
Beschrijft de revisie van de API. Als er geen waarde is opgegeven, wordt standaard revisie 1 gemaakt.
Het type API.
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.
Beschrijft de versieset die moet worden gebruikt met de API.
Beschrijving van de API. Kan HTML-opmaaktags bevatten.
Weergavenaam van deze API.
Wacht niet tot de langlopende bewerking is uitgevoerd.
Beschrijft op welke protocollen (een of meer) de bewerkingen in deze API kunnen worden aangeroepen.
Absolute URL van de back-endservice die deze API implementeert. Mag niet langer zijn dan 2000 tekens.
Het type API wanneer de bestandsindeling WSDL is.
Bestandspad dat is opgegeven om de API te importeren.
URL die is opgegeven om de API te importeren.
Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID .
Hiermee geeft u de naam van de header van de abonnementssleutel op.
Hiermee geeft u de naam van de queryreeks van de abonnementssleutel op.
Indien waar, vereist de API een abonnementssleutel voor aanvragen.
Lokale naam van het WSDL-eindpunt (poort) dat moet worden geïmporteerd.
Lokale naam van de WSDL-service die moet worden geïmporteerd.
Vergroot de logboekregistratie om alle logboeken voor foutopsporing weer te geven.
Laat dit Help-bericht zien en sluit af.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Vergroot de logboekregistratie. Gebruik --debug voor volledige logboeken voor foutopsporing.
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
De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .
De naam van het API Management service-exemplaar.
Optionele parameters
Filter api's op displayName.
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.
Aantal records dat moet worden overgeslagen.
Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID .
Het aantal te retourneren records.
Vergroot de logboekregistratie om alle logboeken voor foutopsporing weer te geven.
Laat dit Help-bericht zien en sluit af.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Vergroot de logboekregistratie. Gebruik --debug voor volledige logboeken voor foutopsporing.
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-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.
De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .
De naam van het API Management service-exemplaar.
Optionele parameters
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.
Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID .
Vergroot de logboekregistratie om alle logboeken voor foutopsporing weer te geven.
Laat dit Help-bericht zien en sluit af.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Vergroot de logboekregistratie. Gebruik --debug voor volledige logboeken voor foutopsporing.
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
De unieke naam van de API die moet worden gemaakt.
De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name> .
De naam van het API Management service-exemplaar.
Optionele parameters
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>.
Het type API.
Beschrijving van de API. Kan HTML-opmaaktags bevatten.
API-naam. Moet 1 tot 300 tekens lang zijn.
Wanneer u 'set' of 'add' gebruikt, moet u letterlijke tekenreeksen bewaren in plaats van te proberen te converteren naar JSON.
ETag van de entiteit. Niet vereist bij het maken van een entiteit, maar vereist bij het bijwerken van een entiteit.
Wacht niet tot de langlopende bewerking is uitgevoerd.
Vereist. Relatieve URL die deze API en alle resourcepaden binnen het service API Management service-exemplaar uniek identificeert.
Beschrijft op welke protocollen de bewerkingen in deze API kunnen worden aangeroepen.
Verwijder een eigenschap of een element uit een lijst. Voorbeeld: --remove property.list OR --remove propertyToRemove.
Absolute URL van de back-endservice die deze API implementeert. Mag niet langer zijn dan 2000 tekens.
Werk een object bij door een eigenschapspad en waarde op te geven die moeten worden ingesteld. Voorbeeld: --set property1.property2=.
Naam of id van het abonnement. U kunt het standaardabonnement configureren met az account set -s NAME_OR_ID behulp van .
Hiermee geeft u de naam van de header van de abonnementssleutel op.
Hiermee geeft u de naam van de tekenreeksparameter van de abonnementssleutel op.
Indien waar, vereist de API een abonnementssleutel voor aanvragen.
Door ruimte gescheiden tags: sleutel[=waarde] [sleutel[=waarde] ...]. Gebruik '' om bestaande tags te verwijderen.
Vergroot de logboekregistratie om alle logboeken voor foutopsporing weer te geven.
Laat dit Help-bericht zien en sluit af.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Vergroot de logboekregistratie. Gebruik --debug voor volledige logboeken voor foutopsporing.
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-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.
De naam van het service-exemplaar van API Management.
De naam van de resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name> .
Optionele parameters
Wacht tot u met provisioningState bij Succeeded hebt gemaakt.
Wacht totdat de voorwaarde voldoet aan een aangepaste JMESPath-query. Bijvoorbeeld provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wacht tot u deze hebt verwijderd.
Wacht totdat de resource bestaat.
Pollinginterval in seconden.
Naam of id van het abonnement. U kunt het standaardabonnement configureren met az account set -s NAME_OR_ID behulp van .
Maximale wachttijd in seconden.
Wacht tot provisioningState is bijgewerkt bij Succeeded.
Vergroot de logboekregistratie om alle logboeken voor foutopsporing weer te geven.
Laat dit Help-bericht zien en sluit af.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Vergroot de logboekregistratie. Gebruik --debug voor volledige logboeken voor foutopsporing.