Bagikan melalui


az apim api

Mengelola API Management Azure API.

Perintah

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

Buat API Management API.

az apim api create --api-id
                   --display-name
                   --path
                   --resource-group
                   --service-name
                   [--api-type {graphql, http, soap, websocket}]
                   [--authorization-scope]
                   [--authorization-server-id]
                   [--bearer-token-sending-methods]
                   [--description]
                   [--no-wait]
                   [--open-id-provider-id]
                   [--protocols {http, https, ws, wss}]
                   [--service-url]
                   [--subscription-key-header-name]
                   [--subscription-key-query-param-name]
                   [--subscription-key-required]
                   [--subscription-required {false, true}]

Contoh

Buat API dasar.

az apim api create --service-name MyApim -g MyResourceGroup --api-id MyApi --path '/myapi' --display-name 'My API'

Parameter yang Diperlukan

--api-id

Nama unik api yang akan dibuat.

Pengidentifikasi revisi API. Harus unik dalam instans layanan API Management saat ini. Revisi non-saat ini memiliki ; rev=n sebagai akhiran di mana n adalah nomor revisi.

Properti Nilai
Grup parameter: API Arguments
--display-name

Nama tampilan API yang akan dibuat.

Properti Nilai
Grup parameter: API Arguments
--path

Jalur ke API.

Properti Nilai
Grup parameter: API Arguments
--resource-group -g

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

--service-name -n

Nama instans layanan API Management.

Parameter Opsional

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

--api-type

Jenis API.

Properti Nilai
Grup parameter: API Arguments
Nilai yang diterima: graphql, http, soap, websocket
--authorization-scope

Menentukan cakupan operasi OAuth.

--authorization-server-id

Menentukan ID server otorisasi OAuth.

--bearer-token-sending-methods

Menentukan metode pengiriman untuk token pembawa.

--description

Deskripsi API. Dapat mencakup tag pemformatan HTML.

Properti Nilai
Grup parameter: API Arguments
--no-wait

Jangan menunggu operasi jangka panjang selesai.

Properti Nilai
Nilai default: False
--open-id-provider-id

Menentukan openid dalam pengaturan autentikasi.

--protocols

Menjelaskan protokol mana yang dapat dipanggil oleh operasi dalam API ini.

Properti Nilai
Grup parameter: API Arguments
Nilai yang diterima: http, https, ws, wss
--service-url

URL absolut layanan backend yang mengimplementasikan API ini. Panjangnya tidak boleh lebih dari 2000 karakter.

Properti Nilai
Grup parameter: API Arguments
--subscription-key-header-name

Menentukan nama header kunci langganan.

Properti Nilai
Grup parameter: API Arguments
--subscription-key-query-param-name

Menentukan nama parameter string kueri kunci langganan.

Properti Nilai
Grup parameter: API Arguments
--subscription-key-required

Menentukan apakah kunci langganan diperlukan selama panggilan ke API ini, true - API disertakan ke dalam produk tertutup saja, false - API disertakan ke dalam produk terbuka saja, null - ada campuran produk.

--subscription-required

Jika true, API memerlukan kunci langganan pada permintaan.

Properti Nilai
Grup parameter: API Arguments
Nilai default: False
Nilai yang diterima: false, true
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 api delete

Menghapus API Management.

az apim api delete --api-id
                   --resource-group
                   --service-name
                   [--delete-revisions]
                   [--if-match]
                   [--no-wait]
                   [--yes]

Parameter yang Diperlukan

--api-id

Pengidentifikasi API. Harus unik dalam instans layanan API Management saat ini. Revisi non-saat ini memiliki ; rev=n sebagai akhiran di mana n adalah nomor revisi.

Properti Nilai
Grup parameter: API Arguments
--resource-group -g

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

--service-name -n

Nama instans layanan API Management.

Parameter Opsional

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

--delete-revisions

Hapus semua revisi Api.

--if-match

ETag Entitas.

--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 api export

Mengekspor API Management API.

az apim api export --api-id
                   --ef --export-format {OpenApiJsonFile, OpenApiJsonUrl, OpenApiYamlFile, OpenApiYamlUrl, SwaggerFile, SwaggerUrl, WadlFile, WadlUrl, WsdlFile, WsdlUrl}
                   --resource-group
                   --service-name
                   [--file-path]

Contoh

Ekspor API Management API ke file atau mengembalikan respons yang berisi tautan ekspor.

az apim api export -g MyResourceGroup --service-name MyApim --api-id MyApi --export-format OpenApiJson --file-path path

Parameter yang Diperlukan

--api-id

Pengidentifikasi API. Harus unik dalam instans layanan API Management saat ini. Revisi non-saat ini memiliki ; rev=n sebagai akhiran di mana n adalah nomor revisi. Pola regex: ^[^*#&+:<>?]+$.

Properti Nilai
Grup parameter: API Arguments
--ef --export-format

Tentukan format API pengekspor.

Properti Nilai
Nilai yang diterima: OpenApiJsonFile, OpenApiJsonUrl, OpenApiYamlFile, OpenApiYamlUrl, SwaggerFile, SwaggerUrl, WadlFile, WadlUrl, WsdlFile, WsdlUrl
--resource-group -g

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

--service-name -n

Nama instans layanan api management.

Parameter Opsional

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

--file-path -f

Jalur file yang ditentukan untuk mengekspor API.

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 api import

Mengimpor API Management.

az apim api import --path
                   --resource-group
                   --service-name
                   --specification-format {GraphQL, OpenApi, OpenApiJson, Swagger, Wadl, Wsdl}
                   [--api-id]
                   [--api-revision]
                   [--api-type {graphql, http, soap, websocket}]
                   [--api-version]
                   [--api-version-set-id]
                   [--description]
                   [--display-name]
                   [--no-wait]
                   [--protocols {http, https, ws, wss}]
                   [--service-url]
                   [--soap-api-type]
                   [--specification-path]
                   [--specification-url]
                   [--subscription-key-header-name]
                   [--subscription-key-query-param-name]
                   [--subscription-required {false, true}]
                   [--wsdl-endpoint-name]
                   [--wsdl-service-name]

Contoh

Mengimpor API Management API Dari file atau url

az apim api import -g MyResourceGroup --service-name MyApim --path MyApi --specification-url https://MySpecificationURL --specification-format OpenApiJson

Parameter yang Diperlukan

--path

Required. URL relatif secara unik mengidentifikasi API ini dan semua jalur sumber dayanya dalam instans layanan API Management.

Properti Nilai
Grup parameter: API Arguments
--resource-group -g

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

--service-name -n

Nama instans layanan api management.

--specification-format

Tentukan format API yang diimpor.

Properti Nilai
Nilai yang diterima: GraphQL, OpenApi, OpenApiJson, Swagger, Wadl, Wsdl

Parameter Opsional

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

--api-id

Pengidentifikasi API. Harus unik dalam instans layanan API Management saat ini. Revisi non-saat ini memiliki ; rev=n sebagai akhiran di mana n adalah nomor revisi.

Properti Nilai
Grup parameter: API Arguments
--api-revision

Menjelaskan Revisi Api. Jika tidak ada nilai yang disediakan, revisi default 1 dibuat.

Properti Nilai
Grup parameter: API Arguments
--api-type

Jenis API.

Properti Nilai
Grup parameter: API Arguments
Nilai yang diterima: graphql, http, soap, websocket
--api-version

Menjelaskan Versi Api. Jika Anda menambahkan versi ke API non-versi, versi Asli akan dibuat secara otomatis dan akan merespons PADA URL default.

Properti Nilai
Grup parameter: API Arguments
--api-version-set-id

Menjelaskan Set Versi yang akan digunakan dengan API.

Properti Nilai
Grup parameter: API Arguments
--description

Deskripsi API. Dapat mencakup tag pemformatan HTML.

Properti Nilai
Grup parameter: API Arguments
--display-name

Nama tampilan API ini.

Properti Nilai
Grup parameter: API Arguments
--no-wait

Jangan menunggu operasi jangka panjang selesai.

Properti Nilai
Nilai default: False
--protocols

Menjelaskan protokol mana (satu atau beberapa) operasi dalam API ini dapat dipanggil.

Properti Nilai
Grup parameter: API Arguments
Nilai yang diterima: http, https, ws, wss
--service-url

URL absolut layanan backend yang mengimplementasikan API ini. Panjangnya tidak boleh lebih dari 2000 karakter.

Properti Nilai
Grup parameter: API Arguments
--soap-api-type

Jenis API saat format file adalah WSDL.

--specification-path

Jalur file yang ditentukan untuk mengimpor API.

--specification-url

Url yang ditentukan untuk mengimpor API.

--subscription-key-header-name

Menentukan nama header kunci langganan.

Properti Nilai
Grup parameter: API Arguments
--subscription-key-query-param-name

Menentukan nama parameter string kueri kunci langganan.

Properti Nilai
Grup parameter: API Arguments
--subscription-required

Jika true, API memerlukan kunci langganan pada permintaan.

Properti Nilai
Grup parameter: API Arguments
Nilai yang diterima: false, true
--wsdl-endpoint-name

Nama lokal Titik Akhir WSDL (port) yang akan diimpor.

--wsdl-service-name

Nama lokal Layanan WSDL yang akan diimpor.

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

Mencantumkan API Management API.

az apim api list --resource-group
                 --service-name
                 [--filter-display-name]
                 [--skip]
                 [--top]

Parameter yang Diperlukan

--resource-group -g

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

--service-name -n

Nama instans layanan API Management.

Parameter Opsional

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

--filter-display-name

Filter API menurut displayName.

Properti Nilai
Grup parameter: API Arguments
--skip

Jumlah rekaman yang akan dilewati.

--top

Jumlah rekaman yang akan dikembalikan.

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

Menampilkan detail API Management.

az apim api show --api-id
                 --resource-group
                 --service-name

Parameter yang Diperlukan

--api-id

Pengidentifikasi API. Harus unik dalam instans layanan API Management saat ini. Revisi non-saat ini memiliki ; rev=n sebagai akhiran di mana n adalah nomor revisi.

Properti Nilai
Grup parameter: API Arguments
--resource-group -g

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

--service-name

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

Perbarui API Management API.

az apim api update --api-id
                   --resource-group
                   --service-name
                   [--add]
                   [--api-type {graphql, http, soap, websocket}]
                   [--description]
                   [--display-name]
                   [--force-string]
                   [--if-match]
                   [--no-wait]
                   [--path]
                   [--protocols {http, https, ws, wss}]
                   [--remove]
                   [--service-url]
                   [--set]
                   [--subscription-key-header-name]
                   [--subscription-key-query-param-name]
                   [--subscription-required {false, true}]
                   [--tags]

Contoh

Buat API dasar.

az apim api update --service-name MyApim -g MyResourceGroup --api-id MyApi --description foo

Parameter yang Diperlukan

--api-id

Nama unik api yang akan dibuat.

Pengidentifikasi revisi API. Harus unik dalam instans layanan API Management saat ini. Revisi non-saat ini memiliki ; rev=n sebagai akhiran di mana n adalah nomor revisi.

Properti Nilai
Grup parameter: API Arguments
--resource-group -g

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

--service-name -n

Nama instans layanan API Management.

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: []
--api-type

Jenis API.

Properti Nilai
Grup parameter: API Arguments
Nilai yang diterima: graphql, http, soap, websocket
--description

Deskripsi API. Dapat mencakup tag pemformatan HTML.

Properti Nilai
Grup parameter: API Arguments
--display-name

Nama API. Panjangnya harus 1 hingga 300 karakter.

Properti Nilai
Grup parameter: API Arguments
--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
--if-match

ETag Entitas. Tidak diperlukan saat membuat entitas, tetapi diperlukan saat memperbarui entitas. Nilai defaultnya adalah Tidak Ada.

--no-wait

Jangan menunggu operasi jangka panjang selesai.

Properti Nilai
Nilai default: False
--path

Required. URL relatif secara unik mengidentifikasi API ini dan semua jalur sumber dayanya dalam instans layanan API Management.

Properti Nilai
Grup parameter: API Arguments
--protocols

Menjelaskan protokol mana yang dapat dipanggil oleh operasi dalam API ini.

Properti Nilai
Grup parameter: API Arguments
Nilai yang diterima: http, https, ws, wss
--remove

Menghapus properti atau elemen dari daftar. Contoh: --remove property.list <indexToRemove> ATAU --remove propertyToRemove.

Properti Nilai
Grup parameter: Generic Update Arguments
Nilai default: []
--service-url

URL absolut layanan backend yang mengimplementasikan API ini. Panjangnya tidak boleh lebih dari 2000 karakter.

Properti Nilai
Grup parameter: API Arguments
--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: []
--subscription-key-header-name

Menentukan nama header kunci langganan.

Properti Nilai
Grup parameter: API Arguments
--subscription-key-query-param-name

Menentukan nama parameter string kueri kunci langganan.

Properti Nilai
Grup parameter: API Arguments
--subscription-required

Jika true, API memerlukan kunci langganan pada permintaan.

Properti Nilai
Grup parameter: API Arguments
Nilai yang diterima: false, true
--tags

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

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 api wait

Tempatkan CLI dalam status tunggu hingga kondisi apim terpenuhi.

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

Contoh

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

az apim api wait --created --api-id MyApi --name MyApim --resource-group MyResourceGroup

Parameter yang Diperlukan

--api-id

Pengidentifikasi revisi API. Harus unik dalam instans layanan API Management saat ini. Revisi non-saat ini memiliki ; rev=n sebagai akhiran di mana n adalah nomor revisi. Required.

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