[Tip: To detect name conflicts<\/a> in your installed modules, use Group-Object.]<\/p>\n When I run ‘Get-Command Expand-Archive,’ PowerShell gets the command that actually runs when I type ‘Expand-Archive.’ That command is determined by command precedence<\/a> and by the order in which PowerShell finds modules, which is, in turn, determined by the order of paths in the $PSModulePath environment variable. That’s complex enough on my own system, but if I’m running shared code in an arbitrary environment, I better make sure that I’m running the correct command.<\/p>\n If I wanted the Expand-Archive command in the PSCX module, I could use a module-qualified name, such as:<\/p>\n But, I need to specify both the module name and the version. That’s where the ModuleSpecification object comes in. This command gets the Expand-Archive function in the 1.0.0.0 version of Microsoft.PowerShell.Archive.<\/p>\n And, if I need to distinguish between two different modules with the same name and version (I created this conflict, but it could happen), you can add a GUID value to get the right module.<\/p>\n I can even use the invoke\/call operator (&) to run a command in a specific version of a specific module.<\/p>\n One of the most important places to use a ModuleSpecification object is the value of the #Requires -Module<\/b> parameter.<\/p>\n Also, several cmdlets and functions in PowerShell 5.0 have parameters that take a ModuleSpecification object.<\/p>\n (See Get-ParameterType.ps1<\/a> on GitHub.)<\/p>\n While Import-Module has a FullyQualifiedName parameter that takes a ModuleSpecification object, it also has version parameters that have the same effect, except for the GUID.<\/p>\n Also, several commands, including the functions in the PowerShellGet module, have version parameters, even though they don’t have parameter that takes a ModuleSpecification object.<\/p>\n Be aware that Version<\/b> and ModuleVersion<\/b> parameters often behave like MinimumVersion, not RequiredVersion. To verify for any given command, check the help.<\/p>\n You can create a ModuleSpecification object from a hash table using particular keys. PowerShell converts the hash table to the correct object type.<\/p>\n Here are the hash table keys. ModuleName is required and you must include exactly one of the version keys. GUID key is optional.<\/p>\n Select one of the following keys (required):<\/p>\n The GUID key is optional:<\/p>\n By the way, examining the Microsoft.PowerShell.Commands.ModuleSpecification class, separate from its PowerShell implementation is not very helpful.<\/p>\n For example, you can create a ModuleSpecification object with no arguments or with a Name argument, but if you do, all of the other fields are blank, because they are read-only (get, not set).<\/p>\n And, the properties don’t match the hash table key names.<\/p>\n So, forget the class and use the rules to create a hash table.<\/p>\n One word of caution. When the core commands use the ModuleSpecification object parameters, they don’t always return what you expect.<\/p>\n For example, in PowerShell 5.1.14352.1002, when you specify a minimum version, Import-Module doesn’t look for the earliest qualified version. Instead, it imports the first instance of that module that it encounters with a version greater than or equal to the minimum.<\/p>\n Also, Get-Command cannot get a command in a non-default version of a module unless that version is already imported into the current session.<\/p>\n We’ll look at these behaviors in a separate post.<\/p>\n June Blender is a technology evangelist at SAPIEN Technologies, Inc. and a Windows PowerShell MVP. You can reach her at <\/em>juneb@sapien.com <\/em><\/a>or follow her on Twitter at <\/em>@juneb_get_help<\/em><\/a>.<\/p>\n","protected":false},"excerpt":{"rendered":" With the advent of side-by-side module versions in Windows PowerShell 5.0, the lovely, but obscure ModuleSpecification object has become your new best friend. Use it to make sure that the commands and module that you use are the ones that you intend. Using ModuleSpecification Let’s start with an example. I want to get the Expand-Archive […]<\/p>\n","protected":false},"author":31,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"footnotes":""},"categories":[941,1129,25],"tags":[1134,1133,934,1130,28,961,587,1132,1131,872],"class_list":["post-12258","post","type-post","status-publish","format-standard","hentry","category-powershell-5-0","category-powershell-5-1-14352-1002","category-windows-powershell","tag-fullyqualifiedmodule","tag-fullyqualifiedname","tag-juneb","tag-modulespecification","tag-powershell","tag-powershell-5-0","tag-version","tag-versionchaos","tag-versioning","tag-versions"],"jetpack_featured_media_url":"","_links":{"self":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts\/12258","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/users\/31"}],"replies":[{"embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/comments?post=12258"}],"version-history":[{"count":16,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts\/12258\/revisions"}],"predecessor-version":[{"id":12318,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts\/12258\/revisions\/12318"}],"wp:attachment":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/media?parent=12258"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/categories?post=12258"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/tags?post=12258"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}Get-Command PSCX\\Expand-Archive<\/pre>\n
Get-Command -Name Expand-Archive `\r\n-FullyQualifiedModule @{ModuleName = 'Microsoft.PowerShell.Archive'; \r\n RequiredVersion = '1.0.0.0'}<\/pre>\nGet-Command -Name Expand-Archive `\r\n-FullyQualifiedModule @{ModuleName = 'PowerShellLogging'; \r\n RequiredVersion = '1.0.0.0'; \r\n GUID='abc0b34-02de-453a-9726-6bb7b716a63f'}<\/pre>\n$myCommand = Get-Command -Name Expand-Archive `\r\n-FullyQualifiedModule @{ModuleName = 'Microsoft.PowerShell.Archive'; \r\n RequiredVersion = '1.0.0.0'}\r\n\r\n& $myCommand -Path .\\Myzip.zip -DestinationPath .\\Unzipped<\/pre>\nWhere can I use ModuleSpecification?<\/h1>\n
#Requires -Module @{ModuleName='Pester'; ModuleVersion='3.4.0'}<\/pre>\nPS C:\\ > .\\Get-ParameterType.ps1 -ParameterType ModuleSpecification\r\n\r\nCmdletName Parameter\r\n---------- ---------\r\nExport-PSSession FullyQualifiedModule\r\nGet-Command FullyQualifiedModule\r\nGet-Module FullyQualifiedName\r\nImport-Module FullyQualifiedName\r\nImport-PSSession FullyQualifiedModule\r\nRemove-Module FullyQualifiedName\r\nSave-Help FullyQualifiedModule\r\nUpdate-Help FullyQualifiedModule<\/pre>\n
PS C:\\> (Get-Command Import-Module).ParameterSets.Parameters | where Name -like \"*Version\" | Sort Name | Select -Property Name, ParameterType -Unique\r\n\r\nName ParameterType\r\n---- -------------\r\nMaximumVersion System.String\r\nMinimumVersion System.Version\r\nRequiredVersion System.Version<\/pre>\n
Import-Module -Name Pester -RequiredVersion 3.4.0<\/pre>\n
PS C:\\> C:\\ps-test\\Get-ParameterName.ps1 -ParameterName \"*Version\"\r\n\r\nCmdletName Parameter Type\r\n---------- --------- ----\r\nFind-DscResource MinimumVersion System.Version\r\nFind-Module MinimumVersion System.Version\r\nFind-Script MinimumVersion System.Version\r\nGet-InstalledModule MinimumVersion System.Version\r\n...\r\n<\/pre>\n
Syntax of a ModuleSpecification Object<\/h1>\n
\n
\n
@{ModuleName = 'Pester'; ModuleVersion = '3.4.0'}<\/pre>\n<\/li>\n<\/ul>\n\n
@{ModuleName = 'Pester'; MaximumVersion = '3.3.10'}<\/pre>\n<\/li>\n<\/ul>\n\n
@{ModuleName = 'Pester'; RequiredVersion = '3.3.9'}<\/pre>\n<\/li>\n<\/ul>\n\n
@{ModuleName = 'Pester'; ModuleVersion = '3.4.0'; GUID='a699dea5-2c73-4616-a270-1f7abb777e71'}<\/pre>\n<\/li>\n<\/ul>\nPS C:\\> $ms = [Microsoft.PowerShell.Commands.ModuleSpecification]::New('PSScriptAnalyzer')\r\n\r\nPS C:\\> $ms | Get-Member\r\n\r\nTypeName: Microsoft.PowerShell.Commands.ModuleSpecification\r\n\r\nName MemberType Definition\r\n---- ---------- ----------\r\nEquals Method bool Equals(System.Object obj)\r\nGetHashCode Method int GetHashCode()\r\nGetType Method type GetType()\r\nToString Method string ToString()\r\nGuid Property System.Nullable[guid] Guid {get;}\r\nMaximumVersion Property string MaximumVersion {get;}\r\nName Property string Name {get;}\r\nRequiredVersion Property version RequiredVersion {get;}\r\nVersion Property version Version {get;}\r\n\r\nPS C:\\ps-test> $ms.Version = '1.0.0.0'\r\n'Version' is a ReadOnly property.\r\nAt line:1 char:1\r\n+ $ms.Version = '1.0.0.0'\r\n+ ~~~~~~~~~~~~~~~~~~~~~~~\r\n+ CategoryInfo : InvalidOperation: (:) [], RuntimeException\r\n+ FullyQualifiedErrorId : PropertyAssignmentException<\/pre>\nPS C:\\> $ms\r\n\r\nName : PSScriptAnalyzer\r\nGuid :\r\nVersion :\r\nMaximumVersion :\r\nRequiredVersion :<\/pre>\n
How does it work?<\/h1>\n
![\"image\"](\"https:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2016\/06\/image_thumb.png\" "\\"image\\"")
<\/a><\/p>\n