az apim api

Referensi

Mengelola API Management Azure API.

Perintah

Nama	Deskripsi	Jenis	Status
az apim api create	Buat API Management API.	Inti	GA
az apim api delete	Menghapus API Management.	Inti	GA
az apim api export	Mengekspor API Management API.	Inti	GA
az apim api import	Mengimpor API Management.	Inti	GA
az apim api list	Mencantumkan API Management API.	Inti	GA
az apim api operation	Mengelola Operasi API Api Management Azure.	Inti	GA
az apim api operation create	Membuat operasi baru di API.	Inti	GA
az apim api operation delete	Menghapus operasi yang ditentukan di API.	Inti	GA
az apim api operation list	Mencantumkan kumpulan operasi untuk API yang ditentukan.	Inti	GA
az apim api operation show	Mendapatkan detail Operasi API yang ditentukan oleh pengidentifikasinya.	Inti	GA
az apim api operation update	Memperbarui detail operasi dalam API yang ditentukan oleh pengidentifikasinya.	Inti	GA
az apim api release	Mengelola Rilis API Api Management Azure.	Inti	GA
az apim api release create	Membuat Rilis baru untuk API.	Inti	GA
az apim api release delete	Menghapus rilis yang ditentukan di API.	Inti	GA
az apim api release list	Mencantumkan semua rilis API.	Inti	GA
az apim api release show	Mengembalikan detail rilis API.	Inti	GA
az apim api release update	Memperbarui detail rilis API yang ditentukan oleh pengidentifikasinya.	Inti	GA
az apim api revision	Mengelola Revisi API Api Management Azure.	Inti	GA
az apim api revision create	Buat revisi API.	Inti	GA
az apim api revision list	Mencantumkan semua revisi API.	Inti	GA
az apim api schema	Mengelola Skema API Api Management Azure.	Inti	GA
az apim api schema create	Buat Skema API Management API.	Inti	GA
az apim api schema delete	Menghapus Skema API Management API.	Inti	GA
az apim api schema get-etag	Dapatkan etag skema API Management API.	Inti	GA
az apim api schema list	Mencantumkan skema API Management API.	Inti	GA
az apim api schema show	Menampilkan detail Skema API Management API.	Inti	GA
az apim api schema wait	Tempatkan CLI dalam status menunggu sampai kondisi skema apim api terpenuhi.	Inti	GA
az apim api show	Menampilkan detail API Management.	Inti	GA
az apim api update	Perbarui API Management API.	Inti	GA
az apim api versionset	Mengelola Set Versi API Management Azure.	Inti	GA
az apim api versionset create	Membuat Set Versi Api.	Inti	GA
az apim api versionset delete	Menghapus Kumpulan Versi Api tertentu.	Inti	GA
az apim api versionset list	Mencantumkan kumpulan Versi API dalam instans layanan yang ditentukan.	Inti	GA
az apim api versionset show	Mendapatkan detail Set Versi Api yang ditentukan oleh pengidentifikasinya.	Inti	GA
az apim api versionset update	Memperbarui detail Api VersionSet yang ditentukan oleh pengidentifikasinya.	Inti	GA
az apim api wait	Tempatkan CLI dalam status tunggu hingga kondisi apim terpenuhi.	Inti	GA

az apim api create

Edit

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.

--display-name

Nama tampilan API yang akan dibuat.

--path

Jalur ke API.

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

--api-type

Jenis API.

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. Mungkin menyertakan tag pemformatan HTML.

--no-wait

Jangan menunggu operasi jangka panjang selesai.

nilai default: False

--open-id-provider-id

Menentukan openid dalam pengaturan autentikasi.

--protocols

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

nilai yang diterima: http, https, ws, wss

--service-url

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

--subscription-key-header-name

Menentukan nama header kunci langganan.

--subscription-key-query-param-name

Menentukan nama parameter string kueri kunci langganan.

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

nilai yang diterima: false, true

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

Edit

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.

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

--delete-revisions

Hapus semua revisi Api.

--if-match

ETag Entitas.

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

Edit

Mengekspor API Management API.

az apim api export --api-id
                   --ef {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: ^[^*#&+:<>?] +$.

--ef --export-format

Tentukan format API pengekspor.

nilai yang diterima: OpenApiJsonFile, OpenApiJsonUrl, OpenApiYamlFile, OpenApiYamlUrl, SwaggerFile, SwaggerUrl, WadlFile, WadlUrl, WsdlFile, WsdlUrl

--resource-group -g

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

--service-name -n

Nama instans layanan api management.

Parameter Opsional

--file-path -f

Jalur file yang ditentukan untuk mengekspor API.

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

Edit

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

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

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

nilai yang diterima: GraphQL, OpenApi, OpenApiJson, Swagger, Wadl, Wsdl

Parameter Opsional

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

--api-revision

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

--api-type

Jenis API.

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.

--api-version-set-id

Menjelaskan Set Versi yang akan digunakan dengan API.

--description

Deskripsi API. Mungkin menyertakan tag pemformatan HTML.

--display-name

Nama tampilan API ini.

--no-wait

Jangan menunggu operasi jangka panjang selesai.

nilai default: False

--protocols

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

nilai yang diterima: http, https, ws, wss

--service-url

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

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

--subscription-key-query-param-name

Menentukan nama parameter string kueri kunci langganan.

--subscription-required

Jika true, API memerlukan kunci langganan pada permintaan.

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

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

Edit

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

--filter-display-name

Filter API menurut displayName.

--skip

Jumlah rekaman yang akan dilewati.

--top

Jumlah rekaman yang akan dikembalikan.

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

Edit

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.

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

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

Edit

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.

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

--add

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

nilai default: []

--api-type

Jenis API.

nilai yang diterima: graphql, http, soap, websocket

--description

Deskripsi API. Mungkin menyertakan tag pemformatan HTML.

--display-name

Nama API. Panjangnya harus 1 hingga 300 karakter.

--force-string

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

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.

nilai default: False

--path

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

--protocols

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

nilai yang diterima: http, https, ws, wss

--remove

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

nilai default: []

--service-url

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

--set

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

nilai default: []

--subscription-key-header-name

Menentukan nama header kunci langganan.

--subscription-key-query-param-name

Menentukan nama parameter string kueri kunci langganan.

--subscription-required

Jika true, API memerlukan kunci langganan pada permintaan.

nilai yang diterima: false, true

--tags

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

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

Edit

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. (dibuat otomatis)

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

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

--created

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

nilai default: False

--custom

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

--deleted

Tunggu hingga dihapus.

nilai default: False

--exists

Tunggu hingga sumber daya ada.

nilai default: False

--interval

Interval polling dalam hitungan detik.

nilai default: 30

--timeout

Tunggu maksimum dalam detik.

nilai default: 3600

--updated

Tunggu hingga diperbarui dengan provisioningState di 'Berhasil'.

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

Perintah

az apim api create

Contoh

Parameter yang Diperlukan

Parameter Opsional

az apim api delete

Parameter yang Diperlukan

Parameter Opsional

az apim api export

Contoh

Parameter yang Diperlukan

Parameter Opsional

az apim api import

Contoh

Parameter yang Diperlukan

Parameter Opsional

az apim api list

Parameter yang Diperlukan

Parameter Opsional

az apim api show

Parameter yang Diperlukan

az apim api update

Contoh

Parameter yang Diperlukan

Parameter Opsional

az apim api wait

Contoh

Parameter yang Diperlukan

Parameter Opsional

Saran dan Komentar

Sumber Daya Tambahan: