1. Packages
  2. Azure Native
  3. API Docs
  4. aadiam
  5. getDiagnosticSetting
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.34.0 published on Thursday, Mar 28, 2024 by Pulumi

azure-native.aadiam.getDiagnosticSetting

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.34.0 published on Thursday, Mar 28, 2024 by Pulumi

    Gets the active diagnostic setting for AadIam. Azure REST API version: 2017-04-01.

    Other available API versions: 2017-04-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,
                               opts: Optional[InvokeOptions] = None) -> GetDiagnosticSettingResult
    def get_diagnostic_setting_output(name: 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:aadiam:getDiagnosticSetting
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    The name of the diagnostic setting.
    Name string
    The name of the diagnostic setting.
    name String
    The name of the diagnostic setting.
    name string
    The name of the diagnostic setting.
    name str
    The name of the diagnostic setting.
    name String
    The name of the diagnostic setting.

    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.
    Logs List<Pulumi.AzureNative.AadIam.Outputs.LogSettingsResponse>
    The list of logs 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 workspace ID (resource ID of a Log Analytics workspace) for a 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.
    Logs []LogSettingsResponse
    The list of logs 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 workspace ID (resource ID of a Log Analytics workspace) for a 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.
    logs List<LogSettingsResponse>
    The list of logs 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 workspace ID (resource ID of a Log Analytics workspace) for a 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.
    logs LogSettingsResponse[]
    The list of logs 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 workspace ID (resource ID of a Log Analytics workspace) for a 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.
    logs Sequence[LogSettingsResponse]
    The list of logs 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 workspace ID (resource ID of a Log Analytics workspace) for a 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.
    logs List<Property Map>
    The list of logs 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 workspace ID (resource ID of a Log Analytics workspace) for a 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.AadIam.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.

    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
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.34.0 published on Thursday, Mar 28, 2024 by Pulumi