az apim api operation

Mengelola Operasi API Azure API Management.

Perintah

Nama	Deskripsi	Jenis	Status
az apim api operation create	Membuat operasi baru di API.	Core	GA
az apim api operation delete	Menghapus operasi yang ditentukan dalam API.	Core	GA
az apim api operation list	Mencantumkan kumpulan operasi untuk API yang ditentukan.	Core	GA
az apim api operation show	Mendapatkan detail Operasi API yang ditentukan oleh pengidentifikasinya.	Core	GA
az apim api operation update	Memperbarui detail operasi dalam API yang ditentukan oleh pengidentifikasinya.	Core	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
                             [--acquire-policy-token]
                             [--change-reference]
                             [--description]
                             [--if-match]
                             [--operation-id]
                             [--params --template-parameters]

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.

Properti	Nilai
Grup parameter:	API Arguments

--display-name

Required. Nama Operasi.

--method

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

Parameter berikut bersifat opsional, tetapi tergantung pada konteksnya, satu atau beberapa mungkin menjadi diperlukan agar perintah berhasil dijalankan.

--acquire-policy-token

Memperoleh token Azure Policy secara otomatis untuk operasi sumber daya ini.

Properti	Nilai
Grup parameter:	Global Policy Arguments

--change-reference

ID referensi perubahan terkait untuk operasi sumber daya ini.

Properti	Nilai
Grup parameter:	Global Policy Arguments

--description

Deskripsi operasi. Dapat mencakup 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

Tingkatkan verbositas pengelogan untuk menampilkan semua log debug.

Properti	Nilai
Nilai default:	False

--help -h

Tampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya tampilkan kesalahan, menekan peringatan.

Properti	Nilai
Nilai default:	False

--output -o

Format output.

Properti	Nilai
Nilai default:	json
Nilai yang diterima:	json, jsonc, none, table, tsv, yaml, yamlc

--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi dan contoh selengkapnya.

--subscription

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

--verbose

Tingkatkan verbositas pengelogan. Gunakan --debug untuk log debug penuh.

Properti	Nilai
Nilai default:	False

az apim api operation delete

Edit

Menghapus operasi yang ditentukan dalam API.

az apim api operation delete --api-id
                             --operation-id
                             --resource-group
                             --service-name
                             [--acquire-policy-token]
                             [--change-reference]
                             [--if-match]

Contoh

Menghapus operasi yang ditentukan dalam 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.

Properti	Nilai
Grup parameter:	API Arguments

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

Parameter berikut bersifat opsional, tetapi tergantung pada konteksnya, satu atau beberapa mungkin menjadi diperlukan agar perintah berhasil dijalankan.

--acquire-policy-token

Memperoleh token Azure Policy secara otomatis untuk operasi sumber daya ini.

Properti	Nilai
Grup parameter:	Global Policy Arguments

--change-reference

ID referensi perubahan terkait untuk operasi sumber daya ini.

Properti	Nilai
Grup parameter:	Global Policy Arguments

--if-match

ETag Entitas.

Parameter Global

--debug

Tingkatkan verbositas pengelogan untuk menampilkan semua log debug.

Properti	Nilai
Nilai default:	False

--help -h

Tampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya tampilkan kesalahan, menekan peringatan.

Properti	Nilai
Nilai default:	False

--output -o

Format output.

Properti	Nilai
Nilai default:	json
Nilai yang diterima:	json, jsonc, none, table, tsv, yaml, yamlc

--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi dan contoh selengkapnya.

--subscription

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

--verbose

Tingkatkan verbositas pengelogan. Gunakan --debug untuk log debug penuh.

Properti	Nilai
Nilai default:	False

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.

Properti	Nilai
Grup parameter:	API Arguments

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

Tingkatkan verbositas pengelogan untuk menampilkan semua log debug.

Properti	Nilai
Nilai default:	False

--help -h

Tampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya tampilkan kesalahan, menekan peringatan.

Properti	Nilai
Nilai default:	False

--output -o

Format output.

Properti	Nilai
Nilai default:	json
Nilai yang diterima:	json, jsonc, none, table, tsv, yaml, yamlc

--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi dan contoh selengkapnya.

--subscription

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

--verbose

Tingkatkan verbositas pengelogan. Gunakan --debug untuk log debug penuh.

Properti	Nilai
Nilai default:	False

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.

Properti	Nilai
Grup parameter:	API Arguments

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

Tingkatkan verbositas pengelogan untuk menampilkan semua log debug.

Properti	Nilai
Nilai default:	False

--help -h

Tampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya tampilkan kesalahan, menekan peringatan.

Properti	Nilai
Nilai default:	False

--output -o

Format output.

Properti	Nilai
Nilai default:	json
Nilai yang diterima:	json, jsonc, none, table, tsv, yaml, yamlc

--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi dan contoh selengkapnya.

--subscription

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

--verbose

Tingkatkan verbositas pengelogan. Gunakan --debug untuk log debug penuh.

Properti	Nilai
Nilai default:	False

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
                             [--acquire-policy-token]
                             [--add]
                             [--change-reference]
                             [--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.

Properti	Nilai
Grup parameter:	API Arguments

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

Parameter berikut bersifat opsional, tetapi tergantung pada konteksnya, satu atau beberapa mungkin menjadi diperlukan agar perintah berhasil dijalankan.

--acquire-policy-token

Memperoleh token Azure Policy secara otomatis untuk operasi sumber daya ini.

Properti	Nilai
Grup parameter:	Global Policy Arguments

--add

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

Properti	Nilai
Grup parameter:	Generic Update Arguments
Nilai default:	[]

--change-reference

ID referensi perubahan terkait untuk operasi sumber daya ini.

Properti	Nilai
Grup parameter:	Global Policy Arguments

--description

Deskripsi operasi. Dapat mencakup tag pemformatan HTML.

--display-name

Required. Nama Operasi.

--force-string

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

Properti	Nilai
Grup parameter:	Generic Update Arguments
Nilai default:	False

--if-match

ETag Entitas.

--method

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

Properti	Nilai
Grup parameter:	Generic Update Arguments
Nilai default:	[]

--set

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

Properti	Nilai
Grup parameter:	Generic Update Arguments
Nilai default:	[]

--url-template

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

Parameter Global

--debug

Tingkatkan verbositas pengelogan untuk menampilkan semua log debug.

Properti	Nilai
Nilai default:	False

--help -h

Tampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya tampilkan kesalahan, menekan peringatan.

Properti	Nilai
Nilai default:	False

--output -o

Format output.

Properti	Nilai
Nilai default:	json
Nilai yang diterima:	json, jsonc, none, table, tsv, yaml, yamlc

--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi dan contoh selengkapnya.

--subscription

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

--verbose

Tingkatkan verbositas pengelogan. Gunakan --debug untuk log debug penuh.

Properti	Nilai
Nilai default:	False

Saran dan Komentar

Apakah halaman ini membantu?