IotDpsResourceOperations interface

Package:

@azure/arm-deviceprovisioningservices

Interface representing a IotDpsResource operations.

Properties

checkProvisioningServiceNameAvailability	Check if a provisioning service name is available. This will validate if the name is syntactically valid and if the name is usable
createOrUpdate	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.
createOrUpdatePrivateEndpointConnection	Create or update the status of a private endpoint connection with the specified name
delete	Deletes the Provisioning Service.
deletePrivateEndpointConnection	Delete private endpoint connection with the specified name
get	Get the metadata of the provisioning service without SAS keys.
getOperationResult	Gets the status of a long running operation, such as create, update or delete a provisioning service.
getPrivateEndpointConnection	Get private endpoint connection properties
getPrivateLinkResources	Get the specified private link resource for the given provisioning service
listByResourceGroup	Get a list of all provisioning services in the given resource group.
listBySubscription	List all the provisioning services for a given subscription id.
listKeys	List the primary and secondary keys for a provisioning service.
listKeysForKeyName	List primary and secondary keys for a specific key name
listPrivateEndpointConnections	List private endpoint connection properties
listPrivateLinkResources	List private link resources for the given provisioning service
listValidSkus	Gets the list of valid SKUs and tiers for a provisioning service.
update	Update an existing provisioning service's tags. to update other fields use the CreateOrUpdate method

Property Details

checkProvisioningServiceNameAvailability

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

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

Property Value

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

createOrUpdate

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.

createOrUpdate: (resourceGroupName: string, provisioningServiceName: string, iotDpsDescription: ProvisioningServiceDescription, options?: IotDpsResourceCreateOrUpdateOptionalParams) => PollerLike<OperationState<ProvisioningServiceDescription>, ProvisioningServiceDescription>

Property Value

(resourceGroupName: string, provisioningServiceName: string, iotDpsDescription: ProvisioningServiceDescription, options?: IotDpsResourceCreateOrUpdateOptionalParams) => PollerLike<OperationState<ProvisioningServiceDescription>, ProvisioningServiceDescription>

createOrUpdatePrivateEndpointConnection

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

createOrUpdatePrivateEndpointConnection: (resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, privateEndpointConnection: PrivateEndpointConnection, options?: IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams) => PollerLike<OperationState<PrivateEndpointConnection>, PrivateEndpointConnection>

Property Value

(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, privateEndpointConnection: PrivateEndpointConnection, options?: IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams) => PollerLike<OperationState<PrivateEndpointConnection>, PrivateEndpointConnection>

delete

Deletes the Provisioning Service.

delete: (resourceGroupName: string, provisioningServiceName: string, options?: IotDpsResourceDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, provisioningServiceName: string, options?: IotDpsResourceDeleteOptionalParams) => PollerLike<OperationState<void>, void>

deletePrivateEndpointConnection

Delete private endpoint connection with the specified name

deletePrivateEndpointConnection: (resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, options?: IotDpsResourceDeletePrivateEndpointConnectionOptionalParams) => PollerLike<OperationState<PrivateEndpointConnection>, PrivateEndpointConnection>

Property Value

(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, options?: IotDpsResourceDeletePrivateEndpointConnectionOptionalParams) => PollerLike<OperationState<PrivateEndpointConnection>, PrivateEndpointConnection>

get

Get the metadata of the provisioning service without SAS keys.

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

Property Value

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

getOperationResult

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

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

Property Value

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

getPrivateEndpointConnection

Get private endpoint connection properties

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

Property Value

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

getPrivateLinkResources

Get the specified private link resource for the given provisioning service

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

Property Value

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

listByResourceGroup

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

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

Property Value

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

listBySubscription

List all the provisioning services for a given subscription id.

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

Property Value

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

listKeys

List the primary and secondary keys for a provisioning service.

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

Property Value

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

listKeysForKeyName

List primary and secondary keys for a specific key name

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

Property Value

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

listPrivateEndpointConnections

List private endpoint connection properties

listPrivateEndpointConnections: (resourceGroupName: string, resourceName: string, options?: IotDpsResourceListPrivateEndpointConnectionsOptionalParams) => Promise<PrivateEndpointConnection[]>

Property Value

(resourceGroupName: string, resourceName: string, options?: IotDpsResourceListPrivateEndpointConnectionsOptionalParams) => Promise<PrivateEndpointConnection[]>

listPrivateLinkResources

List private link resources for the given provisioning service

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

Property Value

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

listValidSkus

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

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

Property Value

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

update

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

update: (resourceGroupName: string, provisioningServiceName: string, provisioningServiceTags: TagsResource, options?: IotDpsResourceUpdateOptionalParams) => PollerLike<OperationState<ProvisioningServiceDescription>, ProvisioningServiceDescription>

Property Value

(resourceGroupName: string, provisioningServiceName: string, provisioningServiceTags: TagsResource, options?: IotDpsResourceUpdateOptionalParams) => PollerLike<OperationState<ProvisioningServiceDescription>, ProvisioningServiceDescription>