az apim api

  • Referentie

Azure API Management-API's beheren.

Opdracht

Name Description Type Status
az apim api create

Maak een API Management-API.

 Basis GA
az apim api delete

Een API Management-API verwijderen.

 Basis GA
az apim api export

Een API Management-API exporteren.

 Basis GA
az apim api import

Importeer een API Management-API.

 Basis GA
az apim api list

Lijst met API Management-API's.

 Basis GA
az apim api operation

Azure API Management API-bewerkingen beheren.

 Basis GA
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 release

Azure API Management API-release beheren.

 Basis GA
az apim api release create

Hiermee maakt u een nieuwe release voor de API.

 Basis GA
az apim api release delete

Hiermee verwijdert u de opgegeven release in de API.

 Basis GA
az apim api release list

Een lijst met alle releases van een API.

 Basis GA
az apim api release show

Retourneert de details van een API-release.

 Basis GA
az apim api release update

Hiermee worden de details bijgewerkt van de release van de API die is opgegeven door de id.

 Basis GA
az apim api revision

Azure API Management-API-revisie beheren.

 Basis GA
az apim api revision create

Api-revisie maken.

 Basis GA
az apim api revision list

Geeft een overzicht van alle revisies van een API.

 Basis GA
az apim api schema

Azure API Management API-schema's beheren.

 Basis GA
az apim api schema create

Maak een API Management API-schema.

 Basis GA
az apim api schema delete

Een API Management API-schema verwijderen.

 Basis GA
az apim api schema get-etag

Haal een etag op van een API Management API-schema.

 Basis GA
az apim api schema list

Api Management API-schema's vermelden.

 Basis GA
az apim api schema show

Details van een API Management API-schema weergeven.

 Basis GA
az apim api schema wait

Plaats de CLI in een wachtstatus totdat aan een voorwaarde van een APIM API-schema is voldaan.

 Basis GA
az apim api show

Details van een API Management-API weergeven.

 Basis GA
az apim api update

Een API Management-API bijwerken.

 Basis GA
az apim api versionset

Azure API Management API-versieset beheren.

 Basis GA
az apim api versionset create

Hiermee maakt u een API-versieset.

 Basis GA
az apim api versionset delete

Hiermee verwijdert u specifieke API-versieset.

 Basis GA
az apim api versionset list

Geeft een verzameling API-versiesets weer in het opgegeven service-exemplaar.

 Basis GA
az apim api versionset show

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

 Basis GA
az apim api versionset update

Hiermee worden de details bijgewerkt van de Api VersionSet die is opgegeven door de id.

 Basis GA
az apim api wait

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

 Basis GA

az apim api create

Bewerken

Maak een API Management-API.

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

Voorbeelden

Maak een eenvoudige API.

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

Vereiste parameters

--api-id

Unieke naam van de API die moet worden gemaakt.

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

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

--service-name -n

De naam van het API Management-service-exemplaar.

Optionele parameters

--api-type

Het type API.

geaccepteerde waarden: graphql, http, soap, websocket
--authorization-scope

Hiermee geeft u het OAuth-bewerkingsbereik.

--authorization-server-id

Hiermee geeft u de OAuth-autorisatieserver-id.

--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 totdat de langdurige bewerking is voltooid.

standaardwaarde: False
--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, ws, wss
--service-url

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

--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 queryreeksparameter voor 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 opgenomen in alleen geopende producten, null - er is een combinatie van producten.

--subscription-required

Indien waar, vereist de API een abonnementssleutel voor aanvragen.

geaccepteerde waarden: false, true
standaardwaarde: False
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 delete

Bewerken

Een API Management-API verwijderen.

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

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.

Optionele parameters

--delete-revisions

Verwijder alle revisies van de API.

--if-match

ETag van de entiteit.

--no-wait

Wacht niet totdat de langdurige bewerking is voltooid.

standaardwaarde: False
--yes -y

Niet vragen om bevestiging.

standaardwaarde: False
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 export

Bewerken

Een API Management-API exporteren.

az apim api export --api-id
                   --ef {OpenApiJsonFile, OpenApiJsonUrl, OpenApiYamlFile, OpenApiYamlUrl, SwaggerFile, SwaggerUrl, WadlFile, WadlUrl, WsdlFile, WsdlUrl}
                   --resource-group
                   --service-name
                   [--file-path]

Voorbeelden

Exporteer een API Management-API naar een bestand of retourneert een antwoord met een koppeling naar de export.

az apim api export -g MyResourceGroup --service-name MyApim --api-id MyApi --export-format OpenApiJson --file-path path

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. Regex-patroon: ^[^*#&+:<>?] +$.

--ef --export-format

Geef de indeling van de export-API op.

geaccepteerde waarden: OpenApiJsonFile, OpenApiJsonUrl, OpenApiYamlFile, OpenApiYamlUrl, SwaggerFile, SwaggerUrl, WadlFile, WadlUrl, WsdlFile, WsdlUrl
--resource-group -g

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

--service-name -n

De naam van het api management-service-exemplaar.

Optionele parameters

--file-path -f

Het opgegeven bestandspad voor het exporteren van de API.

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 import

Bewerken

Importeer een API Management-API.

az apim api import --path
                   --resource-group
                   --service-name
                   --specification-format {GraphQL, OpenApi, OpenApiJson, Swagger, Wadl, Wsdl}
                   [--api-id]
                   [--api-revision]
                   [--api-type {graphql, http, soap, websocket}]
                   [--api-version]
                   [--api-version-set-id]
                   [--description]
                   [--display-name]
                   [--no-wait]
                   [--protocols {http, https, ws, wss}]
                   [--service-url]
                   [--soap-api-type]
                   [--specification-path]
                   [--specification-url]
                   [--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 bijbehorende resourcepaden uniek identificeert binnen het 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.

--specification-format

Geef de indeling van de geïmporteerde API op.

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

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

--api-revision

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

--api-type

Het type API.

geaccepteerde waarden: graphql, http, soap, websocket
--api-version

Beschrijft de versie van de API. Als u een versie toevoegt aan een niet-geversiede API, wordt er automatisch een oorspronkelijke versie gemaakt en wordt er gereageerd 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 totdat de langdurige bewerking is voltooid.

standaardwaarde: False
--protocols

Hierin wordt beschreven welke protocollen (een of meer) de bewerkingen in deze API kunnen worden aangeroepen.

geaccepteerde waarden: http, https, ws, wss
--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

Het opgegeven bestandspad voor het importeren van de API.

--specification-url

De URL die is opgegeven om de API te importeren.

--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 queryreeksparameter voor de abonnementssleutel op.

--subscription-required

Indien waar, vereist de API een abonnementssleutel voor aanvragen.

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

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

--wsdl-service-name

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

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 list

Bewerken

Lijst met API Management-API's.

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

Vereiste parameters

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

--filter-display-name

Filter van API's op displayName.

--skip

Het aantal records dat moet worden overgeslagen.

--top

Het aantal te retourneren records.

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 show

Bewerken

Details van een API Management-API weergeven.

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

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

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 update

Bewerken

Een API Management-API bijwerken.

az apim api update --api-id
                   --resource-group
                   --service-name
                   [--add]
                   [--api-type {graphql, http, soap, websocket}]
                   [--description]
                   [--display-name]
                   [--force-string]
                   [--if-match]
                   [--no-wait]
                   [--path]
                   [--protocols {http, https, ws, wss}]
                   [--remove]
                   [--service-url]
                   [--set]
                   [--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

Unieke naam van de API die moet worden gemaakt.

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

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: []
--api-type

Het type API.

geaccepteerde waarden: graphql, http, soap, websocket
--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 'toevoegen' gebruikt, behoudt u letterlijke tekenreeksen in plaats van te converteren naar JSON.

standaardwaarde: False
--if-match

ETag van de entiteit. Niet vereist bij het maken van een entiteit, maar vereist bij het bijwerken van een entiteit. De standaardwaarde is Geen.

--no-wait

Wacht niet totdat de langdurige bewerking is voltooid.

standaardwaarde: False
--path

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

--protocols

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

geaccepteerde waarden: http, https, ws, wss
--remove

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

standaardwaarde: []
--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 u wilt instellen. Voorbeeld: --set property1.property2=<value>.

standaardwaarde: []
--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 queryreeksparameter voor de abonnementssleutel op.

--subscription-required

Indien waar, vereist de API een abonnementssleutel voor aanvragen.

geaccepteerde waarden: false, true
--tags

Door spaties gescheiden tags: key[=value] [key[=value] ...]. Gebruik '' om bestaande tags te wissen.

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 wait

Bewerken

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

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

Voorbeelden

Plaats de CLI in een wachtstatus totdat aan een voorwaarde van een APIM-API is 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 EXEMPLAAR van de API Management-service. Niet-huidige herziening heeft ; rev=n als achtervoegsel waarbij n het revisienummer is. Vereist.

--name -n

De naam van het 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>.

Optionele parameters

--created

Wacht totdat u 'provisioningState' hebt gemaakt bij 'Succeeded'.

standaardwaarde: False
--custom

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

--deleted

Wacht totdat deze is verwijderd.

standaardwaarde: False
--exists

Wacht tot de resource bestaat.

standaardwaarde: False
--interval

Polling-interval in seconden.

standaardwaarde: 30
--timeout

Maximale wachttijd in seconden.

standaardwaarde: 3600
--updated

Wacht totdat deze is bijgewerkt met provisioningState op 'Succeeded'.

standaardwaarde: False
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.