1. Packages
  2. Azure Native
  3. API Docs
  4. deviceprovisioningservices
  5. listIotDpsResourceKeysForKeyName
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

azure-native.deviceprovisioningservices.listIotDpsResourceKeysForKeyName

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

List primary and secondary keys for a specific key name

Uses Azure REST API version 2023-03-01-preview.

Other available API versions: 2017-08-21-preview, 2017-11-15, 2018-01-22, 2020-01-01, 2020-03-01, 2020-09-01-preview, 2021-10-15, 2022-02-05, 2022-12-12, 2025-02-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native deviceprovisioningservices [ApiVersion]. See the version guide for details.

Using listIotDpsResourceKeysForKeyName

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 listIotDpsResourceKeysForKeyName(args: ListIotDpsResourceKeysForKeyNameArgs, opts?: InvokeOptions): Promise<ListIotDpsResourceKeysForKeyNameResult>
function listIotDpsResourceKeysForKeyNameOutput(args: ListIotDpsResourceKeysForKeyNameOutputArgs, opts?: InvokeOptions): Output<ListIotDpsResourceKeysForKeyNameResult>
Copy
def list_iot_dps_resource_keys_for_key_name(key_name: Optional[str] = None,
                                            provisioning_service_name: Optional[str] = None,
                                            resource_group_name: Optional[str] = None,
                                            opts: Optional[InvokeOptions] = None) -> ListIotDpsResourceKeysForKeyNameResult
def list_iot_dps_resource_keys_for_key_name_output(key_name: Optional[pulumi.Input[str]] = None,
                                            provisioning_service_name: Optional[pulumi.Input[str]] = None,
                                            resource_group_name: Optional[pulumi.Input[str]] = None,
                                            opts: Optional[InvokeOptions] = None) -> Output[ListIotDpsResourceKeysForKeyNameResult]
Copy
func ListIotDpsResourceKeysForKeyName(ctx *Context, args *ListIotDpsResourceKeysForKeyNameArgs, opts ...InvokeOption) (*ListIotDpsResourceKeysForKeyNameResult, error)
func ListIotDpsResourceKeysForKeyNameOutput(ctx *Context, args *ListIotDpsResourceKeysForKeyNameOutputArgs, opts ...InvokeOption) ListIotDpsResourceKeysForKeyNameResultOutput
Copy

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

public static class ListIotDpsResourceKeysForKeyName 
{
    public static Task<ListIotDpsResourceKeysForKeyNameResult> InvokeAsync(ListIotDpsResourceKeysForKeyNameArgs args, InvokeOptions? opts = null)
    public static Output<ListIotDpsResourceKeysForKeyNameResult> Invoke(ListIotDpsResourceKeysForKeyNameInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<ListIotDpsResourceKeysForKeyNameResult> listIotDpsResourceKeysForKeyName(ListIotDpsResourceKeysForKeyNameArgs args, InvokeOptions options)
public static Output<ListIotDpsResourceKeysForKeyNameResult> listIotDpsResourceKeysForKeyName(ListIotDpsResourceKeysForKeyNameArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:deviceprovisioningservices:listIotDpsResourceKeysForKeyName
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

KeyName
This property is required.
Changes to this property will trigger replacement.
string
Logical key name to get key-values for.
ProvisioningServiceName
This property is required.
Changes to this property will trigger replacement.
string
Name of the provisioning service.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the provisioning service.
KeyName
This property is required.
Changes to this property will trigger replacement.
string
Logical key name to get key-values for.
ProvisioningServiceName
This property is required.
Changes to this property will trigger replacement.
string
Name of the provisioning service.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the provisioning service.
keyName
This property is required.
Changes to this property will trigger replacement.
String
Logical key name to get key-values for.
provisioningServiceName
This property is required.
Changes to this property will trigger replacement.
String
Name of the provisioning service.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the provisioning service.
keyName
This property is required.
Changes to this property will trigger replacement.
string
Logical key name to get key-values for.
provisioningServiceName
This property is required.
Changes to this property will trigger replacement.
string
Name of the provisioning service.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the provisioning service.
key_name
This property is required.
Changes to this property will trigger replacement.
str
Logical key name to get key-values for.
provisioning_service_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the provisioning service.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group that contains the provisioning service.
keyName
This property is required.
Changes to this property will trigger replacement.
String
Logical key name to get key-values for.
provisioningServiceName
This property is required.
Changes to this property will trigger replacement.
String
Name of the provisioning service.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the provisioning service.

listIotDpsResourceKeysForKeyName Result

The following output properties are available:

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.

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 v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi