Azure Native v2.47.1, Jun 24 24

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.47.1 published on Monday, Jun 24, 2024 by Pulumi

pulumi/pulumi-azure-native

azure-native.security.getAssessment

Explore with Pulumi AI

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.47.1 published on Monday, Jun 24, 2024 by Pulumi

pulumi/pulumi-azure-native

Using getAssessment

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 getAssessment(args: GetAssessmentArgs, opts?: InvokeOptions): Promise<GetAssessmentResult>
function getAssessmentOutput(args: GetAssessmentOutputArgs, opts?: InvokeOptions): Output<GetAssessmentResult>

def get_assessment(assessment_name: Optional[str] = None,
                   expand: Optional[str] = None,
                   resource_id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetAssessmentResult
def get_assessment_output(assessment_name: Optional[pulumi.Input[str]] = None,
                   expand: Optional[pulumi.Input[str]] = None,
                   resource_id: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetAssessmentResult]

func LookupAssessment(ctx *Context, args *LookupAssessmentArgs, opts ...InvokeOption) (*LookupAssessmentResult, error)
func LookupAssessmentOutput(ctx *Context, args *LookupAssessmentOutputArgs, opts ...InvokeOption) LookupAssessmentResultOutput

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

public static class GetAssessment 
{
    public static Task<GetAssessmentResult> InvokeAsync(GetAssessmentArgs args, InvokeOptions? opts = null)
    public static Output<GetAssessmentResult> Invoke(GetAssessmentInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetAssessmentResult> getAssessment(GetAssessmentArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:security:getAssessment
  arguments:
    # arguments dictionary

The following arguments are supported:

AssessmentName string: The Assessment Key - Unique key for the assessment type
ResourceId string: The identifier of the resource.
Expand string: OData expand. Optional.

AssessmentName string: The Assessment Key - Unique key for the assessment type
ResourceId string: The identifier of the resource.
Expand string: OData expand. Optional.

assessmentName String: The Assessment Key - Unique key for the assessment type
resourceId String: The identifier of the resource.
expand String: OData expand. Optional.

assessmentName string: The Assessment Key - Unique key for the assessment type
resourceId string: The identifier of the resource.
expand string: OData expand. Optional.

assessment_name str: The Assessment Key - Unique key for the assessment type
resource_id str: The identifier of the resource.
expand str: OData expand. Optional.

assessmentName String: The Assessment Key - Unique key for the assessment type
resourceId String: The identifier of the resource.
expand String: OData expand. Optional.

getAssessment Result

The following output properties are available:

DisplayName string: User friendly display name of the assessment
Id string: Resource Id
Links Pulumi.AzureNative.Security.Outputs.AssessmentLinksResponse: Links relevant to the assessment
Name string: Resource name
ResourceDetails Pulumi.AzureNative.Security.Outputs.AzureResourceDetailsResponse | Pulumi.AzureNative.Security.Outputs.OnPremiseResourceDetailsResponse | Pulumi.AzureNative.Security.Outputs.OnPremiseSqlResourceDetailsResponse: Details of the resource that was assessed
Status Pulumi.AzureNative.Security.Outputs.AssessmentStatusResponseResponse: The result of the assessment
Type string: Resource type
AdditionalData Dictionary<string, string>: Additional data regarding the assessment
Metadata Pulumi.AzureNative.Security.Outputs.SecurityAssessmentMetadataPropertiesResponse: Describes properties of an assessment metadata.
PartnersData Pulumi.AzureNative.Security.Outputs.SecurityAssessmentPartnerDataResponse: Data regarding 3rd party partner integration

DisplayName string: User friendly display name of the assessment
Id string: Resource Id
Links AssessmentLinksResponse: Links relevant to the assessment
Name string: Resource name
ResourceDetails AzureResourceDetailsResponse | OnPremiseResourceDetailsResponse | OnPremiseSqlResourceDetailsResponse: Details of the resource that was assessed
Status AssessmentStatusResponseResponse: The result of the assessment
Type string: Resource type
AdditionalData map[string]string: Additional data regarding the assessment
Metadata SecurityAssessmentMetadataPropertiesResponse: Describes properties of an assessment metadata.
PartnersData SecurityAssessmentPartnerDataResponse: Data regarding 3rd party partner integration

displayName String: User friendly display name of the assessment
id String: Resource Id
links AssessmentLinksResponse: Links relevant to the assessment
name String: Resource name
resourceDetails AzureResourceDetailsResponse | OnPremiseResourceDetailsResponse | OnPremiseSqlResourceDetailsResponse: Details of the resource that was assessed
status AssessmentStatusResponseResponse: The result of the assessment
type String: Resource type
additionalData Map<String,String>: Additional data regarding the assessment
metadata SecurityAssessmentMetadataPropertiesResponse: Describes properties of an assessment metadata.
partnersData SecurityAssessmentPartnerDataResponse: Data regarding 3rd party partner integration

displayName string: User friendly display name of the assessment
id string: Resource Id
links AssessmentLinksResponse: Links relevant to the assessment
name string: Resource name
resourceDetails AzureResourceDetailsResponse | OnPremiseResourceDetailsResponse | OnPremiseSqlResourceDetailsResponse: Details of the resource that was assessed
status AssessmentStatusResponseResponse: The result of the assessment
type string: Resource type
additionalData {[key: string]: string}: Additional data regarding the assessment
metadata SecurityAssessmentMetadataPropertiesResponse: Describes properties of an assessment metadata.
partnersData SecurityAssessmentPartnerDataResponse: Data regarding 3rd party partner integration

display_name str: User friendly display name of the assessment
id str: Resource Id
links AssessmentLinksResponse: Links relevant to the assessment
name str: Resource name
resource_details AzureResourceDetailsResponse | OnPremiseResourceDetailsResponse | OnPremiseSqlResourceDetailsResponse: Details of the resource that was assessed
status AssessmentStatusResponseResponse: The result of the assessment
type str: Resource type
additional_data Mapping[str, str]: Additional data regarding the assessment
metadata SecurityAssessmentMetadataPropertiesResponse: Describes properties of an assessment metadata.
partners_data SecurityAssessmentPartnerDataResponse: Data regarding 3rd party partner integration

displayName String: User friendly display name of the assessment
id String: Resource Id
links Property Map: Links relevant to the assessment
name String: Resource name
resourceDetails Property Map | Property Map | Property Map: Details of the resource that was assessed
status Property Map: The result of the assessment
type String: Resource type
additionalData Map<String>: Additional data regarding the assessment
metadata Property Map: Describes properties of an assessment metadata.
partnersData Property Map: Data regarding 3rd party partner integration

Supporting Types

AssessmentLinksResponse

AzurePortalUri string: Link to assessment in Azure Portal

AzurePortalUri string: Link to assessment in Azure Portal

azurePortalUri String: Link to assessment in Azure Portal

azurePortalUri string: Link to assessment in Azure Portal

azure_portal_uri str: Link to assessment in Azure Portal

azurePortalUri String: Link to assessment in Azure Portal

AssessmentStatusResponseResponse

Code string: Programmatic code for the status of the assessment
FirstEvaluationDate string: The time that the assessment was created and first evaluated. Returned as UTC time in ISO 8601 format
StatusChangeDate string: The time that the status of the assessment last changed. Returned as UTC time in ISO 8601 format
Cause string: Programmatic code for the cause of the assessment status
Description string: Human readable description of the assessment status

Code string: Programmatic code for the status of the assessment
FirstEvaluationDate string: The time that the assessment was created and first evaluated. Returned as UTC time in ISO 8601 format
StatusChangeDate string: The time that the status of the assessment last changed. Returned as UTC time in ISO 8601 format
Cause string: Programmatic code for the cause of the assessment status
Description string: Human readable description of the assessment status

code String: Programmatic code for the status of the assessment
firstEvaluationDate String: The time that the assessment was created and first evaluated. Returned as UTC time in ISO 8601 format
statusChangeDate String: The time that the status of the assessment last changed. Returned as UTC time in ISO 8601 format
cause String: Programmatic code for the cause of the assessment status
description String: Human readable description of the assessment status

code string: Programmatic code for the status of the assessment
firstEvaluationDate string: The time that the assessment was created and first evaluated. Returned as UTC time in ISO 8601 format
statusChangeDate string: The time that the status of the assessment last changed. Returned as UTC time in ISO 8601 format
cause string: Programmatic code for the cause of the assessment status
description string: Human readable description of the assessment status

code str: Programmatic code for the status of the assessment
first_evaluation_date str: The time that the assessment was created and first evaluated. Returned as UTC time in ISO 8601 format
status_change_date str: The time that the status of the assessment last changed. Returned as UTC time in ISO 8601 format
cause str: Programmatic code for the cause of the assessment status
description str: Human readable description of the assessment status

code String: Programmatic code for the status of the assessment
firstEvaluationDate String: The time that the assessment was created and first evaluated. Returned as UTC time in ISO 8601 format
statusChangeDate String: The time that the status of the assessment last changed. Returned as UTC time in ISO 8601 format
cause String: Programmatic code for the cause of the assessment status
description String: Human readable description of the assessment status

AzureResourceDetailsResponse

Id string: Azure resource Id of the assessed resource

Id string: Azure resource Id of the assessed resource

id String: Azure resource Id of the assessed resource

id string: Azure resource Id of the assessed resource

id str: Azure resource Id of the assessed resource

id String: Azure resource Id of the assessed resource

OnPremiseResourceDetailsResponse

MachineName string: The name of the machine
SourceComputerId string: The oms agent Id installed on the machine
Vmuuid string: The unique Id of the machine
WorkspaceId string: Azure resource Id of the workspace the machine is attached to

MachineName string: The name of the machine
SourceComputerId string: The oms agent Id installed on the machine
Vmuuid string: The unique Id of the machine
WorkspaceId string: Azure resource Id of the workspace the machine is attached to

machineName String: The name of the machine
sourceComputerId String: The oms agent Id installed on the machine
vmuuid String: The unique Id of the machine
workspaceId String: Azure resource Id of the workspace the machine is attached to

machineName string: The name of the machine
sourceComputerId string: The oms agent Id installed on the machine
vmuuid string: The unique Id of the machine
workspaceId string: Azure resource Id of the workspace the machine is attached to

machine_name str: The name of the machine
source_computer_id str: The oms agent Id installed on the machine
vmuuid str: The unique Id of the machine
workspace_id str: Azure resource Id of the workspace the machine is attached to

machineName String: The name of the machine
sourceComputerId String: The oms agent Id installed on the machine
vmuuid String: The unique Id of the machine
workspaceId String: Azure resource Id of the workspace the machine is attached to

OnPremiseSqlResourceDetailsResponse

DatabaseName string: The Sql database name installed on the machine
MachineName string: The name of the machine
ServerName string: The Sql server name installed on the machine
SourceComputerId string: The oms agent Id installed on the machine
Vmuuid string: The unique Id of the machine
WorkspaceId string: Azure resource Id of the workspace the machine is attached to

DatabaseName string: The Sql database name installed on the machine
MachineName string: The name of the machine
ServerName string: The Sql server name installed on the machine
SourceComputerId string: The oms agent Id installed on the machine
Vmuuid string: The unique Id of the machine
WorkspaceId string: Azure resource Id of the workspace the machine is attached to

databaseName String: The Sql database name installed on the machine
machineName String: The name of the machine
serverName String: The Sql server name installed on the machine
sourceComputerId String: The oms agent Id installed on the machine
vmuuid String: The unique Id of the machine
workspaceId String: Azure resource Id of the workspace the machine is attached to

databaseName string: The Sql database name installed on the machine
machineName string: The name of the machine
serverName string: The Sql server name installed on the machine
sourceComputerId string: The oms agent Id installed on the machine
vmuuid string: The unique Id of the machine
workspaceId string: Azure resource Id of the workspace the machine is attached to

database_name str: The Sql database name installed on the machine
machine_name str: The name of the machine
server_name str: The Sql server name installed on the machine
source_computer_id str: The oms agent Id installed on the machine
vmuuid str: The unique Id of the machine
workspace_id str: Azure resource Id of the workspace the machine is attached to

databaseName String: The Sql database name installed on the machine
machineName String: The name of the machine
serverName String: The Sql server name installed on the machine
sourceComputerId String: The oms agent Id installed on the machine
vmuuid String: The unique Id of the machine
workspaceId String: Azure resource Id of the workspace the machine is attached to

SecurityAssessmentMetadataPartnerDataResponse

PartnerName string: Name of the company of the partner
Secret string: Secret to authenticate the partner and verify it created the assessment - write only
ProductName string: Name of the product of the partner that created the assessment

PartnerName string: Name of the company of the partner
Secret string: Secret to authenticate the partner and verify it created the assessment - write only
ProductName string: Name of the product of the partner that created the assessment

partnerName String: Name of the company of the partner
secret String: Secret to authenticate the partner and verify it created the assessment - write only
productName String: Name of the product of the partner that created the assessment

partnerName string: Name of the company of the partner
secret string: Secret to authenticate the partner and verify it created the assessment - write only
productName string: Name of the product of the partner that created the assessment

partner_name str: Name of the company of the partner
secret str: Secret to authenticate the partner and verify it created the assessment - write only
product_name str: Name of the product of the partner that created the assessment

partnerName String: Name of the company of the partner
secret String: Secret to authenticate the partner and verify it created the assessment - write only
productName String: Name of the product of the partner that created the assessment

SecurityAssessmentMetadataPropertiesResponse

AssessmentType string: BuiltIn if the assessment based on built-in Azure Policy definition, Custom if the assessment based on custom Azure Policy definition
DisplayName string: User friendly display name of the assessment
PolicyDefinitionId string: Azure resource ID of the policy definition that turns this assessment calculation on
Severity string: The severity level of the assessment
Categories List<string>
Description string: Human readable description of the assessment
ImplementationEffort string: The implementation effort required to remediate this assessment
PartnerData Pulumi.AzureNative.Security.Inputs.SecurityAssessmentMetadataPartnerDataResponse: Describes the partner that created the assessment
Preview bool: True if this assessment is in preview release status
RemediationDescription string: Human readable description of what you should do to mitigate this security issue
Threats List<string>
UserImpact string: The user impact of the assessment

AssessmentType string: BuiltIn if the assessment based on built-in Azure Policy definition, Custom if the assessment based on custom Azure Policy definition
DisplayName string: User friendly display name of the assessment
PolicyDefinitionId string: Azure resource ID of the policy definition that turns this assessment calculation on
Severity string: The severity level of the assessment
Categories []string
Description string: Human readable description of the assessment
ImplementationEffort string: The implementation effort required to remediate this assessment
PartnerData SecurityAssessmentMetadataPartnerDataResponse: Describes the partner that created the assessment
Preview bool: True if this assessment is in preview release status
RemediationDescription string: Human readable description of what you should do to mitigate this security issue
Threats []string
UserImpact string: The user impact of the assessment

assessmentType String: BuiltIn if the assessment based on built-in Azure Policy definition, Custom if the assessment based on custom Azure Policy definition
displayName String: User friendly display name of the assessment
policyDefinitionId String: Azure resource ID of the policy definition that turns this assessment calculation on
severity String: The severity level of the assessment
categories List<String>
description String: Human readable description of the assessment
implementationEffort String: The implementation effort required to remediate this assessment
partnerData SecurityAssessmentMetadataPartnerDataResponse: Describes the partner that created the assessment
preview Boolean: True if this assessment is in preview release status
remediationDescription String: Human readable description of what you should do to mitigate this security issue
threats List<String>
userImpact String: The user impact of the assessment

assessmentType string: BuiltIn if the assessment based on built-in Azure Policy definition, Custom if the assessment based on custom Azure Policy definition
displayName string: User friendly display name of the assessment
policyDefinitionId string: Azure resource ID of the policy definition that turns this assessment calculation on
severity string: The severity level of the assessment
categories string[]
description string: Human readable description of the assessment
implementationEffort string: The implementation effort required to remediate this assessment
partnerData SecurityAssessmentMetadataPartnerDataResponse: Describes the partner that created the assessment
preview boolean: True if this assessment is in preview release status
remediationDescription string: Human readable description of what you should do to mitigate this security issue
threats string[]
userImpact string: The user impact of the assessment

assessment_type str: BuiltIn if the assessment based on built-in Azure Policy definition, Custom if the assessment based on custom Azure Policy definition
display_name str: User friendly display name of the assessment
policy_definition_id str: Azure resource ID of the policy definition that turns this assessment calculation on
severity str: The severity level of the assessment
categories Sequence[str]
description str: Human readable description of the assessment
implementation_effort str: The implementation effort required to remediate this assessment
partner_data SecurityAssessmentMetadataPartnerDataResponse: Describes the partner that created the assessment
preview bool: True if this assessment is in preview release status
remediation_description str: Human readable description of what you should do to mitigate this security issue
threats Sequence[str]
user_impact str: The user impact of the assessment

assessmentType String: BuiltIn if the assessment based on built-in Azure Policy definition, Custom if the assessment based on custom Azure Policy definition
displayName String: User friendly display name of the assessment
policyDefinitionId String: Azure resource ID of the policy definition that turns this assessment calculation on
severity String: The severity level of the assessment
categories List<String>
description String: Human readable description of the assessment
implementationEffort String: The implementation effort required to remediate this assessment
partnerData Property Map: Describes the partner that created the assessment
preview Boolean: True if this assessment is in preview release status
remediationDescription String: Human readable description of what you should do to mitigate this security issue
threats List<String>
userImpact String: The user impact of the assessment

SecurityAssessmentPartnerDataResponse

PartnerName string: Name of the company of the partner
Secret string: secret to authenticate the partner - write only

PartnerName string: Name of the company of the partner
Secret string: secret to authenticate the partner - write only

partnerName String: Name of the company of the partner
secret String: secret to authenticate the partner - write only

partnerName string: Name of the company of the partner
secret string: secret to authenticate the partner - write only

partner_name str: Name of the company of the partner
secret str: secret to authenticate the partner - write only

partnerName String: Name of the company of the partner
secret String: secret to authenticate the partner - write only

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 v1 docs if using the v1 version of this package.

Azure Native v2.47.1 published on Monday, Jun 24, 2024 by Pulumi

pulumi/pulumi-azure-native

azure-native.security.getAssessment

On this page

On this page

Using getAssessment

getAssessment Result

Supporting Types

AssessmentLinksResponse

AssessmentStatusResponseResponse

AzureResourceDetailsResponse

OnPremiseResourceDetailsResponse

OnPremiseSqlResourceDetailsResponse

SecurityAssessmentMetadataPartnerDataResponse

SecurityAssessmentMetadataPropertiesResponse

SecurityAssessmentPartnerDataResponse

Package Details

On this page

On this page