Bagikan melalui


az apim

Mengelola layanan Azure API Management.

Perintah

Nama Deskripsi Jenis Status
az apim api

Mengelola API Management Azure API.

Core GA
az apim api create

Buat API Management API.

Core GA
az apim api delete

Menghapus API Management.

Core GA
az apim api export

Mengekspor API Management API.

Core GA
az apim api import

Mengimpor API Management.

Core GA
az apim api list

Mencantumkan API Management API.

Core GA
az apim api operation

Mengelola Operasi API Api Management Azure.

Core GA
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 release

Mengelola Rilis API Api Management Azure.

Core GA
az apim api release create

Membuat Rilis baru untuk API.

Core GA
az apim api release delete

Menghapus rilis yang ditentukan di API.

Core GA
az apim api release list

Mencantumkan semua rilis API.

Core GA
az apim api release show

Mengembalikan detail rilis API.

Core GA
az apim api release update

Memperbarui detail rilis API yang ditentukan oleh pengidentifikasinya.

Core GA
az apim api revision

Mengelola Revisi API Api Management Azure.

Core GA
az apim api revision create

Buat revisi API.

Core GA
az apim api revision list

Mencantumkan semua revisi API.

Core GA
az apim api schema

Mengelola Skema API Api Management Azure.

Core GA
az apim api schema create

Buat Skema API Management API.

Core GA
az apim api schema delete

Menghapus Skema API Management API.

Core GA
az apim api schema get-etag

Dapatkan etag skema API Management API.

Core GA
az apim api schema list

Mencantumkan skema API Management API.

Core GA
az apim api schema show

Menampilkan detail Skema API Management API.

Core GA
az apim api schema wait

Tempatkan CLI dalam status menunggu sampai kondisi skema apim api terpenuhi.

Core GA
az apim api show

Menampilkan detail API Management.

Core GA
az apim api update

Perbarui API Management API.

Core GA
az apim api versionset

Mengelola Set Versi API Management Azure.

Core GA
az apim api versionset create

Membuat Set Versi Api.

Core GA
az apim api versionset delete

Menghapus Set Versi Api tertentu.

Core GA
az apim api versionset list

Mencantumkan kumpulan Set Versi API dalam instans layanan yang ditentukan.

Core GA
az apim api versionset show

Mendapatkan detail Set Versi Api yang ditentukan oleh pengidentifikasinya.

Core GA
az apim api versionset update

Memperbarui detail Api VersionSet yang ditentukan oleh pengidentifikasinya.

Core GA
az apim api wait

Tempatkan CLI dalam status tunggu hingga kondisi apim terpenuhi.

Core GA
az apim apply-network-updates

Perbarui sumber daya API Management yang berjalan di jaringan virtual untuk memilih pengaturan jaringan yang diperbarui.

Core GA
az apim backup

Membuat cadangan layanan API Management ke Akun Azure Storage yang diberikan. Ini adalah operasi jangka panjang dan bisa memakan waktu beberapa menit untuk diselesaikan.

Core GA
az apim check-name

Memeriksa untuk melihat apakah nama layanan tersedia untuk digunakan.

Core GA
az apim create

Buat instans layanan API Management.

Core GA
az apim delete

Menghapus layanan API Management.

Core GA
az apim deletedservice

Mengelola layanan Azure API Management yang dihapus sementara.

Core GA
az apim deletedservice list

Cantumkan semua instans layanan Api Management yang dihapus sementara yang tersedia untuk batal dihapus untuk langganan yang diberikan.

Core GA
az apim deletedservice purge

Hapus menyeluruh instans layanan Api Management yang dihapus sementara (menghapusnya tanpa opsi untuk membatalkan penghapusan).

Core GA
az apim deletedservice show

Dapatkan instans layanan Api Management yang dihapus sementara yang tersedia untuk membatalkan penghapusan berdasarkan nama.

Core GA
az apim graphql

Mengelola API Azure API Management GraphQL API.

Core GA
az apim graphql resolver

Mengelola Pemecah Masalah API Azure API Management GraphQL.

Core GA
az apim graphql resolver create

Buat resolver baru di GraphQL API atau perbarui yang sudah ada.

Core GA
az apim graphql resolver delete

Hapus resolver yang ditentukan di GraphQL API.

Core GA
az apim graphql resolver list

Mencantumkan kumpulan resolver untuk API GraphQL yang ditentukan.

Core GA
az apim graphql resolver policy

Mengelola Kebijakan Pemecah Masalah API Azure API Management GraphQL.

Core GA
az apim graphql resolver policy create

Membuat atau memperbarui konfigurasi kebijakan untuk tingkat Pemecah Masalah GraphQL API.

Core GA
az apim graphql resolver policy delete

Hapus konfigurasi kebijakan di GraphQL Api Resolver.

Core GA
az apim graphql resolver policy list

Dapatkan daftar konfigurasi kebijakan di tingkat Pemecah Masalah GraphQL API.

Core GA
az apim graphql resolver policy show

Dapatkan konfigurasi kebijakan di tingkat Pemecah Masalah GraphQL API.

Core GA
az apim graphql resolver show

Dapatkan detail Resolver API GraphQL yang ditentukan oleh pengidentifikasinya.

Core GA
az apim list

Mencantumkan instans layanan API Management.

Core GA
az apim nv

Mengelola Nilai Bernama Azure API Management.

Core GA
az apim nv create

Buat API Management Bernama Value.

Core GA
az apim nv delete

Menghapus Nilai Bernama API Management.

Core GA
az apim nv list

Mencantumkan Nilai Bernama API Management.

Core GA
az apim nv show

Tampilkan detail API Management Bernama Value.

Core GA
az apim nv show-secret

Mendapatkan rahasia API Management Named Value.

Core GA
az apim nv update

Perbarui Nilai Bernama API Management.

Core GA
az apim nv wait

Tempatkan CLI dalam status tunggu hingga kondisi apim bernama value terpenuhi.

Core GA
az apim product

Mengelola Produk Azure API Management.

Core GA
az apim product api

Mengelola API Produk Azure API Management.

Core GA
az apim product api add

Tambahkan API ke produk yang ditentukan.

Core GA
az apim product api check

Memeriksa apakah entitas API yang ditentukan oleh pengidentifikasi dikaitkan dengan entitas Produk.

Core GA
az apim product api delete

Menghapus API yang ditentukan dari produk yang ditentukan.

Core GA
az apim product api list

Mencantumkan koleksi API yang terkait dengan produk.

Core GA
az apim product create

Membuat produk.

Core GA
az apim product delete

Hapus produk.

Core GA
az apim product list

Mencantumkan kumpulan produk dalam instans layanan yang ditentukan.

Core GA
az apim product show

Mendapatkan detail produk yang ditentukan oleh pengidentifikasinya.

Core GA
az apim product update

Perbarui detail produk yang ada.

Core GA
az apim product wait

Tempatkan CLI dalam status tunggu sampai kondisi produk apim terpenuhi.

Core GA
az apim restore

Memulihkan cadangan layanan API Management yang dibuat menggunakan operasi ApiManagementService_Backup pada layanan saat ini. Ini adalah operasi jangka panjang dan bisa memakan waktu beberapa menit untuk diselesaikan.

Core GA
az apim show

Menampilkan detail instans layanan API Management.

Core GA
az apim update

Perbarui instans layanan API Management.

Core GA
az apim wait

Tempatkan CLI dalam status menunggu hingga kondisi apim terpenuhi.

Core GA

az apim apply-network-updates

Perbarui sumber daya API Management yang berjalan di jaringan virtual untuk memilih pengaturan jaringan yang diperbarui.

az apim apply-network-updates --name
                              --resource-group
                              [--location]
                              [--no-wait]

Contoh

Memperbarui pengaturan jaringan virtual instans layanan API Management

az apim apply-network-updates --name MyApim -g MyResourceGroup

Parameter yang Diperlukan

--name -n

Nama instans layanan api management.

--resource-group -g

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

Parameter Opsional

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

--location -l

Location. Nilai dari: az account list-locations. Anda dapat mengonfigurasi lokasi default menggunakan az configure --defaults location=<location>.

--no-wait

Jangan menunggu operasi jangka panjang selesai.

Properti Nilai
Nilai default: False
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 backup

Membuat cadangan layanan API Management ke Akun Azure Storage yang diberikan. Ini adalah operasi jangka panjang dan bisa memakan waktu beberapa menit untuk diselesaikan.

az apim backup --backup-name
               --container-name --storage-account-container
               --name
               --resource-group
               --storage-account-key
               --storage-account-name
               [--no-wait]

Contoh

Membuat cadangan instans layanan API Management

az apim backup --name MyApim -g MyResourceGroup --backup-name myBackup              --storage-account-name mystorageaccount --storage-account-container backups              --storage-account-key Ay2ZbdxLnD4OJPT29F6jLPkB6KynOzx85YCObhrw==

Parameter yang Diperlukan

--backup-name

Nama file cadangan yang akan dibuat.

--container-name --storage-account-container

Nama kontainer akun penyimpanan yang digunakan untuk menempatkan cadangan.

--name -n

Nama instans layanan api management.

--resource-group -g

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

--storage-account-key

Kunci akses akun penyimpanan yang digunakan untuk menempatkan cadangan.

Properti Nilai
Grup parameter: Storage Arguments
--storage-account-name

Nama akun penyimpanan yang digunakan untuk menempatkan cadangan.

Properti Nilai
Grup parameter: Storage Arguments

Parameter Opsional

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

--no-wait

Jangan menunggu operasi jangka panjang selesai.

Properti Nilai
Nilai default: False
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 check-name

Memeriksa untuk melihat apakah nama layanan tersedia untuk digunakan.

az apim check-name --name

Parameter yang Diperlukan

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

Buat instans layanan API Management.

az apim create --name
               --publisher-email
               --publisher-name
               --resource-group
               [--disable-gateway {false, true}]
               [--enable-client-certificate {false, true}]
               [--enable-managed-identity {false, true}]
               [--location]
               [--no-wait]
               [--public-network-access {false, true}]
               [--sku-capacity]
               [--sku-name {Basic, Consumption, Developer, Isolated, Premium, Standard}]
               [--tags]
               [--virtual-network {External, Internal, None}]

Contoh

Buat layanan API Management tingkat Pengembang.

az apim create --name MyApim -g MyResourceGroup -l eastus --publisher-email email@mydomain.com --publisher-name Microsoft

Buat layanan API Management tingkat Konsumsi.

az apim create --name MyApim -g MyResourceGroup -l eastus --sku-name Consumption --enable-client-certificate \
    --publisher-email email@mydomain.com --publisher-name Microsoft

Parameter yang Diperlukan

--name -n

Nama unik instans layanan yang akan dibuat.

Nama harus unik secara global karena akan disertakan sebagai nama host gateway seperti' https://my-api-servicename.azure-api.net'. Lihat contoh.

--publisher-email

Alamat email untuk menerima semua pemberitahuan sistem.

--publisher-name

Nama organisasi Anda untuk digunakan di portal pengembang dan pemberitahuan email.

--resource-group -g

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

Parameter Opsional

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

--disable-gateway

Nonaktifkan gateway di wilayah master. Hanya berlaku untuk layanan Api Management yang disebarkan di beberapa lokasi.

Properti Nilai
Nilai yang diterima: false, true
--enable-client-certificate

Memberlakukan sertifikat klien untuk disajikan pada setiap permintaan ke gateway dan juga memungkinkan kemampuan untuk mengautentikasi sertifikat dalam kebijakan di gateway.

Properti Nilai
Nilai yang diterima: false, true
--enable-managed-identity

Buat identitas terkelola untuk layanan API Management untuk mengakses sumber daya Azure lainnya. Hanya dimaksudkan untuk digunakan untuk Layanan SKU Konsumsi.

Properti Nilai
Nilai default: False
Nilai yang diterima: false, true
--location -l

Location. Nilai dari: az account list-locations. Anda dapat mengonfigurasi lokasi default menggunakan az configure --defaults location=<location>.

--no-wait

Jangan menunggu operasi jangka panjang selesai.

Properti Nilai
Nilai default: False
--public-network-access

Apakah akses titik akhir publik diizinkan atau tidak untuk layanan API Management ini. Jika diatur ke true, titik akhir privat adalah metode akses eksklusif.

Properti Nilai
Nilai yang diterima: false, true
--sku-capacity

Jumlah unit SKU yang disebarkan.

Properti Nilai
Nilai default: 1
--sku-name

Sku instans manajemen api.

Properti Nilai
Nilai default: Developer
Nilai yang diterima: Basic, Consumption, Developer, Isolated, Premium, Standard
--tags

Tag yang dipisahkan spasi: key[=value] [key[=value] ...]. Gunakan "" untuk menghapus tag yang ada.

--virtual-network -v

Jenis jaringan virtual.

Properti Nilai
Nilai default: None
Nilai yang diterima: External, Internal, None
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 delete

Menghapus layanan API Management.

az apim delete --name
               --resource-group
               [--no-wait]
               [--yes]

Contoh

Menghapus layanan API Management.

az apim delete -n MyApim -g MyResourceGroup

Parameter yang Diperlukan

--name -n

Nama instans layanan api management.

--resource-group -g

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

Parameter Opsional

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

--no-wait

Jangan menunggu operasi jangka panjang selesai.

Properti Nilai
Nilai default: False
--yes -y

Jangan meminta konfirmasi.

Properti Nilai
Nilai default: False
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 list

Mencantumkan instans layanan API Management.

az apim list [--resource-group]

Parameter Opsional

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

--resource-group -g

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

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 restore

Memulihkan cadangan layanan API Management yang dibuat menggunakan operasi ApiManagementService_Backup pada layanan saat ini. Ini adalah operasi jangka panjang dan bisa memakan waktu beberapa menit untuk diselesaikan.

az apim restore --backup-name
                --container-name --storage-account-container
                --name
                --resource-group
                --storage-account-key
                --storage-account-name
                [--no-wait]

Contoh

Memulihkan cadangan instans layanan API Management

az apim restore --name MyApim -g MyResourceGroup --backup-name myBackup              --storage-account-name mystorageaccount --storage-account-container backups              --storage-account-key Ay2ZbdxLnD4OJPT29F6jLPkB6KynOzx85YCObhrw==

Parameter yang Diperlukan

--backup-name

Nama file cadangan yang akan dipulihkan.

--container-name --storage-account-container

Nama kontainer akun penyimpanan yang digunakan untuk mengambil cadangan.

--name -n

Nama instans layanan api management.

--resource-group -g

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

--storage-account-key

Kunci akses akun penyimpanan yang digunakan untuk mengambil cadangan.

Properti Nilai
Grup parameter: Storage Arguments
--storage-account-name

Nama akun penyimpanan yang digunakan untuk mengambil cadangan.

Properti Nilai
Grup parameter: Storage Arguments

Parameter Opsional

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

--no-wait

Jangan menunggu operasi jangka panjang selesai.

Properti Nilai
Nilai default: False
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 show

Menampilkan detail instans layanan API Management.

az apim show --name
             --resource-group

Parameter yang Diperlukan

--name -n

Nama instans layanan api management.

--resource-group -g

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

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 update

Perbarui instans layanan API Management.

az apim update --name
               --resource-group
               [--add]
               [--disable-gateway {false, true}]
               [--enable-client-certificate {false, true}]
               [--enable-managed-identity {false, true}]
               [--force-string]
               [--no-wait]
               [--public-network-access {false, true}]
               [--publisher-email]
               [--publisher-name]
               [--remove]
               [--set]
               [--sku-capacity]
               [--sku-name {Basic, Consumption, Developer, Isolated, Premium, Standard}]
               [--tags]
               [--virtual-network {External, Internal, None}]

Parameter yang Diperlukan

--name -n

Nama instans layanan api management.

--resource-group -g

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

Parameter Opsional

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

--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: []
--disable-gateway

Nonaktifkan gateway di wilayah master. Hanya berlaku untuk layanan Api Management yang disebarkan di beberapa lokasi.

Properti Nilai
Nilai yang diterima: false, true
--enable-client-certificate

Memberlakukan sertifikat klien untuk disajikan pada setiap permintaan ke gateway dan juga memungkinkan kemampuan untuk mengautentikasi sertifikat dalam kebijakan di gateway.

Properti Nilai
Nilai yang diterima: false, true
--enable-managed-identity

Buat identitas terkelola untuk layanan API Management untuk mengakses sumber daya Azure lainnya. Hanya dimaksudkan untuk digunakan untuk Layanan SKU Konsumsi.

Properti Nilai
Nilai yang diterima: false, true
--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
--no-wait

Jangan menunggu operasi jangka panjang selesai.

Properti Nilai
Nilai default: False
--public-network-access

Apakah akses titik akhir publik diizinkan atau tidak untuk layanan API Management ini. Jika diatur ke true, titik akhir privat adalah metode akses eksklusif.

Properti Nilai
Nilai yang diterima: false, true
--publisher-email

Alamat email untuk menerima semua pemberitahuan sistem.

--publisher-name

Nama organisasi Anda untuk digunakan di portal pengembang dan pemberitahuan email.

--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: []
--sku-capacity

Jumlah unit SKU yang disebarkan.

--sku-name

Sku instans manajemen api.

Properti Nilai
Nilai yang diterima: Basic, Consumption, Developer, Isolated, Premium, Standard
--tags

Tag yang dipisahkan spasi: key[=value] [key[=value] ...]. Gunakan "" untuk menghapus tag yang ada.

--virtual-network -v

Jenis jaringan virtual.

Properti Nilai
Nilai yang diterima: External, Internal, None
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 wait

Tempatkan CLI dalam status menunggu hingga kondisi apim terpenuhi.

az apim wait --name
             --resource-group
             [--created]
             [--custom]
             [--deleted]
             [--exists]
             [--interval]
             [--timeout]
             [--updated]

Contoh

Tempatkan CLI dalam status tunggu sampai kondisi apim terpenuhi. (autogenerated)

az apim wait --created --name MyApim --resource-group MyResourceGroup

Parameter yang Diperlukan

--name -n

Nama instans layanan api management.

--resource-group -g

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

Parameter Opsional

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

--created

Tunggu hingga dibuat dengan 'provisioningState' di 'Berhasil'.

Properti Nilai
Grup parameter: Wait Condition Arguments
Nilai default: False
--custom

Tunggu hingga kondisi memenuhi kueri JMESPath kustom. Misalnya provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Properti Nilai
Grup parameter: Wait Condition Arguments
--deleted

Tunggu hingga dihapus.

Properti Nilai
Grup parameter: Wait Condition Arguments
Nilai default: False
--exists

Tunggu hingga sumber daya ada.

Properti Nilai
Grup parameter: Wait Condition Arguments
Nilai default: False
--interval

Interval polling dalam hitungan detik.

Properti Nilai
Grup parameter: Wait Condition Arguments
Nilai default: 30
--timeout

Tunggu maksimum dalam detik.

Properti Nilai
Grup parameter: Wait Condition Arguments
Nilai default: 3600
--updated

Tunggu hingga diperbarui dengan provisioningState di 'Berhasil'.

Properti Nilai
Grup parameter: Wait Condition Arguments
Nilai default: False
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