Dela via

az apic api definition

  • Referens

Kommentar

Den här referensen är en del av tillägget apic-extension för Azure CLI (version 2.57.0 eller senare). Tillägget installeras automatiskt första gången du kör ett az apic API-definitionskommando . Läs mer om tillägg.

Kommandon för att hantera API-definitioner i API Center.

Kommandon

Name Description Typ Status
az apic api definition create

Skapa en ny API-definition eller uppdatera en befintlig API-definition.

 Anknytning Allmän tillgänglighet
az apic api definition delete

Ta bort angiven API-definition.

 Anknytning Allmän tillgänglighet
az apic api definition export-specification

Exporterar API-specifikationen.

 Anknytning Allmän tillgänglighet
az apic api definition import-specification

Importerar API-specifikationen.

 Anknytning Allmän tillgänglighet
az apic api definition list

Lista en samling API-definitioner.

 Anknytning Allmän tillgänglighet
az apic api definition show

Hämta information om API-definitionen.

 Anknytning Allmän tillgänglighet
az apic api definition update

Uppdatera befintlig API-definition.

 Anknytning Allmän tillgänglighet

az apic api definition create

Skapa en ny API-definition eller uppdatera en befintlig API-definition.

az apic api definition create --api-id
                              --definition-id
                              --resource-group
                              --service-name
                              --title
                              --version-id
                              [--description]

Exempel

Skapa API-definition

az apic api definition create -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi" --title "OpenAPI"

Obligatoriska parametrar

--api-id

ID:t för API:et.

--definition-id

ID:t för API-definitionen.

--resource-group -g

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

--service-name -n

Namnet på Azure API Center-tjänsten.

--title

API-version.

--version-id

ID:t för API-versionen.

Valfria parametrar

--description

Beskrivning av API-definition.

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.

Godkända 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 apic api definition delete

Ta bort angiven API-definition.

az apic api definition delete [--api-id]
                              [--definition-id]
                              [--ids]
                              [--resource-group]
                              [--service-name]
                              [--subscription]
                              [--version-id]
                              [--yes]

Exempel

Ta bort API-definition

az apic api definition delete -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi"

Valfria parametrar

--api-id

ID:t för API:et.

--definition-id

ID:t för API-definitionen.

--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om argumenten "Resurs-ID". Du bör ange antingen --id eller andra "Resurs-ID"-argument.

--resource-group -g

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

--service-name -n

Namnet på Azure API Center-tjänsten.

--subscription

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

--version-id

ID:t för API-versionen.

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

Godkända 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 apic api definition export-specification

Exporterar API-specifikationen.

az apic api definition export-specification --file-name
                                            [--api-id]
                                            [--definition-id]
                                            [--ids]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--resource-group]
                                            [--service-name]
                                            [--subscription]
                                            [--version-id]

Exempel

Exportspecifikation

az apic api definition export-specification -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id default --file-name filename.json

Obligatoriska parametrar

--file-name

Namnet på filen där specifikationen ska exporteras till.

Valfria parametrar

--api-id

ID:t för API:et.

--definition-id

ID:t för API-definitionen.

--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om argumenten "Resurs-ID". Du bör ange antingen --id eller andra "Resurs-ID"-argument.

--no-wait

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

Godkända värden: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

--service-name -n

Namnet på Azure API Center-tjänsten.

--subscription

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

--version-id

ID:t för API-versionen.

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.

Godkända 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 apic api definition import-specification

Importerar API-specifikationen.

az apic api definition import-specification --format {inline, link}
                                            --specification
                                            --value
                                            [--api-id]
                                            [--definition-id]
                                            [--ids]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--resource-group]
                                            [--service-name]
                                            [--subscription]
                                            [--version-id]

Exempel

Exempel på importspecifikation 1

az apic api definition import-specification -g api-center-test -n contosoeuap --api-id echo-api-2 --version-id 2023-08-01 --definition-id openapi3 --format "inline" --value '{"openapi":"3.0.1","info":{"title":"httpbin.org","description":"API Management facade for a very handy and free online HTTP tool.","version":"1.0"}}' --specification '{"name":"openapi","version":"3.0.0"}'

Exempel på importspecifikation 2

az apic api definition import-specification -g api-center-test -n contoso --api-id echo-api --version-id 2023-11-01 --definition-id openapi --format "link" --value 'https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json' --specification '{"name":"openapi","version":"3.0.0"}'

Obligatoriska parametrar

--format

Format för API-specifikationskällan.

Godkända värden: inline, link
--specification

API-specifikationsinformation. Stöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.

--value

Värdet för API-specifikationskällan.

Valfria parametrar

--api-id

ID:t för API:et.

--definition-id

ID:t för API-definitionen.

--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om argumenten "Resurs-ID". Du bör ange antingen --id eller andra "Resurs-ID"-argument.

--no-wait

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

Godkända värden: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

--service-name -n

Namnet på Azure API Center-tjänsten.

--subscription

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

--version-id

ID:t för API-versionen.

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.

Godkända 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 apic api definition list

Lista en samling API-definitioner.

az apic api definition list --api-id
                            --resource-group
                            --service-name
                            --version-id
                            [--filter]
                            [--max-items]
                            [--next-token]

Exempel

Lista API-definitioner

az apic api definition list -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01

Obligatoriska parametrar

--api-id

ID:t för API:et.

--resource-group -g

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

--service-name -n

Namnet på Azure API Center-tjänsten.

--version-id

ID:t för API-versionen.

Valfria parametrar

--filter

OData-filterparameter.

--max-items

Totalt antal objekt som ska returneras i kommandots utdata. Om det totala antalet tillgängliga objekt är mer än det angivna värdet anges en token i kommandots utdata. Om du vill återuppta sidnumreringen anger du tokenvärdet i --next-token argumentet för ett efterföljande kommando.

--next-token

Token för att ange var sidnumrering ska börja. Detta är tokenvärdet från ett tidigare trunkerat svar.

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.

Godkända 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 apic api definition show

Hämta information om API-definitionen.

az apic api definition show [--api-id]
                            [--definition-id]
                            [--ids]
                            [--resource-group]
                            [--service-name]
                            [--subscription]
                            [--version-id]

Exempel

Visa API-definitionsinformation

az apic api definition show -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi"

Valfria parametrar

--api-id

ID:t för API:et.

--definition-id

ID:t för API-definitionen.

--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om argumenten "Resurs-ID". Du bör ange antingen --id eller andra "Resurs-ID"-argument.

--resource-group -g

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

--service-name -n

Namnet på Azure API Center-tjänsten.

--subscription

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

--version-id

ID:t för API-versionen.

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.

Godkända 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 apic api definition update

Uppdatera befintlig API-definition.

az apic api definition update [--add]
                              [--api-id]
                              [--definition-id]
                              [--description]
                              [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                              [--ids]
                              [--remove]
                              [--resource-group]
                              [--service-name]
                              [--set]
                              [--subscription]
                              [--title]
                              [--version-id]

Exempel

Uppdatera API-definition

az apic api definition update -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi" --title "OpenAPI"

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 eller JSON string>.

--api-id

ID:t för API:et.

--definition-id

ID:t för API-definitionen.

--description

Beskrivning av API-definition.

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

Godkända värden: 0, 1, f, false, n, no, t, true, y, yes
--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om argumenten "Resurs-ID". Du bör ange antingen --id eller andra "Resurs-ID"-argument.

--remove

Ta bort en egenskap eller ett element från en lista. Exempel: --remove property.list OR --remove propertyToRemove.

--resource-group -g

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

--service-name -n

Namnet på Azure API Center-tjänsten.

--set

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

--subscription

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

--title

API-versionsrubrik.

--version-id

ID:t för API-versionen.

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.

Godkända 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.