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.75.0 published on Saturday, Nov 30, 2024 by Pulumi
azure-native.kusto.getCosmosDbDataConnection
Explore with Pulumi AI
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.75.0 published on Saturday, Nov 30, 2024 by Pulumi
Returns a data connection. Azure REST API version: 2022-12-29.
Using getCosmosDbDataConnection
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 getCosmosDbDataConnection(args: GetCosmosDbDataConnectionArgs, opts?: InvokeOptions): Promise<GetCosmosDbDataConnectionResult>
function getCosmosDbDataConnectionOutput(args: GetCosmosDbDataConnectionOutputArgs, opts?: InvokeOptions): Output<GetCosmosDbDataConnectionResult>
def get_cosmos_db_data_connection(cluster_name: Optional[str] = None,
data_connection_name: Optional[str] = None,
database_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetCosmosDbDataConnectionResult
def get_cosmos_db_data_connection_output(cluster_name: Optional[pulumi.Input[str]] = None,
data_connection_name: Optional[pulumi.Input[str]] = None,
database_name: Optional[pulumi.Input[str]] = None,
resource_group_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetCosmosDbDataConnectionResult]
func LookupCosmosDbDataConnection(ctx *Context, args *LookupCosmosDbDataConnectionArgs, opts ...InvokeOption) (*LookupCosmosDbDataConnectionResult, error)
func LookupCosmosDbDataConnectionOutput(ctx *Context, args *LookupCosmosDbDataConnectionOutputArgs, opts ...InvokeOption) LookupCosmosDbDataConnectionResultOutput
> Note: This function is named LookupCosmosDbDataConnection
in the Go SDK.
public static class GetCosmosDbDataConnection
{
public static Task<GetCosmosDbDataConnectionResult> InvokeAsync(GetCosmosDbDataConnectionArgs args, InvokeOptions? opts = null)
public static Output<GetCosmosDbDataConnectionResult> Invoke(GetCosmosDbDataConnectionInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetCosmosDbDataConnectionResult> getCosmosDbDataConnection(GetCosmosDbDataConnectionArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:kusto:getCosmosDbDataConnection
arguments:
# arguments dictionary
The following arguments are supported:
- Cluster
Name string - The name of the Kusto cluster.
- Data
Connection stringName - The name of the data connection.
- Database
Name string - The name of the database in the Kusto cluster.
- Resource
Group stringName - The name of the resource group containing the Kusto cluster.
- Cluster
Name string - The name of the Kusto cluster.
- Data
Connection stringName - The name of the data connection.
- Database
Name string - The name of the database in the Kusto cluster.
- Resource
Group stringName - The name of the resource group containing the Kusto cluster.
- cluster
Name String - The name of the Kusto cluster.
- data
Connection StringName - The name of the data connection.
- database
Name String - The name of the database in the Kusto cluster.
- resource
Group StringName - The name of the resource group containing the Kusto cluster.
- cluster
Name string - The name of the Kusto cluster.
- data
Connection stringName - The name of the data connection.
- database
Name string - The name of the database in the Kusto cluster.
- resource
Group stringName - The name of the resource group containing the Kusto cluster.
- cluster_
name str - The name of the Kusto cluster.
- data_
connection_ strname - The name of the data connection.
- database_
name str - The name of the database in the Kusto cluster.
- resource_
group_ strname - The name of the resource group containing the Kusto cluster.
- cluster
Name String - The name of the Kusto cluster.
- data
Connection StringName - The name of the data connection.
- database
Name String - The name of the database in the Kusto cluster.
- resource
Group StringName - The name of the resource group containing the Kusto cluster.
getCosmosDbDataConnection Result
The following output properties are available:
- Cosmos
Db stringAccount Resource Id - The resource ID of the Cosmos DB account used to create the data connection.
- Cosmos
Db stringContainer - The name of an existing container in the Cosmos DB database.
- Cosmos
Db stringDatabase - The name of an existing database in the Cosmos DB account.
- Id string
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- Managed
Identity stringObject Id - The object ID of the managed identity resource.
- Managed
Identity stringResource Id - The resource ID of a managed system or user-assigned identity. The identity is used to authenticate with Cosmos DB.
- Name string
- The name of the resource
- Provisioning
State string - The provisioned state of the resource.
- Table
Name string - The case-sensitive name of the existing target table in your cluster. Retrieved data is ingested into this table.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Location string
- Resource location.
- Mapping
Rule stringName - The name of an existing mapping rule to use when ingesting the retrieved data.
- Retrieval
Start stringDate - Optional. If defined, the data connection retrieves Cosmos DB documents created or updated after the specified retrieval start date.
- Cosmos
Db stringAccount Resource Id - The resource ID of the Cosmos DB account used to create the data connection.
- Cosmos
Db stringContainer - The name of an existing container in the Cosmos DB database.
- Cosmos
Db stringDatabase - The name of an existing database in the Cosmos DB account.
- Id string
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- Managed
Identity stringObject Id - The object ID of the managed identity resource.
- Managed
Identity stringResource Id - The resource ID of a managed system or user-assigned identity. The identity is used to authenticate with Cosmos DB.
- Name string
- The name of the resource
- Provisioning
State string - The provisioned state of the resource.
- Table
Name string - The case-sensitive name of the existing target table in your cluster. Retrieved data is ingested into this table.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Location string
- Resource location.
- Mapping
Rule stringName - The name of an existing mapping rule to use when ingesting the retrieved data.
- Retrieval
Start stringDate - Optional. If defined, the data connection retrieves Cosmos DB documents created or updated after the specified retrieval start date.
- cosmos
Db StringAccount Resource Id - The resource ID of the Cosmos DB account used to create the data connection.
- cosmos
Db StringContainer - The name of an existing container in the Cosmos DB database.
- cosmos
Db StringDatabase - The name of an existing database in the Cosmos DB account.
- id String
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- managed
Identity StringObject Id - The object ID of the managed identity resource.
- managed
Identity StringResource Id - The resource ID of a managed system or user-assigned identity. The identity is used to authenticate with Cosmos DB.
- name String
- The name of the resource
- provisioning
State String - The provisioned state of the resource.
- table
Name String - The case-sensitive name of the existing target table in your cluster. Retrieved data is ingested into this table.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- location String
- Resource location.
- mapping
Rule StringName - The name of an existing mapping rule to use when ingesting the retrieved data.
- retrieval
Start StringDate - Optional. If defined, the data connection retrieves Cosmos DB documents created or updated after the specified retrieval start date.
- cosmos
Db stringAccount Resource Id - The resource ID of the Cosmos DB account used to create the data connection.
- cosmos
Db stringContainer - The name of an existing container in the Cosmos DB database.
- cosmos
Db stringDatabase - The name of an existing database in the Cosmos DB account.
- id string
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- managed
Identity stringObject Id - The object ID of the managed identity resource.
- managed
Identity stringResource Id - The resource ID of a managed system or user-assigned identity. The identity is used to authenticate with Cosmos DB.
- name string
- The name of the resource
- provisioning
State string - The provisioned state of the resource.
- table
Name string - The case-sensitive name of the existing target table in your cluster. Retrieved data is ingested into this table.
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- location string
- Resource location.
- mapping
Rule stringName - The name of an existing mapping rule to use when ingesting the retrieved data.
- retrieval
Start stringDate - Optional. If defined, the data connection retrieves Cosmos DB documents created or updated after the specified retrieval start date.
- cosmos_
db_ straccount_ resource_ id - The resource ID of the Cosmos DB account used to create the data connection.
- cosmos_
db_ strcontainer - The name of an existing container in the Cosmos DB database.
- cosmos_
db_ strdatabase - The name of an existing database in the Cosmos DB account.
- id str
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- managed_
identity_ strobject_ id - The object ID of the managed identity resource.
- managed_
identity_ strresource_ id - The resource ID of a managed system or user-assigned identity. The identity is used to authenticate with Cosmos DB.
- name str
- The name of the resource
- provisioning_
state str - The provisioned state of the resource.
- table_
name str - The case-sensitive name of the existing target table in your cluster. Retrieved data is ingested into this table.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- location str
- Resource location.
- mapping_
rule_ strname - The name of an existing mapping rule to use when ingesting the retrieved data.
- retrieval_
start_ strdate - Optional. If defined, the data connection retrieves Cosmos DB documents created or updated after the specified retrieval start date.
- cosmos
Db StringAccount Resource Id - The resource ID of the Cosmos DB account used to create the data connection.
- cosmos
Db StringContainer - The name of an existing container in the Cosmos DB database.
- cosmos
Db StringDatabase - The name of an existing database in the Cosmos DB account.
- id String
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- managed
Identity StringObject Id - The object ID of the managed identity resource.
- managed
Identity StringResource Id - The resource ID of a managed system or user-assigned identity. The identity is used to authenticate with Cosmos DB.
- name String
- The name of the resource
- provisioning
State String - The provisioned state of the resource.
- table
Name String - The case-sensitive name of the existing target table in your cluster. Retrieved data is ingested into this table.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- location String
- Resource location.
- mapping
Rule StringName - The name of an existing mapping rule to use when ingesting the retrieved data.
- retrieval
Start StringDate - Optional. If defined, the data connection retrieves Cosmos DB documents created or updated after the specified retrieval start date.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
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.75.0 published on Saturday, Nov 30, 2024 by Pulumi