Normalizing static analysis, adding help and parameter checks, adding generated help

Author: markcowl

src/CLU/Commands.ResourceManager.Cmdlets/Content/help/resource.action.invoke.hlp

@@ -0,0 +1,53 @@
+az resource action invoke
+
+Invoke a Resource Action.
+
+USAGE:
+
+az resource action invoke -a <action> --resourceId <resourceId> [--parameters <parameters>] [--oDataQuery <oDataQuery>] [-f] [--apiVersion <apiVersion>] [--pre]
+
+az resource action invoke -a <action> -n <resourceName> -t <resourceType> [--parameters <parameters>] [--extensionResourceName <extensionResourceName>] [--extensionResourceType <extensionResourceType>] [--oDataQuery <oDataQuery>] [-g <resourceGroupName>] [-f] [--apiVersion <apiVersion>] [--pre]
+
+az resource action invoke -a <action> -n <resourceName> -t <resourceType> --tenantLevel [--parameters <parameters>] [--extensionResourceName <extensionResourceName>] [--extensionResourceType <extensionResourceType>] [--oDataQuery <oDataQuery>] [-f] [--apiVersion <apiVersion>] [--pre]
+
+PARAMETERS:
+
+-a (--actionName, --action)
+  [string] The name of the action to invoke.
+
+--apiVersion
+  [string] When set, indicates the version of the resource provider API to use. If not specified, the API version is automatically determined as the latest available.
+
+--extensionResourceName
+  [string] The extension resource name. e.g. to specify a database MyServer/MyDatabase.
+
+--extensionResourceType
+  [string] The extension resource type. e.g. Microsoft.Sql/Servers/Databases.
+
+-f (--force)
+  [flag] Perform this action without prompting, even if permanent changes are made.
+
+-g (--group, --resourceGroupName)
+  [string] The name of the resource group containing this resource
+
+-n (--name, --resourceName)
+  [string] The resource name. e.g. to specify a database MyServer/MyDatabase.
+
+--oDataQuery
+  [string] An OData style filter which will be appended to the request in addition to any other filters.
+
+--parameters (--object)
+  [hashtable] A hash table which represents resource properties.
+
+--pre
+  [flag] When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use.
+
+--resourceId (--id)
+  [string] The identity of this resource. Resource identity is a Uri path that uniquely identifies the resource.
+
+-t (--type, --resourceType)
+  [string] The resource type. e.g. Microsoft.Sql/Servers/Databases.
+
+--tenantLevel
+  [flag] Indicates that this is a tenant level operation.
+

src/CLU/Commands.ResourceManager.Cmdlets/Content/help/resource.create.hlp

@@ -0,0 +1,68 @@
+az resource create
+
+Create a Resource.
+
+USAGE:
+
+az resource create --properties <properties> --resourceId <resourceId> [-l <location>] [-k <kind>] [--planObject <planObject>] [--skuObject <skuObject>] [-t <tag>] [--isFullObject] [--oDataQuery <oDataQuery>] [-f] [--apiVersion <apiVersion>] [--pre]
+
+az resource create --properties <properties> -n <resourceName> -t <resourceType> [-l <location>] [-k <kind>] [--planObject <planObject>] [--skuObject <skuObject>] [-t <tag>] [--isFullObject] [--extensionResourceName <extensionResourceName>] [--extensionResourceType <extensionResourceType>] [--oDataQuery <oDataQuery>] [-g <resourceGroupName>] [-f] [--apiVersion <apiVersion>] [--pre]
+
+az resource create --properties <properties> -n <resourceName> -t <resourceType> --tenantLevel [-l <location>] [-k <kind>] [--planObject <planObject>] [--skuObject <skuObject>] [-t <tag>] [--isFullObject] [--extensionResourceName <extensionResourceName>] [--extensionResourceType <extensionResourceType>] [--oDataQuery <oDataQuery>] [-f] [--apiVersion <apiVersion>] [--pre]
+
+PARAMETERS:
+
+--apiVersion
+  [string] When set, indicates the version of the resource provider API to use. If not specified, the API version is automatically determined as the latest available.
+
+--extensionResourceName
+  [string] The extension resource name. e.g. to specify a database MyServer/MyDatabase.
+
+--extensionResourceType
+  [string] The extension resource type. e.g. Microsoft.Sql/Servers/Databases.
+
+-f (--force)
+  [flag] Perform this action without prompting, even if permanent changes are made.
+
+-g (--group, --resourceGroupName)
+  [string] The name of the resource group containing this resource
+
+--isFullObject
+  [flag] When set indicates that the full object is passed in to the -PropertyObject parameter.
+
+-k (--kind)
+  [string] The resource kind.
+
+-l (--location)
+  [string] The region that will contain this resource.  Possible values include 'East US', 'North Europe', 'East Asia'
+
+-n (--name, --resourceName)
+  [string] The resource name. e.g. to specify a database MyServer/MyDatabase.
+
+--oDataQuery
+  [string] An OData style filter which will be appended to the request in addition to any other filters.
+
+--planObject (--plan)
+  [hashtable] A hash table which represents resource plan properties.
+
+--pre
+  [flag] When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use.
+
+--properties (--propertyObject)
+  [psObject] A hash table which represents resource properties.
+
+--resourceId (--id)
+  [string] The identity of this resource. Resource identity is a Uri path that uniquely identifies the resource.
+
+--skuObject (--sku)
+  [hashtable] A hash table which represents sku properties.
+
+-t (--tags, --tag)
+  [hashtable[]] A hash table which represents resource tags.
+
+-t (--type, --resourceType)
+  [string] The resource type. e.g. Microsoft.Sql/Servers/Databases.
+
+--tenantLevel
+  [flag] Indicates that this is a tenant level operation.
+

src/CLU/Commands.ResourceManager.Cmdlets/Content/help/resource.find.hlp

@@ -0,0 +1,50 @@
+az resource find
+
+Find a Resource.
+
+USAGE:
+
+az resource find [-n <resourceNameContains>] [-t <resourceType>] [--extensionResourceType <extensionResourceType>] [--top <top>] [--oDataQuery <oDataQuery>] [--tagName <tagName>] [--tagValue <tagValue>] [-g <resourceGroupNameContains>] [--expandProperties] [--apiVersion <apiVersion>] [--pre]
+
+az resource find -t <resourceType> --tenantLevel [-n <resourceNameContains>] [--extensionResourceType <extensionResourceType>] [--top <top>] [--oDataQuery <oDataQuery>] [--expandProperties] [--apiVersion <apiVersion>] [--pre]
+
+az resource find -t <resourceType> [-n <resourceNameContains>] [--extensionResourceType <extensionResourceType>] [--top <top>] [--oDataQuery <oDataQuery>] [--tagName <tagName>] [--tagValue <tagValue>] [-g <resourceGroupNameContains>] [--expandProperties] [--apiVersion <apiVersion>] [--pre]
+
+PARAMETERS:
+
+--apiVersion
+  [string] When set, indicates the version of the resource provider API to use. If not specified, the API version is automatically determined as the latest available.
+
+--expandProperties
+  [flag] When specified, expands the properties of the resource.
+
+--extensionResourceType
+  [string] The extension resource type. e.g. Microsoft.Sql/Servers/{serverName}/Databases/myDatabase.
+
+-g (--resourceGroupName, --group, --resourceGroupNameContains)
+  [string] The resource group name substring.
+
+-n (--name, --resourceNameContains)
+  [string] The resource name substring. e.g. if your resource name is testResource, you can specify test.
+
+--oDataQuery
+  [string] An OData style filter which will be appended to the request in addition to any other filters.
+
+--pre
+  [flag] When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use.
+
+-t (--type, --resourceType)
+  [string] The resource type. e.g. Microsoft.Sql/Servers/Databases.
+
+--tagName
+  [string] The name of the tag to query by.
+
+--tagValue
+  [string] The value of the tag to query by.
+
+--tenantLevel
+  [flag] Indicates that this is a tenant level operation.
+
+--top
+  [int32] The number of resources to retrieve.
+

src/CLU/Commands.ResourceManager.Cmdlets/Content/help/resource.group.deployment.operation.ls.hlp

@@ -0,0 +1,25 @@
+az resource group deployment operation ls
+
+Get Resource Group Deployment Operation details.
+
+USAGE:
+
+az resource group deployment operation ls -n <deploymentName> -g <resourceGroupName> [-s <subscriptionId>] [--apiVersion <apiVersion>] [--pre]
+
+PARAMETERS:
+
+--apiVersion
+  [string] When set, indicates the version of the resource provider API to use. If not specified, the API version is automatically determined as the latest available.
+
+-g (--group, --resourceGroupName)
+  [string] The name of the resource group containing this resource
+
+-n (--name, --deploymentName)
+  [string] The deployment name.
+
+--pre
+  [flag] When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use.
+
+-s (--id, --subscriptionId)
+  [guid] The subscription identity, a global unique identifier (GUID) that uniquely identifies the subscription.
+

src/CLU/Commands.ResourceManager.Cmdlets/Content/help/resource.group.find.hlp

@@ -0,0 +1,19 @@
+az resource group find
+
+Find a Resource Group.
+
+USAGE:
+
+az resource group find [-t <tag>] [--apiVersion <apiVersion>] [--pre]
+
+PARAMETERS:
+
+--apiVersion
+  [string] When set, indicates the version of the resource provider API to use. If not specified, the API version is automatically determined as the latest available.
+
+--pre
+  [flag] When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use.
+
+-t (--tag)
+  [hashtable] The tag filter for the OData query. The expected format is @{Name = 'tagName'} or @{Name = 'tagName'; Value = 'tagValue'}.
+

src/CLU/Commands.ResourceManager.Cmdlets/Content/help/resource.lock.create.hlp

@@ -0,0 +1,58 @@
+az resource lock create
+
+Create a Resource Lock.
+
+USAGE:
+
+az resource lock create -n <lockName> --lockLevel <lockLevel> --resourceName <resourceName> -t <resourceType> [--lockNotes <lockNotes>] [-f] [--apiVersion <apiVersion>] [--pre]
+
+az resource lock create -n <lockName> --lockLevel <lockLevel> -g <resourceGroupName> [--lockNotes <lockNotes>] [-f] [--apiVersion <apiVersion>] [--pre]
+
+az resource lock create -n <lockName> --lockLevel <lockLevel> --resourceName <resourceName> -t <resourceType> -g <resourceGroupName> [--lockNotes <lockNotes>] [-f] [--apiVersion <apiVersion>] [--pre]
+
+az resource lock create -n <lockName> --lockLevel <lockLevel> --scope <scope> [--lockNotes <lockNotes>] [-f] [--apiVersion <apiVersion>] [--pre]
+
+az resource lock create -n <lockName> --lockLevel <lockLevel> [--lockNotes <lockNotes>] [-f] [--apiVersion <apiVersion>] [--pre]
+
+az resource lock create -n <lockName> --lockLevel <lockLevel> --resourceName <resourceName> -t <resourceType> --tenantLevel [--lockNotes <lockNotes>] [-f] [--apiVersion <apiVersion>] [--pre]
+
+az resource lock create --lockLevel <lockLevel> --lockId <lockId> [--lockNotes <lockNotes>] [-f] [--apiVersion <apiVersion>] [--pre]
+
+PARAMETERS:
+
+--apiVersion
+  [string] When set, indicates the version of the resource provider API to use. If not specified, the API version is automatically determined as the latest available.
+
+-f (--force)
+  [flag] Perform this action without prompting, even if permanent changes are made.
+
+-g (--group, --resourceGroupName)
+  [string] The name of the resource group containing this resource
+
+--lockId
+  [string] The Id of the lock.
+
+--lockLevel (--level)
+  [object] The level of the lock.
+
+--lockNotes (--notes)
+  [string] The notes of the lock.
+
+-n (--extensionResourceName, --name, --lockName)
+  [string] The name of the lock.
+
+--pre
+  [flag] When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use.
+
+--resourceName
+  [string] The resource name. e.g. to specify a database MyServer/MyDatabase.
+
+--scope (--id, --resourceId)
+  [string] The scope. e.g. to specify a database '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaserName}', to specify a resoruce group: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'
+
+-t (--type, --resourceType)
+  [string] The resource type. e.g. Microsoft.Sql/Servers/Databases.
+
+--tenantLevel
+  [flag] Indicates that this is a tenant level operation.
+

src/CLU/Commands.ResourceManager.Cmdlets/Content/help/resource.lock.ls.hlp

@@ -0,0 +1,54 @@
+az resource lock ls
+
+Get Resource Lock details.
+
+USAGE:
+
+az resource lock ls [--atScope] [--apiVersion <apiVersion>] [--pre]
+
+az resource lock ls -g <resourceGroupName> [-n <lockName>] [--atScope] [--apiVersion <apiVersion>] [--pre]
+
+az resource lock ls --resourceName <resourceName> -t <resourceType> -g <resourceGroupName> [-n <lockName>] [--atScope] [--apiVersion <apiVersion>] [--pre]
+
+az resource lock ls --scope <scope> [-n <lockName>] [--atScope] [--apiVersion <apiVersion>] [--pre]
+
+az resource lock ls [-n <lockName>] [--atScope] [--apiVersion <apiVersion>] [--pre]
+
+az resource lock ls --resourceName <resourceName> -t <resourceType> [-n <lockName>] [--atScope] [--apiVersion <apiVersion>] [--pre]
+
+az resource lock ls --resourceName <resourceName> -t <resourceType> --tenantLevel [-n <lockName>] [--atScope] [--apiVersion <apiVersion>] [--pre]
+
+az resource lock ls --lockId <lockId> [--atScope] [--apiVersion <apiVersion>] [--pre]
+
+PARAMETERS:
+
+--apiVersion
+  [string] When set, indicates the version of the resource provider API to use. If not specified, the API version is automatically determined as the latest available.
+
+--atScope
+  [flag] When specified returns all locks at or above the specified scope, otherwise returns all locks at, above or below the scope.
+
+-g (--group, --resourceGroupName)
+  [string] The name of the resource group containing this resource
+
+--lockId
+  [string] The Id of the lock.
+
+-n (--extensionResourceName, --name, --lockName)
+  [string] The name of the lock.
+
+--pre
+  [flag] When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use.
+
+--resourceName
+  [string] The resource name. e.g. to specify a database MyServer/MyDatabase.
+
+--scope (--id, --resourceId)
+  [string] The scope. e.g. to specify a database '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaserName}', to specify a resoruce group: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'
+
+-t (--type, --resourceType)
+  [string] The resource type. e.g. Microsoft.Sql/Servers/Databases.
+
+--tenantLevel
+  [flag] Indicates that this is a tenant level operation.
+

src/CLU/Commands.ResourceManager.Cmdlets/Content/help/resource.lock.rm.hlp

@@ -0,0 +1,54 @@
+az resource lock rm
+
+Remove a Resource Lock.
+
+USAGE:
+
+az resource lock rm [-f] [--apiVersion <apiVersion>] [--pre]
+
+az resource lock rm -n <lockName> -g <resourceGroupName> [-f] [--apiVersion <apiVersion>] [--pre]
+
+az resource lock rm -n <lockName> --resourceName <resourceName> -t <resourceType> -g <resourceGroupName> [-f] [--apiVersion <apiVersion>] [--pre]
+
+az resource lock rm -n <lockName> --scope <scope> [-f] [--apiVersion <apiVersion>] [--pre]
+
+az resource lock rm -n <lockName> [-f] [--apiVersion <apiVersion>] [--pre]
+
+az resource lock rm -n <lockName> --resourceName <resourceName> -t <resourceType> [-f] [--apiVersion <apiVersion>] [--pre]
+
+az resource lock rm -n <lockName> --resourceName <resourceName> -t <resourceType> --tenantLevel [-f] [--apiVersion <apiVersion>] [--pre]
+
+az resource lock rm --lockId <lockId> [-f] [--apiVersion <apiVersion>] [--pre]
+
+PARAMETERS:
+
+--apiVersion
+  [string] When set, indicates the version of the resource provider API to use. If not specified, the API version is automatically determined as the latest available.
+
+-f (--force)
+  [flag] Perform this action without prompting, even if permanent changes are made.
+
+-g (--group, --resourceGroupName)
+  [string] The name of the resource group containing this resource
+
+--lockId
+  [string] The Id of the lock.
+
+-n (--extensionResourceName, --name, --lockName)
+  [string] The name of the lock.
+
+--pre
+  [flag] When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use.
+
+--resourceName
+  [string] The resource name. e.g. to specify a database MyServer/MyDatabase.
+
+--scope (--id, --resourceId)
+  [string] The scope. e.g. to specify a database '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaserName}', to specify a resoruce group: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'
+
+-t (--type, --resourceType)
+  [string] The resource type. e.g. Microsoft.Sql/Servers/Databases.
+
+--tenantLevel
+  [flag] Indicates that this is a tenant level operation.
+