Delen via

az apim

  • Referentie

Azure API Management-services beheren.

Opdracht

Name Description Type Status
az apim api

Azure API Management-API's beheren.

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

Werk de API Management-resource bij die wordt uitgevoerd in het virtuele netwerk om de bijgewerkte netwerkinstellingen te kiezen.

 Basis GA
az apim backup

Hiermee maakt u een back-up van de API Management-service naar het opgegeven Azure Storage-account. Dit duurt lang en kan enkele minuten duren.

 Basis GA
az apim check-name

Controleert of er een servicenaam beschikbaar is voor gebruik.

 Basis GA
az apim create

Maak een API Management-service-exemplaar.

 Basis GA
az apim delete

Hiermee verwijdert u een API Management-service.

 Basis GA
az apim deletedservice

Voorlopig verwijderde Azure API Management-services beheren.

 Basis GA
az apim deletedservice list

Geef alle voorlopig verwijderde Api Management-services-exemplaren weer die beschikbaar zijn voor ongedaan maken voor het opgegeven abonnement.

 Basis GA
az apim deletedservice purge

Verwijder voorlopig verwijderde Api Management-service-exemplaar (verwijdert deze zonder optie om het verwijderen ongedaan te maken).

 Basis GA
az apim deletedservice show

Download voorlopig verwijderde Api Management-service-exemplaren die beschikbaar zijn voor ongedaan maken op naam.

 Basis GA
az apim graphql

Azure API Management GraphQL API's beheren.

 Basis GA
az apim graphql resolver

Beheer de Resolvers van De GraphQL-API van Azure API Management.

 Basis GA
az apim graphql resolver create

Maak een nieuwe resolver in de GraphQL-API of werk een bestaande oplossing bij.

 Basis GA
az apim graphql resolver delete

Verwijder de opgegeven resolver in de GraphQL-API.

 Basis GA
az apim graphql resolver list

Een verzameling van de resolvers voor de opgegeven GraphQL-API weergeven.

 Basis GA
az apim graphql resolver policy

Beheer het beleid voor Resolvers van De GraphQL API van Azure API Management.

 Basis GA
az apim graphql resolver policy create

Beleidsconfiguratie maken of bijwerken voor het Niveau van de GraphQL API Resolver.

 Basis GA
az apim graphql resolver policy delete

Verwijder de beleidsconfiguratie in de GraphQL API Resolver.

 Basis GA
az apim graphql resolver policy list

Haal de lijst met beleidsconfiguraties op het niveau van de GraphQL API Resolver op.

 Basis GA
az apim graphql resolver policy show

Haal de beleidsconfiguratie op het niveau van de GraphQL API Resolver op.

 Basis GA
az apim graphql resolver show

Haal de details op van de GraphQL API Resolver die is opgegeven door de id.

 Basis GA
az apim list

Api Management-service-exemplaren weergeven.

 Basis GA
az apim nv

Azure API Management benoemde waarden beheren.

 Basis GA
az apim nv create

Maak een benoemde WAARDE voor API Management.

 Basis GA
az apim nv delete

Verwijder een benoemde waarde voor API Management.

 Basis GA
az apim nv list

Geef API Management benoemde waarden weer.

 Basis GA
az apim nv show

Details weergeven van een benoemde API Management-waarde.

 Basis GA
az apim nv show-secret

Hiermee haalt u het geheim van een benoemde API Management-waarde op.

 Basis GA
az apim nv update

Werk een benoemde waarde voor API Management bij.

 Basis GA
az apim nv wait

Plaats de CLI in een wachtstatus totdat aan een voorwaarde van een apim benoemde waarde is voldaan.

 Basis GA
az apim product

Azure API Management-product beheren.

 Basis GA
az apim product api

Api's van Azure API Management-producten beheren.

 Basis GA
az apim product api add

Voeg een API toe aan het opgegeven product.

 Basis GA
az apim product api check

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

 Basis GA
az apim product api delete

Hiermee verwijdert u de opgegeven API uit het opgegeven product.

 Basis GA
az apim product api list

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

 Basis GA
az apim product create

Hiermee maakt u een product.

 Basis GA
az apim product delete

Product verwijderen.

 Basis GA
az apim product list

Geeft een verzameling producten weer in het opgegeven service-exemplaar.

 Basis GA
az apim product show

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

 Basis GA
az apim product update

Bestaande productdetails bijwerken.

 Basis GA
az apim product wait

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

 Basis GA
az apim restore

Hiermee herstelt u een back-up van een API Management-service die is gemaakt met behulp van de ApiManagementService_Backup bewerking op de huidige service. Dit is een langdurige bewerking en kan enkele minuten duren.

 Basis GA
az apim show

Details van een API Management-service-exemplaar weergeven.

 Basis GA
az apim update

Een API Management-service-exemplaar bijwerken.

 Basis GA
az apim wait

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

 Basis GA

az apim apply-network-updates

Bewerken

Werk de API Management-resource bij die wordt uitgevoerd in het virtuele netwerk om de bijgewerkte netwerkinstellingen te kiezen.

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

Voorbeelden

De instellingen van het virtuele netwerk van het API Management-service-exemplaar bijwerken

az apim apply-network-updates --name MyApim -g MyResourceGroup

Vereiste parameters

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

--location -l

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

--no-wait

Wacht niet totdat de langdurige bewerking is voltooid.

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 backup

Bewerken

Hiermee maakt u een back-up van de API Management-service naar het opgegeven Azure Storage-account. Dit duurt lang en kan enkele minuten duren.

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

Voorbeelden

Een back-up maken van het 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 u wilt maken.

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

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

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

Bewerken

Controleert of er een servicenaam beschikbaar is voor gebruik.

az apim check-name --name

Vereiste parameters

--name -n

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 create

Bewerken

Maak een API Management-service-exemplaar.

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

Voorbeelden

Maak een API Management-service voor ontwikkelaarslagen.

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

Maak een API Management-service voor de verbruikslaag.

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

Unieke naam van het service-exemplaar dat moet worden gemaakt.

De naam moet wereldwijd uniek zijn, omdat deze wordt opgenomen als de hostnaam van de gateway, zoals ' https://my-api-servicename.azure-api.net. Zie voorbeelden.

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

--disable-gateway

Schakel de gateway uit in de hoofdregio. Alleen geldig voor een Api Management-service die op meerdere locaties is geïmplementeerd.

geaccepteerde waarden: false, true
--enable-client-certificate

Hiermee wordt afgedwongen dat een clientcertificaat wordt weergegeven voor elke aanvraag voor 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. Alleen bedoeld om te worden gebruikt voor de verbruiks-SKU-service.

geaccepteerde waarden: false, true
standaardwaarde: False
--location -l

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

--no-wait

Wacht niet totdat de langdurige bewerking is voltooid.

standaardwaarde: False
--public-network-access

Of openbare eindpunttoegang wel of niet is toegestaan voor deze API Management-service. Als deze optie is ingesteld op waar, zijn privé-eindpunten de exclusieve toegangsmethode.

geaccepteerde waarden: false, true
--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, Isolated, Premium, Standard
standaardwaarde: Developer
--tags

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

--virtual-network -v

Het type virtueel netwerk.

geaccepteerde waarden: External, Internal, None
standaardwaarde: None
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 delete

Bewerken

Hiermee verwijdert u een API Management-service.

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

Voorbeelden

Een API Management-service verwijderen.

az apim delete -n MyApim -g MyResourceGroup

Vereiste parameters

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

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

Bewerken

Api Management-service-exemplaren weergeven.

az apim list [--resource-group]

Optionele parameters

--resource-group -g

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

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 restore

Bewerken

Hiermee herstelt u een back-up van een API Management-service die is gemaakt met behulp van de ApiManagementService_Backup bewerking op de huidige service. Dit is een langdurige bewerking en kan enkele minuten duren.

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

Voorbeelden

Hiermee herstelt u een back-up van het 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 u wilt herstellen.

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

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

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

--storage-account-key

De toegangssleutel van het opslagaccount waaruit de back-up is opgehaald.

--storage-account-name

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

Optionele parameters

--no-wait

Wacht niet totdat de langdurige bewerking is voltooid.

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 show

Bewerken

Details van een API Management-service-exemplaar weergeven.

az apim show --name
             --resource-group

Vereiste parameters

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

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 update

Bewerken

Een API Management-service-exemplaar bijwerken.

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

Vereiste parameters

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

--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: []
--disable-gateway

Schakel de gateway uit in de hoofdregio. Alleen geldig voor een Api Management-service die op meerdere locaties is geïmplementeerd.

geaccepteerde waarden: false, true
--enable-client-certificate

Hiermee wordt afgedwongen dat een clientcertificaat wordt weergegeven voor elke aanvraag voor 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. Alleen bedoeld om te worden gebruikt voor de verbruiks-SKU-service.

geaccepteerde waarden: false, true
--force-string

Wanneer u 'set' of 'toevoegen' gebruikt, behoudt u letterlijke tekenreeksen in plaats van te converteren naar JSON.

standaardwaarde: False
--no-wait

Wacht niet totdat de langdurige bewerking is voltooid.

standaardwaarde: False
--public-network-access

Of openbare eindpunttoegang wel of niet is toegestaan voor deze API Management-service. Als deze optie is ingesteld op waar, zijn privé-eindpunten de exclusieve toegangsmethode.

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

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

standaardwaarde: []
--set

Werk een object bij door een eigenschapspad en waarde op te geven die u wilt instellen. Voorbeeld: --set property1.property2=<value>.

standaardwaarde: []
--sku-capacity

Het aantal geïmplementeerde eenheden van de SKU.

--sku-name

De sKU van het API Management-exemplaar.

geaccepteerde waarden: Basic, Consumption, Developer, Isolated, Premium, Standard
--tags

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

--virtual-network -v

Het type virtueel netwerk.

geaccepteerde waarden: External, Internal, None
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 wait

Bewerken

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

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

Voorbeelden

Plaats de CLI in een wachtstatus totdat aan een voorwaarde van een APIM is voldaan. (automatisch gegenereerd)

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

Vereiste parameters

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