Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. batch
  5. listBatchAccountKeys
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.batch.listBatchAccountKeys

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

This operation applies only to Batch accounts with allowedAuthenticationModes containing ‘SharedKey’. If the Batch account doesn’t contain ‘SharedKey’ in its allowedAuthenticationMode, clients cannot use shared keys to authenticate, and must use another allowedAuthenticationModes instead. In this case, getting the keys will fail.

Uses Azure REST API version 2024-07-01.

Other available API versions: 2023-05-01, 2023-11-01, 2024-02-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native batch [ApiVersion]. See the version guide for details.

Using listBatchAccountKeys

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 listBatchAccountKeys(args: ListBatchAccountKeysArgs, opts?: InvokeOptions): Promise<ListBatchAccountKeysResult>
function listBatchAccountKeysOutput(args: ListBatchAccountKeysOutputArgs, opts?: InvokeOptions): Output<ListBatchAccountKeysResult>
Copy
def list_batch_account_keys(account_name: Optional[str] = None,
                            resource_group_name: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> ListBatchAccountKeysResult
def list_batch_account_keys_output(account_name: Optional[pulumi.Input[str]] = None,
                            resource_group_name: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[ListBatchAccountKeysResult]
Copy
func ListBatchAccountKeys(ctx *Context, args *ListBatchAccountKeysArgs, opts ...InvokeOption) (*ListBatchAccountKeysResult, error)
func ListBatchAccountKeysOutput(ctx *Context, args *ListBatchAccountKeysOutputArgs, opts ...InvokeOption) ListBatchAccountKeysResultOutput
Copy

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

public static class ListBatchAccountKeys 
{
    public static Task<ListBatchAccountKeysResult> InvokeAsync(ListBatchAccountKeysArgs args, InvokeOptions? opts = null)
    public static Output<ListBatchAccountKeysResult> Invoke(ListBatchAccountKeysInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<ListBatchAccountKeysResult> listBatchAccountKeys(ListBatchAccountKeysArgs args, InvokeOptions options)
public static Output<ListBatchAccountKeysResult> listBatchAccountKeys(ListBatchAccountKeysArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:batch:listBatchAccountKeys
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AccountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Batch account.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the Batch account.
AccountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Batch account.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the Batch account.
accountName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Batch account.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the Batch account.
accountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Batch account.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the Batch account.
account_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Batch account.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group that contains the Batch account.
accountName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Batch account.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the Batch account.

listBatchAccountKeys Result

The following output properties are available:

AccountName string
The Batch account name.
Primary string
The primary key associated with the account.
Secondary string
The secondary key associated with the account.
AccountName string
The Batch account name.
Primary string
The primary key associated with the account.
Secondary string
The secondary key associated with the account.
accountName String
The Batch account name.
primary String
The primary key associated with the account.
secondary String
The secondary key associated with the account.
accountName string
The Batch account name.
primary string
The primary key associated with the account.
secondary string
The secondary key associated with the account.
account_name str
The Batch account name.
primary str
The primary key associated with the account.
secondary str
The secondary key associated with the account.
accountName String
The Batch account name.
primary String
The primary key associated with the account.
secondary String
The secondary key associated with the account.

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