Skip to content

Commit 447460a

Browse files
ravbhatnagarravbhatnagar
committed
Adding positional params to Resource group cmdlets and updating help for a bunch of cmdlets
1 parent 40ff809 commit 447460a

File tree

5 files changed

+100
-29
lines changed

5 files changed

+100
-29
lines changed

‎src/ResourceManager/Resources/Commands.ResourceManager/Cmdlets/Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml

Lines changed: 54 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -882,7 +882,8 @@
882882
<dev:version />
883883
</command:details>
884884
<maml:description>
885-
<maml:para>Gets the resource group deployment operation</maml:para>
885+
<maml:para>This lists all the operations that were part of a deployment. It can be used for debugging deployment failures as it will help you identify and give more information about the exact operations that failed for a particular deployment. It can also give out the response and the request content for each deployment operation. This is the same information that you get from the deployment details on the portal. </maml:para>
886+
<maml:para>For getting the request and the response content, the setting will have to be enabled when submitting a deployment through New-AzureRmResourceGroupDeployment. log and expose secrets like passwords used in the resource property or listKeys operations that are then returned when you retrieve the deployment operations. For more details on this setting and how to enable it, please see the help for New-AzureRmResourceGroupDeployment</maml:para>
886887
</maml:description>
887888
<command:syntax>
888889
<command:syntaxItem>
@@ -1095,7 +1096,7 @@
10951096
</maml:alertSet>
10961097
<command:examples>
10971098
<command:example>
1098-
<maml:title>-------------------------- Get1 --------------------------</maml:title>
1099+
<maml:title>-------------------------- Example1 --------------------------</maml:title>
10991100
<maml:introduction>
11001101
<maml:paragraph>PS C:\&gt;</maml:paragraph>
11011102
</maml:introduction>
@@ -1115,6 +1116,37 @@
11151116
</command:commandLine>
11161117
</command:commandLines>
11171118
</command:example>
1119+
<command:example>
1120+
<maml:title>------- Example2 Get the request and response content for each deployment operation if enabled on new deployment -------</maml:title>
1121+
<maml:introduction>
1122+
<maml:paragraph>PS C:\&gt;</maml:paragraph>
1123+
</maml:introduction>
1124+
<dev:code>
1125+
$operations = Get-AzureRmResourceGroupDeploymentOperation -DeploymentName test -ResourceGroupName test
1126+
foreach($operation in $operations)
1127+
{
1128+
Write-Host $operation.id
1129+
Write-Host "Request:"
1130+
$operation.Properties.Request | ConvertTo-Json -Depth 10
1131+
Write-Host "Response:"
1132+
$operation.Properties.Response | ConvertTo-Json -Depth 10
1133+
}
1134+
</dev:code>
1135+
<dev:remarks>
1136+
<maml:para>Gets deployment operation with name "test" under resource group "test" and lists all the request and response content associated with each deployment operation.</maml:para>
1137+
<maml:para />
1138+
<maml:para />
1139+
<maml:para>
1140+
</maml:para>
1141+
</dev:remarks>
1142+
<command:commandLines>
1143+
<command:commandLine>
1144+
<command:commandText>
1145+
<maml:para />
1146+
</command:commandText>
1147+
</command:commandLine>
1148+
</command:commandLines>
1149+
</command:example>
11181150
</command:examples>
11191151
<maml:relatedLinks>
11201152
</maml:relatedLinks>
@@ -2863,22 +2895,22 @@
28632895
<dev:version />
28642896
</command:details>
28652897
<maml:description>
2866-
<maml:para>Create a new resource lock.</maml:para>
2898+
<maml:para>Create a new resource lock. Resource Locks are useful to prevent accidental deletions of your azure resources. Once a lock is placed on a resource, it can't be deleted unless the lock is removed. </maml:para>
28672899
</maml:description>
28682900
<command:syntax>
28692901
<command:syntaxItem>
28702902
<maml:name>New-AzureRmResourceLock</maml:name>
28712903
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
28722904
<maml:name>LockLevel</maml:name>
28732905
<maml:description>
2874-
<maml:para>The level of the lock.</maml:para>
2906+
<maml:para>The level of the lock. The currently supported lock level is "CannotDelete". When this level is set on a resource, that resource cannont be deleted unless the lock is removed. </maml:para>
28752907
</maml:description>
28762908
<command:parameterValue required="true" variableLength="false">LockLevel</command:parameterValue>
28772909
</command:parameter>
28782910
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
28792911
<maml:name>LockNotes</maml:name>
28802912
<maml:description>
2881-
<maml:para>The notes of the lock.</maml:para>
2913+
<maml:para>The notes of the lock. This should not exceed 512 characters.</maml:para>
28822914
</maml:description>
28832915
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
28842916
</command:parameter>
@@ -2965,14 +2997,14 @@
29652997
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
29662998
<maml:name>LockLevel</maml:name>
29672999
<maml:description>
2968-
<maml:para>The level of the lock.</maml:para>
3000+
<maml:para>The level of the lock. The currently supported lock level is "CannotDelete". When this level is set on a resource, that resource cannont be deleted unless the lock is removed. </maml:para>
29693001
</maml:description>
29703002
<command:parameterValue required="true" variableLength="false">LockLevel</command:parameterValue>
29713003
</command:parameter>
29723004
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
29733005
<maml:name>LockNotes</maml:name>
29743006
<maml:description>
2975-
<maml:para>The notes of the lock.</maml:para>
3007+
<maml:para>The notes of the lock. This should not exceed 512 characters.</maml:para>
29763008
</maml:description>
29773009
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
29783010
</command:parameter>
@@ -3052,14 +3084,14 @@
30523084
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
30533085
<maml:name>LockLevel</maml:name>
30543086
<maml:description>
3055-
<maml:para>The level of the lock.</maml:para>
3087+
<maml:para>The level of the lock. The currently supported lock level is "CannotDelete". When this level is set on a resource, that resource cannont be deleted unless the lock is removed. </maml:para>
30563088
</maml:description>
30573089
<command:parameterValue required="true" variableLength="false">LockLevel</command:parameterValue>
30583090
</command:parameter>
30593091
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
30603092
<maml:name>LockNotes</maml:name>
30613093
<maml:description>
3062-
<maml:para>The notes of the lock.</maml:para>
3094+
<maml:para>The notes of the lock. This should not exceed 512 characters.</maml:para>
30633095
</maml:description>
30643096
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
30653097
</command:parameter>
@@ -3153,14 +3185,14 @@
31533185
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
31543186
<maml:name>LockLevel</maml:name>
31553187
<maml:description>
3156-
<maml:para>The level of the lock.</maml:para>
3188+
<maml:para>The level of the lock. The currently supported lock level is "CannotDelete". When this level is set on a resource, that resource cannont be deleted unless the lock is removed. </maml:para>
31573189
</maml:description>
31583190
<command:parameterValue required="true" variableLength="false">LockLevel</command:parameterValue>
31593191
</command:parameter>
31603192
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
31613193
<maml:name>LockNotes</maml:name>
31623194
<maml:description>
3163-
<maml:para>The notes of the lock.</maml:para>
3195+
<maml:para>The notes of the lock. This should not exceed 512 characters.</maml:para>
31643196
</maml:description>
31653197
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
31663198
</command:parameter>
@@ -3254,14 +3286,14 @@
32543286
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
32553287
<maml:name>LockLevel</maml:name>
32563288
<maml:description>
3257-
<maml:para>The level of the lock.</maml:para>
3289+
<maml:para>The level of the lock. The currently supported lock level is "CannotDelete". When this level is set on a resource, that resource cannont be deleted unless the lock is removed. </maml:para>
32583290
</maml:description>
32593291
<command:parameterValue required="true" variableLength="false">LockLevel</command:parameterValue>
32603292
</command:parameter>
32613293
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
32623294
<maml:name>LockNotes</maml:name>
32633295
<maml:description>
3264-
<maml:para>The notes of the lock.</maml:para>
3296+
<maml:para>The notes of the lock. This should not exceed 512 characters.</maml:para>
32653297
</maml:description>
32663298
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
32673299
</command:parameter>
@@ -3334,14 +3366,14 @@
33343366
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
33353367
<maml:name>LockLevel</maml:name>
33363368
<maml:description>
3337-
<maml:para>The level of the lock.</maml:para>
3369+
<maml:para>The level of the lock. The currently supported lock level is "CannotDelete". When this level is set on a resource, that resource cannont be deleted unless the lock is removed.</maml:para>
33383370
</maml:description>
33393371
<command:parameterValue required="true" variableLength="false">LockLevel</command:parameterValue>
33403372
</command:parameter>
33413373
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
33423374
<maml:name>LockNotes</maml:name>
33433375
<maml:description>
3344-
<maml:para>The notes of the lock.</maml:para>
3376+
<maml:para>The notes of the lock. This should not exceed 512 characters.</maml:para>
33453377
</maml:description>
33463378
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
33473379
</command:parameter>
@@ -3421,7 +3453,7 @@
34213453
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
34223454
<maml:name>LockLevel</maml:name>
34233455
<maml:description>
3424-
<maml:para>The level of the lock.</maml:para>
3456+
<maml:para>TThe level of the lock. The currently supported lock level is "CannotDelete". When this level is set on a resource, that resource cannont be deleted unless the lock is removed. </maml:para>
34253457
</maml:description>
34263458
<command:parameterValue required="true" variableLength="false">LockLevel</command:parameterValue>
34273459
<dev:type>
@@ -3434,7 +3466,7 @@
34343466
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
34353467
<maml:name>LockNotes</maml:name>
34363468
<maml:description>
3437-
<maml:para>The notes of the lock.</maml:para>
3469+
<maml:para>The notes of the lock. This should not exceed 512 characters.</maml:para>
34383470
</maml:description>
34393471
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
34403472
<dev:type>
@@ -3684,7 +3716,7 @@
36843716
</maml:alertSet>
36853717
<command:examples>
36863718
<command:example>
3687-
<maml:title>-------------------------- New1 --------------------------</maml:title>
3719+
<maml:title>-------------------------- Example1 --------------------------</maml:title>
36883720
<maml:introduction>
36893721
<maml:paragraph>PS C:\&gt;</maml:paragraph>
36903722
</maml:introduction>
@@ -4924,7 +4956,7 @@
49244956
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
49254957
<maml:name>Properties</maml:name>
49264958
<maml:description>
4927-
<maml:para>A hash table which represents resource properties.</maml:para>
4959+
<maml:para>A hash table which represents resource properties. You should always provide the full properties set to Set-AzureResource. You can fetch all the current properties using Get-AzureRmResource, modify the properties you want to and then pass it to this cmdlet for updating.</maml:para>
49284960
</maml:description>
49294961
<command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue>
49304962
</command:parameter>
@@ -5032,7 +5064,7 @@
50325064
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
50335065
<maml:name>Properties</maml:name>
50345066
<maml:description>
5035-
<maml:para>A hash table which represents resource properties.</maml:para>
5067+
<maml:para>A hash table which represents resource properties. You should always provide the full properties set to Set-AzureResource. You can fetch all the current properties using Get-AzureRmResource, modify the properties you want to and then pass it to this cmdlet for updating.</maml:para>
50365068
</maml:description>
50375069
<command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue>
50385070
</command:parameter>
@@ -5168,7 +5200,7 @@
51685200
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
51695201
<maml:name>Properties</maml:name>
51705202
<maml:description>
5171-
<maml:para>A hash table which represents resource properties.</maml:para>
5203+
<maml:para>A hash table which represents resource properties. You should always provide the full properties set to Set-AzureResource. You can fetch all the current properties using Get-AzureRmResource, modify the properties you want to and then pass it to this cmdlet for updating.</maml:para>
51725204
</maml:description>
51735205
<command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue>
51745206
</command:parameter>
@@ -5310,7 +5342,7 @@
53105342
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
53115343
<maml:name>Properties</maml:name>
53125344
<maml:description>
5313-
<maml:para>A hash table which represents resource properties.</maml:para>
5345+
<maml:para>A hash table which represents resource properties. You should always provide the full properties set to Set-AzureResource. You can fetch all the current properties using Get-AzureRmResource, modify the properties you want to and then pass it to this cmdlet for updating.</maml:para>
53145346
</maml:description>
53155347
<command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue>
53165348
<dev:type>

0 commit comments

Comments
 (0)