Share via


BuildAzureSqlDatabaseDataMaskingRule Class

Definition

Base for creation and update of data masking rule.

public abstract class BuildAzureSqlDatabaseDataMaskingRule : Microsoft.Azure.Commands.Sql.DataMasking.Cmdlet.SqlDatabaseDataMaskingRuleCmdletBase
type BuildAzureSqlDatabaseDataMaskingRule = class
    inherit SqlDatabaseDataMaskingRuleCmdletBase
Public MustInherit Class BuildAzureSqlDatabaseDataMaskingRule
Inherits SqlDatabaseDataMaskingRuleCmdletBase
Inheritance

Constructors

BuildAzureSqlDatabaseDataMaskingRule()

Fields

_adalListener (Inherited from AzurePSCmdlet)
_clientRequestId (Inherited from AzurePSCmdlet)
_fileTimeStampSuffixFormat (Inherited from AzurePSCmdlet)
_metricHelper (Inherited from AzurePSCmdlet)
_qosEvent (Inherited from AzurePSCmdlet)
_serviceClientTracingInterceptor (Inherited from AzureRMCmdlet)
AUX_HEADER_NAME (Inherited from AzureRMCmdlet)
AUX_TOKEN_APPEND_CHAR (Inherited from AzureRMCmdlet)
AUX_TOKEN_PREFIX (Inherited from AzureRMCmdlet)
EnqueueDebugKey (Inherited from AzureRMCmdlet)
MAX_NUMBER_OF_TOKENS_ALLOWED_IN_AUX_HEADER (Inherited from AzureRMCmdlet)
WriteDebugKey (Inherited from AzureRMCmdlet)
WriteInformationKey (Inherited from AzureRMCmdlet)
WriteVerboseKey (Inherited from AzureRMCmdlet)
WriteWarningKey (Inherited from AzureRMCmdlet)

Properties

_dataCollectionProfile (Inherited from AzurePSCmdlet)
_matchers (Inherited from AzurePSCmdlet)
AsJobDynamicParameters (Inherited from AzurePSCmdlet)
ColumnName

Gets or sets the column name

(Inherited from SqlDatabaseDataMaskingRuleCmdletBase)
DatabaseName

Gets or sets the name of the database to use.

(Inherited from AzureSqlDatabaseCmdletBase<M,A>)
DataCollectionWarning (Inherited from AzureRMCmdlet)
DebugMessages (Inherited from AzurePSCmdlet)
DefaultContext (Inherited from AzureRMCmdlet)
DefaultProfile (Inherited from AzureRMCmdlet)
ImplementationBackgroundJobDescription (Inherited from AzurePSCmdlet)
IsErrorMetricEnabled (Inherited from AzurePSCmdlet)
IsUsageMetricEnabled (Inherited from AzurePSCmdlet)
MaskingFunction

Gets or sets the masking function - the definition of this property as a cmdlet parameter is done in the subclasses

ModelAdapter

The ModelAdapter object used by this cmdlet

(Inherited from AzureSqlCmdletBase<M,A>)
ModuleName (Inherited from AzurePSCmdlet)
ModuleVersion (Inherited from AzurePSCmdlet)
NumberFrom

Gets or sets the NumberFrom property, which is the lower bound of the random interval when using the number masking function

NumberTo

Gets or sets the NumberTo property, which is the upper bound of the random interval when using the number masking function

PassThru

Defines whether the cmdlets will output the model object at the end of its execution

PrefixSize

Gets or sets the prefix size when using the text masking function

PSVersion
Obsolete.
(Inherited from AzurePSCmdlet)
ReplacementString

Gets or sets the replacement string when using the text masking function

ResourceGroupName

Gets or sets the name of the resource group to use.

(Inherited from AzureSqlCmdletBase<M,A>)
SchemaName

Gets or sets the schema name

(Inherited from SqlDatabaseDataMaskingRuleCmdletBase)
ServerName

Gets or sets the name of the database server to use.

(Inherited from AzureSqlDatabaseCmdletBase<M,A>)
SessionState (Inherited from AzurePSCmdlet)
SuffixSize

Gets or sets the suffix size when using the text masking function

TableName

Gets or sets the table name

(Inherited from SqlDatabaseDataMaskingRuleCmdletBase)

Methods

AddDebuggingFilter(Regex) (Inherited from AzurePSCmdlet)
ApplyUserInputToModel(IEnumerable<DatabaseDataMaskingRuleModel>)

Updates the given model element with the cmdlet specific operation

ApplyUserInputToModel(M)

Updates the given model element with the cmdlet specific operation

(Inherited from AzureSqlCmdletBase<M,A>)
BeginProcessing() (Inherited from AzureRMCmdlet)
CheckIfInteractive() (Inherited from AzurePSCmdlet)
ConfirmAction(Boolean, String, String, String, Action) (Inherited from AzureRMCmdlet)
ConfirmAction(Boolean, String, String, String, Action, Func<Boolean>) (Inherited from AzurePSCmdlet)
ConfirmAction(String, String, Action) (Inherited from AzurePSCmdlet)
ConfirmResourceAction(String, Boolean, String, String, Action, Func<Boolean>) (Inherited from AzureRMCmdlet)
ConfirmResourceAction(String, String, Action) (Inherited from AzureRMCmdlet)
ConfirmResourceAction(String, String, String, Boolean, String, String, Action, Func<Boolean>) (Inherited from AzureRMCmdlet)
ConfirmResourceAction(String, String, String, String, Action) (Inherited from AzureRMCmdlet)
ConstructPSObject(String, Object[]) (Inherited from AzurePSCmdlet)
CurrentPath() (Inherited from AzurePSCmdlet)
Dispose() (Inherited from AzurePSCmdlet)
Dispose(Boolean) (Inherited from AzureRMCmdlet)
EndProcessing() (Inherited from AzurePSCmdlet)
ExecuteCmdlet()

Executes the cmdlet

(Inherited from AzureSqlCmdletBase<M,A>)
FlushInitializationWarnings() (Inherited from AzurePSCmdlet)
GetAuxilaryAuthHeaderFromResourceIds(List<String>) (Inherited from AzureRMCmdlet)
GetAuxiliaryAuthHeaderFromTenantIds(IEnumerable<String>) (Inherited from AzureRMCmdlet)
GetConfirmActionProcessMessage() (Inherited from AzureSqlCmdletBase<M,A>)
GetDynamicParameters() (Inherited from AzureRMCmdlet)
GetEntity()

Provides the model element that this cmdlet operates on

(Inherited from SqlDatabaseDataMaskingRuleCmdletBase)
GetResourceId(M) (Inherited from AzureSqlCmdletBase<M,A>)
GetRule(IEnumerable<DatabaseDataMaskingRuleModel>)

Returns the rule that this cmdlet operates on

InitDebuggingFilter() (Inherited from AzurePSCmdlet)
InitializeQosEvent() (Inherited from AzureRMCmdlet)
InitModelAdapter()

Creation and initialization of the ModelAdapter object

(Inherited from SqlDatabaseDataMaskingRuleCmdletBase)
InitModelAdapter(IAzureSubscription) (Inherited from SqlDatabaseDataMaskingRuleCmdletBase)
IsDataCollectionAllowed() (Inherited from AzurePSCmdlet)
IsModelOfRule(BaseDataMaskingRuleModel)

Checks whether the model of the current cmdlet is the same as the model of the given rule

(Inherited from SqlDatabaseDataMaskingRuleCmdletBase)
IsTerminatingError(Exception) (Inherited from AzurePSCmdlet)
IsVerbose() (Inherited from AzurePSCmdlet)
LoadModuleVersion(String, Boolean) (Inherited from AzurePSCmdlet)
LogCmdletEndInvocationInfo() (Inherited from AzureRMCmdlet)
LogCmdletStartInvocationInfo() (Inherited from AzureRMCmdlet)
LogQosEvent() (Inherited from AzurePSCmdlet)
PersistChanges(IEnumerable<DatabaseDataMaskingRuleModel>)

This method is responsible to call the right API in the communication layer that will eventually send the information in the object to the REST endpoint

PersistChanges(M)

This method is responsible to call the right API in the communication layer that will eventually send the information in the object to the REST endpoint

(Inherited from AzureSqlCmdletBase<M,A>)
ProcessRecord() (Inherited from AzurePSCmdlet)
RegisterDynamicParameters(RuntimeDefinedParameterDictionary) (Inherited from AzurePSCmdlet)
RequireDefaultContext() (Inherited from AzureRMCmdlet)
ResolveUserPath(String) (Inherited from AzurePSCmdlet)
ResolveUserPath(String[]) (Inherited from AzurePSCmdlet)
SafeWriteOutputPSObject(String, Object[]) (Inherited from AzurePSCmdlet)
SetBackgroundJobDescription(String) (Inherited from AzurePSCmdlet)
SetupDebuggingTraces() (Inherited from AzureRMCmdlet)
SetupHttpClientPipeline() (Inherited from AzurePSCmdlet)
ShouldGetByName(String, String) (Inherited from AzureRMCmdlet)
ShouldListByResourceGroup(String, String) (Inherited from AzureRMCmdlet)
ShouldListBySubscription(String, String) (Inherited from AzureRMCmdlet)
SubResourceWildcardFilter<T>(String, IEnumerable<T>) (Inherited from AzureRMCmdlet)
TearDownDebuggingTraces() (Inherited from AzureRMCmdlet)
TearDownHttpClientPipeline() (Inherited from AzurePSCmdlet)
ThrowTerminatingError(ErrorRecord) (Inherited from AzurePSCmdlet)
TopLevelWildcardFilter<T>(String, String, IEnumerable<T>) (Inherited from AzureRMCmdlet)
TransformModelToOutputObject(IEnumerable<DatabaseDataMaskingRuleModel>)

The model is a list of rules. This method would return the specific rule that was updated

(Inherited from SqlDatabaseDataMaskingRuleCmdletBase)
TransformModelToOutputObject(M)

Transforms the given model object to be an object that is written out

(Inherited from AzureSqlCmdletBase<M,A>)
TryGetDefaultContext(IAzureContext) (Inherited from AzureRMCmdlet)
UpdateRule(DatabaseDataMaskingRuleModel)

Update the rule this cmdlet is operating on based on the values provided by the user

UpdateRuleList(IEnumerable<DatabaseDataMaskingRuleModel>, DatabaseDataMaskingRuleModel)

Update the rule that this cmdlet operates on based on the user provided values

ValidateOperation(IEnumerable<DatabaseDataMaskingRuleModel>)

An additional validation hook for inheriting classes to provide specific validation.

WriteCommandDetail(String) (Inherited from AzurePSCmdlet)
WriteDebug(String) (Inherited from AzurePSCmdlet)
WriteDebugWithTimestamp(String) (Inherited from AzurePSCmdlet)
WriteDebugWithTimestamp(String, Object[]) (Inherited from AzurePSCmdlet)
WriteError(ErrorRecord) (Inherited from AzurePSCmdlet)
WriteErrorWithTimestamp(String) (Inherited from AzurePSCmdlet)
WriteExceptionError(Exception) (Inherited from AzurePSCmdlet)
WriteInformation(Object, String[]) (Inherited from AzurePSCmdlet)
WriteInformation(String, Nullable<Boolean>) (Inherited from AzurePSCmdlet)
WriteInformationWithTimestamp(String) (Inherited from AzurePSCmdlet)
WriteInitializationWarnings(String) (Inherited from AzurePSCmdlet)
WriteObject(Object) (Inherited from AzurePSCmdlet)
WriteObject(Object, Boolean) (Inherited from AzurePSCmdlet)
WriteProgress(ProgressRecord) (Inherited from AzurePSCmdlet)
WriteResult()

Returns true if the model object that was constructed by this cmdlet should be written out

WriteSurvey() (Inherited from AzurePSCmdlet)
WriteVerbose(String) (Inherited from AzurePSCmdlet)
WriteVerboseWithTimestamp(String) (Inherited from AzurePSCmdlet)
WriteVerboseWithTimestamp(String, Object[]) (Inherited from AzurePSCmdlet)
WriteWarning(String) (Inherited from AzurePSCmdlet)
WriteWarningWithTimestamp(String) (Inherited from AzurePSCmdlet)

Extension Methods

DisableDataCollection(AzurePSCmdlet)
EnableDataCollection(AzurePSCmdlet)

Applies to