Skip to content

Commit 9926594

Browse files
author
Hovsep
committed
Merge pull request Azure#1869 from vivsriaus/DocUpdate
Update help for ARM cmdlets
2 parents 97d1738 + 83ab72d commit 9926594

File tree

2 files changed

+590
-729
lines changed

2 files changed

+590
-729
lines changed

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

Lines changed: 294 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9695,6 +9695,300 @@ Remove-AzureRmPolicyDefinition -Id $policyDefinition.ResourceId -Force</dev:code
96959695
</command:examples>
96969696
<maml:relatedLinks>
96979697
</maml:relatedLinks>
9698+
</command:command>
9699+
<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">
9700+
<!--Generated by PS Cmdlet Help Editor-->
9701+
<command:details>
9702+
<command:name>Invoke-AzureRmResourceAction</command:name>
9703+
<maml:description>
9704+
<maml:para>Invokes the specified action on a resource</maml:para>
9705+
</maml:description>
9706+
<maml:copyright>
9707+
<maml:para />
9708+
</maml:copyright>
9709+
<command:verb>Invoke</command:verb>
9710+
<command:noun>AzureRmResourceAction</command:noun>
9711+
<dev:version />
9712+
</command:details>
9713+
<maml:description>
9714+
<maml:para>Invokes the specified action on a resource</maml:para>
9715+
</maml:description>
9716+
<command:syntax>
9717+
<command:syntaxItem>
9718+
<maml:name>Invoke-AzureRmResourceAction</maml:name>
9719+
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
9720+
<maml:name>Parameters</maml:name>
9721+
<maml:description>
9722+
<maml:para>A hashtable that reperesents the resource properties</maml:para>
9723+
</maml:description>
9724+
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
9725+
</command:parameter>
9726+
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
9727+
<maml:name>Force</maml:name>
9728+
<maml:description>
9729+
<maml:para>Do not ask for confirmation</maml:para>
9730+
</maml:description>
9731+
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
9732+
</command:parameter>
9733+
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
9734+
<maml:name>ApiVersion</maml:name>
9735+
<maml:description>
9736+
<maml:para>The api version to use while invoking the action on the resource.</maml:para>
9737+
</maml:description>
9738+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
9739+
</command:parameter>
9740+
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
9741+
<maml:name>Pre</maml:name>
9742+
<maml:description>
9743+
<maml:para />
9744+
</maml:description>
9745+
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
9746+
</command:parameter>
9747+
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
9748+
<maml:name>InformationAction</maml:name>
9749+
<maml:description>
9750+
<maml:para />
9751+
</maml:description>
9752+
<command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue>
9753+
</command:parameter>
9754+
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
9755+
<maml:name>InformationVariable</maml:name>
9756+
<maml:description>
9757+
<maml:para />
9758+
</maml:description>
9759+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
9760+
</command:parameter>
9761+
</command:syntaxItem>
9762+
</command:syntax>
9763+
<command:parameters>
9764+
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
9765+
<maml:name>Parameters</maml:name>
9766+
<maml:description>
9767+
<maml:para>A hashtable that reperesents the resource properties</maml:para>
9768+
</maml:description>
9769+
<command:parameterValue required="false" variableLength="false">String</command:parameterValue>
9770+
</command:parameter>
9771+
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
9772+
<maml:name>Force</maml:name>
9773+
<maml:description>
9774+
<maml:para>Do not ask for confirmation</maml:para>
9775+
</maml:description>
9776+
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
9777+
</command:parameter>
9778+
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
9779+
<maml:name>ApiVersion</maml:name>
9780+
<maml:description>
9781+
<maml:para>The api version to use while invoking the action on the resource.</maml:para>
9782+
</maml:description>
9783+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
9784+
</command:parameter>
9785+
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
9786+
<maml:name>Pre</maml:name>
9787+
<maml:description>
9788+
<maml:para />
9789+
</maml:description>
9790+
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
9791+
<dev:type>
9792+
<maml:name>SwitchParameter</maml:name>
9793+
<maml:uri/>
9794+
</dev:type>
9795+
<dev:defaultValue></dev:defaultValue>
9796+
</command:parameter>
9797+
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
9798+
<maml:name>InformationAction</maml:name>
9799+
<maml:description>
9800+
<maml:para />
9801+
</maml:description>
9802+
<command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue>
9803+
<dev:type>
9804+
<maml:name>ActionPreference</maml:name>
9805+
<maml:uri/>
9806+
</dev:type>
9807+
<dev:defaultValue></dev:defaultValue>
9808+
</command:parameter>
9809+
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
9810+
<maml:name>InformationVariable</maml:name>
9811+
<maml:description>
9812+
<maml:para />
9813+
</maml:description>
9814+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
9815+
<dev:type>
9816+
<maml:name>String</maml:name>
9817+
<maml:uri/>
9818+
</dev:type>
9819+
<dev:defaultValue></dev:defaultValue>
9820+
</command:parameter>
9821+
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
9822+
<maml:name>Action</maml:name>
9823+
<maml:description>
9824+
<maml:para>The name of the action to invoke.</maml:para>
9825+
</maml:description>
9826+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
9827+
<dev:type>
9828+
<maml:name>String</maml:name>
9829+
<maml:uri/>
9830+
</dev:type>
9831+
<dev:defaultValue></dev:defaultValue>
9832+
</command:parameter>
9833+
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
9834+
<maml:name>ResourceId</maml:name>
9835+
<maml:description>
9836+
<maml:para>The fully qualified resource Id, including the subscription. e.g. /subscriptions/{subscriptionId}/providers/Microsoft.Sql/servers/myServer/databases/myDatabase</maml:para>
9837+
</maml:description>
9838+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
9839+
<dev:type>
9840+
<maml:name>String</maml:name>
9841+
<maml:uri/>
9842+
</dev:type>
9843+
<dev:defaultValue></dev:defaultValue>
9844+
</command:parameter>
9845+
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
9846+
<maml:name>ResourceName</maml:name>
9847+
<maml:description>
9848+
<maml:para>The resource name. e.g. to specify a database MyServer/MyDatabase.</maml:para>
9849+
</maml:description>
9850+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
9851+
<dev:type>
9852+
<maml:name>String</maml:name>
9853+
<maml:uri/>
9854+
</dev:type>
9855+
<dev:defaultValue></dev:defaultValue>
9856+
</command:parameter>
9857+
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
9858+
<maml:name>ResourceType</maml:name>
9859+
<maml:description>
9860+
<maml:para>The resource type. e.g. Microsoft.Sql/Servers/Databases.</maml:para>
9861+
</maml:description>
9862+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
9863+
<dev:type>
9864+
<maml:name>String</maml:name>
9865+
<maml:uri />
9866+
</dev:type>
9867+
<dev:defaultValue>
9868+
</dev:defaultValue>
9869+
</command:parameter>
9870+
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
9871+
<maml:name>ExtensionResourceName</maml:name>
9872+
<maml:description>
9873+
<maml:para>The extension resource name. e.g. to specify a database MyServer/MyDatabase.</maml:para>
9874+
</maml:description>
9875+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
9876+
<dev:type>
9877+
<maml:name>String</maml:name>
9878+
<maml:uri />
9879+
</dev:type>
9880+
<dev:defaultValue>
9881+
</dev:defaultValue>
9882+
</command:parameter>
9883+
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
9884+
<maml:name>ExtensionResourceType</maml:name>
9885+
<maml:description>
9886+
<maml:para>The extension resource type. e.g. Microsoft.Sql/Servers/Databases.</maml:para>
9887+
</maml:description>
9888+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
9889+
<dev:type>
9890+
<maml:name>String</maml:name>
9891+
<maml:uri />
9892+
</dev:type>
9893+
<dev:defaultValue>
9894+
</dev:defaultValue>
9895+
</command:parameter>
9896+
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
9897+
<maml:name>ODataQuery</maml:name>
9898+
<maml:description>
9899+
<maml:para>An OData style filter which will be appended to the request in addition to any other filters.</maml:para>
9900+
</maml:description>
9901+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
9902+
<dev:type>
9903+
<maml:name>String</maml:name>
9904+
<maml:uri />
9905+
</dev:type>
9906+
<dev:defaultValue>
9907+
</dev:defaultValue>
9908+
</command:parameter>
9909+
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
9910+
<maml:name>ResourceGroupName</maml:name>
9911+
<maml:description>
9912+
<maml:para>The resource group name.</maml:para>
9913+
</maml:description>
9914+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
9915+
<dev:type>
9916+
<maml:name>String</maml:name>
9917+
<maml:uri />
9918+
</dev:type>
9919+
<dev:defaultValue>
9920+
</dev:defaultValue>
9921+
</command:parameter>
9922+
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
9923+
<maml:name>TenantLevel</maml:name>
9924+
<maml:description>
9925+
<maml:para />
9926+
</maml:description>
9927+
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
9928+
<dev:type>
9929+
<maml:name>SwitchParameter</maml:name>
9930+
<maml:uri />
9931+
</dev:type>
9932+
<dev:defaultValue>
9933+
</dev:defaultValue>
9934+
</command:parameter>
9935+
</command:parameters>
9936+
<command:inputTypes>
9937+
<command:inputType>
9938+
<dev:type>
9939+
<maml:name></maml:name>
9940+
<maml:uri></maml:uri>
9941+
<maml:description/>
9942+
</dev:type>
9943+
<maml:description>
9944+
<maml:para />
9945+
</maml:description>
9946+
</command:inputType>
9947+
</command:inputTypes>
9948+
<command:returnValues>
9949+
<command:returnValue>
9950+
<dev:type>
9951+
<maml:name></maml:name>
9952+
<maml:uri></maml:uri>
9953+
<maml:description/>
9954+
</dev:type>
9955+
<maml:description>
9956+
<maml:para />
9957+
</maml:description>
9958+
</command:returnValue>
9959+
</command:returnValues>
9960+
<command:terminatingErrors></command:terminatingErrors>
9961+
<command:nonTerminatingErrors></command:nonTerminatingErrors>
9962+
<maml:alertSet>
9963+
<maml:title></maml:title>
9964+
<maml:alert>
9965+
<maml:para />
9966+
</maml:alert>
9967+
</maml:alertSet>
9968+
<command:examples>
9969+
<command:example>
9970+
<maml:title>-------------------------- Invoke list action on website config resource --------------------------</maml:title>
9971+
<maml:introduction>
9972+
<maml:paragraph>PS C:\&gt;</maml:paragraph>
9973+
</maml:introduction>
9974+
<dev:code>Invoke-AzureRmResourceAction -ResourceGroupName myGroup -ResourceType Microsoft.Web/sites/config/list -ResourceName mySite/appsettings -Action list -ApiVersion 2015-08-01 -Force</dev:code>
9975+
<dev:remarks>
9976+
<maml:para>Invokes the list action on website config</maml:para>
9977+
<maml:para />
9978+
<maml:para />
9979+
<maml:para></maml:para>
9980+
</dev:remarks>
9981+
<command:commandLines>
9982+
<command:commandLine>
9983+
<command:commandText>
9984+
<maml:para />
9985+
</command:commandText>
9986+
</command:commandLine>
9987+
</command:commandLines>
9988+
</command:example>
9989+
</command:examples>
9990+
<maml:relatedLinks>
9991+
</maml:relatedLinks>
96989992
</command:command>
96999993
</helpItems>
97009994

0 commit comments

Comments
 (0)