AzureSqlElasticJobTargetCmdletBase<TInputObject> Class

Definition

Namespace:

Microsoft.Azure.Commands.Sql.ElasticJobs.Cmdlet

Assembly:

Microsoft.Azure.PowerShell.Cmdlets.Sql.dll

The elastic job target cmdlet base

public abstract class AzureSqlElasticJobTargetCmdletBase<TInputObject> : Microsoft.Azure.Commands.Sql.Common.AzureSqlElasticJobsCmdletBase<TInputObject,System.Collections.Generic.IEnumerable<Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobTargetModel>,Microsoft.Azure.Commands.Sql.ElasticJobs.Services.AzureSqlElasticJobAdapter>

type AzureSqlElasticJobTargetCmdletBase<'InputObject> = class
    inherit AzureSqlElasticJobsCmdletBase<'InputObject, seq<AzureSqlElasticJobTargetModel>, AzureSqlElasticJobAdapter>

Public MustInherit Class AzureSqlElasticJobTargetCmdletBase(Of TInputObject)
Inherits AzureSqlElasticJobsCmdletBase(Of TInputObject, IEnumerable(Of AzureSqlElasticJobTargetModel), AzureSqlElasticJobAdapter)

Type Parameters

TInputObject

The input object model

Inheritance

PSCmdlet

AzurePSCmdlet

AzureRMCmdlet

AzureSqlCmdletBase<TModel,TAdapter>

AzureSqlElasticJobsCmdletBase<TInputObject,IEnumerable<AzureSqlElasticJobTargetModel>,AzureSqlElasticJobAdapter>

AzureSqlElasticJobTargetCmdletBase<TInputObject>

Constructors

AzureSqlElasticJobTargetCmdletBase<TInputObject>()

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)
DefaultParameterSet	Common parameter sets (Inherited from AzureSqlElasticJobsCmdletBase<TInputObject,TModel,TAdapter>)
DefaultSqlDatabaseSet	Parameter sets name for default target group db, server, elastic pool, and shard map
DefaultSqlServerOrElasticPoolSet
DefaultSqlShardMapSet
EnqueueDebugKey	(Inherited from AzureRMCmdlet)
ExistingTargets	The existing targets
InputObjectParameterSet	(Inherited from AzureSqlElasticJobsCmdletBase<TInputObject,TModel,TAdapter>)
MAX_NUMBER_OF_TOKENS_ALLOWED_IN_AUX_HEADER	(Inherited from AzureRMCmdlet)
NeedsUpdate	Flag to determine whether an update to targets in target group is needed in this powershell session
ParentResourceIdSqlDatabaseSet	Parameter sets for target group resource id db, server, pool, and shard map
ParentResourceIdSqlServerOrElasticPoolSet
ParentResourceIdSqlShardMapSet
ResourceIdParameterSet	(Inherited from AzureSqlElasticJobsCmdletBase<TInputObject,TModel,TAdapter>)
Target	The target in question
TargetGroupObjectSqlDatabaseSet	Parameter sets for target group object db, server, elastic pool, and shard map
TargetGroupObjectSqlServerOrElasticPoolSet
TargetGroupObjectSqlShardMapSet
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)
AgentName	Gets or sets the name of the agent
AgentServerName	Gets or sets the name of the agent's server name
AsJobDynamicParameters	(Inherited from AzurePSCmdlet)
CredentialName	(Inherited from AzureSqlElasticJobsCmdletBase<TInputObject,TModel,TAdapter>)
DatabaseName	Gets or sets the Target Database Name
DataCollectionWarning	(Inherited from AzureRMCmdlet)
DebugMessages	(Inherited from AzurePSCmdlet)
DefaultContext	(Inherited from AzureRMCmdlet)
DefaultProfile	(Inherited from AzureRMCmdlet)
ElasticPoolName	Gets or sets the Target Elastic Pool Name
Exclude	Gets or sets the switch parameter for whether or not this target will be excluded.
ImplementationBackgroundJobDescription	(Inherited from AzurePSCmdlet)
IsErrorMetricEnabled	(Inherited from AzurePSCmdlet)
IsUsageMetricEnabled	(Inherited from AzurePSCmdlet)
JobExecutionId	(Inherited from AzureSqlElasticJobsCmdletBase<TInputObject,TModel,TAdapter>)
JobName	(Inherited from AzureSqlElasticJobsCmdletBase<TInputObject,TModel,TAdapter>)
ModelAdapter	The ModelAdapter object used by this cmdlet (Inherited from AzureSqlCmdletBase<M,A>)
ModuleName	(Inherited from AzurePSCmdlet)
ModuleVersion	(Inherited from AzurePSCmdlet)
Name	(Inherited from AzureSqlElasticJobsCmdletBase<TInputObject,TModel,TAdapter>)
ParentObject	Gets or sets the target group input object.
ParentResourceId	Gets or sets the target group resource id.
PrivateEndpointName	(Inherited from AzureSqlElasticJobsCmdletBase<TInputObject,TModel,TAdapter>)
PSVersion	Obsolete. (Inherited from AzurePSCmdlet)
RefreshCredentialName	Gets or sets the Refresh Credential Name
ResourceGroupName	Gets or sets the resource group name.
ServerName	Gets or sets the Target Server Name
SessionState	(Inherited from AzurePSCmdlet)
ShardMapName	Gets or sets the Shard Map Name
StepName	(Inherited from AzureSqlElasticJobsCmdletBase<TInputObject,TModel,TAdapter>)
TargetGroupName	Gets or sets the target group name

Methods

AddDebuggingFilter(Regex)	(Inherited from AzurePSCmdlet)
ApplyUserInputToModel(IEnumerable<AzureSqlElasticJobTargetModel>)	Updates the existing list of targets with the new target if it doesn't already exist in the list.
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)
ClearProperties()	Clears target group properties
ConfirmAction(Boolean, String, String, String, Action, Func<Boolean>)	(Inherited from AzurePSCmdlet)
ConfirmAction(Boolean, String, String, String, Action)	(Inherited from AzureRMCmdlet)
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)
CreateCredentialId(String, String, String, String)	Creates the credential id (Inherited from AzureSqlElasticJobsCmdletBase<TInputObject,TModel,TAdapter>)
CreateTargetGroupId(String, String, String, String)	Creates the target group id (Inherited from AzureSqlElasticJobsCmdletBase<TInputObject,TModel,TAdapter>)
CurrentPath()	(Inherited from AzurePSCmdlet)
Dispose()	(Inherited from AzurePSCmdlet)
Dispose(Boolean)	(Inherited from AzureRMCmdlet)
EndProcessing()	(Inherited from AzureRMCmdlet)
ExecuteCmdlet()	Executes the cmdlet (Inherited from AzureSqlCmdletBase<M,A>)
FindTarget()	Does a scan over the list of targets and finds the target's index in the list
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()	Gets the list of existing targets in the target group.
GetPropertyValue(String[], String, Int32)	Helper method to return model property value from resource id (Inherited from AzureSqlElasticJobsCmdletBase<TInputObject,TModel,TAdapter>)
GetPropertyValue(TInputObject, String)	Helper method to return model property from input object model (Inherited from AzureSqlElasticJobsCmdletBase<TInputObject,TModel,TAdapter>)
GetResourceId(M)	(Inherited from AzureSqlCmdletBase<M,A>)
GetTargetType()	Helper for determining based on parameter set what target type this target should be.
InitDebuggingFilter()	(Inherited from AzurePSCmdlet)
InitializeInputObjectProperties(TInputObject)	Initializes the input from model object (Inherited from AzureSqlElasticJobsCmdletBase<TInputObject,TModel,TAdapter>)
InitializeQosEvent()	(Inherited from AzureRMCmdlet)
InitializeResourceIdProperties(String)	Initializes the input from resource id if necessary (Inherited from AzureSqlElasticJobsCmdletBase<TInputObject,TModel,TAdapter>)
InitModelAdapter()	Intializes the model adapter
InitModelAdapter(IAzureSubscription)	(Inherited from AzureSqlCmdletBase<M,A>)
IsDataCollectionAllowed()	(Inherited from AzurePSCmdlet)
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<AzureSqlElasticJobTargetModel>)	Sends the changes to the service -> Creates or updates the target if necessary
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(M)	Transforms the given model object to be an object that is written out (Inherited from AzureSqlCmdletBase<M,A>)
TryGetDefaultContext(IAzureContext)	(Inherited from AzureRMCmdlet)
UpdateExistingTargets()	Abstract method when adding or removing targets
WriteCommandDetail(String)	(Inherited from AzurePSCmdlet)
WriteDebug(String)	(Inherited from AzurePSCmdlet)
WriteDebugWithTimestamp(String, Object[])	(Inherited from AzurePSCmdlet)
WriteDebugWithTimestamp(String)	(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, Boolean)	(Inherited from AzurePSCmdlet)
WriteObject(Object)	(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 (Inherited from AzureSqlCmdletBase<M,A>)
WriteSurvey()	(Inherited from AzurePSCmdlet)
WriteVerbose(String)	(Inherited from AzurePSCmdlet)
WriteVerboseWithTimestamp(String, Object[])	(Inherited from AzurePSCmdlet)
WriteVerboseWithTimestamp(String)	(Inherited from AzurePSCmdlet)
WriteWarning(String)	(Inherited from AzurePSCmdlet)
WriteWarningWithTimestamp(String)	(Inherited from AzurePSCmdlet)

Extension Methods

DisableDataCollection(AzurePSCmdlet)

EnableDataCollection(AzurePSCmdlet)