Get-AzKustoDatabase
Returns a database.
Syntax
Get-AzKustoDatabase
-ClusterName <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-Skiptoken <String>]
[-Top <Int32>]
[-DefaultProfile <PSObject>]
[<CommonParameters>] Get-AzKustoDatabase
-ClusterName <String>
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>] Get-AzKustoDatabase
-InputObject <IKustoIdentity>
[-DefaultProfile <PSObject>]
[<CommonParameters>] Description
Returns a database.
Examples
Example 1: List all Kusto databases in a cluster by name
Get-AzKustoDatabase -ResourceGroupName testrg -ClusterName testnewkustocluster
Kind Location Name Type
---- -------- ---- ----
ReadWrite East US testnewkustocluster/mykustodatabase Microsoft.Kusto/Clusters/Databases
ReadWrite East US testnewkustocluster/mykustodatabase2 Microsoft.Kusto/Clusters/DatabasesThe above command returns all Kusto databases in the cluster "testnewkustocluster" found in the resource group "testrg".
Example 2: Get a specific Kusto database by name
Get-AzKustoDatabase -ResourceGroupName testrg -ClusterName testnewkustocluster -Name mykustodatabase
Kind Location Name Type
---- -------- ---- ----
ReadWrite East US testnewkustocluster/mykustodatabase Microsoft.Kusto/Clusters/DatabasesThe above command returns the Kusto database named "mykustodatabase" in the cluster "testnewkustocluster" found in the resource group "testrg".
Parameters
-ClusterName
The name of the Kusto cluster.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
| Type: | PSObject |
| Aliases: | AzureRMContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
| Type: | IKustoIdentity |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
The name of the database in the Kusto cluster.
| Type: | String |
| Aliases: | DatabaseName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
The name of the resource group. The name is case insensitive.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Skiptoken
Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SubscriptionId
The ID of the target subscription.
| Type: | String[] |
| Position: | Named |
| Default value: | (Get-AzContext).Subscription.Id |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Top
limit the number of results
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |