Dela via

az apim api schema

  • Referens

Hantera API-scheman för Azure API Management.

Kommandon

Name Description Typ Status
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 schema create

Redigera

Skapa ett API Management API-schema.

az apim api schema create --api-id
                          --resource-group
                          --schema-id
                          --schema-type
                          --service-name
                          [--no-wait]
                          [--resource-type]
                          [--schema-content]
                          [--schema-name]
                          [--schema-path]

Exempel

Skapa ett API-schema.

az apim api schema create --service-name MyApim -g MyResourceGroup --api-id MyApi --schema-id schemaId --schema-type schemaType --schema-path schemaFilePath

Obligatoriska parametrar

--api-id

Unikt namn på api:et som schemat måste skapas för.

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.

--resource-group -g

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

--schema-id

Unikt namn på det API-schema som ska skapas.

Schemaidentifierare. Måste vara unikt i den aktuella API Management-tjänstinstansen.

--schema-type

Schematyp (t.ex. application/json, application/vnd.ms-azure-apim.graphql.schema).

Måste vara en giltig medietyp som används i ett content-type-huvud enligt definitionen i RFC 2616. Medietyp för schemadokumentet.

--service-name -n

Namnet på API Management-tjänstinstansen.

Valfria parametrar

--no-wait

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

standardvärde: False
--resource-type

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts".

--schema-content

Json-undantagen sträng som definierar dokumentet som representerar schemat.

Ange antingen --schema-path eller --schema-content inte båda.

--schema-name

Namnet på schemaresursen.

--schema-path

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

Ange antingen --schema-path eller --schema-content inte båda.

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 api schema delete

Redigera

Ta bort ett API Management API-schema.

az apim api schema delete --api-id
                          --resource-group
                          --schema-id
                          --service-name
                          [--if-match]
                          [--no-wait]
                          [--yes]

Exempel

ta bort ett API-schema.

az apim api schema delete --service-name MyApim -g MyResourceGroup --api-id MyApi --schema-id schemaId

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.

--resource-group -g

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

--schema-id

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

--service-name -n

Namnet på API Management-tjänstinstansen.

Valfria parametrar

--if-match

ETag för entiteten.

--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 api schema get-etag

Redigera

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

az apim api schema get-etag --api-id
                            --resource-group
                            --schema-id
                            --service-name

Exempel

hämta en schemaentitetstagg.

az apim api schema get-etag --service-name MyApim -g MyResourceGroup --api-id MyApi --schema-id schemaId

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.

--resource-group -g

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

--schema-id

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

--service-name -n

Namnet på API Management-tjänstinstansen.

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

Redigera

Lista API Management API-scheman.

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

Exempel

Hämta en lista över scheman som är associerade med ett API-ID.

az apim api schema list --service-name MyApim -g MyResourceGroup --api-id MyApi

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.

--resource-group -g

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

--service-name -n

Namnet på API Management-tjänstinstansen.

Valfria parametrar

--filter-display-name

Filter för API:er efter displayName.

--skip

Antal poster att hoppa över.

--top

Antal poster som ska returneras.

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 api schema show

Redigera

Visa information om ett API Management API-schema.

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

Exempel

Hämta ett API-schema.

az apim api schema show --service-name MyApim -g MyResourceGroup --api-id MyApi --schema-id schemaId

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.

--resource-group -g

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

--schema-id

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

--service-name -n

Namnet på API Management-tjänstinstansen.

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 api schema wait

Redigera

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

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

Exempel

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

az apim api schema wait --created --api-id MyApi --name MyApim --schema-id schemaId -g 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. Obligatoriska.

--name -n

Namnet på api Management Service-instansen.

--resource-group -g

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

--schema-id

Schema-ID-identifierare. Måste vara unikt i den aktuella API Management-tjänstinstansen. Obligatoriska.

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.