Bagikan melalui

az apic

  • Referensi

Catatan

Referensi ini adalah bagian dari ekstensi apic-extension untuk Azure CLI (versi 2.57.0 atau yang lebih tinggi). Ekstensi akan secara otomatis menginstal pertama kali Anda menjalankan perintah az apic . Pelajari lebih lanjut tentang ekstensi.

Mengelola layanan Azure API Center.

Perintah

Nama Deskripsi Jenis Status
az apic api

Perintah untuk mengelola API di API Center.

 Ekstensi GA
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 Pratinjau
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
az apic create

Membuat instans atau memperbarui instans layanan Azure API Center yang ada.

 Ekstensi GA
az apic delete

Menghapus instans layanan Azure API Center.

 Ekstensi GA
az apic environment

Perintah untuk mengelola lingkungan di API Center.

 Ekstensi GA
az apic environment create

Buat lingkungan baru atau perbarui lingkungan yang sudah ada.

 Ekstensi GA
az apic environment delete

Hapus lingkungan.

 Ekstensi GA
az apic environment list

Mencantumkan kumpulan lingkungan.

 Ekstensi GA
az apic environment show

Dapatkan detail lingkungan.

 Ekstensi GA
az apic environment update

Perbarui lingkungan yang ada.

 Ekstensi GA
az apic import-from-apim

Mengimpor API dari instans layanan Azure API Management.

 Ekstensi GA
az apic list

Mencantumkan layanan Azure API Center dalam langganan Azure.

 Ekstensi GA
az apic metadata

Perintah untuk mengelola skema metadata di API Center.

 Ekstensi GA
az apic metadata create

Buat skema metadata baru atau perbarui skema metadata yang ada.

 Ekstensi GA
az apic metadata delete

Hapus skema metadata yang ditentukan.

 Ekstensi GA
az apic metadata export

Mengekspor skema metadata.

 Ekstensi GA
az apic metadata list

Mencantumkan kumpulan skema metadata.

 Ekstensi GA
az apic metadata show

Dapatkan detail skema metadata.

 Ekstensi GA
az apic metadata update

Perbarui skema metadata yang ada.

 Ekstensi GA
az apic show

Menampilkan detail instans layanan Azure API Center.

 Ekstensi GA
az apic update

Memperbarui instans layanan Azure API Center.

 Ekstensi GA

az apic create

Membuat instans atau memperbarui instans layanan Azure API Center yang ada.

az apic create --name
               --resource-group
               [--identity]
               [--location]
               [--tags]

Contoh

Buat Contoh layanan 1

az apic create -g contoso-resources -n contoso -l eastus

Buat Contoh Layanan 2

az apic create --resource-group contoso-resources --name contoso --location eastus

Parameter yang Diperlukan

--name -n

Nama layanan API Center.

--resource-group -g

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

Parameter Opsional

--identity

Identitas layanan terkelola yang ditetapkan ke sumber daya ini. Mendukung shorthand-sintaks, json-file dan yaml-file. Coba "??" untuk menunjukkan lebih banyak.

--location -l

Lokasi geografis tempat sumber daya berada Ketika tidak ditentukan, lokasi grup sumber daya akan digunakan.

--tags

Tag sumber daya. Mendukung shorthand-sintaks, json-file dan yaml-file. Coba "??" untuk menunjukkan lebih banyak.

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

Menghapus instans layanan Azure API Center.

az apic delete [--ids]
               [--name]
               [--resource-group]
               [--subscription]
               [--yes]

Contoh

Hapus layanan

az apic delete -n contoso -g contoso-resources

Parameter Opsional

--ids

Satu atau beberapa ID sumber daya (dibatasi ruang). Ini harus menjadi ID sumber daya lengkap yang berisi semua informasi argumen 'Id Sumber Daya'. Anda harus menyediakan argumen --ids atau 'Resource Id' lainnya.

--name -n

Nama layanan API Center.

--resource-group -g

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

--subscription

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

--yes -y

Jangan meminta konfirmasi.

Nilai default: False
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 apic import-from-apim

Mengimpor API dari instans layanan Azure API Management.

az apic import-from-apim --apim-apis
                         --apim-name
                         [--apim-resource-group]
                         [--apim-subscription]
                         [--ids]
                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                         [--resource-group]
                         [--service-name]
                         [--subscription]

Contoh

Mengimpor semua API dari APIM dalam grup sumber daya yang sama

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-name contoso-apim --apim-apis *

Mengimpor API yang dipilih dari APIM dalam grup sumber daya yang sama

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-name contoso-apim --apim-apis [echo,foo]

Mengimpor semua API dari APIM di langganan dan grup sumber daya lain

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-subscription 00000000-0000-0000-0000-000000000000 --apim-resource-group apim-rg --apim-name contoso-apim --apim-apis *

Parameter yang Diperlukan

--apim-apis

API yang akan diimpor. Mendukung shorthand-sintaks, json-file dan yaml-file. Coba "??" untuk menunjukkan lebih banyak.

--apim-name

Nama instans APIM sumber.

Parameter Opsional

--apim-resource-group

Grup sumber daya instans APIM sumber.

--apim-subscription

Id langganan instans APIM sumber.

--ids

Satu atau beberapa ID sumber daya (dibatasi ruang). Ini harus menjadi ID sumber daya lengkap yang berisi semua informasi argumen 'Id Sumber Daya'. Anda harus menyediakan argumen --ids atau 'Resource Id' lainnya.

--no-wait

Jangan menunggu operasi jangka panjang selesai.

Nilai yang diterima: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

--service-name -n

Nama layanan Azure API Center.

--subscription

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

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

Mencantumkan layanan Azure API Center dalam langganan Azure.

Ada masalah yang diketahui bahwa mencantumkan semua sumber daya di bawah langganan tidak berfungsi. Silakan cantumkan sumber daya menurut grup sumber daya.

az apic list [--max-items]
             [--next-token]
             [--resource-group]

Contoh

Mencantumkan layanan dalam grup sumber daya

az apic list -g contoso-resources

Parameter Opsional

--max-items

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 --next-token argumen perintah berikutnya.

--next-token

Token untuk menentukan tempat untuk memulai paginating. Ini adalah nilai token dari respons yang dipotong sebelumnya.

--resource-group -g

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

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

Menampilkan detail instans layanan Azure API Center.

az apic show [--ids]
             [--name]
             [--resource-group]
             [--subscription]

Contoh

Perlihatkan detail layanan

az apic show -g contoso-resources -n contoso

Parameter Opsional

--ids

Satu atau beberapa ID sumber daya (dibatasi ruang). Ini harus menjadi ID sumber daya lengkap yang berisi semua informasi argumen 'Id Sumber Daya'. Anda harus menyediakan argumen --ids atau 'Resource Id' lainnya.

--name -n

Nama layanan API Center.

--resource-group -g

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

--subscription

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

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

Memperbarui instans layanan Azure API Center.

az apic update [--add]
               [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
               [--identity]
               [--ids]
               [--name]
               [--remove]
               [--resource-group]
               [--set]
               [--subscription]
               [--tags]

Contoh

Memperbarui detail layanan

az apic update -g contoso-resources -n contoso

Parameter Opsional

--add

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

--force-string

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

Nilai yang diterima: 0, 1, f, false, n, no, t, true, y, yes
--identity

Identitas layanan terkelola yang ditetapkan ke sumber daya ini. Mendukung shorthand-sintaks, json-file dan yaml-file. Coba "??" untuk menunjukkan lebih banyak.

--ids

Satu atau beberapa ID sumber daya (dibatasi ruang). Ini harus menjadi ID sumber daya lengkap yang berisi semua informasi argumen 'Id Sumber Daya'. Anda harus menyediakan argumen --ids atau 'Resource Id' lainnya.

--name -n

Nama layanan API Center.

--remove

Menghapus properti atau elemen dari daftar. Contoh: --remove property.list OR --remove propertyToRemove.

--resource-group -g

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

--set

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

--subscription

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

--tags

Tag sumber daya. Mendukung shorthand-sintaks, json-file dan yaml-file. Coba "??" untuk menunjukkan lebih banyak.

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.