azure-native.documentdb.listDatabaseAccountKeys
Explore with Pulumi AI
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, 2024-05-15, 2024-05-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 dictionaryThe following arguments are supported:
- Account
Name string - Cosmos DB database account name.
 - Resource
Group stringName  - The name of the resource group. The name is case insensitive.
 
- Account
Name string - Cosmos DB database account name.
 - Resource
Group stringName  - The name of the resource group. The name is case insensitive.
 
- account
Name String - Cosmos DB database account name.
 - resource
Group StringName  - The name of the resource group. The name is case insensitive.
 
- account
Name string - Cosmos DB database account name.
 - resource
Group stringName  - The name of the resource group. The name is case insensitive.
 
- account_
name str - Cosmos DB database account name.
 - resource_
group_ strname  - The name of the resource group. The name is case insensitive.
 
- account
Name String - Cosmos DB database account name.
 - resource
Group StringName  - The name of the resource group. The name is case insensitive.
 
listDatabaseAccountKeys Result
The following output properties are available:
- Primary
Master stringKey  - Base 64 encoded value of the primary read-write key.
 - Primary
Readonly stringMaster Key  - Base 64 encoded value of the primary read-only key.
 - Secondary
Master stringKey  - Base 64 encoded value of the secondary read-write key.
 - Secondary
Readonly stringMaster Key  - Base 64 encoded value of the secondary read-only key.
 
- Primary
Master stringKey  - Base 64 encoded value of the primary read-write key.
 - Primary
Readonly stringMaster Key  - Base 64 encoded value of the primary read-only key.
 - Secondary
Master stringKey  - Base 64 encoded value of the secondary read-write key.
 - Secondary
Readonly stringMaster Key  - Base 64 encoded value of the secondary read-only key.
 
- primary
Master StringKey  - Base 64 encoded value of the primary read-write key.
 - primary
Readonly StringMaster Key  - Base 64 encoded value of the primary read-only key.
 - secondary
Master StringKey  - Base 64 encoded value of the secondary read-write key.
 - secondary
Readonly StringMaster Key  - Base 64 encoded value of the secondary read-only key.
 
- primary
Master stringKey  - Base 64 encoded value of the primary read-write key.
 - primary
Readonly stringMaster Key  - Base 64 encoded value of the primary read-only key.
 - secondary
Master stringKey  - Base 64 encoded value of the secondary read-write key.
 - secondary
Readonly stringMaster Key  - Base 64 encoded value of the secondary read-only key.
 
- primary_
master_ strkey  - Base 64 encoded value of the primary read-write key.
 - primary_
readonly_ strmaster_ key  - Base 64 encoded value of the primary read-only key.
 - secondary_
master_ strkey  - Base 64 encoded value of the secondary read-write key.
 - secondary_
readonly_ strmaster_ key  - Base 64 encoded value of the secondary read-only key.
 
- primary
Master StringKey  - Base 64 encoded value of the primary read-write key.
 - primary
Readonly StringMaster Key  - Base 64 encoded value of the primary read-only key.
 - secondary
Master StringKey  - Base 64 encoded value of the secondary read-write key.
 - secondary
Readonly StringMaster Key  - Base 64 encoded value of the secondary read-only key.
 
Package Details
- Repository
 - Azure Native pulumi/pulumi-azure-native
 - License
 - Apache-2.0