Bagikan melalui


az spring gateway

Catatan

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

(Hanya Tingkat Perusahaan) Perintah untuk mengelola gateway di Azure Spring Apps.

Perintah

Nama Deskripsi Jenis Status
az spring gateway clear

Hapus semua pengaturan gateway.

Ekstensi GA
az spring gateway create

Buat Spring Cloud Gateway.

Ekstensi GA
az spring gateway custom-domain

Perintah untuk mengelola domain kustom untuk gateway.

Ekstensi GA
az spring gateway custom-domain bind

Mengikat domain kustom dengan gateway.

Ekstensi GA
az spring gateway custom-domain list

Mencantumkan semua domain kustom gateway.

Ekstensi GA
az spring gateway custom-domain show

Perlihatkan detail domain kustom.

Ekstensi GA
az spring gateway custom-domain unbind

Batalkan ikatan domain kustom gateway.

Ekstensi GA
az spring gateway custom-domain update

Memperbarui domain kustom gateway.

Ekstensi GA
az spring gateway delete

Hapus Spring Cloud Gateway.

Ekstensi GA
az spring gateway restart

Mulai ulang Spring Cloud Gateway.

Ekstensi GA
az spring gateway route-config

Perintah untuk mengelola konfigurasi rute gateway di Azure Spring Apps.

Ekstensi GA
az spring gateway route-config create

Buat konfigurasi rute gateway dengan aturan perutean format array Json.

Ekstensi GA
az spring gateway route-config list

Mencantumkan semua konfigurasi rute gateway yang ada.

Ekstensi GA
az spring gateway route-config remove

Menghapus konfigurasi rute gateway yang ada.

Ekstensi GA
az spring gateway route-config show

Dapatkan konfigurasi rute gateway yang sudah ada.

Ekstensi GA
az spring gateway route-config update

Perbarui konfigurasi rute gateway yang ada dengan aturan perutean format array Json.

Ekstensi GA
az spring gateway show

Perlihatkan pengaturan, status provisi, dan status runtime gateway.

Ekstensi GA
az spring gateway sync-cert

Sinkronkan sertifikat gateway.

Ekstensi GA
az spring gateway update

Perbarui properti gateway yang sudah ada.

Ekstensi GA

az spring gateway clear

Hapus semua pengaturan gateway.

az spring gateway clear --resource-group
                        --service
                        [--no-wait]

Parameter yang Diperlukan

--resource-group -g

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

--service -s

Nama instans Azure Spring Apps, Anda dapat mengonfigurasi layanan default menggunakan az configure --defaults spring=.

Parameter Opsional

--no-wait

Jangan menunggu operasi jangka panjang selesai.

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

Buat Spring Cloud Gateway.

az spring gateway create --resource-group
                         --service
                         [--instance-count]

Contoh

Buat Spring Cloud Gateway.

az spring gateway create -s MyService -g MyResourceGroup --instance-count 2

Parameter yang Diperlukan

--resource-group -g

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

--service -s

Nama instans Azure Spring Apps, Anda dapat mengonfigurasi layanan default menggunakan az configure --defaults spring=.

Parameter Opsional

--instance-count

Jumlah instans.

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 spring gateway delete

Hapus Spring Cloud Gateway.

az spring gateway delete --resource-group
                         --service
                         [--yes]

Parameter yang Diperlukan

--resource-group -g

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

--service -s

Nama instans Azure Spring Apps, Anda dapat mengonfigurasi layanan default menggunakan az configure --defaults spring=.

Parameter Opsional

--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 spring gateway restart

Mulai ulang Spring Cloud Gateway.

az spring gateway restart --resource-group
                          --service
                          [--no-wait]
                          [--yes]

Contoh

Mulai ulang Spring Cloud Gateway.

az spring gateway restart -s MyService -g MyResourceGroup

Parameter yang Diperlukan

--resource-group -g

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

--service -s

Nama instans Azure Spring Apps, Anda dapat mengonfigurasi layanan default menggunakan az configure --defaults spring=.

Parameter Opsional

--no-wait

Jangan menunggu operasi jangka panjang selesai.

nilai default: False
--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 spring gateway show

Perlihatkan pengaturan, status provisi, dan status runtime gateway.

az spring gateway show --resource-group
                       --service

Parameter yang Diperlukan

--resource-group -g

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

--service -s

Nama instans Azure Spring Apps, Anda dapat mengonfigurasi layanan default menggunakan az configure --defaults spring=.

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 spring gateway sync-cert

Sinkronkan sertifikat gateway.

az spring gateway sync-cert --resource-group
                            --service
                            [--no-wait]
                            [--yes]

Contoh

Sinkronkan sertifikat gateway.

az spring gateway sync-cert -s MyService -g MyResourceGroup

Parameter yang Diperlukan

--resource-group -g

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

--service -s

Nama instans Azure Spring Apps, Anda dapat mengonfigurasi layanan default menggunakan az configure --defaults spring=.

Parameter Opsional

--no-wait

Jangan menunggu operasi jangka panjang selesai.

nilai default: False
--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 spring gateway update

Perbarui properti gateway yang sudah ada.

az spring gateway update --resource-group
                         --service
                         [--addon-configs-file]
                         [--addon-configs-json]
                         [--allow-credentials {false, true}]
                         [--allow-origin-patterns]
                         [--allowed-headers]
                         [--allowed-methods]
                         [--allowed-origins]
                         [--api-description]
                         [--api-doc-location]
                         [--api-title]
                         [--api-version]
                         [--apm-types]
                         [--apms]
                         [--assign-endpoint {false, true}]
                         [--certificate-names]
                         [--client-id]
                         [--client-secret]
                         [--cpu]
                         [--enable-cert-verify {false, true}]
                         [--enable-response-cache {false, true}]
                         [--exposed-headers]
                         [--https-only {false, true}]
                         [--instance-count]
                         [--issuer-uri]
                         [--max-age]
                         [--memory]
                         [--no-wait]
                         [--properties]
                         [--response-cache-scope]
                         [--response-cache-size]
                         [--response-cache-ttl]
                         [--scope]
                         [--secrets]
                         [--server-url]

Contoh

Memperbarui properti gateway.

az spring gateway update -s MyService -g MyResourceGroup --assign-endpoint true --https-only true

Aktifkan dan konfigurasikan cache respons di tingkat Rute dan atur ttl ke 5 menit.

az spring gateway update -s MyService -g MyResourceGroup --enable-response-cache --response-cache-scope Route --response-cache-ttl 5m

Saat cache respons diaktifkan, perbarui ttl menjadi 3 menit.

az spring gateway update -s MyService -g MyResourceGroup --response-cache-ttl 3m

Nonaktifkan cache respons.

az spring gateway update -s MyService -g MyResourceGroup --enable-response-cache false

Parameter yang Diperlukan

--resource-group -g

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

--service -s

Nama instans Azure Spring Apps, Anda dapat mengonfigurasi layanan default menggunakan az configure --defaults spring=.

Parameter Opsional

--addon-configs-file

Jalur file string JSON konfigurasi add-on.

--addon-configs-json

String konfigurasi add-on JSON.

--allow-credentials

Apakah kredensial pengguna didukung pada permintaan lintas situs.

nilai yang diterima: false, true
--allow-origin-patterns --allowed-origin-patterns

Daftar pola asal yang diizinkan yang dipisahkan koma untuk membuat permintaan lintas situs.

--allowed-headers

Daftar header yang diizinkan yang dipisahkan koma dalam permintaan lintas situs. Nilai * khusus memungkinkan permintaan aktual untuk mengirim header apa pun.

--allowed-methods

Daftar metode HTTP yang diizinkan yang dipisahkan koma pada permintaan lintas situs. Nilai * khusus memungkinkan semua metode.

--allowed-origins

Daftar asal yang diizinkan yang dipisahkan koma untuk membuat permintaan lintas situs. Nilai * khusus memungkinkan semua domain.

--api-description

Deskripsi terperinci tentang API yang tersedia pada instans Gateway.

--api-doc-location

Lokasi dokumentasi tambahan untuk API yang tersedia di instans Gateway.

--api-title

Judul yang menjelaskan konteks API yang tersedia pada instans Gateway.

--api-version

Versi API tersedia pada instans Gateway ini.

--apm-types

Daftar APM yang dipisahkan spasi yang terintegrasi dengan Gateway. Nilai yang diizinkan adalah: ApplicationInsights, AppDynamics, Dynatrace, NewRelic, ElasticAPM.

--apms

Daftar nama referensi APM yang dipisahkan spasi di Azure Spring Apps untuk diintegrasikan dengan Gateway.

--assign-endpoint

Jika true, tetapkan URL titik akhir untuk akses langsung.

nilai yang diterima: false, true
--certificate-names

Daftar nama sertifikat yang dipisahkan koma di Azure Spring Apps.

--client-id

Pengidentifikasi publik untuk aplikasi.

--client-secret

Rahasia yang hanya diketahui oleh aplikasi dan server otorisasi.

--cpu

Kuantitas sumber daya CPU. Harus 500m atau jumlah inti CPU.

--enable-cert-verify --enable-certificate-verification

Jika true, akan memverifikasi sertifikat dalam koneksi TLS dari gateway ke aplikasi.

nilai yang diterima: false, true
--enable-response-cache

Aktifkan pengaturan cache respons di Spring Cloud Gateway.

nilai yang diterima: false, true
--exposed-headers

Daftar header respons HTTP yang dipisahkan koma untuk mengekspos permintaan lintas situs.

--https-only

Jika true, akses titik akhir melalui https.

nilai yang diterima: false, true
--instance-count

Jumlah instans.

--issuer-uri

URI Pengidentifikasi Pengeluar Sertifikat.

--max-age

Berapa lama, dalam detik, respons dari permintaan pra-penerbangan dapat di-cache oleh klien.

--memory

Kuantitas sumber daya memori. Harus 512Mi atau #Gi, misalnya, 1Gi, 3Gi.

--no-wait

Jangan menunggu operasi jangka panjang selesai.

nilai default: False
--properties

Properti tidak sensitif untuk variabel lingkungan. Format "key[=value]" dan dipisahkan oleh spasi.

--response-cache-scope

Cakupan untuk cache respons, nilai yang tersedia adalah [Rute, Instans].

--response-cache-size

Ukuran maksimum cache yang menentukan apakah cache perlu mengeluarkan beberapa entri. Contohnya adalah [1GB, 10MB, 100KB]. Gunakan "default" untuk mengatur ulang, dan Gateway akan mengelola properti ini.

--response-cache-ttl

Waktu sebelum entri yang di-cache kedaluwarsa. Contohnya adalah [1h, 30m, 50s]. Gunakan "default" untuk mengatur ulang, dan Gateway akan mengelola properti ini.

--scope

Daftar aplikasi tindakan tertentu yang dipisahkan koma dapat diizinkan untuk dilakukan atas nama pengguna.

--secrets

Properti sensitif untuk variabel lingkungan. Setelah dimasukkan, itu akan dienkripsi dan tidak dikembalikan. Format "key[=value]" dan dipisahkan oleh spasi.

--server-url

URL dasar yang akan digunakan konsumen API untuk mengakses API pada instans Gateway.

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.