New-SCAScanEntityDefinition
SYNOPSIS
Defines a cloud entity to scan
SYNTAX
New-SCAScanEntityDefinition [-account_id] <String> [[-org_id] <String>] [[-Definition] <PSObject[]>]
[<CommonParameters>]
DESCRIPTION
Returns an entity definition object for use with the -entityIds parameter of Start-SCAScan, identifying a specific account, project or subscription to scan.
Pass the output of a previous call as -Definition to scan several entities in one request.
EXAMPLES
Example 1
New-SCAScanEntityDefinition -account_id '123456789012'
Defines a standalone AWS account to scan.
Example 2
$Entities = New-SCAScanEntityDefinition -org_id '098765432109' -account_id '123456789012'
$Entities = New-SCAScanEntityDefinition -Definition $Entities -org_id '098765432109' -account_id '210987654321'
Start-SCAScan -cloudProvider AWS -accountType Specific -entityIds $Entities
Chains two accounts in an AWS organization together, and scans both.
PARAMETERS
-Definition
Accepts previous output from New-SCAScanEntityDefinition, to which this entity is appended.
Type: PSObject[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-account_id
The ID of the workspace to scan.
AWS: the AWS account ID.
Azure resource: the subscription ID.
Azure - Microsoft Entra ID: the Azure tenant ID.
Google Cloud: the project ID.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-org_id
The ID of the organization the workspace belongs to. Not required for a standalone AWS account.
AWS: the management account ID.
Azure: the Azure tenant ID.
Google Cloud: the Google Cloud organization ID.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.