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.
- Resource
Uri string The identifier of the resource.
- Name string
The name of the diagnostic setting.
- Resource
Uri string The identifier of the resource.
- name String
The name of the diagnostic setting.
- resource
Uri String The identifier of the resource.
- name string
The name of the diagnostic setting.
- resource
Uri 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.
- resource
Uri 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
- string
The resource Id for the event hub authorization rule.
- Event
Hub stringName The name of the event hub. If none is specified, the default event hub will be selected.
- Log
Analytics stringDestination Type 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.
Azure Native. Insights. Outputs. Log Settings Response> The list of logs settings.
- Metrics
List<Pulumi.
Azure Native. Insights. Outputs. Metric Settings Response> The list of metric settings.
- Service
Bus stringRule Id The service bus rule Id of the diagnostic setting. This is here to maintain backwards compatibility.
- Storage
Account stringId The resource ID of the storage account to which you would like to send Diagnostic Logs.
- Workspace
Id 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
- string
The resource Id for the event hub authorization rule.
- Event
Hub stringName The name of the event hub. If none is specified, the default event hub will be selected.
- Log
Analytics stringDestination Type 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
[]Log
Settings Response The list of logs settings.
- Metrics
[]Metric
Settings Response The list of metric settings.
- Service
Bus stringRule Id The service bus rule Id of the diagnostic setting. This is here to maintain backwards compatibility.
- Storage
Account stringId The resource ID of the storage account to which you would like to send Diagnostic Logs.
- Workspace
Id 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
- String
The resource Id for the event hub authorization rule.
- event
Hub StringName The name of the event hub. If none is specified, the default event hub will be selected.
- log
Analytics StringDestination Type 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<Log
Settings Response> The list of logs settings.
- metrics
List<Metric
Settings Response> The list of metric settings.
- service
Bus StringRule Id The service bus rule Id of the diagnostic setting. This is here to maintain backwards compatibility.
- storage
Account StringId The resource ID of the storage account to which you would like to send Diagnostic Logs.
- workspace
Id 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
- string
The resource Id for the event hub authorization rule.
- event
Hub stringName The name of the event hub. If none is specified, the default event hub will be selected.
- log
Analytics stringDestination Type 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
Log
Settings Response[] The list of logs settings.
- metrics
Metric
Settings Response[] The list of metric settings.
- service
Bus stringRule Id The service bus rule Id of the diagnostic setting. This is here to maintain backwards compatibility.
- storage
Account stringId The resource ID of the storage account to which you would like to send Diagnostic Logs.
- workspace
Id 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
- str
The resource Id for the event hub authorization rule.
- event_
hub_ strname The name of the event hub. If none is specified, the default event hub will be selected.
- log_
analytics_ strdestination_ type 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[Log
Settings Response] The list of logs settings.
- metrics
Sequence[Metric
Settings Response] The list of metric settings.
- service_
bus_ strrule_ id The service bus rule Id of the diagnostic setting. This is here to maintain backwards compatibility.
- storage_
account_ strid 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
- String
The resource Id for the event hub authorization rule.
- event
Hub StringName The name of the event hub. If none is specified, the default event hub will be selected.
- log
Analytics StringDestination Type 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.
- service
Bus StringRule Id The service bus rule Id of the diagnostic setting. This is here to maintain backwards compatibility.
- storage
Account StringId The resource ID of the storage account to which you would like to send Diagnostic Logs.
- workspace
Id 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.
- Retention
Policy Pulumi.Azure Native. Insights. Inputs. Retention Policy Response 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.
- Retention
Policy RetentionPolicy Response 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.
- retention
Policy RetentionPolicy Response 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.
- retention
Policy RetentionPolicy Response 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 RetentionPolicy Response 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.
- retention
Policy 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.
- Retention
Policy Pulumi.Azure Native. Insights. Inputs. Retention Policy Response the retention policy for this category.
- Time
Grain 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.
- Retention
Policy RetentionPolicy Response the retention policy for this category.
- Time
Grain 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.
- retention
Policy RetentionPolicy Response the retention policy for this category.
- time
Grain 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.
- retention
Policy RetentionPolicy Response the retention policy for this category.
- time
Grain 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 RetentionPolicy Response 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.
- retention
Policy Property Map the retention policy for this category.
- time
Grain String the timegrain of the metric in ISO8601 format.
RetentionPolicyResponse
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0