This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
azure-native.devices.getIotDpsResource
Explore with Pulumi AI
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
Get the metadata of the provisioning service without SAS keys. Azure REST API version: 2022-12-12.
Other available API versions: 2020-09-01-preview, 2023-03-01-preview, 2025-02-01-preview.
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.
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)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:devices:getIotDpsResource
arguments:
# arguments dictionary
The following arguments are supported:
- Provisioning
Service stringName - Name of the provisioning service to retrieve.
- Resource
Group stringName - Resource group name.
- Provisioning
Service stringName - Name of the provisioning service to retrieve.
- Resource
Group stringName - Resource group name.
- provisioning
Service StringName - Name of the provisioning service to retrieve.
- resource
Group StringName - Resource group name.
- provisioning
Service stringName - Name of the provisioning service to retrieve.
- resource
Group stringName - Resource group name.
- provisioning_
service_ strname - Name of the provisioning service to retrieve.
- resource_
group_ strname - Resource group name.
- provisioning
Service StringName - Name of the provisioning service to retrieve.
- resource
Group StringName - 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.
Azure Native. Devices. Outputs. Iot Dps Properties Description Response - Service specific properties for a provisioning service
- Sku
Pulumi.
Azure Native. Devices. Outputs. Iot Dps Sku Info Response - Sku info for a provisioning Service.
- System
Data Pulumi.Azure Native. Devices. Outputs. System Data Response - 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.
- Dictionary<string, string>
- The resource tags.
- Id string
- The resource identifier.
- Location string
- The resource location.
- Name string
- The resource name.
- Properties
Iot
Dps Properties Description Response - Service specific properties for a provisioning service
- Sku
Iot
Dps Sku Info Response - Sku info for a provisioning Service.
- System
Data SystemData Response - 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.
- map[string]string
- The resource tags.
- id String
- The resource identifier.
- location String
- The resource location.
- name String
- The resource name.
- properties
Iot
Dps Properties Description Response - Service specific properties for a provisioning service
- sku
Iot
Dps Sku Info Response - Sku info for a provisioning Service.
- system
Data SystemData Response - 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.
- Map<String,String>
- The resource tags.
- id string
- The resource identifier.
- location string
- The resource location.
- name string
- The resource name.
- properties
Iot
Dps Properties Description Response - Service specific properties for a provisioning service
- sku
Iot
Dps Sku Info Response - Sku info for a provisioning Service.
- system
Data SystemData Response - 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.
- {[key: string]: string}
- The resource tags.
- id str
- The resource identifier.
- location str
- The resource location.
- name str
- The resource name.
- properties
Iot
Dps Properties Description Response - Service specific properties for a provisioning service
- sku
Iot
Dps Sku Info Response - Sku info for a provisioning Service.
- system_
data SystemData Response - 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.
- 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.
- system
Data 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.
- Map<String>
- The resource tags.
Supporting Types
IotDpsPropertiesDescriptionResponse
- Device
Provisioning stringHost Name - Device endpoint for this provisioning service.
- Id
Scope string - Unique identifier of this provisioning service.
- Service
Operations stringHost Name - Service endpoint for provisioning service.
- Allocation
Policy string - Allocation policy to be used by this provisioning service.
- List<Pulumi.
Azure Native. Devices. Inputs. Shared Access Signature Authorization Rule Access Rights Description Response> - List of authorization keys for a provisioning service.
- Enable
Data boolResidency - Optional. Indicates if the DPS instance has Data Residency enabled, removing the cross geo-pair disaster recovery.
- Iot
Hubs List<Pulumi.Azure Native. Devices. Inputs. Iot Hub Definition Description Response> - List of IoT hubs associated with this provisioning service.
- Ip
Filter List<Pulumi.Rules Azure Native. Devices. Inputs. Target Ip Filter Rule Response> - The IP filter rules.
- Portal
Operations stringHost Name - Portal endpoint to enable CORS for this provisioning service.
- Private
Endpoint List<Pulumi.Connections Azure Native. Devices. Inputs. Private Endpoint Connection Response> - Private endpoint connections created on this IotHub
- Provisioning
State string - The ARM provisioning state of the provisioning service.
- Public
Network stringAccess - Whether requests from Public Network are allowed
- State string
- Current state of the provisioning service.
- Device
Provisioning stringHost Name - Device endpoint for this provisioning service.
- Id
Scope string - Unique identifier of this provisioning service.
- Service
Operations stringHost Name - Service endpoint for provisioning service.
- Allocation
Policy string - Allocation policy to be used by this provisioning service.
- []Shared
Access Signature Authorization Rule Access Rights Description Response - List of authorization keys for a provisioning service.
- Enable
Data boolResidency - Optional. Indicates if the DPS instance has Data Residency enabled, removing the cross geo-pair disaster recovery.
- Iot
Hubs []IotHub Definition Description Response - List of IoT hubs associated with this provisioning service.
- Ip
Filter []TargetRules Ip Filter Rule Response - The IP filter rules.
- Portal
Operations stringHost Name - Portal endpoint to enable CORS for this provisioning service.
- Private
Endpoint []PrivateConnections Endpoint Connection Response - Private endpoint connections created on this IotHub
- Provisioning
State string - The ARM provisioning state of the provisioning service.
- Public
Network stringAccess - Whether requests from Public Network are allowed
- State string
- Current state of the provisioning service.
- device
Provisioning StringHost Name - Device endpoint for this provisioning service.
- id
Scope String - Unique identifier of this provisioning service.
- service
Operations StringHost Name - Service endpoint for provisioning service.
- allocation
Policy String - Allocation policy to be used by this provisioning service.
- List<Shared
Access Signature Authorization Rule Access Rights Description Response> - List of authorization keys for a provisioning service.
- enable
Data BooleanResidency - Optional. Indicates if the DPS instance has Data Residency enabled, removing the cross geo-pair disaster recovery.
- iot
Hubs List<IotHub Definition Description Response> - List of IoT hubs associated with this provisioning service.
- ip
Filter List<TargetRules Ip Filter Rule Response> - The IP filter rules.
- portal
Operations StringHost Name - Portal endpoint to enable CORS for this provisioning service.
- private
Endpoint List<PrivateConnections Endpoint Connection Response> - Private endpoint connections created on this IotHub
- provisioning
State String - The ARM provisioning state of the provisioning service.
- public
Network StringAccess - Whether requests from Public Network are allowed
- state String
- Current state of the provisioning service.
- device
Provisioning stringHost Name - Device endpoint for this provisioning service.
- id
Scope string - Unique identifier of this provisioning service.
- service
Operations stringHost Name - Service endpoint for provisioning service.
- allocation
Policy string - Allocation policy to be used by this provisioning service.
- Shared
Access Signature Authorization Rule Access Rights Description Response[] - List of authorization keys for a provisioning service.
- enable
Data booleanResidency - Optional. Indicates if the DPS instance has Data Residency enabled, removing the cross geo-pair disaster recovery.
- iot
Hubs IotHub Definition Description Response[] - List of IoT hubs associated with this provisioning service.
- ip
Filter TargetRules Ip Filter Rule Response[] - The IP filter rules.
- portal
Operations stringHost Name - Portal endpoint to enable CORS for this provisioning service.
- private
Endpoint PrivateConnections Endpoint Connection Response[] - Private endpoint connections created on this IotHub
- provisioning
State string - The ARM provisioning state of the provisioning service.
- public
Network stringAccess - Whether requests from Public Network are allowed
- state string
- Current state of the provisioning service.
- device_
provisioning_ strhost_ name - Device endpoint for this provisioning service.
- id_
scope str - Unique identifier of this provisioning service.
- service_
operations_ strhost_ name - Service endpoint for provisioning service.
- allocation_
policy str - Allocation policy to be used by this provisioning service.
- Sequence[Shared
Access Signature Authorization Rule Access Rights Description Response] - List of authorization keys for a provisioning service.
- enable_
data_ boolresidency - Optional. Indicates if the DPS instance has Data Residency enabled, removing the cross geo-pair disaster recovery.
- iot_
hubs Sequence[IotHub Definition Description Response] - List of IoT hubs associated with this provisioning service.
- ip_
filter_ Sequence[Targetrules Ip Filter Rule Response] - The IP filter rules.
- portal_
operations_ strhost_ name - Portal endpoint to enable CORS for this provisioning service.
- private_
endpoint_ Sequence[Privateconnections Endpoint Connection Response] - Private endpoint connections created on this IotHub
- provisioning_
state str - The ARM provisioning state of the provisioning service.
- public_
network_ straccess - Whether requests from Public Network are allowed
- state str
- Current state of the provisioning service.
- device
Provisioning StringHost Name - Device endpoint for this provisioning service.
- id
Scope String - Unique identifier of this provisioning service.
- service
Operations StringHost Name - Service endpoint for provisioning service.
- allocation
Policy String - Allocation policy to be used by this provisioning service.
- List<Property Map>
- List of authorization keys for a provisioning service.
- enable
Data BooleanResidency - Optional. Indicates if the DPS instance has Data Residency enabled, removing the cross geo-pair disaster recovery.
- iot
Hubs List<Property Map> - List of IoT hubs associated with this provisioning service.
- ip
Filter List<Property Map>Rules - The IP filter rules.
- portal
Operations StringHost Name - Portal endpoint to enable CORS for this provisioning service.
- private
Endpoint List<Property Map>Connections - Private endpoint connections created on this IotHub
- provisioning
State String - The ARM provisioning state of the provisioning service.
- public
Network StringAccess - Whether requests from Public Network are allowed
- state String
- Current state of the provisioning service.
IotDpsSkuInfoResponse
IotHubDefinitionDescriptionResponse
- Connection
String string - Connection string of the IoT hub.
- Location string
- ARM region of the IoT hub.
- Name string
- Host name of the IoT hub.
- Allocation
Weight int - weight to apply for a given iot h.
- Apply
Allocation boolPolicy - flag for applying allocationPolicy or not for a given iot hub.
- Connection
String string - Connection string of the IoT hub.
- Location string
- ARM region of the IoT hub.
- Name string
- Host name of the IoT hub.
- Allocation
Weight int - weight to apply for a given iot h.
- Apply
Allocation boolPolicy - flag for applying allocationPolicy or not for a given iot hub.
- connection
String String - Connection string of the IoT hub.
- location String
- ARM region of the IoT hub.
- name String
- Host name of the IoT hub.
- allocation
Weight Integer - weight to apply for a given iot h.
- apply
Allocation BooleanPolicy - flag for applying allocationPolicy or not for a given iot hub.
- connection
String string - Connection string of the IoT hub.
- location string
- ARM region of the IoT hub.
- name string
- Host name of the IoT hub.
- allocation
Weight number - weight to apply for a given iot h.
- apply
Allocation booleanPolicy - 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_ boolpolicy - flag for applying allocationPolicy or not for a given iot hub.
- connection
String String - Connection string of the IoT hub.
- location String
- ARM region of the IoT hub.
- name String
- Host name of the IoT hub.
- allocation
Weight Number - weight to apply for a given iot h.
- apply
Allocation BooleanPolicy - flag for applying allocationPolicy or not for a given iot hub.
PrivateEndpointConnectionPropertiesResponse
- Private
Link Pulumi.Service Connection State Azure Native. Devices. Inputs. Private Link Service Connection State Response - The current state of a private endpoint connection
- Private
Endpoint Pulumi.Azure Native. Devices. Inputs. Private Endpoint Response - The private endpoint property of a private endpoint connection
- Private
Link PrivateService Connection State Link Service Connection State Response - The current state of a private endpoint connection
- Private
Endpoint PrivateEndpoint Response - The private endpoint property of a private endpoint connection
- private
Link PrivateService Connection State Link Service Connection State Response - The current state of a private endpoint connection
- private
Endpoint PrivateEndpoint Response - The private endpoint property of a private endpoint connection
- private
Link PrivateService Connection State Link Service Connection State Response - The current state of a private endpoint connection
- private
Endpoint PrivateEndpoint Response - The private endpoint property of a private endpoint connection
- private_
link_ Privateservice_ connection_ state Link Service Connection State Response - The current state of a private endpoint connection
- private_
endpoint PrivateEndpoint Response - The private endpoint property of a private endpoint connection
- private
Link Property MapService Connection State - The current state of a private endpoint connection
- private
Endpoint Property Map - The private endpoint property of a private endpoint connection
PrivateEndpointConnectionResponse
- Id string
- The resource identifier.
- Name string
- The resource name.
- Properties
Pulumi.
Azure Native. Devices. Inputs. Private Endpoint Connection Properties Response - The properties of a private endpoint connection
- Type string
- The resource type.
- System
Data Pulumi.Azure Native. Devices. Inputs. System Data Response - Metadata pertaining to creation and last modification of the resource.
- Id string
- The resource identifier.
- Name string
- The resource name.
- Properties
Private
Endpoint Connection Properties Response - The properties of a private endpoint connection
- Type string
- The resource type.
- System
Data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- id String
- The resource identifier.
- name String
- The resource name.
- properties
Private
Endpoint Connection Properties Response - The properties of a private endpoint connection
- type String
- The resource type.
- system
Data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- id string
- The resource identifier.
- name string
- The resource name.
- properties
Private
Endpoint Connection Properties Response - The properties of a private endpoint connection
- type string
- The resource type.
- system
Data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- id str
- The resource identifier.
- name str
- The resource name.
- properties
Private
Endpoint Connection Properties Response - The properties of a private endpoint connection
- type str
- The resource type.
- system_
data SystemData Response - 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.
- system
Data 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
- Actions
Required 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
- Actions
Required 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
- actions
Required 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
- actions
Required 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
- actions
Required String - Actions required for a private endpoint connection
SharedAccessSignatureAuthorizationRuleAccessRightsDescriptionResponse
- Key
Name string - Name of the key.
- Rights string
- Rights that this key has.
- Primary
Key string - Primary SAS key value.
- Secondary
Key string - Secondary SAS key value.
- Key
Name string - Name of the key.
- Rights string
- Rights that this key has.
- Primary
Key string - Primary SAS key value.
- Secondary
Key string - Secondary SAS key value.
- key
Name String - Name of the key.
- rights String
- Rights that this key has.
- primary
Key String - Primary SAS key value.
- secondary
Key String - Secondary SAS key value.
- key
Name string - Name of the key.
- rights string
- Rights that this key has.
- primary
Key string - Primary SAS key value.
- secondary
Key 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.
- key
Name String - Name of the key.
- rights String
- Rights that this key has.
- primary
Key String - Primary SAS key value.
- secondary
Key String - Secondary SAS key value.
SystemDataResponse
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
TargetIpFilterRuleResponse
- Action string
- The desired action for requests captured by this rule.
- Filter
Name string - The name of the IP filter rule.
- Ip
Mask 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.
- Filter
Name string - The name of the IP filter rule.
- Ip
Mask 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.
- filter
Name String - The name of the IP filter rule.
- ip
Mask 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.
- filter
Name string - The name of the IP filter rule.
- ip
Mask 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.
- filter
Name String - The name of the IP filter rule.
- ip
Mask 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 pulumi/pulumi-azure-native
- License
- Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi