Microsoft.Azure.Commands.Batch.dll-Help.xml
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml"> <!-- Updatable Help Version 1.0.0.0 --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzureRmBatchAccountKeys</command:name> <maml:description> <maml:para>Gets the specified key of the specified Batch accounts under the current subscription.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRMBatchAccountKeys</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureRmBatchAccountKeys cmdlet gets the specified key of the specified Azure Batch accounts under the current subscription.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmBatchAccountKeys</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="Name"> <maml:name>AccountName</maml:name> <maml:description> <maml:para>Specifies the name of the account. If you specify an account name, this cmdlet only returns the specified account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group where the account is created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="Name"> <maml:name>AccountName</maml:name> <maml:description> <maml:para>Specifies the name of the account. If you specify an account name, this cmdlet only returns the specified account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group where the account is created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title> 1: </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:remarks> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureRmBatchAccountKey</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>RMAzure_Batch_Cmdlets</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, batch</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzureRmBatchAccount</command:name> <maml:description> <maml:para>Gets a Batch account under the current subscription.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRMBatchAccount</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureRmBatchAccount cmdlet gets an Azure Batch account under the current subscription. You can use the AccountName parameter to get a single account, or you can use the ResourceGroupName parameter to get accounts under that resource group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmBatchAccount</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="Name"> <maml:name>AccountName</maml:name> <maml:description> <maml:para>Specifies the name of the account. If you specify an account name, this cmdlet only returns the specified account.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="2" aliases="none"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group. If you specify a resource group, this cmdlet lists the accounts under the specified resource group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="3" aliases="none"> <maml:name>Tag</maml:name> <maml:description> <maml:para>Specifies tags in an array of hash tables to set on the account.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="Name"> <maml:name>AccountName</maml:name> <maml:description> <maml:para>Specifies the name of the account. If you specify an account name, this cmdlet only returns the specified account.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="2" aliases="none"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group. If you specify a resource group, this cmdlet lists the accounts under the specified resource group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="3" aliases="none"> <maml:name>Tag</maml:name> <maml:description> <maml:para>Specifies tags in an array of hash tables to set on the account.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>BatchAccountContext</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get a batch account by name</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureRmBatchAccount -AccountName "pfuller" AccountName : pfuller Location : westus ResourceGroupName : CmdletExampleRG CoreQuota : 20 PoolQuota : 20 ActiveJobAndJobScheduleQuota : 20 Tags : TaskTenantUrl : https://pfuller.westus.batch.azure.com </dev:code> <dev:remarks> <maml:para>This command gets the batch account named pfuller.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Gets the batch accounts associated with a resource group</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureRmBatchAccount -ResourceGroupName "CmdletExampleRG" AccountName : cmdletexample Location : westus ResourceGroupName : CmdletExampleRG CoreQuota : 20 PoolQuota : 20 ActiveJobAndJobScheduleQuota : 20 Tags : TaskTenantUrl : https://cmdletexample.westus.batch.azure.com AccountName : cmdletexample2 Location : westus ResourceGroupName : CmdletExampleRG CoreQuota : 20 PoolQuota : 20 ActiveJobAndJobScheduleQuota : 20 Tags : TaskTenantUrl : https://cmdletexample.westus.batch.azure.com </dev:code> <dev:remarks> <maml:para>This command gets the batch accounts associated with the CmdletExampleRG resource group.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureRmBatchAccount</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmBatchAccount</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmBatchAccount</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>RMAzure_Batch_Cmdlets</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, batch</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzureBatchComputeNode</command:name> <maml:description> <maml:para>Gets Batch compute nodes from a pool.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureBatchComputeNode</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureBatchComputeNode cmdlet gets Azure Batch compute nodes under a pool. Specify either the pool ID or pool object. Specify the Id parameter to get a single compute node. Specify the Filter parameter to get the compute nodes that match an OData filter. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureBatchComputeNode</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies an OData filter clause. This cmdlet returns compute nodes that match the filter that this parameter specifies. If you do not specify a filter, this cmdlet returns all compute nodes for the pool. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Select</maml:name> <maml:description> <maml:para>Specifies an OData select clause. Used to retrieve only specific properties instead of all object properties.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MaxCount</maml:name> <maml:description> <maml:para>Specifies the maximum number of compute nodes to return. If you specify a value of zero (0) or less, the cmdlet does not use an upper limit. The default value is 1000.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>PoolId</maml:name> <maml:description> <maml:para>Specifies the ID of the pool that contains the compute nodes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureBatchComputeNode</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>PoolId</maml:name> <maml:description> <maml:para>Specifies the ID of the pool that contains the compute nodes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="2" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of the compute node that this cmdlet gets from the pool. You cannot specify wildcard characters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Select</maml:name> <maml:description> <maml:para>Specifies an OData select clause. Used to retrieve only specific properties instead of all object properties.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureBatchComputeNode</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="1" aliases="none"> <maml:name>Pool</maml:name> <maml:description> <maml:para>Specifies the pool, as a PSCloudPool object, that contains the compute nodes. To obtain a PSCloudPool object, use the Get-AzureBatchPool cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCloudPool</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies an OData filter clause. This cmdlet returns compute nodes that match the filter that this parameter specifies. If you do not specify a filter, this cmdlet returns all compute nodes for the pool. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Select</maml:name> <maml:description> <maml:para>Specifies an OData select clause. Used to retrieve only specific properties instead of all object properties.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MaxCount</maml:name> <maml:description> <maml:para>Specifies the maximum number of compute nodes to return. If you specify a value of zero (0) or less, the cmdlet does not use an upper limit. The default value is 1000.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> <dev:type> <maml:name>BatchAccountContext</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies an OData filter clause. This cmdlet returns compute nodes that match the filter that this parameter specifies. If you do not specify a filter, this cmdlet returns all compute nodes for the pool. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Select</maml:name> <maml:description> <maml:para>Specifies an OData select clause. Used to retrieve only specific properties instead of all object properties.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="2" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of the compute node that this cmdlet gets from the pool. You cannot specify wildcard characters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MaxCount</maml:name> <maml:description> <maml:para>Specifies the maximum number of compute nodes to return. If you specify a value of zero (0) or less, the cmdlet does not use an upper limit. The default value is 1000.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="1" aliases="none"> <maml:name>Pool</maml:name> <maml:description> <maml:para>Specifies the pool, as a PSCloudPool object, that contains the compute nodes. To obtain a PSCloudPool object, use the Get-AzureBatchPool cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCloudPool</command:parameterValue> <dev:type> <maml:name>PSCloudPool</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>PoolId</maml:name> <maml:description> <maml:para>Specifies the ID of the pool that contains the compute nodes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PSComputeNode</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get a compute node by ID </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureBatchComputeNode -PoolId "Pool06" -Id "tvm-2316545714_1-20150725t213220z" -BatchContext $Context Id : tvm-2316545714_1-20150725t213220z Url : https://cmdletexample.westus.batch.azure.com/pools/MyPool/nodes/tvm-2316545714_1-20150725t213220z State : Idle StateTransitionTime : 7/25/2015 9:36:53 PM LastBootTime : 7/25/2015 9:36:53 PM AllocationTime : 7/25/2015 9:32:20 PM IPAddress : 10.14.121.1 AffinityId : TVM:tvm-2316545714_1-20150725t213220z VirtualMachineSize : small TotalTasksRun : 1 StartTaskInformation : RecentTasks : {} StartTask : CertificateReferences : Errors : </dev:code> <dev:remarks> <maml:para>This command gets the compute node that has the ID tvm-2316545714_1-20150725t213220z from the pool that has the ID Pool06. Use the Get-AzureRmBatchAccountKeys cmdlet to assign a context to the $Context variable.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Get all idle compute nodes from a pool</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureBatchComputeNode -PoolId "Pool06" -Filter "state eq 'idle'" -BatchContext $Context Id : tvm-2316545714_1-20150725t213220z Url : https://cmdletexample.westus.batch.azure.com/pools/MyPool/nodes/tvm-2316545714_1-20150725t213220z State : Idle StateTransitionTime : 7/25/2015 9:36:53 PM LastBootTime : 7/25/2015 9:36:53 PM AllocationTime : 7/25/2015 9:32:20 PM IPAddress : 10.14.121.1 AffinityId : TVM:tvm-2316545714_1-20150725t213220z VirtualMachineSize : small TotalTasksRun : 1 StartTaskInformation : RecentTasks : {} StartTask : CertificateReferences : Errors : Id : tvm-2316545714_2-20150726t172920z Url : https://cmdletexample.westus.batch.azure.com/pools/MyPool/nodes/tvm-2316545714_2-20150726t172920z State : Idle StateTransitionTime : 7/26/2015 5:33:58 PM LastBootTime : 7/26/2015 5:33:58 PM AllocationTime : 7/26/2015 5:29:20 PM IPAddress : 10.14.121.38 AffinityId : TVM:tvm-2316545714_2-20150726t172920z VirtualMachineSize : small TotalTasksRun : 0 StartTaskInformation : RecentTasks : StartTask : CertificateReferences : Errors : </dev:code> <dev:remarks> <maml:para>This command gets all idle compute nodes that are contained in the pool that has the ID Pool06. The command specifies the idle state by using the Filter parameter.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3: Get all compute nodes in a specified pool</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureBatchPool -Id "Pool07" -BatchContext $Context | Get-AzureBatchComputeNode -BatchContext $Context Id : tvm-2316545714_1-20150725t213220z Url : https://cmdletexample.westus.batch.azure.com/pools/MyPool/nodes/tvm-2316545714_1-20150725t213220z State : Idle StateTransitionTime : 7/25/2015 9:36:53 PM LastBootTime : 7/25/2015 9:36:53 PM AllocationTime : 7/25/2015 9:32:20 PM IPAddress : 10.14.121.1 AffinityId : TVM:tvm-2316545714_1-20150725t213220z VirtualMachineSize : small TotalTasksRun : 1 StartTaskInformation : RecentTasks : {} StartTask : CertificateReferences : Errors : Id : tvm-2316545714_2-20150726t172920z Url : https://cmdletexample.westus.batch.azure.com/pools/MyPool/nodes/tvm-2316545714_2-20150726t172920z State : Idle StateTransitionTime : 7/26/2015 5:33:58 PM LastBootTime : 7/26/2015 5:33:58 PM AllocationTime : 7/26/2015 5:29:20 PM IPAddress : 10.14.121.38 AffinityId : TVM:tvm-2316545714_2-20150726t172920z VirtualMachineSize : small TotalTasksRun : 0 StartTaskInformation : RecentTasks : StartTask : CertificateReferences : Errors : </dev:code> <dev:remarks> <maml:para>This command gets the pool that has the ID Pool07 by using the Get-AzureBatchPool cmdlet. The command passes that pool to the current cmdlet by using the pipeline operator. That cmdlet gets all compute nodes from that pool.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureBatchNodeFile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureBatchNodeFileContent</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureBatchPool</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>RMAzure_Batch_Cmdlets</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, batch</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzureBatchJobSchedule</command:name> <maml:description> <maml:para>Gets Batch job schedules.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureBatchJobSchedule</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureBatchJobSchedule cmdlet gets Azure Batch job schedules for the Batch account specified by the BatchContext parameter. Specify an ID to get a single job schedule. Specify the Filter parameter to get the job schedules that match an OData filter. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureBatchJobSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies an OData filter clause. This cmdlet returns job schedules that match the filter that this parameter specifies. If you do not specify a filter, this cmdlet returns all job schedules for the Batch context. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Select</maml:name> <maml:description> <maml:para>Specifies an OData select clause. Used to retrieve only specific properties instead of all object properties.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Expand</maml:name> <maml:description> <maml:para>Specifies an OData expand clause. Used to retrieve associated entities of the main entity being retrieved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MaxCount</maml:name> <maml:description> <maml:para>Specifies the maximum number of job schedules to return. If you specify a value of zero (0) or less, the cmdlet does not use an upper limit. The default value is 1000. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureBatchJobSchedule</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByValue,ByPropertyName)" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of the job schedule that this cmdlet gets. You cannot specify wildcard characters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Select</maml:name> <maml:description> <maml:para>Specifies an OData select clause. Used to retrieve only specific properties instead of all object properties.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Expand</maml:name> <maml:description> <maml:para>Specifies an OData expand clause. Used to retrieve associated entities of the main entity being retrieved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> <dev:type> <maml:name>BatchAccountContext</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies an OData filter clause. This cmdlet returns job schedules that match the filter that this parameter specifies. If you do not specify a filter, this cmdlet returns all job schedules for the Batch context. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Select</maml:name> <maml:description> <maml:para>Specifies an OData select clause. Used to retrieve only specific properties instead of all object properties.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Expand</maml:name> <maml:description> <maml:para>Specifies an OData expand clause. Used to retrieve associated entities of the main entity being retrieved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByValue,ByPropertyName)" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of the job schedule that this cmdlet gets. You cannot specify wildcard characters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MaxCount</maml:name> <maml:description> <maml:para>Specifies the maximum number of job schedules to return. If you specify a value of zero (0) or less, the cmdlet does not use an upper limit. The default value is 1000. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PSCloudJobSchedule</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get a job schedule by specifying an ID</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureBatchJobSchedule -Id "JobSchedule23" -BatchContext $Context CreationTime : 7/25/2015 9:15:43 PM DisplayName : ETag : 0x8D2953633427FCA ExecutionInformation : Microsoft.Azure.Commands.Batch.Models.PSJobScheduleExecutionInformation Id : MyJobSchedule JobSpecification : Microsoft.Azure.Commands.Batch.Models.PSJobSpecification LastModified : 7/25/2015 9:15:43 PM Metadata : PreviousState : Invalid PreviousStateTransitionTime : Schedule : State : Active StateTransitionTime : 7/25/2015 9:15:43 PM Statistics : Url : https://cmdletexample.westus.batch.azure.com/jobschedules/JobSchedule23 </dev:code> <dev:remarks> <maml:para>This command gets the job schedule that has the ID JobSchedule23.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Get job schedules by using a filter</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureBatchJobSchedule -Filter "startswith(id,'Job')" -BatchContext $Context CreationTime : 7/25/2015 9:15:43 PM DisplayName : ETag : 0x8D2953633427FCA ExecutionInformation : Microsoft.Azure.Commands.Batch.Models.PSJobScheduleExecutionInformation Id : MyJobSchedule JobSpecification : Microsoft.Azure.Commands.Batch.Models.PSJobSpecification LastModified : 7/25/2015 9:15:43 PM Metadata : PreviousState : Invalid PreviousStateTransitionTime : Schedule : State : Active StateTransitionTime : 7/25/2015 9:15:43 PM Statistics : Url : https://cmdletexample.westus.batch.azure.com/jobschedules/JobSchedule23 CreationTime : 7/26/2015 5:39:33 PM DisplayName : ETag : 0x8D295E12B1084B4 ExecutionInformation : Microsoft.Azure.Commands.Batch.Models.PSJobScheduleExecutionInformation Id : MyJobSchedule2 JobSpecification : Microsoft.Azure.Commands.Batch.Models.PSJobSpecification LastModified : 7/26/2015 5:39:33 PM Metadata : PreviousState : Invalid PreviousStateTransitionTime : Schedule : State : Active StateTransitionTime : 7/26/2015 5:39:33 PM Statistics : Url : https://cmdletexample.westus.batch.azure.com/jobschedules/JobSchedule17 </dev:code> <dev:remarks> <maml:para>This command gets all job schedules that have IDs that start with Job by specifying the Filter parameter.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureBatchJobSchedule</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureBatchJobSchedule</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>RMAzure_Batch_Cmdlets</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, batch</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzureBatchJob</command:name> <maml:description> <maml:para>Gets Batch jobs under the specified Batch account or job schedule.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureBatchJob</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureBatchJob cmdlet gets the Azure Batch jobs under the Batch account specified by the BatchAccountContext parameter. You can use the Id parameter to get a single job, or you can use the Filter parameter to get the jobs that match an OData filter. If you supply a job schedule ID or PSCloudJobSchedule instance, only the jobs under that job schedule will be returned.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureBatchJob</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies the OData filter clause to use when querying for jobs. If you do not specify a filter, and if you do not specify a job schedule, then all jobs under the Batch account will be returned. If not filter is specified, but a job schedule is specified, then all jobs under that job schedule will be returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Select</maml:name> <maml:description> <maml:para>Specifies an OData select clause. Used to retrieve only specific properties instead of all object properties.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Expand</maml:name> <maml:description> <maml:para>Specifies an OData expand clause. Used to retrieve associated entities of the main entity being retrieved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>JobScheduleId</maml:name> <maml:description> <maml:para>Specifies the ID of the job schedule which contains the jobs.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MaxCount</maml:name> <maml:description> <maml:para>Specifies the maximum number of jobs to return. If you specify a value of zero (0) or less, the cmdlet does not use an upper limit. The default value is 1000.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureBatchJob</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of the job. You cannot specify wildcard characters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Select</maml:name> <maml:description> <maml:para>Specifies an OData select clause. Used to retrieve only specific properties instead of all object properties.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Expand</maml:name> <maml:description> <maml:para>Specifies an OData expand clause. Used to retrieve associated entities of the main entity being retrieved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureBatchJob</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="1" aliases="none"> <maml:name>JobSchedule</maml:name> <maml:description> <maml:para>Specifies the PSCloudJobSchedule object representing the job schedule which contains the jobs. Use the Get-AzureBatchJobSchedule cmdlet to get a PSCloudJobSchedule object.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCloudJobSchedule</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies the OData filter clause to use when querying for jobs. If you do not specify a filter, and if you do not specify a job schedule, then all jobs under the Batch account will be returned. If not filter is specified, but a job schedule is specified, then all jobs under that job schedule will be returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Select</maml:name> <maml:description> <maml:para>Specifies an OData select clause. Used to retrieve only specific properties instead of all object properties.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Expand</maml:name> <maml:description> <maml:para>Specifies an OData expand clause. Used to retrieve associated entities of the main entity being retrieved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MaxCount</maml:name> <maml:description> <maml:para>Specifies the maximum number of jobs to return. If you specify a value of zero (0) or less, the cmdlet does not use an upper limit. The default value is 1000.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> <dev:type> <maml:name>BatchAccountContext</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies the OData filter clause to use when querying for jobs. If you do not specify a filter, and if you do not specify a job schedule, then all jobs under the Batch account will be returned. If not filter is specified, but a job schedule is specified, then all jobs under that job schedule will be returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Select</maml:name> <maml:description> <maml:para>Specifies an OData select clause. Used to retrieve only specific properties instead of all object properties.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Expand</maml:name> <maml:description> <maml:para>Specifies an OData expand clause. Used to retrieve associated entities of the main entity being retrieved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of the job. You cannot specify wildcard characters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="1" aliases="none"> <maml:name>JobSchedule</maml:name> <maml:description> <maml:para>Specifies the PSCloudJobSchedule object representing the job schedule which contains the jobs. Use the Get-AzureBatchJobSchedule cmdlet to get a PSCloudJobSchedule object.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCloudJobSchedule</command:parameterValue> <dev:type> <maml:name>PSCloudJobSchedule</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>JobScheduleId</maml:name> <maml:description> <maml:para>Specifies the ID of the job schedule which contains the jobs.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MaxCount</maml:name> <maml:description> <maml:para>Specifies the maximum number of jobs to return. If you specify a value of zero (0) or less, the cmdlet does not use an upper limit. The default value is 1000.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PSCloudJob</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get a Batch job by id</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureBatchJob -Id "Job01" -BatchContext $Context CommonEnvironmentSettings : Constraints : Microsoft.Azure.Commands.Batch.Models.PSJobConstraints CreationTime : 7/25/2015 9:12:07 PM DisplayName : ETag : 0x8D29535B2941439 ExecutionInformation : Microsoft.Azure.Commands.Batch.Models.PSJobExecutionInformation Id : Job01 JobManagerTask : JobPreparationTask : JobReleaseTask : LastModified : 7/25/2015 9:12:07 PM Metadata : PoolInformation : Microsoft.Azure.Commands.Batch.Models.PSPoolInformation PreviousState : PreviousStateTransitionTime : Priority : 0 State : Active StateTransitionTime : 7/25/2015 9:12:07 PM Statistics : Url : https://cmdletexample.westus.batch.azure.com/jobs/Job01 </dev:code> <dev:remarks> <maml:para>This command gets the job with ID Job01.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Get all active jobs under a specified job schedule</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureBatchJob -JobScheduleId "MyJobSchedule" -Filter "state eq 'active'" -BatchContext $Context CommonEnvironmentSettings : Constraints : Microsoft.Azure.Commands.Batch.Models.PSJobConstraints CreationTime : 7/25/2015 9:15:44 PM DisplayName : ETag : 0x8D2953633DD13E1 ExecutionInformation : Microsoft.Azure.Commands.Batch.Models.PSJobExecutionInformation Id : MyJobSchedule:job-1 JobManagerTask : JobPreparationTask : JobReleaseTask : LastModified : 7/25/2015 9:15:44 PM Metadata : PoolInformation : Microsoft.Azure.Commands.Batch.Models.PSPoolInformation PreviousState : PreviousStateTransitionTime : Priority : 0 State : Active StateTransitionTime : 7/25/2015 9:15:44 PM Statistics : Url : https://cmdletexample.westus.batch.azure.com/jobs/MyJobSchedule:job-1 </dev:code> <dev:remarks> <maml:para>This command gets the active jobs under the job schedule with ID MyJobSchedule.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3: Gets all jobs under a job schedule using pipelining</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureBatchJobSchedule -Id "MyJobSchedule" -BatchContext $Context | Get-AzureBatchJob -BatchContext $Context CommonEnvironmentSettings : Constraints : Microsoft.Azure.Commands.Batch.Models.PSJobConstraints CreationTime : 7/25/2015 9:15:44 PM DisplayName : ETag : 0x8D2953633DD13E1 ExecutionInformation : Microsoft.Azure.Commands.Batch.Models.PSJobExecutionInformation Id : MyJobSchedule:job-1 JobManagerTask : JobPreparationTask : JobReleaseTask : LastModified : 7/25/2015 9:15:44 PM Metadata : PoolInformation : Microsoft.Azure.Commands.Batch.Models.PSPoolInformation PreviousState : PreviousStateTransitionTime : Priority : 0 State : Active StateTransitionTime : 7/25/2015 9:15:44 PM Statistics : Url : https://cmdletexample.westus.batch.azure.com/jobs/MyJobSchedule:job-1 </dev:code> <dev:remarks> <maml:para>This command gets all jobs under the job schedule with ID MyJobSchedule.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmBatchAccountKeys</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureBatchJobSchedule</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureBatchJob</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>RMAzure_Batch_Cmdlets</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, batch</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzureBatchNodeFileContent</command:name> <maml:description> <maml:para>Gets a Batch node file.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureBatchNodeFileContent</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureBatchNodeFileContent cmdlet gets an Azure Batch node file and saves it as a file or to a stream.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureBatchNodeFileContent</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the node file that this cmdlet retrieves. You cannot specify wildcard characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>JobId</maml:name> <maml:description> <maml:para>Specifies the ID of the job that contains the target task.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>TaskId</maml:name> <maml:description> <maml:para>Specifies the ID of the task.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>DestinationPath</maml:name> <maml:description> <maml:para>Specifies the file path where this cmdlet saves the node file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureBatchNodeFileContent</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>DestinationStream</maml:name> <maml:description> <maml:para>Specifies the stream into which this cmdlet writes the node file contents. This cmdlet does not close or rewind this stream.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Stream</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>JobId</maml:name> <maml:description> <maml:para>Specifies the ID of the job that contains the target task.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the node file that this cmdlet retrieves. You cannot specify wildcard characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>TaskId</maml:name> <maml:description> <maml:para>Specifies the ID of the task.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureBatchNodeFileContent</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>PoolId</maml:name> <maml:description> <maml:para>Specifies the ID of the pool that contains the compute node that contains the node file that this cmdlet gets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="2" aliases="none"> <maml:name>ComputeNodeId</maml:name> <maml:description> <maml:para>Specifies the ID of the compute node that contains the node file that this cmdlet returns.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the node file that this cmdlet retrieves. You cannot specify wildcard characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>DestinationStream</maml:name> <maml:description> <maml:para>Specifies the stream into which this cmdlet writes the node file contents. This cmdlet does not close or rewind this stream.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Stream</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureBatchNodeFileContent</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>PoolId</maml:name> <maml:description> <maml:para>Specifies the ID of the pool that contains the compute node that contains the node file that this cmdlet gets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="2" aliases="none"> <maml:name>ComputeNodeId</maml:name> <maml:description> <maml:para>Specifies the ID of the compute node that contains the node file that this cmdlet returns.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the node file that this cmdlet retrieves. You cannot specify wildcard characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>DestinationPath</maml:name> <maml:description> <maml:para>Specifies the file path where this cmdlet saves the node file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureBatchNodeFileContent</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="1" aliases="none"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the file that this cmdlet gets, as a PSNodeFile object. To obtain a node file object, use the Get-AzureBatchNodeFile cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSNodeFile</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>DestinationStream</maml:name> <maml:description> <maml:para>Specifies the stream into which this cmdlet writes the node file contents. This cmdlet does not close or rewind this stream.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Stream</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureBatchNodeFileContent</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="1" aliases="none"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the file that this cmdlet gets, as a PSNodeFile object. To obtain a node file object, use the Get-AzureBatchNodeFile cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSNodeFile</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>DestinationPath</maml:name> <maml:description> <maml:para>Specifies the file path where this cmdlet saves the node file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> <dev:type> <maml:name>BatchAccountContext</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="2" aliases="none"> <maml:name>ComputeNodeId</maml:name> <maml:description> <maml:para>Specifies the ID of the compute node that contains the node file that this cmdlet returns.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>DestinationPath</maml:name> <maml:description> <maml:para>Specifies the file path where this cmdlet saves the node file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>DestinationStream</maml:name> <maml:description> <maml:para>Specifies the stream into which this cmdlet writes the node file contents. This cmdlet does not close or rewind this stream.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Stream</command:parameterValue> <dev:type> <maml:name>Stream</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="1" aliases="none"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the file that this cmdlet gets, as a PSNodeFile object. To obtain a node file object, use the Get-AzureBatchNodeFile cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSNodeFile</command:parameterValue> <dev:type> <maml:name>PSNodeFile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>JobId</maml:name> <maml:description> <maml:para>Specifies the ID of the job that contains the target task.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the node file that this cmdlet retrieves. You cannot specify wildcard characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>PoolId</maml:name> <maml:description> <maml:para>Specifies the ID of the pool that contains the compute node that contains the node file that this cmdlet gets.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>TaskId</maml:name> <maml:description> <maml:para>Specifies the ID of the task.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get a Batch node file associated with a task and save the file </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureBatchNodeFileContent -JobId "Job01" -TaskId "Task01" -Name "StdOut.txt" -DestinationPath "E:\PowerShell\StdOut.txt" -BatchContext $Context </dev:code> <dev:remarks> <maml:para>This command gets the node file that is named StdOut.txt, and saves it to the E:\PowerShell\StdOut.txt file path on the local computer. The StdOut.txt node file is associated with task that has the ID Task01 for the job that has the ID Job01. Use the Get-AzureRmBatchAccountKeys cmdlet to assign a context to the $Context variable.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Get a Batch node file and save it to a specified file path using the pipeline</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureBatchNodeFile -JobId "Job02" -TaskId "Task02" -Name "StdErr.txt" -BatchContext $Context | Get-AzureBatchNodeFileContent -DestinationPath "E:\PowerShell\StdOut.txt" -BatchContext $Context </dev:code> <dev:remarks> <maml:para>This command gets the node file that is named StdErr.txt by using the Get-AzureBatchNodeFile cmdlet. The command passes that file to the current cmdlet by using the pipeline operator. The current cmdlet saves that file to the E:\PowerShell\StdOut.txt file path on the local computer. The StdOut.txt node file is associated with the task that has the ID Task02 for the job that has the ID Job02.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3: Get a Batch node file associated with a task and direct it to a stream</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>$Stream = New-Object -TypeName "System.IO.MemoryStream" PS C:\> Get-AzureBatchNodeFileContent -JobId "Job03" -TaskId "Task11" -Name "stdout.txt" -DestinationStream $Stream -BatchContext $Context </dev:code> <dev:remarks> <maml:para>The first command creates a stream by using the New-Object cmdlet, and then stores it in the $Stream variable. </maml:para> <maml:para>The second command gets the node file that is named StdOut.txt from the task that has the ID Task11 for the job that has the ID Job03. The command directs file contents to the stream in $Stream.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 4: Get a node file from a compute node and save it </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureBatchNodeFileContent -PoolId "Pool01" -ComputeNodeId "ComputeNode01" -Name "Startup\StdOut.txt" -DestinationPath "E:\PowerShell\StdOut.txt" -BatchContext $Context </dev:code> <dev:remarks> <maml:para>This command gets the node file Startup\StdOut.txt from the compute node that has the ID ComputeNode01 in the pool that has the ID Pool01. The command saves the file to the E:\PowerShell\StdOut.txt file path on the local computer.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 5: Get a node file from a compute node and save it by using the pipeline</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureBatchNodeFile -PoolId "Pool01" -ComputeNodeId "ComputeNode01" -Name "Startup\StdOut.txt" -BatchContext $Context | Get-AzureBatchNodeFileContent -DestinationPath "E:\PowerShell\StdOut.txt" -BatchContext $Context </dev:code> <dev:remarks> <maml:para>This command gets the node file Startup\StdOut.txt by using Get-AzureBatchNodeFile from the compute node that has the ID ComputeNode01. The compute node is in the pool that has the ID Pool01. The command passes that node file to the current cmdlet. That cmdlet saves the file to the E:\PowerShell\StdOut.txt file path on the local computer.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 6: Get a node file from a compute node and direct it to a stream</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>$Stream = New-Object -TypeName "System.IO.MemoryStream" PS C:\> Get-AzureBatchNodeFileContent -PoolId "Pool01" -ComputeNodeId "ComputeNode01" -Name "startup\stdout.txt" -DestinationStream $Stream -BatchContext $Context </dev:code> <dev:remarks> <maml:para>The first command creates a stream by using the New-Object cmdlet, and then stores it in the $Stream variable. </maml:para> <maml:para>The second command gets the node file that is named StdOut.txt from the compute node that has the ID ComputeNode01 in the pool that has the ID Pool01. The command directs file contents to the stream in $Stream. </maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmBatchAccountKeys</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureBatchNodeFile</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>RMAzure_Batch_Cmdlets</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, batch</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzureBatchNodeFile</command:name> <maml:description> <maml:para>Gets the properties of Batch node files.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureBatchNodeFile</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureBatchNodeFile cmdlet gets the properties of the Azure Batch node files of a task or compute node. To narrow your results, you can specify a filter. If you specify a task, but not a filter, this cmdlet returns properties for all node files for that task. If you specify a compute node, but not a filter, this cmdlet returns properties for all node files for that compute node.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureBatchNodeFile</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>PoolId</maml:name> <maml:description> <maml:para>Specifies the ID of the pool that contains the compute node from which to get properties of node files.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="2" aliases="none"> <maml:name>ComputeNodeId</maml:name> <maml:description> <maml:para>Specifies the ID of the compute node that contains the Batch node files.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the node file for which this cmdlet retrieves properties. You cannot specify wildcard characters. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureBatchNodeFile</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies an OData filter clause. This cmdlet returns properties for node files that match the filter that this parameter specifies. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MaxCount</maml:name> <maml:description> <maml:para>Specifies the maximum number of node files for which this cmdlet returns properties. If you specify a value of zero (0) or less, the cmdlet does not use an upper limit. The default value is 1000. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Recursive</maml:name> <maml:description> <maml:para>Indicates that this cmdlet returns a recursive list of files. Otherwise, it returns only the files in the root folder.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>JobId</maml:name> <maml:description> <maml:para>Specifies the ID of the job that contains the target task.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>TaskId</maml:name> <maml:description> <maml:para>Specifies the ID of the task for which this cmdlet gets properties of node files.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureBatchNodeFile</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the node file for which this cmdlet retrieves properties. You cannot specify wildcard characters. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>JobId</maml:name> <maml:description> <maml:para>Specifies the ID of the job that contains the target task.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>TaskId</maml:name> <maml:description> <maml:para>Specifies the ID of the task for which this cmdlet gets properties of node files.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureBatchNodeFile</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="1" aliases="none"> <maml:name>Task</maml:name> <maml:description> <maml:para>Specifies the task, as a PSCloudTask object, with which the node files are associated. To obtain a task object, use the Get-AzureBatchTask cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCloudTask</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies an OData filter clause. This cmdlet returns properties for node files that match the filter that this parameter specifies. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MaxCount</maml:name> <maml:description> <maml:para>Specifies the maximum number of node files for which this cmdlet returns properties. If you specify a value of zero (0) or less, the cmdlet does not use an upper limit. The default value is 1000. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Recursive</maml:name> <maml:description> <maml:para>Indicates that this cmdlet returns a recursive list of files. Otherwise, it returns only the files in the root folder.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureBatchNodeFile</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>PoolId</maml:name> <maml:description> <maml:para>Specifies the ID of the pool that contains the compute node from which to get properties of node files.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="2" aliases="none"> <maml:name>ComputeNodeId</maml:name> <maml:description> <maml:para>Specifies the ID of the compute node that contains the Batch node files.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies an OData filter clause. This cmdlet returns properties for node files that match the filter that this parameter specifies. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MaxCount</maml:name> <maml:description> <maml:para>Specifies the maximum number of node files for which this cmdlet returns properties. If you specify a value of zero (0) or less, the cmdlet does not use an upper limit. The default value is 1000. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Recursive</maml:name> <maml:description> <maml:para>Indicates that this cmdlet returns a recursive list of files. Otherwise, it returns only the files in the root folder.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureBatchNodeFile</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="1" aliases="none"> <maml:name>ComputeNode</maml:name> <maml:description> <maml:para>Specifies the compute node, as a PSComputeNode object, that contains the Batch node files. To obtain a compute node object, use the Get-AzureBatchComputeNode cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSComputeNode</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies an OData filter clause. This cmdlet returns properties for node files that match the filter that this parameter specifies. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MaxCount</maml:name> <maml:description> <maml:para>Specifies the maximum number of node files for which this cmdlet returns properties. If you specify a value of zero (0) or less, the cmdlet does not use an upper limit. The default value is 1000. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Recursive</maml:name> <maml:description> <maml:para>Indicates that this cmdlet returns a recursive list of files. Otherwise, it returns only the files in the root folder.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> <dev:type> <maml:name>BatchAccountContext</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="1" aliases="none"> <maml:name>ComputeNode</maml:name> <maml:description> <maml:para>Specifies the compute node, as a PSComputeNode object, that contains the Batch node files. To obtain a compute node object, use the Get-AzureBatchComputeNode cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSComputeNode</command:parameterValue> <dev:type> <maml:name>PSComputeNode</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="2" aliases="none"> <maml:name>ComputeNodeId</maml:name> <maml:description> <maml:para>Specifies the ID of the compute node that contains the Batch node files.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies an OData filter clause. This cmdlet returns properties for node files that match the filter that this parameter specifies. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>JobId</maml:name> <maml:description> <maml:para>Specifies the ID of the job that contains the target task.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MaxCount</maml:name> <maml:description> <maml:para>Specifies the maximum number of node files for which this cmdlet returns properties. If you specify a value of zero (0) or less, the cmdlet does not use an upper limit. The default value is 1000. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the node file for which this cmdlet retrieves properties. You cannot specify wildcard characters. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>PoolId</maml:name> <maml:description> <maml:para>Specifies the ID of the pool that contains the compute node from which to get properties of node files.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Recursive</maml:name> <maml:description> <maml:para>Indicates that this cmdlet returns a recursive list of files. Otherwise, it returns only the files in the root folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="1" aliases="none"> <maml:name>Task</maml:name> <maml:description> <maml:para>Specifies the task, as a PSCloudTask object, with which the node files are associated. To obtain a task object, use the Get-AzureBatchTask cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCloudTask</command:parameterValue> <dev:type> <maml:name>PSCloudTask</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>TaskId</maml:name> <maml:description> <maml:para>Specifies the ID of the task for which this cmdlet gets properties of node files.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PSNodeFile</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get the properties of a node file associated with a task</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureBatchNodeFile -JobId "Job-000001" -TaskId "Task26" -Name "Stdout.txt" -BatchContext $Context IsDirectory Name Properties Url ----------- ---- ---------- --- False StdOut.txt Microsoft.Azure.Commands.Batch.Models.PSFile... https://cmdletexample.westus.Batch.contoso... </dev:code> <dev:remarks> <maml:para>This command gets the properties of the StdOut.txt node file associated with the task that has the ID Task26 in the job that has the ID Job-000001. Use the Get-AzureRmBatchAccountKeys cmdlet to assign a context to the $Context variable.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Get the properties of node files associated with a task by using a filter</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureBatchNodeFile -JobId "Job-00002" -TaskId "Task26" -Filter "startswith(name,'St')" -BatchContext $Context IsDirectory Name Properties Url ----------- ---- ---------- --- False StdErr.txt Microsoft.Azure.Commands.Batch.Models.PSFile... https://cmdletexample.westus.Batch.contoso... False StdOut.txt Microsoft.Azure.Commands.Batch.Models.PSFile... https://cmdletexample.westus.Batch.contoso... </dev:code> <dev:remarks> <maml:para>This command gets the properties of the node files whose names start with st and are associated with task that has the ID Task26 under job that has the ID Job-00002.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3: Recursively get the properties of node files associated with a task</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureBatchTask "Job-00003" "Task31" -BatchContext $Context | Get-AzureBatchNodeFile -Recursive -BatchContext $Context IsDirectory Name Properties Url ----------- ---- ---------- --- False ProcessEnv.cmd Microsoft.Azure.Commands.Batch.Models.PSFile... https://cmdletexample.westus.Batch.contoso... False StdErr.txt Microsoft.Azure.Commands.Batch.Models.PSFile... https://cmdletexample.westus.Batch.contoso... False StdOut.txt Microsoft.Azure.Commands.Batch.Models.PSFile... https://cmdletexample.westus.Batch.contoso... True wd https://cmdletexample.westus.Batch.contoso... False wd\newFile.txt Microsoft.Azure.Commands.Batch.Models.PSFile... https://cmdletexample.westus.Batch.contoso... </dev:code> <dev:remarks> <maml:para>This command gets the properties of all files associated with the task that has the ID Task31 in job Job-00003. This command specifies the Recursive parameter. Therefore, the cmdlet performs a recursive file search is performed, and returns the wd\newFile.txt node file.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 4: Get a single file from a compute node </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureBatchNodeFile -PoolId "Pool22" -ComputeNodeId "ComputeNode01" -Name "Startup\StdOut.txt" -BatchContext $Context IsDirectory Name Properties Url ----------- ---- ---------- --- False startup\stdout.txt Microsoft.Azure.Commands.Batch.Models.PSFile... https://cmdletexample.westus.Batch.contoso... </dev:code> <dev:remarks> <maml:para>This command gets the file that is named Startup\StdOut.txt from the compute node that has the ID ComputeNode01 in the pool that has the ID Pool22.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 5: Get all files under a folder from a compute node </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureBatchNodeFile -PoolId "Pool22" -ComputeNodeId "ComputeNode01" -Filter "startswith(name,'startup')" -Recursive -BatchContext $Context IsDirectory Name Properties Url ----------- ---- ---------- --- True startup https://cmdletexample.westus.Batch.contoso... False startup\ProcessEnv.cmd Microsoft.Azure.Commands.Batch.Models.PSFile... https://cmdletexample.westus.Batch.contoso... False startup\stderr.txt Microsoft.Azure.Commands.Batch.Models.PSFile... https://cmdletexample.westus.Batch.contoso... False startup\stdout.txt Microsoft.Azure.Commands.Batch.Models.PSFile... https://cmdletexample.westus.Batch.contoso... True startup\wd https://cmdletexample.westus.Batch.contoso... </dev:code> <dev:remarks> <maml:para>This command gets all the files under the startup folder from the compute node that has the ID ComputeNode01 in the pool that has the ID Pool22. This cmdlet specifies the Recursive parameter.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 6: Get files from the root folder of a compute node</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureBatchComputeNode "Pool22" -Id "ComputeNode01" -BatchContext $Context | Get-AzureBatchNodeFile -BatchContext $Context IsDirectory Name Properties Url ----------- ---- ---------- --- True shared https://cmdletexample.westus.Batch.contoso... True startup https://cmdletexample.westus.Batch.contoso... True workitems https://cmdletexample.westus.Batch.contoso... </dev:code> <dev:remarks> <maml:para>This command gets all the files at the root folder of the compute node that has the ID ComputeNode01 in the pool that has the ID Pool22.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmBatchAccountKeys</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureBatchComputeNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureBatchTask</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>RMAzure_Batch_Cmdlets</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, batch</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzureBatchPool</command:name> <maml:description> <maml:para>Gets Batch pools under the specified Batch account.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureBatchPool</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureBatchPool cmdlet gets the Azure Batch pools under the Batch account specified with the BatchContext parameter. You can use the Id parameter to get a single pool, or you can use the Filter parameter to get the pools that match an OData filter. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureBatchPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies the OData filter clause to use when querying for pools. If you do not specify a filter, all pools under the Batch account specified with the BatchContext parameter are returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Select</maml:name> <maml:description> <maml:para>Specifies an OData select clause. Used to retrieve only specific properties instead of all object properties.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Expand</maml:name> <maml:description> <maml:para>Specifies an OData expand clause. Used to retrieve associated entities of the main entity being retrieved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MaxCount</maml:name> <maml:description> <maml:para>Specifies the maximum number of pools to return. If you specify a value of zero (0) or less, the cmdlet does not use an upper limit. The default value is 1000.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureBatchPool</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByValue,ByPropertyName)" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of the pool to retrieve. You cannot specify wildcard characters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Select</maml:name> <maml:description> <maml:para>Specifies an OData select clause. Used to retrieve only specific properties instead of all object properties.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Expand</maml:name> <maml:description> <maml:para>Specifies an OData expand clause. Used to retrieve associated entities of the main entity being retrieved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> <dev:type> <maml:name>BatchAccountContext</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies the OData filter clause to use when querying for pools. If you do not specify a filter, all pools under the Batch account specified with the BatchContext parameter are returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Select</maml:name> <maml:description> <maml:para>Specifies an OData select clause. Used to retrieve only specific properties instead of all object properties.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Expand</maml:name> <maml:description> <maml:para>Specifies an OData expand clause. Used to retrieve associated entities of the main entity being retrieved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByValue,ByPropertyName)" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of the pool to retrieve. You cannot specify wildcard characters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MaxCount</maml:name> <maml:description> <maml:para>Specifies the maximum number of pools to return. If you specify a value of zero (0) or less, the cmdlet does not use an upper limit. The default value is 1000.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PSCloudPool</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get a pool by ID</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureBatchPool -Id "MyPool" -BatchContext $Context AllocationState : Resizing AllocationStateTransitionTime : 7/25/2015 9:30:28 PM AutoScaleEnabled : False AutoScaleFormula : AutoScaleRun : CertificateReferences : CreationTime : 7/25/2015 9:30:28 PM CurrentDedicated : 0 CurrentOSVersion : * DisplayName : ETag : 0x8D29538429CF04C Id : MyPool InterComputeNodeCommunicationEnabled : False LastModified : 7/25/2015 9:30:28 PM MaxTasksPerComputeNode : 1 Metadata : OSFamily : 4 ResizeError : ResizeTimeout : 00:05:00 TaskSchedulingPolicy : Microsoft.Azure.Commands.Batch.Models.PSTaskSchedulingPolicy StartTask : State : Active StateTransitionTime : 7/25/2015 9:30:28 PM Statistics : TargetDedicated : 1 TargetOSVersion : * Url : https://cmdletexample.westus.batch.azure.com/pools/MyPool VirtualMachineSize : small </dev:code> <dev:remarks> <maml:para>This command gets the pool with ID MyPool.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Get all pools using an OData filter</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureBatchPool -Filter "startswith(id,'My')" -BatchContext $Context AllocationState : Resizing AllocationStateTransitionTime : 7/25/2015 9:30:28 PM AutoScaleEnabled : False AutoScaleFormula : AutoScaleRun : CertificateReferences : CreationTime : 7/25/2015 9:30:28 PM CurrentDedicated : 0 CurrentOSVersion : * DisplayName : ETag : 0x8D29538429CF04C Id : MyPool InterComputeNodeCommunicationEnabled : False LastModified : 7/25/2015 9:30:28 PM MaxTasksPerComputeNode : 1 Metadata : OSFamily : 4 ResizeError : ResizeTimeout : 00:05:00 TaskSchedulingPolicy : Microsoft.Azure.Commands.Batch.Models.PSTaskSchedulingPolicy StartTask : State : Active StateTransitionTime : 7/25/2015 9:30:28 PM Statistics : TargetDedicated : 1 TargetOSVersion : * Url : https://cmdletexample.westus.batch.azure.com/pools/MyPool VirtualMachineSize : small </dev:code> <dev:remarks> <maml:para>This command gets the pools whose IDs start with My by using the Filter parameter.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmBatchAccountKeys</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureBatchPool</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureBatchPool</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>RMAzure_Batch_Cmdlets</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, batch</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzureBatchRemoteDesktopProtocolFile</command:name> <maml:description> <maml:para>Gets an RDP file from a compute node.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureBatchRemoteDesktopProtocolFile</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureBatchRemoteDesktopProtocolFile cmdlet gets a Remote Desktop Protocol (RDP) file from a compute node and saves it as a file or to a user supplied stream.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureBatchRemoteDesktopProtocolFile</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="none"> <maml:name>PoolId</maml:name> <maml:description> <maml:para>Specifies the ID of the pool that contains the compute node from which this cmdlet gets an .rdp file. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases="none"> <maml:name>ComputeNodeId</maml:name> <maml:description> <maml:para>Specifies the ID of the compute node to which the .rdp file points. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>DestinationPath</maml:name> <maml:description> <maml:para>Specifies the file path where this cmdlet saves the .rdp file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureBatchRemoteDesktopProtocolFile</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>PoolId</maml:name> <maml:description> <maml:para>Specifies the ID of the pool that contains the compute node from which this cmdlet gets an .rdp file. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="2" aliases="none"> <maml:name>ComputeNodeId</maml:name> <maml:description> <maml:para>Specifies the ID of the compute node to which the .rdp file points. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>DestinationStream</maml:name> <maml:description> <maml:para>Specifies the stream into which this cmdlet directs the RDP data. This cmdlet does not close or rewind this stream.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Stream</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureBatchRemoteDesktopProtocolFile</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="1" aliases="none"> <maml:name>ComputeNode</maml:name> <maml:description> <maml:para>Specifies a compute node, as a PSComputeNode object, to which the .rdp file points. To obtain a compute node object, use the Get-AzureBatchComputeNode cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSComputeNode</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>DestinationPath</maml:name> <maml:description> <maml:para>Specifies the file path where this cmdlet saves the .rdp file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureBatchRemoteDesktopProtocolFile</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="1" aliases="none"> <maml:name>ComputeNode</maml:name> <maml:description> <maml:para>Specifies a compute node, as a PSComputeNode object, to which the .rdp file points. To obtain a compute node object, use the Get-AzureBatchComputeNode cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSComputeNode</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>DestinationStream</maml:name> <maml:description> <maml:para>Specifies the stream into which this cmdlet directs the RDP data. This cmdlet does not close or rewind this stream.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Stream</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> <dev:type> <maml:name>BatchAccountContext</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="1" aliases="none"> <maml:name>ComputeNode</maml:name> <maml:description> <maml:para>Specifies a compute node, as a PSComputeNode object, to which the .rdp file points. To obtain a compute node object, use the Get-AzureBatchComputeNode cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSComputeNode</command:parameterValue> <dev:type> <maml:name>PSComputeNode</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases="none"> <maml:name>ComputeNodeId</maml:name> <maml:description> <maml:para>Specifies the ID of the compute node to which the .rdp file points. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>DestinationPath</maml:name> <maml:description> <maml:para>Specifies the file path where this cmdlet saves the .rdp file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>DestinationStream</maml:name> <maml:description> <maml:para>Specifies the stream into which this cmdlet directs the RDP data. This cmdlet does not close or rewind this stream.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Stream</command:parameterValue> <dev:type> <maml:name>Stream</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="none"> <maml:name>PoolId</maml:name> <maml:description> <maml:para>Specifies the ID of the pool that contains the compute node from which this cmdlet gets an .rdp file. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get an RDP file from a specified compute node and save the file</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureBatchRemoteDesktopProtocolFile -PoolId "Pool06" -ComputeNodeId "ComputeNode01" -DestinationPath "C:\PowerShell\ComputeNode01.rdp" -BatchContext $Context </dev:code> <dev:remarks> <maml:para>This command gets an RDP file from the compute node that has the ID ComputeNode01 in the pool that has the ID Pool06. The command saves the .rdp file as C:\PowerShell\MyComputeNode.rdp. Use the Get-AzureRmBatchAccountKeys cmdlet to assign a context to the $Context variable.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Get an RDP file from a compute node and save the file by using the pipeline</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureBatchComputeNode -PoolId "Pool06" -Id "ComputeNode02" -BatchContext $Context | Get-AzureBatchRemoteDesktopProtocolFile -DestinationPath "C:\PowerShell\MyComputeNode02.rdp" -BatchContext $Context </dev:code> <dev:remarks> <maml:para>This command gets the compute node that has the ID ComputeNode02 in the pool that has the ID Pool06. The command passes that compute node to the current cmdlet by using the pipeline operator. The current cmdlet gets an .rpd file from the compute node, and then saves the contents as a file that is named C:\PowerShell\MyComputeNode02.rdp. </maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3: Get a RDP file from a specified compute node and direct it to a stream</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>$Stream = New-Object -TypeName "System.IO.MemoryStream" PS C:\> Get-AzureBatchRemoteDesktopProtocolFile "Pool06" -ComputeNodeId "ComputeNode03" -DestinationStream $Stream -BatchContext $Context </dev:code> <dev:remarks> <maml:para>The first command creates a stream by using the New-Object cmdlet, and then stores it in the $Stream variable. </maml:para> <maml:para>The second command gets an .rdp file from the compute node that has the ID ComputeNode03 in the pool that has the ID Pool06. The command directs file contents to the stream in $Stream. </maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmBatchAccountKeys</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureBatchComputeNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>RMAzure_Batch_Cmdlets</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, batch</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzureBatchTask</command:name> <maml:description> <maml:para>Gets the Batch tasks for the specified job.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureBatchTask</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureBatchTask cmdlet gets the Azure Batch tasks for the job specified by either the JobId parameter or the Job parameter. You can use the Id parameter to get a single task, or you can use the Filter parameter to get the tasks that match an OData filter. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureBatchTask</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="none"> <maml:name>JobId</maml:name> <maml:description> <maml:para>Specifies the ID of the job which contains the tasks.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies the OData filter clause to use when querying for tasks. If you do not specify a filter, then all tasks under the job specified with either the JobId parameter or the Job parameter will be returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Select</maml:name> <maml:description> <maml:para>Specifies an OData select clause. Used to retrieve only specific properties instead of all object properties.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Expand</maml:name> <maml:description> <maml:para>Specifies an OData expand clause. Used to retrieve associated entities of the main entity being retrieved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MaxCount</maml:name> <maml:description> <maml:para>Specifies the maximum number of tasks to return. If you specify a value of zero (0) or less, the cmdlet does not use an upper limit. The default value is 1000.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureBatchTask</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>JobId</maml:name> <maml:description> <maml:para>Specifies the ID of the job which contains the tasks.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of the task to retrieve. You cannot specify wildcard characters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Select</maml:name> <maml:description> <maml:para>Specifies an OData select clause. Used to retrieve only specific properties instead of all object properties.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Expand</maml:name> <maml:description> <maml:para>Specifies an OData expand clause. Used to retrieve associated entities of the main entity being retrieved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureBatchTask</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="1" aliases="none"> <maml:name>Job</maml:name> <maml:description> <maml:para>Specifies the PSCloudJob object representing the job which contains the tasks. Use the Get-AzureBatchJob cmdlet to get a PSCloudJob object.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCloudJob</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies the OData filter clause to use when querying for tasks. If you do not specify a filter, then all tasks under the job specified with either the JobId parameter or the Job parameter will be returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Select</maml:name> <maml:description> <maml:para>Specifies an OData select clause. Used to retrieve only specific properties instead of all object properties.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Expand</maml:name> <maml:description> <maml:para>Specifies an OData expand clause. Used to retrieve associated entities of the main entity being retrieved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MaxCount</maml:name> <maml:description> <maml:para>Specifies the maximum number of tasks to return. If you specify a value of zero (0) or less, the cmdlet does not use an upper limit. The default value is 1000.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> <dev:type> <maml:name>BatchAccountContext</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies the OData filter clause to use when querying for tasks. If you do not specify a filter, then all tasks under the job specified with either the JobId parameter or the Job parameter will be returned.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Select</maml:name> <maml:description> <maml:para>Specifies an OData select clause. Used to retrieve only specific properties instead of all object properties.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Expand</maml:name> <maml:description> <maml:para>Specifies an OData expand clause. Used to retrieve associated entities of the main entity being retrieved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of the task to retrieve. You cannot specify wildcard characters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="1" aliases="none"> <maml:name>Job</maml:name> <maml:description> <maml:para>Specifies the PSCloudJob object representing the job which contains the tasks. Use the Get-AzureBatchJob cmdlet to get a PSCloudJob object.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCloudJob</command:parameterValue> <dev:type> <maml:name>PSCloudJob</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="none"> <maml:name>JobId</maml:name> <maml:description> <maml:para>Specifies the ID of the job which contains the tasks.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MaxCount</maml:name> <maml:description> <maml:para>Specifies the maximum number of tasks to return. If you specify a value of zero (0) or less, the cmdlet does not use an upper limit. The default value is 1000.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PSCloudTask</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get a task by ID</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureBatchTask -JobId "Job01" -Id "MyTask" -BatchContext $Context AffinityInformation : CommandLine : cmd /c dir /s ComputeNodeInformation : Microsoft.Azure.Commands.Batch.Models.PSComputeNodeInformation Constraints : Microsoft.Azure.Commands.Batch.Models.PSTaskConstraints CreationTime : 7/25/2015 11:24:52 PM DisplayName : EnvironmentSettings : ETag : 0x8D295483E08BD9D ExecutionInformation : Microsoft.Azure.Commands.Batch.Models.PSTaskExecutionInformation Id : MyTask LastModified : 7/25/2015 11:24:52 PM PreviousState : Running PreviousStateTransitionTime : 7/25/2015 11:24:59 PM ResourceFiles : RunElevated : False State : Completed StateTransitionTime : 7/25/2015 11:24:59 PM Statistics : Url : https://cmdletexample.westus.batch.azure.com/jobs/Job01/tasks/MyTask </dev:code> <dev:remarks> <maml:para>This command gets the task with ID MyTask under job Job01.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Get all completed tasks from a specified job</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureBatchTask -JobId "Job02" -Filter "state eq 'completed'" -BatchContext $Context AffinityInformation : CommandLine : cmd /c dir /s ComputeNodeInformation : Microsoft.Azure.Commands.Batch.Models.PSComputeNodeInformation Constraints : Microsoft.Azure.Commands.Batch.Models.PSTaskConstraints CreationTime : 3/24/2015 10:21:51 PM EnvironmentSettings : ETag : 0x8D295483E08BD9D ExecutionInformation : Microsoft.Azure.Commands.Batch.Models.PSTaskExecutionInformation Id : MyTask LastModified : 3/24/2015 10:21:51 PM PreviousState : Running PreviousStateTransitionTime : 3/24/2015 10:22:00 PM ResourceFiles : RunElevated : False State : Completed StateTransitionTime : 3/24/2015 10:22:00 PM Statistics : Url : https://cmdletexample.westus.batch.azure.com/jobs/Job02/tasks/MyTask AffinityInformation : CommandLine : cmd /c echo hello > newFile.txt ComputeNodeInformation : Microsoft.Azure.Commands.Batch.Models.PSComputeNodeInformation Constraints : Microsoft.Azure.Commands.Batch.Models.PSTaskConstraints CreationTime : 3/24/2015 10:21:51 PM EnvironmentSettings : ETag : 0x8D295483E08BD9D ExecutionInformation : Microsoft.Azure.Commands.Batch.Models.PSTaskExecutionInformation Id : MyTask2 LastModified : 3/24/2015 10:23:35 PM PreviousState : Running PreviousStateTransitionTime : 3/24/2015 10:23:37 PM ResourceFiles : RunElevated : True State : Completed StateTransitionTime : 3/24/2015 10:23:37 PM Statistics : Url : https://cmdletexample.westus.batch.azure.com/jobs/Job02/tasks/MyTask2 </dev:code> <dev:remarks> <maml:para>This command gets the completed tasks from the job with ID Job02.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmBatchAccountKeys</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureBatchJob</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureBatchTask</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureBatchTask</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>RMAzure_Batch_Cmdlets</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, batch</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AzureRmBatchAccountKey</command:name> <maml:description> <maml:para>Regenerates the specified key of the specified Batch account.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureRMBatchAccountKey</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-AzureRmBatchAccountKey cmdlet regenerates the specified key of the specified Azure Batch account. The cmdlet outputs a BatchAccountContext object with its PrimaryAccountKey and SecondaryAccountKey properties populated with the latest access keys.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureRmBatchAccountKey</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="Name"> <maml:name>AccountName</maml:name> <maml:description> <maml:para>Specifies the name of the Batch account to regenerate the specified key.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the resource group of the account.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>KeyType</maml:name> <maml:description> <maml:para>Specifies the type of key to regenerate.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">Primary</command:parameterValue> <command:parameterValue required="true" variableLength="false">Secondary</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="Name"> <maml:name>AccountName</maml:name> <maml:description> <maml:para>Specifies the name of the Batch account to regenerate the specified key.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>KeyType</maml:name> <maml:description> <maml:para>Specifies the type of key to regenerate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the resource group of the account.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>BatchAccountContext</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Regenerate the primary account key on a named batch account</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>New-AzureRmBatchAccountKey -AccountName "cmdletexample" -KeyType "Primary" AccountName : cmdletexample Location : westus ResourceGroupName : CmdletExampleRG CoreQuota : 20 PoolQuota : 20 ActiveJobAndJobScheduleQuota : 20 Tags : TaskTenantUrl : https://cmdletexample.westus.batch.azure.com </dev:code> <dev:remarks> <maml:para>This command regenerates the primary account key on the Batch account named CmdletExample.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmBatchAccountKeys</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>RMAzure_Batch_Cmdlets</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, batch</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AzureRmBatchAccount</command:name> <maml:description> <maml:para>Creates a new Batch account.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureRMBatchAccount</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-AzureRmBatchAccount cmdlet creates a new Azure Batch account under the specified resource group and location.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureRmBatchAccount</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="Name"> <maml:name>AccountName</maml:name> <maml:description> <maml:para>Specifies the name of the Batch account to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="2" aliases="none"> <maml:name>Location</maml:name> <maml:description> <maml:para>Specifies the region where the account will be created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="3" aliases="none"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group where the account will be created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="Tags"> <maml:name>Tag</maml:name> <maml:description> <maml:para>Specifies tags in an array of hash tables to set on the account.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Hashtable[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="Name"> <maml:name>AccountName</maml:name> <maml:description> <maml:para>Specifies the name of the Batch account to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="2" aliases="none"> <maml:name>Location</maml:name> <maml:description> <maml:para>Specifies the region where the account will be created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="3" aliases="none"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group where the account will be created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="Tags"> <maml:name>Tag</maml:name> <maml:description> <maml:para>Specifies tags in an array of hash tables to set on the account.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">Hashtable[]</command:parameterValue> <dev:type> <maml:name>Hashtable[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>BatchAccountContext</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Create a new Batch account</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>New-AzureRmBatchAccount -AccountName "cmdletexample" -ResourceGroupName "CmdletExampleRG" -Location "WestUS" AccountName : cmdletexample Location : westus ResourceGroupName : CmdletExampleRG CoreQuota : 20 PoolQuota : 20 ActiveJobAndJobScheduleQuota : 20 Tags : TaskTenantUrl : https://cmdletexample.westus.batch.azure.com </dev:code> <dev:remarks> <maml:para>This command creates a new Batch account named cmdletexample using the CmdletExampleRG resource group in the WestUS location.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmBatchAccount</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmBatchAccount</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmBatchAccount</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>RMAzure_Batch_Cmdlets</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, batch</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AzureBatchComputeNodeUser</command:name> <maml:description> <maml:para>Creates a user account on a Batch compute node.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureBatchComputeNodeUser</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-AzureBatchComputeNodeUser cmdlet creates a user account on an Azure Batch compute node. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureBatchComputeNodeUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>PoolId</maml:name> <maml:description> <maml:para>Specifies the ID of the pool that contains the compute node on which to create the user account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="none"> <maml:name>ComputeNodeId</maml:name> <maml:description> <maml:para>Specifies the ID of the compute node on which this cmdlet creates a user account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ExpiryTime</maml:name> <maml:description> <maml:para>Specifies the expiry time for the new user account.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IsAdmin</maml:name> <maml:description> <maml:para>Indicates that the cmdlet creates a user account that has administrative credentials.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the new local Windows account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies the user account password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureBatchComputeNodeUser</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ComputeNode</maml:name> <maml:description> <maml:para>Specifies the compute node, as a PSComputeNode object, on which this cmdlet creates a user account.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSComputeNode</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ExpiryTime</maml:name> <maml:description> <maml:para>Specifies the expiry time for the new user account.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IsAdmin</maml:name> <maml:description> <maml:para>Indicates that the cmdlet creates a user account that has administrative credentials.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the new local Windows account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies the user account password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> <dev:type> <maml:name>BatchAccountContext</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ComputeNode</maml:name> <maml:description> <maml:para>Specifies the compute node, as a PSComputeNode object, on which this cmdlet creates a user account.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSComputeNode</command:parameterValue> <dev:type> <maml:name>PSComputeNode</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="none"> <maml:name>ComputeNodeId</maml:name> <maml:description> <maml:para>Specifies the ID of the compute node on which this cmdlet creates a user account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ExpiryTime</maml:name> <maml:description> <maml:para>Specifies the expiry time for the new user account.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IsAdmin</maml:name> <maml:description> <maml:para>Indicates that the cmdlet creates a user account that has administrative credentials.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the new local Windows account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Password</maml:name> <maml:description> <maml:para>Specifies the user account password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>PoolId</maml:name> <maml:description> <maml:para>Specifies the ID of the pool that contains the compute node on which to create the user account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Create a user account that has administrative credentials</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>New-AzureBatchComputeNodeUser -PoolId "MyPool01" -ComputeNodeId "ComputeNode01" -Name "TestUser" -Password "Password" -ExpiryTime ([DateTime]::Now.AddDays(7)) -IsAdmin -BatchContext $Context </dev:code> <dev:remarks> <maml:para>This command creates a user account on the compute node that has the ID ComputeNode01. The node is in the pool that has the ID MyPool01. The user name is TestUser, the password is Password, the account expires in seven days, and the account is has administrative credentials.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Create a user account on a compute node by using the pipeline</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureBatchComputeNode "MyPool01" -ComputeNodeId "ComputeNode01" -BatchContext $Context | New-AzureBatchComputeNodeUser -Name "TestUser" -Password "Password" -BatchContext $Context </dev:code> <dev:remarks> <maml:para>This command gets the compute node named ComputeNode01 by using the Get-AzureBatchComputeNode cmdlet. That node is in the pool that has the ID MyPool01. The command passes that compute node to the current cmdlet by using the pipeline operator. The command creates a user account that has the user name TestUserand the password Password.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmBatchAccountKeys</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureBatchComputeNode</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureBatchComputeNodeUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>RMAzure_Batch_Cmdlets</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, batch</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AzureBatchJobSchedule</command:name> <maml:description> <maml:para>Creates a job schedule in the Batch service.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureBatchJobSchedule</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-AzureBatchJobSchedule cmdlet creates a job schedule in the Azure Batch service. The BatchAccountContext parameter specifies the account in which this cmdlet creates the schedule.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureBatchJobSchedule</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of the job schedule that this cmdlet creates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Specifies a display name for the job schedule.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>Specifies metadata, as key/value pairs, to add to the job schedule. The key is the metadata name. The value is the metadata value.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">IDictionary</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>JobSpecification</maml:name> <maml:description> <maml:para>Specifies the details of the jobs that this cmdlet includes in the job schedule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSJobSpecification</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Schedule</maml:name> <maml:description> <maml:para>Specifies the schedule that determines when to create jobs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSSchedule</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> <dev:type> <maml:name>BatchAccountContext</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Specifies a display name for the job schedule.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of the job schedule that this cmdlet creates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>JobSpecification</maml:name> <maml:description> <maml:para>Specifies the details of the jobs that this cmdlet includes in the job schedule.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSJobSpecification</command:parameterValue> <dev:type> <maml:name>PSJobSpecification</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>Specifies metadata, as key/value pairs, to add to the job schedule. The key is the metadata name. The value is the metadata value.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">IDictionary</command:parameterValue> <dev:type> <maml:name>IDictionary</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Schedule</maml:name> <maml:description> <maml:para>Specifies the schedule that determines when to create jobs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSSchedule</command:parameterValue> <dev:type> <maml:name>PSSchedule</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Create a job schedule</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>$Schedule = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSSchedule" PS C:\> $Schedule.RecurrenceInterval = [TimeSpan]::FromDays(1) PS C:\> $JobSpecification = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSJobSpecification" PS C:\> $JobSpecification.PoolInformation = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSPoolInformation" PS C:\> $JobSpecification.PoolInformation.PoolId = "ContosoPool06" PS C:\> New-AzureBatchJobSchedule -Id "JobSchedule17" -Schedule $Schedule -JobSpecification $JobSpecification -BatchContext $Context </dev:code> <dev:remarks> <maml:para>This example creates a job schedule. The first five commands create and modify PSSchedule, PSJobSpecification, and PSPoolInformation objects. The commands use the New-Object cmdlet and standard Azure PowerShell syntax. The commands store these objects in the $Schedule and $JobSpecification variables.</maml:para> <maml:para>The final command creates a job schedule that has the ID JobSchedule17. This schedule creates jobs with a recurrence interval of one day. The jobs run on the pool that has the ID ContosoPool06, as specified in the fifth command. Use the Get-AzureRmBatchAccountKeys cmdlet to assign a context to the $Context variable.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmBatchAccountKeys</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureBatchJobSchedule</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureBatchJobSchedule</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>RMAzure_Batch_Cmdlets</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, batch</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AzureBatchJob</command:name> <maml:description> <maml:para>Creates a job in the Batch service.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureBatchJob</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-AzureBatchJob cmdlet creates a job in the Azure Batch service in the account specified by the BatchAccountContext parameter.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureBatchJob</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies an ID for the job.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>CommonEnvironmentSettings</maml:name> <maml:description> <maml:para>Specifies the common environment variables, as key/value pairs, that are set for all tasks in the job. The key is the environment variable name. The value is the environment variable value. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">IDictionary</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Constraints</maml:name> <maml:description> <maml:para>Specifies the run constraints for the job.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSJobConstraints</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Specifies the display name for the job.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>JobManagerTask</maml:name> <maml:description> <maml:para>Specifies the Job Manager task. The Batch service runs the Job Manager task when the job is started.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSJobManagerTask</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>JobPreparationTask</maml:name> <maml:description> <maml:para>Specifies the Job Preparation task. The Batch service runs the Job Preparation task on a compute node before it starts any tasks of that job on that compute node.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSJobPreparationTask</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>JobReleaseTask</maml:name> <maml:description> <maml:para>Specifies the Job Release task. The Batch service runs the Job Release task when the job ends. The Batch service runs the Job Release task on each compute node where it ran any task of the job.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSJobReleaseTask</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>Specifies metadata, as key/value pairs, to add to the job. The key is the metadata name. The value is the metadata value. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">IDictionary</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Priority</maml:name> <maml:description> <maml:para>Specifies the priority of the job. Valid values are: integers from -1000 to 1000. A value of -1000 is the lowest priority. A value of 1000 is the highest priority. The default value is 0.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>PoolInformation</maml:name> <maml:description> <maml:para>Specifies the details of the pool on which the Batch service runs the tasks of the job.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSPoolInformation</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> <dev:type> <maml:name>BatchAccountContext</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>CommonEnvironmentSettings</maml:name> <maml:description> <maml:para>Specifies the common environment variables, as key/value pairs, that are set for all tasks in the job. The key is the environment variable name. The value is the environment variable value. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">IDictionary</command:parameterValue> <dev:type> <maml:name>IDictionary</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Constraints</maml:name> <maml:description> <maml:para>Specifies the run constraints for the job.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSJobConstraints</command:parameterValue> <dev:type> <maml:name>PSJobConstraints</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Specifies the display name for the job.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies an ID for the job.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>JobManagerTask</maml:name> <maml:description> <maml:para>Specifies the Job Manager task. The Batch service runs the Job Manager task when the job is started.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSJobManagerTask</command:parameterValue> <dev:type> <maml:name>PSJobManagerTask</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>JobPreparationTask</maml:name> <maml:description> <maml:para>Specifies the Job Preparation task. The Batch service runs the Job Preparation task on a compute node before it starts any tasks of that job on that compute node.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSJobPreparationTask</command:parameterValue> <dev:type> <maml:name>PSJobPreparationTask</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>JobReleaseTask</maml:name> <maml:description> <maml:para>Specifies the Job Release task. The Batch service runs the Job Release task when the job ends. The Batch service runs the Job Release task on each compute node where it ran any task of the job.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSJobReleaseTask</command:parameterValue> <dev:type> <maml:name>PSJobReleaseTask</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>Specifies metadata, as key/value pairs, to add to the job. The key is the metadata name. The value is the metadata value. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">IDictionary</command:parameterValue> <dev:type> <maml:name>IDictionary</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>PoolInformation</maml:name> <maml:description> <maml:para>Specifies the details of the pool on which the Batch service runs the tasks of the job.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSPoolInformation</command:parameterValue> <dev:type> <maml:name>PSPoolInformation</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Priority</maml:name> <maml:description> <maml:para>Specifies the priority of the job. Valid values are: integers from -1000 to 1000. A value of -1000 is the lowest priority. A value of 1000 is the highest priority. The default value is 0.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Create a job</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>$PoolInformation = New-Object -TypeName "Microsoft.Azure.Commands.Batch.Models.PSPoolInformation" PS C:\> $PoolInformation.PoolId = "Pool22" PS C:\> New-AzureBatchJob -Id "ContosoJob35" -PoolInformation $PoolInformation -BatchContext $Context </dev:code> <dev:remarks> <maml:para>The first command creates a PSPoolInformation object by using the New-Object cmdlet. The command stores that object in the $PoolInformation variable. </maml:para> <maml:para>The second command assigns the ID Pool22 to the PoolId property of the object in $PoolInformation.</maml:para> <maml:para>The final command creates a job that has the ID ContosoJob35. Tasks added to the job run on the pool that has the ID Pool22. Use the Get-AzureRmBatchAccountKeys cmdlet to assign a context to the $Context variable.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmBatchAccountKeys</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureBatchJobSchedule</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureBatchJob</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>RMAzure_Batch_Cmdlets</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, batch</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AzureBatchPool</command:name> <maml:description> <maml:para>Creates a new pool in the Batch service under the specified account.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureBatchPool</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-AzureBatchPool cmdlet creates a new pool in the Azure Batch service under the account specified by the BatchContext parameter.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureBatchPool</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of the pool to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>AutoScaleFormula</maml:name> <maml:description> <maml:para>Specifies the formula for automatically scaling the pool. For more information on Autoscale formulas, see <maml:navigationLink><maml:linkText>Define the Autoscaling Formula for a Pool</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (https://msdn.microsoft.com/en-us/library/azure/dn820182.aspx) in the Microsoft Developer Network Library.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>CertificateReferences</maml:name> <maml:description> <maml:para>Specifies certificates associated with the pool. The Batch service installs the referenced certificates on each compute node of the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PSCertificateReference[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Specifies the display name of the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>InterComputeNodeCommunicationEnabled</maml:name> <maml:description> <maml:para>Indicates that this cmdlet sets up the pool for direct communication between dedicated compute nodes.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MaxTasksPerComputeNode</maml:name> <maml:description> <maml:para>Specifies the maximum number of tasks that can run on a single compute node.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>Specifies the metadata, as key/value pairs, to add to the new pool. The key is the metadata name. The value is the metadata value. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">IDictionary</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>StartTask</maml:name> <maml:description> <maml:para>Specifies the start task specification for the pool. The start task is run when a compute node joins the pool, or when the compute node is rebooted or reimaged.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSStartTask</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>TargetOSVersion</maml:name> <maml:description> <maml:para>Specifies the target operating system version of the compute nodes in the pool. You can use "*" for the latest operating system version for the specified family. For more information about operating system families and versions, see <maml:navigationLink><maml:linkText>Azure Guest OS Releases and SDK Compatibility Matrix</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://azure.microsoft.com/en-us/documentation/articles/cloud-services-guestos-update-matrix/) in the Microsoft Developer Network Library.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>TaskSchedulingPolicy</maml:name> <maml:description> <maml:para>Specifies the task scheduling policy, such as the ComputeNodeFillType.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSTaskSchedulingPolicy</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>OSFamily</maml:name> <maml:description> <maml:para>Specifies the operating system family of the compute nodes in the pool. For more information about operating system families and versions, see <maml:navigationLink><maml:linkText>Azure Guest OS Releases and SDK Compatibility Matrix</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://azure.microsoft.com/en-us/documentation/articles/cloud-services-guestos-update-matrix/) in the Microsoft Developer Library.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>VirtualMachineSize</maml:name> <maml:description> <maml:para>Specifies the size of the virtual machines in the pool. For more information on virtual machine sizes, see <maml:navigationLink><maml:linkText>Sizes for Virtual Machines</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (https://azure.microsoft.com/en-us/documentation/articles/virtual-machines-size-specs/) in the Microsoft Developer Network Library. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureBatchPool</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of the pool to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>CertificateReferences</maml:name> <maml:description> <maml:para>Specifies certificates associated with the pool. The Batch service installs the referenced certificates on each compute node of the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PSCertificateReference[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Specifies the display name of the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>InterComputeNodeCommunicationEnabled</maml:name> <maml:description> <maml:para>Indicates that this cmdlet sets up the pool for direct communication between dedicated compute nodes.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MaxTasksPerComputeNode</maml:name> <maml:description> <maml:para>Specifies the maximum number of tasks that can run on a single compute node.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>Specifies the metadata, as key/value pairs, to add to the new pool. The key is the metadata name. The value is the metadata value. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">IDictionary</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ResizeTimeout</maml:name> <maml:description> <maml:para>Specifies the timeout for allocating compute nodes to the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TimeSpan</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>StartTask</maml:name> <maml:description> <maml:para>Specifies the start task specification for the pool. The start task is run when a compute node joins the pool, or when the compute node is rebooted or reimaged.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSStartTask</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>TargetDedicated</maml:name> <maml:description> <maml:para>Specifies the target number of compute nodes to allocate to the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>TargetOSVersion</maml:name> <maml:description> <maml:para>Specifies the target operating system version of the compute nodes in the pool. You can use "*" for the latest operating system version for the specified family. For more information about operating system families and versions, see <maml:navigationLink><maml:linkText>Azure Guest OS Releases and SDK Compatibility Matrix</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://azure.microsoft.com/en-us/documentation/articles/cloud-services-guestos-update-matrix/) in the Microsoft Developer Network Library.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>TaskSchedulingPolicy</maml:name> <maml:description> <maml:para>Specifies the task scheduling policy, such as the ComputeNodeFillType.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSTaskSchedulingPolicy</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>OSFamily</maml:name> <maml:description> <maml:para>Specifies the operating system family of the compute nodes in the pool. For more information about operating system families and versions, see <maml:navigationLink><maml:linkText>Azure Guest OS Releases and SDK Compatibility Matrix</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://azure.microsoft.com/en-us/documentation/articles/cloud-services-guestos-update-matrix/) in the Microsoft Developer Library.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>VirtualMachineSize</maml:name> <maml:description> <maml:para>Specifies the size of the virtual machines in the pool. For more information on virtual machine sizes, see <maml:navigationLink><maml:linkText>Sizes for Virtual Machines</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (https://azure.microsoft.com/en-us/documentation/articles/virtual-machines-size-specs/) in the Microsoft Developer Network Library. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>AutoScaleFormula</maml:name> <maml:description> <maml:para>Specifies the formula for automatically scaling the pool. For more information on Autoscale formulas, see <maml:navigationLink><maml:linkText>Define the Autoscaling Formula for a Pool</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (https://msdn.microsoft.com/en-us/library/azure/dn820182.aspx) in the Microsoft Developer Network Library.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> <dev:type> <maml:name>BatchAccountContext</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>CertificateReferences</maml:name> <maml:description> <maml:para>Specifies certificates associated with the pool. The Batch service installs the referenced certificates on each compute node of the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">PSCertificateReference[]</command:parameterValue> <dev:type> <maml:name>PSCertificateReference[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Specifies the display name of the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of the pool to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>InterComputeNodeCommunicationEnabled</maml:name> <maml:description> <maml:para>Indicates that this cmdlet sets up the pool for direct communication between dedicated compute nodes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MaxTasksPerComputeNode</maml:name> <maml:description> <maml:para>Specifies the maximum number of tasks that can run on a single compute node.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>Specifies the metadata, as key/value pairs, to add to the new pool. The key is the metadata name. The value is the metadata value. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">IDictionary</command:parameterValue> <dev:type> <maml:name>IDictionary</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>OSFamily</maml:name> <maml:description> <maml:para>Specifies the operating system family of the compute nodes in the pool. For more information about operating system families and versions, see <maml:navigationLink><maml:linkText>Azure Guest OS Releases and SDK Compatibility Matrix</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://azure.microsoft.com/en-us/documentation/articles/cloud-services-guestos-update-matrix/) in the Microsoft Developer Library.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ResizeTimeout</maml:name> <maml:description> <maml:para>Specifies the timeout for allocating compute nodes to the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TimeSpan</command:parameterValue> <dev:type> <maml:name>TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>StartTask</maml:name> <maml:description> <maml:para>Specifies the start task specification for the pool. The start task is run when a compute node joins the pool, or when the compute node is rebooted or reimaged.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSStartTask</command:parameterValue> <dev:type> <maml:name>PSStartTask</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>TargetDedicated</maml:name> <maml:description> <maml:para>Specifies the target number of compute nodes to allocate to the pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>TargetOSVersion</maml:name> <maml:description> <maml:para>Specifies the target operating system version of the compute nodes in the pool. You can use "*" for the latest operating system version for the specified family. For more information about operating system families and versions, see <maml:navigationLink><maml:linkText>Azure Guest OS Releases and SDK Compatibility Matrix</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (http://azure.microsoft.com/en-us/documentation/articles/cloud-services-guestos-update-matrix/) in the Microsoft Developer Network Library.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>TaskSchedulingPolicy</maml:name> <maml:description> <maml:para>Specifies the task scheduling policy, such as the ComputeNodeFillType.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSTaskSchedulingPolicy</command:parameterValue> <dev:type> <maml:name>PSTaskSchedulingPolicy</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>VirtualMachineSize</maml:name> <maml:description> <maml:para>Specifies the size of the virtual machines in the pool. For more information on virtual machine sizes, see <maml:navigationLink><maml:linkText>Sizes for Virtual Machines</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (https://azure.microsoft.com/en-us/documentation/articles/virtual-machines-size-specs/) in the Microsoft Developer Network Library. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Create a new pool using the TargetDedicated parameter set</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>New-AzureBatchPool -Id "MyPool" -VirtualMachineSize "small" -OSFamily "4" -TargetOSVersion "*" -TargetDedicated 3 -BatchContext $Context </dev:code> <dev:remarks> <maml:para>This command creates a new pool with id MyPool using the TargetDedicated parameter set. The target allocation is three compute nodes. The pool will use small virtual machines imaged with the latest operating system version of family four.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Create a new pool using the AutoScale parameter set</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>New-AzureBatchPool -Id "AutoScalePool" -VirtualMachineSize "small" -OSFamily "4" -TargetOSVersion "*" -AutoScaleFormula '$TargetDedicated=2;' -BatchContext $Context </dev:code> <dev:remarks> <maml:para>This command creates a new pool with ID AutoScalePool using the AutoScale parameter set. The pool will use small virtual machines imaged with the latest operating system version of family four, and the target number of compute nodes will be determined by the Autoscale formula.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmBatchAccountKeys</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureBatchPool</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureBatchPool</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>RMAzure_Batch_Cmdlets</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, batch</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AzureBatchTask</command:name> <maml:description> <maml:para>Creates a new Batch task under the specified job.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureBatchTask</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-AzureBatchTask cmdlet creates a new Azure Batch task under the job specified by the JobId parameter or the Job parameter.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureBatchTask</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>AffinityInformation</maml:name> <maml:description> <maml:para>Specifies a locality hint that can be used by the Batch service to select a node on which to start the task.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSAffinityInformation</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Constraints</maml:name> <maml:description> <maml:para>Specifies the run constraints for the task.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSTaskConstraints</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Specifies the display name of the task.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>EnvironmentSettings</maml:name> <maml:description> <maml:para>Specifies the environment settings to add to the new task. For each key/value pair, set the key to the environment setting name, and the value to the environment setting.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">IDictionary</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ResourceFiles</maml:name> <maml:description> <maml:para>Specifies resource files required by the task. For each key/value pair, set the key to the resource file path, and the value to the resource file blob source.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">IDictionary</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>RunElevated</maml:name> <maml:description> <maml:para>Indicates that the task process runs elevated as Administrator. Otherwise, the process runs without elevation.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>CommandLine</maml:name> <maml:description> <maml:para>Specifies the command-line command for the task.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of the task to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>JobId</maml:name> <maml:description> <maml:para>Specifies the ID of the job to create the task under.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureBatchTask</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>AffinityInformation</maml:name> <maml:description> <maml:para>Specifies a locality hint that can be used by the Batch service to select a node on which to start the task.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSAffinityInformation</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Constraints</maml:name> <maml:description> <maml:para>Specifies the run constraints for the task.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSTaskConstraints</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Specifies the display name of the task.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>EnvironmentSettings</maml:name> <maml:description> <maml:para>Specifies the environment settings to add to the new task. For each key/value pair, set the key to the environment setting name, and the value to the environment setting.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">IDictionary</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>Job</maml:name> <maml:description> <maml:para>Specifies the PSCloudJob object representing the job to create the task under. Use the Get-AzureBatchJob cmdlet to get a PSCloudJob object.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCloudJob</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ResourceFiles</maml:name> <maml:description> <maml:para>Specifies resource files required by the task. For each key/value pair, set the key to the resource file path, and the value to the resource file blob source.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">IDictionary</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>RunElevated</maml:name> <maml:description> <maml:para>Indicates that the task process runs elevated as Administrator. Otherwise, the process runs without elevation.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>CommandLine</maml:name> <maml:description> <maml:para>Specifies the command-line command for the task.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of the task to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>AffinityInformation</maml:name> <maml:description> <maml:para>Specifies a locality hint that can be used by the Batch service to select a node on which to start the task.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSAffinityInformation</command:parameterValue> <dev:type> <maml:name>PSAffinityInformation</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> <dev:type> <maml:name>BatchAccountContext</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>CommandLine</maml:name> <maml:description> <maml:para>Specifies the command-line command for the task.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Constraints</maml:name> <maml:description> <maml:para>Specifies the run constraints for the task.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSTaskConstraints</command:parameterValue> <dev:type> <maml:name>PSTaskConstraints</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Specifies the display name of the task.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>EnvironmentSettings</maml:name> <maml:description> <maml:para>Specifies the environment settings to add to the new task. For each key/value pair, set the key to the environment setting name, and the value to the environment setting.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">IDictionary</command:parameterValue> <dev:type> <maml:name>IDictionary</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of the task to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>Job</maml:name> <maml:description> <maml:para>Specifies the PSCloudJob object representing the job to create the task under. Use the Get-AzureBatchJob cmdlet to get a PSCloudJob object.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCloudJob</command:parameterValue> <dev:type> <maml:name>PSCloudJob</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>JobId</maml:name> <maml:description> <maml:para>Specifies the ID of the job to create the task under.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ResourceFiles</maml:name> <maml:description> <maml:para>Specifies resource files required by the task. For each key/value pair, set the key to the resource file path, and the value to the resource file blob source.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">IDictionary</command:parameterValue> <dev:type> <maml:name>IDictionary</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>RunElevated</maml:name> <maml:description> <maml:para>Indicates that the task process runs elevated as Administrator. Otherwise, the process runs without elevation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Create a new Batch task</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>New-AzureBatchTask -JobId "Job-000001" -Id "MyTask" -CommandLine "cmd /c dir /s" -BatchContext $Context </dev:code> <dev:remarks> <maml:para>This command creates a new task with ID MyTask under job Job-000001. The task will run the command-line "cmd /c dir /s".</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Create a new Batch task</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureBatchJob -Id "Job-000001" -BatchContext $Context | New-AzureBatchTask -Id "MyTask2" -CommandLine "cmd /c echo hello > newFile.txt" -RunElevated -BatchContext $Context </dev:code> <dev:remarks> <maml:para>This command creates a new task with ID MyTask2 under job Job-000001. The task will run the command-line "cmd /c echo hello > newFile.txt" with elevated permissions.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmBatchAccountKeys</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureBatchJob</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureBatchTask</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureBatchTask</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>RMAzure_Batch_Cmdlets</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, batch</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AzureRmBatchAccount</command:name> <maml:description> <maml:para>Removes the specified Batch account.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureRMBatchAccount</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-AzureRmBatchAccount cmdlet removes the specified Azure Batch account. You will be prompted for confirmation unless you use the Force parameter.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureRmBatchAccount</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="Name"> <maml:name>AccountName</maml:name> <maml:description> <maml:para>Specifies the name of the batch account to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="2" aliases="none"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the resource group of the account to remove.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="Name"> <maml:name>AccountName</maml:name> <maml:description> <maml:para>Specifies the name of the batch account to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="2" aliases="none"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the resource group of the account to remove.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Remove a batch account by name</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Remove-AzureRmBatchAccount -AccountName "cmdletexample" </dev:code> <dev:remarks> <maml:para>This command removes the batch account named cmdletexample. The user is prompted for confirmation before the delete operation takes place.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmBatchAccount</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmBatchAccount</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmBatchAccount</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>RMAzure_Batch_Cmdlets</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, batch</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AzureBatchComputeNodeUser</command:name> <maml:description> <maml:para>Deletes a user account from a Batch compute node.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureBatchComputeNodeUser</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-AzureBatchComputeNodeUser cmdlet deletes a user account from an Azure Batch compute node.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureBatchComputeNodeUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>PoolId</maml:name> <maml:description> <maml:para>Specifies the ID of the pool that contains the compute node on which to delete the user account. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="2" aliases="none"> <maml:name>ComputeNodeId</maml:name> <maml:description> <maml:para>Specifies the ID of the compute node on which this cmdlet deletes the user account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the user account to delete. You cannot specify wildcard characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> <dev:type> <maml:name>BatchAccountContext</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="2" aliases="none"> <maml:name>ComputeNodeId</maml:name> <maml:description> <maml:para>Specifies the ID of the compute node on which this cmdlet deletes the user account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the user account to delete. You cannot specify wildcard characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>PoolId</maml:name> <maml:description> <maml:para>Specifies the ID of the pool that contains the compute node on which to delete the user account. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Delete a user from a compute node without confirmation</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Remove-AzureBatchComputeNodeUser -PoolId "Pool01" -ComputeNodeId "ComputeNode01" -Name "User14" -Force -BatchContext $Context </dev:code> <dev:remarks> <maml:para>This command deletes the user named User14 from compute node named ComputeNode01. The compute node is in the pool named Pool01. This command specifies the Force parameter. Therefore, the command does not prompt you for confirmation. </maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmBatchAccountKeys</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureBatchComputeNodeUser</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>RMAzure_Batch_Cmdlets</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, batch</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AzureBatchJobSchedule</command:name> <maml:description> <maml:para>Removes a Batch job schedule.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureBatchJobSchedule</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-AzureBatchJobSchedule cmdlet removes an Azure Batch job schedule. This cmdlet prompts you for confirmation before it removes a schedule. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureBatchJobSchedule</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of the job schedule that this cmdlet removes. You cannot specify wildcard characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> <dev:type> <maml:name>BatchAccountContext</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of the job schedule that this cmdlet removes. You cannot specify wildcard characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Delete a job schedule </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Remove-AzureBatchJobSchedule "JobSchedule17" -BatchContext $Context </dev:code> <dev:remarks> <maml:para>This command deletes the job schedule that has the ID JobSchedule17. Use the Get-AzureRmBatchAccountKeys cmdlet to assign a context to the $Context variable. This command prompts you before it removes the schedule.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Delete a job schedule without confirmation </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureBatchJobSchedule -Id "JobSchedule23" -BatchContext $Context | Remove-AzureBatchJobSchedule -Force -BatchContext $Context </dev:code> <dev:remarks> <maml:para>This command gets the job schedule that has the ID JobSchedule23 by using the Get-AzureBatchJobSchedule cmdlet. The command passes that schedule to the current cmdlet by using the pipeline operator. The command removes that schedule. The command specifies the Force parameter. Therefore, it does not prompt you for confirmation.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureBatchJobSchedule</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureBatchJobSchedule</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>RMAzure_Batch_Cmdlets</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, batch</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AzureBatchJob</command:name> <maml:description> <maml:para>Deletes the specified Batch job.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureBatchJob</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-AzureBatchJob cmdlet deletes the specified Azure Batch job. You will be prompted for confirmation unless you use the Force parameter.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureBatchJob</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of the job to delete. You cannot specify wildcard characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> <dev:type> <maml:name>BatchAccountContext</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of the job to delete. You cannot specify wildcard characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Delete a Batch job by id </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Remove-AzureBatchJob -Id "Job-000001" -BatchContext $Context </dev:code> <dev:remarks> <maml:para>This command deletes the job with ID Job-000001. The user is prompted for confirmation before the delete operation takes place.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Delete a Batch job by pipelining without confirmation</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureBatchJob -Id "Job-000002" -BatchContext $Context | Remove-AzureBatchJob -Force -BatchContext $Context </dev:code> <dev:remarks> <maml:para>This command deletes the job with ID Job-000002. Since the Force parameter is present, the confirmation prompt is suppressed.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmBatchAccountKeys</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureBatchJob</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>RMAzure_Batch_Cmdlets</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, batch</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AzureBatchPool</command:name> <maml:description> <maml:para>Deletes the specified Batch pool.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureBatchPool</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-AzureBatchPool cmdlet deletes the specified Azure Batch pool. You will be prompted for confirmation unless you use the Force parameter.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureBatchPool</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of the pool to delete. You cannot specify wildcard characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> <dev:type> <maml:name>BatchAccountContext</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of the pool to delete. You cannot specify wildcard characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Delete a Batch pool by pool ID</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Remove-AzureBatchPool -Id "MyPool" -BatchContext $Context </dev:code> <dev:remarks> <maml:para>This command deletes the pool with ID MyPool. The user is prompted for confirmation before the delete operation takes place.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Delete all Batch pools by force</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureBatchPool -BatchContext $Context | Remove-AzureBatchPool -Force -BatchContext $Context </dev:code> <dev:remarks> <maml:para>This command deletes all Batch pools. Since the Force parameter is present, the confirmation prompt is suppressed.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureBatchPool</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureBatchPool</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmBatchAccountKeys</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>RMAzure_Batch_Cmdlets</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, batch</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AzureBatchTask</command:name> <maml:description> <maml:para>Deletes the specified Batch task.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureBatchTask</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-AzureBatchTask cmdlet deletes the specified Azure Batch task. You will be prompted for confirmation unless you use the Force parameter.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureBatchTask</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>JobId</maml:name> <maml:description> <maml:para>Specifies the ID of the job containing the task to delete.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="2" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of the task to delete. You cannot specify wildcard characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-AzureBatchTask</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="1" aliases="none"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the PSCloudTask object representing the task to delete. Use the Get-AzureBatchTask cmdlet to get a PSCloudTask object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCloudTask</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> <dev:type> <maml:name>BatchAccountContext</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="2" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of the task to delete. You cannot specify wildcard characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="1" aliases="none"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the PSCloudTask object representing the task to delete. Use the Get-AzureBatchTask cmdlet to get a PSCloudTask object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCloudTask</command:parameterValue> <dev:type> <maml:name>PSCloudTask</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>JobId</maml:name> <maml:description> <maml:para>Specifies the ID of the job containing the task to delete.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Delete a Batch task by id with user confirmation </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Remove-AzureBatchTask -JobId "Job-000001" -Id "MyTask" -BatchContext $Context </dev:code> <dev:remarks> <maml:para>This command deletes the task with ID MyTask in job Job-000001. The user is prompted for confirmation before the delete operation takes place.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Delete a Batch task by id without user confirmation </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureBatchTask "Job-000001" "MyTask2" -BatchContext $Context | Remove-AzureBatchTask -Force -BatchContext $Context </dev:code> <dev:remarks> <maml:para>This command deletes the task with id MyTask2 in job Job-000001. Since the Force parameter is present, the confirmation prompt is suppressed.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmBatchAccountKeys</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureBatchTask</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureBatchTask</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>RMAzure_Batch_Cmdlets</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, batch</maml:para> </maml:alert> </maml:alertSet> </command:command> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">The Azure Batch cmdlets in the Azure module enable you to manage Microsoft Azure Batch services in Azure PowerShell.</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Azure PowerShell is a command-line shell and scripting language designed to help information technology (IT) professionals automate system administration tasks. To install the latest Azure PowerShell version and associate it with your Azure subscription, see <maml:navigationLink><maml:linkText>How to install and configure Azure PowerShell</maml:linkText><maml:uri></maml:uri></maml:navigationLink>. For more information about Azure Resource Manager cmdlets, see <maml:navigationLink><maml:linkText>Using Azure PowerShell with Azure Resource Manager</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Before you run cmdlets in Azure Resource Manager, switch to Azure Resource Manager mode. To switch to this mode, type the following command: Switch-AzureMode AzureResourceManager</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <maml:para>The Switch-AzureMode cmdlet is deprecated. For more information, see <maml:navigationLink><maml:linkText>Deprecation of Switch AzureMode in Azure PowerShell</maml:linkText><maml:uri></maml:uri></maml:navigationLink> (https://github.com/Azure/azure-powershell/wiki/Deprecation-of-Switch-AzureMode-in-Azure-PowerShell).</maml:para> <maml:para>This deprecation is a breaking change. You may need to revise scripts that operate in Azure Resource Manager.</maml:para> </maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">The following cmdlets are the Azure Batch cmdlets in the Azure module:</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Name</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Description</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Get-AzureRmBatchAccount</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Gets a Batch account under the current subscription.</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Get-AzureRmBatchAccountKeys</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Gets the specified key of the specified Batch accounts under the current subscription.</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Get-AzureBatchComputeNode</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Gets Batch compute nodes from a pool.</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Get-AzureBatchJob</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Gets Batch jobs under the specified Batch account or job schedule.</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Get-AzureBatchJobSchedule</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Gets Batch job schedules.</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Get-AzureBatchNodeFile</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Gets the properties of Batch node files.</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Get-AzureBatchNodeFileContent</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Gets a Batch node file.</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Get-AzureBatchPool</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Gets Batch pools under the specified Batch account.</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Get-AzureBatchRemoteDesktopProtocolFile</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Gets an RDP file from a compute node.</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Get-AzureBatchTask</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Gets the Batch tasks for the specified job.</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">New-AzureRmBatchAccount</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Creates a new Batch account.</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">New-AzureRmBatchAccountKey</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Regenerates the specified key of the specified Batch account.</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">New-AzureBatchComputeNodeUser</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Creates a user account on a Batch compute node.</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">New-AzureBatchJob</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Creates a job in the Batch service.</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">New-AzureBatchJobSchedule</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Creates a job schedule in the Batch service.</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">New-AzureBatchPool</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Creates a new pool in the Batch service under the specified account.</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">New-AzureBatchTask</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Creates a new Batch task under the specified job.</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Remove-AzureRmBatchAccount</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Removes the specified Batch account.</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Remove-AzureBatchComputeNodeUser</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Deletes a user account from a Batch compute node.</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Remove-AzureBatchJob</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Deletes the specified Batch job.</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Remove-AzureBatchJobSchedule</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Removes a Batch job schedule.</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Remove-AzureBatchPool</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Deletes the specified Batch pool.</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Remove-AzureBatchTask</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Deletes the specified Batch task.</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Set-AzureRmBatchAccount</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Updates the specified Batch account.</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Start-AzureBatchPoolResize</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Starts to resize a pool.</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Stop-AzureBatchPoolResize</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Stops a pool resize operation.</maml:para> <maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">For more information about, or for the syntax of, any of the cmdlets, use the Get-Help <cmdlet name> cmdlet, where <cmdlet name> is the name of the cmdlet that you want to research. For more detailed information, you can run any of the following cmdlets: ● Get-Help <cmdlet name> -Detailed ● Get-Help <cmdlet name> -Examples ● Get-Help <cmdlet name> -Full </maml:para> <maml:navigationLink xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <maml:linkText>Azure Cmdlet Reference</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink>Azure Resource Manager Cmdlets<maml:navigationLink xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><maml:linkText>Using Windows Powershell with Resource Manager</maml:linkText><maml:uri></maml:uri></maml:navigationLink><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Set-AzureRmBatchAccount</command:name><maml:description><maml:para>Updates the specified Batch account.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Set</command:verb><command:noun>AzureRMBatchAccount</command:noun><dev:version /></command:details><maml:description><maml:para>The Set-AzureRmBatchAccount cmdlet updates the specified Azure Batch account. Currently, only tags can be updated.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Set-AzureRmBatchAccount</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="Name"><maml:name>AccountName</maml:name><maml:description><maml:para>Specifies the name of the existing Batch account to update.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true(ByPropertyName)" position="2" aliases="Tags"><maml:name>Tag</maml:name><maml:description><maml:para>Specifies tags in an array of hash tables to set on the account.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">Hashtable[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"><maml:name>Profile</maml:name><maml:description><maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name><maml:description><maml:para>Specifies the resource group of the account being updated.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">String</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="Name"><maml:name>AccountName</maml:name><maml:description><maml:para>Specifies the name of the existing Batch account to update.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue>none</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"><maml:name>Profile</maml:name><maml:description><maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue><dev:type><maml:name>AzureProfile</maml:name><maml:uri /></dev:type><dev:defaultValue>none</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name><maml:description><maml:para>Specifies the resource group of the account being updated.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue>none</dev:defaultValue></command:parameter><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true(ByPropertyName)" position="2" aliases="Tags"><maml:name>Tag</maml:name><maml:description><maml:para>Specifies tags in an array of hash tables to set on the account.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">Hashtable[]</command:parameterValue><dev:type><maml:name>Hashtable[]</maml:name><maml:uri /></dev:type><dev:defaultValue>none</dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name></maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para></maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>BatchAccountContext</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para></maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>Example 1: Update the tags on an existing Batch account</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>Set-AzureRmBatchAccount -AccountName "cmdletexample" -Tag @(@{Name = "tag1";Value = "value1"},@{Name = "tag2";Value = "value2"}) AccountName : cmdletexample Location : westus ResourceGroupName : CmdletExampleRG CoreQuota : 20 PoolQuota : 20 ActiveJobAndJobScheduleQuota : 20 Tags : Name Value ==== ====== tag1 value1 tag2 value2 TaskTenantUrl : https://cmdletexample.westus.batch.azure.com </dev:code><dev:remarks><maml:para>This command updates the tags on the cmdletexample account.</maml:para><maml:para /><maml:para /></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Get-AzureRmBatchAccount</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>New-AzureRmBatchAccount</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Remove-AzureRmBatchAccount</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>RMAzure_Batch_Cmdlets</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks><maml:alertSet><maml:alert><maml:para>Keywords: azure, azurerm, arm, resource, management, manager, batch</maml:para></maml:alert></maml:alertSet></command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Start-AzureBatchPoolResize</command:name><maml:description><maml:para>Starts to resize a pool.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Start</command:verb><command:noun>AzureBatchPoolResize</command:noun><dev:version /></command:details><maml:description><maml:para>The Start-AzureBatchPoolResize cmdlet starts an Azure Batch resize operation on a pool.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Start-AzureBatchPoolResize</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue,ByPropertyName)" position="1" aliases="none"><maml:name>Id</maml:name><maml:description><maml:para>Specifies the ID of the pool that this cmdlet resizes.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"><maml:name>ComputeNodeDeallocationOption</maml:name><maml:description><maml:para>Specifies a deallocation option for the resizing operation that this cmdlet starts.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">ComputeNodeDeallocationOption</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"><maml:name>Profile</maml:name><maml:description><maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"><maml:name>ResizeTimeout</maml:name><maml:description><maml:para>Specifies a time-out period for the resizing operation. If the pool does not reach the target size by this time, the resize operation stops.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">TimeSpan</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"><maml:name>BatchContext</maml:name><maml:description><maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"><maml:name>TargetDedicated</maml:name><maml:description><maml:para>Specifies the target number of dedicated compute nodes.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"><maml:name>BatchContext</maml:name><maml:description><maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue><dev:type><maml:name>BatchAccountContext</maml:name><maml:uri /></dev:type><dev:defaultValue>none</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"><maml:name>ComputeNodeDeallocationOption</maml:name><maml:description><maml:para>Specifies a deallocation option for the resizing operation that this cmdlet starts.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">ComputeNodeDeallocationOption</command:parameterValue><dev:type><maml:name>ComputeNodeDeallocationOption</maml:name><maml:uri /></dev:type><dev:defaultValue>none</dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue,ByPropertyName)" position="1" aliases="none"><maml:name>Id</maml:name><maml:description><maml:para>Specifies the ID of the pool that this cmdlet resizes.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue>none</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"><maml:name>Profile</maml:name><maml:description><maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue><dev:type><maml:name>AzureProfile</maml:name><maml:uri /></dev:type><dev:defaultValue>none</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"><maml:name>ResizeTimeout</maml:name><maml:description><maml:para>Specifies a time-out period for the resizing operation. If the pool does not reach the target size by this time, the resize operation stops.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">TimeSpan</command:parameterValue><dev:type><maml:name>TimeSpan</maml:name><maml:uri /></dev:type><dev:defaultValue>none</dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"><maml:name>TargetDedicated</maml:name><maml:description><maml:para>Specifies the target number of dedicated compute nodes.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue><dev:type><maml:name>Int32</maml:name><maml:uri /></dev:type><dev:defaultValue>none</dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name></maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para></maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name></maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para></maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>Example 1: Resize a pool to 12 nodes</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>Start-AzureBatchPoolResize -Id "ContosoPool06" -TargetDedicated 12 -BatchContext $Context </dev:code><dev:remarks><maml:para>This command starts a resize operation on the pool that has the ID ContosoPool06. The target for the operation is 12 dedicated compute nodes. Use the Get-AzureRmBatchAccountKeys cmdlet to assign a context to the $Context variable. </maml:para><maml:para /><maml:para /></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>Example 2: Resize a pool using a deallocation option</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>Get-AzureBatchPool -Id "ContosoPool06" -BatchContext $Context | Start-AzureBatchPoolResize -TargetDedicated 5 -ResizeTimeout ([TimeSpan]::FromHours(1)) -ComputeNodeDeallocationOption ([Microsoft.Azure.Batch.Common.ComputeNodeDeallocationOption]::Terminate) -BatchContext $Context </dev:code><dev:remarks><maml:para>This cmdlet resizes a pool to five dedicated compute nodes. The command gets the pool that has the ID ContosoPool06 by using the Get-AzureBatchPool cmdlet. The command passes that pool object to the current cmdlet by using the pipeline operator. The command starts a resize operation on the pool. The target is five dedicated compute nodes. The command specifies time-out period of one hour. The command specifies a deallocation option of Terminate.</maml:para><maml:para /><maml:para /></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Get-AzureRmBatchAccountKeys</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Get-AzureBatchPool</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Stop-AzureBatchPoolResize</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>RMAzure_Batch_Cmdlets</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks><maml:alertSet><maml:alert><maml:para>Keywords: azure, azurerm, arm, resource, management, manager, batch</maml:para></maml:alert></maml:alertSet></command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Stop-AzureBatchPoolResize</command:name><maml:description><maml:para>Stops a pool resize operation.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Stop</command:verb><command:noun>AzureBatchPoolResize</command:noun><dev:version /></command:details><maml:description><maml:para>The Stop-AzureBatchPoolResize cmdlet stops an Azure Batch resize operation on a pool.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Stop-AzureBatchPoolResize</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue,ByPropertyName)" position="1" aliases="none"><maml:name>Id</maml:name><maml:description><maml:para>Specifies the ID of the pool for which this cmdlet stops a resizing operation.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"><maml:name>Profile</maml:name><maml:description><maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"><maml:name>BatchContext</maml:name><maml:description><maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"><maml:name>BatchContext</maml:name><maml:description><maml:para>Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext object that contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue><dev:type><maml:name>BatchAccountContext</maml:name><maml:uri /></dev:type><dev:defaultValue>none</dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue,ByPropertyName)" position="1" aliases="none"><maml:name>Id</maml:name><maml:description><maml:para>Specifies the ID of the pool for which this cmdlet stops a resizing operation.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue>none</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"><maml:name>Profile</maml:name><maml:description><maml:para>Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">AzureProfile</command:parameterValue><dev:type><maml:name>AzureProfile</maml:name><maml:uri /></dev:type><dev:defaultValue>none</dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name></maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para></maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name></maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para></maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>Example 1: Stop resizing a pool</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>Stop-AzureBatchPoolResize -Id "ContosoPool06" -BatchContext $Context </dev:code><dev:remarks><maml:para>This command stops a resize operation on the pool that has the ID ContosoPool06. Use the Get-AzureRmBatchAccountKeys cmdlet to assign a context to the $Context variable.</maml:para><maml:para /><maml:para /></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>Example 2: Stop resizing a pool by using the pipeline</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>Get-AzureBatchPool -Id "ContosoPool06" -BatchContext $Context | Stop-AzureBatchPoolResize -BatchContext $Context </dev:code><dev:remarks><maml:para>This example stops resizing a pool by using the pipeline operator. The command gets the pool that has the ID ContosoPool06 by using the Get-AzureBatchPool cmdlet. The command passes that pool object to the current cmdlet. The command stops the resize operation on that pool. </maml:para><maml:para /><maml:para /></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Get-AzureRmBatchAccountKeys</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Get-AzureBatchPool</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Start-AzureBatchPoolResize</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>RMAzure_Batch_Cmdlets</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks><maml:alertSet><maml:alert><maml:para>Keywords: azure, azurerm, arm, resource, management, manager, batch</maml:para></maml:alert></maml:alertSet></command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><command:details><command:name> Enable-AzureBatchAutoScale </command:name><maml:description><maml:para>Enables automatic scaling on the specified pool.</maml:para></maml:description><maml:copyright><maml:para></maml:para></maml:copyright><command:verb>Enable</command:verb><command:noun>AzureBatchAutoScale</command:noun><dev:version></dev:version></command:details><maml:description><maml:para>Enables automatic scaling on the specified pool. </maml:para></maml:description><!-- Cmdlet syntax section--><command:syntax><command:syntaxItem><maml:name>Enable-AzureBatchAutoScale</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"><maml:name>Id</maml:name><maml:description><maml:para>The id of the pool to enable automatic scaling on.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"><maml:name>AutoScaleFormula</maml:name><maml:description><maml:para>The formula for the desired number of compute nodes in the pool. For more information on defining autoscale formulas, see: https://msdn.microsoft.com/en-us/library/azure/dn820182.aspx</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"><maml:name>BatchContext</maml:name><maml:description><maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><!-- Cmdlet parameter section --><command:parameters><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"><maml:name>AutoScaleFormula</maml:name><maml:description><maml:para>The formula for the desired number of compute nodes in the pool. For more information on defining autoscale formulas, see: https://msdn.microsoft.com/en-us/library/azure/dn820182.aspx</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue><dev:type><maml:name>string</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"><maml:name>BatchContext</maml:name><maml:description><maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue><dev:type><maml:name>BatchAccountContext</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"><maml:name>Id</maml:name><maml:description><maml:para>The id of the pool to enable automatic scaling on.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue><dev:type><maml:name>string</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><!-- Input - Output section--><command:inputTypes><command:inputType><dev:type><maml:name></maml:name><maml:uri /><maml:description /></dev:type><maml:description><maml:para><!-- description --></maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name></maml:name><maml:uri /><maml:description /></dev:type><maml:description><maml:para><!-- description --></maml:para></maml:description></command:returnValue></command:returnValues><!-- Error section--><command:terminatingErrors /><command:nonTerminatingErrors /><!-- Notes section --><maml:alertSet><maml:title></maml:title><maml:alert><maml:para></maml:para><maml:para>Keywords: azure, azurerm, arm, resource, management, manager, batch</maml:para></maml:alert><maml:alert><maml:para></maml:para></maml:alert></maml:alertSet><!-- Example section --><command:examples><command:example><maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title><maml:introduction><maml:para>C:\PS></maml:para></maml:introduction><dev:code> $formula = 'totalNodes=($CPUPercent.GetSamplePercent(TimeInterval_Minute*0,TimeInterval_Minute*10)<0.7?5:(min($CPUPercent.GetSample(TimeInterval_Minute*0, TimeInterval_Minute*10))>0.8?($CurrentDedicated*1.1):$CurrentDedicated));$TargetDedicated=min(100,totalNodes);'; Enable-AzureBatchAutoScale "myPool" $formula -BatchContext $context </dev:code><dev:remarks><maml:para>Description</maml:para><maml:para>-----------</maml:para><maml:para>Enables automatic scaling on pool "myPool" using the specified formula. </maml:para><maml:para></maml:para><maml:para></maml:para><maml:para></maml:para><maml:para></maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText></command:commandText></command:commandLine></command:commandLines></command:example></command:examples><!-- Link section --><maml:relatedLinks><maml:navigationLink><maml:linkText></maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><command:details><command:name> Test-AzureBatchAutoScale </command:name><maml:description><maml:para>Gets the result of evaluation an automatic scaling formula on the specified pool.</maml:para></maml:description><maml:copyright><maml:para></maml:para></maml:copyright><command:verb>Test</command:verb><command:noun>AzureBatchAutoScale</command:noun><dev:version></dev:version></command:details><maml:description><maml:para>Gets the result of evaluation an automatic scaling formula on the specified pool. This is primarily for validating an autoscale formula, as it simply returns the result without applying the formula to the pool.</maml:para></maml:description><!-- Cmdlet syntax section--><command:syntax><command:syntaxItem><maml:name>Test-AzureBatchAutoScale</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"><maml:name>Id</maml:name><maml:description><maml:para>The id of the pool to evaluate the automatic scaling formula on.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"><maml:name>AutoScaleFormula</maml:name><maml:description><maml:para>The formula for the desired number of compute nodes in the pool. For more information on defining autoscale formulas, see: https://msdn.microsoft.com/en-us/library/azure/dn820182.aspx</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"><maml:name>BatchContext</maml:name><maml:description><maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><!-- Cmdlet parameter section --><command:parameters><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"><maml:name>AutoScaleFormula</maml:name><maml:description><maml:para>The formula for the desired number of compute nodes in the pool. For more information on defining autoscale formulas, see: https://msdn.microsoft.com/en-us/library/azure/dn820182.aspx</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue><dev:type><maml:name>string</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"><maml:name>BatchContext</maml:name><maml:description><maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue><dev:type><maml:name>BatchAccountContext</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"><maml:name>Id</maml:name><maml:description><maml:para>The id of the pool to evaluate the automatic scaling formula on.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue><dev:type><maml:name>string</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><!-- Input - Output section--><command:inputTypes><command:inputType><dev:type><maml:name></maml:name><maml:uri /><maml:description /></dev:type><maml:description><maml:para><!-- description --></maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>PSAutoScaleEvaluation</maml:name><maml:uri /><maml:description /></dev:type><maml:description><maml:para><!-- description --></maml:para></maml:description></command:returnValue></command:returnValues><!-- Error section--><command:terminatingErrors /><command:nonTerminatingErrors /><!-- Notes section --><maml:alertSet><maml:title></maml:title><maml:alert><maml:para></maml:para><maml:para>Keywords: azure, azurerm, arm, resource, management, manager, batch</maml:para></maml:alert><maml:alert><maml:para></maml:para></maml:alert></maml:alertSet><!-- Example section --><command:examples><command:example><maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title><maml:introduction><maml:para>C:\PS></maml:para></maml:introduction><dev:code> $formula = 'totalNodes=($CPUPercent.GetSamplePercent(TimeInterval_Minute*0,TimeInterval_Minute*10)<0.7?5:(min($CPUPercent.GetSample(TimeInterval_Minute*0, TimeInterval_Minute*10))>0.8?($CurrentDedicated*1.1):$CurrentDedicated));$TargetDedicated=min(100,totalNodes);'; $evaluation = Test-AzureBatchAutoScale "myPool" $formula -BatchContext $context $evaluation.AutoScaleRun.Results $TargetDedicated=5;$NodeDeallocationOption=requeue;totalNodes=5 </dev:code><dev:remarks><maml:para>Description</maml:para><maml:para>-----------</maml:para><maml:para>Evaluates the specified autoscale formula on pool "myPool" and displays the results.</maml:para><maml:para></maml:para><maml:para></maml:para><maml:para></maml:para><maml:para></maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText></command:commandText></command:commandLine></command:commandLines></command:example></command:examples><!-- Link section --><maml:relatedLinks><maml:navigationLink><maml:linkText></maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><command:details><command:name> Disable-AzureBatchAutoScale </command:name><maml:description><maml:para>Disables automatic scaling on the specified pool.</maml:para></maml:description><maml:copyright><maml:para></maml:para></maml:copyright><command:verb>Disable</command:verb><command:noun>AzureBatchAutoScale</command:noun><dev:version></dev:version></command:details><maml:description><maml:para>Disables automatic scaling on the specified pool.</maml:para></maml:description><!-- Cmdlet syntax section--><command:syntax><command:syntaxItem><maml:name>Disable-AzureBatchAutoScale</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"><maml:name>Id</maml:name><maml:description><maml:para>The id of the pool to disable automatic scaling on.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"><maml:name>BatchContext</maml:name><maml:description><maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><!-- Cmdlet parameter section --><command:parameters><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"><maml:name>BatchContext</maml:name><maml:description><maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue><dev:type><maml:name>BatchAccountContext</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"><maml:name>Id</maml:name><maml:description><maml:para>The id of the pool to disable automatic scaling on.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue><dev:type><maml:name>string</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><!-- Input - Output section--><command:inputTypes><command:inputType><dev:type><maml:name></maml:name><maml:uri /><maml:description /></dev:type><maml:description><maml:para><!-- description --></maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name></maml:name><maml:uri /><maml:description /></dev:type><maml:description><maml:para><!-- description --></maml:para></maml:description></command:returnValue></command:returnValues><!-- Error section--><command:terminatingErrors /><command:nonTerminatingErrors /><!-- Notes section --><maml:alertSet><maml:title></maml:title><maml:alert><maml:para></maml:para><maml:para>Keywords: azure, azurerm, arm, resource, management, manager, batch</maml:para></maml:alert><maml:alert><maml:para></maml:para></maml:alert></maml:alertSet><!-- Example section --><command:examples><command:example><maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title><maml:introduction><maml:para>C:\PS></maml:para></maml:introduction><dev:code> Disable-AzureBatchAutoScale "myPool" -BatchContext $context </dev:code><dev:remarks><maml:para>Description</maml:para><maml:para>-----------</maml:para><maml:para>Disables automatic scaling on pool "myPool".</maml:para><maml:para></maml:para><maml:para></maml:para><maml:para></maml:para><maml:para></maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText></command:commandText></command:commandLine></command:commandLines></command:example></command:examples><!-- Link section --><maml:relatedLinks><maml:navigationLink><maml:linkText></maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><command:details><command:name> Restart-AzureBatchComputeNode </command:name><maml:description><maml:para>Reboots the specified compute node.</maml:para></maml:description><maml:copyright><maml:para></maml:para></maml:copyright><command:verb>Restart</command:verb><command:noun>AzureBatchComputeNode</command:noun><dev:version></dev:version></command:details><maml:description><maml:para>Reboots the specified compute node.</maml:para></maml:description><!-- Cmdlet syntax section--><command:syntax><command:syntaxItem><maml:name>Restart-AzureBatchComputeNode</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"><maml:name>PoolId</maml:name><maml:description><maml:para>The id of the pool that contains the compute node.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"><maml:name>Id</maml:name><maml:description><maml:para>The id of the compute node to reboot.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"><maml:name>BatchContext</maml:name><maml:description><maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"><maml:name>RebootOption</maml:name><maml:description><maml:para>Specifies when to reboot the node and what to do with currently running tasks. The default is Requeue.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">ComputeNodeRebootOption</command:parameterValue></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Restart-AzureBatchComputeNode</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"><maml:name>ComputeNode</maml:name><maml:description><maml:para>The PSComputeNode object representing the compute node to reboot.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSComputeNode</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"><maml:name>BatchContext</maml:name><maml:description><maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"><maml:name>RebootOption</maml:name><maml:description><maml:para>Specifies when to reboot the node and what to do with currently running tasks. The default is Requeue.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">ComputeNodeRebootOption</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><!-- Cmdlet parameter section --><command:parameters><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"><maml:name>BatchContext</maml:name><maml:description><maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue><dev:type><maml:name>BatchAccountContext</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"><maml:name>ComputeNode</maml:name><maml:description><maml:para>The PSComputeNode object representing the compute node to reboot.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSComputeNode</command:parameterValue><dev:type><maml:name>PSComputeNode</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"><maml:name>Id</maml:name><maml:description><maml:para>The id of the compute node to reboot.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue><dev:type><maml:name>string</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"><maml:name>PoolId</maml:name><maml:description><maml:para>The id of the pool that contains the compute node.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue><dev:type><maml:name>string</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"><maml:name>RebootOption</maml:name><maml:description><maml:para>Specifies when to reboot the node and what to do with currently running tasks. The default is Requeue.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">ComputeNodeRebootOption</command:parameterValue><dev:type><maml:name>ComputeNodeRebootOption</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><!-- Input - Output section--><command:inputTypes><command:inputType><dev:type><maml:name></maml:name><maml:uri /><maml:description /></dev:type><maml:description><maml:para><!-- description --></maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name></maml:name><maml:uri /><maml:description /></dev:type><maml:description><maml:para><!-- description --></maml:para></maml:description></command:returnValue></command:returnValues><!-- Error section--><command:terminatingErrors /><command:nonTerminatingErrors /><!-- Notes section --><maml:alertSet><maml:title></maml:title><maml:alert><maml:para></maml:para><maml:para>Keywords: azure, azurerm, arm, resource, management, manager, batch</maml:para></maml:alert><maml:alert><maml:para></maml:para></maml:alert></maml:alertSet><!-- Example section --><command:examples><command:example><maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title><maml:introduction><maml:para>C:\PS></maml:para></maml:introduction><dev:code> Restart-AzureBatchComputeNode -PoolId "myPool" -Id "tvm-3257026573_2-20150813t200938z" -BatchContext $context </dev:code><dev:remarks><maml:para>Description</maml:para><maml:para>-----------</maml:para><maml:para>Reboots the compute node with id "tvm-3257026573_2-20150813t200938z" in pool "myPool".</maml:para><maml:para></maml:para><maml:para></maml:para><maml:para></maml:para><maml:para></maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText></command:commandText></command:commandLine></command:commandLines></command:example><command:example><maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title><maml:introduction><maml:para>C:\PS></maml:para></maml:introduction><dev:code> Get-AzureBatchComputeNode -PoolId "myPool" -BatchContext $context | Restart-AzureBatchComputeNode -BatchContext $context </dev:code><dev:remarks><maml:para>Description</maml:para><maml:para>-----------</maml:para><maml:para>Reboots every compute node in pool "myPool".</maml:para><maml:para></maml:para><maml:para></maml:para><maml:para></maml:para><maml:para></maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText></command:commandText></command:commandLine></command:commandLines></command:example></command:examples><!-- Link section --><maml:relatedLinks><maml:navigationLink><maml:linkText></maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><command:details><command:name> Reset-AzureBatchComputeNode </command:name><maml:description><maml:para>Reinstalls the operating system on the specified compute node.</maml:para></maml:description><maml:copyright><maml:para></maml:para></maml:copyright><command:verb>Reset</command:verb><command:noun>AzureBatchComputeNode</command:noun><dev:version></dev:version></command:details><maml:description><maml:para>Reinstalls the operating system on the specified compute node.</maml:para></maml:description><!-- Cmdlet syntax section--><command:syntax><command:syntaxItem><maml:name>Reset-AzureBatchComputeNode</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"><maml:name>PoolId</maml:name><maml:description><maml:para>The id of the pool that contains the compute node.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"><maml:name>Id</maml:name><maml:description><maml:para>The id of the compute node to reimage.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"><maml:name>BatchContext</maml:name><maml:description><maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"><maml:name>ReimageOption</maml:name><maml:description><maml:para>Specifies when to reimage the node and what to do with currently running tasks. The default is Requeue.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">ComputeNodeReimageOption</command:parameterValue></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Reset-AzureBatchComputeNode</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"><maml:name>ComputeNode</maml:name><maml:description><maml:para>The PSComputeNode object representing the compute node to reimage.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSComputeNode</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"><maml:name>BatchContext</maml:name><maml:description><maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"><maml:name>ReimageOption</maml:name><maml:description><maml:para>Specifies when to reimage the node and what to do with currently running tasks. The default is Requeue.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">ComputeNodeReimageOption</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><!-- Cmdlet parameter section --><command:parameters><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"><maml:name>BatchContext</maml:name><maml:description><maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue><dev:type><maml:name>BatchAccountContext</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"><maml:name>ComputeNode</maml:name><maml:description><maml:para>The PSComputeNode object representing the compute node to reimage.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSComputeNode</command:parameterValue><dev:type><maml:name>PSComputeNode</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"><maml:name>Id</maml:name><maml:description><maml:para>The id of the compute node to reimage.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue><dev:type><maml:name>string</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"><maml:name>PoolId</maml:name><maml:description><maml:para>The id of the pool that contains the compute node.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue><dev:type><maml:name>string</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"><maml:name>ReimageOption</maml:name><maml:description><maml:para>Specifies when to reimage the node and what to do with currently running tasks. The default is Requeue.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">ComputeNodeReimageOption</command:parameterValue><dev:type><maml:name>ComputeNodeReimageOption</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><!-- Input - Output section--><command:inputTypes><command:inputType><dev:type><maml:name></maml:name><maml:uri /><maml:description /></dev:type><maml:description><maml:para><!-- description --></maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name></maml:name><maml:uri /><maml:description /></dev:type><maml:description><maml:para><!-- description --></maml:para></maml:description></command:returnValue></command:returnValues><!-- Error section--><command:terminatingErrors /><command:nonTerminatingErrors /><!-- Notes section --><maml:alertSet><maml:title></maml:title><maml:alert><maml:para></maml:para><maml:para>Keywords: azure, azurerm, arm, resource, management, manager, batch</maml:para></maml:alert><maml:alert><maml:para></maml:para></maml:alert></maml:alertSet><!-- Example section --><command:examples><command:example><maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title><maml:introduction><maml:para>C:\PS></maml:para></maml:introduction><dev:code> Reset-AzureBatchComputeNode -PoolId "myPool" -Id "tvm-3257026573_2-20150813t200938z" -BatchContext $context </dev:code><dev:remarks><maml:para>Description</maml:para><maml:para>-----------</maml:para><maml:para>Reimages the compute node with id "tvm-3257026573_2-20150813t200938z" in pool "myPool".</maml:para><maml:para></maml:para><maml:para></maml:para><maml:para></maml:para><maml:para></maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText></command:commandText></command:commandLine></command:commandLines></command:example><command:example><maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title><maml:introduction><maml:para>C:\PS></maml:para></maml:introduction><dev:code> Get-AzureBatchComputeNode -PoolId "myPool" -BatchContext $context | Reset-AzureBatchComputeNode -BatchContext $context </dev:code><dev:remarks><maml:para>Description</maml:para><maml:para>-----------</maml:para><maml:para>Reimages every compute node in pool "myPool".</maml:para><maml:para></maml:para><maml:para></maml:para><maml:para></maml:para><maml:para></maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText></command:commandText></command:commandLine></command:commandLines></command:example></command:examples><!-- Link section --><maml:relatedLinks><maml:navigationLink><maml:linkText></maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><command:details><command:name> Set-AzureBatchPoolOSVersion </command:name><maml:description><maml:para>Changes the operating system version of the specified pool.</maml:para></maml:description><maml:copyright><maml:para></maml:para></maml:copyright><command:verb>Set</command:verb><command:noun>AzureBatchPoolOSVersion</command:noun><dev:version></dev:version></command:details><maml:description><maml:para>Changes the operating system version of the specified pool.</maml:para></maml:description><!-- Cmdlet syntax section--><command:syntax><command:syntaxItem><maml:name>Set-AzureBatchPoolOSVersion</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"><maml:name>Id</maml:name><maml:description><maml:para>The id of the pool.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"><maml:name>TargetOSVersion</maml:name><maml:description><maml:para>The Azure Guest OS version to be installed on the virtual machines in the pool. For more information on Azure Guest OS versions, see http://azure.microsoft.com/en-us/documentation/articles/cloud-services-guestos-update-matrix/</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"><maml:name>BatchContext</maml:name><maml:description><maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><!-- Cmdlet parameter section --><command:parameters><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"><maml:name>BatchContext</maml:name><maml:description><maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue><dev:type><maml:name>BatchAccountContext</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"><maml:name>Id</maml:name><maml:description><maml:para>The id of the pool.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue><dev:type><maml:name>string</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"><maml:name>TargetOSVersion</maml:name><maml:description><maml:para>The Azure Guest OS version to be installed on the virtual machines in the pool. For more information on Azure Guest OS versions, see http://azure.microsoft.com/en-us/documentation/articles/cloud-services-guestos-update-matrix/</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue><dev:type><maml:name>string</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><!-- Input - Output section--><command:inputTypes><command:inputType><dev:type><maml:name></maml:name><maml:uri /><maml:description /></dev:type><maml:description><maml:para><!-- description --></maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name></maml:name><maml:uri /><maml:description /></dev:type><maml:description><maml:para><!-- description --></maml:para></maml:description></command:returnValue></command:returnValues><!-- Error section--><command:terminatingErrors /><command:nonTerminatingErrors /><!-- Notes section --><maml:alertSet><maml:title></maml:title><maml:alert><maml:para></maml:para><maml:para>Keywords: azure, azurerm, arm, resource, management, manager, batch</maml:para></maml:alert><maml:alert><maml:para></maml:para></maml:alert></maml:alertSet><!-- Example section --><command:examples><command:example><maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title><maml:introduction><maml:para>C:\PS></maml:para></maml:introduction><dev:code> Set-AzureBatchPoolOSVersion -Id "myPool" -TargetOSVersion "WA-GUEST-OS-4.20_201505-01" -BatchContext $context </dev:code><dev:remarks><maml:para>Description</maml:para><maml:para>-----------</maml:para><maml:para>Sets the target OS version of pool "myPool" to "WA-GUEST-OS-4.20_201505-01"</maml:para><maml:para></maml:para><maml:para></maml:para><maml:para></maml:para><maml:para></maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText></command:commandText></command:commandLine></command:commandLines></command:example></command:examples><!-- Link section --><maml:relatedLinks><maml:navigationLink><maml:linkText></maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><command:details><command:name> Enable-AzureBatchJobSchedule </command:name><maml:description><maml:para>Enables the specified job schedule.</maml:para></maml:description><maml:copyright><maml:para></maml:para></maml:copyright><command:verb>Enable</command:verb><command:noun>AzureBatchJobSchedule</command:noun><dev:version></dev:version></command:details><maml:description><maml:para>Enables the specified job schedule, allowing jobs to be created according to its Schedule.</maml:para></maml:description><!-- Cmdlet syntax section--><command:syntax><command:syntaxItem><maml:name>Enable-AzureBatchJobSchedule</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"><maml:name>Id</maml:name><maml:description><maml:para>The id of the job schedule to enable.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"><maml:name>BatchContext</maml:name><maml:description><maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><!-- Cmdlet parameter section --><command:parameters><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"><maml:name>BatchContext</maml:name><maml:description><maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue><dev:type><maml:name>BatchAccountContext</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"><maml:name>Id</maml:name><maml:description><maml:para>The id of the job schedule to enable.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue><dev:type><maml:name>string</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><!-- Input - Output section--><command:inputTypes><command:inputType><dev:type><maml:name></maml:name><maml:uri /><maml:description /></dev:type><maml:description><maml:para><!-- description --></maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name></maml:name><maml:uri /><maml:description /></dev:type><maml:description><maml:para><!-- description --></maml:para></maml:description></command:returnValue></command:returnValues><!-- Error section--><command:terminatingErrors /><command:nonTerminatingErrors /><!-- Notes section --><maml:alertSet><maml:title></maml:title><maml:alert><maml:para></maml:para><maml:para>Keywords: azure, azurerm, arm, resource, management, manager, batch</maml:para></maml:alert><maml:alert><maml:para></maml:para></maml:alert></maml:alertSet><!-- Example section --><command:examples><command:example><maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title><maml:introduction><maml:para>C:\PS></maml:para></maml:introduction><dev:code> Enable-AzureBatchJobSchedule "myJobSchedule" -BatchContext $context </dev:code><dev:remarks><maml:para>Description</maml:para><maml:para>-----------</maml:para><maml:para>Enables the job schedule with id "myJobSchedule".</maml:para><maml:para></maml:para><maml:para></maml:para><maml:para></maml:para><maml:para></maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText></command:commandText></command:commandLine></command:commandLines></command:example></command:examples><!-- Link section --><maml:relatedLinks><maml:navigationLink><maml:linkText></maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><command:details><command:name> Disable-AzureBatchJobSchedule </command:name><maml:description><maml:para>Disables the specified job schedule</maml:para></maml:description><maml:copyright><maml:para></maml:para></maml:copyright><command:verb>Disable</command:verb><command:noun>AzureBatchJobSchedule</command:noun><dev:version></dev:version></command:details><maml:description><maml:para>Disables the specified job schedule. Disabled schedules do not create new jobs, but may be re-enabled later.</maml:para></maml:description><!-- Cmdlet syntax section--><command:syntax><command:syntaxItem><maml:name>Disable-AzureBatchJobSchedule</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"><maml:name>Id</maml:name><maml:description><maml:para>The id of the job schedule to disable.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"><maml:name>BatchContext</maml:name><maml:description><maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><!-- Cmdlet parameter section --><command:parameters><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"><maml:name>BatchContext</maml:name><maml:description><maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue><dev:type><maml:name>BatchAccountContext</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"><maml:name>Id</maml:name><maml:description><maml:para>The id of the job schedule to disable.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue><dev:type><maml:name>string</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><!-- Input - Output section--><command:inputTypes><command:inputType><dev:type><maml:name></maml:name><maml:uri /><maml:description /></dev:type><maml:description><maml:para><!-- description --></maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name></maml:name><maml:uri /><maml:description /></dev:type><maml:description><maml:para><!-- description --></maml:para></maml:description></command:returnValue></command:returnValues><!-- Error section--><command:terminatingErrors /><command:nonTerminatingErrors /><!-- Notes section --><maml:alertSet><maml:title></maml:title><maml:alert><maml:para></maml:para><maml:para>Keywords: azure, azurerm, arm, resource, management, manager, batch</maml:para></maml:alert><maml:alert><maml:para></maml:para></maml:alert></maml:alertSet><!-- Example section --><command:examples><command:example><maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title><maml:introduction><maml:para>C:\PS></maml:para></maml:introduction><dev:code> Disable-AzureBatchJobSchedule "myJobSchedule" -BatchContext $context </dev:code><dev:remarks><maml:para>Description</maml:para><maml:para>-----------</maml:para><maml:para>Disables the job schedule with id "myJobSchedule".</maml:para><maml:para></maml:para><maml:para></maml:para><maml:para></maml:para><maml:para></maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText></command:commandText></command:commandLine></command:commandLines></command:example></command:examples><!-- Link section --><maml:relatedLinks><maml:navigationLink><maml:linkText></maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><command:details><command:name> Enable-AzureBatchJob </command:name><maml:description><maml:para>Enables the specified job.</maml:para></maml:description><maml:copyright><maml:para></maml:para></maml:copyright><command:verb>Enable</command:verb><command:noun>AzureBatchJob</command:noun><dev:version></dev:version></command:details><maml:description><maml:para>Enables the specified job, allowing new tasks to run.</maml:para></maml:description><!-- Cmdlet syntax section--><command:syntax><command:syntaxItem><maml:name>Enable-AzureBatchJob</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"><maml:name>Id</maml:name><maml:description><maml:para>The id of the job to enable.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"><maml:name>BatchContext</maml:name><maml:description><maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><!-- Cmdlet parameter section --><command:parameters><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"><maml:name>BatchContext</maml:name><maml:description><maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue><dev:type><maml:name>BatchAccountContext</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"><maml:name>Id</maml:name><maml:description><maml:para>The id of the job to enable.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue><dev:type><maml:name>string</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><!-- Input - Output section--><command:inputTypes><command:inputType><dev:type><maml:name></maml:name><maml:uri /><maml:description /></dev:type><maml:description><maml:para><!-- description --></maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name></maml:name><maml:uri /><maml:description /></dev:type><maml:description><maml:para><!-- description --></maml:para></maml:description></command:returnValue></command:returnValues><!-- Error section--><command:terminatingErrors /><command:nonTerminatingErrors /><!-- Notes section --><maml:alertSet><maml:title></maml:title><maml:alert><maml:para></maml:para><maml:para>Keywords: azure, azurerm, arm, resource, management, manager, batch</maml:para></maml:alert><maml:alert><maml:para></maml:para></maml:alert></maml:alertSet><!-- Example section --><command:examples><command:example><maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title><maml:introduction><maml:para>C:\PS></maml:para></maml:introduction><dev:code> Enable-AzureBatchJob "myJob" -BatchContext $context </dev:code><dev:remarks><maml:para>Description</maml:para><maml:para>-----------</maml:para><maml:para>Enables the job with id "myJob".</maml:para><maml:para></maml:para><maml:para></maml:para><maml:para></maml:para><maml:para></maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText></command:commandText></command:commandLine></command:commandLines></command:example></command:examples><!-- Link section --><maml:relatedLinks><maml:navigationLink><maml:linkText></maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><command:details><command:name> Disable-AzureBatchJob </command:name><maml:description><maml:para>Disables the specified job.</maml:para></maml:description><maml:copyright><maml:para></maml:para></maml:copyright><command:verb>Disable</command:verb><command:noun>AzureBatchJob</command:noun><dev:version></dev:version></command:details><maml:description><maml:para>Disables the specified job. Disabled jobs do not run new tasks, but may be re-enabled later.</maml:para></maml:description><!-- Cmdlet syntax section--><command:syntax><command:syntaxItem><maml:name>Disable-AzureBatchJob</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"><maml:name>Id</maml:name><maml:description><maml:para>The id of the job to disable.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"><maml:name>DisableJobOption</maml:name><maml:description><maml:para>Specifies what to do with active tasks associated with the job.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">DisableJobOption</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"><maml:name>BatchContext</maml:name><maml:description><maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><!-- Cmdlet parameter section --><command:parameters><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"><maml:name>BatchContext</maml:name><maml:description><maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue><dev:type><maml:name>BatchAccountContext</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"><maml:name>DisableJobOption</maml:name><maml:description><maml:para>Specifies what to do with active tasks associated with the job.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">DisableJobOption</command:parameterValue><dev:type><maml:name>DisableJobOption</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"><maml:name>Id</maml:name><maml:description><maml:para>The id of the job to disable.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue><dev:type><maml:name>string</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><!-- Input - Output section--><command:inputTypes><command:inputType><dev:type><maml:name></maml:name><maml:uri /><maml:description /></dev:type><maml:description><maml:para><!-- description --></maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name></maml:name><maml:uri /><maml:description /></dev:type><maml:description><maml:para><!-- description --></maml:para></maml:description></command:returnValue></command:returnValues><!-- Error section--><command:terminatingErrors /><command:nonTerminatingErrors /><!-- Notes section --><maml:alertSet><maml:title></maml:title><maml:alert><maml:para></maml:para><maml:para>Keywords: azure, azurerm, arm, resource, management, manager, batch</maml:para></maml:alert><maml:alert><maml:para></maml:para></maml:alert></maml:alertSet><!-- Example section --><command:examples><command:example><maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title><maml:introduction><maml:para>C:\PS></maml:para></maml:introduction><dev:code> Disable-AzureBatchJob "myJob" Terminate -BatchContext $context </dev:code><dev:remarks><maml:para>Description</maml:para><maml:para>-----------</maml:para><maml:para>Disables the job with id "myJob". Running tasks associated with the job will be terminated and will not run again.</maml:para><maml:para></maml:para><maml:para></maml:para><maml:para></maml:para><maml:para></maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText></command:commandText></command:commandLine></command:commandLines></command:example></command:examples><!-- Link section --><maml:relatedLinks><maml:navigationLink><maml:linkText></maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><command:details><command:name> Stop-AzureBatchJobSchedule </command:name><maml:description><maml:para>Terminates the specified job schedule.</maml:para></maml:description><maml:copyright><maml:para></maml:para></maml:copyright><command:verb>Stop</command:verb><command:noun>AzureBatchJobSchedule</command:noun><dev:version></dev:version></command:details><maml:description><maml:para>Terminates the specified job schedule.</maml:para></maml:description><!-- Cmdlet syntax section--><command:syntax><command:syntaxItem><maml:name>Stop-AzureBatchJobSchedule</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"><maml:name>Id</maml:name><maml:description><maml:para>The id of the job schedule to terminate.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"><maml:name>BatchContext</maml:name><maml:description><maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><!-- Cmdlet parameter section --><command:parameters><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"><maml:name>BatchContext</maml:name><maml:description><maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue><dev:type><maml:name>BatchAccountContext</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"><maml:name>Id</maml:name><maml:description><maml:para>The id of the job schedule to terminate.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue><dev:type><maml:name>string</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><!-- Input - Output section--><command:inputTypes><command:inputType><dev:type><maml:name></maml:name><maml:uri /><maml:description /></dev:type><maml:description><maml:para><!-- description --></maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name></maml:name><maml:uri /><maml:description /></dev:type><maml:description><maml:para><!-- description --></maml:para></maml:description></command:returnValue></command:returnValues><!-- Error section--><command:terminatingErrors /><command:nonTerminatingErrors /><!-- Notes section --><maml:alertSet><maml:title></maml:title><maml:alert><maml:para></maml:para><maml:para>Keywords: azure, azurerm, arm, resource, management, manager, batch</maml:para></maml:alert><maml:alert><maml:para></maml:para></maml:alert></maml:alertSet><!-- Example section --><command:examples><command:example><maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title><maml:introduction><maml:para>C:\PS></maml:para></maml:introduction><dev:code> Stop-AzureBatchJobSchedule "myJobSchedule" -BatchContext $context </dev:code><dev:remarks><maml:para>Description</maml:para><maml:para>-----------</maml:para><maml:para>Terminates the job schedule with id "myJobSchedule"</maml:para><maml:para></maml:para><maml:para></maml:para><maml:para></maml:para><maml:para></maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText></command:commandText></command:commandLine></command:commandLines></command:example></command:examples><!-- Link section --><maml:relatedLinks><maml:navigationLink><maml:linkText></maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><command:details><command:name> Stop-AzureBatchJob </command:name><maml:description><maml:para>Terminates the specified job.</maml:para></maml:description><maml:copyright><maml:para></maml:para></maml:copyright><command:verb>Stop</command:verb><command:noun>AzureBatchJob</command:noun><dev:version></dev:version></command:details><maml:description><maml:para>Terminates the specified job, marking it as completed.</maml:para></maml:description><!-- Cmdlet syntax section--><command:syntax><command:syntaxItem><maml:name>Stop-AzureBatchJob</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"><maml:name>Id</maml:name><maml:description><maml:para>The id of the job to terminate.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"><maml:name>TerminateReason</maml:name><maml:description><maml:para>The text you want to appear as the job's TerminateReason.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">DisableJobOption</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"><maml:name>BatchContext</maml:name><maml:description><maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><!-- Cmdlet parameter section --><command:parameters><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"><maml:name>BatchContext</maml:name><maml:description><maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue><dev:type><maml:name>BatchAccountContext</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"><maml:name>TerminateReason</maml:name><maml:description><maml:para>The text you want to appear as the job's TerminateReason.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">DisableJobOption</command:parameterValue><dev:type><maml:name>DisableJobOption</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"><maml:name>Id</maml:name><maml:description><maml:para>The id of the job to terminate.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue><dev:type><maml:name>string</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><!-- Input - Output section--><command:inputTypes><command:inputType><dev:type><maml:name></maml:name><maml:uri /><maml:description /></dev:type><maml:description><maml:para><!-- description --></maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name></maml:name><maml:uri /><maml:description /></dev:type><maml:description><maml:para><!-- description --></maml:para></maml:description></command:returnValue></command:returnValues><!-- Error section--><command:terminatingErrors /><command:nonTerminatingErrors /><!-- Notes section --><maml:alertSet><maml:title></maml:title><maml:alert><maml:para></maml:para><maml:para>Keywords: azure, azurerm, arm, resource, management, manager, batch</maml:para></maml:alert><maml:alert><maml:para></maml:para></maml:alert></maml:alertSet><!-- Example section --><command:examples><command:example><maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title><maml:introduction><maml:para>C:\PS></maml:para></maml:introduction><dev:code> Stop-AzureBatchJob "myJob" "No more tasks to run" -BatchContext $context </dev:code><dev:remarks><maml:para>Description</maml:para><maml:para>-----------</maml:para><maml:para>Terminates the job with id "myJob". The supplied terminate reason is "No more tasks to run".</maml:para><maml:para></maml:para><maml:para></maml:para><maml:para></maml:para><maml:para></maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText></command:commandText></command:commandLine></command:commandLines></command:example></command:examples><!-- Link section --><maml:relatedLinks><maml:navigationLink><maml:linkText></maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><command:details><command:name> Stop-AzureBatchTask </command:name><maml:description><maml:para>Terminates the specified task.</maml:para></maml:description><maml:copyright><maml:para></maml:para></maml:copyright><command:verb>Stop</command:verb><command:noun>AzureBatchTask</command:noun><dev:version></dev:version></command:details><maml:description><maml:para>Terminates the specified task.</maml:para></maml:description><!-- Cmdlet syntax section--><command:syntax><command:syntaxItem><maml:name>Stop-AzureBatchTask</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"><maml:name>JobId</maml:name><maml:description><maml:para>The id of the job containing the task to terminate.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"><maml:name>Id</maml:name><maml:description><maml:para>The id of the task to terminate.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"><maml:name>BatchContext</maml:name><maml:description><maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Stop-AzureBatchTask</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"><maml:name>Task</maml:name><maml:description><maml:para>The PSCloudTask object representing the task to terminate. Use the Get-AzureBatchTask cmdlet to get a PSCloudTask object.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCloudTask</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"><maml:name>BatchContext</maml:name><maml:description><maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><!-- Cmdlet parameter section --><command:parameters><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"><maml:name>BatchContext</maml:name><maml:description><maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue><dev:type><maml:name>BatchAccountContext</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"><maml:name>Task</maml:name><maml:description><maml:para>The PSCloudTask object representing the task to terminate. Use the Get-AzureBatchTask cmdlet to get a PSCloudTask object.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCloudTask</command:parameterValue><dev:type><maml:name>PSCloudTask</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"><maml:name>JobId</maml:name><maml:description><maml:para>The id of the job containing the task to terminate.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue><dev:type><maml:name>string</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"><maml:name>Id</maml:name><maml:description><maml:para>The id of the task to terminate.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue><dev:type><maml:name>string</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><!-- Input - Output section--><command:inputTypes><command:inputType><dev:type><maml:name></maml:name><maml:uri /><maml:description /></dev:type><maml:description><maml:para><!-- description --></maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name></maml:name><maml:uri /><maml:description /></dev:type><maml:description><maml:para><!-- description --></maml:para></maml:description></command:returnValue></command:returnValues><!-- Error section--><command:terminatingErrors /><command:nonTerminatingErrors /><!-- Notes section --><maml:alertSet><maml:title></maml:title><maml:alert><maml:para></maml:para><maml:para>Keywords: azure, azurerm, arm, resource, management, manager, batch</maml:para></maml:alert><maml:alert><maml:para></maml:para></maml:alert></maml:alertSet><!-- Example section --><command:examples><command:example><maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title><maml:introduction><maml:para>C:\PS></maml:para></maml:introduction><dev:code> Stop-AzureBatchTask "myJob" "myTask" -BatchContext $context </dev:code><dev:remarks><maml:para>Description</maml:para><maml:para>-----------</maml:para><maml:para>Terminates the task with id "myTask" under job "myJob".</maml:para><maml:para></maml:para><maml:para></maml:para><maml:para></maml:para><maml:para></maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText></command:commandText></command:commandLine></command:commandLines></command:example><command:example><maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title><maml:introduction><maml:para>C:\PS></maml:para></maml:introduction><dev:code> Get-AzureBatchTask "myJob" "myTask" -BatchContext $context | Stop-AzureBatchTask -BatchContext $context </dev:code><dev:remarks><maml:para>Description</maml:para><maml:para>-----------</maml:para><maml:para>Terminates the task with id "myTask" under job "myJob" using the pipeline.</maml:para><maml:para></maml:para><maml:para></maml:para><maml:para></maml:para><maml:para></maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText></command:commandText></command:commandLine></command:commandLines></command:example></command:examples><!-- Link section --><maml:relatedLinks><maml:navigationLink><maml:linkText></maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><command:details><command:name> Set-AzureBatchComputeNodeUser </command:name><maml:description><maml:para>Updates the properties of a user account on a compute node.</maml:para></maml:description><maml:copyright><maml:para></maml:para></maml:copyright><command:verb>Set</command:verb><command:noun>AzureBatchComputeNodeUser</command:noun><dev:version></dev:version></command:details><maml:description><maml:para>Updates the properties of a user account on a compute node.</maml:para></maml:description><!-- Cmdlet syntax section--><command:syntax><command:syntaxItem><maml:name>Set-AzureBatchComputeNodeUser</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"><maml:name>PoolId</maml:name><maml:description><maml:para>The id of the pool containing the compute node.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"><maml:name>ComputeNodeId</maml:name><maml:description><maml:para>The id of the compute node containing the user account to update.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"><maml:name>Name</maml:name><maml:description><maml:para>The name of the user account to update.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4"><maml:name>Password</maml:name><maml:description><maml:para>The account password.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"><maml:name>BatchContext</maml:name><maml:description><maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRMBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"><maml:name>ExpiryTime</maml:name><maml:description><maml:para>The time at which the account should expire. The default is 1 day from the time of the update.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><!-- Cmdlet parameter section --><command:parameters><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"><maml:name>BatchContext</maml:name><maml:description><maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRMBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue><dev:type><maml:name>BatchAccountContext</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"><maml:name>ComputeNodeId</maml:name><maml:description><maml:para>The id of the compute node containing the user account to update.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue><dev:type><maml:name>string</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"><maml:name>ExpiryTime</maml:name><maml:description><maml:para>The time at which the account should expire. The default is 1 day from the time of the update.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue><dev:type><maml:name>DateTime</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"><maml:name>Name</maml:name><maml:description><maml:para>The name of the user account to update.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue><dev:type><maml:name>string</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4"><maml:name>Password</maml:name><maml:description><maml:para>The account password.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue><dev:type><maml:name>string</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"><maml:name>PoolId</maml:name><maml:description><maml:para>The id of the pool containing the compute node.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">string</command:parameterValue><dev:type><maml:name>string</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><!-- Input - Output section--><command:inputTypes><command:inputType><dev:type><maml:name></maml:name><maml:uri /><maml:description /></dev:type><maml:description><maml:para><!-- description --></maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name></maml:name><maml:uri /><maml:description /></dev:type><maml:description><maml:para><!-- description --></maml:para></maml:description></command:returnValue></command:returnValues><!-- Error section--><command:terminatingErrors /><command:nonTerminatingErrors /><!-- Notes section --><maml:alertSet><maml:title></maml:title><maml:alert><maml:para></maml:para><maml:para>Keywords: azure, azurerm, arm, resource, management, manager, batch</maml:para></maml:alert><maml:alert><maml:para></maml:para></maml:alert></maml:alertSet><!-- Example section --><command:examples><command:example><maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title><maml:introduction><maml:para>C:\PS></maml:para></maml:introduction><dev:code> Set-AzureBatchComputeNodeUser "myPool" "tvm-3257026573_1-20150904t230807z" "myUser" "Password1234!" -ExpiryTime ([DateTime]::Now.AddDays(14)) -BatchContext $context </dev:code><dev:remarks><maml:para>Description</maml:para><maml:para>-----------</maml:para><maml:para>Updates the "myUser" user account on compute node "tvm-3257026573_1-20150904t230807z" in pool "myPool". The account password is updated to "Password1234!", and the expiry time is updated to 14 days from now.</maml:para><maml:para></maml:para><maml:para></maml:para><maml:para></maml:para><maml:para></maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText></command:commandText></command:commandLine></command:commandLines></command:example></command:examples><!-- Link section --><maml:relatedLinks><maml:navigationLink><maml:linkText></maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><command:details><command:name> Set-AzureBatchJob </command:name><maml:description><maml:para>Updates the properties of a job.</maml:para></maml:description><maml:copyright><maml:para></maml:para></maml:copyright><command:verb>Set</command:verb><command:noun>AzureBatchJob</command:noun><dev:version></dev:version></command:details><maml:description><maml:para>Updates the properties of a job.</maml:para></maml:description><!-- Cmdlet syntax section--><command:syntax><command:syntaxItem><maml:name>Set-AzureBatchJob</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"><maml:name>Job</maml:name><maml:description><maml:para>The PSCloudJob object with changes to commit to the Batch Service. Use the Get-AzureBatchJob cmdlet to get a PSCloudJob object. Modify the properties of this object and pass it into the Set-AzureBatchJob cmdlet to commit these changes to the Batch Service.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCloudJob</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"><maml:name>BatchContext</maml:name><maml:description><maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRMBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><!-- Cmdlet parameter section --><command:parameters><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"><maml:name>BatchContext</maml:name><maml:description><maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRMBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue><dev:type><maml:name>BatchAccountContext</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"><maml:name>Job</maml:name><maml:description><maml:para>The PSCloudJob object with changes to commit to the Batch Service. Use the Get-AzureBatchJob cmdlet to get a PSCloudJob object. Modify the properties of this object and pass it into the Set-AzureBatchJob cmdlet to commit these changes to the Batch Service.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCloudJob</command:parameterValue><dev:type><maml:name>PSCloudJob</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><!-- Input - Output section--><command:inputTypes><command:inputType><dev:type><maml:name></maml:name><maml:uri /><maml:description /></dev:type><maml:description><maml:para><!-- description --></maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name></maml:name><maml:uri /><maml:description /></dev:type><maml:description><maml:para><!-- description --></maml:para></maml:description></command:returnValue></command:returnValues><!-- Error section--><command:terminatingErrors /><command:nonTerminatingErrors /><!-- Notes section --><maml:alertSet><maml:title></maml:title><maml:alert><maml:para></maml:para><maml:para>Keywords: azure, azurerm, arm, resource, management, manager, batch</maml:para></maml:alert><maml:alert><maml:para></maml:para></maml:alert></maml:alertSet><!-- Example section --><command:examples><command:example><maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title><maml:introduction><maml:para>C:\PS></maml:para></maml:introduction><dev:code> $job = Get-AzureBatchJob "myJob" -BatchContext $context $job.Priority = 1 $job | Set-AzureBatchJob -BatchContext $context </dev:code><dev:remarks><maml:para>Description</maml:para><maml:para>-----------</maml:para><maml:para>Updates the priority of job "myJob" to a new value of 1.</maml:para><maml:para></maml:para><maml:para></maml:para><maml:para></maml:para><maml:para></maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText></command:commandText></command:commandLine></command:commandLines></command:example></command:examples><!-- Link section --><maml:relatedLinks><maml:navigationLink><maml:linkText></maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><command:details><command:name> Set-AzureBatchJobSchedule </command:name><maml:description><maml:para>Updates the properties of a job schedule.</maml:para></maml:description><maml:copyright><maml:para></maml:para></maml:copyright><command:verb>Set</command:verb><command:noun>AzureBatchJobSchedule</command:noun><dev:version></dev:version></command:details><maml:description><maml:para>Updates the properties of a job schedule.</maml:para></maml:description><!-- Cmdlet syntax section--><command:syntax><command:syntaxItem><maml:name>Set-AzureBatchJobSchedule</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"><maml:name>JobSchedule</maml:name><maml:description><maml:para>The PSCloudJobSchedule object with changes to commit to the Batch Service. Use the Get-AzureBatchJobSchedule cmdlet to get a PSCloudJobSchedule object. Modify the properties of this object and pass it into the Set-AzureBatchJobSchedule cmdlet to commit these changes to the Batch Service.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCloudJobSchedule</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"><maml:name>BatchContext</maml:name><maml:description><maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRMBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><!-- Cmdlet parameter section --><command:parameters><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"><maml:name>BatchContext</maml:name><maml:description><maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRMBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue><dev:type><maml:name>BatchAccountContext</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"><maml:name>JobSchedule</maml:name><maml:description><maml:para>The PSCloudJobSchedule object with changes to commit to the Batch Service. Use the Get-AzureBatchJobSchedule cmdlet to get a PSCloudJobSchedule object. Modify the properties of this object and pass it into the Set-AzureBatchJobSchedule cmdlet to commit these changes to the Batch Service.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCloudJobSchedule</command:parameterValue><dev:type><maml:name>PSCloudJobSchedule</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><!-- Input - Output section--><command:inputTypes><command:inputType><dev:type><maml:name></maml:name><maml:uri /><maml:description /></dev:type><maml:description><maml:para><!-- description --></maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name></maml:name><maml:uri /><maml:description /></dev:type><maml:description><maml:para><!-- description --></maml:para></maml:description></command:returnValue></command:returnValues><!-- Error section--><command:terminatingErrors /><command:nonTerminatingErrors /><!-- Notes section --><maml:alertSet><maml:title></maml:title><maml:alert><maml:para></maml:para><maml:para>Keywords: azure, azurerm, arm, resource, management, manager, batch</maml:para></maml:alert><maml:alert><maml:para></maml:para></maml:alert></maml:alertSet><!-- Example section --><command:examples><command:example><maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title><maml:introduction><maml:para>C:\PS></maml:para></maml:introduction><dev:code> $jobSchedule = Get-AzureBatchJobSchedule "myJobSchedule" -BatchContext $context $schedule = New-Object Microsoft.Azure.Commands.Batch.Models.PSSchedule $schedule.DoNotRunAfter = [DateTime]::Now.AddDays(30) $schedule.DoNotRunUntil = [DateTime]::Now.AddDays(1) $jobSchedule.Schedule = $schedule $jobSchedule | Set-AzureBatchJobSchedule -BatchContext $context </dev:code><dev:remarks><maml:para>Description</maml:para><maml:para>-----------</maml:para><maml:para>Updates the Schedule property on the job schedule with id "myJobSchedule".</maml:para><maml:para></maml:para><maml:para></maml:para><maml:para></maml:para><maml:para></maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText></command:commandText></command:commandLine></command:commandLines></command:example></command:examples><!-- Link section --><maml:relatedLinks><maml:navigationLink><maml:linkText></maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><command:details><command:name> Set-AzureBatchPool </command:name><maml:description><maml:para>Updates the properties of a pool.</maml:para></maml:description><maml:copyright><maml:para></maml:para></maml:copyright><command:verb>Set</command:verb><command:noun>AzureBatchPool</command:noun><dev:version></dev:version></command:details><maml:description><maml:para>Updates the properties of a pool.</maml:para></maml:description><!-- Cmdlet syntax section--><command:syntax><command:syntaxItem><maml:name>Set-AzureBatchPool</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"><maml:name>Pool</maml:name><maml:description><maml:para>The PSCloudPool object with changes to commit to the Batch Service. Use the Get-AzureBatchPool cmdlet to get a PSCloudPool object. Modify the properties of this object and pass it into the Set-AzureBatchPool cmdlet to commit these changes to the Batch Service.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCloudPool</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"><maml:name>BatchContext</maml:name><maml:description><maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRMBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><!-- Cmdlet parameter section --><command:parameters><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"><maml:name>BatchContext</maml:name><maml:description><maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRMBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue><dev:type><maml:name>BatchAccountContext</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"><maml:name>Pool</maml:name><maml:description><maml:para>The PSCloudPool object with changes to commit to the Batch Service. Use the Get-AzureBatchPool cmdlet to get a PSCloudPool object. Modify the properties of this object and pass it into the Set-AzureBatchPool cmdlet to commit these changes to the Batch Service.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCloudPool</command:parameterValue><dev:type><maml:name>PSCloudPool</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><!-- Input - Output section--><command:inputTypes><command:inputType><dev:type><maml:name></maml:name><maml:uri /><maml:description /></dev:type><maml:description><maml:para><!-- description --></maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name></maml:name><maml:uri /><maml:description /></dev:type><maml:description><maml:para><!-- description --></maml:para></maml:description></command:returnValue></command:returnValues><!-- Error section--><command:terminatingErrors /><command:nonTerminatingErrors /><!-- Notes section --><maml:alertSet><maml:title></maml:title><maml:alert><maml:para></maml:para><maml:para>Keywords: azure, azurerm, arm, resource, management, manager, batch</maml:para></maml:alert><maml:alert><maml:para></maml:para></maml:alert></maml:alertSet><!-- Example section --><command:examples><command:example><maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title><maml:introduction><maml:para>C:\PS></maml:para></maml:introduction><dev:code> $pool = Get-AzureBatchPool "myPool" -BatchContext $context $startTask = New-Object Microsoft.Azure.Commands.Batch.Models.PSStartTask $startTask.CommandLine = "cmd /c echo example" $pool.StartTask = $startTask $pool | Set-AzureBatchPool -BatchContext $context </dev:code><dev:remarks><maml:para>Description</maml:para><maml:para>-----------</maml:para><maml:para>Updates the start task specification on pool "myPool".</maml:para><maml:para></maml:para><maml:para></maml:para><maml:para></maml:para><maml:para></maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText></command:commandText></command:commandLine></command:commandLines></command:example></command:examples><!-- Link section --><maml:relatedLinks><maml:navigationLink><maml:linkText></maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"><command:details><command:name> Set-AzureBatchTask </command:name><maml:description><maml:para>Updates the properties of a task.</maml:para></maml:description><maml:copyright><maml:para></maml:para></maml:copyright><command:verb>Set</command:verb><command:noun>AzureBatchTask</command:noun><dev:version></dev:version></command:details><maml:description><maml:para>Updates the properties of a task.</maml:para></maml:description><!-- Cmdlet syntax section--><command:syntax><command:syntaxItem><maml:name>Set-AzureBatchTask</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"><maml:name>Task</maml:name><maml:description><maml:para>The PSCloudTask object with changes to commit to the Batch Service. Use the Get-AzureBatchTask cmdlet to get a PSCloudTask object. Modify the properties of this object and pass it into the Set-AzureBatchTask cmdlet to commit these changes to the Batch Service.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCloudTask</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"><maml:name>BatchContext</maml:name><maml:description><maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRMBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><!-- Cmdlet parameter section --><command:parameters><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"><maml:name>BatchContext</maml:name><maml:description><maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRMBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue><dev:type><maml:name>BatchAccountContext</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"><maml:name>Task</maml:name><maml:description><maml:para>The PSCloudTask object with changes to commit to the Batch Service. Use the Get-AzureBatchTask cmdlet to get a PSCloudTask object. Modify the properties of this object and pass it into the Set-AzureBatchTask cmdlet to commit these changes to the Batch Service.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCloudTask</command:parameterValue><dev:type><maml:name>PSCloudTask</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><!-- Input - Output section--><command:inputTypes><command:inputType><dev:type><maml:name></maml:name><maml:uri /><maml:description /></dev:type><maml:description><maml:para><!-- description --></maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name></maml:name><maml:uri /><maml:description /></dev:type><maml:description><maml:para><!-- description --></maml:para></maml:description></command:returnValue></command:returnValues><!-- Error section--><command:terminatingErrors /><command:nonTerminatingErrors /><!-- Notes section --><maml:alertSet><maml:title></maml:title><maml:alert><maml:para></maml:para><maml:para>Keywords: azure, azurerm, arm, resource, management, manager, batch</maml:para></maml:alert><maml:alert><maml:para></maml:para></maml:alert></maml:alertSet><!-- Example section --><command:examples><command:example><maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title><maml:introduction><maml:para>C:\PS></maml:para></maml:introduction><dev:code> $task = Get-AzureBatchTask "myJob" "myTask" -BatchContext $context $constraints = New-Object Microsoft.Azure.Commands.Batch.Models.PSTaskConstraints -ArgumentList @([TimeSpan}::FromDays(5), [TimeSpan]::FromDays(2), 3) $task.Constraints = $constraints $task | Set-AzureBatchTask -BatchContext $context </dev:code><dev:remarks><maml:para>Description</maml:para><maml:para>-----------</maml:para><maml:para>Updates the constraints on task "myTask" under job "myJob".</maml:para><maml:para></maml:para><maml:para></maml:para><maml:para></maml:para><maml:para></maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText></command:commandText></command:commandLine></command:commandLines></command:example></command:examples><!-- Link section --><maml:relatedLinks><maml:navigationLink><maml:linkText></maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name> New-AzureBatchCertificate </command:name> <maml:description> <maml:para>Adds a new certificate to the specified Batch account.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureBatchCertificate</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para>Adds a new certificate to the specified Batch account.</maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem> <maml:name>New-AzureBatchCertificate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>The path to the certificate file. The certificate file must be in either .cer or .pfx format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>The password to access the certificate private key. This parameter must be supplied when using a .pfx certificate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureBatchCertificate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>RawData</maml:name> <maml:description> <maml:para>The raw certificate data in either .cer or .pfx format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">byte[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>The password to access the certificate private key. This parameter must be supplied when using a .pfx certificate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Cmdlet parameter section --> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> <dev:type> <maml:name>BatchAccountContext</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>The path to the certificate file. The certificate file must be in either .cer or .pfx format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>The password to access the certificate private key. This parameter must be supplied when using a .pfx certificate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>RawData</maml:name> <maml:description> <maml:para>The raw certificate data in either .cer or .pfx format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">byte[]</command:parameterValue> <dev:type> <maml:name>byte[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <!-- Input - Output section--> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <!-- Error section--> <command:terminatingErrors /> <command:nonTerminatingErrors /> <!-- Notes section --> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para> </maml:para> </maml:alert> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <!-- Example section --> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> New-AzureBatchCertificate "E:\Certificates\MyCert.cer" -BatchContext $context </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>Adds a new certificate to the specified Batch account using the file E:\Certificates\MyCert.cer.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText></command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> $rawData = [System.IO.File]::ReadAllBytes("E:\Certificates\MyCert.pfx") New-AzureBatchCertificate $rawData -Password "Password1234" -BatchContext $context </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>Adds a new certificate to the specified Batch account using the raw data from E:\Certificates\MyCert.pfx.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText></command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <!-- Link section --> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></maml:linkText> <maml:uri/> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name> Get-AzureBatchCertificate </command:name> <maml:description> <maml:para>The Get-AzureBatchCertificate cmdlet gets the certificates under the specified Batch account.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureBatchCertificate</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para>The Get-AzureBatchCertificate cmdlet gets the certificates under the Batch account specified with the BatchContext parameter. You can use the ThumbprintAlgorithm and Thumbprint parameters to get a single certificate, or you can use the Filter parameter to get the certificates that match an OData filter.</maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureBatchCertificate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies the OData filter clause to use when querying for certificates. If you do not specify a filter, all certificates under the Batch account specified with the BatchContext parameter are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxCount</maml:name> <maml:description> <maml:para>Specifies the maximum number of certificates to return. If you specify a value of zero (0) or less, the cmdlet does not use an upper limit. The default value is 1000.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Select</maml:name> <maml:description> <maml:para>Specifies an OData select clause. Used to retrieve only specific properties instead of all object properties.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureBatchCertificate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ThumbprintAlgorithm</maml:name> <maml:description> <maml:para>The algorithm used to derive the Thumbprint parameter. This must be sha1.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Thumbprint</maml:name> <maml:description> <maml:para>The thumbprint of the certificate to get.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Select</maml:name> <maml:description> <maml:para>Specifies an OData select clause. Used to retrieve only specific properties instead of all object properties.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Cmdlet parameter section --> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> <dev:type> <maml:name>BatchAccountContext</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies the OData filter clause to use when querying for certificates. If you do not specify a filter, all certificates under the Batch account specified with the BatchContext parameter are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MaxCount</maml:name> <maml:description> <maml:para>Specifies the maximum number of certificates to return. If you specify a value of zero (0) or less, the cmdlet does not use an upper limit. The default value is 1000.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Select</maml:name> <maml:description> <maml:para>Specifies an OData select clause. Used to retrieve only specific properties instead of all object properties.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Thumbprint</maml:name> <maml:description> <maml:para>The thumbprint of the certificate to get.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ThumbprintAlgorithm</maml:name> <maml:description> <maml:para>The algorithm used to derive the Thumbprint parameter. This must be sha1.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <!-- Input - Output section--> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <!-- Error section--> <command:terminatingErrors /> <command:nonTerminatingErrors /> <!-- Notes section --> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para> </maml:para> </maml:alert> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <!-- Example section --> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> Get-AzureBatchCertificate "sha1" "C1E494A415149C5F211C4778B52F2E834A07247C" -BatchContext $context Thumbprint : c1e494a415149c5f211c4778b52f2e834a07247c ThumbprintAlgorithm : sha1 Url : https://pstests.eastus.batch.azure.com/certificates(thumbprintAlgorithm=sha1,thumbprint=C1E494A415149C5F211C4778B52F2E834A07247 C) State : Active StateTransitionTime : 10/6/2015 6:21:16 PM PreviousState : PreviousStateTransitionTime : Data : CertificateFormat : Password : PublicData : MIIB9DCCAWGgAwIBAgIQpUXhwCuAPJRDhl7kY/0PdTAJBgUrDgMCHQUAMBYxFDASBgNVBAMTC0JhdGNoVGVzdDAxMB4XDTE1MTAwMjE2MjkwNVoXDTM5MTIzMTIzNTk 1OVowFjEUMBIGA1UEAxMLQmF0Y2hUZXN0MDEwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAM06unpRipn3BmHBM75d0s8w/Wwifci16PoJo4c2V68GwsCCFsNOn5 ypo7BBXo1fpBjrnso5w+koaE5LjxkBSVm+TkogwbKlW6WURTM0O5viRVbPnEEU/Y01Pj5cJElFuLEk9Uoe/r/lP8b5A607t1cPjSXkwhEZEYc3LkHDSo0ZAgMBAAGjS zBJMEcGA1UdAQRAMD6AEFRsTAsrvF+FmPuICooZXaKhGDAWMRQwEgYDVQQDEwtCYXRjaFRlc3QwMYIQpUXhwCuAPJRDhl7kY/0PdTAJBgUrDgMCHQUAA4GBALt0F8Ep +8XVE/M2aNtxzlku72gxiOiAo1HmpUaixXx3gl8kdP3xgoKMaq4JskqdLmbJJUnCQ3wmzsdPwjswsW2ycT12zuBddaiS+id98k8U/KYc6FxMgS+H70FYOxARLn7P4FS SBf/QCyign+BherzezdZ5NBdfzbmWxIMP5iFJ DeleteCertificateError : </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>Gets a single certificate. The certificate thumbprint algorithm is "sha1", and the thumbprint is "C1E494A415149C5F211C4778B52F2E834A07247C"</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText></command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> Get-AzureBatchCertificate -Filter "state eq 'active'" -BatchContext $context Thumbprint : 025b351b087a084c5067f5e71eff8591970323f9 ThumbprintAlgorithm : sha1 Url : https://pstests.eastus.batch.azure.com/certificates(thumbprintAlgorithm=sha1,thumbprint=025b351b087a084c5067f5e71eff8591970323f 9) State : Active StateTransitionTime : 10/6/2015 6:21:17 PM PreviousState : PreviousStateTransitionTime : Data : CertificateFormat : Password : PublicData : MIIB9DCCAWGgAwIBAgIQy9W5y8iwhppGhtAG06dHKTAJBgUrDgMCHQUAMBYxFDASBgNVBAMTC0JhdGNoVGVzdDAyMB4XDTE1MTAwMjE2MjkxNFoXDTM5MTIzMTIzNTk 1OVowFjEUMBIGA1UEAxMLQmF0Y2hUZXN0MDIwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAJxagvVrlnKfv6hfzSiFJUkdGkPjC3tFiKebK6IaeHzesFdFfupXUE wT0xOWh9xwa3OVkPECEc/u1sw3iVX/J4AODiwzmOWutoVRpWjxGFpgw9+dPvXMjs/Ue7JL7ag3siHs5EcarW91qKbgtko6i/r4emaRyk60U93TrbWQAWJ9AgMBAAGjS zBJMEcGA1UdAQRAMD6AEAdqsOpyeXF/uDe7ZGKeez+hGDAWMRQwEgYDVQQDEwtCYXRjaFRlc3QwMoIQy9W5y8iwhppGhtAG06dHKTAJBgUrDgMCHQUAA4GBAC0MaAem 6ByyURFvGnFZyjEepjXC5wcaGq+gguDFe8rG88ceig1ZqewdcmC1y4p05uBhbmETbYVWzJarNsHYq2LTihi4t2J4jt2YVYz/IRdUB82iaFFbJRSPrN+6xD3KM2lve5N 4OjtlZAdiXiSUYFf3I6ypberUsAdba3QQajCN DeleteCertificateError : Thumbprint : c1e494a415149c5f211c4778b52f2e834a07247c ThumbprintAlgorithm : sha1 Url : https://pstests.eastus.batch.azure.com/certificates(thumbprintAlgorithm=sha1,thumbprint=c1e494a415149c5f211c4778b52f2e834a07247 c) State : Active StateTransitionTime : 10/6/2015 6:21:16 PM PreviousState : PreviousStateTransitionTime : Data : CertificateFormat : Password : PublicData : MIIB9DCCAWGgAwIBAgIQpUXhwCuAPJRDhl7kY/0PdTAJBgUrDgMCHQUAMBYxFDASBgNVBAMTC0JhdGNoVGVzdDAxMB4XDTE1MTAwMjE2MjkwNVoXDTM5MTIzMTIzNTk 1OVowFjEUMBIGA1UEAxMLQmF0Y2hUZXN0MDEwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAM06unpRipn3BmHBM75d0s8w/Wwifci16PoJo4c2V68GwsCCFsNOn5 ypo7BBXo1fpBjrnso5w+koaE5LjxkBSVm+TkogwbKlW6WURTM0O5viRVbPnEEU/Y01Pj5cJElFuLEk9Uoe/r/lP8b5A607t1cPjSXkwhEZEYc3LkHDSo0ZAgMBAAGjS zBJMEcGA1UdAQRAMD6AEFRsTAsrvF+FmPuICooZXaKhGDAWMRQwEgYDVQQDEwtCYXRjaFRlc3QwMYIQpUXhwCuAPJRDhl7kY/0PdTAJBgUrDgMCHQUAA4GBALt0F8Ep +8XVE/M2aNtxzlku72gxiOiAo1HmpUaixXx3gl8kdP3xgoKMaq4JskqdLmbJJUnCQ3wmzsdPwjswsW2ycT12zuBddaiS+id98k8U/KYc6FxMgS+H70FYOxARLn7P4FS SBf/QCyign+BherzezdZ5NBdfzbmWxIMP5iFJ DeleteCertificateError : </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>Gets all certificates in the "active" state from the Batch account.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText></command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <!-- Link section --> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></maml:linkText> <maml:uri/> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name> Remove-AzureBatchCertificate </command:name> <maml:description> <maml:para>Deletes a certificate from the specified account.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureBatchCertificate</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para>Deletes a certificate from the specified account.</maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureBatchCertificate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ThumbprintAlgorithm</maml:name> <maml:description> <maml:para>The algorithm used to derive the Thumbprint parameter. This must be sha1.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Thumbprint</maml:name> <maml:description> <maml:para>The thumbprint of the certificate to delete.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If this parameter is not present, then you will be prompted for confirmation before the certificate is deleted. Use this parameter to delete the certificate without being asked for confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Cmdlet parameter section --> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> <dev:type> <maml:name>BatchAccountContext</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If this parameter is not present, then you will be prompted for confirmation before the certificate is deleted. Use this parameter to delete the certificate without being asked for confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Thumbprint</maml:name> <maml:description> <maml:para>The thumbprint of the certificate to delete.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ThumbprintAlgorithm</maml:name> <maml:description> <maml:para>The algorithm used to derive the Thumbprint parameter. This must be sha1.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <!-- Input - Output section--> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <!-- Error section--> <command:terminatingErrors /> <command:nonTerminatingErrors /> <!-- Notes section --> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para> </maml:para> </maml:alert> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <!-- Example section --> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> Remove-AzureBatchCertificate "sha1" "c1e494a415149c5f211c4778b52f2e834a07247c" -BatchContext $context </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>Deletes the certificate with thumbprint "c1e494a415149c5f211c4778b52f2e834a07247c". </maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText></command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------------------- EXAMPLE 2 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> Get-AzureBatchCertificate -Filter "state eq 'active'" -BatchContext $context | Remove-AzureBatchCertificate -Force -BatchContext $context </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>Deletes all active certificates from the Batch account.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText></command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <!-- Link section --> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></maml:linkText> <maml:uri/> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name> Stop-AzureBatchCertificateDeletion </command:name> <maml:description> <maml:para>Cancels a failed deletion of the specified certificate. </maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Stop</command:verb> <command:noun>AzureBatchCertificateDeletion</command:noun> <dev:version></dev:version> </command:details> <maml:description> <maml:para>Cancels a failed deletion of the specified certificate. This can be done only when the certificate is in the DeleteFailed state, and restores the certificate to the Active state.</maml:para> </maml:description> <!-- Cmdlet syntax section--> <command:syntax> <command:syntaxItem> <maml:name>Stop-AzureBatchCertificateDeletion</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ThumbprintAlgorithm</maml:name> <maml:description> <maml:para>The algorithm used to derive the Thumbprint parameter. This must be sha1.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Thumbprint</maml:name> <maml:description> <maml:para>The thumbprint of the certificate that failed to delete.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <!-- Cmdlet parameter section --> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>BatchContext</maml:name> <maml:description> <maml:para>The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BatchAccountContext</command:parameterValue> <dev:type> <maml:name>BatchAccountContext</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Thumbprint</maml:name> <maml:description> <maml:para>The thumbprint of the certificate that failed to delete.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ThumbprintAlgorithm</maml:name> <maml:description> <maml:para>The algorithm used to derive the Thumbprint parameter. This must be sha1.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <!-- Input - Output section--> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> <!-- description --> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <!-- Error section--> <command:terminatingErrors /> <command:nonTerminatingErrors /> <!-- Notes section --> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para> </maml:para> </maml:alert> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <!-- Example section --> <command:examples> <command:example> <maml:title> -------------------------- EXAMPLE 1 -------------------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code> Stop-AzureBatchCertificateDeletion "sha1" "c1e494a415149c5f211c4778b52f2e834a07247c" -BatchContext $context </dev:code> <dev:remarks> <maml:para>Description</maml:para> <maml:para>-----------</maml:para> <maml:para>Cancels the deletion of the certificate with thumbprint "c1e494a415149c5f211c4778b52f2e834a07247c".</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText></command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <!-- Link section --> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></maml:linkText> <maml:uri/> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzureRmBatchSubscriptionQuotas</command:name> <maml:description> <maml:para>Gets the quotas of the subscription in the Batch Service.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRmBatchSubscriptionQuotas</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Get-AzureRmBatchSubscriptionQuotas cmdlet gets the quotas of the subscription in the Batch Service for the specified region.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmBatchSubscriptionQuotas</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>Location</maml:name> <maml:description> <maml:para>The region to get the quotas of the subscription in the Batch Service from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="1" aliases="none"> <maml:name>Location</maml:name> <maml:description> <maml:para>The region to get the quotas of the subscription in the Batch Service from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PSBatchSubscriptionQuotas</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get the quotas for the subscription in the Batch Service in the westus region.</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-AzureRmBatchSubscriptionQuotas "westus" AccountQuota Location ------------ -------- 1 westus </dev:code> <dev:remarks> <maml:para>The return value indicates that this subscription can only create 1 account in the westus region.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> </command:command> </helpItems> |