az apim api
Hantera API:er för Azure API Management.
Kommandon
| Name | Description | Typ | Status |
|---|---|---|---|
| az apim api create |
Skapa ett API Management-API. |
Core | GA |
| az apim api delete |
Ta bort ett API Management-API. |
Core | GA |
| az apim api export |
Exportera ett API Management-API. |
Core | GA |
| az apim api import |
Importera ett API Management-API. |
Core | GA |
| az apim api list |
Lista API Management API:er. |
Core | GA |
| az apim api operation |
Hantera API-åtgärder för Azure API Management. |
Core | GA |
| az apim api operation create |
Skapar en ny åtgärd i API:et. |
Core | GA |
| az apim api operation delete |
Tar bort den angivna åtgärden i API:et. |
Core | GA |
| az apim api operation list |
Lista en samling av åtgärderna för det angivna API:et. |
Core | GA |
| az apim api operation show |
Hämtar information om DEN API-åtgärd som anges av dess identifierare. |
Core | GA |
| az apim api operation update |
Uppdaterar informationen om åtgärden i API:et som anges av dess identifierare. |
Core | GA |
| az apim api release |
Hantera Azure API Management API Release. |
Core | GA |
| az apim api release create |
Skapar en ny version för API:et. |
Core | GA |
| az apim api release delete |
Tar bort den angivna versionen i API:et. |
Core | GA |
| az apim api release list |
Visar en lista över alla versioner av ett API. |
Core | GA |
| az apim api release show |
Returnerar information om en API-version. |
Core | GA |
| az apim api release update |
Uppdaterar informationen om den version av API:et som anges av dess identifierare. |
Core | GA |
| az apim api revision |
Hantera Azure API Management API Revision. |
Core | GA |
| az apim api revision create |
Skapa API-revision. |
Core | GA |
| az apim api revision list |
Visar en lista över alla revisioner av ett API. |
Core | GA |
| az apim api schema |
Hantera API-scheman för Azure API Management. |
Core | GA |
| az apim api schema create |
Skapa ett API Management API-schema. |
Core | GA |
| az apim api schema delete |
Ta bort ett API Management API-schema. |
Core | GA |
| az apim api schema get-etag |
Hämta etag för ett API Management API-schema. |
Core | GA |
| az apim api schema list |
Lista API Management API-scheman. |
Core | GA |
| az apim api schema show |
Visa information om ett API Management API-schema. |
Core | GA |
| az apim api schema wait |
Placera CLI i vänteläge tills ett villkor för ett apim api-schema uppfylls. |
Core | GA |
| az apim api show |
Visa information om ett API Management-API. |
Core | GA |
| az apim api update |
Uppdatera ett API Management-API. |
Core | GA |
| az apim api versionset |
Hantera Versionsuppsättning för Azure API Management API. |
Core | GA |
| az apim api versionset create |
Skapar en API-versionsuppsättning. |
Core | GA |
| az apim api versionset delete |
Tar bort specifika API-versionsuppsättningar. |
Core | GA |
| az apim api versionset list |
Visar en samling API-versionsuppsättningar i den angivna tjänstinstansen. |
Core | GA |
| az apim api versionset show |
Hämtar information om api-versionsuppsättningen som anges av dess identifierare. |
Core | GA |
| az apim api versionset update |
Uppdaterar informationen om API VersionSet som anges av dess identifierare. |
Core | GA |
| az apim api wait |
Placera CLI i ett väntetillstånd tills ett villkor för ett apim-API uppfylls. |
Core | GA |
az apim api create
Skapa ett 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}]
Exempel
Skapa ett grundläggande API.
az apim api create --service-name MyApim -g MyResourceGroup --api-id MyApi --path '/myapi' --display-name 'My API'
Obligatoriska parametrar
Unikt namn på api:et som ska skapas.
API-revisionsidentifierare. Måste vara unikt i den aktuella API Management-tjänstinstansen. Icke-aktuell revision har ; rev=n som ett suffix där n är revisionsnumret.
| Egenskap | Värde |
|---|---|
| Parameter group: | API Arguments |
Visningsnamn för api:et som ska skapas.
| Egenskap | Värde |
|---|---|
| Parameter group: | API Arguments |
Sökväg till API:et.
| Egenskap | Värde |
|---|---|
| Parameter group: | API Arguments |
Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.
Namnet på API Management-tjänstinstansen.
Valfria parametrar
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Typen av API.
| Egenskap | Värde |
|---|---|
| Parameter group: | API Arguments |
| Godkända värden: | graphql, http, soap, websocket |
Anger omfånget för OAuth-åtgärder.
Anger OAuth-auktoriseringsserverns ID.
Anger sändningsmetoderna för ägartoken.
Beskrivning av API:et. Kan innehålla HTML-formateringstaggar.
| Egenskap | Värde |
|---|---|
| Parameter group: | API Arguments |
Vänta inte tills den långvariga åtgärden har slutförts.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Anger openid i autentiseringsinställningen.
Beskriver vilka protokoll som åtgärderna i det här API:et kan anropas för.
| Egenskap | Värde |
|---|---|
| Parameter group: | API Arguments |
| Godkända värden: | http, https, ws, wss |
Absolut URL för serverdelstjänsten som implementerar det här API:et. Får inte vara längre än 2 000 tecken.
| Egenskap | Värde |
|---|---|
| Parameter group: | API Arguments |
Anger namnet på prenumerationsnyckelns huvud.
| Egenskap | Värde |
|---|---|
| Parameter group: | API Arguments |
Anger parameternamnet för frågesträngen för prenumerationsnyckeln.
| Egenskap | Värde |
|---|---|
| Parameter group: | API Arguments |
Anger om prenumerationsnyckeln krävs under anropet till det här API:et, sant – API ingår endast i stängda produkter, false – API ingår enbart i öppna produkter, null – det finns en blandning av produkter.
Om det är sant kräver API:et en prenumerationsnyckel för begäranden.
| Egenskap | Värde |
|---|---|
| Parameter group: | API Arguments |
| Standardvärde: | False |
| Godkända värden: | false, true |
Globala parametrar
Öka loggningsverositeten för att visa alla felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Visa det här hjälpmeddelandet och avsluta.
Visa bara fel och ignorera varningar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Utdataformat.
| Egenskap | Värde |
|---|---|
| Standardvärde: | json |
| Godkända värden: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.
Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.
Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
az apim api delete
Ta bort ett API Management-API.
az apim api delete --api-id
--resource-group
--service-name
[--delete-revisions]
[--if-match]
[--no-wait]
[--yes]
Obligatoriska parametrar
API-identifierare. Måste vara unikt i den aktuella API Management-tjänstinstansen. Icke-aktuell revision har ; rev=n som ett suffix där n är revisionsnumret.
| Egenskap | Värde |
|---|---|
| Parameter group: | API Arguments |
Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.
Namnet på API Management-tjänstinstansen.
Valfria parametrar
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Ta bort alla revisioner av API:et.
ETag för entiteten.
Vänta inte tills den långvariga åtgärden har slutförts.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Fråga inte efter bekräftelse.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Globala parametrar
Öka loggningsverositeten för att visa alla felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Visa det här hjälpmeddelandet och avsluta.
Visa bara fel och ignorera varningar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Utdataformat.
| Egenskap | Värde |
|---|---|
| Standardvärde: | json |
| Godkända värden: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.
Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.
Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
az apim api export
Exportera ett API Management-API.
az apim api export --api-id
--ef --export-format {OpenApiJsonFile, OpenApiJsonUrl, OpenApiYamlFile, OpenApiYamlUrl, SwaggerFile, SwaggerUrl, WadlFile, WadlUrl, WsdlFile, WsdlUrl}
--resource-group
--service-name
[--file-path]
Exempel
Exportera ett API Management-API till en fil eller returnerar ett svar som innehåller en länk till exporten.
az apim api export -g MyResourceGroup --service-name MyApim --api-id MyApi --export-format OpenApiJson --file-path path
Obligatoriska parametrar
API-identifierare. Måste vara unikt i den aktuella API Management-tjänstinstansen. Icke-aktuell revision har ; rev=n som ett suffix där n är revisionsnumret. Regex-mönster: ^[^*#&+:<>?]+$.
| Egenskap | Värde |
|---|---|
| Parameter group: | API Arguments |
Ange formatet för det exporterande API:et.
| Egenskap | Värde |
|---|---|
| Godkända värden: | OpenApiJsonFile, OpenApiJsonUrl, OpenApiYamlFile, OpenApiYamlUrl, SwaggerFile, SwaggerUrl, WadlFile, WadlUrl, WsdlFile, WsdlUrl |
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
Namnet på api Management Service-instansen.
Valfria parametrar
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Filsökväg som angetts för att exportera API:et.
Globala parametrar
Öka loggningsverositeten för att visa alla felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Visa det här hjälpmeddelandet och avsluta.
Visa bara fel och ignorera varningar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Utdataformat.
| Egenskap | Värde |
|---|---|
| Standardvärde: | json |
| Godkända värden: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.
Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.
Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
az apim api import
Importera ett 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]
Exempel
Importera ett API Management-API från en fil eller en URL
az apim api import -g MyResourceGroup --service-name MyApim --path MyApi --specification-url https://MySpecificationURL --specification-format OpenApiJson
Obligatoriska parametrar
Required. Relativ URL som unikt identifierar det här API:et och alla dess resurssökvägar i API Management-tjänstinstansen.
| Egenskap | Värde |
|---|---|
| Parameter group: | API Arguments |
Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.
Namnet på api Management Service-instansen.
Ange formatet för det importerade API:et.
| Egenskap | Värde |
|---|---|
| Godkända värden: | GraphQL, OpenApi, OpenApiJson, Swagger, Wadl, Wsdl |
Valfria parametrar
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
API-identifierare. Måste vara unikt i den aktuella API Management-tjänstinstansen. Icke-aktuell revision har ; rev=n som ett suffix där n är revisionsnumret.
| Egenskap | Värde |
|---|---|
| Parameter group: | API Arguments |
Beskriver revisionen av API:et. Om inget värde anges skapas standardrevision 1.
| Egenskap | Värde |
|---|---|
| Parameter group: | API Arguments |
Typen av API.
| Egenskap | Värde |
|---|---|
| Parameter group: | API Arguments |
| Godkända värden: | graphql, http, soap, websocket |
Beskriver api-versionen. Om du lägger till en version i ett icke-versions-API skapas en ursprunglig version automatiskt och svarar på standard-URL:en.
| Egenskap | Värde |
|---|---|
| Parameter group: | API Arguments |
Beskriver den versionsuppsättning som ska användas med API:et.
| Egenskap | Värde |
|---|---|
| Parameter group: | API Arguments |
Beskrivning av API:et. Kan innehålla HTML-formateringstaggar.
| Egenskap | Värde |
|---|---|
| Parameter group: | API Arguments |
Visningsnamn för det här API:et.
| Egenskap | Värde |
|---|---|
| Parameter group: | API Arguments |
Vänta inte tills den långvariga åtgärden har slutförts.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Beskriver vilka protokoll(en eller flera) som åtgärderna i det här API:et kan anropas för.
| Egenskap | Värde |
|---|---|
| Parameter group: | API Arguments |
| Godkända värden: | http, https, ws, wss |
Absolut URL för serverdelstjänsten som implementerar det här API:et. Får inte vara längre än 2 000 tecken.
| Egenskap | Värde |
|---|---|
| Parameter group: | API Arguments |
Typen av API när filformatet är WSDL.
Filsökväg som angetts för att importera API:et.
Url som angetts för att importera API:et.
Anger namnet på prenumerationsnyckelns huvud.
| Egenskap | Värde |
|---|---|
| Parameter group: | API Arguments |
Anger parameternamnet för frågesträngen för prenumerationsnyckeln.
| Egenskap | Värde |
|---|---|
| Parameter group: | API Arguments |
Om det är sant kräver API:et en prenumerationsnyckel för begäranden.
| Egenskap | Värde |
|---|---|
| Parameter group: | API Arguments |
| Godkända värden: | false, true |
Lokalt namn på den WSDL-slutpunkt (port) som ska importeras.
Lokalt namn på WSDL-tjänsten som ska importeras.
Globala parametrar
Öka loggningsverositeten för att visa alla felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Visa det här hjälpmeddelandet och avsluta.
Visa bara fel och ignorera varningar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Utdataformat.
| Egenskap | Värde |
|---|---|
| Standardvärde: | json |
| Godkända värden: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.
Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.
Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
az apim api list
Lista API Management API:er.
az apim api list --resource-group
--service-name
[--filter-display-name]
[--skip]
[--top]
Obligatoriska parametrar
Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.
Namnet på API Management-tjänstinstansen.
Valfria parametrar
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Filter för API:er efter displayName.
| Egenskap | Värde |
|---|---|
| Parameter group: | API Arguments |
Antal poster att hoppa över.
Antal poster som ska returneras.
Globala parametrar
Öka loggningsverositeten för att visa alla felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Visa det här hjälpmeddelandet och avsluta.
Visa bara fel och ignorera varningar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Utdataformat.
| Egenskap | Värde |
|---|---|
| Standardvärde: | json |
| Godkända värden: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.
Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.
Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
az apim api show
Visa information om ett API Management-API.
az apim api show --api-id
--resource-group
--service-name
Obligatoriska parametrar
API-identifierare. Måste vara unikt i den aktuella API Management-tjänstinstansen. Icke-aktuell revision har ; rev=n som ett suffix där n är revisionsnumret.
| Egenskap | Värde |
|---|---|
| Parameter group: | API Arguments |
Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.
Namnet på API Management-tjänstinstansen.
Globala parametrar
Öka loggningsverositeten för att visa alla felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Visa det här hjälpmeddelandet och avsluta.
Visa bara fel och ignorera varningar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Utdataformat.
| Egenskap | Värde |
|---|---|
| Standardvärde: | json |
| Godkända värden: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.
Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.
Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
az apim api update
Uppdatera ett API Management-API.
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]
Exempel
Skapa ett grundläggande API.
az apim api update --service-name MyApim -g MyResourceGroup --api-id MyApi --description foo
Obligatoriska parametrar
Unikt namn på api:et som ska skapas.
API-revisionsidentifierare. Måste vara unikt i den aktuella API Management-tjänstinstansen. Icke-aktuell revision har ; rev=n som ett suffix där n är revisionsnumret.
| Egenskap | Värde |
|---|---|
| Parameter group: | API Arguments |
Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.
Namnet på API Management-tjänstinstansen.
Valfria parametrar
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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>.
| Egenskap | Värde |
|---|---|
| Parameter group: | Generic Update Arguments |
| Standardvärde: | [] |
Typen av API.
| Egenskap | Värde |
|---|---|
| Parameter group: | API Arguments |
| Godkända värden: | graphql, http, soap, websocket |
Beskrivning av API:et. Kan innehålla HTML-formateringstaggar.
| Egenskap | Värde |
|---|---|
| Parameter group: | API Arguments |
API-namn. Måste vara mellan 1 och 300 tecken långt.
| Egenskap | Värde |
|---|---|
| Parameter group: | API Arguments |
När du använder "set" eller "add" bevarar du strängliteraler i stället för att försöka konvertera till JSON.
| Egenskap | Värde |
|---|---|
| Parameter group: | Generic Update Arguments |
| Standardvärde: | False |
ETag för entiteten. Krävs inte när du skapar en entitet, men krävs vid uppdatering av en entitet. Standardvärdet är Ingen.
Vänta inte tills den långvariga åtgärden har slutförts.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Required. Relativ URL som unikt identifierar det här API:et och alla dess resurssökvägar i API Management-tjänstinstansen.
| Egenskap | Värde |
|---|---|
| Parameter group: | API Arguments |
Beskriver vilka protokoll som åtgärderna i det här API:et kan anropas för.
| Egenskap | Värde |
|---|---|
| Parameter group: | API Arguments |
| Godkända värden: | http, https, ws, wss |
Ta bort en egenskap eller ett element från en lista. Exempel: --remove property.list <indexToRemove> ELLER --remove propertyToRemove.
| Egenskap | Värde |
|---|---|
| Parameter group: | Generic Update Arguments |
| Standardvärde: | [] |
Absolut URL för serverdelstjänsten som implementerar det här API:et. Får inte vara längre än 2 000 tecken.
| Egenskap | Värde |
|---|---|
| Parameter group: | API Arguments |
Uppdatera ett objekt genom att ange en egenskapssökväg och ett värde som ska anges. Exempel: --set property1.property2=<value>.
| Egenskap | Värde |
|---|---|
| Parameter group: | Generic Update Arguments |
| Standardvärde: | [] |
Anger namnet på prenumerationsnyckelns huvud.
| Egenskap | Värde |
|---|---|
| Parameter group: | API Arguments |
Anger parameternamnet för frågesträngen för prenumerationsnyckeln.
| Egenskap | Värde |
|---|---|
| Parameter group: | API Arguments |
Om det är sant kräver API:et en prenumerationsnyckel för begäranden.
| Egenskap | Värde |
|---|---|
| Parameter group: | API Arguments |
| Godkända värden: | false, true |
Blankstegsavgränsade taggar: key[=value] [key[=value] ...]. Använd "" för att rensa befintliga taggar.
Globala parametrar
Öka loggningsverositeten för att visa alla felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Visa det här hjälpmeddelandet och avsluta.
Visa bara fel och ignorera varningar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Utdataformat.
| Egenskap | Värde |
|---|---|
| Standardvärde: | json |
| Godkända värden: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.
Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.
Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
az apim api wait
Placera CLI i ett väntetillstånd tills ett villkor för ett apim-API uppfylls.
az apim api wait --api-id
--name
--resource-group
[--created]
[--custom]
[--deleted]
[--exists]
[--interval]
[--timeout]
[--updated]
Exempel
Placera CLI i väntetillstånd tills ett villkor för ett apim-api uppfylls. (autogenerated)
az apim api wait --created --api-id MyApi --name MyApim --resource-group MyResourceGroup
Obligatoriska parametrar
API-revisionsidentifierare. Måste vara unikt i den aktuella API Management-tjänstinstansen. Icke-aktuell revision har ; rev=n som ett suffix där n är revisionsnumret. Required.
Namnet på api Management Service-instansen.
Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.
Valfria parametrar
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Vänta tills du har skapat med "provisioningState" på "Lyckades".
| Egenskap | Värde |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Standardvärde: | False |
Vänta tills villkoret uppfyller en anpassad JMESPath-fråga. T.ex. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
| Egenskap | Värde |
|---|---|
| Parameter group: | Wait Condition Arguments |
Vänta tills den har tagits bort.
| Egenskap | Värde |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Standardvärde: | False |
Vänta tills resursen finns.
| Egenskap | Värde |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Standardvärde: | False |
Avsökningsintervall i sekunder.
| Egenskap | Värde |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Standardvärde: | 30 |
Maximal väntetid i sekunder.
| Egenskap | Värde |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Standardvärde: | 3600 |
Vänta tills det har uppdaterats med provisioningState på Lyckades.
| Egenskap | Värde |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Standardvärde: | False |
Globala parametrar
Öka loggningsverositeten för att visa alla felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Visa det här hjälpmeddelandet och avsluta.
Visa bara fel och ignorera varningar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Utdataformat.
| Egenskap | Värde |
|---|---|
| Standardvärde: | json |
| Godkända värden: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.
Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.
Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |