1. Packages
  2. Azure Native
  3. API Docs
  4. documentdb
  5. listDatabaseAccountKeys
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.33.0 published on Friday, Mar 22, 2024 by Pulumi

azure-native.documentdb.listDatabaseAccountKeys

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.33.0 published on Friday, Mar 22, 2024 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: 2020-03-01, 2020-06-01-preview, 2020-09-01, 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.

    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>
    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]
    func ListDatabaseAccountKeys(ctx *Context, args *ListDatabaseAccountKeysArgs, opts ...InvokeOption) (*ListDatabaseAccountKeysResult, error)
    func ListDatabaseAccountKeysOutput(ctx *Context, args *ListDatabaseAccountKeysOutputArgs, opts ...InvokeOption) ListDatabaseAccountKeysResultOutput

    > 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)
    }
    public static CompletableFuture<ListDatabaseAccountKeysResult> listDatabaseAccountKeys(ListDatabaseAccountKeysArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:documentdb:listDatabaseAccountKeys
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AccountName string
    Cosmos DB database account name.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    AccountName string
    Cosmos DB database account name.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    accountName String
    Cosmos DB database account name.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    accountName string
    Cosmos DB database account name.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    account_name str
    Cosmos DB database account name.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    accountName String
    Cosmos DB database account name.
    resourceGroupName 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 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.33.0 published on Friday, Mar 22, 2024 by Pulumi