az apim

Azure API Management beheren.

Opdracht

az apim api

Azure API Management API's beheren.

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 apply-network-updates

Een back-up API Management service naar het geconfigureerde opslagaccount.

az apim backup

Hiermee maakt u een back-up van de API Management service naar het opgegeven Azure Storage-account. Dit is een langdurige bewerking die enkele minuten kan duren.

az apim check-name

Controleert of er een servicenaam beschikbaar is voor gebruik.

az apim create

Maak een API Management service-exemplaar.

az apim delete

Hiermee verwijdert u API Management service.

az apim list

Lijst API Management service-exemplaren.

az apim nv

Azure-API Management benoemde waarden beheren.

az apim nv create

Maak een API Management benoemde waarde.

az apim nv delete

Verwijder een API Management benoemde waarde.

az apim nv list

Lijst API Management benoemde waarden.

az apim nv show

Details van een API Management waarde.

az apim nv show-secret

Haalt het geheim van een API Management benoemde waarde.

az apim nv update

Werk een API Management benoemde waarde bij.

az apim product

Azure API Management Product's beheren.

az apim product api

De API'API Management van Azure API Management product beheren.

az apim product api add

Voeg een API toe aan het opgegeven product.

az apim product api check

Controleert of de API-entiteit die is opgegeven door id, is gekoppeld aan de entiteit Product.

az apim product api delete

Hiermee verwijdert u de opgegeven API uit het opgegeven product.

az apim product api list

Geeft een verzameling van de API's weer die aan een product zijn gekoppeld.

az apim product create

Hiermee maakt u een product.

az apim product delete

Product verwijderen.

az apim product list

Een lijst met een verzameling producten in het opgegeven service-exemplaar.

az apim product show

Hiermee haalt u de details op van het product dat is opgegeven door de id.

az apim product update

Bestaande productdetails bijwerken.

az apim product wait

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

az apim restore

Herstelt een back-up van API Management service die is gemaakt met behulp ApiManagementService_Backup bewerking voor de huidige service. Dit is een langdurige bewerking die enkele minuten kan duren.

az apim show

Details van een API Management service-exemplaar.

az apim update

Werk een API Management service-exemplaar bij.

az apim wait

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

az apim apply-network-updates

Een back-up API Management service naar het geconfigureerde opslagaccount.

az apim apply-network-updates --name
                              --resource-group
                              [--location]
                              [--no-wait]
                              [--subscription]

Vereiste parameters

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

--location -l

Locatie. Waarden van: az account list-locations . U kunt de standaardlocatie configureren met az configure --defaults location=<location> behulp van .

--no-wait

Wacht niet tot de langlopende bewerking is uitgevoerd.

--subscription

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

az apim backup

Hiermee maakt u een back-up van de API Management service naar het opgegeven Azure Storage-account. Dit is een langdurige bewerking die enkele minuten kan duren.

az apim backup --backup-name
               --container-name
               --name
               --resource-group
               --storage-account-key
               --storage-account-name
               [--no-wait]
               [--subscription]

Voorbeelden

Een back-up maken van API Management service-exemplaar

az apim backup --name MyApim -g MyResourceGroup --backup-name myBackup              --storage-account-name mystorageaccount --storage-account-container backups              --storage-account-key Ay2ZbdxLnD4OJPT29F6jLPkB6KynOzx85YCObhrw==

Vereiste parameters

--backup-name

De naam van het back-upbestand dat moet worden gemaakt.

--container-name --storage-account-container

De naam van de opslagaccountcontainer die wordt gebruikt om de back-up te plaatsen.

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

--storage-account-key

De toegangssleutel van het opslagaccount dat wordt gebruikt om de back-up te plaatsen.

--storage-account-name

De naam van het opslagaccount dat wordt gebruikt om de back-up te plaatsen.

Optionele parameters

--no-wait

Wacht niet tot de langlopende bewerking is uitgevoerd.

--subscription

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

az apim check-name

Controleert of er een servicenaam beschikbaar is voor gebruik.

az apim check-name --name
                   [--subscription]

Vereiste parameters

--name -n

De naam van het service-exemplaar van API Management.

Optionele parameters

--subscription

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

az apim create

Maak een API Management service-exemplaar.

az apim create --name
               --publisher-email
               --publisher-name
               --resource-group
               [--enable-client-certificate {false, true}]
               [--enable-managed-identity {false, true}]
               [--location]
               [--no-wait]
               [--sku-capacity]
               [--sku-name {Basic, Consumption, Developer, Premium, Standard}]
               [--subscription]
               [--tags]
               [--virtual-network {External, Internal, None}]

Voorbeelden

Maak een developer-laag API Management service.

az apim create --name MyApim -g MyResourceGroup -l eastus --publisher-email email@mydomain.com --publisher-name Microsoft

Maak een verbruikslaag API Management service.

az apim create --name MyApim -g MyResourceGroup -l eastus --sku-name Consumption --enable-client-certificate \
    --publisher-email email@mydomain.com --publisher-name Microsoft

Vereiste parameters

--name -n

De unieke naam van het service-exemplaar dat moet worden gemaakt.

--publisher-email

Het e-mailadres voor het ontvangen van alle systeemmeldingen.

--publisher-name

De naam van uw organisatie voor gebruik in de ontwikkelaarsportal en e-mailmeldingen.

--resource-group -g

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

Optionele parameters

--enable-client-certificate

Hiermee wordt afgedwongen dat bij elke aanvraag een clientcertificaat wordt gepresenteerd aan de gateway en kan het certificaat ook worden geverifieerd in het beleid op de gateway.

geaccepteerde waarden: false, true
--enable-managed-identity

Maak een beheerde identiteit voor de API Management service voor toegang tot andere Azure-resources.

geaccepteerde waarden: false, true
--location -l

Locatie. Waarden van: az account list-locations . U kunt de standaardlocatie configureren met az configure --defaults location=<location> behulp van .

--no-wait

Wacht niet tot de langlopende bewerking is uitgevoerd.

--sku-capacity

Het aantal geïmplementeerde eenheden van de SKU.

standaardwaarde: 1
--sku-name

De SKU van het API Management-exemplaar.

geaccepteerde waarden: Basic, Consumption, Developer, Premium, Standard
standaardwaarde: Developer
--subscription

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

--tags

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

--virtual-network -v

Het type virtueel netwerk.

geaccepteerde waarden: External, Internal, None
standaardwaarde: None

az apim delete

Hiermee verwijdert u API Management service.

az apim delete --name
               --resource-group
               [--no-wait]
               [--subscription]
               [--yes]

Voorbeelden

Verwijder een API Management service.

az apim delete -n MyApim -g MyResourceGroup

Vereiste parameters

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

--no-wait

Wacht niet tot de langlopende bewerking is uitgevoerd.

--subscription

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

--yes -y

Niet vragen om bevestiging.

az apim list

Lijst API Management service-exemplaren.

az apim list [--query-examples]
             [--resource-group]
             [--subscription]

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.

--resource-group -g

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

--subscription

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

az apim restore

Herstelt een back-up van API Management service die is gemaakt met behulp ApiManagementService_Backup bewerking voor de huidige service. Dit is een langdurige bewerking die enkele minuten kan duren.

az apim restore --backup-name
                --container-name
                --name
                --resource-group
                --storage-account-key
                --storage-account-name
                [--no-wait]
                [--subscription]

Voorbeelden

Herstelt een back-up van API Management service-exemplaar

az apim restore --name MyApim -g MyResourceGroup --backup-name myBackup              --storage-account-name mystorageaccount --storage-account-container backups              --storage-account-key Ay2ZbdxLnD4OJPT29F6jLPkB6KynOzx85YCObhrw==

Vereiste parameters

--backup-name

De naam van het back-upbestand dat moet worden hersteld.

--container-name --storage-account-container

De naam van de opslagaccountcontainer waar de back-up van wordt opgehaald.

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

--storage-account-key

De toegangssleutel van het opslagaccount waar de back-up van wordt opgehaald.

--storage-account-name

De naam van het opslagaccount waar de back-up van is opgehaald.

Optionele parameters

--no-wait

Wacht niet tot de langlopende bewerking is uitgevoerd.

--subscription

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

az apim show

Details van een API Management service-exemplaar.

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

Vereiste parameters

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

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

Werk een API Management service-exemplaar bij.

az apim update --name
               --resource-group
               [--add]
               [--enable-client-certificate {false, true}]
               [--enable-managed-identity {false, true}]
               [--force-string]
               [--no-wait]
               [--publisher-email]
               [--publisher-name]
               [--remove]
               [--set]
               [--sku-capacity]
               [--sku-name {Basic, Consumption, Developer, Premium, Standard}]
               [--subscription]
               [--tags]
               [--virtual-network {External, Internal, None}]

Vereiste parameters

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

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

--enable-client-certificate

Hiermee wordt afgedwongen dat bij elke aanvraag een clientcertificaat wordt gepresenteerd aan de gateway en kan het certificaat ook worden geverifieerd in het beleid op de gateway.

geaccepteerde waarden: false, true
--enable-managed-identity

Maak een beheerde identiteit voor de API Management service voor toegang tot andere Azure-resources.

geaccepteerde waarden: false, true
--force-string

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

--no-wait

Wacht niet tot de langlopende bewerking is uitgevoerd.

--publisher-email

Het e-mailadres voor het ontvangen van alle systeemmeldingen.

--publisher-name

De naam van uw organisatie voor gebruik in de ontwikkelaarsportal en e-mailmeldingen.

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

--sku-capacity

Het aantal geïmplementeerde eenheden van de SKU.

--sku-name

De SKU van het API Management-exemplaar.

geaccepteerde waarden: Basic, Consumption, Developer, Premium, Standard
--subscription

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

--tags

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

--virtual-network -v

Het type virtueel netwerk.

geaccepteerde waarden: External, Internal, None

az apim wait

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

az apim wait --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 wordt voldaan. (automatisch gegenereerd)

az apim wait --created --name MyApim --resource-group MyResourceGroup

Vereiste parameters

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

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