Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. monitor
  5. getDiagnosticSetting
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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.monitor.getDiagnosticSetting

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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets the active diagnostic settings for the specified resource.

Uses Azure REST API version 2021-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>
Copy
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]
Copy
func LookupDiagnosticSetting(ctx *Context, args *LookupDiagnosticSettingArgs, opts ...InvokeOption) (*LookupDiagnosticSettingResult, error)
func LookupDiagnosticSettingOutput(ctx *Context, args *LookupDiagnosticSettingOutputArgs, opts ...InvokeOption) LookupDiagnosticSettingResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetDiagnosticSettingResult> getDiagnosticSetting(GetDiagnosticSettingArgs args, InvokeOptions options)
public static Output<GetDiagnosticSettingResult> getDiagnosticSetting(GetDiagnosticSettingArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:monitor:getDiagnosticSetting
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name
This property is required.
Changes to this property will trigger replacement.
string
The name of the diagnostic setting.
ResourceUri
This property is required.
Changes to this property will trigger replacement.
string
The identifier of the resource.
Name
This property is required.
Changes to this property will trigger replacement.
string
The name of the diagnostic setting.
ResourceUri
This property is required.
Changes to this property will trigger replacement.
string
The identifier of the resource.
name
This property is required.
Changes to this property will trigger replacement.
String
The name of the diagnostic setting.
resourceUri
This property is required.
Changes to this property will trigger replacement.
String
The identifier of the resource.
name
This property is required.
Changes to this property will trigger replacement.
string
The name of the diagnostic setting.
resourceUri
This property is required.
Changes to this property will trigger replacement.
string
The identifier of the resource.
name
This property is required.
Changes to this property will trigger replacement.
str
The name of the diagnostic setting.
resource_uri
This property is required.
Changes to this property will trigger replacement.
str
The identifier of the resource.
name
This property is required.
Changes to this property will trigger replacement.
String
The name of the diagnostic setting.
resourceUri
This property is required.
Changes to this property will trigger replacement.
String
The identifier of the resource.

getDiagnosticSetting Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
SystemData Pulumi.AzureNative.Monitor.Outputs.SystemDataResponse
The system metadata related to this resource.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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.Monitor.Outputs.LogSettingsResponse>
The list of logs settings.
MarketplacePartnerId string
The full ARM resource ID of the Marketplace resource to which you would like to send Diagnostic Logs.
Metrics List<Pulumi.AzureNative.Monitor.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
AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
SystemData SystemDataResponse
The system metadata related to this resource.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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.
MarketplacePartnerId string
The full ARM resource ID of the Marketplace resource to which you would like to send Diagnostic Logs.
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
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
systemData SystemDataResponse
The system metadata related to this resource.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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.
marketplacePartnerId String
The full ARM resource ID of the Marketplace resource to which you would like to send Diagnostic Logs.
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
azureApiVersion string
The Azure API version of the resource.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name string
The name of the resource
systemData SystemDataResponse
The system metadata related to this resource.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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.
marketplacePartnerId string
The full ARM resource ID of the Marketplace resource to which you would like to send Diagnostic Logs.
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
azure_api_version str
The Azure API version of the resource.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str
The name of the resource
system_data SystemDataResponse
The system metadata related to this resource.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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.
marketplace_partner_id str
The full ARM resource ID of the Marketplace resource to which you would like to send Diagnostic Logs.
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
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
systemData Property Map
The system metadata related to this resource.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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.
marketplacePartnerId String
The full ARM resource ID of the Marketplace resource to which you would like to send Diagnostic Logs.
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 This property is required. 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.
CategoryGroup string
Name of a Diagnostic Log category group 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.Monitor.Inputs.RetentionPolicyResponse
the retention policy for this log.
Enabled This property is required. 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.
CategoryGroup string
Name of a Diagnostic Log category group 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 This property is required. 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.
categoryGroup String
Name of a Diagnostic Log category group 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 This property is required. 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.
categoryGroup string
Name of a Diagnostic Log category group 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 This property is required. 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.
category_group str
Name of a Diagnostic Log category group 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 This property is required. 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.
categoryGroup String
Name of a Diagnostic Log category group 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 This property is required. 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.Monitor.Inputs.RetentionPolicyResponse
the retention policy for this category.
TimeGrain string
the timegrain of the metric in ISO8601 format.
Enabled This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. int
the number of days for the retention in days. A value of 0 will retain the events indefinitely.
Enabled This property is required. bool
a value indicating whether the retention policy is enabled.
Days This property is required. int
the number of days for the retention in days. A value of 0 will retain the events indefinitely.
Enabled This property is required. bool
a value indicating whether the retention policy is enabled.
days This property is required. Integer
the number of days for the retention in days. A value of 0 will retain the events indefinitely.
enabled This property is required. Boolean
a value indicating whether the retention policy is enabled.
days This property is required. number
the number of days for the retention in days. A value of 0 will retain the events indefinitely.
enabled This property is required. boolean
a value indicating whether the retention policy is enabled.
days This property is required. int
the number of days for the retention in days. A value of 0 will retain the events indefinitely.
enabled This property is required. bool
a value indicating whether the retention policy is enabled.
days This property is required. Number
the number of days for the retention in days. A value of 0 will retain the events indefinitely.
enabled This property is required. Boolean
a value indicating whether the retention policy is enabled.

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native