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

Redigera

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

--api-id

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
Parametergrupp:	API Arguments

--display-name

Visningsnamn för api:et som ska skapas.

Egenskap	Värde
Parametergrupp:	API Arguments

--path

Sökväg till API:et.

Egenskap	Värde
Parametergrupp:	API Arguments

--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

--service-name -n

Namnet på API Management-tjänstinstansen.

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--api-type

Typen av API.

Egenskap	Värde
Parametergrupp:	API Arguments
Godkända värden:	graphql, http, soap, websocket

--authorization-scope

Anger omfånget för OAuth-åtgärder.

--authorization-server-id

Anger OAuth-auktoriseringsserverns ID.

--bearer-token-sending-methods

Anger sändningsmetoderna för ägartoken.

--description

Beskrivning av API:et. Kan innehålla HTML-formateringstaggar.

Egenskap	Värde
Parametergrupp:	API Arguments

--no-wait

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

Egenskap	Värde
Standardvärde:	False

--open-id-provider-id

Anger openid i autentiseringsinställningen.

--protocols

Beskriver vilka protokoll som åtgärderna i det här API:et kan anropas för.

Egenskap	Värde
Parametergrupp:	API Arguments
Godkända värden:	http, https, ws, wss

--service-url

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
Parametergrupp:	API Arguments

--subscription-key-header-name

Anger namnet på prenumerationsnyckelns huvud.

Egenskap	Värde
Parametergrupp:	API Arguments

--subscription-key-query-param-name

Anger parameternamnet för frågesträngen för prenumerationsnyckeln.

Egenskap	Värde
Parametergrupp:	API Arguments

--subscription-key-required

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.

--subscription-required

Om det är sant kräver API:et en prenumerationsnyckel för begäranden.

Egenskap	Värde
Parametergrupp:	API Arguments
Standardvärde:	False
Godkända värden:	false, true

Globala parametrar

--debug

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

Egenskap	Värde
Standardvärde:	False

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap	Värde
Standardvärde:	False

--output -o

Utdataformat.

Egenskap	Värde
Standardvärde:	json
Godkända värden:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

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

Egenskap	Värde
Standardvärde:	False

az apim api delete

Redigera

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

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
Parametergrupp:	API Arguments

--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

--service-name -n

Namnet på API Management-tjänstinstansen.

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--delete-revisions

Ta bort alla revisioner av API:et.

--if-match

ETag för entiteten.

--no-wait

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

Egenskap	Värde
Standardvärde:	False

--yes -y

Fråga inte efter bekräftelse.

Egenskap	Värde
Standardvärde:	False

Globala parametrar

--debug

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

Egenskap	Värde
Standardvärde:	False

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap	Värde
Standardvärde:	False

--output -o

Utdataformat.

Egenskap	Värde
Standardvärde:	json
Godkända värden:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

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

Egenskap	Värde
Standardvärde:	False

az apim api export

Redigera

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

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
Parametergrupp:	API Arguments

--ef --export-format

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

--resource-group -g

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

--service-name -n

Namnet på api Management Service-instansen.

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--file-path -f

Filsökväg som angetts för att exportera API:et.

Globala parametrar

--debug

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

Egenskap	Värde
Standardvärde:	False

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap	Värde
Standardvärde:	False

--output -o

Utdataformat.

Egenskap	Värde
Standardvärde:	json
Godkända värden:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

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

Egenskap	Värde
Standardvärde:	False

az apim api import

Redigera

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

--path

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
Parametergrupp:	API Arguments

--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

--service-name -n

Namnet på api Management Service-instansen.

--specification-format

Ange formatet för det importerade API:et.

Egenskap	Värde
Godkända värden:	GraphQL, OpenApi, OpenApiJson, Swagger, Wadl, Wsdl

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--api-id

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
Parametergrupp:	API Arguments

--api-revision

Beskriver revisionen av API:et. Om inget värde anges skapas standardrevision 1.

Egenskap	Värde
Parametergrupp:	API Arguments

--api-type

Typen av API.

Egenskap	Värde
Parametergrupp:	API Arguments
Godkända värden:	graphql, http, soap, websocket

--api-version

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
Parametergrupp:	API Arguments

--api-version-set-id

Beskriver den versionsuppsättning som ska användas med API:et.

Egenskap	Värde
Parametergrupp:	API Arguments

--description

Beskrivning av API:et. Kan innehålla HTML-formateringstaggar.

Egenskap	Värde
Parametergrupp:	API Arguments

--display-name

Visningsnamn för det här API:et.

Egenskap	Värde
Parametergrupp:	API Arguments

--no-wait

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

Egenskap	Värde
Standardvärde:	False

--protocols

Beskriver vilka protokoll(en eller flera) som åtgärderna i det här API:et kan anropas för.

Egenskap	Värde
Parametergrupp:	API Arguments
Godkända värden:	http, https, ws, wss

--service-url

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
Parametergrupp:	API Arguments

--soap-api-type

Typen av API när filformatet är WSDL.

--specification-path

Filsökväg som angetts för att importera API:et.

--specification-url

Url som angetts för att importera API:et.

--subscription-key-header-name

Anger namnet på prenumerationsnyckelns huvud.

Egenskap	Värde
Parametergrupp:	API Arguments

--subscription-key-query-param-name

Anger parameternamnet för frågesträngen för prenumerationsnyckeln.

Egenskap	Värde
Parametergrupp:	API Arguments

--subscription-required

Om det är sant kräver API:et en prenumerationsnyckel för begäranden.

Egenskap	Värde
Parametergrupp:	API Arguments
Godkända värden:	false, true

--wsdl-endpoint-name

Lokalt namn på den WSDL-slutpunkt (port) som ska importeras.

--wsdl-service-name

Lokalt namn på WSDL-tjänsten som ska importeras.

Globala parametrar

--debug

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

Egenskap	Värde
Standardvärde:	False

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap	Värde
Standardvärde:	False

--output -o

Utdataformat.

Egenskap	Värde
Standardvärde:	json
Godkända värden:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

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

Egenskap	Värde
Standardvärde:	False

az apim api list

Redigera

Lista API Management API:er.

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

Obligatoriska parametrar

--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

--service-name -n

Namnet på API Management-tjänstinstansen.

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--filter-display-name

Filter för API:er efter displayName.

Egenskap	Värde
Parametergrupp:	API Arguments

--skip

Antal poster att hoppa över.

--top

Antal poster som ska returneras.

Globala parametrar

--debug

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

Egenskap	Värde
Standardvärde:	False

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap	Värde
Standardvärde:	False

--output -o

Utdataformat.

Egenskap	Värde
Standardvärde:	json
Godkända värden:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

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

Egenskap	Värde
Standardvärde:	False

az apim api show

Redigera

Visa information om ett API Management-API.

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

Obligatoriska parametrar

--api-id

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
Parametergrupp:	API Arguments

--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

--service-name

Namnet på API Management-tjänstinstansen.

Globala parametrar

--debug

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

Egenskap	Värde
Standardvärde:	False

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap	Värde
Standardvärde:	False

--output -o

Utdataformat.

Egenskap	Värde
Standardvärde:	json
Godkända värden:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

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

Egenskap	Värde
Standardvärde:	False

az apim api update

Redigera

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

--api-id

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
Parametergrupp:	API Arguments

--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

--service-name -n

Namnet på API Management-tjänstinstansen.

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

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

Egenskap	Värde
Parametergrupp:	Generic Update Arguments
Standardvärde:	[]

--api-type

Typen av API.

Egenskap	Värde
Parametergrupp:	API Arguments
Godkända värden:	graphql, http, soap, websocket

--description

Beskrivning av API:et. Kan innehålla HTML-formateringstaggar.

Egenskap	Värde
Parametergrupp:	API Arguments

--display-name

API-namn. Måste vara mellan 1 och 300 tecken långt.

Egenskap	Värde
Parametergrupp:	API Arguments

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

Egenskap	Värde
Parametergrupp:	Generic Update Arguments
Standardvärde:	False

--if-match

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.

--no-wait

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

Egenskap	Värde
Standardvärde:	False

--path

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
Parametergrupp:	API Arguments

--protocols

Beskriver vilka protokoll som åtgärderna i det här API:et kan anropas för.

Egenskap	Värde
Parametergrupp:	API Arguments
Godkända värden:	http, https, ws, wss

--remove

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

Egenskap	Värde
Parametergrupp:	Generic Update Arguments
Standardvärde:	[]

--service-url

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
Parametergrupp:	API Arguments

--set

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
Parametergrupp:	Generic Update Arguments
Standardvärde:	[]

--subscription-key-header-name

Anger namnet på prenumerationsnyckelns huvud.

Egenskap	Värde
Parametergrupp:	API Arguments

--subscription-key-query-param-name

Anger parameternamnet för frågesträngen för prenumerationsnyckeln.

Egenskap	Värde
Parametergrupp:	API Arguments

--subscription-required

Om det är sant kräver API:et en prenumerationsnyckel för begäranden.

Egenskap	Värde
Parametergrupp:	API Arguments
Godkända värden:	false, true

--tags

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

Globala parametrar

--debug

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

Egenskap	Värde
Standardvärde:	False

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap	Värde
Standardvärde:	False

--output -o

Utdataformat.

Egenskap	Värde
Standardvärde:	json
Godkända värden:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

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

Egenskap	Värde
Standardvärde:	False

az apim api wait

Redigera

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

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.

--name -n

Namnet på api Management Service-instansen.

--resource-group -g

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--created

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

Egenskap	Värde
Parametergrupp:	Wait Condition Arguments
Standardvärde:	False

--custom

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

Egenskap	Värde
Parametergrupp:	Wait Condition Arguments

--deleted

Vänta tills den har tagits bort.

Egenskap	Värde
Parametergrupp:	Wait Condition Arguments
Standardvärde:	False

--exists

Vänta tills resursen finns.

Egenskap	Värde
Parametergrupp:	Wait Condition Arguments
Standardvärde:	False

--interval

Avsökningsintervall i sekunder.

Egenskap	Värde
Parametergrupp:	Wait Condition Arguments
Standardvärde:	30

--timeout

Maximal väntetid i sekunder.

Egenskap	Värde
Parametergrupp:	Wait Condition Arguments
Standardvärde:	3600

--updated

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

Egenskap	Värde
Parametergrupp:	Wait Condition Arguments
Standardvärde:	False

Globala parametrar

--debug

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

Egenskap	Värde
Standardvärde:	False

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap	Värde
Standardvärde:	False

--output -o

Utdataformat.

Egenskap	Värde
Standardvärde:	json
Godkända värden:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

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

Egenskap	Värde
Standardvärde:	False

Feedback

Var den här sidan till hjälp?

Dela via

az apim api

Kommandon

az apim api create

Exempel

Obligatoriska parametrar

Valfria parametrar

az apim api delete

Obligatoriska parametrar

Valfria parametrar

az apim api export

Exempel

Obligatoriska parametrar

Valfria parametrar

az apim api import

Exempel

Obligatoriska parametrar

Valfria parametrar

az apim api list

Obligatoriska parametrar

Valfria parametrar

az apim api show

Obligatoriska parametrar

az apim api update

Exempel

Obligatoriska parametrar

Valfria parametrar

az apim api wait

Exempel

Obligatoriska parametrar

Valfria parametrar

Feedback