C# Class Microsoft.Azure.Commands.Batch.Models.BatchClient

Show file Open project: Azure/azure-powershell Class Usage Examples

Private Properties

Property	Type	Description
ActivateApplicationPackage	void
CheckApplicationAllowsUpdates	void
ConvertApplicationPackagesToPsApplicationPackages	IList
ConvertApplicationToPSApplication	PSApplication
ConvertGetApplicationPackageResponseToApplicationPackage	PSApplicationPackage
CopyRDPStream	void
DownloadNodeFileByInstance	void
ExtractResourceGroupName	string
GetGroupForAccount	string
GetGroupForAccountNoThrow	string
GetStorageUrl	string
ListAllAccounts	IEnumerable
ListNextAccounts	IPage
ListNodeFilesByComputeNode	IEnumerable
ListNodeFilesByTask	IEnumerable
UploadFileToApplicationPackage	void
WriteVerbose	void

Public Methods

Method	Description
AddApplication ( string resourceGroupName, string accountName, string applicationId, bool allowUpdates, string displayName ) : PSApplication
AddCertificate ( NewCertificateParameters parameters ) : void	Adds a certificate to the specified Batch account.
AddTaskCollection ( NewBulkTaskParameters parameters ) : void	Adds a collection of tasks
BatchClient ( ) : Microsoft.Azure.Commands.Common.Authentication
BatchClient ( AzureContext context ) : Microsoft.Azure.Commands.Common.Authentication	Creates new BatchClient
BatchClient ( IBatchManagementClient batchManagementClient, IResourceManagementClient resourceManagementClient ) : Microsoft.Azure.Commands.Common.Authentication	Creates new BatchClient instance
CancelDeleteCertificate ( CertificateOperationParameters parameters ) : void	Cancels a failed deletion of the specified certificate.
ChangeOSVersion ( ChangeOSVersionParameters parameters ) : void	Changes the operating system version of the specified pool.
CreateAccount ( string resourceGroupName, string accountName, string location, Hashtable tags, string autoStorageAccountId ) : BatchAccountContext	Creates a new Batch account
CreateComputeNodeUser ( NewComputeNodeUserParameters options ) : void	Creates a new compute node user.
CreateJob ( Microsoft.Azure.Commands.Batch.Models.NewJobParameters parameters ) : void	Creates a new job.
CreateJobSchedule ( NewJobScheduleParameters parameters ) : void	Creates a new job schedule.
CreatePool ( NewPoolParameters parameters ) : void	Creates a new pool.
CreateTask ( NewTaskParameters parameters ) : void	Creates a new task.
DeleteAccount ( string resourceGroupName, string accountName ) : void	Deletes the specified account
DeleteApplication ( string resourceGroupName, string accountName, string applicationId ) : void
DeleteApplicationPackage ( string resourceGroupName, string accountName, string applicationId, string version ) : void
DeleteCertificate ( CertificateOperationParameters parameters ) : void	Deletes the specified certificate.
DeleteComputeNodeUser ( Microsoft.Azure.Commands.Batch.Models.ComputeNodeUserOperationParameters parameters ) : void	Deletes the specified compute node user.
DeleteJob ( BatchAccountContext context, string jobId, IEnumerable additionBehaviors = null ) : void	Deletes the specified job.
DeleteJobSchedule ( BatchAccountContext context, string jobScheduleId, IEnumerable additionBehaviors = null ) : void	Deletes the specified job schedule.
DeleteNodeFile ( bool recursive, NodeFileOperationParameters parameters ) : void	Deletes the specified file from its compute node.
DeletePool ( BatchAccountContext context, string poolId, IEnumerable additionBehaviors = null ) : void	Deletes the specified pool.
DeleteTask ( Microsoft.Azure.Commands.Batch.Models.TaskOperationParameters parameters ) : void	Deletes the specified task.
DisableAutoScale ( Microsoft.Azure.Commands.Batch.Models.PoolOperationParameters parameters ) : void	Disables automatic scaling on the specified pool.
DisableComputeNodeScheduling ( DisableComputeNodeSchedulingParameters parameters ) : void	Disables task scheduling on the specified compute node.
DisableJob ( DisableJobParameters parameters ) : void	Disables the specified job.
DisableJobSchedule ( BatchAccountContext context, string jobScheduleId, IEnumerable additionBehaviors = null ) : void	Disables the specified job schedule.
DownloadNodeFile ( Microsoft.Azure.Commands.Batch.Models.DownloadNodeFileOptions options ) : void	Downloads a node file using the specified options.
DownloadRemoteDesktopProtocolFile ( DownloadRemoteDesktopProtocolFileOptions options ) : void	Downloads a Remote Desktop Protocol file using the specified options.
EnableAutoScale ( EnableAutoScaleParameters parameters ) : void	Enables automatic scaling on the specified pool.
EnableComputeNodeScheduling ( Microsoft.Azure.Commands.Batch.Models.ComputeNodeOperationParameters parameters ) : void	Enables task scheduling on the specified compute node.
EnableJob ( BatchAccountContext context, string jobId, IEnumerable additionBehaviors = null ) : void	Enables the specified job.
EnableJobSchedule ( BatchAccountContext context, string jobScheduleId, IEnumerable additionBehaviors = null ) : void	Enables the specified job schedule.
EvaluateAutoScale ( EvaluateAutoScaleParameters parameters ) : PSAutoScaleRun	Gets the result of evaluating an automatic scaling formula on the specified pool.
GetAccount ( string resourceGroupName, string accountName ) : BatchAccountContext	Get details about the Batch account
GetAllJobsLifetimeStatistics ( BatchAccountContext context, IEnumerable additionalBehaviors = null ) : PSJobStatistics	Gets lifetime summary statistics for all of the jobs in the specified account.
GetAllPoolsLifetimeStatistics ( BatchAccountContext context, IEnumerable additionBehaviors = null ) : PSPoolStatistics	Gets all pools lifetime summary statistics
GetApplication ( string resourceGroupName, string accountName, string applicationId ) : PSApplication
GetApplicationPackage ( string resourceGroupName, string accountName, string applicationId, string version ) : PSApplicationPackage
GetKeys ( string resourceGroupName, string accountName ) : BatchAccountContext	Gets the keys associated with the Batch account
GetLocationQuotas ( string location ) : PSBatchLocationQuotas	Gets the Batch service quotas for the specified subscription at the given region.
ListAccounts ( Hashtable tag, string resourceGroupName = default(string) ) : IEnumerable	Lists all accounts in a subscription or in a resource group if its name is specified
ListApplications ( string resourceGroupName, string accountName ) : IEnumerable
ListCertificates ( Microsoft.Azure.Commands.Batch.Models.ListCertificateOptions options ) : IEnumerable	Lists the certificates matching the specified filter options.
ListComputeNodeRemoteLoginSettings ( Microsoft.Azure.Commands.Batch.Models.ComputeNodeOperationParameters parameters ) : PSRemoteLoginSettings	Get the settings required for remote login to a compute node
ListComputeNodes ( Microsoft.Azure.Commands.Batch.Models.ListComputeNodeOptions options ) : IEnumerable	Lists the compute nodes matching the specified filter options.
ListJobSchedules ( Microsoft.Azure.Commands.Batch.Models.ListJobScheduleOptions options ) : IEnumerable	Lists the job schedules matching the specified filter options.
ListJobs ( ListJobOptions options ) : IEnumerable	Lists the jobs matching the specified filter options.
ListNodeAgentSkus ( BatchAccountContext context, string filterClause = default(string), int maxCount = default(int), IEnumerable additionalBehaviors = null ) : IEnumerable	Lists the node agent SKUs matching the specified filter options.
ListNodeFiles ( ListNodeFileOptions options ) : IEnumerable	Lists the node files matching the specified filter options.
ListPoolUsageMetrics ( ListPoolUsageOptions options ) : IEnumerable	Lists the usage metrics, aggregated by pool across individual time intervals, for the specified account.
ListPools ( Microsoft.Azure.Commands.Batch.Models.ListPoolOptions options ) : IEnumerable	Lists the pools matching the specified filter options.
ListSubtasks ( ListSubtaskOptions options ) : IEnumerable	Lists the subtasks matching the specified filter options.
ListTasks ( Microsoft.Azure.Commands.Batch.Models.ListTaskOptions options ) : IEnumerable	Lists the tasks matching the specified filter options.
ReactivateTask ( Microsoft.Azure.Commands.Batch.Models.TaskOperationParameters parameters ) : void	Reactivates a task, allowing it to run again even if its retry count has been exhausted.
RebootComputeNode ( RebootComputeNodeParameters parameters ) : void	Reboots the specified compute node.
RegenerateKeys ( string resourceGroupName, string accountName, AccountKeyType keyType ) : BatchAccountContext	Generates new key for the Batch account
ReimageComputeNode ( ReimageComputeNodeParameters parameters ) : void	Reinstalls the operating system on the specified compute node.
RemoveComputeNodesFromPool ( RemoveComputeNodeParameters parameters ) : void	Removes the specified compute nodes from the specified pool.
ResizePool ( Microsoft.Azure.Commands.Batch.Models.PoolResizeParameters parameters ) : void	Resizes the specified pool.
StopResizePool ( BatchAccountContext context, string poolId, IEnumerable additionalBehaviors = null ) : void	Stops the resize operation on the specified pool.
TerminateJob ( TerminateJobParameters parameters ) : void	Terminates the specified job.
TerminateJobSchedule ( BatchAccountContext context, string jobScheduleId, IEnumerable additionBehaviors = null ) : void	Terminates the specified job schedule.
TerminateTask ( Microsoft.Azure.Commands.Batch.Models.TaskOperationParameters parameters ) : void	Terminates the specified task.
UpdateAccount ( string resourceGroupName, string accountName, Hashtable tags, string autoStorageAccountId ) : BatchAccountContext	Updates an existing Batch account
UpdateApplication ( string resourceGroupName, string accountName, string applicationId, bool allowUpdates, string defaultVersion, string displayName ) : void
UpdateComputeNodeUser ( UpdateComputeNodeUserParameters parameters ) : void	Updates a compute node user account
UpdateJob ( BatchAccountContext context, PSCloudJob job, IEnumerable additionBehaviors = null ) : void	Commits changes to a PSCloudJob object to the Batch Service.
UpdateJobSchedule ( BatchAccountContext context, PSCloudJobSchedule jobSchedule, IEnumerable additionBehaviors = null ) : void	Commits changes to a PSCloudJobSchedule object to the Batch Service.
UpdatePool ( BatchAccountContext context, PSCloudPool pool, IEnumerable additionBehaviors = null ) : void	Commits changes to a PSCloudPool object to the Batch Service.
UpdateTask ( BatchAccountContext context, PSCloudTask task, IEnumerable additionBehaviors = null ) : void	Commits changes to a PSCloudTask object to the Batch Service.
UploadAndActivateApplicationPackage ( string resourceGroupName, string accountName, string applicationId, string version, string filePath, string format, bool activateOnly ) : PSApplicationPackage

Private Methods

Method	Description
ActivateApplicationPackage ( string resourceGroupName, string accountName, string applicationId, string version, string format, string errorMessageFormat ) : void
CheckApplicationAllowsUpdates ( string resourceGroupName, string accountName, string applicationId, string version ) : void
ConvertApplicationPackagesToPsApplicationPackages ( IEnumerable applicationPackages ) : IList
ConvertApplicationToPSApplication ( Application application ) : PSApplication
ConvertGetApplicationPackageResponseToApplicationPackage ( ApplicationPackage response ) : PSApplicationPackage
CopyRDPStream ( Stream destinationStream, Microsoft client, string poolId, string computeNodeId, PSComputeNode computeNode, IEnumerable additionalBehaviors = null ) : void
DownloadNodeFileByInstance ( Microsoft.Azure.Batch.NodeFile file, string destinationPath, Stream stream, IEnumerable additionalBehaviors = null ) : void
ExtractResourceGroupName ( string id ) : string
GetGroupForAccount ( string accountName ) : string
GetGroupForAccountNoThrow ( string accountName ) : string
GetStorageUrl ( string resourceGroupName, string accountName, string applicationId, string version, bool &didCreateAppPackage ) : string
ListAllAccounts ( IPage response ) : IEnumerable	Appends all accounts into a list.
ListNextAccounts ( string NextLink ) : IPage	Lists all accounts in a subscription or in a resource group if its name is specified
ListNodeFilesByComputeNode ( ListNodeFileOptions options ) : IEnumerable
ListNodeFilesByTask ( ListNodeFileOptions options ) : IEnumerable
UploadFileToApplicationPackage ( string resourceGroupName, string accountName, string applicationId, string version, string filePath, string storageUrl, bool appPackageAlreadyExists ) : void
WriteVerbose ( string message ) : void

Method Details

AddApplication() public method

public AddApplication ( string resourceGroupName, string accountName, string applicationId, bool allowUpdates, string displayName ) : PSApplication
resourceGroupName	string
accountName	string
applicationId	string
allowUpdates	bool
displayName	string
return	PSApplication

AddCertificate() public method

Adds a certificate to the specified Batch account.

public AddCertificate ( NewCertificateParameters parameters ) : void
parameters	NewCertificateParameters	The parameters to use when creating the certificate.
return	void

AddTaskCollection() public method

Adds a collection of tasks

public AddTaskCollection ( NewBulkTaskParameters parameters ) : void
parameters	NewBulkTaskParameters	The parameters to use when creating the tasks.
return	void

BatchClient() public method

public BatchClient ( ) : Microsoft.Azure.Commands.Common.Authentication
return	Microsoft.Azure.Commands.Common.Authentication

BatchClient() public method

Creates new BatchClient

public BatchClient ( AzureContext context ) : Microsoft.Azure.Commands.Common.Authentication
context	AzureContext	Context with subscription containing a batch account to manipulate
return	Microsoft.Azure.Commands.Common.Authentication

BatchClient() public method

Creates new BatchClient instance

public BatchClient ( IBatchManagementClient batchManagementClient, IResourceManagementClient resourceManagementClient ) : Microsoft.Azure.Commands.Common.Authentication
batchManagementClient	IBatchManagementClient	The IBatchManagementClient instance
resourceManagementClient	IResourceManagementClient	The IResourceManagementClient instance
return	Microsoft.Azure.Commands.Common.Authentication

CancelDeleteCertificate() public method

Cancels a failed deletion of the specified certificate.

public CancelDeleteCertificate ( CertificateOperationParameters parameters ) : void
parameters	CertificateOperationParameters	The parameters indicating which certificate to failed to delete.
return	void

ChangeOSVersion() public method

Changes the operating system version of the specified pool.

public ChangeOSVersion ( ChangeOSVersionParameters parameters ) : void
parameters	ChangeOSVersionParameters	The parameters specifying the pool and target OS version.
return	void

CreateAccount() public method

Creates a new Batch account

public CreateAccount ( string resourceGroupName, string accountName, string location, Hashtable tags, string autoStorageAccountId ) : BatchAccountContext
resourceGroupName	string	The name of the resource group in which to create the account
accountName	string	The account name
location	string	The location to use when creating the account
tags	Hashtable	The tags to associate with the account
autoStorageAccountId	string	The resource id of the storage account to be used for auto storage.
return	BatchAccountContext

CreateComputeNodeUser() public method

Creates a new compute node user.

public CreateComputeNodeUser ( NewComputeNodeUserParameters options ) : void
options	NewComputeNodeUserParameters	The options to use when creating the compute node user.
return	void

CreateJob() public method

Creates a new job.

public CreateJob ( Microsoft.Azure.Commands.Batch.Models.NewJobParameters parameters ) : void
parameters	Microsoft.Azure.Commands.Batch.Models.NewJobParameters	The parameters to use when creating the job.
return	void

CreateJobSchedule() public method

Creates a new job schedule.

public CreateJobSchedule ( NewJobScheduleParameters parameters ) : void
parameters	NewJobScheduleParameters	The parameters to use when creating the job schedule.
return	void

CreatePool() public method

Creates a new pool.

public CreatePool ( NewPoolParameters parameters ) : void
parameters	NewPoolParameters	The parameters to use when creating the pool.
return	void

CreateTask() public method

Creates a new task.

public CreateTask ( NewTaskParameters parameters ) : void
parameters	NewTaskParameters	The parameters to use when creating the task.
return	void

DeleteAccount() public method

Deletes the specified account

public DeleteAccount ( string resourceGroupName, string accountName ) : void
resourceGroupName	string	The name of the resource group the account is under. If unspecified, it will be looked up.
accountName	string	The account name
return	void

DeleteApplication() public method

public DeleteApplication ( string resourceGroupName, string accountName, string applicationId ) : void
resourceGroupName	string
accountName	string
applicationId	string
return	void

DeleteApplicationPackage() public method

public DeleteApplicationPackage ( string resourceGroupName, string accountName, string applicationId, string version ) : void
resourceGroupName	string
accountName	string
applicationId	string
version	string
return	void

DeleteCertificate() public method

Deletes the specified certificate.

public DeleteCertificate ( CertificateOperationParameters parameters ) : void
parameters	CertificateOperationParameters	The parameters indicating which certificate to delete.
return	void

DeleteComputeNodeUser() public method

Deletes the specified compute node user.

public DeleteComputeNodeUser ( Microsoft.Azure.Commands.Batch.Models.ComputeNodeUserOperationParameters parameters ) : void
parameters	Microsoft.Azure.Commands.Batch.Models.ComputeNodeUserOperationParameters	The parameters indicating which compute node user to delete.
return	void

DeleteJob() public method

Deletes the specified job.

public DeleteJob ( BatchAccountContext context, string jobId, IEnumerable additionBehaviors = null ) : void
context	BatchAccountContext	The account to use.
jobId	string	The id of the job to delete.
additionBehaviors	IEnumerable	Additional client behaviors to perform.
return	void

DeleteJobSchedule() public method

Deletes the specified job schedule.

public DeleteJobSchedule ( BatchAccountContext context, string jobScheduleId, IEnumerable additionBehaviors = null ) : void
context	BatchAccountContext	The account to use.
jobScheduleId	string	The id of the job schedule to delete.
additionBehaviors	IEnumerable	Additional client behaviors to perform.
return	void

DeleteNodeFile() public method

Deletes the specified file from its compute node.

public DeleteNodeFile ( bool recursive, NodeFileOperationParameters parameters ) : void
recursive	bool	If the file-path parameter represents a directory instead of a file, you can set the optional /// recursive parameter to true to delete the directory and all of the files and subdirectories in it. If recursive is false /// then the directory must be empty or deletion will fail..
parameters	NodeFileOperationParameters	Specifies which node file to delete.
return	void

DeletePool() public method

Deletes the specified pool.

public DeletePool ( BatchAccountContext context, string poolId, IEnumerable additionBehaviors = null ) : void
context	BatchAccountContext	The account to use.
poolId	string	The id of the pool to delete.
additionBehaviors	IEnumerable	Additional client behaviors to perform.
return	void

DeleteTask() public method

Deletes the specified task.

public DeleteTask ( Microsoft.Azure.Commands.Batch.Models.TaskOperationParameters parameters ) : void
parameters	Microsoft.Azure.Commands.Batch.Models.TaskOperationParameters	The parameters indicating which task to delete.
return	void

DisableAutoScale() public method

Disables automatic scaling on the specified pool.

public DisableAutoScale ( Microsoft.Azure.Commands.Batch.Models.PoolOperationParameters parameters ) : void
parameters	Microsoft.Azure.Commands.Batch.Models.PoolOperationParameters	The parameters specifying the target pool.
return	void

DisableComputeNodeScheduling() public method

Disables task scheduling on the specified compute node.

public DisableComputeNodeScheduling ( DisableComputeNodeSchedulingParameters parameters ) : void
parameters	DisableComputeNodeSchedulingParameters	The parameters specifying the compute node.
return	void

DisableJob() public method

Disables the specified job.

public DisableJob ( DisableJobParameters parameters ) : void
parameters	DisableJobParameters	Specifies the job to disable as well as the job disable option.
return	void

DisableJobSchedule() public method

Disables the specified job schedule.

public DisableJobSchedule ( BatchAccountContext context, string jobScheduleId, IEnumerable additionBehaviors = null ) : void
context	BatchAccountContext	The account to use.
jobScheduleId	string	The id of the job schedule to disable.
additionBehaviors	IEnumerable	Additional client behaviors to perform.
return	void

DownloadNodeFile() public method

Downloads a node file using the specified options.

public DownloadNodeFile ( Microsoft.Azure.Commands.Batch.Models.DownloadNodeFileOptions options ) : void
options	Microsoft.Azure.Commands.Batch.Models.DownloadNodeFileOptions	The download options.
return	void

DownloadRemoteDesktopProtocolFile() public method

Downloads a Remote Desktop Protocol file using the specified options.

public DownloadRemoteDesktopProtocolFile ( DownloadRemoteDesktopProtocolFileOptions options ) : void
options	DownloadRemoteDesktopProtocolFileOptions	The download options.
return	void

EnableAutoScale() public method

Enables automatic scaling on the specified pool.

public EnableAutoScale ( EnableAutoScaleParameters parameters ) : void
parameters	EnableAutoScaleParameters	The parameters specifying the pool and autoscale parameters.
return	void

EnableComputeNodeScheduling() public method

Enables task scheduling on the specified compute node.

public EnableComputeNodeScheduling ( Microsoft.Azure.Commands.Batch.Models.ComputeNodeOperationParameters parameters ) : void
parameters	Microsoft.Azure.Commands.Batch.Models.ComputeNodeOperationParameters	The parameters specifying the compute node.
return	void

EnableJob() public method

Enables the specified job.

public EnableJob ( BatchAccountContext context, string jobId, IEnumerable additionBehaviors = null ) : void
context	BatchAccountContext	The account to use.
jobId	string	The id of the job to enable.
additionBehaviors	IEnumerable	Additional client behaviors to perform.
return	void

EnableJobSchedule() public method

Enables the specified job schedule.

public EnableJobSchedule ( BatchAccountContext context, string jobScheduleId, IEnumerable additionBehaviors = null ) : void
context	BatchAccountContext	The account to use.
jobScheduleId	string	The id of the job schedule to enable.
additionBehaviors	IEnumerable	Additional client behaviors to perform.
return	void

EvaluateAutoScale() public method

Gets the result of evaluating an automatic scaling formula on the specified pool.

public EvaluateAutoScale ( EvaluateAutoScaleParameters parameters ) : PSAutoScaleRun
parameters	EvaluateAutoScaleParameters	The parameters specifying the pool and autoscale formula.
return	PSAutoScaleRun

GetAccount() public method

Get details about the Batch account

public GetAccount ( string resourceGroupName, string accountName ) : BatchAccountContext
resourceGroupName	string	The name of the resource group the account is under. If unspecified, it will be looked up.
accountName	string	The account name
return	BatchAccountContext

GetAllJobsLifetimeStatistics() public method

Gets lifetime summary statistics for all of the jobs in the specified account.

public GetAllJobsLifetimeStatistics ( BatchAccountContext context, IEnumerable additionalBehaviors = null ) : PSJobStatistics
context	BatchAccountContext	The account to use.
additionalBehaviors	IEnumerable	Additional client behaviors to perform.
return	PSJobStatistics

GetAllPoolsLifetimeStatistics() public method

Gets all pools lifetime summary statistics

public GetAllPoolsLifetimeStatistics ( BatchAccountContext context, IEnumerable additionBehaviors = null ) : PSPoolStatistics
context	BatchAccountContext	The account to use.
additionBehaviors	IEnumerable	Additional client behaviors to perform.
return	PSPoolStatistics

GetApplication() public method

public GetApplication ( string resourceGroupName, string accountName, string applicationId ) : PSApplication
resourceGroupName	string
accountName	string
applicationId	string
return	PSApplication

GetApplicationPackage() public method

public GetApplicationPackage ( string resourceGroupName, string accountName, string applicationId, string version ) : PSApplicationPackage
resourceGroupName	string
accountName	string
applicationId	string
version	string
return	PSApplicationPackage

GetKeys() public method

Gets the keys associated with the Batch account

public GetKeys ( string resourceGroupName, string accountName ) : BatchAccountContext
resourceGroupName	string	The name of the resource group the account is under. If unspecified, it will be looked up.
accountName	string	The account name
return	BatchAccountContext

GetLocationQuotas() public method

Gets the Batch service quotas for the specified subscription at the given region.

public GetLocationQuotas ( string location ) : PSBatchLocationQuotas
location	string	The desired region for the quotas.
return	PSBatchLocationQuotas

ListAccounts() public method

Lists all accounts in a subscription or in a resource group if its name is specified

public ListAccounts ( Hashtable tag, string resourceGroupName = default(string) ) : IEnumerable
tag	Hashtable	The tag to filter accounts on
resourceGroupName	string	The name of the resource group to search under for accounts. If unspecified, all accounts will be looked up.
return	IEnumerable

ListApplications() public method

public ListApplications ( string resourceGroupName, string accountName ) : IEnumerable
resourceGroupName	string
accountName	string
return	IEnumerable

ListCertificates() public method

Lists the certificates matching the specified filter options.

public ListCertificates ( Microsoft.Azure.Commands.Batch.Models.ListCertificateOptions options ) : IEnumerable
options	Microsoft.Azure.Commands.Batch.Models.ListCertificateOptions	The options to use when querying for certificates.
return	IEnumerable

ListComputeNodeRemoteLoginSettings() public method

Get the settings required for remote login to a compute node

public ListComputeNodeRemoteLoginSettings ( Microsoft.Azure.Commands.Batch.Models.ComputeNodeOperationParameters parameters ) : PSRemoteLoginSettings
parameters	Microsoft.Azure.Commands.Batch.Models.ComputeNodeOperationParameters
return	PSRemoteLoginSettings

ListComputeNodes() public method

Lists the compute nodes matching the specified filter options.

public ListComputeNodes ( Microsoft.Azure.Commands.Batch.Models.ListComputeNodeOptions options ) : IEnumerable
options	Microsoft.Azure.Commands.Batch.Models.ListComputeNodeOptions	The options to use when querying for compute nodes.
return	IEnumerable

ListJobSchedules() public method

Lists the job schedules matching the specified filter options.

public ListJobSchedules ( Microsoft.Azure.Commands.Batch.Models.ListJobScheduleOptions options ) : IEnumerable
options	Microsoft.Azure.Commands.Batch.Models.ListJobScheduleOptions	The options to use when querying for job schedules.
return	IEnumerable

ListJobs() public method

Lists the jobs matching the specified filter options.

public ListJobs ( ListJobOptions options ) : IEnumerable
options	ListJobOptions	The options to use when querying for jobs.
return	IEnumerable

ListNodeAgentSkus() public method

Lists the node agent SKUs matching the specified filter options.

public ListNodeAgentSkus ( BatchAccountContext context, string filterClause = default(string), int maxCount = default(int), IEnumerable additionalBehaviors = null ) : IEnumerable
context	BatchAccountContext	The account to use.
filterClause	string	The level of detail
maxCount	int	The number of results.
additionalBehaviors	IEnumerable	Additional client behaviors to perform.
return	IEnumerable

ListNodeFiles() public method

Lists the node files matching the specified filter options.

public ListNodeFiles ( ListNodeFileOptions options ) : IEnumerable
options	ListNodeFileOptions	The options to use when querying for node files.
return	IEnumerable

ListPoolUsageMetrics() public method

Lists the usage metrics, aggregated by pool across individual time intervals, for the specified account.

public ListPoolUsageMetrics ( ListPoolUsageOptions options ) : IEnumerable
options	ListPoolUsageOptions	The options to use when aggregating usage for pools.
return	IEnumerable

ListPools() public method

Lists the pools matching the specified filter options.

public ListPools ( Microsoft.Azure.Commands.Batch.Models.ListPoolOptions options ) : IEnumerable
options	Microsoft.Azure.Commands.Batch.Models.ListPoolOptions	The options to use when querying for pools.
return	IEnumerable

ListSubtasks() public method

Lists the subtasks matching the specified filter options.

public ListSubtasks ( ListSubtaskOptions options ) : IEnumerable
options	ListSubtaskOptions	The options to use when querying for subtasks.
return	IEnumerable

ListTasks() public method

Lists the tasks matching the specified filter options.

public ListTasks ( Microsoft.Azure.Commands.Batch.Models.ListTaskOptions options ) : IEnumerable
options	Microsoft.Azure.Commands.Batch.Models.ListTaskOptions	The options to use when querying for tasks.
return	IEnumerable

ReactivateTask() public method

Reactivates a task, allowing it to run again even if its retry count has been exhausted.

public ReactivateTask ( Microsoft.Azure.Commands.Batch.Models.TaskOperationParameters parameters ) : void
parameters	Microsoft.Azure.Commands.Batch.Models.TaskOperationParameters	The parameters indicating which task to reactivate.
return	void

RebootComputeNode() public method

Reboots the specified compute node.

public RebootComputeNode ( RebootComputeNodeParameters parameters ) : void
parameters	RebootComputeNodeParameters	The parameters specifying the compute node to reboot and the reboot option.
return	void

RegenerateKeys() public method

Generates new key for the Batch account

public RegenerateKeys ( string resourceGroupName, string accountName, AccountKeyType keyType ) : BatchAccountContext
resourceGroupName	string	The name of the resource group the account is under. If unspecified, it will be looked up.
accountName	string	The account name
keyType	AccountKeyType	The type of key to regenerate
return	BatchAccountContext

ReimageComputeNode() public method

Reinstalls the operating system on the specified compute node.

public ReimageComputeNode ( ReimageComputeNodeParameters parameters ) : void
parameters	ReimageComputeNodeParameters	The parameters specifying the compute node to reimage and the reimage option.
return	void

RemoveComputeNodesFromPool() public method

Removes the specified compute nodes from the specified pool.

public RemoveComputeNodesFromPool ( RemoveComputeNodeParameters parameters ) : void
parameters	RemoveComputeNodeParameters	The parameters specifying the pool and the compute nodes.
return	void

ResizePool() public method

Resizes the specified pool.

public ResizePool ( Microsoft.Azure.Commands.Batch.Models.PoolResizeParameters parameters ) : void
parameters	Microsoft.Azure.Commands.Batch.Models.PoolResizeParameters	The parameters to use when resizing the pool.
return	void

StopResizePool() public method

Stops the resize operation on the specified pool.

public StopResizePool ( BatchAccountContext context, string poolId, IEnumerable additionalBehaviors = null ) : void
context	BatchAccountContext	The account to use.
poolId	string	The id of the pool.
additionalBehaviors	IEnumerable	Additional client behaviors to perform.
return	void

TerminateJob() public method

Terminates the specified job.

public TerminateJob ( TerminateJobParameters parameters ) : void
parameters	TerminateJobParameters	Specifies the job to terminate as well as the terminate reason.
return	void

TerminateJobSchedule() public method

Terminates the specified job schedule.

public TerminateJobSchedule ( BatchAccountContext context, string jobScheduleId, IEnumerable additionBehaviors = null ) : void
context	BatchAccountContext	The account to use.
jobScheduleId	string	The id of the job schedule to terminate.
additionBehaviors	IEnumerable	Additional client behaviors to perform.
return	void

TerminateTask() public method

Terminates the specified task.

public TerminateTask ( Microsoft.Azure.Commands.Batch.Models.TaskOperationParameters parameters ) : void
parameters	Microsoft.Azure.Commands.Batch.Models.TaskOperationParameters	The parameters indicating which task to terminate.
return	void

UpdateAccount() public method

Updates an existing Batch account

public UpdateAccount ( string resourceGroupName, string accountName, Hashtable tags, string autoStorageAccountId ) : BatchAccountContext
resourceGroupName	string	The name of the resource group the account is under. If unspecified, it will be looked up.
accountName	string	The account name
tags	Hashtable	New tags to associate with the account
autoStorageAccountId	string	The resource id of the storage account to be used for auto storage.
return	BatchAccountContext

UpdateApplication() public method

public UpdateApplication ( string resourceGroupName, string accountName, string applicationId, bool allowUpdates, string defaultVersion, string displayName ) : void
resourceGroupName	string
accountName	string
applicationId	string
allowUpdates	bool
defaultVersion	string
displayName	string
return	void

UpdateComputeNodeUser() public method

Updates a compute node user account

public UpdateComputeNodeUser ( UpdateComputeNodeUserParameters parameters ) : void
parameters	UpdateComputeNodeUserParameters	The parameters specifying the compute node user to update and the changes to make
return	void

UpdateJob() public method

Commits changes to a PSCloudJob object to the Batch Service.

public UpdateJob ( BatchAccountContext context, PSCloudJob job, IEnumerable additionBehaviors = null ) : void
context	BatchAccountContext	The account to use.
job	PSCloudJob	The PSCloudJob object representing the job to update.
additionBehaviors	IEnumerable	Additional client behaviors to perform.
return	void

UpdateJobSchedule() public method

Commits changes to a PSCloudJobSchedule object to the Batch Service.

public UpdateJobSchedule ( BatchAccountContext context, PSCloudJobSchedule jobSchedule, IEnumerable additionBehaviors = null ) : void
context	BatchAccountContext	The account to use.
jobSchedule	PSCloudJobSchedule	The PSCloudJobSchedule object representing the job schedule to update.
additionBehaviors	IEnumerable	Additional client behaviors to perform.
return	void

UpdatePool() public method

Commits changes to a PSCloudPool object to the Batch Service.

public UpdatePool ( BatchAccountContext context, PSCloudPool pool, IEnumerable additionBehaviors = null ) : void
context	BatchAccountContext	The account to use.
pool	PSCloudPool	The PSCloudPool object representing the pool to update.
additionBehaviors	IEnumerable	Additional client behaviors to perform.
return	void

UpdateTask() public method

Commits changes to a PSCloudTask object to the Batch Service.

public UpdateTask ( BatchAccountContext context, PSCloudTask task, IEnumerable additionBehaviors = null ) : void
context	BatchAccountContext	The account to use.
task	PSCloudTask	The PSCloudTask object representing the task to update.
additionBehaviors	IEnumerable	Additional client behaviors to perform.
return	void

UploadAndActivateApplicationPackage() public method

public UploadAndActivateApplicationPackage ( string resourceGroupName, string accountName, string applicationId, string version, string filePath, string format, bool activateOnly ) : PSApplicationPackage
resourceGroupName	string
accountName	string
applicationId	string
version	string
filePath	string
format	string
activateOnly	bool
return	PSApplicationPackage