1. Packages
  2. Azure Native
  3. API Docs
  4. documentdb
  5. listDatabaseAccountConnectionStrings
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.41.0 published on Tuesday, May 14, 2024 by Pulumi

azure-native.documentdb.listDatabaseAccountConnectionStrings

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.41.0 published on Tuesday, May 14, 2024 by Pulumi

    Lists the connection strings 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 listDatabaseAccountConnectionStrings

    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 listDatabaseAccountConnectionStrings(args: ListDatabaseAccountConnectionStringsArgs, opts?: InvokeOptions): Promise<ListDatabaseAccountConnectionStringsResult>
    function listDatabaseAccountConnectionStringsOutput(args: ListDatabaseAccountConnectionStringsOutputArgs, opts?: InvokeOptions): Output<ListDatabaseAccountConnectionStringsResult>
    def list_database_account_connection_strings(account_name: Optional[str] = None,
                                                 resource_group_name: Optional[str] = None,
                                                 opts: Optional[InvokeOptions] = None) -> ListDatabaseAccountConnectionStringsResult
    def list_database_account_connection_strings_output(account_name: Optional[pulumi.Input[str]] = None,
                                                 resource_group_name: Optional[pulumi.Input[str]] = None,
                                                 opts: Optional[InvokeOptions] = None) -> Output[ListDatabaseAccountConnectionStringsResult]
    func ListDatabaseAccountConnectionStrings(ctx *Context, args *ListDatabaseAccountConnectionStringsArgs, opts ...InvokeOption) (*ListDatabaseAccountConnectionStringsResult, error)
    func ListDatabaseAccountConnectionStringsOutput(ctx *Context, args *ListDatabaseAccountConnectionStringsOutputArgs, opts ...InvokeOption) ListDatabaseAccountConnectionStringsResultOutput

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

    public static class ListDatabaseAccountConnectionStrings 
    {
        public static Task<ListDatabaseAccountConnectionStringsResult> InvokeAsync(ListDatabaseAccountConnectionStringsArgs args, InvokeOptions? opts = null)
        public static Output<ListDatabaseAccountConnectionStringsResult> Invoke(ListDatabaseAccountConnectionStringsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<ListDatabaseAccountConnectionStringsResult> listDatabaseAccountConnectionStrings(ListDatabaseAccountConnectionStringsArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:documentdb:listDatabaseAccountConnectionStrings
      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.

    listDatabaseAccountConnectionStrings Result

    The following output properties are available:

    ConnectionStrings List<Pulumi.AzureNative.DocumentDB.Outputs.DatabaseAccountConnectionStringResponse>
    An array that contains the connection strings for the Cosmos DB account.
    ConnectionStrings []DatabaseAccountConnectionStringResponse
    An array that contains the connection strings for the Cosmos DB account.
    connectionStrings List<DatabaseAccountConnectionStringResponse>
    An array that contains the connection strings for the Cosmos DB account.
    connectionStrings DatabaseAccountConnectionStringResponse[]
    An array that contains the connection strings for the Cosmos DB account.
    connection_strings Sequence[DatabaseAccountConnectionStringResponse]
    An array that contains the connection strings for the Cosmos DB account.
    connectionStrings List<Property Map>
    An array that contains the connection strings for the Cosmos DB account.

    Supporting Types

    DatabaseAccountConnectionStringResponse

    ConnectionString string
    Value of the connection string
    Description string
    Description of the connection string
    KeyKind string
    Kind of the connection string key
    Type string
    Type of the connection string
    ConnectionString string
    Value of the connection string
    Description string
    Description of the connection string
    KeyKind string
    Kind of the connection string key
    Type string
    Type of the connection string
    connectionString String
    Value of the connection string
    description String
    Description of the connection string
    keyKind String
    Kind of the connection string key
    type String
    Type of the connection string
    connectionString string
    Value of the connection string
    description string
    Description of the connection string
    keyKind string
    Kind of the connection string key
    type string
    Type of the connection string
    connection_string str
    Value of the connection string
    description str
    Description of the connection string
    key_kind str
    Kind of the connection string key
    type str
    Type of the connection string
    connectionString String
    Value of the connection string
    description String
    Description of the connection string
    keyKind String
    Kind of the connection string key
    type String
    Type of the connection string

    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.41.0 published on Tuesday, May 14, 2024 by Pulumi