az iot central enrollment-group

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 enrollment-group . Pelajari lebih lanjut tentang ekstensi.

Mengelola dan mengonfigurasi grup pendaftaran IoT Central.

Perintah

Nama Deskripsi Jenis Status
az iot central enrollment-group create

Buat grup pendaftaran.

Ekstensi GA
az iot central enrollment-group delete

Menghapus grup pendaftaran menurut ID.

Ekstensi GA
az iot central enrollment-group generate-verification-code

Buat kode verifikasi untuk sertifikat x509 primer atau sekunder dari grup pendaftaran.

Ekstensi GA
az iot central enrollment-group list

Dapatkan daftar grup pendaftaran dalam aplikasi.

Ekstensi GA
az iot central enrollment-group show

Dapatkan detail tentang grup pendaftaran menurut ID.

Ekstensi GA
az iot central enrollment-group update

Memperbarui grup pendaftaran.

Ekstensi GA
az iot central enrollment-group verify-certificate

Verifikasi sertifikat x509 primer atau sekunder dari grup pendaftaran.

Ekstensi GA

az iot central enrollment-group create

Buat grup pendaftaran.

az iot central enrollment-group create --app-id
                                       --at {symmetricKey, x509}
                                       --display-name
                                       --group-id
                                       --type
                                       [--api-version {2022-06-30-preview, 2022-07-31}]
                                       [--central-api-uri]
                                       [--certificate-path]
                                       [--etag]
                                       [--pk]
                                       [--provisioning-status {disabled, enabled}]
                                       [--scp]
                                       [--secondary-key]
                                       [--token]

Contoh

Membuat grup pendaftaran

az iot central enrollment-group create --app-id {appid} --id {enrollmentGroupId} --at {attestation} --display-name {displayName} --type {type}

Membuat grup pendaftaran dengan sertifikasi utama x509

az iot central enrollment-group create --app-id {appid} --id {enrollmentGroupId} --at 'x509' --display-name {displayName} --type {type} --cp {primayCertPath}

Membuat grup pendaftaran dengan sertifikasi kunci konten yang diberikan

az iot central enrollment-group create --app-id {appid} --id {enrollmentGroupId} --at 'symmetricKey' --display-name {displayName} --type {type} --pk {primaryKey} --sk {secondaryKey}

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.

--at --attestation-type

Mekanisme pengesahan untuk grup pendaftaran. Hanya 'x509' atau 'symmetricKey' yang diizinkan. Secara default 'symmetricKey' akan digunakan untuk pengesahan.

nilai yang diterima: symmetricKey, x509
nilai default: symmetricKey
--display-name

Nama tampilan grup pendaftaran.

--group-id --id

Pengidentifikasi unik untuk grup pendaftaran.

--type

Jenis perangkat yang terhubung melalui grup.

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
--certificate-path --cp

Jalur ke file yang berisi sertifikat utama.

--etag -e

Tag Etag atau entitas yang sesuai dengan status terakhir sumber daya. Jika tidak ada etag yang disediakan, nilai '*' digunakan.

--pk --primary-key

Kunci akses bersama simetris utama yang disimpan dalam format base64.

--provisioning-status --ps

Apakah perangkat yang menggunakan grup diizinkan untuk terhubung ke IoT Central. Benar atau Salah.

nilai yang diterima: disabled, enabled
nilai default: enabled
--scp --secondary-certificate-path

Jalur ke file yang berisi sertifikat sekunder.

--secondary-key --sk

Kunci akses bersama simetris sekunder yang disimpan dalam format base64.

--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 enrollment-group delete

Menghapus grup pendaftaran menurut ID.

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

Contoh

Menghapus grup pendaftaran menurut ID

az iot central enrollment-group delete --app-id {appid} --id {enrollmentGroupId}

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.

--group-id --id

Pengidentifikasi unik untuk grup pendaftaran.

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 enrollment-group generate-verification-code

Buat kode verifikasi untuk sertifikat x509 primer atau sekunder dari grup pendaftaran.

az iot central enrollment-group generate-verification-code --app-id
                                                           --group-id
                                                           [--api-version {2022-06-30-preview, 2022-07-31}]
                                                           [--central-api-uri]
                                                           [--certificate-entry {primary, secondary}]
                                                           [--token]

Contoh

Membuat kode verifikasi untuk sertifikat x509 utama grup pendaftaran

az iot central enrollment-group generate-verification-code --app-id {appid} --id {enrollmentGroupId} --entry 'primary'

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.

--group-id --id

Pengidentifikasi unik untuk grup pendaftaran.

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

Jenis entri sertifikat x509 yang hanya memungkinkan 'primer' dan 'sekunder'.

nilai yang diterima: primary, secondary
--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 enrollment-group list

Dapatkan daftar grup pendaftaran dalam aplikasi.

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

Contoh

Mendapatkan daftar grup pendaftaran dalam aplikasi

az iot central enrollment-group 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 enrollment-group show

Dapatkan detail tentang grup pendaftaran menurut ID.

az iot central enrollment-group show --app-id
                                     --group-id
                                     [--api-version {2022-06-30-preview, 2022-07-31}]
                                     [--central-api-uri]
                                     [--certificate-entry {primary, secondary}]
                                     [--token]

Contoh

Mendapatkan detail tentang grup pendaftaran menurut ID

az iot central enrollment-group show --app-id {appid} --id {enrollmentGroupId}

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.

--group-id --id

Pengidentifikasi unik untuk grup pendaftaran.

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

Jenis entri sertifikat x509 yang hanya memungkinkan 'primer' dan 'sekunder'.

nilai yang diterima: primary, secondary
--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 enrollment-group update

Memperbarui grup pendaftaran.

az iot central enrollment-group update --app-id
                                       --group-id
                                       [--api-version {2022-06-30-preview, 2022-07-31}]
                                       [--central-api-uri]
                                       [--certificate-entry {primary, secondary}]
                                       [--certificate-path]
                                       [--display-name]
                                       [--etag]
                                       [--provisioning-status {disabled, enabled}]
                                       [--remove-x509 {false, true}]
                                       [--scp]
                                       [--token]
                                       [--type]

Contoh

Memperbarui grup pendaftaran

az iot central enrollment-group update --app-id {appid} --id {enrollmentGroupId} --display-name {displayName} --type {type} --ps {enabled}

Menghapus sertifikat utama x509 dari grup pendaftaran

az iot central enrollment-group update --app-id {appid} --id {enrollmentGroupId} --remove-x509 'true' --entry 'primary'

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.

--group-id --id

Pengidentifikasi unik untuk grup pendaftaran.

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

Jenis entri sertifikat x509 yang hanya memungkinkan 'primer' dan 'sekunder'.

nilai yang diterima: primary, secondary
--certificate-path --cp

Jalur ke file yang berisi sertifikat utama.

--display-name

Nama tampilan grup pendaftaran.

--etag

ETag digunakan untuk mencegah konflik dalam pembaruan grup pendaftaran.

--provisioning-status --ps

Apakah perangkat yang menggunakan grup diizinkan untuk terhubung ke IoT Central. Benar atau Salah.

nilai yang diterima: disabled, enabled
nilai default: enabled
--remove-x509

Apakah sertifikat x509 harus dihapus dari grup. Benar atau Salah.

nilai yang diterima: false, true
--scp --secondary-certificate-path

Jalur ke file yang berisi sertifikat sekunder.

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

--type

Jenis perangkat yang terhubung melalui grup.

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 enrollment-group verify-certificate

Verifikasi sertifikat x509 primer atau sekunder dari grup pendaftaran.

Verifikasi sertifikat x509 primer atau sekunder dari grup pendaftaran dengan memberikan sertifikat dengan kode verifikasi yang ditandatangani.

Harap dicatat bahwa jika grup pendaftaran dibuat dengan sertifikat x509 yang belum diverifikasi, sertifikat verifikasi perlu dibuat menggunakan sertifikat x509 yang belum diverifikasi dan kode verifikasi sebelum menggunakan perintah ini. Kode verifikasi dapat dihasilkan melalui cli menggunakan perintah 'enrollment-group generate-verification-code'. Pelajari selengkapnya tentang cara membuat sertifikat verifikasi menggunakan kode verifikasi di https://learn.microsoft.com/en-us/azure/iot-central/core/how-to-connect-devices-x509.

az iot central enrollment-group verify-certificate --app-id
                                                   --group-id
                                                   [--api-version {2022-06-30-preview, 2022-07-31}]
                                                   [--central-api-uri]
                                                   [--certificate-path]
                                                   [--scp]
                                                   [--token]

Contoh

Memverifikasi sertifikat x509 utama grup pendaftaran

az iot central enrollment-group verify-certificate --app-id {appid} --id {enrollmentGroupId} --cp {primayCertPath}

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.

--group-id --id

Pengidentifikasi unik untuk grup pendaftaran.

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
--certificate-path --cp

Jalur ke file yang berisi sertifikat utama.

--scp --secondary-certificate-path

Jalur ke file yang berisi sertifikat sekunder.

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