az apic api definition

Note

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.	Extension	GA
az apic api definition delete	Ta bort angiven API-definition.	Extension	GA
az apic api definition export-specification	Exporterar API-specifikationen.	Extension	GA
az apic api definition import-specification	Importerar API-specifikationen.	Extension	GA
az apic api definition list	Lista en samling API-definitioner.	Extension	GA
az apic api definition show	Hämta information om API-definitionen.	Extension	GA
az apic api definition update	Uppdatera befintlig API-definition.	Extension	GA

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

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

--service-name -n

Namnet på Azure API Center-tjänsten.

--title

API-version.

Egenskap	Värde
Parameter group:	Properties Arguments

--version-id

ID:t för API-versionen.

Valfria parametrar

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--description

Beskrivning av API-definition.

Egenskap	Värde
Parameter group:	Properties Arguments

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--api-id

ID:t för API:et.

Egenskap	Värde
Parameter group:	Resource Id Arguments

--definition-id

ID:t för API-definitionen.

Egenskap	Värde
Parameter group:	Resource Id Arguments

--ids

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

Egenskap	Värde
Parameter group:	Resource Id Arguments

--resource-group -g

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

Egenskap	Värde
Parameter group:	Resource Id Arguments

--service-name -n

Namnet på Azure API Center-tjänsten.

Egenskap	Värde
Parameter group:	Resource Id Arguments

--subscription

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

Egenskap	Värde
Parameter group:	Resource Id Arguments

--version-id

ID:t för API-versionen.

Egenskap	Värde
Parameter group:	Resource Id Arguments

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

--verbose

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

Egenskap	Värde
Standardvärde:	False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--api-id

ID:t för API:et.

Egenskap	Värde
Parameter group:	Resource Id Arguments

--definition-id

ID:t för API-definitionen.

Egenskap	Värde
Parameter group:	Resource Id Arguments

--ids

Egenskap	Värde
Parameter group:	Resource Id Arguments

--no-wait

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

Egenskap	Värde
Godkända värden:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

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

Egenskap	Värde
Parameter group:	Resource Id Arguments

--service-name -n

Namnet på Azure API Center-tjänsten.

Egenskap	Värde
Parameter group:	Resource Id Arguments

--subscription

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

Egenskap	Värde
Parameter group:	Resource Id Arguments

--version-id

ID:t för API-versionen.

Egenskap	Värde
Parameter group:	Resource Id Arguments

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.

--verbose

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

Egenskap	Värde
Standardvärde:	False

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://petstore3.swagger.io/api/v3/openapi.json' --specification '{"name":"openapi","version":"3.0.0"}'

Importera specifikation från filexempel

az apic api definition import-specification -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-08-01 --definition-id openapi --format "inline" --value '@petstore.json'

Obligatoriska parametrar

--format

Format för API-specifikationskällan.

Egenskap	Värde
Parameter group:	Payload Arguments
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.

Egenskap	Värde
Parameter group:	Payload Arguments

--value

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

Egenskap	Värde
Parameter group:	Payload Arguments

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

ID:t för API:et.

Egenskap	Värde
Parameter group:	Resource Id Arguments

--definition-id

ID:t för API-definitionen.

Egenskap	Värde
Parameter group:	Resource Id Arguments

--ids

Egenskap	Värde
Parameter group:	Resource Id Arguments

--no-wait

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

Egenskap	Värde
Godkända värden:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

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

Egenskap	Värde
Parameter group:	Resource Id Arguments

--service-name -n

Namnet på Azure API Center-tjänsten.

Egenskap	Värde
Parameter group:	Resource Id Arguments

--subscription

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

Egenskap	Värde
Parameter group:	Resource Id Arguments

--version-id

ID:t för API-versionen.

Egenskap	Värde
Parameter group:	Resource Id Arguments

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.

--verbose

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

Egenskap	Värde
Standardvärde:	False

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

Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av 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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--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 argument för ett efterföljande kommando.

Egenskap	Värde
Parameter group:	Pagination Arguments

--next-token

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

Egenskap	Värde
Parameter group:	Pagination Arguments

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--api-id

ID:t för API:et.

Egenskap	Värde
Parameter group:	Resource Id Arguments

--definition-id

ID:t för API-definitionen.

Egenskap	Värde
Parameter group:	Resource Id Arguments

--ids

Egenskap	Värde
Parameter group:	Resource Id Arguments

--resource-group -g

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

Egenskap	Värde
Parameter group:	Resource Id Arguments

--service-name -n

Namnet på Azure API Center-tjänsten.

Egenskap	Värde
Parameter group:	Resource Id Arguments

--subscription

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

Egenskap	Värde
Parameter group:	Resource Id Arguments

--version-id

ID:t för API-versionen.

Egenskap	Värde
Parameter group:	Resource Id Arguments

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.

--verbose

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

Egenskap	Värde
Standardvärde:	False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--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
Parameter group:	Generic Update Arguments

--api-id

ID:t för API:et.

Egenskap	Värde
Parameter group:	Resource Id Arguments

--definition-id

ID:t för API-definitionen.

Egenskap	Värde
Parameter group:	Resource Id Arguments

--description

Beskrivning av API-definition.

Egenskap	Värde
Parameter group:	Properties 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
Parameter group:	Generic Update Arguments
Godkända värden:	0, 1, f, false, n, no, t, true, y, yes

--ids

Egenskap	Värde
Parameter group:	Resource Id Arguments

--remove

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

--resource-group -g

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

Egenskap	Värde
Parameter group:	Resource Id Arguments

--service-name -n

Namnet på Azure API Center-tjänsten.

Egenskap	Värde
Parameter group:	Resource Id 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
Parameter group:	Generic Update Arguments

--subscription

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

Egenskap	Värde
Parameter group:	Resource Id Arguments

--title

API-versionsrubrik.

Egenskap	Värde
Parameter group:	Properties Arguments

--version-id

ID:t för API-versionen.

Egenskap	Värde
Parameter group:	Resource Id Arguments

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.

--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 apic api definition

Kommandon

az apic api definition create

Exempel

Obligatoriska parametrar

Valfria parametrar

az apic api definition delete

Exempel

Valfria parametrar

az apic api definition export-specification

Exempel

Obligatoriska parametrar

Valfria parametrar

az apic api definition import-specification

Exempel

Obligatoriska parametrar

Valfria parametrar

az apic api definition list

Exempel

Obligatoriska parametrar

Valfria parametrar

az apic api definition show

Exempel

Valfria parametrar

az apic api definition update

Exempel

Valfria parametrar

Feedback