az apim api operation

  • Referensi

Mengelola Operasi API Api Management Azure.

Perintah

Nama Deskripsi Jenis Status
az apim api operation create

Membuat operasi baru di API.

 Inti GA
az apim api operation delete

Menghapus operasi yang ditentukan di API.

 Inti GA
az apim api operation list

Mencantumkan kumpulan operasi untuk API yang ditentukan.

 Inti GA
az apim api operation show

Mendapatkan detail Operasi API yang ditentukan oleh pengidentifikasinya.

 Inti GA
az apim api operation update

Memperbarui detail operasi dalam API yang ditentukan oleh pengidentifikasinya.

 Inti GA

az apim api operation create

Edit

Membuat operasi baru di API.

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

Contoh

Membuat operasi baru di API dengan beberapa parameter

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"

Parameter yang Diperlukan

--api-id

Pengidentifikasi API. Harus unik dalam instans layanan API Management saat ini. Revisi non-saat ini memiliki ; rev=n sebagai akhiran di mana n adalah nomor revisi.

--display-name

Harus diisi. Nama Operasi.

--method

Harus diisi. Metode Operasi HTTP yang valid. Metode Http umum seperti GET, PUT, POST tetapi tidak hanya dibatasi olehnya.

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

--url-template

Templat URL relatif mengidentifikasi sumber daya target untuk operasi ini. Dapat mencakup parameter.

Parameter Opsional

--description

Deskripsi operasi. Mungkin menyertakan tag pemformatan HTML.

--if-match

ETag Entitas.

--operation-id

Pengidentifikasi operasi dalam API. Harus unik dalam instans layanan API Management saat ini.

--params --template-parameters -p

Kumpulan parameter templat URL.

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

Edit

Menghapus operasi yang ditentukan di API.

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

Contoh

Menghapus operasi yang ditentukan di API.

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

Parameter yang Diperlukan

--api-id

Pengidentifikasi API. Harus unik dalam instans layanan API Management saat ini. Revisi non-saat ini memiliki ; rev=n sebagai akhiran di mana n adalah nomor revisi.

--operation-id

Pengidentifikasi operasi dalam API. Harus unik dalam instans layanan API Management saat ini.

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

Edit

Mencantumkan kumpulan operasi untuk API yang ditentukan.

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

Contoh

Mencantumkan kumpulan operasi untuk API yang ditentukan.

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

Parameter yang Diperlukan

--api-id

Pengidentifikasi API. Harus unik dalam instans layanan API Management saat ini. Revisi non-saat ini memiliki ; rev=n sebagai akhiran di mana n adalah nomor revisi.

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

Edit

Mendapatkan detail Operasi API yang ditentukan oleh pengidentifikasinya.

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

Contoh

Mendapatkan detail Operasi API yang ditentukan oleh pengidentifikasinya.

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

Parameter yang Diperlukan

--api-id

Pengidentifikasi API. Harus unik dalam instans layanan API Management saat ini. Revisi non-saat ini memiliki ; rev=n sebagai akhiran di mana n adalah nomor revisi.

--operation-id

Pengidentifikasi operasi dalam API. Harus unik dalam instans layanan API Management saat ini.

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

Edit

Memperbarui detail operasi dalam API yang ditentukan oleh pengidentifikasinya.

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]

Contoh

Metode pembaruan, nama tampilan, deskripsi operasi dalam API yang ditentukan oleh pengidentifikasinya.

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

Parameter yang Diperlukan

--api-id

Pengidentifikasi API. Harus unik dalam instans layanan API Management saat ini. Revisi non-saat ini memiliki ; rev=n sebagai akhiran di mana n adalah nomor revisi.

--operation-id

Pengidentifikasi operasi dalam API. Harus unik dalam instans layanan API Management saat ini.

--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 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 operasi. Mungkin menyertakan tag pemformatan HTML.

--display-name

Harus diisi. Nama Operasi.

--force-string

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

nilai default: False
--if-match

ETag Entitas.

--method

Harus diisi. Metode Operasi HTTP yang valid. Metode Http umum seperti GET, PUT, POST tetapi tidak hanya dibatasi olehnya.

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

Templat URL relatif mengidentifikasi sumber daya target untuk operasi ini. Dapat mencakup parameter.

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.