az apic api deployment

  • 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 penyebaran api az apic. Pelajari lebih lanjut tentang ekstensi.

Perintah untuk mengelola penyebaran API di API Center.

Perintah

Nama Deskripsi Jenis Status
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 deployment create

Buat penyebaran API baru atau perbarui penyebaran API yang ada.

az apic api deployment create --api-id
                              --deployment-id
                              --resource-group
                              --service
                              [--custom-properties]
                              [--definition-id]
                              [--description]
                              [--environment-id]
                              [--server]
                              [--state {active, inactive}]
                              [--title]

Contoh

Membuat penyebaran

az apic api deployment create -g api-center-test -s contoso --deployment-id production --title "Production deployment" --description "Public cloud production deployment." --api-id echo-api --environment-id "/workspaces/default/environments/production" --definition-id "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi" --server '{"runtimeUri":["https://example.com"]}'

Parameter yang Diperlukan

--api-id

The id of the API.

--deployment-id

Id penyebaran API.

--resource-group -g

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

--service --service-name -s

Nama layanan API Center.

Parameter Opsional

--custom-properties

Metadata kustom yang ditentukan untuk entitas katalog API. Mendukung json-file dan yaml-file.

--definition-id

ID sumber daya definisi yang dicakup pusat API.

--description

Deskripsi penyebaran.

--environment-id

ID sumber daya lingkungan yang dicakup pusat API.

--server

Dukungan Server shorthand-sintaks, json-file dan yaml-file. Coba "??" untuk menunjukkan lebih banyak.

--state

Status penyebaran API.

nilai yang diterima: active, inactive
--title

Judul penyebaran.

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 api deployment delete

Menghapus penyebaran API.

az apic api deployment delete [--api-id]
                              [--deployment-id]
                              [--ids]
                              [--resource-group]
                              [--service]
                              [--subscription]
                              [--yes]

Contoh

Menghapus penyebaran API

az apic api deployment delete -g api-center-test -s contoso --deployment-id production --api-id echo-api

Parameter Opsional

--api-id

The id of the API.

--deployment-id

Id penyebaran API.

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

--resource-group -g

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

--service --service-name -s

Nama layanan API Center.

--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 api deployment list

Mencantumkan kumpulan penyebaran API.

az apic api deployment list --api-id
                            --resource-group
                            --service
                            [--filter]
                            [--max-items]
                            [--next-token]

Contoh

Mencantumkan penyebaran API

az apic api deployment list -g api-center-test -s contoso --api-id echo-api

Parameter yang Diperlukan

--api-id

The id of the API.

--resource-group -g

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

--service --service-name -s

Nama layanan API Center.

Parameter Opsional

--filter

Parameter filter OData.

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

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 api deployment show

Dapatkan detail penyebaran API.

az apic api deployment show [--api-id]
                            [--deployment-id]
                            [--ids]
                            [--resource-group]
                            [--service]
                            [--subscription]

Contoh

Tampilkan detail penyebaran API

az apic api deployment show -g api-center-test -s contoso --deployment-id production --api-id echo-api

Parameter Opsional

--api-id

The id of the API.

--deployment-id

Id penyebaran API.

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

--resource-group -g

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

--service --service-name -s

Nama layanan 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 api deployment update

Perbarui penyebaran API yang ada.

az apic api deployment update [--add]
                              [--api-id]
                              [--custom-properties]
                              [--definition-id]
                              [--deployment-id]
                              [--description]
                              [--environment-id]
                              [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                              [--ids]
                              [--remove]
                              [--resource-group]
                              [--server]
                              [--service]
                              [--set]
                              [--state {active, inactive}]
                              [--subscription]
                              [--title]

Contoh

Memperbarui penyebaran API

az apic api deployment update -g api-center-test -s contoso --deployment-id production --title "Production deployment" --api-id echo-api

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

--api-id

The id of the API.

--custom-properties

Metadata kustom yang ditentukan untuk entitas katalog API. Mendukung json-file dan yaml-file.

--definition-id

ID sumber daya definisi yang dilingkup layanan.

--deployment-id

Id penyebaran API.

--description

Deskripsi penyebaran.

--environment-id

ID sumber daya lingkungan yang dilingkup layanan.

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

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

--server

Dukungan Server shorthand-sintaks, json-file dan yaml-file. Coba "??" untuk menunjukkan lebih banyak.

--service --service-name -s

Nama layanan API Center.

--set

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

--state

Status penyebaran API.

nilai yang diterima: active, inactive
--subscription

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

--title

Judul.

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.