az apim api operation

  • Referencia

Az Azure API Management API-műveletek kezelése.

Parancsok

Name Description Típus Állapot
az apim api operation create

Új műveletet hoz létre az API-ban.

 Alapvető FE
az apim api operation delete

Törli a megadott műveletet az API-ban.

 Alapvető FE
az apim api operation list

Adja meg a megadott API műveleteinek gyűjteményét.

 Alapvető FE
az apim api operation show

Lekéri az azonosító által megadott API-művelet részleteit.

 Alapvető FE
az apim api operation update

Frissítések a művelet részleteit az API-ban, amelyet az azonosítója határoz meg.

 Alapvető FE

az apim api operation create

Szerkesztés

Új műveletet hoz létre az API-ban.

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

Példák

Új műveletet hoz létre az API-ban több paraméterrel

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"

Kötelező paraméterek

--api-id

API-azonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. A nem aktuális változat rendelkezik ; rev=n utótagként, ahol n a változat száma.

--display-name

Szükséges. Művelet neve.

--method

Szükséges. Érvényes HTTP-műveleti módszer. Tipikus HTTP-metódusok, például GET, PUT, POST, de nem csak ezek.

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>: .

--service-name -n

Az API Management szolgáltatáspéldány neve.

--url-template

A művelet célerőforrását azonosító relatív URL-sablon. Tartalmazhat paramétereket.

Opcionális paraméterek

--description

A művelet leírása. HTML-formázási címkéket is tartalmazhat.

--if-match

Az entitás ETagje.

--operation-id

Műveletazonosító egy API-on belül. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.

--params --template-parameters -p

URL-sablonparaméterek gyűjteménye.

Globális paraméterek
--debug

Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.

--help -h

Jelenítse meg ezt a súgóüzenetet, és lépjen ki.

--only-show-errors

Csak a hibák megjelenítése, a figyelmeztetések mellőzése.

--output -o

Kimeneti formátum.

elfogadott értékek: json, jsonc, none, table, tsv, yaml, yamlc
alapértelmezett érték: json
--query

JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID: .

--verbose

A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

az apim api operation delete

Szerkesztés

Törli a megadott műveletet az API-ban.

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

Példák

Törli a megadott műveletet az API-ban.

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

Kötelező paraméterek

--api-id

API-azonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. A nem aktuális változat rendelkezik ; rev=n utótagként, ahol n a változat száma.

--operation-id

Műveletazonosító egy API-on belül. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>: .

--service-name -n

Az API Management szolgáltatáspéldány neve.

Opcionális paraméterek

--if-match

Az entitás ETagje.

Globális paraméterek
--debug

Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.

--help -h

Jelenítse meg ezt a súgóüzenetet, és lépjen ki.

--only-show-errors

Csak a hibák megjelenítése, a figyelmeztetések mellőzése.

--output -o

Kimeneti formátum.

elfogadott értékek: json, jsonc, none, table, tsv, yaml, yamlc
alapértelmezett érték: json
--query

JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID: .

--verbose

A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

az apim api operation list

Szerkesztés

Adja meg a megadott API műveleteinek gyűjteményét.

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

Példák

Adja meg a megadott API műveleteinek gyűjteményét.

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

Kötelező paraméterek

--api-id

API-azonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. A nem aktuális változat rendelkezik ; rev=n utótagként, ahol n a változat száma.

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>: .

--service-name -n

Az API Management szolgáltatáspéldány neve.

Globális paraméterek
--debug

Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.

--help -h

Jelenítse meg ezt a súgóüzenetet, és lépjen ki.

--only-show-errors

Csak a hibák megjelenítése, a figyelmeztetések mellőzése.

--output -o

Kimeneti formátum.

elfogadott értékek: json, jsonc, none, table, tsv, yaml, yamlc
alapértelmezett érték: json
--query

JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID: .

--verbose

A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

az apim api operation show

Szerkesztés

Lekéri az azonosító által megadott API-művelet részleteit.

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

Példák

Lekéri az azonosító által megadott API-művelet részleteit.

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

Kötelező paraméterek

--api-id

API-azonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. A nem aktuális változat rendelkezik ; rev=n utótagként, ahol n a változat száma.

--operation-id

Műveletazonosító egy API-on belül. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>: .

--service-name -n

Az API Management szolgáltatáspéldány neve.

Globális paraméterek
--debug

Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.

--help -h

Jelenítse meg ezt a súgóüzenetet, és lépjen ki.

--only-show-errors

Csak a hibák megjelenítése, a figyelmeztetések mellőzése.

--output -o

Kimeneti formátum.

elfogadott értékek: json, jsonc, none, table, tsv, yaml, yamlc
alapértelmezett érték: json
--query

JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID: .

--verbose

A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

az apim api operation update

Szerkesztés

Frissítések a művelet részleteit az API-ban, amelyet az azonosítója határoz meg.

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éldák

Frissítések metódus, megjelenítendő név, a művelet leírása az API-ban, amelyet az azonosítója határoz meg.

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

Kötelező paraméterek

--api-id

API-azonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. A nem aktuális változat rendelkezik ; rev=n utótagként, ahol n a változat száma.

--operation-id

Műveletazonosító egy API-on belül. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>: .

--service-name -n

Az API Management szolgáltatáspéldány neve.

Opcionális paraméterek

--add

Adjon hozzá egy objektumot az objektumok listájához egy elérési út és egy kulcsértékpár megadásával. Példa: --add property.listProperty <key=value, string or JSON string>

alapértelmezett érték: []
--description

A művelet leírása. HTML-formázási címkéket is tartalmazhat.

--display-name

Szükséges. Művelet neve.

--force-string

A "set" vagy a "add" használata esetén a JSON-ra való konvertálás helyett őrizze meg a sztringkonstansokat.

alapértelmezett érték: False
--if-match

Az entitás ETagje.

--method

Szükséges. Érvényes HTTP-műveleti módszer. Tipikus HTTP-metódusok, például GET, PUT, POST, de nem csak ezek.

--remove

Tulajdonság vagy elem eltávolítása a listából. Példa: --remove property.list <indexToRemove> VAGY --remove propertyToRemove.

alapértelmezett érték: []
--set

Frissítsen egy objektumot egy beállítandó tulajdonság elérési útjának és értékének megadásával. Példa: --set property1.property2=<value>

alapértelmezett érték: []
--url-template

A művelet célerőforrását azonosító relatív URL-sablon. Tartalmazhat paramétereket.

Globális paraméterek
--debug

Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.

--help -h

Jelenítse meg ezt a súgóüzenetet, és lépjen ki.

--only-show-errors

Csak a hibák megjelenítése, a figyelmeztetések mellőzése.

--output -o

Kimeneti formátum.

elfogadott értékek: json, jsonc, none, table, tsv, yaml, yamlc
alapértelmezett érték: json
--query

JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID: .

--verbose

A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.