Dela via


az apic

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

Hantera Azure API Center-tjänster.

Kommandon

Name Description Typ Status
az apic api

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

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

Skapar en instans eller uppdaterar en befintlig instans av en Azure API Center-tjänst.

Anknytning Allmän tillgänglighet
az apic delete

Tar bort en instans av en Azure API Center-tjänst.

Anknytning Allmän tillgänglighet
az apic environment

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

Anknytning Allmän tillgänglighet
az apic environment create

Skapa en ny miljö eller uppdatera en befintlig miljö.

Anknytning Allmän tillgänglighet
az apic environment delete

Ta bort miljön.

Anknytning Allmän tillgänglighet
az apic environment list

Visa en lista över en samling miljöer.

Anknytning Allmän tillgänglighet
az apic environment show

Få information om miljön.

Anknytning Allmän tillgänglighet
az apic environment update

Uppdatera befintlig miljö.

Anknytning Allmän tillgänglighet
az apic import-from-apim

Importerar API:er från en Azure API Management-tjänstinstans.

Anknytning Allmän tillgänglighet
az apic list

Visar en lista över Azure API Center-tjänster i en Azure-prenumeration.

Anknytning Allmän tillgänglighet
az apic metadata

Kommandon för att hantera metadatascheman i API Center.

Anknytning Allmän tillgänglighet
az apic metadata create

Skapa ett nytt metadataschema eller uppdatera ett befintligt metadataschema.

Anknytning Allmän tillgänglighet
az apic metadata delete

Ta bort angivet metadataschema.

Anknytning Allmän tillgänglighet
az apic metadata export

Exporterar metadataschemat.

Anknytning Allmän tillgänglighet
az apic metadata list

Lista en samling metadatascheman.

Anknytning Allmän tillgänglighet
az apic metadata show

Hämta information om metadataschemat.

Anknytning Allmän tillgänglighet
az apic metadata update

Uppdatera befintligt metadataschema.

Anknytning Allmän tillgänglighet
az apic show

Visa information om en Azure API Center-tjänstinstans.

Anknytning Allmän tillgänglighet
az apic update

Uppdatera en instans av en Azure API Center-tjänst.

Anknytning Allmän tillgänglighet

az apic create

Skapar en instans eller uppdaterar en befintlig instans av en Azure API Center-tjänst.

az apic create --name
               --resource-group
               [--identity]
               [--location]
               [--tags]

Exempel

Skapa tjänstexempel 1

az apic create -g contoso-resources -n contoso -l eastus

Skapa tjänstexempel 2

az apic create --resource-group contoso-resources --name contoso --location eastus

Obligatoriska parametrar

--name -n

Namnet på API Center-tjänsten.

--resource-group -g

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

Valfria parametrar

--identity

De hanterade tjänstidentiteter som tilldelats den här resursen. Stöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.

--location -l

Den geo-plats där resursen finns När den inte anges används platsen för resursgruppen.

--tags

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

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 delete

Tar bort en instans av en Azure API Center-tjänst.

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

Exempel

Ta bort tjänst

az apic delete -n contoso -g contoso-resources

Valfria parametrar

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

--name -n

Namnet på API Center-tjänsten.

--resource-group -g

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

--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 import-from-apim

Importerar API:er från en Azure API Management-tjänstinstans.

az apic import-from-apim --apim-apis
                         --apim-name
                         [--apim-resource-group]
                         [--apim-subscription]
                         [--ids]
                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                         [--resource-group]
                         [--service-name]
                         [--subscription]

Exempel

Importera alla API:er från APIM i samma resursgrupp

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-name contoso-apim --apim-apis *

Importera valda API:er från APIM i samma resursgrupp

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-name contoso-apim --apim-apis [echo,foo]

Importera alla API:er från APIM i en annan prenumeration och resursgrupp

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-subscription 00000000-0000-0000-0000-000000000000 --apim-resource-group apim-rg --apim-name contoso-apim --apim-apis *

Obligatoriska parametrar

--apim-apis

DE API:er som ska importeras. Stöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.

--apim-name

Namnet på APIM-källinstansen.

Valfria parametrar

--apim-resource-group

Resursgruppen för APIM-källinstansen.

--apim-subscription

Prenumerations-ID för APIM-källinstansen.

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

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 list

Visar en lista över Azure API Center-tjänster i en Azure-prenumeration.

Det finns ett känt problem med att lista alla resurser under en prenumeration inte fungerar. Ange resurser efter resursgrupp.

az apic list [--max-items]
             [--next-token]
             [--resource-group]

Exempel

Visa en lista över tjänster i resursgruppen

az apic list -g contoso-resources

Valfria parametrar

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

--resource-group -g

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

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 show

Visa information om en Azure API Center-tjänstinstans.

az apic show [--ids]
             [--name]
             [--resource-group]
             [--subscription]

Exempel

Visa tjänstinformation

az apic show -g contoso-resources -n contoso

Valfria parametrar

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

--name -n

Namnet på API Center-tjänsten.

--resource-group -g

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

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

Uppdatera en instans av en Azure API Center-tjänst.

az apic update [--add]
               [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
               [--identity]
               [--ids]
               [--name]
               [--remove]
               [--resource-group]
               [--set]
               [--subscription]
               [--tags]

Exempel

Uppdatera tjänstinformation

az apic update -g contoso-resources -n contoso

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

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

De hanterade tjänstidentiteter som tilldelats den här resursen. Stöd för shorthand-syntax, json-file och yaml-file. Prova "??" för att visa mer.

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

--name -n

Namnet på API Center-tjänsten.

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

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

--tags

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

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.