Azure Native v2 v2.90.0, Mar 27 25

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.

Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native-v2.devices.getIotDpsResource

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.

Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

Using getIotDpsResource

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getIotDpsResource(args: GetIotDpsResourceArgs, opts?: InvokeOptions): Promise<GetIotDpsResourceResult>
function getIotDpsResourceOutput(args: GetIotDpsResourceOutputArgs, opts?: InvokeOptions): Output<GetIotDpsResourceResult>

def get_iot_dps_resource(provisioning_service_name: Optional[str] = None,
                         resource_group_name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetIotDpsResourceResult
def get_iot_dps_resource_output(provisioning_service_name: Optional[pulumi.Input[str]] = None,
                         resource_group_name: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetIotDpsResourceResult]

func LookupIotDpsResource(ctx *Context, args *LookupIotDpsResourceArgs, opts ...InvokeOption) (*LookupIotDpsResourceResult, error)
func LookupIotDpsResourceOutput(ctx *Context, args *LookupIotDpsResourceOutputArgs, opts ...InvokeOption) LookupIotDpsResourceResultOutput

> Note: This function is named LookupIotDpsResource in the Go SDK.

public static class GetIotDpsResource 
{
    public static Task<GetIotDpsResourceResult> InvokeAsync(GetIotDpsResourceArgs args, InvokeOptions? opts = null)
    public static Output<GetIotDpsResourceResult> Invoke(GetIotDpsResourceInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetIotDpsResourceResult> getIotDpsResource(GetIotDpsResourceArgs args, InvokeOptions options)
public static Output<GetIotDpsResourceResult> getIotDpsResource(GetIotDpsResourceArgs args, InvokeOptions options)

fn::invoke:
  function: azure-native:devices:getIotDpsResource
  arguments:
    # arguments dictionary

The following arguments are supported:

ProvisioningServiceName string: Name of the provisioning service to retrieve.
ResourceGroupName string: Resource group name.

ProvisioningServiceName string: Name of the provisioning service to retrieve.
ResourceGroupName string: Resource group name.

provisioningServiceName String: Name of the provisioning service to retrieve.
resourceGroupName String: Resource group name.

provisioningServiceName string: Name of the provisioning service to retrieve.
resourceGroupName string: Resource group name.

provisioning_service_name str: Name of the provisioning service to retrieve.
resource_group_name str: Resource group name.

provisioningServiceName String: Name of the provisioning service to retrieve.
resourceGroupName String: Resource group name.

getIotDpsResource Result

The following output properties are available:

Id string: The resource identifier.
Location string: The resource location.
Name string: The resource name.
Properties Pulumi.AzureNative.Devices.Outputs.IotDpsPropertiesDescriptionResponse: Service specific properties for a provisioning service
Sku Pulumi.AzureNative.Devices.Outputs.IotDpsSkuInfoResponse: Sku info for a provisioning Service.
SystemData Pulumi.AzureNative.Devices.Outputs.SystemDataResponse: Metadata pertaining to creation and last modification of the resource.
Type string: The resource type.
Etag string: The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.
Resourcegroup string: The resource group of the resource.
Subscriptionid string: The subscription id of the resource.
Tags Dictionary<string, string>: The resource tags.

Id string: The resource identifier.
Location string: The resource location.
Name string: The resource name.
Properties IotDpsPropertiesDescriptionResponse: Service specific properties for a provisioning service
Sku IotDpsSkuInfoResponse: Sku info for a provisioning Service.
SystemData SystemDataResponse: Metadata pertaining to creation and last modification of the resource.
Type string: The resource type.
Etag string: The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.
Resourcegroup string: The resource group of the resource.
Subscriptionid string: The subscription id of the resource.
Tags map[string]string: The resource tags.

id String: The resource identifier.
location String: The resource location.
name String: The resource name.
properties IotDpsPropertiesDescriptionResponse: Service specific properties for a provisioning service
sku IotDpsSkuInfoResponse: Sku info for a provisioning Service.
systemData SystemDataResponse: Metadata pertaining to creation and last modification of the resource.
type String: The resource type.
etag String: The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.
resourcegroup String: The resource group of the resource.
subscriptionid String: The subscription id of the resource.
tags Map<String,String>: The resource tags.

id string: The resource identifier.
location string: The resource location.
name string: The resource name.
properties IotDpsPropertiesDescriptionResponse: Service specific properties for a provisioning service
sku IotDpsSkuInfoResponse: Sku info for a provisioning Service.
systemData SystemDataResponse: Metadata pertaining to creation and last modification of the resource.
type string: The resource type.
etag string: The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.
resourcegroup string: The resource group of the resource.
subscriptionid string: The subscription id of the resource.
tags {[key: string]: string}: The resource tags.

id str: The resource identifier.
location str: The resource location.
name str: The resource name.
properties IotDpsPropertiesDescriptionResponse: Service specific properties for a provisioning service
sku IotDpsSkuInfoResponse: Sku info for a provisioning Service.
system_data SystemDataResponse: Metadata pertaining to creation and last modification of the resource.
type str: The resource type.
etag str: The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.
resourcegroup str: The resource group of the resource.
subscriptionid str: The subscription id of the resource.
tags Mapping[str, str]: The resource tags.

id String: The resource identifier.
location String: The resource location.
name String: The resource name.
properties Property Map: Service specific properties for a provisioning service
sku Property Map: Sku info for a provisioning Service.
systemData Property Map: Metadata pertaining to creation and last modification of the resource.
type String: The resource type.
etag String: The Etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.
resourcegroup String: The resource group of the resource.
subscriptionid String: The subscription id of the resource.
tags Map<String>: The resource tags.

Supporting Types

IotDpsPropertiesDescriptionResponse

DeviceProvisioningHostName string: Device endpoint for this provisioning service.
IdScope string: Unique identifier of this provisioning service.
ServiceOperationsHostName string: Service endpoint for provisioning service.
AllocationPolicy string: Allocation policy to be used by this provisioning service.
AuthorizationPolicies List<Pulumi.AzureNative.Devices.Inputs.SharedAccessSignatureAuthorizationRuleAccessRightsDescriptionResponse>: List of authorization keys for a provisioning service.
EnableDataResidency bool: Optional. Indicates if the DPS instance has Data Residency enabled, removing the cross geo-pair disaster recovery.
IotHubs List<Pulumi.AzureNative.Devices.Inputs.IotHubDefinitionDescriptionResponse>: List of IoT hubs associated with this provisioning service.
IpFilterRules List<Pulumi.AzureNative.Devices.Inputs.TargetIpFilterRuleResponse>: The IP filter rules.
PortalOperationsHostName string: Portal endpoint to enable CORS for this provisioning service.
PrivateEndpointConnections List<Pulumi.AzureNative.Devices.Inputs.PrivateEndpointConnectionResponse>: Private endpoint connections created on this IotHub
ProvisioningState string: The ARM provisioning state of the provisioning service.
PublicNetworkAccess string: Whether requests from Public Network are allowed
State string: Current state of the provisioning service.

DeviceProvisioningHostName string: Device endpoint for this provisioning service.
IdScope string: Unique identifier of this provisioning service.
ServiceOperationsHostName string: Service endpoint for provisioning service.
AllocationPolicy string: Allocation policy to be used by this provisioning service.
AuthorizationPolicies []SharedAccessSignatureAuthorizationRuleAccessRightsDescriptionResponse: List of authorization keys for a provisioning service.
EnableDataResidency bool: Optional. Indicates if the DPS instance has Data Residency enabled, removing the cross geo-pair disaster recovery.
IotHubs []IotHubDefinitionDescriptionResponse: List of IoT hubs associated with this provisioning service.
IpFilterRules []TargetIpFilterRuleResponse: The IP filter rules.
PortalOperationsHostName string: Portal endpoint to enable CORS for this provisioning service.
PrivateEndpointConnections []PrivateEndpointConnectionResponse: Private endpoint connections created on this IotHub
ProvisioningState string: The ARM provisioning state of the provisioning service.
PublicNetworkAccess string: Whether requests from Public Network are allowed
State string: Current state of the provisioning service.

deviceProvisioningHostName String: Device endpoint for this provisioning service.
idScope String: Unique identifier of this provisioning service.
serviceOperationsHostName String: Service endpoint for provisioning service.
allocationPolicy String: Allocation policy to be used by this provisioning service.
authorizationPolicies List<SharedAccessSignatureAuthorizationRuleAccessRightsDescriptionResponse>: List of authorization keys for a provisioning service.
enableDataResidency Boolean: Optional. Indicates if the DPS instance has Data Residency enabled, removing the cross geo-pair disaster recovery.
iotHubs List<IotHubDefinitionDescriptionResponse>: List of IoT hubs associated with this provisioning service.
ipFilterRules List<TargetIpFilterRuleResponse>: The IP filter rules.
portalOperationsHostName String: Portal endpoint to enable CORS for this provisioning service.
privateEndpointConnections List<PrivateEndpointConnectionResponse>: Private endpoint connections created on this IotHub
provisioningState String: The ARM provisioning state of the provisioning service.
publicNetworkAccess String: Whether requests from Public Network are allowed
state String: Current state of the provisioning service.

deviceProvisioningHostName string: Device endpoint for this provisioning service.
idScope string: Unique identifier of this provisioning service.
serviceOperationsHostName string: Service endpoint for provisioning service.
allocationPolicy string: Allocation policy to be used by this provisioning service.
authorizationPolicies SharedAccessSignatureAuthorizationRuleAccessRightsDescriptionResponse[]: List of authorization keys for a provisioning service.
enableDataResidency boolean: Optional. Indicates if the DPS instance has Data Residency enabled, removing the cross geo-pair disaster recovery.
iotHubs IotHubDefinitionDescriptionResponse[]: List of IoT hubs associated with this provisioning service.
ipFilterRules TargetIpFilterRuleResponse[]: The IP filter rules.
portalOperationsHostName string: Portal endpoint to enable CORS for this provisioning service.
privateEndpointConnections PrivateEndpointConnectionResponse[]: Private endpoint connections created on this IotHub
provisioningState string: The ARM provisioning state of the provisioning service.
publicNetworkAccess string: Whether requests from Public Network are allowed
state string: Current state of the provisioning service.

device_provisioning_host_name str: Device endpoint for this provisioning service.
id_scope str: Unique identifier of this provisioning service.
service_operations_host_name str: Service endpoint for provisioning service.
allocation_policy str: Allocation policy to be used by this provisioning service.
authorization_policies Sequence[SharedAccessSignatureAuthorizationRuleAccessRightsDescriptionResponse]: List of authorization keys for a provisioning service.
enable_data_residency bool: Optional. Indicates if the DPS instance has Data Residency enabled, removing the cross geo-pair disaster recovery.
iot_hubs Sequence[IotHubDefinitionDescriptionResponse]: List of IoT hubs associated with this provisioning service.
ip_filter_rules Sequence[TargetIpFilterRuleResponse]: The IP filter rules.
portal_operations_host_name str: Portal endpoint to enable CORS for this provisioning service.
private_endpoint_connections Sequence[PrivateEndpointConnectionResponse]: Private endpoint connections created on this IotHub
provisioning_state str: The ARM provisioning state of the provisioning service.
public_network_access str: Whether requests from Public Network are allowed
state str: Current state of the provisioning service.

deviceProvisioningHostName String: Device endpoint for this provisioning service.
idScope String: Unique identifier of this provisioning service.
serviceOperationsHostName String: Service endpoint for provisioning service.
allocationPolicy String: Allocation policy to be used by this provisioning service.
authorizationPolicies List<Property Map>: List of authorization keys for a provisioning service.
enableDataResidency Boolean: Optional. Indicates if the DPS instance has Data Residency enabled, removing the cross geo-pair disaster recovery.
iotHubs List<Property Map>: List of IoT hubs associated with this provisioning service.
ipFilterRules List<Property Map>: The IP filter rules.
portalOperationsHostName String: Portal endpoint to enable CORS for this provisioning service.
privateEndpointConnections List<Property Map>: Private endpoint connections created on this IotHub
provisioningState String: The ARM provisioning state of the provisioning service.
publicNetworkAccess String: Whether requests from Public Network are allowed
state String: Current state of the provisioning service.

IotDpsSkuInfoResponse

Tier string: Pricing tier name of the provisioning service.
Capacity double: The number of units to provision
Name string: Sku name.

Tier string: Pricing tier name of the provisioning service.
Capacity float64: The number of units to provision
Name string: Sku name.

tier String: Pricing tier name of the provisioning service.
capacity Double: The number of units to provision
name String: Sku name.

tier string: Pricing tier name of the provisioning service.
capacity number: The number of units to provision
name string: Sku name.

tier str: Pricing tier name of the provisioning service.
capacity float: The number of units to provision
name str: Sku name.

tier String: Pricing tier name of the provisioning service.
capacity Number: The number of units to provision
name String: Sku name.

IotHubDefinitionDescriptionResponse

ConnectionString string: Connection string of the IoT hub.
Location string: ARM region of the IoT hub.
Name string: Host name of the IoT hub.
AllocationWeight int: weight to apply for a given iot h.
ApplyAllocationPolicy bool: flag for applying allocationPolicy or not for a given iot hub.

ConnectionString string: Connection string of the IoT hub.
Location string: ARM region of the IoT hub.
Name string: Host name of the IoT hub.
AllocationWeight int: weight to apply for a given iot h.
ApplyAllocationPolicy bool: flag for applying allocationPolicy or not for a given iot hub.

connectionString String: Connection string of the IoT hub.
location String: ARM region of the IoT hub.
name String: Host name of the IoT hub.
allocationWeight Integer: weight to apply for a given iot h.
applyAllocationPolicy Boolean: flag for applying allocationPolicy or not for a given iot hub.

connectionString string: Connection string of the IoT hub.
location string: ARM region of the IoT hub.
name string: Host name of the IoT hub.
allocationWeight number: weight to apply for a given iot h.
applyAllocationPolicy boolean: flag for applying allocationPolicy or not for a given iot hub.

connection_string str: Connection string of the IoT hub.
location str: ARM region of the IoT hub.
name str: Host name of the IoT hub.
allocation_weight int: weight to apply for a given iot h.
apply_allocation_policy bool: flag for applying allocationPolicy or not for a given iot hub.

connectionString String: Connection string of the IoT hub.
location String: ARM region of the IoT hub.
name String: Host name of the IoT hub.
allocationWeight Number: weight to apply for a given iot h.
applyAllocationPolicy Boolean: flag for applying allocationPolicy or not for a given iot hub.

PrivateEndpointConnectionPropertiesResponse

PrivateLinkServiceConnectionState Pulumi.AzureNative.Devices.Inputs.PrivateLinkServiceConnectionStateResponse: The current state of a private endpoint connection
PrivateEndpoint Pulumi.AzureNative.Devices.Inputs.PrivateEndpointResponse: The private endpoint property of a private endpoint connection

PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse: The current state of a private endpoint connection
PrivateEndpoint PrivateEndpointResponse: The private endpoint property of a private endpoint connection

privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse: The current state of a private endpoint connection
privateEndpoint PrivateEndpointResponse: The private endpoint property of a private endpoint connection

privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse: The current state of a private endpoint connection
privateEndpoint PrivateEndpointResponse: The private endpoint property of a private endpoint connection

private_link_service_connection_state PrivateLinkServiceConnectionStateResponse: The current state of a private endpoint connection
private_endpoint PrivateEndpointResponse: The private endpoint property of a private endpoint connection

privateLinkServiceConnectionState Property Map: The current state of a private endpoint connection
privateEndpoint Property Map: The private endpoint property of a private endpoint connection

PrivateEndpointConnectionResponse

Id string: The resource identifier.
Name string: The resource name.
Properties Pulumi.AzureNative.Devices.Inputs.PrivateEndpointConnectionPropertiesResponse: The properties of a private endpoint connection
Type string: The resource type.
SystemData Pulumi.AzureNative.Devices.Inputs.SystemDataResponse: Metadata pertaining to creation and last modification of the resource.

Id string: The resource identifier.
Name string: The resource name.
Properties PrivateEndpointConnectionPropertiesResponse: The properties of a private endpoint connection
Type string: The resource type.
SystemData SystemDataResponse: Metadata pertaining to creation and last modification of the resource.

id String: The resource identifier.
name String: The resource name.
properties PrivateEndpointConnectionPropertiesResponse: The properties of a private endpoint connection
type String: The resource type.
systemData SystemDataResponse: Metadata pertaining to creation and last modification of the resource.

id string: The resource identifier.
name string: The resource name.
properties PrivateEndpointConnectionPropertiesResponse: The properties of a private endpoint connection
type string: The resource type.
systemData SystemDataResponse: Metadata pertaining to creation and last modification of the resource.

id str: The resource identifier.
name str: The resource name.
properties PrivateEndpointConnectionPropertiesResponse: The properties of a private endpoint connection
type str: The resource type.
system_data SystemDataResponse: Metadata pertaining to creation and last modification of the resource.

id String: The resource identifier.
name String: The resource name.
properties Property Map: The properties of a private endpoint connection
type String: The resource type.
systemData Property Map: Metadata pertaining to creation and last modification of the resource.

PrivateEndpointResponse

Id string: The resource identifier.

Id string: The resource identifier.

id String: The resource identifier.

id string: The resource identifier.

id str: The resource identifier.

id String: The resource identifier.

PrivateLinkServiceConnectionStateResponse

Description string: The description for the current state of a private endpoint connection
Status string: The status of a private endpoint connection
ActionsRequired string: Actions required for a private endpoint connection

Description string: The description for the current state of a private endpoint connection
Status string: The status of a private endpoint connection
ActionsRequired string: Actions required for a private endpoint connection

description String: The description for the current state of a private endpoint connection
status String: The status of a private endpoint connection
actionsRequired String: Actions required for a private endpoint connection

description string: The description for the current state of a private endpoint connection
status string: The status of a private endpoint connection
actionsRequired string: Actions required for a private endpoint connection

description str: The description for the current state of a private endpoint connection
status str: The status of a private endpoint connection
actions_required str: Actions required for a private endpoint connection

description String: The description for the current state of a private endpoint connection
status String: The status of a private endpoint connection
actionsRequired String: Actions required for a private endpoint connection

SharedAccessSignatureAuthorizationRuleAccessRightsDescriptionResponse

KeyName string: Name of the key.
Rights string: Rights that this key has.
PrimaryKey string: Primary SAS key value.
SecondaryKey string: Secondary SAS key value.

KeyName string: Name of the key.
Rights string: Rights that this key has.
PrimaryKey string: Primary SAS key value.
SecondaryKey string: Secondary SAS key value.

keyName String: Name of the key.
rights String: Rights that this key has.
primaryKey String: Primary SAS key value.
secondaryKey String: Secondary SAS key value.

keyName string: Name of the key.
rights string: Rights that this key has.
primaryKey string: Primary SAS key value.
secondaryKey string: Secondary SAS key value.

key_name str: Name of the key.
rights str: Rights that this key has.
primary_key str: Primary SAS key value.
secondary_key str: Secondary SAS key value.

keyName String: Name of the key.
rights String: Rights that this key has.
primaryKey String: Primary SAS key value.
secondaryKey String: Secondary SAS key value.

SystemDataResponse

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: The type of identity that created the resource.
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string: The type of identity that last modified the resource.

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: The type of identity that created the resource.
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string: The type of identity that last modified the resource.

createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: The type of identity that created the resource.
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String: The type of identity that last modified the resource.

createdAt string: The timestamp of resource creation (UTC).
createdBy string: The identity that created the resource.
createdByType string: The type of identity that created the resource.
lastModifiedAt string: The timestamp of resource last modification (UTC)
lastModifiedBy string: The identity that last modified the resource.
lastModifiedByType string: The type of identity that last modified the resource.

created_at str: The timestamp of resource creation (UTC).
created_by str: The identity that created the resource.
created_by_type str: The type of identity that created the resource.
last_modified_at str: The timestamp of resource last modification (UTC)
last_modified_by str: The identity that last modified the resource.
last_modified_by_type str: The type of identity that last modified the resource.

createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: The type of identity that created the resource.
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String: The type of identity that last modified the resource.

TargetIpFilterRuleResponse

Action string: The desired action for requests captured by this rule.
FilterName string: The name of the IP filter rule.
IpMask string: A string that contains the IP address range in CIDR notation for the rule.
Target string: Target for requests captured by this rule.

Action string: The desired action for requests captured by this rule.
FilterName string: The name of the IP filter rule.
IpMask string: A string that contains the IP address range in CIDR notation for the rule.
Target string: Target for requests captured by this rule.

action String: The desired action for requests captured by this rule.
filterName String: The name of the IP filter rule.
ipMask String: A string that contains the IP address range in CIDR notation for the rule.
target String: Target for requests captured by this rule.

action string: The desired action for requests captured by this rule.
filterName string: The name of the IP filter rule.
ipMask string: A string that contains the IP address range in CIDR notation for the rule.
target string: Target for requests captured by this rule.

action str: The desired action for requests captured by this rule.
filter_name str: The name of the IP filter rule.
ip_mask str: A string that contains the IP address range in CIDR notation for the rule.
target str: Target for requests captured by this rule.

action String: The desired action for requests captured by this rule.
filterName String: The name of the IP filter rule.
ipMask String: A string that contains the IP address range in CIDR notation for the rule.
target String: Target for requests captured by this rule.

Package Details

Repository: azure-native-v2 pulumi/pulumi-azure-native
License: Apache-2.0

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.

Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

pulumi/pulumi-azure-native

azure-native-v2.devices.getIotDpsResource

On this page

On this page

Using getIotDpsResource

getIotDpsResource Result

Supporting Types

IotDpsPropertiesDescriptionResponse

IotDpsSkuInfoResponse

IotHubDefinitionDescriptionResponse

PrivateEndpointConnectionPropertiesResponse

PrivateEndpointConnectionResponse

PrivateEndpointResponse

PrivateLinkServiceConnectionStateResponse

SharedAccessSignatureAuthorizationRuleAccessRightsDescriptionResponse

SystemDataResponse

TargetIpFilterRuleResponse

Package Details

On this page

On this page