C# Class Microsoft.Azure.Commands.ResourceManager.Cmdlets.Implementation.ResourceManagerCmdletBase

The base class for resource manager cmdlets.

Inheritance: Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet

Mostra file Open project: Azure/azure-powershell

Private Properties

Property	Type	Description
DisposeOfCancellationSource	void
GetCmdletHeaders	string>.Dictionary
GetLongRunningOperationTracker	Microsoft.Azure.Commands.ResourceManager.Cmdlets.Components.LongRunningOperationHelper
HandleException	void

Public Methods

Method	Description
DetermineParameterSetName ( ) : string	Determines the parameter set name.
ExecuteCmdlet ( ) : void	The `ProcessRecord` method.
GetResourcesClient ( ) : ResourceManagerRestRestClient	Gets a new instance of the ResourceManagerRestRestClient.

Protected Methods

Method	Description
BeginProcessing ( ) : void	The `BeginProcessing` method.
DetermineApiVersion ( string resourceId, bool pre = null ) : Task	Determines the API version.
DetermineApiVersion ( string providerNamespace, string resourceType, bool pre = null ) : Task	Determines the API version.
EndProcessing ( ) : void	The `EndProcessing` method.
OnBeginProcessing ( ) : void	When overridden, allows child classes to be called when the `BeginProcessing` method is invoked.
OnEndProcessing ( ) : void	When overridden, allows child classes to be called when the `EndProcessing` method is invoked.
OnProcessRecord ( ) : void	When overridden, allows child classes to be called when the `ProcessRecord` method is invoked.
OnStopProcessing ( ) : void	When overridden, allows child classes to be called when the `StopProcessing` method is invoked.
StopProcessing ( ) : void	The `StopProcessing` method.
TryConvertAndWriteObject ( string resultString ) : void	Writes the object
TryConvertToResourceAndWriteObject ( string resultString ) : void	Writes the object
WriteObject ( JToken result ) : void	Writes a JToken object as a PSObject.

Private Methods

Method	Description
DisposeOfCancellationSource ( ) : void	Disposes of the CancellationTokenSource.
GetCmdletHeaders ( ) : string>.Dictionary
GetLongRunningOperationTracker ( string activityName, bool isResourceCreateOrUpdate ) : LongRunningOperationHelper	Gets a new instance of the long running operation helper.
HandleException ( ExceptionDispatchInfo capturedException ) : void	Provides specialized exception handling.

Method Details

BeginProcessing() protected method

The BeginProcessing method.

protected BeginProcessing ( ) : void
return	void

DetermineApiVersion() protected method

Determines the API version.

protected DetermineApiVersion ( string resourceId, bool pre = null ) : Task
resourceId	string	The resource Id.
pre	bool	When specified, indicates if pre-release API versions should be considered.
return	Task

DetermineApiVersion() protected method

Determines the API version.

protected DetermineApiVersion ( string providerNamespace, string resourceType, bool pre = null ) : Task
providerNamespace	string	The provider namespace.
resourceType	string	The resource type.
pre	bool	When specified, indicates if pre-release API versions should be considered.
return	Task

DetermineParameterSetName() public method

Determines the parameter set name.

public DetermineParameterSetName ( ) : string
return	string

EndProcessing() protected method

The EndProcessing method.

protected EndProcessing ( ) : void
return	void

ExecuteCmdlet() public method

The ProcessRecord method.

public ExecuteCmdlet ( ) : void
return	void

GetResourcesClient() public method

Gets a new instance of the ResourceManagerRestRestClient.

public GetResourcesClient ( ) : ResourceManagerRestRestClient
return	ResourceManagerRestRestClient

OnBeginProcessing() protected method

When overridden, allows child classes to be called when the BeginProcessing method is invoked.

protected OnBeginProcessing ( ) : void
return	void

OnEndProcessing() protected method

When overridden, allows child classes to be called when the EndProcessing method is invoked.

protected OnEndProcessing ( ) : void
return	void

OnProcessRecord() protected method

When overridden, allows child classes to be called when the ProcessRecord method is invoked.

protected OnProcessRecord ( ) : void
return	void

OnStopProcessing() protected method

When overridden, allows child classes to be called when the StopProcessing method is invoked.

protected OnStopProcessing ( ) : void
return	void

StopProcessing() protected method

The StopProcessing method.

protected StopProcessing ( ) : void
return	void

TryConvertAndWriteObject() protected method

Writes the object

protected TryConvertAndWriteObject ( string resultString ) : void
resultString	string	The result as a string
return	void

TryConvertToResourceAndWriteObject() protected method

Writes the object

protected TryConvertToResourceAndWriteObject ( string resultString ) : void
resultString	string	The result as a string
return	void

WriteObject() protected method

Writes a JToken object as a PSObject.

protected WriteObject ( JToken result ) : void
result	JToken	The result of the action.
return	void