Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. insights
  5. getSubscriptionDiagnosticSetting
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.insights.getSubscriptionDiagnosticSetting

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets the active subscription diagnostic settings for the specified resource. Azure REST API version: 2021-05-01-preview.

Other available API versions: 2017-05-01-preview.

Using getSubscriptionDiagnosticSetting

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 getSubscriptionDiagnosticSetting(args: GetSubscriptionDiagnosticSettingArgs, opts?: InvokeOptions): Promise<GetSubscriptionDiagnosticSettingResult>
function getSubscriptionDiagnosticSettingOutput(args: GetSubscriptionDiagnosticSettingOutputArgs, opts?: InvokeOptions): Output<GetSubscriptionDiagnosticSettingResult>
Copy
def get_subscription_diagnostic_setting(name: Optional[str] = None,
                                        opts: Optional[InvokeOptions] = None) -> GetSubscriptionDiagnosticSettingResult
def get_subscription_diagnostic_setting_output(name: Optional[pulumi.Input[str]] = None,
                                        opts: Optional[InvokeOptions] = None) -> Output[GetSubscriptionDiagnosticSettingResult]
Copy
func LookupSubscriptionDiagnosticSetting(ctx *Context, args *LookupSubscriptionDiagnosticSettingArgs, opts ...InvokeOption) (*LookupSubscriptionDiagnosticSettingResult, error)
func LookupSubscriptionDiagnosticSettingOutput(ctx *Context, args *LookupSubscriptionDiagnosticSettingOutputArgs, opts ...InvokeOption) LookupSubscriptionDiagnosticSettingResultOutput
Copy

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

public static class GetSubscriptionDiagnosticSetting 
{
    public static Task<GetSubscriptionDiagnosticSettingResult> InvokeAsync(GetSubscriptionDiagnosticSettingArgs args, InvokeOptions? opts = null)
    public static Output<GetSubscriptionDiagnosticSettingResult> Invoke(GetSubscriptionDiagnosticSettingInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetSubscriptionDiagnosticSettingResult> getSubscriptionDiagnosticSetting(GetSubscriptionDiagnosticSettingArgs args, InvokeOptions options)
public static Output<GetSubscriptionDiagnosticSettingResult> getSubscriptionDiagnosticSetting(GetSubscriptionDiagnosticSettingArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:insights:getSubscriptionDiagnosticSetting
  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.
Name
This property is required.
Changes to this property will trigger replacement.
string
The name of the diagnostic setting.
name
This property is required.
Changes to this property will trigger replacement.
String
The name of the diagnostic setting.
name
This property is required.
Changes to this property will trigger replacement.
string
The name of the diagnostic setting.
name
This property is required.
Changes to this property will trigger replacement.
str
The name of the diagnostic setting.
name
This property is required.
Changes to this property will trigger replacement.
String
The name of the diagnostic setting.

getSubscriptionDiagnosticSetting Result

The following output properties are available:

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.Insights.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.
Logs List<Pulumi.AzureNative.Insights.Outputs.SubscriptionLogSettingsResponse>
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.
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
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.
Logs []SubscriptionLogSettingsResponse
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.
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
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.
logs List<SubscriptionLogSettingsResponse>
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.
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
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.
logs SubscriptionLogSettingsResponse[]
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.
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
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.
logs Sequence[SubscriptionLogSettingsResponse]
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.
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
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.
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.
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

SubscriptionLogSettingsResponse

Enabled This property is required. bool
a value indicating whether this log is enabled.
Category string
Name of a Subscription Diagnostic Log category for a resource type this setting is applied to.
CategoryGroup string
Name of a Subscription Diagnostic Log category group for a resource type this setting is applied to.
Enabled This property is required. bool
a value indicating whether this log is enabled.
Category string
Name of a Subscription Diagnostic Log category for a resource type this setting is applied to.
CategoryGroup string
Name of a Subscription Diagnostic Log category group for a resource type this setting is applied to.
enabled This property is required. Boolean
a value indicating whether this log is enabled.
category String
Name of a Subscription Diagnostic Log category for a resource type this setting is applied to.
categoryGroup String
Name of a Subscription Diagnostic Log category group for a resource type this setting is applied to.
enabled This property is required. boolean
a value indicating whether this log is enabled.
category string
Name of a Subscription Diagnostic Log category for a resource type this setting is applied to.
categoryGroup string
Name of a Subscription Diagnostic Log category group for a resource type this setting is applied to.
enabled This property is required. bool
a value indicating whether this log is enabled.
category str
Name of a Subscription Diagnostic Log category for a resource type this setting is applied to.
category_group str
Name of a Subscription Diagnostic Log category group for a resource type this setting is applied to.
enabled This property is required. Boolean
a value indicating whether this log is enabled.
category String
Name of a Subscription Diagnostic Log category for a resource type this setting is applied to.
categoryGroup String
Name of a Subscription Diagnostic Log category group for a resource type this setting is applied to.

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-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native