Dela via

az apim

  • Referens

Hantera Azure API Management-tjänster.

Kommandon

Name Description Typ Status
az apim api

Hantera API:er för Azure API Management.

 Kärna Allmän tillgänglighet
az apim api create

Skapa ett API Management-API.

 Kärna Allmän tillgänglighet
az apim api delete

Ta bort ett API Management-API.

 Kärna Allmän tillgänglighet
az apim api export

Exportera ett API Management-API.

 Kärna Allmän tillgänglighet
az apim api import

Importera ett API Management-API.

 Kärna Allmän tillgänglighet
az apim api list

Lista API Management API:er.

 Kärna Allmän tillgänglighet
az apim api operation

Hantera API-åtgärder för Azure API Management.

 Kärna Allmän tillgänglighet
az apim api operation create

Skapar en ny åtgärd i API:et.

 Kärna Allmän tillgänglighet
az apim api operation delete

Tar bort den angivna åtgärden i API:et.

 Kärna Allmän tillgänglighet
az apim api operation list

Lista en samling av åtgärderna för det angivna API:et.

 Kärna Allmän tillgänglighet
az apim api operation show

Hämtar information om DEN API-åtgärd som anges av dess identifierare.

 Kärna Allmän tillgänglighet
az apim api operation update

Uppdateringar information om åtgärden i API:et som anges av dess identifierare.

 Kärna Allmän tillgänglighet
az apim api release

Hantera Azure API Management API Release.

 Kärna Allmän tillgänglighet
az apim api release create

Skapar en ny version för API:et.

 Kärna Allmän tillgänglighet
az apim api release delete

Tar bort den angivna versionen i API:et.

 Kärna Allmän tillgänglighet
az apim api release list

Visar en lista över alla versioner av ett API.

 Kärna Allmän tillgänglighet
az apim api release show

Returnerar information om en API-version.

 Kärna Allmän tillgänglighet
az apim api release update

Uppdateringar information om versionen av API:et som anges av dess identifierare.

 Kärna Allmän tillgänglighet
az apim api revision

Hantera Azure API Management API Revision.

 Kärna Allmän tillgänglighet
az apim api revision create

Skapa API-revision.

 Kärna Allmän tillgänglighet
az apim api revision list

Visar en lista över alla revisioner av ett API.

 Kärna Allmän tillgänglighet
az apim api schema

Hantera API-scheman för Azure API Management.

 Kärna Allmän tillgänglighet
az apim api schema create

Skapa ett API Management API-schema.

 Kärna Allmän tillgänglighet
az apim api schema delete

Ta bort ett API Management API-schema.

 Kärna Allmän tillgänglighet
az apim api schema get-etag

Hämta etag för ett API Management API-schema.

 Kärna Allmän tillgänglighet
az apim api schema list

Lista API Management API-scheman.

 Kärna Allmän tillgänglighet
az apim api schema show

Visa information om ett API Management API-schema.

 Kärna Allmän tillgänglighet
az apim api schema wait

Placera CLI i vänteläge tills ett villkor för ett apim api-schema uppfylls.

 Kärna Allmän tillgänglighet
az apim api show

Visa information om ett API Management-API.

 Kärna Allmän tillgänglighet
az apim api update

Uppdatera ett API Management-API.

 Kärna Allmän tillgänglighet
az apim api versionset

Hantera Versionsuppsättning för Azure API Management API.

 Kärna Allmän tillgänglighet
az apim api versionset create

Skapar en API-versionsuppsättning.

 Kärna Allmän tillgänglighet
az apim api versionset delete

Tar bort specifika API-versionsuppsättningar.

 Kärna Allmän tillgänglighet
az apim api versionset list

Visar en samling API-versionsuppsättningar i den angivna tjänstinstansen.

 Kärna Allmän tillgänglighet
az apim api versionset show

Hämtar information om api-versionsuppsättningen som anges av dess identifierare.

 Kärna Allmän tillgänglighet
az apim api versionset update

Uppdateringar information om API VersionSet som anges av dess identifierare.

 Kärna Allmän tillgänglighet
az apim api wait

Placera CLI i ett väntetillstånd tills ett villkor för ett apim-API uppfylls.

 Kärna Allmän tillgänglighet
az apim apply-network-updates

Uppdatera API Management-resursen som körs i det virtuella nätverket för att välja de uppdaterade nätverksinställningarna.

 Kärna Allmän tillgänglighet
az apim backup

Skapar en säkerhetskopia av API Management-tjänsten till det angivna Azure Storage-kontot. Det här är en tidskrävande åtgärd som kan ta flera minuter att slutföra.

 Kärna Allmän tillgänglighet
az apim check-name

Kontrollerar om ett tjänstnamn är tillgängligt att använda.

 Kärna Allmän tillgänglighet
az apim create

Skapa en API Management-tjänstinstans.

 Kärna Allmän tillgänglighet
az apim delete

Tar bort en API Management-tjänst.

 Kärna Allmän tillgänglighet
az apim deletedservice

Hantera mjukt borttagna Azure API Management-tjänster.

 Kärna Allmän tillgänglighet
az apim deletedservice list

Visa en lista över alla instanser av api management-tjänster som är tillgängliga för att ta bort den angivna prenumerationen.

 Kärna Allmän tillgänglighet
az apim deletedservice purge

Rensa den mjukt borttagna Api Management-tjänstinstansen (tar bort den utan alternativ för att ta bort borttagningen).

 Kärna Allmän tillgänglighet
az apim deletedservice show

Hämta instanser av api management-tjänsten med mjuk borttagning som är tillgängliga för avborttagning efter namn.

 Kärna Allmän tillgänglighet
az apim graphql

Hantera GraphQL API:er för Azure API Management.

 Kärna Allmän tillgänglighet
az apim graphql resolver

Hantera GraphQL API:s Matchare för Azure API Management.

 Kärna Allmän tillgänglighet
az apim graphql resolver create

Skapa en ny lösning i GraphQL-API:et eller uppdatera en befintlig.

 Kärna Allmän tillgänglighet
az apim graphql resolver delete

Ta bort den angivna matcharen i GraphQL-API:et.

 Kärna Allmän tillgänglighet
az apim graphql resolver list

Lista en samling matchare för det angivna GraphQL-API:et.

 Kärna Allmän tillgänglighet
az apim graphql resolver policy

Hantera Azure API Management GraphQL API:s matchningsprinciper.

 Kärna Allmän tillgänglighet
az apim graphql resolver policy create

Skapa eller uppdatera principkonfigurationen för GraphQL API Resolver-nivån.

 Kärna Allmän tillgänglighet
az apim graphql resolver policy delete

Ta bort principkonfigurationen i GraphQL Api Resolver.

 Kärna Allmän tillgänglighet
az apim graphql resolver policy list

Hämta listan över principkonfiguration på GraphQL API Resolver-nivå.

 Kärna Allmän tillgänglighet
az apim graphql resolver policy show

Hämta principkonfigurationen på GraphQL API Resolver-nivå.

 Kärna Allmän tillgänglighet
az apim graphql resolver show

Hämta information om GraphQL API Resolver som anges av dess identifierare.

 Kärna Allmän tillgänglighet
az apim list

Lista API Management-tjänstinstanser.

 Kärna Allmän tillgänglighet
az apim nv

Hantera namngivna värden för Azure API Management.

 Kärna Allmän tillgänglighet
az apim nv create

Skapa ett API Management-namngivet värde.

 Kärna Allmän tillgänglighet
az apim nv delete

Ta bort ett API Management-namngivet värde.

 Kärna Allmän tillgänglighet
az apim nv list

Lista API Management-namngivna värden.

 Kärna Allmän tillgänglighet
az apim nv show

Visa information om ett API Management-namngivet värde.

 Kärna Allmän tillgänglighet
az apim nv show-secret

Hämtar hemligheten för ett API Management-namngivet värde.

 Kärna Allmän tillgänglighet
az apim nv update

Uppdatera ett API Management-namngivet värde.

 Kärna Allmän tillgänglighet
az apim nv wait

Placera CLI i vänteläge tills ett villkor för ett apim-namngivet värde uppfylls.

 Kärna Allmän tillgänglighet
az apim product

Hantera Azure API Management-produkter.

 Kärna Allmän tillgänglighet
az apim product api

Hantera API:er för Azure API Management Product.

 Kärna Allmän tillgänglighet
az apim product api add

Lägg till ett API i den angivna produkten.

 Kärna Allmän tillgänglighet
az apim product api check

Kontrollerar att API-entiteten som anges av identifieraren är associerad med entiteten Produkt.

 Kärna Allmän tillgänglighet
az apim product api delete

Tar bort det angivna API:et från den angivna produkten.

 Kärna Allmän tillgänglighet
az apim product api list

Visar en samling api:er som är associerade med en produkt.

 Kärna Allmän tillgänglighet
az apim product create

Skapar en produkt.

 Kärna Allmän tillgänglighet
az apim product delete

Ta bort produkten.

 Kärna Allmän tillgänglighet
az apim product list

Visar en samling produkter i den angivna tjänstinstansen.

 Kärna Allmän tillgänglighet
az apim product show

Hämtar information om den produkt som anges av dess identifierare.

 Kärna Allmän tillgänglighet
az apim product update

Uppdatera befintlig produktinformation.

 Kärna Allmän tillgänglighet
az apim product wait

Placera CLI i vänteläge tills ett villkor för en apim-produkt uppfylls.

 Kärna Allmän tillgänglighet
az apim restore

Återställer en säkerhetskopia av en API Management-tjänst som skapats med hjälp av den ApiManagementService_Backup åtgärden för den aktuella tjänsten. Det här är en tidskrävande åtgärd som kan ta flera minuter att slutföra.

 Kärna Allmän tillgänglighet
az apim show

Visa information om en API Management-tjänstinstans.

 Kärna Allmän tillgänglighet
az apim update

Uppdatera en API Management-tjänstinstans.

 Kärna Allmän tillgänglighet
az apim wait

Placera CLI i vänteläge tills ett villkor för en apim uppfylls.

 Kärna Allmän tillgänglighet

az apim apply-network-updates

Redigera

Uppdatera API Management-resursen som körs i det virtuella nätverket för att välja de uppdaterade nätverksinställningarna.

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

Exempel

Uppdatera inställningarna för det virtuella nätverket för API Management-tjänstinstansen

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

Obligatoriska parametrar

--name -n

Namnet på api Management Service-instansen.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Valfria parametrar

--location -l

Plats. Värden från: az account list-locations. Du kan konfigurera standardplatsen med hjälp av az configure --defaults location=<location>.

--no-wait

Vänta inte tills den långvariga åtgärden har slutförts.

standardvärde: False
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az apim backup

Redigera

Skapar en säkerhetskopia av API Management-tjänsten till det angivna Azure Storage-kontot. Det här är en tidskrävande åtgärd som kan ta flera minuter att slutföra.

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

Exempel

Skapa en säkerhetskopia av API Management-tjänstinstansen

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

Obligatoriska parametrar

--backup-name

Namnet på den säkerhetskopieringsfil som ska skapas.

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

Namnet på lagringskontocontainern som användes för att placera säkerhetskopian.

--name -n

Namnet på api Management Service-instansen.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--storage-account-key

Åtkomstnyckeln för lagringskontot som används för att placera säkerhetskopian.

--storage-account-name

Namnet på lagringskontot som användes för att placera säkerhetskopian.

Valfria parametrar

--no-wait

Vänta inte tills den långvariga åtgärden har slutförts.

standardvärde: False
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az apim check-name

Redigera

Kontrollerar om ett tjänstnamn är tillgängligt att använda.

az apim check-name --name

Obligatoriska parametrar

--name -n

Namnet på api Management Service-instansen.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az apim create

Redigera

Skapa en API Management-tjänstinstans.

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

Exempel

Skapa en API Management-tjänst på utvecklarnivå.

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

Skapa en API Management-tjänst på förbrukningsnivå.

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

Obligatoriska parametrar

--name -n

Unikt namn på den tjänstinstans som ska skapas.

Namnet måste vara globalt unikt eftersom det inkluderas som gatewayens https://my-api-servicename.azure-api.netvärdnamn, till exempel. Se exempel.

--publisher-email

E-postadressen för att ta emot alla systemaviseringar.

--publisher-name

Namnet på din organisation för användning i utvecklarportalen och e-postmeddelanden.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Valfria parametrar

--disable-gateway

Inaktivera gatewayen i huvudregionen. Endast giltig för en Api Management-tjänst som distribuerats på flera platser.

accepterade värden: false, true
--enable-client-certificate

Framtvingar ett klientcertifikat som ska visas på varje begäran till gatewayen och gör det också möjligt att autentisera certifikatet i principen på gatewayen.

accepterade värden: false, true
--enable-managed-identity

Skapa en hanterad identitet för API Management-tjänsten för åtkomst till andra Azure-resurser. Endast avsedd att användas för förbruknings-SKU-tjänsten.

accepterade värden: false, true
standardvärde: False
--location -l

Plats. Värden från: az account list-locations. Du kan konfigurera standardplatsen med hjälp av az configure --defaults location=<location>.

--no-wait

Vänta inte tills den långvariga åtgärden har slutförts.

standardvärde: False
--public-network-access

Om offentlig slutpunktsåtkomst tillåts för den här API Management-tjänsten eller inte. Om värdet är true är privata slutpunkter den exklusiva åtkomstmetoden.

accepterade värden: false, true
--sku-capacity

Antalet distribuerade enheter för SKU:n.

standardvärde: 1
--sku-name

SKU:n för api-hanteringsinstansen.

accepterade värden: Basic, Consumption, Developer, Isolated, Premium, Standard
standardvärde: Developer
--tags

Blankstegsavgränsade taggar: key[=value] [key[=value] ...]. Använd "" för att rensa befintliga taggar.

--virtual-network -v

Den virtuella nätverkstypen.

accepterade värden: External, Internal, None
standardvärde: None
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az apim delete

Redigera

Tar bort en API Management-tjänst.

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

Exempel

Ta bort en API Management-tjänst.

az apim delete -n MyApim -g MyResourceGroup

Obligatoriska parametrar

--name -n

Namnet på api Management Service-instansen.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Valfria parametrar

--no-wait

Vänta inte tills den långvariga åtgärden har slutförts.

standardvärde: False
--yes -y

Fråga inte efter bekräftelse.

standardvärde: False
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az apim list

Redigera

Lista API Management-tjänstinstanser.

az apim list [--resource-group]

Valfria parametrar

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az apim restore

Redigera

Återställer en säkerhetskopia av en API Management-tjänst som skapats med hjälp av den ApiManagementService_Backup åtgärden för den aktuella tjänsten. Det här är en tidskrävande åtgärd som kan ta flera minuter att slutföra.

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

Exempel

Återställer en säkerhetskopia av API Management-tjänstinstansen

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

Obligatoriska parametrar

--backup-name

Namnet på den säkerhetskopieringsfil som ska återställas.

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

Namnet på lagringskontocontainern som används för att hämta säkerhetskopian från.

--name -n

Namnet på api Management Service-instansen.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--storage-account-key

Åtkomstnyckeln för lagringskontot som används för att hämta säkerhetskopian från.

--storage-account-name

Namnet på lagringskontot som används för att hämta säkerhetskopian från.

Valfria parametrar

--no-wait

Vänta inte tills den långvariga åtgärden har slutförts.

standardvärde: False
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az apim show

Redigera

Visa information om en API Management-tjänstinstans.

az apim show --name
             --resource-group

Obligatoriska parametrar

--name -n

Namnet på api Management Service-instansen.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az apim update

Redigera

Uppdatera en API Management-tjänstinstans.

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

Obligatoriska parametrar

--name -n

Namnet på api Management Service-instansen.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Valfria parametrar

--add

Lägg till ett objekt i en lista över objekt genom att ange en sökväg och nyckelvärdepar. Exempel: --add property.listProperty <key=value, string or JSON string>.

standardvärde: []
--disable-gateway

Inaktivera gatewayen i huvudregionen. Endast giltig för en Api Management-tjänst som distribuerats på flera platser.

accepterade värden: false, true
--enable-client-certificate

Framtvingar ett klientcertifikat som ska visas på varje begäran till gatewayen och gör det också möjligt att autentisera certifikatet i principen på gatewayen.

accepterade värden: false, true
--enable-managed-identity

Skapa en hanterad identitet för API Management-tjänsten för åtkomst till andra Azure-resurser. Endast avsedd att användas för förbruknings-SKU-tjänsten.

accepterade värden: false, true
--force-string

När du använder "set" eller "add" bevarar du strängliteraler i stället för att försöka konvertera till JSON.

standardvärde: False
--no-wait

Vänta inte tills den långvariga åtgärden har slutförts.

standardvärde: False
--public-network-access

Om offentlig slutpunktsåtkomst tillåts för den här API Management-tjänsten eller inte. Om värdet är true är privata slutpunkter den exklusiva åtkomstmetoden.

accepterade värden: false, true
--publisher-email

E-postadressen för att ta emot alla systemaviseringar.

--publisher-name

Namnet på din organisation för användning i utvecklarportalen och e-postmeddelanden.

--remove

Ta bort en egenskap eller ett element från en lista. Exempel: --remove property.list <indexToRemove> ELLER --remove propertyToRemove.

standardvärde: []
--set

Uppdatera ett objekt genom att ange en egenskapssökväg och ett värde som ska anges. Exempel: --set property1.property2=<value>.

standardvärde: []
--sku-capacity

Antalet distribuerade enheter för SKU:n.

--sku-name

SKU:n för api-hanteringsinstansen.

accepterade värden: Basic, Consumption, Developer, Isolated, Premium, Standard
--tags

Blankstegsavgränsade taggar: key[=value] [key[=value] ...]. Använd "" för att rensa befintliga taggar.

--virtual-network -v

Den virtuella nätverkstypen.

accepterade värden: External, Internal, None
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az apim wait

Redigera

Placera CLI i vänteläge tills ett villkor för en apim uppfylls.

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

Exempel

Placera CLI i vänteläge tills ett villkor för en apim uppfylls. (automatiskt genererad)

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

Obligatoriska parametrar

--name -n

Namnet på api Management Service-instansen.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Valfria parametrar

--created

Vänta tills du har skapat med "provisioningState" på "Lyckades".

standardvärde: False
--custom

Vänta tills villkoret uppfyller en anpassad JMESPath-fråga. T.ex. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Vänta tills den har tagits bort.

standardvärde: False
--exists

Vänta tills resursen finns.

standardvärde: False
--interval

Avsökningsintervall i sekunder.

standardvärde: 30
--timeout

Maximal väntetid i sekunder.

standardvärde: 3600
--updated

Vänta tills det har uppdaterats med provisioningState på Lyckades.

standardvärde: False
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.