az apim api operation

Správa operací rozhraní API služby Azure API Management

Příkazy

Name	Description	Typ	Stav
az apim api operation create	Vytvoří novou operaci v rozhraní API.	Core	GA
az apim api operation delete	Odstraní zadanou operaci v rozhraní API.	Core	GA
az apim api operation list	Vypíše kolekci operací pro zadané rozhraní API.	Core	GA
az apim api operation show	Získá podrobnosti operace rozhraní API určené jeho identifikátorem.	Core	GA
az apim api operation update	Aktualizuje podrobnosti o operaci v rozhraní API určeném jeho identifikátorem.	Core	GA

az apim api operation create

Upravit

Vytvoří novou operaci v rozhraní API.

az apim api operation create --api-id
                             --display-name
                             --method
                             --resource-group
                             --service-name
                             --url-template
                             [--description]
                             [--if-match]
                             [--operation-id]
                             [--params --template-parameters]

Příklady

Vytvoří novou operaci v rozhraní API s několika parametry.

az apim api operation create --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --url-template "/session/{param1}/{param2}" --method "GET" --display-name MyOperationName --description MyDescription --template-parameters name=param1 description=descriptionContent type=paramType required="true" --template-parameters name=param2 required="false" type="string"

Povinné parametry

--api-id

Identifikátor rozhraní API. V aktuální instanci služby API Management musí být jedinečné. Revize, která není aktuální, má ; rev=n jako přípona, kde n je číslo revize.

Vlastnost	Hodnota
Skupina parametrů:	API Arguments

--display-name

Required. Název operace.

--method

Required. Platná metoda operace HTTP. Typické metody HTTP, jako je GET, PUT, POST, ale nejsou omezeny pouze nimi.

--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 instance služby API Management.

--url-template

Relativní šablona adresy URL identifikující cílový prostředek pro tuto operaci Může obsahovat parametry.

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.

--description

Popis operace Může obsahovat značky formátování HTML.

--if-match

ETag of the Entity.

--operation-id

Identifikátor operace v rámci rozhraní API. V aktuální instanci služby API Management musí být jedinečné.

--params --template-parameters -p

Kolekce parametrů šablony adresy URL

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 apim api operation delete

Upravit

Odstraní zadanou operaci v rozhraní API.

az apim api operation delete --api-id
                             --operation-id
                             --resource-group
                             --service-name
                             [--if-match]

Příklady

Odstraní zadanou operaci v rozhraní API.

az apim api operation delete --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --operation-id MyOperationId

Povinné parametry

--api-id

Identifikátor rozhraní API. V aktuální instanci služby API Management musí být jedinečné. Revize, která není aktuální, má ; rev=n jako přípona, kde n je číslo revize.

Vlastnost	Hodnota
Skupina parametrů:	API Arguments

--operation-id

Identifikátor operace v rámci rozhraní API. V aktuální instanci služby API Management musí být jedinečné.

--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 instance služby API Management.

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.

--if-match

ETag of the Entity.

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 apim api operation list

Upravit

Vypíše kolekci operací pro zadané rozhraní API.

az apim api operation list --api-id
                           --resource-group
                           --service-name

Příklady

Vypíše kolekci operací pro zadané rozhraní API.

az apim api operation list --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId

Povinné parametry

--api-id

Identifikátor rozhraní API. V aktuální instanci služby API Management musí být jedinečné. Revize, která není aktuální, má ; rev=n jako přípona, kde n je číslo revize.

Vlastnost	Hodnota
Skupina parametrů:	API Arguments

--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 instance služby API Management.

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 apim api operation show

Upravit

Získá podrobnosti operace rozhraní API určené jeho identifikátorem.

az apim api operation show --api-id
                           --operation-id
                           --resource-group
                           --service-name

Příklady

Získá podrobnosti operace rozhraní API určené jeho identifikátorem.

az apim api operation show --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --operation-id MyOperationId

Povinné parametry

--api-id

Identifikátor rozhraní API. V aktuální instanci služby API Management musí být jedinečné. Revize, která není aktuální, má ; rev=n jako přípona, kde n je číslo revize.

Vlastnost	Hodnota
Skupina parametrů:	API Arguments

--operation-id

Identifikátor operace v rámci rozhraní API. V aktuální instanci služby API Management musí být jedinečné.

--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 instance služby API Management.

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 apim api operation update

Upravit

Aktualizuje podrobnosti o operaci v rozhraní API určeném jeho identifikátorem.

az apim api operation update --api-id
                             --operation-id
                             --resource-group
                             --service-name
                             [--add]
                             [--description]
                             [--display-name]
                             [--force-string]
                             [--if-match]
                             [--method]
                             [--remove]
                             [--set]
                             [--url-template]

Příklady

Metoda aktualizace, displayname, popis operace v rozhraní API určeném jeho identifikátorem.

az apim api operation update --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --operation-id MyOperationId --method "PUT" --display-name NewDisplayName --description NewDescription

Povinné parametry

--api-id

Identifikátor rozhraní API. V aktuální instanci služby API Management musí být jedinečné. Revize, která není aktuální, má ; rev=n jako přípona, kde n je číslo revize.

Vlastnost	Hodnota
Skupina parametrů:	API Arguments

--operation-id

Identifikátor operace v rámci rozhraní API. V aktuální instanci služby API Management musí být jedinečné.

--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 instance služby API Management.

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
Default value:	[]

--description

Popis operace Může obsahovat značky formátování HTML.

--display-name

Required. Název operace.

--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
Default value:	False

--if-match

ETag of the Entity.

--method

Required. Platná metoda operace HTTP. Typické metody HTTP, jako je GET, PUT, POST, ale nejsou omezeny pouze nimi.

--remove

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

Vlastnost	Hodnota
Skupina parametrů:	Generic Update Arguments
Default value:	[]

--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
Default value:	[]

--url-template

Relativní šablona adresy URL identifikující cílový prostředek pro tuto operaci Může obsahovat parametry.

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

Váš názor

Byla tato stránka užitečná?

Sdílet prostřednictvím

az apim api operation

Příkazy

az apim api operation create

Příklady

Povinné parametry

Volitelné parametry

az apim api operation delete

Příklady

Povinné parametry

Volitelné parametry

az apim api operation list

Příklady

Povinné parametry

az apim api operation show

Příklady

Povinné parametry

az apim api operation update

Příklady

Povinné parametry

Volitelné parametry

Váš názor