Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. devices
  5. getIotDpsResource
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.devices.getIotDpsResource

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

    Get the metadata of the provisioning service without SAS keys. API Version: 2020-03-01.

    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:

    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.
    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.
    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.
    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.
    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.
    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.
    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.
    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.
    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.
    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.
    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.
    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.
    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.
    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.
    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.
    IotHubs []IotHubDefinitionDescriptionResponse
    List of IoT hubs associated with this provisioning service.
    IpFilterRules []TargetIpFilterRuleResponse
    The IP filter rules.
    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.
    iotHubs List<IotHubDefinitionDescriptionResponse>
    List of IoT hubs associated with this provisioning service.
    ipFilterRules List<TargetIpFilterRuleResponse>
    The IP filter rules.
    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.
    iotHubs IotHubDefinitionDescriptionResponse[]
    List of IoT hubs associated with this provisioning service.
    ipFilterRules TargetIpFilterRuleResponse[]
    The IP filter rules.
    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.
    iot_hubs Sequence[IotHubDefinitionDescriptionResponse]
    List of IoT hubs associated with this provisioning service.
    ip_filter_rules Sequence[TargetIpFilterRuleResponse]
    The IP filter rules.
    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.
    iotHubs List<Property Map>
    List of IoT hubs associated with this provisioning service.
    ipFilterRules List<Property Map>
    The IP filter rules.
    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 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.
    Id string
    The resource identifier.
    Name string
    The resource name.
    Properties PrivateEndpointConnectionPropertiesResponse
    The properties of a private endpoint connection
    Type string
    The resource type.
    id String
    The resource identifier.
    name String
    The resource name.
    properties PrivateEndpointConnectionPropertiesResponse
    The properties of a private endpoint connection
    type String
    The resource type.
    id string
    The resource identifier.
    name string
    The resource name.
    properties PrivateEndpointConnectionPropertiesResponse
    The properties of a private endpoint connection
    type string
    The resource type.
    id str
    The resource identifier.
    name str
    The resource name.
    properties PrivateEndpointConnectionPropertiesResponse
    The properties of a private endpoint connection
    type str
    The resource type.
    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.

    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.

    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-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
    pulumi/pulumi-azure-native