Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. iothub
  5. listIotHubResourceKeys
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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.iothub.listIotHubResourceKeys

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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Get the security metadata for an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.

Uses Azure REST API version 2023-06-30.

Other available API versions: 2016-02-03, 2017-01-19, 2017-07-01, 2018-01-22, 2018-04-01, 2018-12-01-preview, 2019-03-22, 2019-03-22-preview, 2019-07-01-preview, 2019-11-04, 2020-03-01, 2020-04-01, 2020-06-15, 2020-07-10-preview, 2020-08-01, 2020-08-31, 2020-08-31-preview, 2021-02-01-preview, 2021-03-03-preview, 2021-03-31, 2021-07-01, 2021-07-01-preview, 2021-07-02, 2021-07-02-preview, 2022-04-30-preview, 2022-11-15-preview, 2023-06-30-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native iothub [ApiVersion]. See the version guide for details.

Using listIotHubResourceKeys

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 listIotHubResourceKeys(args: ListIotHubResourceKeysArgs, opts?: InvokeOptions): Promise<ListIotHubResourceKeysResult>
function listIotHubResourceKeysOutput(args: ListIotHubResourceKeysOutputArgs, opts?: InvokeOptions): Output<ListIotHubResourceKeysResult>
Copy
def list_iot_hub_resource_keys(resource_group_name: Optional[str] = None,
                               resource_name: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> ListIotHubResourceKeysResult
def list_iot_hub_resource_keys_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                               resource_name: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[ListIotHubResourceKeysResult]
Copy
func ListIotHubResourceKeys(ctx *Context, args *ListIotHubResourceKeysArgs, opts ...InvokeOption) (*ListIotHubResourceKeysResult, error)
func ListIotHubResourceKeysOutput(ctx *Context, args *ListIotHubResourceKeysOutputArgs, opts ...InvokeOption) ListIotHubResourceKeysResultOutput
Copy

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

public static class ListIotHubResourceKeys 
{
    public static Task<ListIotHubResourceKeysResult> InvokeAsync(ListIotHubResourceKeysArgs args, InvokeOptions? opts = null)
    public static Output<ListIotHubResourceKeysResult> Invoke(ListIotHubResourceKeysInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<ListIotHubResourceKeysResult> listIotHubResourceKeys(ListIotHubResourceKeysArgs args, InvokeOptions options)
public static Output<ListIotHubResourceKeysResult> listIotHubResourceKeys(ListIotHubResourceKeysArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:iothub:listIotHubResourceKeys
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the IoT hub.
ResourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the IoT hub.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the IoT hub.
ResourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the IoT hub.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the IoT hub.
resourceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the IoT hub.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the IoT hub.
resourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the IoT hub.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group that contains the IoT hub.
resource_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the IoT hub.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the IoT hub.
resourceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the IoT hub.

listIotHubResourceKeys Result

The following output properties are available:

NextLink string
The next link.
Value []SharedAccessSignatureAuthorizationRuleResponse
The list of shared access policies.
nextLink String
The next link.
value List<SharedAccessSignatureAuthorizationRuleResponse>
The list of shared access policies.
nextLink string
The next link.
value SharedAccessSignatureAuthorizationRuleResponse[]
The list of shared access policies.
next_link str
The next link.
value Sequence[SharedAccessSignatureAuthorizationRuleResponse]
The list of shared access policies.
nextLink String
The next link.
value List<Property Map>
The list of shared access policies.

Supporting Types

SharedAccessSignatureAuthorizationRuleResponse

KeyName This property is required. string
The name of the shared access policy.
Rights This property is required. string
The permissions assigned to the shared access policy.
PrimaryKey string
The primary key.
SecondaryKey string
The secondary key.
KeyName This property is required. string
The name of the shared access policy.
Rights This property is required. string
The permissions assigned to the shared access policy.
PrimaryKey string
The primary key.
SecondaryKey string
The secondary key.
keyName This property is required. String
The name of the shared access policy.
rights This property is required. String
The permissions assigned to the shared access policy.
primaryKey String
The primary key.
secondaryKey String
The secondary key.
keyName This property is required. string
The name of the shared access policy.
rights This property is required. string
The permissions assigned to the shared access policy.
primaryKey string
The primary key.
secondaryKey string
The secondary key.
key_name This property is required. str
The name of the shared access policy.
rights This property is required. str
The permissions assigned to the shared access policy.
primary_key str
The primary key.
secondary_key str
The secondary key.
keyName This property is required. String
The name of the shared access policy.
rights This property is required. String
The permissions assigned to the shared access policy.
primaryKey String
The primary key.
secondaryKey String
The secondary key.

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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native