Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. azurearcdata
  5. getSqlServerInstanceTelemetry
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.azurearcdata.getSqlServerInstanceTelemetry

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

Retrieves SQL Server instance telemetry

Uses Azure REST API version 2024-01-01.

Other available API versions: 2024-05-01-preview, 2025-03-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native azurearcdata [ApiVersion]. See the version guide for details.

Using getSqlServerInstanceTelemetry

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 getSqlServerInstanceTelemetry(args: GetSqlServerInstanceTelemetryArgs, opts?: InvokeOptions): Promise<GetSqlServerInstanceTelemetryResult>
function getSqlServerInstanceTelemetryOutput(args: GetSqlServerInstanceTelemetryOutputArgs, opts?: InvokeOptions): Output<GetSqlServerInstanceTelemetryResult>
Copy
def get_sql_server_instance_telemetry(aggregation_type: Optional[Union[str, AggregationType]] = None,
                                      database_names: Optional[Sequence[str]] = None,
                                      dataset_name: Optional[str] = None,
                                      end_time: Optional[str] = None,
                                      interval: Optional[str] = None,
                                      resource_group_name: Optional[str] = None,
                                      sql_server_instance_name: Optional[str] = None,
                                      start_time: Optional[str] = None,
                                      opts: Optional[InvokeOptions] = None) -> GetSqlServerInstanceTelemetryResult
def get_sql_server_instance_telemetry_output(aggregation_type: Optional[pulumi.Input[Union[str, AggregationType]]] = None,
                                      database_names: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                                      dataset_name: Optional[pulumi.Input[str]] = None,
                                      end_time: Optional[pulumi.Input[str]] = None,
                                      interval: Optional[pulumi.Input[str]] = None,
                                      resource_group_name: Optional[pulumi.Input[str]] = None,
                                      sql_server_instance_name: Optional[pulumi.Input[str]] = None,
                                      start_time: Optional[pulumi.Input[str]] = None,
                                      opts: Optional[InvokeOptions] = None) -> Output[GetSqlServerInstanceTelemetryResult]
Copy
func GetSqlServerInstanceTelemetry(ctx *Context, args *GetSqlServerInstanceTelemetryArgs, opts ...InvokeOption) (*GetSqlServerInstanceTelemetryResult, error)
func GetSqlServerInstanceTelemetryOutput(ctx *Context, args *GetSqlServerInstanceTelemetryOutputArgs, opts ...InvokeOption) GetSqlServerInstanceTelemetryResultOutput
Copy

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

public static class GetSqlServerInstanceTelemetry 
{
    public static Task<GetSqlServerInstanceTelemetryResult> InvokeAsync(GetSqlServerInstanceTelemetryArgs args, InvokeOptions? opts = null)
    public static Output<GetSqlServerInstanceTelemetryResult> Invoke(GetSqlServerInstanceTelemetryInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetSqlServerInstanceTelemetryResult> getSqlServerInstanceTelemetry(GetSqlServerInstanceTelemetryArgs args, InvokeOptions options)
public static Output<GetSqlServerInstanceTelemetryResult> getSqlServerInstanceTelemetry(GetSqlServerInstanceTelemetryArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:azurearcdata:getSqlServerInstanceTelemetry
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DatasetName This property is required. string
The name of the telemetry dataset to retrieve.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Azure resource group
SqlServerInstanceName
This property is required.
Changes to this property will trigger replacement.
string
Name of SQL Server Instance
AggregationType string | Pulumi.AzureNative.AzureArcData.AggregationType
The aggregation type to use for the numerical columns in the dataset.
DatabaseNames List<string>
The list of database names to return telemetry for. If not specified, telemetry for all databases will be aggregated and returned.
EndTime string
The end time for the time range to fetch telemetry for. If not specified, the current time is used.
Interval string
The time granularity to fetch telemetry for. This is an ISO8601 duration. Examples: PT15M, PT1H, P1D
StartTime string
The start time for the time range to fetch telemetry for. If not specified, the current time minus 1 hour is used.
DatasetName This property is required. string
The name of the telemetry dataset to retrieve.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Azure resource group
SqlServerInstanceName
This property is required.
Changes to this property will trigger replacement.
string
Name of SQL Server Instance
AggregationType string | AggregationType
The aggregation type to use for the numerical columns in the dataset.
DatabaseNames []string
The list of database names to return telemetry for. If not specified, telemetry for all databases will be aggregated and returned.
EndTime string
The end time for the time range to fetch telemetry for. If not specified, the current time is used.
Interval string
The time granularity to fetch telemetry for. This is an ISO8601 duration. Examples: PT15M, PT1H, P1D
StartTime string
The start time for the time range to fetch telemetry for. If not specified, the current time minus 1 hour is used.
datasetName This property is required. String
The name of the telemetry dataset to retrieve.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Azure resource group
sqlServerInstanceName
This property is required.
Changes to this property will trigger replacement.
String
Name of SQL Server Instance
aggregationType String | AggregationType
The aggregation type to use for the numerical columns in the dataset.
databaseNames List<String>
The list of database names to return telemetry for. If not specified, telemetry for all databases will be aggregated and returned.
endTime String
The end time for the time range to fetch telemetry for. If not specified, the current time is used.
interval String
The time granularity to fetch telemetry for. This is an ISO8601 duration. Examples: PT15M, PT1H, P1D
startTime String
The start time for the time range to fetch telemetry for. If not specified, the current time minus 1 hour is used.
datasetName This property is required. string
The name of the telemetry dataset to retrieve.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Azure resource group
sqlServerInstanceName
This property is required.
Changes to this property will trigger replacement.
string
Name of SQL Server Instance
aggregationType string | AggregationType
The aggregation type to use for the numerical columns in the dataset.
databaseNames string[]
The list of database names to return telemetry for. If not specified, telemetry for all databases will be aggregated and returned.
endTime string
The end time for the time range to fetch telemetry for. If not specified, the current time is used.
interval string
The time granularity to fetch telemetry for. This is an ISO8601 duration. Examples: PT15M, PT1H, P1D
startTime string
The start time for the time range to fetch telemetry for. If not specified, the current time minus 1 hour is used.
dataset_name This property is required. str
The name of the telemetry dataset to retrieve.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Azure resource group
sql_server_instance_name
This property is required.
Changes to this property will trigger replacement.
str
Name of SQL Server Instance
aggregation_type str | AggregationType
The aggregation type to use for the numerical columns in the dataset.
database_names Sequence[str]
The list of database names to return telemetry for. If not specified, telemetry for all databases will be aggregated and returned.
end_time str
The end time for the time range to fetch telemetry for. If not specified, the current time is used.
interval str
The time granularity to fetch telemetry for. This is an ISO8601 duration. Examples: PT15M, PT1H, P1D
start_time str
The start time for the time range to fetch telemetry for. If not specified, the current time minus 1 hour is used.
datasetName This property is required. String
The name of the telemetry dataset to retrieve.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Azure resource group
sqlServerInstanceName
This property is required.
Changes to this property will trigger replacement.
String
Name of SQL Server Instance
aggregationType String | "Average" | "Minimum" | "Maximum" | "Sum" | "Count"
The aggregation type to use for the numerical columns in the dataset.
databaseNames List<String>
The list of database names to return telemetry for. If not specified, telemetry for all databases will be aggregated and returned.
endTime String
The end time for the time range to fetch telemetry for. If not specified, the current time is used.
interval String
The time granularity to fetch telemetry for. This is an ISO8601 duration. Examples: PT15M, PT1H, P1D
startTime String
The start time for the time range to fetch telemetry for. If not specified, the current time minus 1 hour is used.

getSqlServerInstanceTelemetry Result

The following output properties are available:

Columns List<Pulumi.AzureNative.AzureArcData.Outputs.SqlServerInstanceTelemetryColumnResponse>
The columns of the result telemetry table for the SQL Server instance.
NextLink string
The link to the next section of rows of the telemetry response for the SQL Server instance. Null if no more sections are available.
Rows List<ImmutableArray<string>>
A list of rows from the result telemetry table for the SQL Server instance.
Columns []SqlServerInstanceTelemetryColumnResponse
The columns of the result telemetry table for the SQL Server instance.
NextLink string
The link to the next section of rows of the telemetry response for the SQL Server instance. Null if no more sections are available.
Rows [][]string
A list of rows from the result telemetry table for the SQL Server instance.
columns List<SqlServerInstanceTelemetryColumnResponse>
The columns of the result telemetry table for the SQL Server instance.
nextLink String
The link to the next section of rows of the telemetry response for the SQL Server instance. Null if no more sections are available.
rows List<List<String>>
A list of rows from the result telemetry table for the SQL Server instance.
columns SqlServerInstanceTelemetryColumnResponse[]
The columns of the result telemetry table for the SQL Server instance.
nextLink string
The link to the next section of rows of the telemetry response for the SQL Server instance. Null if no more sections are available.
rows string[][]
A list of rows from the result telemetry table for the SQL Server instance.
columns Sequence[SqlServerInstanceTelemetryColumnResponse]
The columns of the result telemetry table for the SQL Server instance.
next_link str
The link to the next section of rows of the telemetry response for the SQL Server instance. Null if no more sections are available.
rows Sequence[Sequence[str]]
A list of rows from the result telemetry table for the SQL Server instance.
columns List<Property Map>
The columns of the result telemetry table for the SQL Server instance.
nextLink String
The link to the next section of rows of the telemetry response for the SQL Server instance. Null if no more sections are available.
rows List<List<String>>
A list of rows from the result telemetry table for the SQL Server instance.

Supporting Types

AggregationType

SqlServerInstanceTelemetryColumnResponse

Name string
The name of the telemetry column.
Type string
The type of the telemetry column.
Name string
The name of the telemetry column.
Type string
The type of the telemetry column.
name String
The name of the telemetry column.
type String
The type of the telemetry column.
name string
The name of the telemetry column.
type string
The type of the telemetry column.
name str
The name of the telemetry column.
type str
The type of the telemetry column.
name String
The name of the telemetry column.
type String
The type of the telemetry column.

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 v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native