az iot central api-token

  • Referensi

Catatan

Referensi ini adalah bagian dari ekstensi azure-iot untuk Azure CLI (versi 2.37.0 atau yang lebih tinggi). Ekstensi akan secara otomatis menginstal pertama kali Anda menjalankan perintah az iot central api-token . Pelajari lebih lanjut tentang ekstensi.

Mengelola token API untuk aplikasi IoT Central Anda.

IoT Central memungkinkan Anda membuat dan mengelola token API untuk digunakan untuk mengakses API IoT Central. Informasi selengkapnya tentang API dapat ditemukan di https://aka.ms/iotcentraldocsapi.

Perintah

Nama Deskripsi Jenis Status
az iot central api-token create

Buat token API yang terkait dengan aplikasi IoT Central Anda.

 Ekstensi GA
az iot central api-token delete

Hapus token API yang terkait dengan aplikasi IoT Central Anda.

 Ekstensi GA
az iot central api-token list

Dapatkan daftar token API yang terkait dengan aplikasi IoT Central Anda.

 Ekstensi GA
az iot central api-token show

Dapatkan detail untuk token API yang terkait dengan aplikasi IoT Central Anda.

 Ekstensi GA

az iot central api-token create

Buat token API yang terkait dengan aplikasi IoT Central Anda.

Catatan: Tuliskan token Anda setelah dibuat karena Anda tidak akan dapat mengambilnya lagi.

az iot central api-token create --app-id
                                --role
                                --tkid
                                [--api-version {2022-06-30-preview, 2022-07-31}]
                                [--central-api-uri]
                                [--org-id]
                                [--token]

Contoh

Menambahkan token API baru

az iot central api-token create --token-id {tokenId} --app-id {appId} --role admin

Parameter yang Diperlukan

--app-id -n

ID Aplikasi aplikasi IoT Central yang ingin Anda kelola. Anda dapat menemukan ID Aplikasi di halaman "Tentang" untuk aplikasi Anda di bawah menu bantuan.

--role -r

Peran yang akan dikaitkan dengan token atau pengguna ini. Anda dapat menentukan salah satu peran bawaan, atau menentukan ID peran peran peran kustom. Lihat selengkapnya di https://aka.ms/iotcentral-customrolesdocs.

--tkid --token-id

ID IoT Central yang terkait dengan token ini, [0-9a-zA-Z-] diizinkan, batas panjang maksimum hingga 40. Tentukan ID yang kemudian akan Anda gunakan saat memodifikasi atau menghapus token ini nanti melalui CLI atau API.

Parameter Opsional

--api-version --av
Tidak digunakan lagi

Argumen 'api_version' telah tidak digunakan lagi dan akan dihapus dalam rilis mendatang.

Parameter perintah ini tidak digunakan lagi dan akan diabaikan. Dalam rilis mendatang, kami hanya akan mendukung API IoT Central dari versi GA terbaru. Jika ada API yang belum GA, kami akan memanggil versi pratinjau terbaru.

nilai yang diterima: 2022-06-30-preview, 2022-07-31
nilai default: 2022-07-31
--central-api-uri --central-dns-suffix

Akhiran DNS IoT Central yang terkait dengan aplikasi Anda.

nilai default: azureiotcentral.com
--org-id --organization-id

ID organisasi untuk penetapan peran token. Hanya tersedia untuk api-version == 1.1-preview.

--token

Jika Anda lebih suka mengirimkan permintaan tanpa mengautentikasi terhadap Azure CLI, Anda dapat menentukan token pengguna yang valid untuk mengautentikasi permintaan Anda. Anda harus menentukan jenis kunci sebagai bagian dari permintaan. Pelajari lebih lanjut di https://aka.ms/iotcentraldocsapi.

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 iot central api-token delete

Hapus token API yang terkait dengan aplikasi IoT Central Anda.

az iot central api-token delete --app-id
                                --tkid
                                [--api-version {2022-06-30-preview, 2022-07-31}]
                                [--central-api-uri]
                                [--token]

Contoh

Menghapus token API

az iot central api-token delete --app-id {appid} --token-id {tokenId}

Parameter yang Diperlukan

--app-id -n

ID Aplikasi aplikasi IoT Central yang ingin Anda kelola. Anda dapat menemukan ID Aplikasi di halaman "Tentang" untuk aplikasi Anda di bawah menu bantuan.

--tkid --token-id

ID IoT Central yang terkait dengan token ini, [0-9a-zA-Z-] diizinkan, batas panjang maksimum hingga 40. Tentukan ID yang kemudian akan Anda gunakan saat memodifikasi atau menghapus token ini nanti melalui CLI atau API.

Parameter Opsional

--api-version --av
Tidak digunakan lagi

Argumen 'api_version' telah tidak digunakan lagi dan akan dihapus dalam rilis mendatang.

Parameter perintah ini tidak digunakan lagi dan akan diabaikan. Dalam rilis mendatang, kami hanya akan mendukung API IoT Central dari versi GA terbaru. Jika ada API yang belum GA, kami akan memanggil versi pratinjau terbaru.

nilai yang diterima: 2022-06-30-preview, 2022-07-31
nilai default: 2022-07-31
--central-api-uri --central-dns-suffix

Akhiran DNS IoT Central yang terkait dengan aplikasi Anda.

nilai default: azureiotcentral.com
--token

Jika Anda lebih suka mengirimkan permintaan tanpa mengautentikasi terhadap Azure CLI, Anda dapat menentukan token pengguna yang valid untuk mengautentikasi permintaan Anda. Anda harus menentukan jenis kunci sebagai bagian dari permintaan. Pelajari lebih lanjut di https://aka.ms/iotcentraldocsapi.

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 iot central api-token list

Dapatkan daftar token API yang terkait dengan aplikasi IoT Central Anda.

Informasi dalam daftar berisi informasi dasar tentang token dalam aplikasi dan tidak menyertakan nilai token.

az iot central api-token list --app-id
                              [--api-version {2022-06-30-preview, 2022-07-31}]
                              [--central-api-uri]
                              [--token]

Contoh

Daftar token API

az iot central api-token list --app-id {appid}

Parameter yang Diperlukan

--app-id -n

ID Aplikasi aplikasi IoT Central yang ingin Anda kelola. Anda dapat menemukan ID Aplikasi di halaman "Tentang" untuk aplikasi Anda di bawah menu bantuan.

Parameter Opsional

--api-version --av
Tidak digunakan lagi

Argumen 'api_version' telah tidak digunakan lagi dan akan dihapus dalam rilis mendatang.

Parameter perintah ini tidak digunakan lagi dan akan diabaikan. Dalam rilis mendatang, kami hanya akan mendukung API IoT Central dari versi GA terbaru. Jika ada API yang belum GA, kami akan memanggil versi pratinjau terbaru.

nilai yang diterima: 2022-06-30-preview, 2022-07-31
nilai default: 2022-07-31
--central-api-uri --central-dns-suffix

Akhiran DNS IoT Central yang terkait dengan aplikasi Anda.

nilai default: azureiotcentral.com
--token

Jika Anda lebih suka mengirimkan permintaan tanpa mengautentikasi terhadap Azure CLI, Anda dapat menentukan token pengguna yang valid untuk mengautentikasi permintaan Anda. Anda harus menentukan jenis kunci sebagai bagian dari permintaan. Pelajari lebih lanjut di https://aka.ms/iotcentraldocsapi.

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 iot central api-token show

Dapatkan detail untuk token API yang terkait dengan aplikasi IoT Central Anda.

Mencantumkan detail, seperti peran terkait, untuk token API di aplikasi IoT Central Anda.

az iot central api-token show --app-id
                              --tkid
                              [--api-version {2022-06-30-preview, 2022-07-31}]
                              [--central-api-uri]
                              [--token]

Contoh

Mendapatkan token API

az iot central api-token show --app-id {appid} --token-id {tokenId}

Parameter yang Diperlukan

--app-id -n

ID Aplikasi aplikasi IoT Central yang ingin Anda kelola. Anda dapat menemukan ID Aplikasi di halaman "Tentang" untuk aplikasi Anda di bawah menu bantuan.

--tkid --token-id

ID IoT Central yang terkait dengan token ini, [0-9a-zA-Z-] diizinkan, batas panjang maksimum hingga 40. Tentukan ID yang kemudian akan Anda gunakan saat memodifikasi atau menghapus token ini nanti melalui CLI atau API.

Parameter Opsional

--api-version --av
Tidak digunakan lagi

Argumen 'api_version' telah tidak digunakan lagi dan akan dihapus dalam rilis mendatang.

Parameter perintah ini tidak digunakan lagi dan akan diabaikan. Dalam rilis mendatang, kami hanya akan mendukung API IoT Central dari versi GA terbaru. Jika ada API yang belum GA, kami akan memanggil versi pratinjau terbaru.

nilai yang diterima: 2022-06-30-preview, 2022-07-31
nilai default: 2022-07-31
--central-api-uri --central-dns-suffix

Akhiran DNS IoT Central yang terkait dengan aplikasi Anda.

nilai default: azureiotcentral.com
--token

Jika Anda lebih suka mengirimkan permintaan tanpa mengautentikasi terhadap Azure CLI, Anda dapat menentukan token pengguna yang valid untuk mengautentikasi permintaan Anda. Anda harus menentukan jenis kunci sebagai bagian dari permintaan. Pelajari lebih lanjut di https://aka.ms/iotcentraldocsapi.

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.