az apic api

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-kommando . Läs mer om tillägg.

Kommandon för att hantera API:er i API Center.

Kommandon

Name	Description	Typ	Status
az apic api create	Registrera ett nytt API eller uppdatera ett befintligt API.	Extension	GA
az apic api definition	Kommandon för att hantera API-definitioner i API Center.	Extension	GA
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 delete	Ta bort angivet API.	Extension	GA
az apic api deployment	Kommandon för att hantera API-distributioner i API Center.	Extension	GA
az apic api deployment create	Skapa en ny API-distribution eller uppdatera en befintlig API-distribution.	Extension	GA
az apic api deployment delete	Ta bort API-distribution.	Extension	GA
az apic api deployment list	Lista en samling API-distributioner.	Extension	GA
az apic api deployment show	Hämta information om API-distributionen.	Extension	GA
az apic api deployment update	Uppdatera befintlig API-distribution.	Extension	GA
az apic api list	Lista en samling API:er.	Extension	GA
az apic api register	Registrerar ett nytt API med version, definition och associerade distributioner med hjälp av specifikationsfilen som sanningskälla. För tillfället stöder vi endast OpenAPI JSON/YAML-format.	Extension	Preview
az apic api show	Hämta information om API:et.	Extension	GA
az apic api update	Uppdatera befintligt API.	Extension	GA
az apic api version	Kommandon för att hantera API-versioner i API Center.	Extension	GA
az apic api version create	Skapa en ny API-version eller uppdatera en befintlig API-version.	Extension	GA
az apic api version delete	Ta bort angiven API-version.	Extension	GA
az apic api version list	Visa en lista över en samling API-versioner.	Extension	GA
az apic api version show	Hämta information om API-versionen.	Extension	GA
az apic api version update	Uppdatera befintlig API-version.	Extension	GA

az apic api create

Registrera ett nytt API eller uppdatera ett befintligt API.

az apic api create --api-id
                   --resource-group
                   --service-name
                   --title
                   --type {graphql, grpc, rest, soap, webhook, websocket}
                   [--contacts]
                   [--custom-properties]
                   [--description]
                   [--external-documentation]
                   [--license]
                   [--summary]

Exempel

Skapa API

az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST

Skapa API med anpassade egenskaper

az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST --custom-properties '{"public-facing":true}'

Skapa API med anpassade egenskaper med hjälp av json-filen

az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST --custom-properties '@customProperties.json'

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.

--title

API-rubrik.

Egenskap	Värde
Parametergrupp:	Properties Arguments

--type

Typ av API.

Egenskap	Värde
Parametergrupp:	Properties Arguments
Godkända värden:	graphql, grpc, rest, soap, webhook, websocket

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.

--contacts

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

Egenskap	Värde
Parametergrupp:	Properties Arguments

--custom-properties

Anpassade metadata som definierats för API-katalogentiteter. Stöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.

Egenskap	Värde
Parametergrupp:	Properties Arguments

--description

Beskrivning av API:et.

Egenskap	Värde
Parametergrupp:	Properties Arguments

--external-documentation

Ytterligare extern dokumentation för API:et. Stöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.

Egenskap	Värde
Parametergrupp:	Properties Arguments

--license

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

Egenskap	Värde
Parametergrupp:	Properties Arguments

--summary

Kort beskrivning av API:et.

Egenskap	Värde
Parametergrupp:	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 delete

Ta bort angivet API.

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

Exempel

Ta bort API

az apic api delete -g contoso-resources -n contoso --api-id echo-api

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

ID:t för API:et.

Egenskap	Värde
Parametergrupp:	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
Parametergrupp:	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
Parametergrupp:	Resource Id Arguments

--service-name -n

Namnet på Azure API Center-tjänsten.

Egenskap	Värde
Parametergrupp:	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
Parametergrupp:	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 list

Lista en samling API:er.

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

Exempel

Lista API:er

az apic api list -g contoso-resources -n contoso

Lista API:er med filter

az apic api list -g contoso-resources -n contoso --filter "kind eq 'rest'"

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å Azure API Center-tjänsten.

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

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
Parametergrupp:	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
Parametergrupp:	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 register

Förhandsgranskning

Det här kommandot är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Registrerar ett nytt API med version, definition och associerade distributioner med hjälp av specifikationsfilen som sanningskälla. För tillfället stöder vi endast OpenAPI JSON/YAML-format.

az apic api register --api-location
                     --resource-group
                     --service-name
                     [--environment-id]

Exempel

Registrera API genom att ange specifikationsfil.

az apic api register -g api-center-test -n contosoeuap --api-location "examples/cli-examples/spec-examples/openai.json" --environment-id public
az apic api register -g api-center-test -n contosoeuap --api-location "examples/cli-examples/spec-examples/openai.yml" --environment-id public

Registrera API genom att ange specifikations-URL.

az apic api register -g api-center-test -n contosoeuap --api-location "https://petstore.swagger.io/v2/swagger.json" --environment-id public
az apic api register -g api-center-test -n contosoeuap --api-location "https://petstore.swagger.io/v2/swagger.yaml" --environment-id public

Obligatoriska parametrar

--api-location -l

Plats för specifikationsfil.

--resource-group -g

Namn på resursgrupp.

--service-name -n

APICenter-katalog eller tjänstnamn.

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.

--environment-id

ID för miljön som skapats tidigare.

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 show

Hämta information om API:et.

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

Exempel

Visa API-information

az apic api show -g contoso-resources -n contoso --api-id echo-api

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

ID:t för API:et.

Egenskap	Värde
Parametergrupp:	Resource Id Arguments

--ids

Egenskap	Värde
Parametergrupp:	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
Parametergrupp:	Resource Id Arguments

--service-name -n

Namnet på Azure API Center-tjänsten.

Egenskap	Värde
Parametergrupp:	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
Parametergrupp:	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 update

Uppdatera befintligt API.

az apic api update [--add]
                   [--api-id]
                   [--contacts]
                   [--custom-properties]
                   [--description]
                   [--external-documentation]
                   [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                   [--ids]
                   [--license]
                   [--remove]
                   [--resource-group]
                   [--service-name]
                   [--set]
                   [--subscription]
                   [--summary]
                   [--title]
                   [--type {graphql, grpc, rest, soap, webhook, websocket}]

Exempel

Uppdatera API

az apic api update -g contoso-resources -n contoso --api-id echo-api --summary "Basic REST API service"

Uppdatera anpassade egenskaper

az apic api update -g contoso-resources -n contoso --api-id echo-api --custom-properties '{"public-facing":true}'

Uppdatera anpassade egenskaper med hjälp av json-filen

az apic api update -g contoso-resources -n contoso --api-id echo-api --custom-properties '@customProperities.json'

Uppdatera enskilda anpassade metadata

az apic api update -g contoso-resources -n contoso --api-id echo-api --set customProperties.internal=false

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

--api-id

ID:t för API:et.

Egenskap	Värde
Parametergrupp:	Resource Id Arguments

--contacts

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

Egenskap	Värde
Parametergrupp:	Properties Arguments

--custom-properties

Anpassade metadata som definierats för API-katalogentiteter. Stöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.

Egenskap	Värde
Parametergrupp:	Properties Arguments

--description

Beskrivning av API:et.

Egenskap	Värde
Parametergrupp:	Properties Arguments

--external-documentation

Ytterligare extern dokumentation för API:et. Stöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.

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

--ids

Egenskap	Värde
Parametergrupp:	Resource Id Arguments

--license

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

Egenskap	Värde
Parametergrupp:	Properties Arguments

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

--resource-group -g

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

Egenskap	Värde
Parametergrupp:	Resource Id Arguments

--service-name -n

Namnet på Azure API Center-tjänsten.

Egenskap	Värde
Parametergrupp:	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
Parametergrupp:	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
Parametergrupp:	Resource Id Arguments

--summary

Kort beskrivning av API:et.

Egenskap	Värde
Parametergrupp:	Properties Arguments

--title

API-rubrik.

Egenskap	Värde
Parametergrupp:	Properties Arguments

--type

Typ av API.

Egenskap	Värde
Parametergrupp:	Properties Arguments
Godkända värden:	graphql, grpc, rest, soap, webhook, websocket

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

Kommandon

az apic api create

Exempel

Obligatoriska parametrar

Valfria parametrar

az apic api delete

Exempel

Valfria parametrar

az apic api list

Exempel

Obligatoriska parametrar

Valfria parametrar

az apic api register

Exempel

Obligatoriska parametrar

Valfria parametrar

az apic api show

Exempel

Valfria parametrar

az apic api update

Exempel

Valfria parametrar

Feedback