diff --git a/src/ResourceManager/Resources/Commands.ResourceManager/Cmdlets/Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml b/src/ResourceManager/Resources/Commands.ResourceManager/Cmdlets/Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml index 061df876ebd6..18e86481ad65 100644 --- a/src/ResourceManager/Resources/Commands.ResourceManager/Cmdlets/Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml +++ b/src/ResourceManager/Resources/Commands.ResourceManager/Cmdlets/Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml @@ -7485,7 +7485,7 @@ Pre - + When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. SwitchParameter @@ -7537,7 +7537,7 @@ Pre - + When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. SwitchParameter @@ -7582,7 +7582,7 @@ Pre - + When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. SwitchParameter @@ -7618,7 +7618,7 @@ Pre - + When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. SwitchParameter @@ -7810,7 +7810,7 @@ Pre - + When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. SwitchParameter @@ -7886,7 +7886,7 @@ Pre - + When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. SwitchParameter @@ -7922,7 +7922,7 @@ Pre - + When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. SwitchParameter @@ -8087,7 +8087,7 @@ Scope - The scope at which to assign the policy assignment. For example: /subscriptions/{subId}/resourcegroups/{rgName} + The scope at which to assign the policy assignment. The allowed scopes are subscription, resource group or resource. An example of resource group scope: /subscriptions/{subId}/resourcegroups/{rgName}. An example of resource level scope would be /subscriptions/{subId}/resourcegroups/{rgName}/providers/{resource-type}/{resource-name} String @@ -8115,7 +8115,7 @@ Pre - + When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. SwitchParameter @@ -8151,7 +8151,7 @@ Scope - The scope at which to assign the policy assignment. For example: /subscriptions/{subId}/resourcegroups/{rgName} + The scope at which to assign the policy assignment. The allowed scopes are subscription, resource group or resource. An example of resource group scope: /subscriptions/{subId}/resourcegroups/{rgName}. An example of resource level scope would be /subscriptions/{subId}/resourcegroups/{rgName}/providers/{resource-type}/{resource-name} String @@ -8199,7 +8199,7 @@ Pre - + When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. SwitchParameter @@ -8352,7 +8352,7 @@ Pre - + When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. SwitchParameter @@ -8436,7 +8436,7 @@ Pre - + When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. SwitchParameter @@ -8598,7 +8598,7 @@ Pre - + When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. SwitchParameter @@ -8643,7 +8643,7 @@ Pre - + When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. SwitchParameter @@ -8715,7 +8715,7 @@ Pre - + When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. SwitchParameter @@ -8880,7 +8880,7 @@ Pre - + When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. SwitchParameter @@ -8939,14 +8939,14 @@ Pre - + When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. SwitchParameter InformationAction - + ActionPreference @@ -9023,7 +9023,7 @@ Pre - + When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. SwitchParameter @@ -9180,7 +9180,7 @@ Pre - + When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. SwitchParameter @@ -9225,7 +9225,7 @@ Pre - + When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. SwitchParameter @@ -9297,7 +9297,7 @@ Pre - + When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. SwitchParameter @@ -9467,7 +9467,7 @@ Remove-AzureRmPolicyAssignment -Id $policyAssignment.ResourceId -Force Pre - + When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. SwitchParameter @@ -9512,7 +9512,7 @@ Remove-AzureRmPolicyAssignment -Id $policyAssignment.ResourceId -Force Pre - + When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. SwitchParameter @@ -9572,7 +9572,7 @@ Remove-AzureRmPolicyAssignment -Id $policyAssignment.ResourceId -Force Pre - + When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. SwitchParameter @@ -9711,7 +9711,7 @@ Remove-AzureRmPolicyDefinition -Id $policyDefinition.ResourceId -Force - Invokes the specified action on a resource + Invokes the specified action on a resource. This command is an equivalent of a POST operation on a resource. To get a list of suported actions you can do something like Get-AzureRmProviderOperation -OperationSearchString * | where{$_.Operation -like "*action"} | FT Operation. You can also use the Azure Resource Explorer tool to discover these actions and the schema of the -Parameters property @@ -9719,7 +9719,7 @@ Remove-AzureRmPolicyDefinition -Id $policyDefinition.ResourceId -Force Parameters - A hashtable that reperesents the resource properties + A hashtable that reperesents the resource properties. Example- $ParametersObject=@{targetResourceGroup = "(string)", resources = ("string")} String @@ -9740,7 +9740,7 @@ Remove-AzureRmPolicyDefinition -Id $policyDefinition.ResourceId -Force Pre - + When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. SwitchParameter @@ -9764,7 +9764,7 @@ Remove-AzureRmPolicyDefinition -Id $policyDefinition.ResourceId -Force Parameters - A hashtable that reperesents the resource properties + A hashtable that reperesents the resource properties. Example- $ParametersObject=@{targetResourceGroup = "(string)", resources = ("string")} String @@ -9785,7 +9785,7 @@ Remove-AzureRmPolicyDefinition -Id $policyDefinition.ResourceId -Force Pre - + When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use. SwitchParameter diff --git a/src/ResourceManager/Resources/Commands.Resources/Microsoft.Azure.Commands.Resources.dll-Help.xml b/src/ResourceManager/Resources/Commands.Resources/Microsoft.Azure.Commands.Resources.dll-Help.xml index f7fd6245f67a..9fe4fb1e554e 100644 --- a/src/ResourceManager/Resources/Commands.Resources/Microsoft.Azure.Commands.Resources.dll-Help.xml +++ b/src/ResourceManager/Resources/Commands.Resources/Microsoft.Azure.Commands.Resources.dll-Help.xml @@ -1469,7 +1469,7 @@ - The Get-AzureRmResourceGroup cmdlet gets the Azure resource groups in your subscription. You can use the Name parameter to select resource groups by name. The default is all resource groups.An Azure resource is a user-managed Azure entity, such as a database server, database, or web site. An Azure resource group is a collection of Azure resources that are deployed as a unit. + The Get-AzureRmResourceGroup cmdlet gets the Azure resource groups in your subscription. You can use the Name parameter to select resource groups by name. The default is all resource groups. An Azure resource is a user-managed Azure entity, such as a database server, database, or web site. An Azure resource group is a collection of Azure resources that are deployed as a unit. @@ -1501,37 +1501,35 @@ - - Get-AzureRmResourceGroup - - Id - - Specifies the id of the resource group. Wildcards are not permitted. This parameter is optional. The default is all resource groups in the subscription - - String - - String - - - - - - - Location - - Specifies the location of the resource group. - - String - - String - - - - - - + Get-AzureRmResourceGroup + + Id + + Specifies the id of the resource group. Wildcards are not permitted. This parameter is optional. The default is all resource groups in the subscription + + String + + String + + + + + + + Location + + Specifies the location of the resource group. + + String + + String + + + + + @@ -1579,24 +1577,19 @@ PS C:\> - PS C:\>Get-AzureRmResourceGroup -Detailed -Name: Contoso -Location: West US -Resources: - Name Type Location - =============== ======================= ======== - ConstosoWebSite Microsoft.Web/sites West US - sqlsvr03 Microsoft.Sql/servers West US - sqldb01 Microsoft.Sql/databases West US + PS C:\>Get-AzureRmResourceGroup + ResourceGroupName : Api-Default-West-US + Location : westus + ProvisioningState : Succeeded + Tags : + ResourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/Api-Default-West-US -Name: EngineerBlog -Location: East US -Resources: - Name Type Location - =============== ======================= ======== - EngineerBlog Microsoft.Web/sites West US - EngSvr01 Microsoft.Sql/servers West US - EngDB02 Microsoft.Sql/databases West US + ResourceGroupName : AzureResourceGroup3 + Location : centralus + ProvisioningState : Succeeded + Tags : + ResourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/AzureResourceGroup3 + This command gets all resource groups in the subscription. @@ -1613,21 +1606,19 @@ Resources: - -------------------------- Example 2: Get resource groups by name -------------------------- + -------------------------- Example 2: Get resource group by name -------------------------- PS C:\> - PS C:\>Get-AzureRmResourceGroup -Name EngineerBlog -Name: EngineerBlog -Location: East US -Resources: - Name Type Location - =============== ======================= ======== - EngineerBlog Microsoft.Web/sites West US - EngSvr01 Microsoft.Sql/servers West US - EngDB02 Microsoft.Sql/databases West US - - This command gets Azure resource groups in your subscription that have names that begin with "eng". + PS C:\>Get-AzureRmResourceGroup -Name AzureResourceGroup3 + ResourceGroupName : AzureResourceGroup3 + Location : centralus + ProvisioningState : Succeeded + Tags : + ResourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/AzureResourceGroup3 + + + This command gets the Azure resource group in your subscription which has the name AzureResourceGroup3. @@ -1640,54 +1631,9 @@ Resources: - + - -------------------------- Example 3: Get resource groups by other properties -------------------------- - - PS C:\> - - PS C:\>Get-AzureRmResourceGroup -Detailed | Where-Object {$_.Resources.Type -like "*serverFarms*"} | Select-Object -Property ResourceGroupName -Contoso -EngineerBlog - - The command uses the Where-Object, ForEach-Object, and Select-Object cmdlets to get the names of resource groups that include Azure database server farms. You can use commands like this one to find resource groups with resources or properties of interest. - - - The command uses the Get-AzureRmResourceGroup cmdlet to get all resource groups in the subscription. It pipes the resource groups to the Where-Object cmdlet, which returns only the resource groups that include server farm resources. The command pipes those resource groups to the Select-Object cmdlet, which returns only the value of the ResourceGroupName property of each resource group. - - - - - - - - - - - -------------------------- Example 4: Get resource groups by tag -------------------------- - - PS C:\> - - PS C:\>Get-AzureRmResourceGroup -Tag @{Name="CostCenter";Value="Development"} - -PS C:\>Get-AzureRmResourceGroup -Tag @{Name="CostCenter"} - - These commands get resource groups by tag. The first command gets resource groups that have a "CostCenter" tag with a value of "Development". The second command gets all resource groups that have a "CostCenter" tag, regardless of its value. - - - - - - - - - - - - - - - -------------------------- Example 5: Get all tags of a resource group -------------------------- + -------------------------- Example 3: Get all tags of a resource group -------------------------- PS C:\> @@ -4165,7 +4111,7 @@ NewApplication 61b5d8ea-fdc6-40a2 New-AzureRmResourceGroup - Creates an Azure resource group and its resources + Creates an Azure resource group @@ -4183,7 +4129,7 @@ NewApplication 61b5d8ea-fdc6-40a2 Name - Specifies a name for the resource group. This parameter is required. The resource name must be unique in the subscription.You can use -Name or its alias, -ResourceGroupName.If a resource group with that name already exists, the command prompts you for confirmation before replacing the existing resource group. To suppress the confirmation prompt, use the Force parameter. + Specifies a name for the resource group. This parameter is required. The resource group name must be unique in the subscription.You can use -Name or its alias, -ResourceGroupName.If a resource group with that name already exists, the command prompts you for confirmation before replacing the existing resource group. To suppress the confirmation prompt, use the Force parameter. String @@ -4197,7 +4143,7 @@ NewApplication 61b5d8ea-fdc6-40a2 Tag - Applies the specified tags to the new resource group. Enter new tags or predefined tags that you created by using the New-AzureRmTag cmdlet.A "tag" is a name-value pair that you can apply to resources and resource groups. Use tags to categorize your resources, such as by department or cost center, or to track notes or comments about the resources. After you assign tags to resources, you can use the Tag parameters of Get-AzureRmResource and Get-AzureRmResourceGroup to search for resources and groups by tag name or name and value.Every tag must have a Name key. It can also have an optional Value key with one value. To specify a new tag, use a hash table, such as @{Name="FY2015"} or @{Name="Department";Value="IT"}. To specify multiple tags, use commas to separate the hash tables, such as -Tag @{Name="FY2015"}, @{Name="Department";Value="IT"}. To get your predefined tags, use the Get-AzureRmTag cmdlet. + Applies the specified tags to the new resource group. Enter new tags or predefined tags that you created by using the New-AzureRmTag cmdlet.A "tag" is a name-value pair that you can apply to resources and resource groups. Use tags to categorize your resources, such as by department or cost center, or to track notes or comments about the resources. After you assign tags to resources, you can use the Tag parameters of Find-AzureRmResource and Find-AzureRmResourceGroup to search for resources and groups by tag name or name and value.Every tag must have a Name key. It can also have an optional Value key with one value. To specify a new tag, use a hash table, such as @{Name="FY2015"} or @{Name="Department";Value="IT"}. To specify multiple tags, use commas to separate the hash tables, such as -Tag @{Name="FY2015"}, @{Name="Department";Value="IT"}. To get your predefined tags, use the Get-AzureRmTag cmdlet. Hashtable[] @@ -4238,7 +4184,7 @@ NewApplication 61b5d8ea-fdc6-40a2 Tag - Applies the specified tags to the new resource group. Enter new tags or predefined tags that you created by using the New-AzureRmTag cmdlet.A "tag" is a name-value pair that you can apply to resources and resource groups. Use tags to categorize your resources, such as by department or cost center, or to track notes or comments about the resources. After you assign tags to resources, you can use the Tag parameters of Get-AzureRmResource and Get-AzureRmResourceGroup to search for resources and groups by tag name or name and value.Every tag must have a Name key. It can also have an optional Value key with one value. To specify a new tag, use a hash table, such as @{Name="FY2015"} or @{Name="Department";Value="IT"}. To specify multiple tags, use commas to separate the hash tables, such as -Tag @{Name="FY2015"}, @{Name="Department";Value="IT"}. To get your predefined tags, use the Get-AzureRmTag cmdlet. + Applies the specified tags to the new resource group. Enter new tags or predefined tags that you created by using the New-AzureRmTag cmdlet.A "tag" is a name-value pair that you can apply to resources and resource groups. Use tags to categorize your resources, such as by department or cost center, or to track notes or comments about the resources. After you assign tags to resources, you can use the Tag parameters of Find-AzureRmResource and Find-AzureRmResourceGroup to search for resources and groups by tag name or name and value.Every tag must have a Name key. It can also have an optional Value key with one value. To specify a new tag, use a hash table, such as @{Name="FY2015"} or @{Name="Department";Value="IT"}. To specify multiple tags, use commas to separate the hash tables, such as -Tag @{Name="FY2015"}, @{Name="Department";Value="IT"}. To get your predefined tags, use the Get-AzureRmTag cmdlet. Hashtable[] @@ -5995,7 +5941,7 @@ Resources Register-AzureRmResourceProvider - + Registers a subscription with a resource provider @@ -6005,7 +5951,7 @@ Resources - + Registers a subscription with a resource provider. A subscription must be registered with a resource provider before you can start using the resources supported by that provider. You can check the registration state of the providers in your subscription by running Get-AzureRmResourceProvider -ListAvailable @@ -6013,7 +5959,7 @@ Resources ProviderNamespace - + The namespace of the resource provider String @@ -6037,7 +5983,7 @@ Resources ProviderNamespace - + The namespace of the resource provider String