az apim api versionset

Az Azure API Management API verziókészletének kezelése.

Parancsok

Name	Description	Típus	Állapot
az apim api versionset create	Létrehoz egy API-verziókészletet.	Alapvető	FE
az apim api versionset delete	Törli a megadott API-verziókészletet.	Alapvető	FE
az apim api versionset list	Az API-verziókészletek gyűjteményét sorolja fel a megadott szolgáltatáspéldányban.	Alapvető	FE
az apim api versionset show	Lekéri az api-verziókészlet azonosítója által megadott adatait.	Alapvető	FE
az apim api versionset update	Frissítések az Api VersionSet azonosító által megadott adatait.	Alapvető	FE

az apim api versionset create

Létrehoz egy API-verziókészletet.

az apim api versionset create --display-name
                              --resource-group
                              --service-name
                              --versioning-scheme
                              [--description]
                              [--if-match]
                              [--version-header-name]
                              [--version-query-name]
                              [--version-set-id]

Példák

Létrehoz egy Api-verziókészletet a verziósémával fejlécként.

az apim api versionset create --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId --display-name MyDisplayName --versioning-scheme "Header" --description MyDescription --version-header-name MyHeaderName

Létrehoz egy Api-verziókészletet, amely verziósémával rendelkezik lekérdezésként.

az apim api versionset create --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId --display-name MyDisplayName --versioning-scheme "Query" --description MyDescription --version-query-name MyQueryName

Kötelező paraméterek

--display-name

Szükséges. Az API-verziókészlet neve.

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

--versioning-scheme

Szükséges. Egy érték, amely meghatározza, hogy az API-verzióazonosító hol található egy HTTP-kérésben. A lehetséges értékek a következők: "Szegmens", "Lekérdezés", "Fejléc".

Opcionális paraméterek

--description

Az API verziókészletének leírása.

--if-match

Az entitás ETagje.

--version-header-name

Annak a HTTP-fejlécparaméternek a neve, amely az API-verziót jelzi, ha a versioningScheme értéke header.

--version-query-name

Annak a lekérdezési paraméternek a neve, amely az API-verziót jelzi, ha a versioningScheme értéke query.

--version-set-id

A kapcsolódó ApiVersionSet erőforrás-azonosítója.

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

Törli a megadott API-verziókészletet.

az apim api versionset delete --resource-group
                              --service-name
                              --version-set-id
                              [--if-match]

Példák

Törli a megadott API-verziókészletet.

az apim api versionset delete --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId

Kötelező paraméterek

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

--version-set-id

A kapcsolódó ApiVersionSet erőforrás-azonosítója.

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

Az API-verziókészletek gyűjteményét sorolja fel a megadott szolgáltatáspéldányban.

az apim api versionset list --resource-group
                            --service-name

Példák

Az API-verziókészletek gyűjteményét sorolja fel a megadott szolgáltatáspéldányban.

az apim api versionset list --resource-group MyResourceGroup --service-name MyServiceName

Kötelező paraméterek

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

Lekéri az api-verziókészlet azonosítója által megadott adatait.

az apim api versionset show --resource-group
                            --service-name
                            --version-set-id

Példák

Lekéri az api-verziókészlet azonosítója által megadott adatait.

az apim api versionset show --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId

Kötelező paraméterek

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

--version-set-id

A kapcsolódó ApiVersionSet erőforrás-azonosítója.

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

Frissítések az Api VersionSet azonosító által megadott adatait.

az apim api versionset update --resource-group
                              --service-name
                              --version-set-id
                              [--add]
                              [--description]
                              [--display-name]
                              [--force-string]
                              [--if-match]
                              [--remove]
                              [--set]
                              [--version-header-name]
                              [--version-query-name]
                              [--versioning-scheme]

Példák

Frissítések az Api VersionSet azonosító által megadott leírását, megjelenítendő nevét.

az apim api versionset update --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId --display-name MyNewDisplayName --description MyNewDescription

Frissítések az Api VersionSet azonosító által megadott verziósémát.

az apim api versionset update --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId --versioning-scheme "Query" --version-query-name MyNewQueryName

Kötelező paraméterek

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

--version-set-id

A kapcsolódó ApiVersionSet erőforrás-azonosítója.

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

Az API verziókészletének leírása.

--display-name

Szükséges. Az API-verziókészlet 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.

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

--version-header-name

Annak a HTTP-fejlécparaméternek a neve, amely az API-verziót jelzi, ha a versioningScheme értéke header.

--version-query-name

Annak a lekérdezési paraméternek a neve, amely az API-verziót jelzi, ha a versioningScheme értéke query.

--versioning-scheme

Szükséges. Egy érték, amely meghatározza, hogy az API-verzióazonosító hol található egy HTTP-kérésben. A lehetséges értékek a következők: "Szegmens", "Lekérdezés", "Fejléc".

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.