az apim api

Azure API Management API-k kezelése.

Parancsok

Name	Description	Típus	Állapot
az apim api create	Hozzon létre egy API Management API-t.	Core	GA
az apim api delete	API Management API törlése.	Core	GA
az apim api export	API Management API exportálása.	Core	GA
az apim api import	API Management API importálása.	Core	GA
az apim api list	Az API Management API-k listázása.	Core	GA
az apim api operation	Azure API Management API-műveletek kezelése.	Core	GA
az apim api operation create	Új műveletet hoz létre az API-ban.	Core	GA
az apim api operation delete	Törli a megadott műveletet az API-ban.	Core	GA
az apim api operation list	Adja meg a megadott API műveleteinek gyűjteményét.	Core	GA
az apim api operation show	Lekéri az azonosító által megadott API-művelet részleteit.	Core	GA
az apim api operation update	Frissíti a művelet részleteit az api-ban, amelyet az azonosítója határoz meg.	Core	GA
az apim api release	Azure API Management API-kiadás kezelése.	Core	GA
az apim api release create	Létrehoz egy új kiadást az API-hoz.	Core	GA
az apim api release delete	Törli a megadott kiadást az API-ban.	Core	GA
az apim api release list	Az API összes kiadásának listája.	Core	GA
az apim api release show	Egy API-kiadás részleteit adja vissza.	Core	GA
az apim api release update	Frissíti az azonosító által megadott API kiadásának részleteit.	Core	GA
az apim api revision	Azure API Management API-változat kezelése.	Core	GA
az apim api revision create	API-változat létrehozása.	Core	GA
az apim api revision list	Egy API összes változatának listája.	Core	GA
az apim api schema	Azure API Management API-séma kezelése.	Core	GA
az apim api schema create	Hozzon létre egy API Management API-sémát.	Core	GA
az apim api schema delete	API Management API-séma törlése.	Core	GA
az apim api schema get-etag	Api Management API-séma etagjének lekérése.	Core	GA
az apim api schema list	Az API Management API-sémák listázása.	Core	GA
az apim api schema show	Az API Management API-séma részleteinek megjelenítése.	Core	GA
az apim api schema wait	Helyezze a parancssori felületet várakozási állapotba, amíg egy apim API-séma valamely feltétele teljesül.	Core	GA
az apim api show	Az API Management API részleteinek megjelenítése.	Core	GA
az apim api update	Api Management API frissítése.	Core	GA
az apim api versionset	Azure API Management API-verziókészlet kezelése.	Core	GA
az apim api versionset create	Létrehoz egy API-verziókészletet.	Core	GA
az apim api versionset delete	Törli a megadott API-verziókészletet.	Core	GA
az apim api versionset list	Az API-verziókészletek gyűjteményét sorolja fel a megadott szolgáltatáspéldányban.	Core	GA
az apim api versionset show	Lekéri az api-verziókészlet azonosítója által megadott adatait.	Core	GA
az apim api versionset update	Frissíti az Api VersionSet azonosító által megadott adatait.	Core	GA
az apim api wait	Helyezze a parancssori felületet várakozási állapotba, amíg az apim api egy feltételének nem teljesül.	Core	GA

az apim api create

Szerkesztés

Hozzon létre egy API Management API-t.

az apim api create --api-id
                   --display-name
                   --path
                   --resource-group
                   --service-name
                   [--acquire-policy-token]
                   [--api-type {graphql, http, soap, websocket}]
                   [--authorization-scope]
                   [--authorization-server-id]
                   [--bearer-token-sending-methods]
                   [--change-reference]
                   [--description]
                   [--no-wait]
                   [--open-id-provider-id]
                   [--protocols {http, https, ws, wss}]
                   [--service-url]
                   [--subscription-key-header-name]
                   [--subscription-key-query-param-name]
                   [--subscription-key-required]
                   [--subscription-required {false, true}]

Példák

Hozzon létre egy alapszintű API-t.

az apim api create --service-name MyApim -g MyResourceGroup --api-id MyApi --path '/myapi' --display-name 'My API'

Kötelező paraméterek

--api-id

A létrehozandó api egyedi neve.

API-változat azonosítója. 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.

Tulajdonság	Érték
Paramétercsoport:	API Arguments

--display-name

A létrehozandó API megjelenítendő neve.

Tulajdonság	Érték
Paramétercsoport:	API Arguments

--path

Az API elérési útja.

Tulajdonság	Érték
Paramétercsoport:	API Arguments

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot a az configure --defaults group=<name>használatával konfigurálhatja.

--service-name -n

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

Opcionális paraméterek

Az alábbi paraméterek megadása nem kötelező, de a környezettől függően előfordulhat, hogy a parancs sikeres végrehajtásához egy vagy több is szükséges lehet.

--acquire-policy-token

Az erőforrásművelethez automatikusan beszerez egy Azure Policy-jogkivonatot.

Tulajdonság	Érték
Paramétercsoport:	Global Policy Arguments

--api-type

Az API típusa.

Tulajdonság	Érték
Paramétercsoport:	API Arguments
Elfogadott értékek:	graphql, http, soap, websocket

--authorization-scope

Megadja az OAuth-műveletek hatókörét.

--authorization-server-id

Megadja az OAuth engedélyezési kiszolgáló azonosítóját.

--bearer-token-sending-methods

Megadja a tulajdonosi jogkivonat küldési módszereit.

--change-reference

Az erőforrásművelet kapcsolódó változáshivatkozás-azonosítója.

Tulajdonság	Érték
Paramétercsoport:	Global Policy Arguments

--description

Az API leírása. HTML-formázási címkéket is tartalmazhat.

Tulajdonság	Érték
Paramétercsoport:	API Arguments

--no-wait

Ne várja meg, amíg a hosszú ideig futó művelet befejeződik.

Tulajdonság	Érték
Alapértelmezett érték:	False

--open-id-provider-id

Megadja az openid azonosítót a hitelesítési beállításban.

--protocols

Ez a cikk ismerteti, hogy az API műveletei mely protokollokon hívhatók meg.

Tulajdonság	Érték
Paramétercsoport:	API Arguments
Elfogadott értékek:	http, https, ws, wss

--service-url

Az API-t implementáló háttérszolgáltatás abszolút URL-címe. Legfeljebb 2000 karakter hosszú lehet.

Tulajdonság	Érték
Paramétercsoport:	API Arguments

--subscription-key-header-name

Megadja az előfizetéskulcs fejlécének nevét.

Tulajdonság	Érték
Paramétercsoport:	API Arguments

--subscription-key-query-param-name

Az előfizetési kulcs lekérdezési sztring paraméterének nevét adja meg.

Tulajdonság	Érték
Paramétercsoport:	API Arguments

--subscription-key-required

Megadja, hogy szükség van-e előfizetési kulcsra az API hívása során, igaz – az API csak zárt termékekbe van belefoglalva, hamis – az API csak a nyitott termékekbe van belefoglalva, null – a termékek vegyesen léteznek.

--subscription-required

Ha igaz, az API-nak szüksége van egy előfizetési kulcsra a kérelmekhez.

Tulajdonság	Érték
Paramétercsoport:	API Arguments
Alapértelmezett érték:	False
Elfogadott értékek:	false, true

Globális paraméterek

--debug

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

Tulajdonság	Érték
Alapértelmezett érték:	False

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

Tulajdonság	Érték
Alapértelmezett érték:	False

--output -o

Kimeneti formátum.

Tulajdonság	Érték
Alapértelmezett érték:	json
Elfogadott értékek:	json, jsonc, none, table, tsv, yaml, yamlc

--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 a az account set -s NAME_OR_IDhasználatával konfigurálhatja.

--verbose

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

Tulajdonság	Érték
Alapértelmezett érték:	False

az apim api delete

Szerkesztés

API Management API törlése.

az apim api delete --api-id
                   --resource-group
                   --service-name
                   [--acquire-policy-token]
                   [--change-reference]
                   [--delete-revisions]
                   [--if-match]
                   [--no-wait]
                   [--yes]

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.

Tulajdonság	Érték
Paramétercsoport:	API Arguments

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot a az configure --defaults group=<name>használatával konfigurálhatja.

--service-name -n

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

Opcionális paraméterek

Az alábbi paraméterek megadása nem kötelező, de a környezettől függően előfordulhat, hogy a parancs sikeres végrehajtásához egy vagy több is szükséges lehet.

--acquire-policy-token

Az erőforrásművelethez automatikusan beszerez egy Azure Policy-jogkivonatot.

Tulajdonság	Érték
Paramétercsoport:	Global Policy Arguments

--change-reference

Az erőforrásművelet kapcsolódó változáshivatkozás-azonosítója.

Tulajdonság	Érték
Paramétercsoport:	Global Policy Arguments

--delete-revisions

Törölje az Api összes változatát.

--if-match

Az entitás ETagje.

--no-wait

Ne várja meg, amíg a hosszú ideig futó művelet befejeződik.

Tulajdonság	Érték
Alapértelmezett érték:	False

--yes -y

Ne kérje a megerősítést.

Tulajdonság	Érték
Alapértelmezett érték:	False

Globális paraméterek

--debug

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

Tulajdonság	Érték
Alapértelmezett érték:	False

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

Tulajdonság	Érték
Alapértelmezett érték:	False

--output -o

Kimeneti formátum.

Tulajdonság	Érték
Alapértelmezett érték:	json
Elfogadott értékek:	json, jsonc, none, table, tsv, yaml, yamlc

--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 a az account set -s NAME_OR_IDhasználatával konfigurálhatja.

--verbose

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

Tulajdonság	Érték
Alapértelmezett érték:	False

az apim api export

Szerkesztés

API Management API exportálása.

az apim api export --api-id
                   --ef --export-format {OpenApiJsonFile, OpenApiJsonUrl, OpenApiYamlFile, OpenApiYamlUrl, SwaggerFile, SwaggerUrl, WadlFile, WadlUrl, WsdlFile, WsdlUrl}
                   --resource-group
                   --service-name
                   [--acquire-policy-token]
                   [--change-reference]
                   [--file-path]

Példák

Api Management API exportálása fájlba, vagy az exportálás hivatkozását tartalmazó választ ad vissza.

az apim api export -g MyResourceGroup --service-name MyApim --api-id MyApi --export-format OpenApiJson --file-path path

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. Regex minta: ^[^*#&+:<>?]+$.

Tulajdonság	Érték
Paramétercsoport:	API Arguments

--ef --export-format

Adja meg az exportálási API formátumát.

Tulajdonság	Érték
Elfogadott értékek:	OpenApiJsonFile, OpenApiJsonUrl, OpenApiYamlFile, OpenApiYamlUrl, SwaggerFile, SwaggerUrl, WadlFile, WadlUrl, WsdlFile, WsdlUrl

--resource-group -g

Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.

--service-name -n

Az api management szolgáltatáspéldány neve.

Opcionális paraméterek

Az alábbi paraméterek megadása nem kötelező, de a környezettől függően előfordulhat, hogy a parancs sikeres végrehajtásához egy vagy több is szükséges lehet.

--acquire-policy-token

Az erőforrásművelethez automatikusan beszerez egy Azure Policy-jogkivonatot.

Tulajdonság	Érték
Paramétercsoport:	Global Policy Arguments

--change-reference

Az erőforrásművelet kapcsolódó változáshivatkozás-azonosítója.

Tulajdonság	Érték
Paramétercsoport:	Global Policy Arguments

--file-path -f

Az API exportálásához megadott fájl elérési útja.

Globális paraméterek

--debug

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

Tulajdonság	Érték
Alapértelmezett érték:	False

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

Tulajdonság	Érték
Alapértelmezett érték:	False

--output -o

Kimeneti formátum.

Tulajdonság	Érték
Alapértelmezett érték:	json
Elfogadott értékek:	json, jsonc, none, table, tsv, yaml, yamlc

--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 a az account set -s NAME_OR_IDhasználatával konfigurálhatja.

--verbose

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

Tulajdonság	Érték
Alapértelmezett érték:	False

az apim api import

Szerkesztés

API Management API importálása.

az apim api import --path
                   --resource-group
                   --service-name
                   --specification-format {GraphQL, OpenApi, OpenApiJson, Swagger, Wadl, Wsdl}
                   [--acquire-policy-token]
                   [--api-id]
                   [--api-revision]
                   [--api-type {graphql, http, soap, websocket}]
                   [--api-version]
                   [--api-version-set-id]
                   [--change-reference]
                   [--description]
                   [--display-name]
                   [--no-wait]
                   [--protocols {http, https, ws, wss}]
                   [--service-url]
                   [--soap-api-type]
                   [--specification-path]
                   [--specification-url]
                   [--subscription-key-header-name]
                   [--subscription-key-query-param-name]
                   [--subscription-required {false, true}]
                   [--wsdl-endpoint-name]
                   [--wsdl-service-name]

Példák

API Management API importálása fájlból vagy URL-címből

az apim api import -g MyResourceGroup --service-name MyApim --path MyApi --specification-url https://MySpecificationURL --specification-format OpenApiJson

Kötelező paraméterek

--path

Required. Relatív URL-cím, amely egyedileg azonosítja ezt az API-t és annak összes erőforrásútvonalát az API Management szolgáltatáspéldányon belül.

Tulajdonság	Érték
Paramétercsoport:	API Arguments

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot a az configure --defaults group=<name>használatával konfigurálhatja.

--service-name -n

Az api management szolgáltatáspéldány neve.

--specification-format

Adja meg az importált API formátumát.

Tulajdonság	Érték
Elfogadott értékek:	GraphQL, OpenApi, OpenApiJson, Swagger, Wadl, Wsdl

Opcionális paraméterek

Az alábbi paraméterek megadása nem kötelező, de a környezettől függően előfordulhat, hogy a parancs sikeres végrehajtásához egy vagy több is szükséges lehet.

--acquire-policy-token

Az erőforrásművelethez automatikusan beszerez egy Azure Policy-jogkivonatot.

Tulajdonság	Érték
Paramétercsoport:	Global Policy Arguments

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

Tulajdonság	Érték
Paramétercsoport:	API Arguments

--api-revision

Az Api felülvizsgálatát ismerteti. Ha nincs megadva érték, a rendszer létrehozza az 1. alapértelmezett változatot.

Tulajdonság	Érték
Paramétercsoport:	API Arguments

--api-type

Az API típusa.

Tulajdonság	Érték
Paramétercsoport:	API Arguments
Elfogadott értékek:	graphql, http, soap, websocket

--api-version

Az API verzióját ismerteti. Ha nem verziószámozott API-hoz ad hozzá verziót, a rendszer automatikusan létrehoz egy eredeti verziót, és az alapértelmezett URL-címen válaszol.

Tulajdonság	Érték
Paramétercsoport:	API Arguments

--api-version-set-id

Az API-val használandó verziókészletet ismerteti.

Tulajdonság	Érték
Paramétercsoport:	API Arguments

--change-reference

Az erőforrásművelet kapcsolódó változáshivatkozás-azonosítója.

Tulajdonság	Érték
Paramétercsoport:	Global Policy Arguments

--description

Az API leírása. HTML-formázási címkéket is tartalmazhat.

Tulajdonság	Érték
Paramétercsoport:	API Arguments

--display-name

Az API megjelenítendő neve.

Tulajdonság	Érték
Paramétercsoport:	API Arguments

--no-wait

Ne várja meg, amíg a hosszú ideig futó művelet befejeződik.

Tulajdonság	Érték
Alapértelmezett érték:	False

--protocols

Azt ismerteti, hogy az API-ban található műveletek mely protokollokra hívhatók meg (egy vagy több).

Tulajdonság	Érték
Paramétercsoport:	API Arguments
Elfogadott értékek:	http, https, ws, wss

--service-url

Az API-t implementáló háttérszolgáltatás abszolút URL-címe. Legfeljebb 2000 karakter hosszú lehet.

Tulajdonság	Érték
Paramétercsoport:	API Arguments

--soap-api-type

Az API típusa, ha a fájlformátum WSDL.

--specification-path

Az API importálásához megadott fájl elérési útja.

--specification-url

Az API importálásához megadott URL-cím.

--subscription-key-header-name

Megadja az előfizetéskulcs fejlécének nevét.

Tulajdonság	Érték
Paramétercsoport:	API Arguments

--subscription-key-query-param-name

Az előfizetési kulcs lekérdezési sztring paraméterének nevét adja meg.

Tulajdonság	Érték
Paramétercsoport:	API Arguments

--subscription-required

Ha igaz, az API-nak szüksége van egy előfizetési kulcsra a kérelmekhez.

Tulajdonság	Érték
Paramétercsoport:	API Arguments
Elfogadott értékek:	false, true

--wsdl-endpoint-name

Az importálandó WSDL-végpont (port) helyi neve.

--wsdl-service-name

Az importálandó WSDL-szolgáltatás helyi 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.

Tulajdonság	Érték
Alapértelmezett érték:	False

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

Tulajdonság	Érték
Alapértelmezett érték:	False

--output -o

Kimeneti formátum.

Tulajdonság	Érték
Alapértelmezett érték:	json
Elfogadott értékek:	json, jsonc, none, table, tsv, yaml, yamlc

--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 a az account set -s NAME_OR_IDhasználatával konfigurálhatja.

--verbose

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

Tulajdonság	Érték
Alapértelmezett érték:	False

az apim api list

Szerkesztés

Az API Management API-k listázása.

az apim api list --resource-group
                 --service-name
                 [--filter-display-name]
                 [--skip]
                 [--top]

Kötelező paraméterek

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot a az configure --defaults group=<name>használatával konfigurálhatja.

--service-name -n

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

Opcionális paraméterek

Az alábbi paraméterek megadása nem kötelező, de a környezettől függően előfordulhat, hogy a parancs sikeres végrehajtásához egy vagy több is szükséges lehet.

--filter-display-name

API-k szűrése a displayName alapján.

Tulajdonság	Érték
Paramétercsoport:	API Arguments

--skip

Kihagyandó rekordok száma.

--top

A visszaadni kívánt rekordok száma.

Globális paraméterek

--debug

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

Tulajdonság	Érték
Alapértelmezett érték:	False

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

Tulajdonság	Érték
Alapértelmezett érték:	False

--output -o

Kimeneti formátum.

Tulajdonság	Érték
Alapértelmezett érték:	json
Elfogadott értékek:	json, jsonc, none, table, tsv, yaml, yamlc

--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 a az account set -s NAME_OR_IDhasználatával konfigurálhatja.

--verbose

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

Tulajdonság	Érték
Alapértelmezett érték:	False

az apim api show

Szerkesztés

Az API Management API részleteinek megjelenítése.

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

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.

Tulajdonság	Érték
Paramétercsoport:	API Arguments

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot a az configure --defaults group=<name>használatával konfigurálhatja.

--service-name

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.

Tulajdonság	Érték
Alapértelmezett érték:	False

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

Tulajdonság	Érték
Alapértelmezett érték:	False

--output -o

Kimeneti formátum.

Tulajdonság	Érték
Alapértelmezett érték:	json
Elfogadott értékek:	json, jsonc, none, table, tsv, yaml, yamlc

--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 a az account set -s NAME_OR_IDhasználatával konfigurálhatja.

--verbose

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

Tulajdonság	Érték
Alapértelmezett érték:	False

az apim api update

Szerkesztés

Api Management API frissítése.

az apim api update --api-id
                   --resource-group
                   --service-name
                   [--acquire-policy-token]
                   [--add]
                   [--api-type {graphql, http, soap, websocket}]
                   [--change-reference]
                   [--description]
                   [--display-name]
                   [--force-string]
                   [--if-match]
                   [--no-wait]
                   [--path]
                   [--protocols {http, https, ws, wss}]
                   [--remove]
                   [--service-url]
                   [--set]
                   [--subscription-key-header-name]
                   [--subscription-key-query-param-name]
                   [--subscription-required {false, true}]
                   [--tags]

Példák

Hozzon létre egy alapszintű API-t.

az apim api update --service-name MyApim -g MyResourceGroup --api-id MyApi --description foo

Kötelező paraméterek

--api-id

A létrehozandó api egyedi neve.

API-változat azonosítója. 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.

Tulajdonság	Érték
Paramétercsoport:	API Arguments

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot a az configure --defaults group=<name>használatával konfigurálhatja.

--service-name -n

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

Opcionális paraméterek

Az alábbi paraméterek megadása nem kötelező, de a környezettől függően előfordulhat, hogy a parancs sikeres végrehajtásához egy vagy több is szükséges lehet.

--acquire-policy-token

Az erőforrásművelethez automatikusan beszerez egy Azure Policy-jogkivonatot.

Tulajdonság	Érték
Paramétercsoport:	Global Policy Arguments

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

Tulajdonság	Érték
Paramétercsoport:	Generic Update Arguments
Alapértelmezett érték:	[]

--api-type

Az API típusa.

Tulajdonság	Érték
Paramétercsoport:	API Arguments
Elfogadott értékek:	graphql, http, soap, websocket

--change-reference

Az erőforrásművelet kapcsolódó változáshivatkozás-azonosítója.

Tulajdonság	Érték
Paramétercsoport:	Global Policy Arguments

--description

Az API leírása. HTML-formázási címkéket is tartalmazhat.

Tulajdonság	Érték
Paramétercsoport:	API Arguments

--display-name

API-név. 1–300 karakter hosszúságúnak kell lennie.

Tulajdonság	Érték
Paramétercsoport:	API Arguments

--force-string

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

Tulajdonság	Érték
Paramétercsoport:	Generic Update Arguments
Alapértelmezett érték:	False

--if-match

Az entitás ETagje. Entitás létrehozásakor nem kötelező, de egy entitás frissítésekor kötelező. Az alapértelmezett érték Nincs.

--no-wait

Ne várja meg, amíg a hosszú ideig futó művelet befejeződik.

Tulajdonság	Érték
Alapértelmezett érték:	False

--path

Required. Relatív URL-cím, amely egyedileg azonosítja ezt az API-t és annak összes erőforrásútvonalát az API Management szolgáltatáspéldányon belül.

Tulajdonság	Érték
Paramétercsoport:	API Arguments

--protocols

Ez a cikk ismerteti, hogy az API műveletei mely protokollokon hívhatók meg.

Tulajdonság	Érték
Paramétercsoport:	API Arguments
Elfogadott értékek:	http, https, ws, wss

--remove

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

Tulajdonság	Érték
Paramétercsoport:	Generic Update Arguments
Alapértelmezett érték:	[]

--service-url

Az API-t implementáló háttérszolgáltatás abszolút URL-címe. Legfeljebb 2000 karakter hosszú lehet.

Tulajdonság	Érték
Paramétercsoport:	API Arguments

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

Tulajdonság	Érték
Paramétercsoport:	Generic Update Arguments
Alapértelmezett érték:	[]

--subscription-key-header-name

Megadja az előfizetéskulcs fejlécének nevét.

Tulajdonság	Érték
Paramétercsoport:	API Arguments

--subscription-key-query-param-name

Az előfizetési kulcs lekérdezési sztring paraméterének nevét adja meg.

Tulajdonság	Érték
Paramétercsoport:	API Arguments

--subscription-required

Ha igaz, az API-nak szüksége van egy előfizetési kulcsra a kérelmekhez.

Tulajdonság	Érték
Paramétercsoport:	API Arguments
Elfogadott értékek:	false, true

--tags

Szóközzel elválasztott címkék: key[=value] [key[=value] ...]. Meglévő címkék törlése a "" használatával.

Globális paraméterek

--debug

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

Tulajdonság	Érték
Alapértelmezett érték:	False

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

Tulajdonság	Érték
Alapértelmezett érték:	False

--output -o

Kimeneti formátum.

Tulajdonság	Érték
Alapértelmezett érték:	json
Elfogadott értékek:	json, jsonc, none, table, tsv, yaml, yamlc

--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 a az account set -s NAME_OR_IDhasználatával konfigurálhatja.

--verbose

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

Tulajdonság	Érték
Alapértelmezett érték:	False

az apim api wait

Szerkesztés

Helyezze a parancssori felületet várakozási állapotba, amíg az apim api egy feltételének nem teljesül.

az apim api wait --api-id
                 --name
                 --resource-group
                 [--acquire-policy-token]
                 [--change-reference]
                 [--created]
                 [--custom]
                 [--deleted]
                 [--exists]
                 [--interval]
                 [--timeout]
                 [--updated]

Példák

Helyezze a parancssori felületet várakozási állapotba, amíg az apim api egy feltételének nem teljesül. (autogenerated)

az apim api wait --created --api-id MyApi --name MyApim --resource-group MyResourceGroup

Kötelező paraméterek

--api-id

API-változat azonosítója. 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. Required.

--name -n

Az api management szolgáltatáspéldány neve.

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot a az configure --defaults group=<name>használatával konfigurálhatja.

Opcionális paraméterek

Az alábbi paraméterek megadása nem kötelező, de a környezettől függően előfordulhat, hogy a parancs sikeres végrehajtásához egy vagy több is szükséges lehet.

--acquire-policy-token

Az erőforrásművelethez automatikusan beszerez egy Azure Policy-jogkivonatot.

Tulajdonság	Érték
Paramétercsoport:	Global Policy Arguments

--change-reference

Az erőforrásművelet kapcsolódó változáshivatkozás-azonosítója.

Tulajdonság	Érték
Paramétercsoport:	Global Policy Arguments

--created

Várjon, amíg létre nem jön a "provisioningState" a "Sikeres" helyen.

Tulajdonság	Érték
Paramétercsoport:	Wait Condition Arguments
Alapértelmezett érték:	False

--custom

Várjon, amíg a feltétel megfelel egy egyéni JMESPath-lekérdezésnek. Pl. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running"?.

Tulajdonság	Érték
Paramétercsoport:	Wait Condition Arguments

--deleted

Várjon a törlésig.

Tulajdonság	Érték
Paramétercsoport:	Wait Condition Arguments
Alapértelmezett érték:	False

--exists

Várjon, amíg az erőforrás létezik.

Tulajdonság	Érték
Paramétercsoport:	Wait Condition Arguments
Alapértelmezett érték:	False

--interval

Lekérdezési időköz másodpercben.

Tulajdonság	Érték
Paramétercsoport:	Wait Condition Arguments
Alapértelmezett érték:	30

--timeout

Maximális várakozás másodpercben.

Tulajdonság	Érték
Paramétercsoport:	Wait Condition Arguments
Alapértelmezett érték:	3600

--updated

Várjon, amíg frissül a provisioningState a következő helyen: "Sikeres".

Tulajdonság	Érték
Paramétercsoport:	Wait Condition Arguments
Alapértelmezett érték:	False

Globális paraméterek

--debug

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

Tulajdonság	Érték
Alapértelmezett érték:	False

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

Tulajdonság	Érték
Alapértelmezett érték:	False

--output -o

Kimeneti formátum.

Tulajdonság	Érték
Alapértelmezett érték:	json
Elfogadott értékek:	json, jsonc, none, table, tsv, yaml, yamlc

--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 a az account set -s NAME_OR_IDhasználatával konfigurálhatja.

--verbose

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

Tulajdonság	Érték
Alapértelmezett érték:	False

Visszajelzés

Hasznosnak találta ezt az oldalt?