IotDpsResource interface

Paket:

@azure/arm-deviceprovisioningservices

Antarmuka yang mewakili IotDpsResource.

Metode

beginCreateOrUpdate(string, string, ProvisioningServiceDescription, IotDpsResourceCreateOrUpdateOptionalParams)	Membuat atau memperbarui metadata layanan provisi. Pola yang biasa untuk memodifikasi properti adalah mengambil metadata layanan provisi dan metadata keamanan, lalu menggabungkannya dengan nilai yang dimodifikasi dalam isi baru untuk memperbarui layanan provisi.
beginCreateOrUpdateAndWait(string, string, ProvisioningServiceDescription, IotDpsResourceCreateOrUpdateOptionalParams)	Membuat atau memperbarui metadata layanan provisi. Pola yang biasa untuk memodifikasi properti adalah mengambil metadata layanan provisi dan metadata keamanan, lalu menggabungkannya dengan nilai yang dimodifikasi dalam isi baru untuk memperbarui layanan provisi.
beginCreateOrUpdatePrivateEndpointConnection(string, string, string, PrivateEndpointConnection, IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams)	Membuat atau memperbarui status koneksi titik akhir privat dengan nama yang ditentukan
beginCreateOrUpdatePrivateEndpointConnectionAndWait(string, string, string, PrivateEndpointConnection, IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams)	Membuat atau memperbarui status koneksi titik akhir privat dengan nama yang ditentukan
beginDelete(string, string, IotDpsResourceDeleteOptionalParams)	Menghapus Layanan Provisi.
beginDeleteAndWait(string, string, IotDpsResourceDeleteOptionalParams)	Menghapus Layanan Provisi.
beginDeletePrivateEndpointConnection(string, string, string, IotDpsResourceDeletePrivateEndpointConnectionOptionalParams)	Menghapus koneksi titik akhir privat dengan nama yang ditentukan
beginDeletePrivateEndpointConnectionAndWait(string, string, string, IotDpsResourceDeletePrivateEndpointConnectionOptionalParams)	Menghapus koneksi titik akhir privat dengan nama yang ditentukan
beginUpdate(string, string, TagsResource, IotDpsResourceUpdateOptionalParams)	Perbarui tag layanan provisi yang ada. untuk memperbarui bidang lain menggunakan metode CreateOrUpdate
beginUpdateAndWait(string, string, TagsResource, IotDpsResourceUpdateOptionalParams)	Perbarui tag layanan provisi yang ada. untuk memperbarui bidang lain menggunakan metode CreateOrUpdate
checkProvisioningServiceNameAvailability(OperationInputs, IotDpsResourceCheckProvisioningServiceNameAvailabilityOptionalParams)	Periksa apakah nama layanan provisi tersedia. Ini akan memvalidasi apakah nama valid secara sindikat dan jika nama tersebut dapat digunakan
get(string, string, IotDpsResourceGetOptionalParams)	Dapatkan metadata layanan provisi tanpa kunci SAS.
getOperationResult(string, string, string, string, IotDpsResourceGetOperationResultOptionalParams)	Mendapatkan status operasi yang berjalan lama, seperti membuat, memperbarui, atau menghapus layanan provisi.
getPrivateEndpointConnection(string, string, string, IotDpsResourceGetPrivateEndpointConnectionOptionalParams)	Mendapatkan properti koneksi titik akhir privat
getPrivateLinkResources(string, string, string, IotDpsResourceGetPrivateLinkResourcesOptionalParams)	Mendapatkan sumber daya tautan privat yang ditentukan untuk layanan provisi yang diberikan
listByResourceGroup(string, IotDpsResourceListByResourceGroupOptionalParams)	Dapatkan daftar semua layanan provisi dalam grup sumber daya tertentu.
listBySubscription(IotDpsResourceListBySubscriptionOptionalParams)	Cantumkan semua layanan provisi untuk id langganan tertentu.
listKeys(string, string, IotDpsResourceListKeysOptionalParams)	Cantumkan kunci primer dan sekunder untuk layanan provisi.
listKeysForKeyName(string, string, string, IotDpsResourceListKeysForKeyNameOptionalParams)	Mencantumkan kunci primer dan sekunder untuk nama kunci tertentu
listPrivateEndpointConnections(string, string, IotDpsResourceListPrivateEndpointConnectionsOptionalParams)	Mencantumkan properti koneksi titik akhir privat
listPrivateLinkResources(string, string, IotDpsResourceListPrivateLinkResourcesOptionalParams)	Mencantumkan sumber daya tautan privat untuk layanan provisi yang diberikan
listValidSkus(string, string, IotDpsResourceListValidSkusOptionalParams)	Mendapatkan daftar SKU dan tingkatan yang valid untuk layanan provisi.

Detail Metode

beginCreateOrUpdate(string, string, ProvisioningServiceDescription, IotDpsResourceCreateOrUpdateOptionalParams)

Membuat atau memperbarui metadata layanan provisi. Pola yang biasa untuk memodifikasi properti adalah mengambil metadata layanan provisi dan metadata keamanan, lalu menggabungkannya dengan nilai yang dimodifikasi dalam isi baru untuk memperbarui layanan provisi.

function beginCreateOrUpdate(resourceGroupName: string, provisioningServiceName: string, iotDpsDescription: ProvisioningServiceDescription, options?: IotDpsResourceCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<ProvisioningServiceDescription>, ProvisioningServiceDescription>>

Parameter

resourceGroupName

string

Pengidentifikasi grup sumber daya.

provisioningServiceName

string

Nama layanan provisi untuk membuat atau memperbarui.

iotDpsDescription

ProvisioningServiceDescription

Deskripsi layanan provisi untuk membuat atau memperbarui.

options

IotDpsResourceCreateOrUpdateOptionalParams

Parameter opsi.

Mengembalikan

Promise<PollerLike<@azure/core-lro.PollOperationState<ProvisioningServiceDescription>, ProvisioningServiceDescription>>

beginCreateOrUpdateAndWait(string, string, ProvisioningServiceDescription, IotDpsResourceCreateOrUpdateOptionalParams)

Membuat atau memperbarui metadata layanan provisi. Pola yang biasa untuk memodifikasi properti adalah mengambil metadata layanan provisi dan metadata keamanan, lalu menggabungkannya dengan nilai yang dimodifikasi dalam isi baru untuk memperbarui layanan provisi.

function beginCreateOrUpdateAndWait(resourceGroupName: string, provisioningServiceName: string, iotDpsDescription: ProvisioningServiceDescription, options?: IotDpsResourceCreateOrUpdateOptionalParams): Promise<ProvisioningServiceDescription>

Parameter

resourceGroupName

string

Pengidentifikasi grup sumber daya.

provisioningServiceName

string

Nama layanan provisi untuk membuat atau memperbarui.

iotDpsDescription

ProvisioningServiceDescription

Deskripsi layanan provisi untuk membuat atau memperbarui.

options

IotDpsResourceCreateOrUpdateOptionalParams

Parameter opsi.

Mengembalikan

Promise<ProvisioningServiceDescription>

beginCreateOrUpdatePrivateEndpointConnection(string, string, string, PrivateEndpointConnection, IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams)

Membuat atau memperbarui status koneksi titik akhir privat dengan nama yang ditentukan

function beginCreateOrUpdatePrivateEndpointConnection(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, privateEndpointConnection: PrivateEndpointConnection, options?: IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams): Promise<PollerLike<PollOperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>

Parameter

resourceGroupName

string

Nama grup sumber daya yang berisi layanan provisi.

resourceName

string

Nama layanan provisi.

privateEndpointConnectionName

string

Nama koneksi titik akhir privat

privateEndpointConnection

PrivateEndpointConnection

Koneksi titik akhir privat dengan properti yang diperbarui

options

IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams

Parameter opsi.

Mengembalikan

Promise<PollerLike<@azure/core-lro.PollOperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>

beginCreateOrUpdatePrivateEndpointConnectionAndWait(string, string, string, PrivateEndpointConnection, IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams)

Membuat atau memperbarui status koneksi titik akhir privat dengan nama yang ditentukan

function beginCreateOrUpdatePrivateEndpointConnectionAndWait(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, privateEndpointConnection: PrivateEndpointConnection, options?: IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams): Promise<PrivateEndpointConnection>

Parameter

resourceGroupName

string

Nama grup sumber daya yang berisi layanan provisi.

resourceName

string

Nama layanan provisi.

privateEndpointConnectionName

string

Nama koneksi titik akhir privat

privateEndpointConnection

PrivateEndpointConnection

Koneksi titik akhir privat dengan properti yang diperbarui

options

IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams

Parameter opsi.

Mengembalikan

Promise<PrivateEndpointConnection>

beginDelete(string, string, IotDpsResourceDeleteOptionalParams)

Menghapus Layanan Provisi.

function beginDelete(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameter

provisioningServiceName

string

Nama layanan provisi yang akan dihapus.

resourceGroupName

string

Pengidentifikasi grup sumber daya.

options

IotDpsResourceDeleteOptionalParams

Parameter opsi.

Mengembalikan

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, IotDpsResourceDeleteOptionalParams)

Menghapus Layanan Provisi.

function beginDeleteAndWait(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceDeleteOptionalParams): Promise<void>

Parameter

provisioningServiceName

string

Nama layanan provisi yang akan dihapus.

resourceGroupName

string

Pengidentifikasi grup sumber daya.

options

IotDpsResourceDeleteOptionalParams

Parameter opsi.

Mengembalikan

Promise<void>

beginDeletePrivateEndpointConnection(string, string, string, IotDpsResourceDeletePrivateEndpointConnectionOptionalParams)

Menghapus koneksi titik akhir privat dengan nama yang ditentukan

function beginDeletePrivateEndpointConnection(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, options?: IotDpsResourceDeletePrivateEndpointConnectionOptionalParams): Promise<PollerLike<PollOperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>

Parameter

resourceGroupName

string

Nama grup sumber daya yang berisi layanan provisi.

resourceName

string

Nama layanan provisi.

privateEndpointConnectionName

string

Nama koneksi titik akhir privat

options

IotDpsResourceDeletePrivateEndpointConnectionOptionalParams

Parameter opsi.

Mengembalikan

Promise<PollerLike<@azure/core-lro.PollOperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>

beginDeletePrivateEndpointConnectionAndWait(string, string, string, IotDpsResourceDeletePrivateEndpointConnectionOptionalParams)

Menghapus koneksi titik akhir privat dengan nama yang ditentukan

function beginDeletePrivateEndpointConnectionAndWait(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, options?: IotDpsResourceDeletePrivateEndpointConnectionOptionalParams): Promise<PrivateEndpointConnection>

Parameter

resourceGroupName

string

Nama grup sumber daya yang berisi layanan provisi.

resourceName

string

Nama layanan provisi.

privateEndpointConnectionName

string

Nama koneksi titik akhir privat

options

IotDpsResourceDeletePrivateEndpointConnectionOptionalParams

Parameter opsi.

Mengembalikan

Promise<PrivateEndpointConnection>

beginUpdate(string, string, TagsResource, IotDpsResourceUpdateOptionalParams)

Perbarui tag layanan provisi yang ada. untuk memperbarui bidang lain menggunakan metode CreateOrUpdate

function beginUpdate(resourceGroupName: string, provisioningServiceName: string, provisioningServiceTags: TagsResource, options?: IotDpsResourceUpdateOptionalParams): Promise<PollerLike<PollOperationState<ProvisioningServiceDescription>, ProvisioningServiceDescription>>

Parameter

resourceGroupName

string

Pengidentifikasi grup sumber daya.

provisioningServiceName

string

Nama layanan provisi untuk membuat atau memperbarui.

provisioningServiceTags

TagsResource

Informasi tag yang diperbarui untuk diatur ke dalam instans layanan provisi.

options

IotDpsResourceUpdateOptionalParams

Parameter opsi.

Mengembalikan

Promise<PollerLike<@azure/core-lro.PollOperationState<ProvisioningServiceDescription>, ProvisioningServiceDescription>>

beginUpdateAndWait(string, string, TagsResource, IotDpsResourceUpdateOptionalParams)

Perbarui tag layanan provisi yang ada. untuk memperbarui bidang lain menggunakan metode CreateOrUpdate

function beginUpdateAndWait(resourceGroupName: string, provisioningServiceName: string, provisioningServiceTags: TagsResource, options?: IotDpsResourceUpdateOptionalParams): Promise<ProvisioningServiceDescription>

Parameter

resourceGroupName

string

Pengidentifikasi grup sumber daya.

provisioningServiceName

string

Nama layanan provisi untuk membuat atau memperbarui.

provisioningServiceTags

TagsResource

Informasi tag yang diperbarui untuk diatur ke dalam instans layanan provisi.

options

IotDpsResourceUpdateOptionalParams

Parameter opsi.

Mengembalikan

Promise<ProvisioningServiceDescription>

checkProvisioningServiceNameAvailability(OperationInputs, IotDpsResourceCheckProvisioningServiceNameAvailabilityOptionalParams)

Periksa apakah nama layanan provisi tersedia. Ini akan memvalidasi apakah nama valid secara sindikat dan jika nama tersebut dapat digunakan

function checkProvisioningServiceNameAvailability(argumentsParam: OperationInputs, options?: IotDpsResourceCheckProvisioningServiceNameAvailabilityOptionalParams): Promise<NameAvailabilityInfo>

Parameter

argumentsParam

OperationInputs

Atur parameter nama dalam struktur OperationInputs ke nama layanan provisi untuk diperiksa.

options

IotDpsResourceCheckProvisioningServiceNameAvailabilityOptionalParams

Parameter opsi.

Mengembalikan

Promise<NameAvailabilityInfo>

get(string, string, IotDpsResourceGetOptionalParams)

Dapatkan metadata layanan provisi tanpa kunci SAS.

function get(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceGetOptionalParams): Promise<ProvisioningServiceDescription>

Parameter

provisioningServiceName

string

Nama layanan provisi yang akan diambil.

resourceGroupName

string

Nama grup sumber daya.

options

IotDpsResourceGetOptionalParams

Parameter opsi.

Mengembalikan

Promise<ProvisioningServiceDescription>

getOperationResult(string, string, string, string, IotDpsResourceGetOperationResultOptionalParams)

Mendapatkan status operasi yang berjalan lama, seperti membuat, memperbarui, atau menghapus layanan provisi.

function getOperationResult(operationId: string, resourceGroupName: string, provisioningServiceName: string, asyncinfo: string, options?: IotDpsResourceGetOperationResultOptionalParams): Promise<AsyncOperationResult>

Parameter

operationId

string

Id operasi yang sesuai dengan operasi jangka panjang. Gunakan ini untuk polling status.

resourceGroupName

string

Pengidentifikasi grup sumber daya.

provisioningServiceName

string

Nama layanan provisi tempat operasi berjalan.

asyncinfo

string

Header asinkron yang digunakan untuk melakukan polling pada status operasi, diperoleh saat membuat operasi yang berjalan lama.

options

IotDpsResourceGetOperationResultOptionalParams

Parameter opsi.

Mengembalikan

Promise<AsyncOperationResult>

getPrivateEndpointConnection(string, string, string, IotDpsResourceGetPrivateEndpointConnectionOptionalParams)

Mendapatkan properti koneksi titik akhir privat

function getPrivateEndpointConnection(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, options?: IotDpsResourceGetPrivateEndpointConnectionOptionalParams): Promise<PrivateEndpointConnection>

Parameter

resourceGroupName

string

Nama grup sumber daya yang berisi layanan provisi.

resourceName

string

Nama layanan provisi.

privateEndpointConnectionName

string

Nama koneksi titik akhir privat

options

IotDpsResourceGetPrivateEndpointConnectionOptionalParams

Parameter opsi.

Mengembalikan

Promise<PrivateEndpointConnection>

getPrivateLinkResources(string, string, string, IotDpsResourceGetPrivateLinkResourcesOptionalParams)

Mendapatkan sumber daya tautan privat yang ditentukan untuk layanan provisi yang diberikan

function getPrivateLinkResources(resourceGroupName: string, resourceName: string, groupId: string, options?: IotDpsResourceGetPrivateLinkResourcesOptionalParams): Promise<GroupIdInformation>

Parameter

resourceGroupName

string

Nama grup sumber daya yang berisi layanan provisi.

resourceName

string

Nama layanan provisi.

groupId

string

Nama sumber daya tautan privat

options

IotDpsResourceGetPrivateLinkResourcesOptionalParams

Parameter opsi.

Mengembalikan

Promise<GroupIdInformation>

listByResourceGroup(string, IotDpsResourceListByResourceGroupOptionalParams)

Dapatkan daftar semua layanan provisi dalam grup sumber daya tertentu.

function listByResourceGroup(resourceGroupName: string, options?: IotDpsResourceListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ProvisioningServiceDescription, ProvisioningServiceDescription[], PageSettings>

Parameter

resourceGroupName

string

Pengidentifikasi grup sumber daya.

options

IotDpsResourceListByResourceGroupOptionalParams

Parameter opsi.

Mengembalikan

PagedAsyncIterableIterator<ProvisioningServiceDescription, ProvisioningServiceDescription[], PageSettings>

listBySubscription(IotDpsResourceListBySubscriptionOptionalParams)

Cantumkan semua layanan provisi untuk id langganan tertentu.

function listBySubscription(options?: IotDpsResourceListBySubscriptionOptionalParams): PagedAsyncIterableIterator<ProvisioningServiceDescription, ProvisioningServiceDescription[], PageSettings>

Parameter

options

IotDpsResourceListBySubscriptionOptionalParams

Parameter opsi.

Mengembalikan

PagedAsyncIterableIterator<ProvisioningServiceDescription, ProvisioningServiceDescription[], PageSettings>

listKeys(string, string, IotDpsResourceListKeysOptionalParams)

Cantumkan kunci primer dan sekunder untuk layanan provisi.

function listKeys(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceListKeysOptionalParams): PagedAsyncIterableIterator<SharedAccessSignatureAuthorizationRuleAccessRightsDescription, SharedAccessSignatureAuthorizationRuleAccessRightsDescription[], PageSettings>

Parameter

provisioningServiceName

string

Nama layanan provisi untuk mendapatkan kunci akses bersama.

resourceGroupName

string

nama grup sumber daya

options

IotDpsResourceListKeysOptionalParams

Parameter opsi.

Mengembalikan

PagedAsyncIterableIterator<SharedAccessSignatureAuthorizationRuleAccessRightsDescription, SharedAccessSignatureAuthorizationRuleAccessRightsDescription[], PageSettings>

listKeysForKeyName(string, string, string, IotDpsResourceListKeysForKeyNameOptionalParams)

Mencantumkan kunci primer dan sekunder untuk nama kunci tertentu

function listKeysForKeyName(provisioningServiceName: string, keyName: string, resourceGroupName: string, options?: IotDpsResourceListKeysForKeyNameOptionalParams): Promise<SharedAccessSignatureAuthorizationRuleAccessRightsDescription>

Parameter

provisioningServiceName

string

Nama layanan provisi.

keyName

string

Nama kunci logis untuk mendapatkan nilai kunci.

resourceGroupName

string

Nama grup sumber daya yang berisi layanan provisi.

options

IotDpsResourceListKeysForKeyNameOptionalParams

Parameter opsi.

Mengembalikan

Promise<SharedAccessSignatureAuthorizationRuleAccessRightsDescription>

listPrivateEndpointConnections(string, string, IotDpsResourceListPrivateEndpointConnectionsOptionalParams)

Mencantumkan properti koneksi titik akhir privat

function listPrivateEndpointConnections(resourceGroupName: string, resourceName: string, options?: IotDpsResourceListPrivateEndpointConnectionsOptionalParams): Promise<IotDpsResourceListPrivateEndpointConnectionsResponse>

Parameter

resourceGroupName

string

Nama grup sumber daya yang berisi layanan provisi.

resourceName

string

Nama layanan provisi.

options

IotDpsResourceListPrivateEndpointConnectionsOptionalParams

Parameter opsi.

Mengembalikan

Promise<IotDpsResourceListPrivateEndpointConnectionsResponse>

listPrivateLinkResources(string, string, IotDpsResourceListPrivateLinkResourcesOptionalParams)

Mencantumkan sumber daya tautan privat untuk layanan provisi yang diberikan

function listPrivateLinkResources(resourceGroupName: string, resourceName: string, options?: IotDpsResourceListPrivateLinkResourcesOptionalParams): Promise<PrivateLinkResources>

Parameter

resourceGroupName

string

Nama grup sumber daya yang berisi layanan provisi.

resourceName

string

Nama layanan provisi.

options

IotDpsResourceListPrivateLinkResourcesOptionalParams

Parameter opsi.

Mengembalikan

Promise<PrivateLinkResources>

listValidSkus(string, string, IotDpsResourceListValidSkusOptionalParams)

Mendapatkan daftar SKU dan tingkatan yang valid untuk layanan provisi.

function listValidSkus(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceListValidSkusOptionalParams): PagedAsyncIterableIterator<IotDpsSkuDefinition, IotDpsSkuDefinition[], PageSettings>

Parameter

provisioningServiceName

string

Nama layanan provisi.

resourceGroupName

string

Nama grup sumber daya.

options

IotDpsResourceListValidSkusOptionalParams

Parameter opsi.

Mengembalikan

PagedAsyncIterableIterator<IotDpsSkuDefinition, IotDpsSkuDefinition[], PageSettings>