az apic api
Catatan
Referensi ini adalah bagian dari ekstensi
Perintah untuk mengelola API di API Center.
Nama | Deskripsi | Jenis | Status |
---|---|---|---|
az apic api create |
Daftarkan API baru atau perbarui API yang ada. |
Ekstensi | GA |
az apic api definition |
Perintah untuk mengelola definisi API di API Center. |
Ekstensi | GA |
az apic api definition create |
Buat definisi API baru atau perbarui definisi API yang ada. |
Ekstensi | GA |
az apic api definition delete |
Hapus definisi API yang ditentukan. |
Ekstensi | GA |
az apic api definition export-specification |
Mengekspor spesifikasi API. |
Ekstensi | GA |
az apic api definition import-specification |
Mengimpor spesifikasi API. |
Ekstensi | GA |
az apic api definition list |
Mencantumkan kumpulan definisi API. |
Ekstensi | GA |
az apic api definition show |
Dapatkan detail definisi API. |
Ekstensi | GA |
az apic api definition update |
Perbarui definisi API yang ada. |
Ekstensi | GA |
az apic api delete |
Hapus API yang ditentukan. |
Ekstensi | GA |
az apic api deployment |
Perintah untuk mengelola penyebaran API di API Center. |
Ekstensi | GA |
az apic api deployment create |
Buat penyebaran API baru atau perbarui penyebaran API yang ada. |
Ekstensi | GA |
az apic api deployment delete |
Menghapus penyebaran API. |
Ekstensi | GA |
az apic api deployment list |
Mencantumkan kumpulan penyebaran API. |
Ekstensi | GA |
az apic api deployment show |
Dapatkan detail penyebaran API. |
Ekstensi | GA |
az apic api deployment update |
Perbarui penyebaran API yang ada. |
Ekstensi | GA |
az apic api list |
Mencantumkan kumpulan API. |
Ekstensi | GA |
az apic api register |
Mendaftarkan API baru dengan versi, definisi, dan penyebaran terkait menggunakan file spesifikasi sebagai sumber kebenaran. Untuk saat ini kami hanya mendukung format OpenAPI JSON/YAML. |
Ekstensi | Pratayang |
az apic api show |
Dapatkan detail API. |
Ekstensi | GA |
az apic api update |
Perbarui API yang ada. |
Ekstensi | GA |
az apic api version |
Perintah untuk mengelola versi API di API Center. |
Ekstensi | GA |
az apic api version create |
Buat versi API baru atau perbarui versi API yang sudah ada. |
Ekstensi | GA |
az apic api version delete |
Hapus versi API yang ditentukan. |
Ekstensi | GA |
az apic api version list |
Mencantumkan kumpulan versi API. |
Ekstensi | GA |
az apic api version show |
Dapatkan detail versi API. |
Ekstensi | GA |
az apic api version update |
Perbarui versi API yang ada. |
Ekstensi | GA |
Daftarkan API baru atau perbarui API yang ada.
az apic api create --api-id
--resource-group
--service-name
--title
--type {graphql, grpc, rest, soap, webhook, websocket}
[--contacts]
[--custom-properties]
[--description]
[--external-documentation]
[--license]
[--summary]
Membuat API
az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST
Membuat API dengan properti kustom
az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST --custom-properties '{"public-facing":true}'
Membuat API dengan properti kustom menggunakan file json
az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST --custom-properties '@customProperties.json'
The id of the API.
Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>
.
Nama layanan Azure API Center.
Judul API.
Jenis API.
Informasi kontak untuk API. Mendukung shorthand-sintaks, json-file dan yaml-file. Coba "??" untuk menunjukkan lebih banyak.
Metadata kustom yang ditentukan untuk entitas katalog API. Mendukung json-file dan yaml-file.
Deskripsi API.
Dokumentasi eksternal tambahan untuk API. Mendukung shorthand-sintaks, json-file dan yaml-file. Coba "??" untuk menunjukkan lebih banyak.
Informasi lisensi untuk API. Mendukung shorthand-sintaks, json-file dan yaml-file. Coba "??" untuk menunjukkan lebih banyak.
Deskripsi singkat api.
Parameter Global
Tingkatkan verbositas pengelogan untuk menampilkan semua log debug.
Tampilkan pesan bantuan ini dan keluar.
Hanya tampilkan kesalahan, menekan peringatan.
Format output.
String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi dan contoh selengkapnya.
Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID
.
Tingkatkan verbositas pengelogan. Gunakan --debug untuk log debug penuh.
Hapus API yang ditentukan.
az apic api delete [--api-id]
[--ids]
[--resource-group]
[--service-name]
[--subscription]
[--yes]
Hapus API
az apic api delete -g contoso-resources -n contoso --api-id echo-api
The id of the API.
Satu atau beberapa ID sumber daya (dibatasi spasi). Ini harus menjadi ID sumber daya lengkap yang berisi semua informasi argumen 'Id Sumber Daya'. Anda harus menyediakan argumen --ids atau 'Resource Id' lainnya.
Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>
.
Nama layanan Azure API Center.
Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID
.
Jangan meminta konfirmasi.
Parameter Global
Tingkatkan verbositas pengelogan untuk menampilkan semua log debug.
Tampilkan pesan bantuan ini dan keluar.
Hanya tampilkan kesalahan, menekan peringatan.
Format output.
String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi dan contoh selengkapnya.
Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID
.
Tingkatkan verbositas pengelogan. Gunakan --debug untuk log debug penuh.
Mencantumkan kumpulan API.
az apic api list --resource-group
--service-name
[--filter]
[--max-items]
[--next-token]
Mencantumkan API
az apic api list -g contoso-resources -n contoso
Mencantumkan API dengan filter
az apic api list -g contoso-resources -n contoso --filter "kind eq 'rest'"
Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>
.
Nama layanan Azure API Center.
Parameter filter OData.
Jumlah total item yang akan dikembalikan dalam output perintah. Jika jumlah total item yang tersedia lebih dari nilai yang ditentukan, token disediakan dalam output perintah. Untuk melanjutkan penomoran halaman, berikan nilai token dalam argumen --next-token
dari perintah berikutnya.
Token untuk menentukan tempat untuk memulai paginating. Ini adalah nilai token dari respons yang dipotong sebelumnya.
Parameter Global
Tingkatkan verbositas pengelogan untuk menampilkan semua log debug.
Tampilkan pesan bantuan ini dan keluar.
Hanya tampilkan kesalahan, menekan peringatan.
Format output.
String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi dan contoh selengkapnya.
Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID
.
Tingkatkan verbositas pengelogan. Gunakan --debug untuk log debug penuh.
Perintah ini sedang dalam pratinjau dan sedang dalam pengembangan. Tingkat referensi dan dukungan: https://aka.ms/CLI_refstatus
Mendaftarkan API baru dengan versi, definisi, dan penyebaran terkait menggunakan file spesifikasi sebagai sumber kebenaran. Untuk saat ini kami hanya mendukung format OpenAPI JSON/YAML.
az apic api register --api-location
--resource-group
--service-name
[--environment-id]
Daftarkan api dengan menyediakan file spesifikasi.
az apic api register -g api-center-test -n contosoeuap --api-location "examples/cli-examples/spec-examples/openai.json" --environment-id public
az apic api register -g api-center-test -n contosoeuap --api-location "examples/cli-examples/spec-examples/openai.yml" --environment-id public
Daftarkan api dengan menyediakan url spesifikasi.
az apic api register -g api-center-test -n contosoeuap --api-location "https://petstore.swagger.io/v2/swagger.json" --environment-id public
az apic api register -g api-center-test -n contosoeuap --api-location "https://petstore.swagger.io/v2/swagger.yaml" --environment-id public
Lokasi file spesifikasi.
Nama grup sumber daya.
Katalog APICenter atau Nama layanan.
Id lingkungan yang dibuat sebelumnya.
Parameter Global
Tingkatkan verbositas pengelogan untuk menampilkan semua log debug.
Tampilkan pesan bantuan ini dan keluar.
Hanya tampilkan kesalahan, menekan peringatan.
Format output.
String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi dan contoh selengkapnya.
Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID
.
Tingkatkan verbositas pengelogan. Gunakan --debug untuk log debug penuh.
Dapatkan detail API.
az apic api show [--api-id]
[--ids]
[--resource-group]
[--service-name]
[--subscription]
Tampilkan detail API
az apic api show -g contoso-resources -n contoso --api-id echo-api
The id of the API.
Satu atau beberapa ID sumber daya (dibatasi spasi). Ini harus menjadi ID sumber daya lengkap yang berisi semua informasi argumen 'Id Sumber Daya'. Anda harus menyediakan argumen --ids atau 'Resource Id' lainnya.
Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>
.
Nama layanan Azure API Center.
Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID
.
Parameter Global
Tingkatkan verbositas pengelogan untuk menampilkan semua log debug.
Tampilkan pesan bantuan ini dan keluar.
Hanya tampilkan kesalahan, menekan peringatan.
Format output.
String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi dan contoh selengkapnya.
Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID
.
Tingkatkan verbositas pengelogan. Gunakan --debug untuk log debug penuh.
Perbarui API yang ada.
az apic api update [--add]
[--api-id]
[--contacts]
[--custom-properties]
[--description]
[--external-documentation]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--license]
[--remove]
[--resource-group]
[--service-name]
[--set]
[--subscription]
[--summary]
[--title]
[--type {graphql, grpc, rest, soap, webhook, websocket}]
Perbarui API
az apic api update -g contoso-resources -n contoso --api-id echo-api --summary "Basic REST API service"
Memperbarui properti kustom
az apic api update -g contoso-resources -n contoso --api-id echo-api --custom-properties '{"public-facing":true}'
Memperbarui properti kustom menggunakan file json
az apic api update -g contoso-resources -n contoso --api-id echo-api --custom-properties '@customProperities.json'
Memperbarui metadata kustom tunggal
az apic api update -g contoso-resources -n contoso --api-id echo-api --set customProperties.internal=false
Tambahkan objek ke daftar objek dengan menentukan jalur dan pasangan nilai kunci. Contoh: --add property.listProperty <key=value, string or JSON string>
.
The id of the API.
Informasi kontak untuk API. Mendukung shorthand-sintaks, json-file dan yaml-file. Coba "??" untuk menunjukkan lebih banyak.
Metadata kustom yang ditentukan untuk entitas katalog API. Mendukung json-file dan yaml-file.
Deskripsi API.
Dokumentasi eksternal tambahan untuk API. Mendukung shorthand-sintaks, json-file dan yaml-file. Coba "??" untuk menunjukkan lebih banyak.
Saat menggunakan 'set' atau 'add', pertahankan literal string alih-alih mencoba mengonversi ke JSON.
Satu atau beberapa ID sumber daya (dibatasi spasi). Ini harus menjadi ID sumber daya lengkap yang berisi semua informasi argumen 'Id Sumber Daya'. Anda harus menyediakan argumen --ids atau 'Resource Id' lainnya.
Informasi lisensi untuk API. Mendukung shorthand-sintaks, json-file dan yaml-file. Coba "??" untuk menunjukkan lebih banyak.
Menghapus properti atau elemen dari daftar. Contoh: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>
.
Nama layanan Azure API Center.
Perbarui objek dengan menentukan jalur properti dan nilai yang akan diatur. Contoh: --set property1.property2=<value>
.
Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID
.
Deskripsi singkat api.
Judul API.
Jenis API.
Parameter Global
Tingkatkan verbositas pengelogan untuk menampilkan semua log debug.
Tampilkan pesan bantuan ini dan keluar.
Hanya tampilkan kesalahan, menekan peringatan.
Format output.
String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi dan contoh selengkapnya.
Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID
.
Tingkatkan verbositas pengelogan. Gunakan --debug untuk log debug penuh.
Umpan balik Azure CLI
Azure CLI adalah proyek sumber terbuka. Pilih tautan untuk memberikan umpan balik: