AzureSqlElasticJobAgentCmdletBase<TInputObject> Class

Definition

Defines the elastic job agent cmdlet base

public abstract class AzureSqlElasticJobAgentCmdletBase<TInputObject> : Microsoft.Azure.Commands.Sql.Common.AzureSqlElasticJobsCmdletBase<TInputObject,System.Collections.Generic.IEnumerable<Microsoft.Azure.Commands.Sql.ElasticJobs.Model.AzureSqlElasticJobAgentModel>,Microsoft.Azure.Commands.Sql.ElasticJobs.Services.AzureSqlElasticJobAdapter>
type AzureSqlElasticJobAgentCmdletBase<'InputObject> = class
    inherit AzureSqlElasticJobsCmdletBase<'InputObject, seq<AzureSqlElasticJobAgentModel>, AzureSqlElasticJobAdapter>
Public MustInherit Class AzureSqlElasticJobAgentCmdletBase(Of TInputObject)
Inherits AzureSqlElasticJobsCmdletBase(Of TInputObject, IEnumerable(Of AzureSqlElasticJobAgentModel), AzureSqlElasticJobAdapter)

Type Parameters

TInputObject

The input object model type

Inheritance

Constructors

AzureSqlElasticJobAgentCmdletBase<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>)
EnqueueDebugKey (Inherited from AzureRMCmdlet)
InputObjectParameterSet (Inherited from AzureSqlElasticJobsCmdletBase<TInputObject,TModel,TAdapter>)
MAX_NUMBER_OF_TOKENS_ALLOWED_IN_AUX_HEADER (Inherited from AzureRMCmdlet)
ResourceIdParameterSet (Inherited from AzureSqlElasticJobsCmdletBase<TInputObject,TModel,TAdapter>)
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

Removing parameter attribute here since we use "Name" as set by powershell standards

AgentServerName (Inherited from AzureSqlElasticJobsCmdletBase<TInputObject,TModel,TAdapter>)
AsJobDynamicParameters (Inherited from AzurePSCmdlet)
CredentialName (Inherited from AzureSqlElasticJobsCmdletBase<TInputObject,TModel,TAdapter>)
DatabaseName (Inherited from AzureSqlElasticJobsCmdletBase<TInputObject,TModel,TAdapter>)
DataCollectionWarning (Inherited from AzureRMCmdlet)
DebugMessages (Inherited from AzurePSCmdlet)
DefaultContext (Inherited from AzureRMCmdlet)
DefaultProfile (Inherited from AzureRMCmdlet)
ElasticPoolName (Inherited from AzureSqlElasticJobsCmdletBase<TInputObject,TModel,TAdapter>)
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>)
PrivateEndpointName (Inherited from AzureSqlElasticJobsCmdletBase<TInputObject,TModel,TAdapter>)
PSVersion
Obsolete.
(Inherited from AzurePSCmdlet)
RefreshCredentialName (Inherited from AzureSqlElasticJobsCmdletBase<TInputObject,TModel,TAdapter>)
ResourceGroupName

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

(Inherited from AzureSqlCmdletBase<M,A>)
ServerName

Common properties

(Inherited from AzureSqlElasticJobsCmdletBase<TInputObject,TModel,TAdapter>)
SessionState (Inherited from AzurePSCmdlet)
ShardMapName (Inherited from AzureSqlElasticJobsCmdletBase<TInputObject,TModel,TAdapter>)
StepName (Inherited from AzureSqlElasticJobsCmdletBase<TInputObject,TModel,TAdapter>)
TargetGroupName (Inherited from AzureSqlElasticJobsCmdletBase<TInputObject,TModel,TAdapter>)

Methods

AddDebuggingFilter(Regex) (Inherited from AzurePSCmdlet)
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 agent 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>)
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 an entity from the service

(Inherited from AzureSqlCmdletBase<M,A>)
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>)
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(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)
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)

Applies to