Azure Native v1.98.0, Mar 23 23

azure-native.insights.getDiagnosticSetting

Gets the active diagnostic settings for the specified resource. API Version: 2017-05-01-preview.

Using getDiagnosticSetting

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 getDiagnosticSetting(args: GetDiagnosticSettingArgs, opts?: InvokeOptions): Promise<GetDiagnosticSettingResult>
function getDiagnosticSettingOutput(args: GetDiagnosticSettingOutputArgs, opts?: InvokeOptions): Output<GetDiagnosticSettingResult>

def get_diagnostic_setting(name: Optional[str] = None,
                           resource_uri: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetDiagnosticSettingResult
def get_diagnostic_setting_output(name: Optional[pulumi.Input[str]] = None,
                           resource_uri: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetDiagnosticSettingResult]

func LookupDiagnosticSetting(ctx *Context, args *LookupDiagnosticSettingArgs, opts ...InvokeOption) (*LookupDiagnosticSettingResult, error)
func LookupDiagnosticSettingOutput(ctx *Context, args *LookupDiagnosticSettingOutputArgs, opts ...InvokeOption) LookupDiagnosticSettingResultOutput

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

public static class GetDiagnosticSetting 
{
    public static Task<GetDiagnosticSettingResult> InvokeAsync(GetDiagnosticSettingArgs args, InvokeOptions? opts = null)
    public static Output<GetDiagnosticSettingResult> Invoke(GetDiagnosticSettingInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDiagnosticSettingResult> getDiagnosticSetting(GetDiagnosticSettingArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:insights:getDiagnosticSetting
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: The name of the diagnostic setting.
ResourceUri string: The identifier of the resource.

Name string: The name of the diagnostic setting.
ResourceUri string: The identifier of the resource.

name String: The name of the diagnostic setting.
resourceUri String: The identifier of the resource.

name string: The name of the diagnostic setting.
resourceUri string: The identifier of the resource.

name str: The name of the diagnostic setting.
resource_uri str: The identifier of the resource.

name String: The name of the diagnostic setting.
resourceUri String: The identifier of the resource.

getDiagnosticSetting Result

The following output properties are available:

Id string: Azure resource Id
Name string: Azure resource name
Type string: Azure resource type
EventHubAuthorizationRuleId string: The resource Id for the event hub authorization rule.
EventHubName string: The name of the event hub. If none is specified, the default event hub will be selected.
LogAnalyticsDestinationType string: A string indicating whether the export to Log Analytics should use the default destination type, i.e. AzureDiagnostics, or use a destination type constructed as follows: _. Possible values are: Dedicated and null (null is default.)
Logs List<Pulumi.AzureNative.Insights.Outputs.LogSettingsResponse>: The list of logs settings.
Metrics List<Pulumi.AzureNative.Insights.Outputs.MetricSettingsResponse>: The list of metric settings.
ServiceBusRuleId string: The service bus rule Id of the diagnostic setting. This is here to maintain backwards compatibility.
StorageAccountId string: The resource ID of the storage account to which you would like to send Diagnostic Logs.
WorkspaceId string: The full ARM resource ID of the Log Analytics workspace to which you would like to send Diagnostic Logs. Example: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2

Id string: Azure resource Id
Name string: Azure resource name
Type string: Azure resource type
EventHubAuthorizationRuleId string: The resource Id for the event hub authorization rule.
EventHubName string: The name of the event hub. If none is specified, the default event hub will be selected.
LogAnalyticsDestinationType string: A string indicating whether the export to Log Analytics should use the default destination type, i.e. AzureDiagnostics, or use a destination type constructed as follows: _. Possible values are: Dedicated and null (null is default.)
Logs []LogSettingsResponse: The list of logs settings.
Metrics []MetricSettingsResponse: The list of metric settings.
ServiceBusRuleId string: The service bus rule Id of the diagnostic setting. This is here to maintain backwards compatibility.
StorageAccountId string: The resource ID of the storage account to which you would like to send Diagnostic Logs.
WorkspaceId string: The full ARM resource ID of the Log Analytics workspace to which you would like to send Diagnostic Logs. Example: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2

id String: Azure resource Id
name String: Azure resource name
type String: Azure resource type
eventHubAuthorizationRuleId String: The resource Id for the event hub authorization rule.
eventHubName String: The name of the event hub. If none is specified, the default event hub will be selected.
logAnalyticsDestinationType String: A string indicating whether the export to Log Analytics should use the default destination type, i.e. AzureDiagnostics, or use a destination type constructed as follows: _. Possible values are: Dedicated and null (null is default.)
logs List<LogSettingsResponse>: The list of logs settings.
metrics List<MetricSettingsResponse>: The list of metric settings.
serviceBusRuleId String: The service bus rule Id of the diagnostic setting. This is here to maintain backwards compatibility.
storageAccountId String: The resource ID of the storage account to which you would like to send Diagnostic Logs.
workspaceId String: The full ARM resource ID of the Log Analytics workspace to which you would like to send Diagnostic Logs. Example: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2

id string: Azure resource Id
name string: Azure resource name
type string: Azure resource type
eventHubAuthorizationRuleId string: The resource Id for the event hub authorization rule.
eventHubName string: The name of the event hub. If none is specified, the default event hub will be selected.
logAnalyticsDestinationType string: A string indicating whether the export to Log Analytics should use the default destination type, i.e. AzureDiagnostics, or use a destination type constructed as follows: _. Possible values are: Dedicated and null (null is default.)
logs LogSettingsResponse[]: The list of logs settings.
metrics MetricSettingsResponse[]: The list of metric settings.
serviceBusRuleId string: The service bus rule Id of the diagnostic setting. This is here to maintain backwards compatibility.
storageAccountId string: The resource ID of the storage account to which you would like to send Diagnostic Logs.
workspaceId string: The full ARM resource ID of the Log Analytics workspace to which you would like to send Diagnostic Logs. Example: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2

id str: Azure resource Id
name str: Azure resource name
type str: Azure resource type
event_hub_authorization_rule_id str: The resource Id for the event hub authorization rule.
event_hub_name str: The name of the event hub. If none is specified, the default event hub will be selected.
log_analytics_destination_type str: A string indicating whether the export to Log Analytics should use the default destination type, i.e. AzureDiagnostics, or use a destination type constructed as follows: _. Possible values are: Dedicated and null (null is default.)
logs Sequence[LogSettingsResponse]: The list of logs settings.
metrics Sequence[MetricSettingsResponse]: The list of metric settings.
service_bus_rule_id str: The service bus rule Id of the diagnostic setting. This is here to maintain backwards compatibility.
storage_account_id str: The resource ID of the storage account to which you would like to send Diagnostic Logs.
workspace_id str: The full ARM resource ID of the Log Analytics workspace to which you would like to send Diagnostic Logs. Example: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2

id String: Azure resource Id
name String: Azure resource name
type String: Azure resource type
eventHubAuthorizationRuleId String: The resource Id for the event hub authorization rule.
eventHubName String: The name of the event hub. If none is specified, the default event hub will be selected.
logAnalyticsDestinationType String: A string indicating whether the export to Log Analytics should use the default destination type, i.e. AzureDiagnostics, or use a destination type constructed as follows: _. Possible values are: Dedicated and null (null is default.)
logs List<Property Map>: The list of logs settings.
metrics List<Property Map>: The list of metric settings.
serviceBusRuleId String: The service bus rule Id of the diagnostic setting. This is here to maintain backwards compatibility.
storageAccountId String: The resource ID of the storage account to which you would like to send Diagnostic Logs.
workspaceId String: The full ARM resource ID of the Log Analytics workspace to which you would like to send Diagnostic Logs. Example: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2

Supporting Types

LogSettingsResponse

Enabled bool: a value indicating whether this log is enabled.
Category string: Name of a Diagnostic Log category for a resource type this setting is applied to. To obtain the list of Diagnostic Log categories for a resource, first perform a GET diagnostic settings operation.
RetentionPolicy Pulumi.AzureNative.Insights.Inputs.RetentionPolicyResponse: the retention policy for this log.

Enabled bool: a value indicating whether this log is enabled.
Category string: Name of a Diagnostic Log category for a resource type this setting is applied to. To obtain the list of Diagnostic Log categories for a resource, first perform a GET diagnostic settings operation.
RetentionPolicy RetentionPolicyResponse: the retention policy for this log.

enabled Boolean: a value indicating whether this log is enabled.
category String: Name of a Diagnostic Log category for a resource type this setting is applied to. To obtain the list of Diagnostic Log categories for a resource, first perform a GET diagnostic settings operation.
retentionPolicy RetentionPolicyResponse: the retention policy for this log.

enabled boolean: a value indicating whether this log is enabled.
category string: Name of a Diagnostic Log category for a resource type this setting is applied to. To obtain the list of Diagnostic Log categories for a resource, first perform a GET diagnostic settings operation.
retentionPolicy RetentionPolicyResponse: the retention policy for this log.

enabled bool: a value indicating whether this log is enabled.
category str: Name of a Diagnostic Log category for a resource type this setting is applied to. To obtain the list of Diagnostic Log categories for a resource, first perform a GET diagnostic settings operation.
retention_policy RetentionPolicyResponse: the retention policy for this log.

enabled Boolean: a value indicating whether this log is enabled.
category String: Name of a Diagnostic Log category for a resource type this setting is applied to. To obtain the list of Diagnostic Log categories for a resource, first perform a GET diagnostic settings operation.
retentionPolicy Property Map: the retention policy for this log.

MetricSettingsResponse

Enabled bool: a value indicating whether this category is enabled.
Category string: Name of a Diagnostic Metric category for a resource type this setting is applied to. To obtain the list of Diagnostic metric categories for a resource, first perform a GET diagnostic settings operation.
RetentionPolicy Pulumi.AzureNative.Insights.Inputs.RetentionPolicyResponse: the retention policy for this category.
TimeGrain string: the timegrain of the metric in ISO8601 format.

Enabled bool: a value indicating whether this category is enabled.
Category string: Name of a Diagnostic Metric category for a resource type this setting is applied to. To obtain the list of Diagnostic metric categories for a resource, first perform a GET diagnostic settings operation.
RetentionPolicy RetentionPolicyResponse: the retention policy for this category.
TimeGrain string: the timegrain of the metric in ISO8601 format.

enabled Boolean: a value indicating whether this category is enabled.
category String: Name of a Diagnostic Metric category for a resource type this setting is applied to. To obtain the list of Diagnostic metric categories for a resource, first perform a GET diagnostic settings operation.
retentionPolicy RetentionPolicyResponse: the retention policy for this category.
timeGrain String: the timegrain of the metric in ISO8601 format.

enabled boolean: a value indicating whether this category is enabled.
category string: Name of a Diagnostic Metric category for a resource type this setting is applied to. To obtain the list of Diagnostic metric categories for a resource, first perform a GET diagnostic settings operation.
retentionPolicy RetentionPolicyResponse: the retention policy for this category.
timeGrain string: the timegrain of the metric in ISO8601 format.

enabled bool: a value indicating whether this category is enabled.
category str: Name of a Diagnostic Metric category for a resource type this setting is applied to. To obtain the list of Diagnostic metric categories for a resource, first perform a GET diagnostic settings operation.
retention_policy RetentionPolicyResponse: the retention policy for this category.
time_grain str: the timegrain of the metric in ISO8601 format.

enabled Boolean: a value indicating whether this category is enabled.
category String: Name of a Diagnostic Metric category for a resource type this setting is applied to. To obtain the list of Diagnostic metric categories for a resource, first perform a GET diagnostic settings operation.
retentionPolicy Property Map: the retention policy for this category.
timeGrain String: the timegrain of the metric in ISO8601 format.

RetentionPolicyResponse

Days int: the number of days for the retention in days. A value of 0 will retain the events indefinitely.
Enabled bool: a value indicating whether the retention policy is enabled.

Days int: the number of days for the retention in days. A value of 0 will retain the events indefinitely.
Enabled bool: a value indicating whether the retention policy is enabled.

days Integer: the number of days for the retention in days. A value of 0 will retain the events indefinitely.
enabled Boolean: a value indicating whether the retention policy is enabled.

days number: the number of days for the retention in days. A value of 0 will retain the events indefinitely.
enabled boolean: a value indicating whether the retention policy is enabled.

days int: the number of days for the retention in days. A value of 0 will retain the events indefinitely.
enabled bool: a value indicating whether the retention policy is enabled.

days Number: the number of days for the retention in days. A value of 0 will retain the events indefinitely.
enabled Boolean: a value indicating whether the retention policy is enabled.

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0