Sdílet prostřednictvím

az apic api deployment

Note

Tento odkaz je součástí rozšíření apic-extension pro Azure CLI (verze 2.57.0 nebo vyšší). Rozšíření se automaticky nainstaluje při prvním spuštění příkazu az apic api deployment. Přečtěte si další informace o rozšířeních.

Příkazy pro správu nasazení rozhraní API v centru API.

Příkazy

Name Description Typ Stav
az apic api deployment create

Vytvořte nové nasazení rozhraní API nebo aktualizujte existující nasazení rozhraní API.

 Extension GA
az apic api deployment delete

Odstranění nasazení rozhraní API

 Extension GA
az apic api deployment list

Vypíše kolekci nasazení rozhraní API.

 Extension GA
az apic api deployment show

Získejte podrobnosti o nasazení rozhraní API.

 Extension GA
az apic api deployment update

Aktualizujte existující nasazení rozhraní API.

 Extension GA

az apic api deployment create

Vytvořte nové nasazení rozhraní API nebo aktualizujte existující nasazení rozhraní API.

az apic api deployment create --api-id
                              --definition-id
                              --deployment-id
                              --environment-id
                              --resource-group
                              --server
                              --service-name
                              --title
                              [--custom-properties]
                              [--description]

Příklady

Vytvořit nasazení

az apic api deployment create -g api-center-test -n contoso --deployment-id production --title "Production deployment" --description "Public cloud production deployment." --api-id echo-api --environment-id "/workspaces/default/environments/production" --definition-id "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi" --server '{"runtimeUri":["https://example.com"]}'

Vytvoření nasazení pomocí souboru JSON serveru

az apic api deployment create -g api-center-test -n contoso --deployment-id production --title "Production deployment" --description "Public cloud production deployment." --api-id echo-api --environment-id "/workspaces/default/environments/production" --definition-id "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi" --server '@server.json'

Povinné parametry

--api-id

ID rozhraní API.

--definition-id

ID prostředku prostředku definice v rámci centra rozhraní API

Vlastnost Hodnota
Skupina parametrů: Properties Arguments
--deployment-id

ID nasazení rozhraní API.

--environment-id

ID prostředku prostředí v rámci centra rozhraní API

Vlastnost Hodnota
Skupina parametrů: Properties Arguments
--resource-group -g

Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--server

Server podporuje zkratku syntaxe, json-file a yaml-file. Zkuste "??" zobrazit více.

Vlastnost Hodnota
Skupina parametrů: Properties Arguments
--service-name -n

Název služby Azure API Center.

--title

Název nasazení

Vlastnost Hodnota
Skupina parametrů: Properties Arguments

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--custom-properties

Vlastní metadata definovaná pro entity katalogu rozhraní API. Podpora zkratky syntaxe, json-file a yaml-file Zkuste "??" zobrazit více.

Vlastnost Hodnota
Skupina parametrů: Properties Arguments
--description

Popis nasazení

Vlastnost Hodnota
Skupina parametrů: Properties Arguments
Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost Hodnota
Default value: False
--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost Hodnota
Default value: False
--output -o

Výstupní formát

Vlastnost Hodnota
Default value: json
Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost Hodnota
Default value: False

az apic api deployment delete

Odstranění nasazení rozhraní API

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

Příklady

Odstranění nasazení rozhraní API

az apic api deployment delete -g api-center-test -n contoso --deployment-id production --api-id echo-api

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--api-id

ID rozhraní API.

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
--deployment-id

ID nasazení rozhraní API.

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
--ids

Jedno nebo více ID prostředků (oddělené mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat buď argumenty --ids, nebo jiné argumenty 'ID prostředku'.

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
--resource-group -g

Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
--service-name -n

Název služby Azure API Center.

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
--yes -y

Nevyzývejte k potvrzení.

Vlastnost Hodnota
Default value: False
Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost Hodnota
Default value: False
--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost Hodnota
Default value: False
--output -o

Výstupní formát

Vlastnost Hodnota
Default value: json
Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost Hodnota
Default value: False

az apic api deployment list

Vypíše kolekci nasazení rozhraní API.

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

Příklady

Výpis nasazení rozhraní API

az apic api deployment list -g api-center-test -n contoso --api-id echo-api

Povinné parametry

--api-id

ID rozhraní API.

--resource-group -g

Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--service-name -n

Název služby Azure API Center.

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--filter

Parametr filtru OData.

--max-items

Celkový počet položek, které se mají vrátit ve výstupu příkazu Pokud je celkový počet dostupných položek větší než zadaná hodnota, zobrazí se ve výstupu příkazu token. Pokud chcete pokračovat ve stránkování, zadejte hodnotu tokenu v --next-token argumentu následného příkazu.

Vlastnost Hodnota
Skupina parametrů: Pagination Arguments
--next-token

Token určující, kde se má stránkování spustit. Toto je hodnota tokenu z dříve zkrácené odpovědi.

Vlastnost Hodnota
Skupina parametrů: Pagination Arguments
Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost Hodnota
Default value: False
--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost Hodnota
Default value: False
--output -o

Výstupní formát

Vlastnost Hodnota
Default value: json
Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost Hodnota
Default value: False

az apic api deployment show

Získejte podrobnosti o nasazení rozhraní API.

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

Příklady

Zobrazení podrobností o nasazení rozhraní API

az apic api deployment show -g api-center-test -n contoso --deployment-id production --api-id echo-api

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--api-id

ID rozhraní API.

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
--deployment-id

ID nasazení rozhraní API.

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
--ids

Jedno nebo více ID prostředků (oddělené mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat buď argumenty --ids, nebo jiné argumenty 'ID prostředku'.

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
--resource-group -g

Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
--service-name -n

Název služby Azure API Center.

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost Hodnota
Default value: False
--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost Hodnota
Default value: False
--output -o

Výstupní formát

Vlastnost Hodnota
Default value: json
Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost Hodnota
Default value: False

az apic api deployment update

Aktualizujte existující nasazení rozhraní API.

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

Příklady

Aktualizace nasazení rozhraní API

az apic api deployment update -g api-center-test -n contoso --deployment-id production --title "Production deployment" --api-id echo-api

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--add

Přidejte objekt do seznamu objektů zadáním párů cest a klíč-hodnota. Příklad: --add property.listProperty <key=value, string or JSON string>.

Vlastnost Hodnota
Skupina parametrů: Generic Update Arguments
--api-id

ID rozhraní API.

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
--custom-properties

Vlastní metadata definovaná pro entity katalogu rozhraní API. Podpora zkratky syntaxe, json-file a yaml-file Zkuste "??" zobrazit více.

Vlastnost Hodnota
Skupina parametrů: Properties Arguments
--definition-id

ID prostředku definice s vymezeným oborem služby

Vlastnost Hodnota
Skupina parametrů: Properties Arguments
--deployment-id

ID nasazení rozhraní API.

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
--description

Popis nasazení

Vlastnost Hodnota
Skupina parametrů: Properties Arguments
--environment-id

ID prostředku prostředí s vymezeným oborem služby

Vlastnost Hodnota
Skupina parametrů: Properties Arguments
--force-string

Při použití set nebo add zachovávejte řetězcové literály místo pokusu o převod na JSON.

Vlastnost Hodnota
Skupina parametrů: Generic Update Arguments
Přípustné hodnoty: 0, 1, f, false, n, no, t, true, y, yes
--ids

Jedno nebo více ID prostředků (oddělené mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat buď argumenty --ids, nebo jiné argumenty 'ID prostředku'.

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
--remove

Odeberte vlastnost nebo prvek ze seznamu. Příklad: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Vlastnost Hodnota
Skupina parametrů: Generic Update Arguments
--resource-group -g

Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
--server

Server podporuje zkratku syntaxe, json-file a yaml-file. Zkuste "??" zobrazit více.

Vlastnost Hodnota
Skupina parametrů: Properties Arguments
--service-name -n

Název služby Azure API Center.

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
--set

Aktualizujte objekt zadáním cesty vlastnosti a hodnoty, která se má nastavit. Příklad: --set property1.property2=<value>.

Vlastnost Hodnota
Skupina parametrů: Generic Update Arguments
--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
--title

Title.

Vlastnost Hodnota
Skupina parametrů: Properties Arguments
Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost Hodnota
Default value: False
--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost Hodnota
Default value: False
--output -o

Výstupní formát

Vlastnost Hodnota
Default value: json
Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost Hodnota
Default value: False