1. Packages
  2. Azure Native
  3. API Docs
  4. security
  5. getCustomAssessmentAutomation
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.2.0 published on Monday, Apr 14, 2025 by Pulumi

azure-native.security.getCustomAssessmentAutomation

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.2.0 published on Monday, Apr 14, 2025 by Pulumi

Gets a single custom assessment automation by name for the provided subscription and resource group.

Uses Azure REST API version 2021-07-01-preview.

Using getCustomAssessmentAutomation

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 getCustomAssessmentAutomation(args: GetCustomAssessmentAutomationArgs, opts?: InvokeOptions): Promise<GetCustomAssessmentAutomationResult>
function getCustomAssessmentAutomationOutput(args: GetCustomAssessmentAutomationOutputArgs, opts?: InvokeOptions): Output<GetCustomAssessmentAutomationResult>
Copy
def get_custom_assessment_automation(custom_assessment_automation_name: Optional[str] = None,
                                     resource_group_name: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetCustomAssessmentAutomationResult
def get_custom_assessment_automation_output(custom_assessment_automation_name: Optional[pulumi.Input[str]] = None,
                                     resource_group_name: Optional[pulumi.Input[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetCustomAssessmentAutomationResult]
Copy
func LookupCustomAssessmentAutomation(ctx *Context, args *LookupCustomAssessmentAutomationArgs, opts ...InvokeOption) (*LookupCustomAssessmentAutomationResult, error)
func LookupCustomAssessmentAutomationOutput(ctx *Context, args *LookupCustomAssessmentAutomationOutputArgs, opts ...InvokeOption) LookupCustomAssessmentAutomationResultOutput
Copy

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

public static class GetCustomAssessmentAutomation 
{
    public static Task<GetCustomAssessmentAutomationResult> InvokeAsync(GetCustomAssessmentAutomationArgs args, InvokeOptions? opts = null)
    public static Output<GetCustomAssessmentAutomationResult> Invoke(GetCustomAssessmentAutomationInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetCustomAssessmentAutomationResult> getCustomAssessmentAutomation(GetCustomAssessmentAutomationArgs args, InvokeOptions options)
public static Output<GetCustomAssessmentAutomationResult> getCustomAssessmentAutomation(GetCustomAssessmentAutomationArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:security:getCustomAssessmentAutomation
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CustomAssessmentAutomationName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Custom Assessment Automation.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group within the user's subscription. The name is case insensitive.
CustomAssessmentAutomationName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Custom Assessment Automation.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group within the user's subscription. The name is case insensitive.
customAssessmentAutomationName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Custom Assessment Automation.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group within the user's subscription. The name is case insensitive.
customAssessmentAutomationName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Custom Assessment Automation.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group within the user's subscription. The name is case insensitive.
custom_assessment_automation_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the Custom Assessment Automation.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group within the user's subscription. The name is case insensitive.
customAssessmentAutomationName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Custom Assessment Automation.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group within the user's subscription. The name is case insensitive.

getCustomAssessmentAutomation Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
Resource Id
Name string
Resource name
SystemData Pulumi.AzureNative.Security.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
Resource type
AssessmentKey string
The assessment metadata key used when an assessment is generated for this assessment automation.
CompressedQuery string
GZip encoded KQL query representing the assessment automation results required.
Description string
The description to relate to the assessments generated by this assessment automation.
DisplayName string
The display name of the assessments generated by this assessment automation.
RemediationDescription string
The remediation description to relate to the assessments generated by this assessment automation.
Severity string
The severity to relate to the assessments generated by this assessment automation.
SupportedCloud string
Relevant cloud for the custom assessment automation.
AzureApiVersion string
The Azure API version of the resource.
Id string
Resource Id
Name string
Resource name
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
Resource type
AssessmentKey string
The assessment metadata key used when an assessment is generated for this assessment automation.
CompressedQuery string
GZip encoded KQL query representing the assessment automation results required.
Description string
The description to relate to the assessments generated by this assessment automation.
DisplayName string
The display name of the assessments generated by this assessment automation.
RemediationDescription string
The remediation description to relate to the assessments generated by this assessment automation.
Severity string
The severity to relate to the assessments generated by this assessment automation.
SupportedCloud string
Relevant cloud for the custom assessment automation.
azureApiVersion String
The Azure API version of the resource.
id String
Resource Id
name String
Resource name
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
Resource type
assessmentKey String
The assessment metadata key used when an assessment is generated for this assessment automation.
compressedQuery String
GZip encoded KQL query representing the assessment automation results required.
description String
The description to relate to the assessments generated by this assessment automation.
displayName String
The display name of the assessments generated by this assessment automation.
remediationDescription String
The remediation description to relate to the assessments generated by this assessment automation.
severity String
The severity to relate to the assessments generated by this assessment automation.
supportedCloud String
Relevant cloud for the custom assessment automation.
azureApiVersion string
The Azure API version of the resource.
id string
Resource Id
name string
Resource name
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
Resource type
assessmentKey string
The assessment metadata key used when an assessment is generated for this assessment automation.
compressedQuery string
GZip encoded KQL query representing the assessment automation results required.
description string
The description to relate to the assessments generated by this assessment automation.
displayName string
The display name of the assessments generated by this assessment automation.
remediationDescription string
The remediation description to relate to the assessments generated by this assessment automation.
severity string
The severity to relate to the assessments generated by this assessment automation.
supportedCloud string
Relevant cloud for the custom assessment automation.
azure_api_version str
The Azure API version of the resource.
id str
Resource Id
name str
Resource name
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
Resource type
assessment_key str
The assessment metadata key used when an assessment is generated for this assessment automation.
compressed_query str
GZip encoded KQL query representing the assessment automation results required.
description str
The description to relate to the assessments generated by this assessment automation.
display_name str
The display name of the assessments generated by this assessment automation.
remediation_description str
The remediation description to relate to the assessments generated by this assessment automation.
severity str
The severity to relate to the assessments generated by this assessment automation.
supported_cloud str
Relevant cloud for the custom assessment automation.
azureApiVersion String
The Azure API version of the resource.
id String
Resource Id
name String
Resource name
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
Resource type
assessmentKey String
The assessment metadata key used when an assessment is generated for this assessment automation.
compressedQuery String
GZip encoded KQL query representing the assessment automation results required.
description String
The description to relate to the assessments generated by this assessment automation.
displayName String
The display name of the assessments generated by this assessment automation.
remediationDescription String
The remediation description to relate to the assessments generated by this assessment automation.
severity String
The severity to relate to the assessments generated by this assessment automation.
supportedCloud String
Relevant cloud for the custom assessment automation.

Supporting Types

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.2.0 published on Monday, Apr 14, 2025 by Pulumi