1. Packages
  2. Azure Native v2
  3. API Docs
  4. documentdb
  5. listDatabaseAccountKeys
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native-v2.documentdb.listDatabaseAccountKeys

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

Lists the access keys for the specified Azure Cosmos DB database account. Azure REST API version: 2023-04-15.

Other available API versions: 2021-04-01-preview, 2023-03-15-preview, 2023-09-15, 2023-09-15-preview, 2023-11-15, 2023-11-15-preview, 2024-02-15-preview, 2024-05-15, 2024-05-15-preview, 2024-08-15, 2024-09-01-preview, 2024-11-15, 2024-12-01-preview.

Using listDatabaseAccountKeys

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 listDatabaseAccountKeys(args: ListDatabaseAccountKeysArgs, opts?: InvokeOptions): Promise<ListDatabaseAccountKeysResult>
function listDatabaseAccountKeysOutput(args: ListDatabaseAccountKeysOutputArgs, opts?: InvokeOptions): Output<ListDatabaseAccountKeysResult>
Copy
def list_database_account_keys(account_name: Optional[str] = None,
                               resource_group_name: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> ListDatabaseAccountKeysResult
def list_database_account_keys_output(account_name: Optional[pulumi.Input[str]] = None,
                               resource_group_name: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[ListDatabaseAccountKeysResult]
Copy
func ListDatabaseAccountKeys(ctx *Context, args *ListDatabaseAccountKeysArgs, opts ...InvokeOption) (*ListDatabaseAccountKeysResult, error)
func ListDatabaseAccountKeysOutput(ctx *Context, args *ListDatabaseAccountKeysOutputArgs, opts ...InvokeOption) ListDatabaseAccountKeysResultOutput
Copy

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

public static class ListDatabaseAccountKeys 
{
    public static Task<ListDatabaseAccountKeysResult> InvokeAsync(ListDatabaseAccountKeysArgs args, InvokeOptions? opts = null)
    public static Output<ListDatabaseAccountKeysResult> Invoke(ListDatabaseAccountKeysInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<ListDatabaseAccountKeysResult> listDatabaseAccountKeys(ListDatabaseAccountKeysArgs args, InvokeOptions options)
public static Output<ListDatabaseAccountKeysResult> listDatabaseAccountKeys(ListDatabaseAccountKeysArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:documentdb:listDatabaseAccountKeys
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AccountName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database account name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
AccountName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database account name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
accountName
This property is required.
Changes to this property will trigger replacement.
String
Cosmos DB database account name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
accountName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database account name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
account_name
This property is required.
Changes to this property will trigger replacement.
str
Cosmos DB database account name.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
accountName
This property is required.
Changes to this property will trigger replacement.
String
Cosmos DB database account name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

listDatabaseAccountKeys Result

The following output properties are available:

PrimaryMasterKey string
Base 64 encoded value of the primary read-write key.
PrimaryReadonlyMasterKey string
Base 64 encoded value of the primary read-only key.
SecondaryMasterKey string
Base 64 encoded value of the secondary read-write key.
SecondaryReadonlyMasterKey string
Base 64 encoded value of the secondary read-only key.
PrimaryMasterKey string
Base 64 encoded value of the primary read-write key.
PrimaryReadonlyMasterKey string
Base 64 encoded value of the primary read-only key.
SecondaryMasterKey string
Base 64 encoded value of the secondary read-write key.
SecondaryReadonlyMasterKey string
Base 64 encoded value of the secondary read-only key.
primaryMasterKey String
Base 64 encoded value of the primary read-write key.
primaryReadonlyMasterKey String
Base 64 encoded value of the primary read-only key.
secondaryMasterKey String
Base 64 encoded value of the secondary read-write key.
secondaryReadonlyMasterKey String
Base 64 encoded value of the secondary read-only key.
primaryMasterKey string
Base 64 encoded value of the primary read-write key.
primaryReadonlyMasterKey string
Base 64 encoded value of the primary read-only key.
secondaryMasterKey string
Base 64 encoded value of the secondary read-write key.
secondaryReadonlyMasterKey string
Base 64 encoded value of the secondary read-only key.
primary_master_key str
Base 64 encoded value of the primary read-write key.
primary_readonly_master_key str
Base 64 encoded value of the primary read-only key.
secondary_master_key str
Base 64 encoded value of the secondary read-write key.
secondary_readonly_master_key str
Base 64 encoded value of the secondary read-only key.
primaryMasterKey String
Base 64 encoded value of the primary read-write key.
primaryReadonlyMasterKey String
Base 64 encoded value of the primary read-only key.
secondaryMasterKey String
Base 64 encoded value of the secondary read-write key.
secondaryReadonlyMasterKey String
Base 64 encoded value of the secondary read-only key.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi