Dela via

az apic api

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

 Anknytning Allmän tillgänglighet
az apic api definition

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

 Anknytning Allmän tillgänglighet
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 delete

Ta bort angivet API.

 Anknytning Allmän tillgänglighet
az apic api deployment

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

 Anknytning Allmän tillgänglighet
az apic api deployment create

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

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

Ta bort API-distribution.

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

Lista en samling API-distributioner.

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

Hämta information om API-distributionen.

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

Uppdatera befintlig API-distribution.

 Anknytning Allmän tillgänglighet
az apic api list

Lista en samling API:er.

 Anknytning Allmän tillgänglighet
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.

 Anknytning Förhandsversion
az apic api show

Hämta information om API:et.

 Anknytning Allmän tillgänglighet
az apic api update

Uppdatera befintligt API.

 Anknytning Allmän tillgänglighet
az apic api version

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

 Anknytning Allmän tillgänglighet
az apic api version create

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

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

Ta bort angiven API-version.

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

Visa en lista över en samling API-versioner.

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

Hämta information om API-versionen.

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

Uppdatera befintlig API-version.

 Anknytning Allmän tillgänglighet

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

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.

--title

API-rubrik.

--type

Typ av API.

Godkända värden: graphql, grpc, rest, soap, webhook, websocket

Valfria parametrar

--contacts

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

--custom-properties

Anpassade metadata som definierats för API-katalogentiteter. Stöd för json-file och yaml-file.

--description

Beskrivning av API:et.

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

--license

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

--summary

Kort beskrivning av API:et.

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

--api-id

ID:t för API:et.

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

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

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

--service-name -n

Namnet på Azure API Center-tjänsten.

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

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

--environment-id

ID för miljön som skapats tidigare.

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

--api-id

ID:t för API:et.

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

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

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.

--contacts

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

--custom-properties

Anpassade metadata som definierats för API-katalogentiteter. Stöd för json-file och yaml-file.

--description

Beskrivning av API:et.

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

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

--license

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

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

--summary

Kort beskrivning av API:et.

--title

API-rubrik.

--type

Typ av API.

Godkända värden: graphql, grpc, rest, soap, webhook, websocket
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.