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.13.0 published on Wednesday, Jan 28, 2026 by Pulumi
azure-native logo
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.13.0 published on Wednesday, Jan 28, 2026 by Pulumi

    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>
    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]
    func ListBatchAccountKeys(ctx *Context, args *ListBatchAccountKeysArgs, opts ...InvokeOption) (*ListBatchAccountKeysResult, error)
    func ListBatchAccountKeysOutput(ctx *Context, args *ListBatchAccountKeysOutputArgs, opts ...InvokeOption) ListBatchAccountKeysResultOutput

    > 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)
    }
    public static CompletableFuture<ListBatchAccountKeysResult> listBatchAccountKeys(ListBatchAccountKeysArgs args, InvokeOptions options)
    public static Output<ListBatchAccountKeysResult> listBatchAccountKeys(ListBatchAccountKeysArgs args, InvokeOptions options)
    
    fn::invoke:
      function: azure-native:batch:listBatchAccountKeys
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AccountName string
    A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    AccountName string
    A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    accountName String
    A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    accountName string
    A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    account_name str
    A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    accountName String
    A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    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
    azure-native logo
    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.13.0 published on Wednesday, Jan 28, 2026 by Pulumi
      Meet Neo: Your AI Platform Teammate