New-AzPurviewScan
Creates an instance of a scan
Syntax
Default (Default)
New-AzPurviewScan
-Endpoint <String>
-DataSourceName <String>
-Name <String>
-Body <IScan>
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Creates an instance of a scan
Examples
Example 1: Create a scan instance under a data source
$obj = New-AzPurviewAzureStorageCredentialScanObject -Kind 'AzureStorageCredential' -CollectionReferenceName 'parv-brs-2' -CollectionType 'CollectionReference' -CredentialReferenceName 'datascantestdataparv-accountkey' -CredentialType 'AccountKey' -ScanRulesetName 'AzureStorage' -ScanRulesetType 'System'
New-AzPurviewScan -Endpoint 'https://parv-brs-2.purview.azure.com/' -DataSourceName 'DataScanTestData-Parv' -Name 'ScanTest' -Body $obj
CollectionLastModifiedAt : 2/15/2022 3:49:23 PM
CollectionReferenceName : parv-brs-2
CollectionType : CollectionReference
ConnectedViaReferenceName :
CreatedAt : 2/15/2022 3:49:23 PM
CredentialReferenceName : datascantestdataparv-accountkey
CredentialType : AccountKey
Id : datasources/DataScanTestData-Parv/scans/ScanTest
Kind : AzureStorageCredential
LastModifiedAt : 2/15/2022 11:46:29 PM
Name : ScanTest
Result :
ScanRulesetName : AzureStorage
ScanRulesetType : System
Worker :
Create a scan instance 'ScanTest' under data source
Parameters
-Body
.
To construct, see NOTES section for BODY properties and create a hash table.
Parameter properties
Type: IScan
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DataSourceName
.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The DefaultProfile parameter is not functional.
Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
Parameter properties
Type: PSObject
Default value: None Supports wildcards: False DontShow: False Aliases: AzureRMContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Endpoint
The scanning endpoint of your purview account.
Example: https://{accountName}.purview.azure.com
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Name
.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: ScanName
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs