@azure/arm-deviceprovisioningservices package

Kelas

IotDpsClient

Antarmuka

AsyncOperationResult

Hasil dari operasi jangka panjang.
CertificateListDescription

Array objek Sertifikat yang diserialisasikan JSON.
CertificateProperties

Penjabaran dari Sertifikat CA X509.
CertificateResponse

Sertifikat X509.
DpsCertificateCreateOrUpdateOptionalParams

Parameter opsional.
DpsCertificateDeleteOptionalParams

Parameter opsional.
DpsCertificateGenerateVerificationCodeOptionalParams

Parameter opsional.
DpsCertificateGetOptionalParams

Parameter opsional.
DpsCertificateListOptionalParams

Parameter opsional.
DpsCertificateOperations

Antarmuka yang mewakili operasi DpsCertificate.
DpsCertificateVerifyCertificateOptionalParams

Parameter opsional.
ErrorAdditionalInfo

Informasi tambahan tentang kesalahan pengelolaan sumber daya.
ErrorDetail

Detail kesalahan.
ErrorDetails

Detail kesalahan.
ErrorMessage

Respons kesalahan yang berisi pesan dan kode.
ErrorResponse

Respons kesalahan umum untuk semua API Azure Resource Manager untuk mengembalikan detail kesalahan untuk operasi yang gagal.
GroupIdInformation

Informasi grup untuk membuat titik akhir privat pada layanan provisi
GroupIdInformationProperties

Properti untuk objek informasi grup
IotDpsClientOptionalParams

Parameter opsional untuk klien.
IotDpsPropertiesDescription

properti khusus layanan dari layanan provisi, termasuk kunci, hub iot tertaut, status saat ini, dan properti yang dihasilkan sistem seperti nama host dan idScope
IotDpsResourceCheckProvisioningServiceNameAvailabilityOptionalParams

Parameter opsional.
IotDpsResourceCreateOrUpdateOptionalParams

Parameter opsional.
IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams

Parameter opsional.
IotDpsResourceDeleteOptionalParams

Parameter opsional.
IotDpsResourceDeletePrivateEndpointConnectionOptionalParams

Parameter opsional.
IotDpsResourceGetOperationResultOptionalParams

Parameter opsional.
IotDpsResourceGetOptionalParams

Parameter opsional.
IotDpsResourceGetPrivateEndpointConnectionOptionalParams

Parameter opsional.
IotDpsResourceGetPrivateLinkResourcesOptionalParams

Parameter opsional.
IotDpsResourceListByResourceGroupOptionalParams

Parameter opsional.
IotDpsResourceListBySubscriptionOptionalParams

Parameter opsional.
IotDpsResourceListKeysForKeyNameOptionalParams

Parameter opsional.
IotDpsResourceListKeysOptionalParams

Parameter opsional.
IotDpsResourceListPrivateEndpointConnectionsOptionalParams

Parameter opsional.
IotDpsResourceListPrivateLinkResourcesOptionalParams

Parameter opsional.
IotDpsResourceListValidSkusOptionalParams

Parameter opsional.
IotDpsResourceOperations

Antarmuka yang mewakili operasi IotDpsResource.
IotDpsResourceUpdateOptionalParams

Parameter opsional.
IotDpsSkuDefinition

SKU tingkat dan unit yang tersedia.
IotDpsSkuInfo

Daftar kemungkinan SKU layanan provisi.
IotHubDefinitionDescription

Deskripsi hub IoT.
IpFilterRule

Aturan filter IP untuk Layanan provisi.
ManagedServiceIdentity

Identitas layanan terkelola (identitas yang ditetapkan sistem dan/atau pengguna)
NameAvailabilityInfo

Deskripsi ketersediaan nama.
Operation

Mewakili operasi.
OperationInputs

Nilai input untuk panggilan hasil operasi.
OperationsListOptionalParams

Parameter opsional.
OperationsOperations

Antarmuka yang mewakili operasi Operasi.
PageSettings

Opsi untuk metode byPage
PagedAsyncIterableIterator

Antarmuka yang memungkinkan iterasi yang dapat diulang asinkron baik ke penyelesaian maupun berdasarkan halaman.
PrivateEndpoint

Properti titik akhir privat dari koneksi titik akhir privat
PrivateEndpointConnection

Koneksi titik akhir privat dari layanan provisi
PrivateEndpointConnectionProperties

Properti koneksi titik akhir privat
PrivateLinkResources

Sumber daya tautan privat yang tersedia untuk layanan provisi
PrivateLinkServiceConnectionState

Status koneksi titik akhir privat saat ini
ProvisioningServiceDescription

Deskripsi layanan provisi.
ProxyResource

Definisi model sumber daya untuk sumber daya proksi Azure Resource Manager. Ini tidak akan memiliki tag dan lokasi
Resource

Bidang umum yang dikembalikan dalam respons untuk semua sumber daya Azure Resource Manager
RestorePollerOptions
SharedAccessSignatureAuthorizationRuleAccessRightsDescription

Deskripsi kunci akses bersama.
SystemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
TagsResource

Kontainer yang hanya menyimpan Tag untuk sumber daya, memungkinkan pengguna memperbarui tag pada instans Provisioning Service.
TrackedResource

Definisi model sumber daya untuk Sumber Daya Azure Resource Manager melacak sumber daya tingkat atas yang memiliki 'tag' dan 'lokasi'
UserAssignedIdentity

Properti identitas yang ditetapkan pengguna
VerificationCodeRequest

Sertifikat daun berseri JSON
VerificationCodeResponse

Deskripsi respons kode verifikasi.
VerificationCodeResponseProperties

antarmuka model VerificationCodeResponseProperties

Alias Jenis

AccessRightsDescription

Hak yang dimiliki kunci ini.
KnownAccessRightsDescription dapat digunakan secara bergantian dengan AccessRightsDescription, enum ini berisi nilai yang diketahui yang didukung layanan.

Nilai yang diketahui didukung oleh layanan

ServiceConfig
EnrollmentRead
EnrollmentWrite
DeviceConnect
RegistrationStatusRead
RegistrationStatusWrite
AllocationPolicy

Kebijakan alokasi yang akan digunakan oleh layanan provisi ini.
KnownAllocationPolicy dapat digunakan secara bergantian dengan AllocationPolicy, enum ini berisi nilai yang diketahui yang didukung layanan.

Nilai yang diketahui didukung oleh layanan

Hashed
GeoLatency
Statis
AzureSupportedClouds

Nilai yang didukung untuk pengaturan cloud sebagai jenis literal string
CertificatePurpose

Jenis SertifikatTujuan
ContinuablePage

Antarmuka yang menjelaskan halaman hasil.
CreatedByType

Jenis entitas yang membuat sumber daya.
KnownCreatedByType dapat digunakan secara bergantian dengan CreatedByType, enum ini berisi nilai yang diketahui yang didukung layanan.

Nilai yang diketahui didukung oleh layanan

Pengguna: Entitas dibuat oleh pengguna.
Aplikasi: Entitas dibuat oleh aplikasi.
ManagedIdentity: Entitas dibuat oleh identitas terkelola.
Kunci: Entitas dibuat oleh kunci.
IotDpsSku

Nama Sku.
KnownIotDpsSku dapat digunakan secara bergantian dengan IotDpsSku, enum ini berisi nilai yang diketahui yang didukung layanan.

Nilai yang diketahui didukung oleh layanan

S1
IotHubAuthenticationType

Jenis autentikasi IotHub MI: KeyBased, UserAssigned, SystemAssigned.
KnownIotHubAuthenticationType dapat digunakan secara bergantian dengan IotHubAuthenticationType, enum ini berisi nilai-nilai yang diketahui yang didukung oleh layanan tersebut.

Nilai yang diketahui didukung oleh layanan

Berbasis Kunci: Jenis otentikasi Berbasis Kunci.
UserAssigned: Jenis autentikasi yang ditetapkan pengguna.
SystemAssigned: Jenis autentikasi yang ditetapkan sistem.
IpFilterActionType

Tindakan yang diinginkan untuk permintaan yang diambil oleh aturan ini.
IpFilterTargetType

Target untuk permintaan yang diambil oleh aturan ini.
ManagedServiceIdentityType

Jenis identitas layanan terkelola (di mana jenis SystemAssigned dan UserAssigned diizinkan).
KnownManagedServiceIdentityType dapat digunakan secara bergantian dengan ManagedServiceIdentityType, enum ini berisi nilai yang diketahui yang didukung layanan.

Nilai yang diketahui didukung oleh layanan

Tidak ada: Tidak ada identitas terkelola.
SystemAssigned: Identitas terkelola yang ditetapkan sistem.
UserAssigned: Identitas terkelola yang ditetapkan pengguna.
SystemAssigned,UserAssigned: Sistem dan identitas terkelola yang ditetapkan pengguna.
NameUnavailabilityReason

menentukan alasan nama tidak tersedia
KnownNameUnavailabilityReason dapat digunakan secara bergantian dengan NameUnavailabilityReason, enum ini berisi nilai yang diketahui yang didukung layanan.

Nilai yang diketahui didukung oleh layanan

Tidak Valid
AlreadyExists
PrivateLinkServiceConnectionStatus

Status koneksi titik akhir privat
KnownPrivateLinkServiceConnectionStatus dapat digunakan secara bergantian dengan PrivateLinkServiceConnectionStatus, enum ini berisi nilai yang diketahui yang didukung layanan.

Nilai yang diketahui didukung oleh layanan

Tertunda
yang Disetujui
Ditolak
Terputus
PublicNetworkAccess

Apakah permintaan dari Jaringan Publik diizinkan
KnownPublicNetworkAccess dapat digunakan secara bergantian dengan PublicNetworkAccess, enum ini berisi nilai yang diketahui yang didukung layanan.

Nilai yang diketahui didukung oleh layanan

diaktifkan
Dinonaktifkan
State

Status layanan provisi saat ini.
KnownState dapat digunakan secara bergantian dengan State, enum ini berisi nilai yang diketahui yang didukung layanan.

Nilai yang diketahui didukung oleh layanan

Mengaktifkan
Aktif
Menghapus
dihapus
ActivationFailed
DeletionFailed
Transisi
Menangguhkan
Ditangguhkan

FailingOver
failoverFailed

Enum

AzureClouds

Enum untuk mendeskripsikan lingkungan Azure Cloud.
KnownAccessRightsDescription

Hak yang dimiliki kunci ini.
KnownAllocationPolicy

Kebijakan alokasi yang akan digunakan oleh layanan provisi ini.
KnownCertificatePurpose

Nilai yang diketahui dari CertificatePurpose yang diterima layanan.
KnownCreatedByType

Jenis entitas yang membuat sumber daya.
KnownIotDpsSku

Nama Sku.
KnownIotHubAuthenticationType

Jenis autentikasi IotHub MI: KeyBased, UserAssigned, SystemAssigned.
KnownManagedServiceIdentityType

Jenis identitas layanan terkelola (di mana jenis SystemAssigned dan UserAssigned diizinkan).
KnownNameUnavailabilityReason

menentukan alasan nama tidak tersedia
KnownPrivateLinkServiceConnectionStatus

Status koneksi titik akhir privat
KnownPublicNetworkAccess

Apakah permintaan dari Jaringan Publik diizinkan
KnownState

Status layanan provisi saat ini.
KnownVersions

Versi API yang tersedia.

Fungsi

isRestError(unknown)

Typeguard untuk RestError
restorePoller<TResponse, TResult>(IotDpsClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Membuat poller dari status serialisasi poller lain. Ini dapat berguna ketika Anda ingin membuat poller di host yang berbeda atau poller perlu dibuat setelah poller asli tidak dalam cakupan.

Variabel

RestError

Jenis kesalahan kustom untuk permintaan alur yang gagal.

Detail Fungsi

isRestError(unknown)

Typeguard untuk RestError

function isRestError(e: unknown): e is RestError

Parameter

e

unknown

Sesuatu tertangkap oleh klausul tangkapan.

Mengembalikan

e is RestError

restorePoller<TResponse, TResult>(IotDpsClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Membuat poller dari status serialisasi poller lain. Ini dapat berguna ketika Anda ingin membuat poller di host yang berbeda atau poller perlu dibuat setelah poller asli tidak dalam cakupan.

function restorePoller<TResponse, TResult>(client: IotDpsClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameter

client
IotDpsClient
serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Mengembalikan

PollerLike<OperationState<TResult>, TResult>

Detail Variabel

RestError

Jenis kesalahan kustom untuk permintaan alur yang gagal.

RestError: RestErrorConstructor

Jenis

RestErrorConstructor