az apim api versionset

  • Referensi

Mengelola Set Versi API Management Azure.

Perintah

Nama Deskripsi Jenis Status
az apim api versionset create

Membuat Set Versi Api.

 Inti GA
az apim api versionset delete

Menghapus Kumpulan Versi Api tertentu.

 Inti GA
az apim api versionset list

Mencantumkan kumpulan Versi API dalam instans layanan yang ditentukan.

 Inti GA
az apim api versionset show

Mendapatkan detail Set Versi Api yang ditentukan oleh pengidentifikasinya.

 Inti GA
az apim api versionset update

Memperbarui detail Api VersionSet yang ditentukan oleh pengidentifikasinya.

 Inti GA

az apim api versionset create

Edit

Membuat Set Versi Api.

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]

Contoh

Membuat Set Versi Api dengan skema versi sebagai header.

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

Membuat Set Versi Api dengan skema versi sebagai kueri.

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

Parameter yang Diperlukan

--display-name

Harus diisi. Nama Set Versi API.

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--service-name -n

Nama instans layanan API Management.

--versioning-scheme

Harus diisi. Nilai yang menentukan di mana identifer Versi API akan berada dalam permintaan HTTP. Nilai yang mungkin termasuk: 'Segment', 'Query', 'Header'.

Parameter Opsional

--description

Deskripsi Set Versi API.

--if-match

ETag Entitas.

--version-header-name

Nama parameter header HTTP yang menunjukkan Versi API jika penerapan versiScheme diatur ke header.

--version-query-name

Nama parameter kueri yang menunjukkan Versi API jika penerapan versiScheme diatur ke query.

--version-set-id

Pengidentifikasi sumber daya untuk ApiVersionSet terkait.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az apim api versionset delete

Edit

Menghapus Kumpulan Versi Api tertentu.

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

Contoh

Menghapus Kumpulan Versi Api tertentu.

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

Parameter yang Diperlukan

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--service-name -n

Nama instans layanan API Management.

--version-set-id

Pengidentifikasi sumber daya untuk ApiVersionSet terkait.

Parameter Opsional

--if-match

ETag Entitas.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az apim api versionset list

Edit

Mencantumkan kumpulan Versi API dalam instans layanan yang ditentukan.

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

Contoh

Mencantumkan kumpulan Versi API dalam instans layanan yang ditentukan.

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

Parameter yang Diperlukan

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--service-name -n

Nama instans layanan API Management.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az apim api versionset show

Edit

Mendapatkan detail Set Versi Api yang ditentukan oleh pengidentifikasinya.

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

Contoh

Mendapatkan detail Set Versi Api yang ditentukan oleh pengidentifikasinya.

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

Parameter yang Diperlukan

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--service-name -n

Nama instans layanan API Management.

--version-set-id

Pengidentifikasi sumber daya untuk ApiVersionSet terkait.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az apim api versionset update

Edit

Memperbarui detail Api VersionSet yang ditentukan oleh pengidentifikasinya.

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]

Contoh

Memperbarui deskripsi, nama tampilan Api VersionSet yang ditentukan oleh pengidentifikasinya.

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

Memperbarui skema versi Api VersionSet yang ditentukan oleh pengidentifikasinya.

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

Parameter yang Diperlukan

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--service-name -n

Nama instans layanan API Management.

--version-set-id

Pengidentifikasi sumber daya untuk ApiVersionSet terkait.

Parameter Opsional

--add

Tambahkan objek ke daftar objek dengan menentukan jalur dan pasangan nilai kunci. Contoh: --add property.listProperty <key=value, string or JSON string>.

nilai default: []
--description

Deskripsi Set Versi API.

--display-name

Harus diisi. Nama Set Versi API.

--force-string

Saat menggunakan 'set' atau 'add', pertahankan literal string alih-alih mencoba mengonversi ke JSON.

nilai default: False
--if-match

ETag Entitas.

--remove

Menghapus properti atau elemen dari daftar. Contoh: --remove property.list <indexToRemove> ATAU --remove propertyToRemove.

nilai default: []
--set

Perbarui objek dengan menentukan jalur properti dan nilai yang akan diatur. Contoh: --set property1.property2=<value>.

nilai default: []
--version-header-name

Nama parameter header HTTP yang menunjukkan Versi API jika penerapan versiScheme diatur ke header.

--version-query-name

Nama parameter kueri yang menunjukkan Versi API jika penerapan versiScheme diatur ke query.

--versioning-scheme

Harus diisi. Nilai yang menentukan di mana identifer Versi API akan berada dalam permintaan HTTP. Nilai yang mungkin termasuk: 'Segment', 'Query', 'Header'.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.