IotDpsResource interface

Interface representing a IotDpsResource.

Methods

beginCreateOrUpdate(string, string, ProvisioningServiceDescription, IotDpsResourceCreateOrUpdateOptionalParams)

Create or update the metadata of the provisioning service. The usual pattern to modify a property is to retrieve the provisioning service metadata and security metadata, and then combine them with the modified values in a new body to update the provisioning service.

beginCreateOrUpdateAndWait(string, string, ProvisioningServiceDescription, IotDpsResourceCreateOrUpdateOptionalParams)

Create or update the metadata of the provisioning service. The usual pattern to modify a property is to retrieve the provisioning service metadata and security metadata, and then combine them with the modified values in a new body to update the provisioning service.

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

Create or update the status of a private endpoint connection with the specified name

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

Create or update the status of a private endpoint connection with the specified name

beginDelete(string, string, IotDpsResourceDeleteOptionalParams)

Deletes the Provisioning Service.

beginDeleteAndWait(string, string, IotDpsResourceDeleteOptionalParams)

Deletes the Provisioning Service.

beginDeletePrivateEndpointConnection(string, string, string, IotDpsResourceDeletePrivateEndpointConnectionOptionalParams)

Delete private endpoint connection with the specified name

beginDeletePrivateEndpointConnectionAndWait(string, string, string, IotDpsResourceDeletePrivateEndpointConnectionOptionalParams)

Delete private endpoint connection with the specified name

beginUpdate(string, string, TagsResource, IotDpsResourceUpdateOptionalParams)

Update an existing provisioning service's tags. to update other fields use the CreateOrUpdate method

beginUpdateAndWait(string, string, TagsResource, IotDpsResourceUpdateOptionalParams)

Update an existing provisioning service's tags. to update other fields use the CreateOrUpdate method

checkProvisioningServiceNameAvailability(OperationInputs, IotDpsResourceCheckProvisioningServiceNameAvailabilityOptionalParams)

Check if a provisioning service name is available. This will validate if the name is syntactically valid and if the name is usable

get(string, string, IotDpsResourceGetOptionalParams)

Get the metadata of the provisioning service without SAS keys.

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

Gets the status of a long running operation, such as create, update or delete a provisioning service.

getPrivateEndpointConnection(string, string, string, IotDpsResourceGetPrivateEndpointConnectionOptionalParams)

Get private endpoint connection properties

getPrivateLinkResources(string, string, string, IotDpsResourceGetPrivateLinkResourcesOptionalParams)

Get the specified private link resource for the given provisioning service

listByResourceGroup(string, IotDpsResourceListByResourceGroupOptionalParams)

Get a list of all provisioning services in the given resource group.

listBySubscription(IotDpsResourceListBySubscriptionOptionalParams)

List all the provisioning services for a given subscription id.

listKeys(string, string, IotDpsResourceListKeysOptionalParams)

List the primary and secondary keys for a provisioning service.

listKeysForKeyName(string, string, string, IotDpsResourceListKeysForKeyNameOptionalParams)

List primary and secondary keys for a specific key name

listPrivateEndpointConnections(string, string, IotDpsResourceListPrivateEndpointConnectionsOptionalParams)

List private endpoint connection properties

listPrivateLinkResources(string, string, IotDpsResourceListPrivateLinkResourcesOptionalParams)

List private link resources for the given provisioning service

listValidSkus(string, string, IotDpsResourceListValidSkusOptionalParams)

Gets the list of valid SKUs and tiers for a provisioning service.

Method Details

beginCreateOrUpdate(string, string, ProvisioningServiceDescription, IotDpsResourceCreateOrUpdateOptionalParams)

Create or update the metadata of the provisioning service. The usual pattern to modify a property is to retrieve the provisioning service metadata and security metadata, and then combine them with the modified values in a new body to update the provisioning service.

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

Parameters

resourceGroupName

string

Resource group identifier.

provisioningServiceName

string

Name of provisioning service to create or update.

iotDpsDescription
ProvisioningServiceDescription

Description of the provisioning service to create or update.

options
IotDpsResourceCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, ProvisioningServiceDescription, IotDpsResourceCreateOrUpdateOptionalParams)

Create or update the metadata of the provisioning service. The usual pattern to modify a property is to retrieve the provisioning service metadata and security metadata, and then combine them with the modified values in a new body to update the provisioning service.

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

Parameters

resourceGroupName

string

Resource group identifier.

provisioningServiceName

string

Name of provisioning service to create or update.

iotDpsDescription
ProvisioningServiceDescription

Description of the provisioning service to create or update.

options
IotDpsResourceCreateOrUpdateOptionalParams

The options parameters.

Returns

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

Create or update the status of a private endpoint connection with the specified name

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

Parameters

resourceGroupName

string

The name of the resource group that contains the provisioning service.

resourceName

string

The name of the provisioning service.

privateEndpointConnectionName

string

The name of the private endpoint connection

privateEndpointConnection
PrivateEndpointConnection

The private endpoint connection with updated properties

Returns

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

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

Create or update the status of a private endpoint connection with the specified name

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

Parameters

resourceGroupName

string

The name of the resource group that contains the provisioning service.

resourceName

string

The name of the provisioning service.

privateEndpointConnectionName

string

The name of the private endpoint connection

privateEndpointConnection
PrivateEndpointConnection

The private endpoint connection with updated properties

Returns

beginDelete(string, string, IotDpsResourceDeleteOptionalParams)

Deletes the Provisioning Service.

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

Parameters

provisioningServiceName

string

Name of provisioning service to delete.

resourceGroupName

string

Resource group identifier.

options
IotDpsResourceDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, IotDpsResourceDeleteOptionalParams)

Deletes the Provisioning Service.

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

Parameters

provisioningServiceName

string

Name of provisioning service to delete.

resourceGroupName

string

Resource group identifier.

options
IotDpsResourceDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginDeletePrivateEndpointConnection(string, string, string, IotDpsResourceDeletePrivateEndpointConnectionOptionalParams)

Delete private endpoint connection with the specified name

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

Parameters

resourceGroupName

string

The name of the resource group that contains the provisioning service.

resourceName

string

The name of the provisioning service.

privateEndpointConnectionName

string

The name of the private endpoint connection

Returns

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

beginDeletePrivateEndpointConnectionAndWait(string, string, string, IotDpsResourceDeletePrivateEndpointConnectionOptionalParams)

Delete private endpoint connection with the specified name

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

Parameters

resourceGroupName

string

The name of the resource group that contains the provisioning service.

resourceName

string

The name of the provisioning service.

privateEndpointConnectionName

string

The name of the private endpoint connection

Returns

beginUpdate(string, string, TagsResource, IotDpsResourceUpdateOptionalParams)

Update an existing provisioning service's tags. to update other fields use the CreateOrUpdate method

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

Parameters

resourceGroupName

string

Resource group identifier.

provisioningServiceName

string

Name of provisioning service to create or update.

provisioningServiceTags
TagsResource

Updated tag information to set into the provisioning service instance.

options
IotDpsResourceUpdateOptionalParams

The options parameters.

Returns

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

beginUpdateAndWait(string, string, TagsResource, IotDpsResourceUpdateOptionalParams)

Update an existing provisioning service's tags. to update other fields use the CreateOrUpdate method

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

Parameters

resourceGroupName

string

Resource group identifier.

provisioningServiceName

string

Name of provisioning service to create or update.

provisioningServiceTags
TagsResource

Updated tag information to set into the provisioning service instance.

options
IotDpsResourceUpdateOptionalParams

The options parameters.

Returns

checkProvisioningServiceNameAvailability(OperationInputs, IotDpsResourceCheckProvisioningServiceNameAvailabilityOptionalParams)

Check if a provisioning service name is available. This will validate if the name is syntactically valid and if the name is usable

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

Parameters

argumentsParam
OperationInputs

Set the name parameter in the OperationInputs structure to the name of the provisioning service to check.

Returns

get(string, string, IotDpsResourceGetOptionalParams)

Get the metadata of the provisioning service without SAS keys.

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

Parameters

provisioningServiceName

string

Name of the provisioning service to retrieve.

resourceGroupName

string

Resource group name.

options
IotDpsResourceGetOptionalParams

The options parameters.

Returns

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

Gets the status of a long running operation, such as create, update or delete a provisioning service.

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

Parameters

operationId

string

Operation id corresponding to long running operation. Use this to poll for the status.

resourceGroupName

string

Resource group identifier.

provisioningServiceName

string

Name of provisioning service that the operation is running on.

asyncinfo

string

Async header used to poll on the status of the operation, obtained while creating the long running operation.

options
IotDpsResourceGetOperationResultOptionalParams

The options parameters.

Returns

getPrivateEndpointConnection(string, string, string, IotDpsResourceGetPrivateEndpointConnectionOptionalParams)

Get private endpoint connection properties

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

Parameters

resourceGroupName

string

The name of the resource group that contains the provisioning service.

resourceName

string

The name of the provisioning service.

privateEndpointConnectionName

string

The name of the private endpoint connection

Returns

getPrivateLinkResources(string, string, string, IotDpsResourceGetPrivateLinkResourcesOptionalParams)

Get the specified private link resource for the given provisioning service

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

Parameters

resourceGroupName

string

The name of the resource group that contains the provisioning service.

resourceName

string

The name of the provisioning service.

groupId

string

The name of the private link resource

options
IotDpsResourceGetPrivateLinkResourcesOptionalParams

The options parameters.

Returns

listByResourceGroup(string, IotDpsResourceListByResourceGroupOptionalParams)

Get a list of all provisioning services in the given resource group.

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

Parameters

resourceGroupName

string

Resource group identifier.

options
IotDpsResourceListByResourceGroupOptionalParams

The options parameters.

Returns

listBySubscription(IotDpsResourceListBySubscriptionOptionalParams)

List all the provisioning services for a given subscription id.

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

Parameters

options
IotDpsResourceListBySubscriptionOptionalParams

The options parameters.

Returns

listKeys(string, string, IotDpsResourceListKeysOptionalParams)

List the primary and secondary keys for a provisioning service.

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

Parameters

provisioningServiceName

string

The provisioning service name to get the shared access keys for.

resourceGroupName

string

resource group name

options
IotDpsResourceListKeysOptionalParams

The options parameters.

Returns

listKeysForKeyName(string, string, string, IotDpsResourceListKeysForKeyNameOptionalParams)

List primary and secondary keys for a specific key name

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

Parameters

provisioningServiceName

string

Name of the provisioning service.

keyName

string

Logical key name to get key-values for.

resourceGroupName

string

The name of the resource group that contains the provisioning service.

options
IotDpsResourceListKeysForKeyNameOptionalParams

The options parameters.

Returns

listPrivateEndpointConnections(string, string, IotDpsResourceListPrivateEndpointConnectionsOptionalParams)

List private endpoint connection properties

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

Parameters

resourceGroupName

string

The name of the resource group that contains the provisioning service.

resourceName

string

The name of the provisioning service.

Returns

listPrivateLinkResources(string, string, IotDpsResourceListPrivateLinkResourcesOptionalParams)

List private link resources for the given provisioning service

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

Parameters

resourceGroupName

string

The name of the resource group that contains the provisioning service.

resourceName

string

The name of the provisioning service.

Returns

listValidSkus(string, string, IotDpsResourceListValidSkusOptionalParams)

Gets the list of valid SKUs and tiers for a provisioning service.

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

Parameters

provisioningServiceName

string

Name of provisioning service.

resourceGroupName

string

Name of resource group.

options
IotDpsResourceListValidSkusOptionalParams

The options parameters.

Returns