Azure Native v1.102.0, May 2 23
Azure Native v1.102.0, May 2 23
azure-native.security.getAssessment
Explore with Pulumi AI
Get a security assessment on your scanned resource API Version: 2020-01-01.
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:
- Assessment
Name string The Assessment Key - Unique key for the assessment type
- Resource
Id string The identifier of the resource.
- Expand string
OData expand. Optional.
- Assessment
Name string The Assessment Key - Unique key for the assessment type
- Resource
Id string The identifier of the resource.
- Expand string
OData expand. Optional.
- assessment
Name String The Assessment Key - Unique key for the assessment type
- resource
Id String The identifier of the resource.
- expand String
OData expand. Optional.
- assessment
Name string The Assessment Key - Unique key for the assessment type
- resource
Id 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.
- assessment
Name String The Assessment Key - Unique key for the assessment type
- resource
Id String The identifier of the resource.
- expand String
OData expand. Optional.
getAssessment Result
The following output properties are available:
- Display
Name string User friendly display name of the assessment
- Id string
Resource Id
- Links
Pulumi.
Azure Native. Security. Outputs. Assessment Links Response Links relevant to the assessment
- Name string
Resource name
- Resource
Details Pulumi.Azure | Pulumi.Native. Security. Outputs. Azure Resource Details Response Azure | Pulumi.Native. Security. Outputs. On Premise Resource Details Response Azure Native. Security. Outputs. On Premise Sql Resource Details Response Details of the resource that was assessed
- Status
Pulumi.
Azure Native. Security. Outputs. Assessment Status Response The result of the assessment
- Type string
Resource type
- Additional
Data Dictionary<string, string> Additional data regarding the assessment
- Metadata
Pulumi.
Azure Native. Security. Outputs. Security Assessment Metadata Properties Response Describes properties of an assessment metadata.
- Partners
Data Pulumi.Azure Native. Security. Outputs. Security Assessment Partner Data Response Data regarding 3rd party partner integration
- Display
Name string User friendly display name of the assessment
- Id string
Resource Id
- Links
Assessment
Links Response Links relevant to the assessment
- Name string
Resource name
- Resource
Details AzureResource | OnDetails Response Premise | OnResource Details Response Premise Sql Resource Details Response Details of the resource that was assessed
- Status
Assessment
Status Response The result of the assessment
- Type string
Resource type
- Additional
Data map[string]string Additional data regarding the assessment
- Metadata
Security
Assessment Metadata Properties Response Describes properties of an assessment metadata.
- Partners
Data SecurityAssessment Partner Data Response Data regarding 3rd party partner integration
- display
Name String User friendly display name of the assessment
- id String
Resource Id
- links
Assessment
Links Response Links relevant to the assessment
- name String
Resource name
- resource
Details AzureResource | OnDetails Response Premise | OnResource Details Response Premise Sql Resource Details Response Details of the resource that was assessed
- status
Assessment
Status Response The result of the assessment
- type String
Resource type
- additional
Data Map<String,String> Additional data regarding the assessment
- metadata
Security
Assessment Metadata Properties Response Describes properties of an assessment metadata.
- partners
Data SecurityAssessment Partner Data Response Data regarding 3rd party partner integration
- display
Name string User friendly display name of the assessment
- id string
Resource Id
- links
Assessment
Links Response Links relevant to the assessment
- name string
Resource name
- resource
Details AzureResource | OnDetails Response Premise | OnResource Details Response Premise Sql Resource Details Response Details of the resource that was assessed
- status
Assessment
Status Response The result of the assessment
- type string
Resource type
- additional
Data {[key: string]: string} Additional data regarding the assessment
- metadata
Security
Assessment Metadata Properties Response Describes properties of an assessment metadata.
- partners
Data SecurityAssessment Partner Data Response Data regarding 3rd party partner integration
- display_
name str User friendly display name of the assessment
- id str
Resource Id
- links
Assessment
Links Response Links relevant to the assessment
- name str
Resource name
- resource_
details AzureResource | OnDetails Response Premise | OnResource Details Response Premise Sql Resource Details Response Details of the resource that was assessed
- status
Assessment
Status Response The result of the assessment
- type str
Resource type
- additional_
data Mapping[str, str] Additional data regarding the assessment
- metadata
Security
Assessment Metadata Properties Response Describes properties of an assessment metadata.
- partners_
data SecurityAssessment Partner Data Response Data regarding 3rd party partner integration
- display
Name String User friendly display name of the assessment
- id String
Resource Id
- links Property Map
Links relevant to the assessment
- name String
Resource name
- resource
Details 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
- additional
Data Map<String> Additional data regarding the assessment
- metadata Property Map
Describes properties of an assessment metadata.
- partners
Data Property Map Data regarding 3rd party partner integration
Supporting Types
AssessmentLinksResponse
- Azure
Portal stringUri Link to assessment in Azure Portal
- Azure
Portal stringUri Link to assessment in Azure Portal
- azure
Portal StringUri Link to assessment in Azure Portal
- azure
Portal stringUri Link to assessment in Azure Portal
- azure_
portal_ struri Link to assessment in Azure Portal
- azure
Portal StringUri Link to assessment in Azure Portal
AssessmentStatusResponse
- Code string
Programmatic code for the status of the assessment
- 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
- 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
- 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
- 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
- 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
- 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
- Machine
Name string The name of the machine
- Source
Computer stringId The oms agent Id installed on the machine
- Vmuuid string
The unique Id of the machine
- Workspace
Id string Azure resource Id of the workspace the machine is attached to
- Machine
Name string The name of the machine
- Source
Computer stringId The oms agent Id installed on the machine
- Vmuuid string
The unique Id of the machine
- Workspace
Id string Azure resource Id of the workspace the machine is attached to
- machine
Name String The name of the machine
- source
Computer StringId The oms agent Id installed on the machine
- vmuuid String
The unique Id of the machine
- workspace
Id String Azure resource Id of the workspace the machine is attached to
- machine
Name string The name of the machine
- source
Computer stringId The oms agent Id installed on the machine
- vmuuid string
The unique Id of the machine
- workspace
Id string Azure resource Id of the workspace the machine is attached to
- machine_
name str The name of the machine
- source_
computer_ strid 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
- machine
Name String The name of the machine
- source
Computer StringId The oms agent Id installed on the machine
- vmuuid String
The unique Id of the machine
- workspace
Id String Azure resource Id of the workspace the machine is attached to
OnPremiseSqlResourceDetailsResponse
- Database
Name string The Sql database name installed on the machine
- Machine
Name string The name of the machine
- Server
Name string The Sql server name installed on the machine
- Source
Computer stringId The oms agent Id installed on the machine
- Vmuuid string
The unique Id of the machine
- Workspace
Id string Azure resource Id of the workspace the machine is attached to
- Database
Name string The Sql database name installed on the machine
- Machine
Name string The name of the machine
- Server
Name string The Sql server name installed on the machine
- Source
Computer stringId The oms agent Id installed on the machine
- Vmuuid string
The unique Id of the machine
- Workspace
Id string Azure resource Id of the workspace the machine is attached to
- database
Name String The Sql database name installed on the machine
- machine
Name String The name of the machine
- server
Name String The Sql server name installed on the machine
- source
Computer StringId The oms agent Id installed on the machine
- vmuuid String
The unique Id of the machine
- workspace
Id String Azure resource Id of the workspace the machine is attached to
- database
Name string The Sql database name installed on the machine
- machine
Name string The name of the machine
- server
Name string The Sql server name installed on the machine
- source
Computer stringId The oms agent Id installed on the machine
- vmuuid string
The unique Id of the machine
- workspace
Id 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_ strid 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
- database
Name String The Sql database name installed on the machine
- machine
Name String The name of the machine
- server
Name String The Sql server name installed on the machine
- source
Computer StringId The oms agent Id installed on the machine
- vmuuid String
The unique Id of the machine
- workspace
Id String Azure resource Id of the workspace the machine is attached to
SecurityAssessmentMetadataPartnerDataResponse
- Partner
Name string Name of the company of the partner
- Secret string
Secret to authenticate the partner and verify it created the assessment - write only
- Product
Name string Name of the product of the partner that created the assessment
- Partner
Name string Name of the company of the partner
- Secret string
Secret to authenticate the partner and verify it created the assessment - write only
- Product
Name string Name of the product of the partner that created the assessment
- partner
Name String Name of the company of the partner
- secret String
Secret to authenticate the partner and verify it created the assessment - write only
- product
Name String Name of the product of the partner that created the assessment
- partner
Name string Name of the company of the partner
- secret string
Secret to authenticate the partner and verify it created the assessment - write only
- product
Name 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
- partner
Name String Name of the company of the partner
- secret String
Secret to authenticate the partner and verify it created the assessment - write only
- product
Name String Name of the product of the partner that created the assessment
SecurityAssessmentMetadataPropertiesResponse
- Assessment
Type string BuiltIn if the assessment based on built-in Azure Policy definition, Custom if the assessment based on custom Azure Policy definition
- Display
Name string User friendly display name of the assessment
- Policy
Definition stringId 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
- Implementation
Effort string The implementation effort required to remediate this assessment
- Partner
Data Pulumi.Azure Native. Security. Inputs. Security Assessment Metadata Partner Data Response Describes the partner that created the assessment
- Preview bool
True if this assessment is in preview release status
- Remediation
Description string Human readable description of what you should do to mitigate this security issue
- Threats List<string>
- User
Impact string The user impact of the assessment
- Assessment
Type string BuiltIn if the assessment based on built-in Azure Policy definition, Custom if the assessment based on custom Azure Policy definition
- Display
Name string User friendly display name of the assessment
- Policy
Definition stringId 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
- Implementation
Effort string The implementation effort required to remediate this assessment
- Partner
Data SecurityAssessment Metadata Partner Data Response Describes the partner that created the assessment
- Preview bool
True if this assessment is in preview release status
- Remediation
Description string Human readable description of what you should do to mitigate this security issue
- Threats []string
- User
Impact string The user impact of the assessment
- assessment
Type String BuiltIn if the assessment based on built-in Azure Policy definition, Custom if the assessment based on custom Azure Policy definition
- display
Name String User friendly display name of the assessment
- policy
Definition StringId 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
- implementation
Effort String The implementation effort required to remediate this assessment
- partner
Data SecurityAssessment Metadata Partner Data Response Describes the partner that created the assessment
- preview Boolean
True if this assessment is in preview release status
- remediation
Description String Human readable description of what you should do to mitigate this security issue
- threats List<String>
- user
Impact String The user impact of the assessment
- assessment
Type string BuiltIn if the assessment based on built-in Azure Policy definition, Custom if the assessment based on custom Azure Policy definition
- display
Name string User friendly display name of the assessment
- policy
Definition stringId 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
- implementation
Effort string The implementation effort required to remediate this assessment
- partner
Data SecurityAssessment Metadata Partner Data Response Describes the partner that created the assessment
- preview boolean
True if this assessment is in preview release status
- remediation
Description string Human readable description of what you should do to mitigate this security issue
- threats string[]
- user
Impact 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_ strid 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 SecurityAssessment Metadata Partner Data Response 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
- assessment
Type String BuiltIn if the assessment based on built-in Azure Policy definition, Custom if the assessment based on custom Azure Policy definition
- display
Name String User friendly display name of the assessment
- policy
Definition StringId 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
- implementation
Effort String The implementation effort required to remediate this assessment
- partner
Data Property Map Describes the partner that created the assessment
- preview Boolean
True if this assessment is in preview release status
- remediation
Description String Human readable description of what you should do to mitigate this security issue
- threats List<String>
- user
Impact String The user impact of the assessment
SecurityAssessmentPartnerDataResponse
- Partner
Name string Name of the company of the partner
- Secret string
secret to authenticate the partner - write only
- Partner
Name string Name of the company of the partner
- Secret string
secret to authenticate the partner - write only
- partner
Name String Name of the company of the partner
- secret String
secret to authenticate the partner - write only
- partner
Name 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
- partner
Name 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