Add-Member

Sintaxe

Add-Member
   -InputObject <PSObject>
   -TypeName <String>
   [-PassThru]
   [<CommonParameters>]

Add-Member
   -InputObject <PSObject>
   [-TypeName <String>]
   [-Force]
   [-PassThru]
   [-NotePropertyMembers] <IDictionary>
   [<CommonParameters>]

Add-Member
   -InputObject <PSObject>
   [-TypeName <String>]
   [-Force]
   [-PassThru]
   [-NotePropertyName] <String>
   [-NotePropertyValue] <Object>
   [<CommonParameters>]

Add-Member
   -InputObject <PSObject>
   [-MemberType] <PSMemberTypes>
   [-Name] <String>
   [[-Value] <Object>]
   [[-SecondValue] <Object>]
   [-TypeName <String>]
   [-Force]
   [-PassThru]
   [<CommonParameters>]

Description

O Add-Member cmdlet permite adicionar membros (propriedades e métodos) a uma instância de um objeto do PowerShell. Por exemplo, você pode adicionar um membro NoteProperty que contém uma descrição do objeto ou um membro ScriptMethod que executa um script para alterar o objeto.

Para usar Add-Member, canalize o objeto para Add-Member, ou use o parâmetro InputObject para especificar o objeto.

O parâmetro MemberType indica o tipo de membro que você deseja adicionar. O parâmetro Name atribui um nome ao novo membro e o parâmetro Value define o valor do membro.

As propriedades e métodos que você adiciona são adicionados somente à instância específica do objeto que você especificar. Add-Member não altera o tipo de objeto. Para criar um novo tipo de objeto, use o Add-Type cmdlet.

Você também pode usar o Export-Clixml cmdlet para salvar a instância do objeto, incluindo os membros adicionais, em um arquivo. Em seguida, você pode usar o Import-Clixml cmdlet para recriar a instância do objeto a partir das informações armazenadas no arquivo exportado.

A partir do Windows PowerShell 3.0, Add-Member tem novos recursos que facilitam a adição de propriedades de anotação a objetos. Você pode usar os parâmetros NotePropertyName e NotePropertyValue para definir uma propriedade note ou usar o parâmetro NotePropertyMembers , que usa uma tabela hash de nomes e valores de propriedade de nota.

Além disso, a partir do Windows PowerShell 3.0, o parâmetro PassThru , que gera um objeto de saída, é necessário com menos frequência. Add-Member Agora adiciona os novos membros diretamente ao objeto de entrada de mais tipos. Para obter mais informações, consulte a descrição do parâmetro PassThru .

Exemplos

Exemplo 1: Adicionar uma propriedade note a um PSObject

O exemplo a seguir adiciona uma propriedade Status note com um valor de "Done" ao objeto FileInfo que representa o Test.txt arquivo.

O primeiro comando usa o Get-ChildItem cmdlet para obter um objeto FileInfo que representa o Test.txt arquivo. Ele salva na $a variável.

O segundo comando adiciona a propriedade note ao objeto em $a.

O terceiro comando usa notação de ponto para obter o valor da propriedade Status do objeto em $a. Como mostra a saída, o valor é Done.

$A = Get-ChildItem c:\ps-test\test.txt
$A | Add-Member -NotePropertyName Status -NotePropertyValue Done
$A.Status

Done

Exemplo 2: Adicionar uma propriedade alias a um PSObject

O exemplo a seguir adiciona uma propriedade Size alias ao objeto que representa o Test.txt arquivo. A nova propriedade é um alias para a propriedade Length .

O primeiro comando usa o Get-ChildItem cmdlet para obter o Test.txt objeto FileInfo .

O segundo comando adiciona a propriedade Size alias. O terceiro comando usa notação de ponto para obter o valor da nova propriedade Size .

$A = Get-ChildItem C:\Temp\test.txt
$A | Add-Member -MemberType AliasProperty -Name Size -Value Length
$A.Size

2394

Exemplo 3: Adicionar uma propriedade de nota StringUse a uma cadeia de caracteres

Este exemplo adiciona a propriedade StringUse note a uma cadeia de caracteres. Como Add-Member não é possível adicionar tipos a objetos de entrada String , você pode especificar o parâmetro PassThru para gerar um objeto de saída. O último comando no exemplo exibe a nova propriedade.

Este exemplo usa o parâmetro NotePropertyMembers . O valor do parâmetro NotePropertyMembers é uma tabela hash. A chave é o nome da propriedade note, StringUse, e o valor é o valor da propriedade note, Display.

$A = "A string"
$A = $A | Add-Member -NotePropertyMembers @{StringUse="Display"} -PassThru
$A.StringUse

Display

Exemplo 4: Adicionar um método de script a um objeto FileInfo

Este exemplo adiciona o método de script SizeInMB a um objeto FileInfo que calcula o tamanho do arquivo para o MegaByte mais próximo. O segundo comando cria um ScriptBlock que usa o método estático Round do tipo para arredondar o tamanho do [math] arquivo para a segunda casa decimal.

O parâmetro Value também usa a $This variável automática, que representa o objeto atual. A $This variável é válida apenas em blocos de script que definem novas propriedades e métodos.

O último comando usa notação de ponto para chamar o novo método de script SizeInMB no objeto na $A variável.

$A = Get-ChildItem C:\Temp\test.txt
$S = {[math]::Round(($this.Length / 1MB), 2)}
$A | Add-Member -MemberType ScriptMethod -Name "SizeInMB" -Value $S
$A.SizeInMB()

0.43

Exemplo 5: Criar um objeto personalizado

Este exemplo cria um objeto personalizado Asset .

O New-Object cmdlet cria um PSObject que é salvo na $Asset variável. O [ordered] acelerador de tipo cria um dicionário ordenado que é armazenado na $d variável. Canalização $Asset para Add-Member adicionar os pares chave-valor no dicionário ao objeto como membros NoteProperty . O parâmetro TypeName atribui o tipo Asset ao PSObject. O Get-Member cmdlet mostra o tipo e as propriedades do objeto. No entanto, as propriedades são listadas em ordem alfabética, não na ordem em que foram adicionadas.

$Asset = New-Object -TypeName PSObject
$d = [ordered]@{Name="Server30"; System="Server Core"; PSVersion="4.0"}
$Asset | Add-Member -NotePropertyMembers $d -TypeName Asset
$Asset | Get-Member -MemberType Properties

TypeName: Asset

Name        MemberType   Definition
----        ----------   ----------
Name        NoteProperty string Name=Server30
PSVersion   NoteProperty string PSVersion=4.0
System      NoteProperty string System=Server Core

$Asset.PSObject.Properties | Format-Table Name, MemberType, TypeNameOfValue, Value

Name        MemberType TypeNameOfValue Value
----        ---------- --------------- -----
Name      NoteProperty System.String   Server30
System    NoteProperty System.String   Server Core
PSVersion NoteProperty System.String   4.0

Inspecionar a lista bruta de propriedades mostra as propriedades na ordem em que foram adicionadas ao objeto. Format-Table é usado neste exemplo para criar uma saída semelhante a Get-Member.

Exemplo 6: Adicionar um AliasProperty a um objeto

Neste exemplo, criamos um objeto personalizado que contém dois membros NoteProperty . O tipo para um NoteProperty reflete o tipo do valor armazenado na propriedade. Nesse caso, a propriedade Age é uma cadeia de caracteres.

PS> $obj = [pscustomobject]@{
      Name = 'Doris'
      Age = '20'
}
PS> $obj | Add-Member -MemberType AliasProperty -Name 'intAge' -Value age -SecondValue uint32
PS> $obj | Get-Member

   TypeName: System.Management.Automation.PSCustomObject

Name        MemberType    Definition
----        ----------    ----------
intAge      AliasProperty intAge = (System.UInt32)age
Equals      Method        bool Equals(System.Object obj)
GetHashCode Method        int GetHashCode()
GetType     Method        type GetType()
ToString    Method        string ToString()
Age         NoteProperty  string Age=20
Name        NoteProperty  string Name=Doris

PS> $obj

Name  Age intAge
----  --- ------
Doris 20      20

PS> $obj.Age + 1

201

PS> $obj.intAge + 1

21

A propriedade intAge é uma AliasProperty para a propriedade Age , mas o tipo é garantido como uint32.

Exemplo 7: Adicionar métodos get e set a um objeto personalizado

Este exemplo mostra como definir os métodos Get e set que acessam uma propriedade profundamente aninhada.

$user = [pscustomobject]@{
    Name      = 'User1'
    Age       = 29
    StartDate = [datetime]'2019-05-05'
    Position  = [pscustomobject]@{
        DepartmentName = 'IT'
        Role = 'Manager'
    }
}
$addMemberSplat = @{
    MemberType = 'ScriptProperty'
    Name = 'Title'
    Value = { $this.Position.Role }                  # getter
    SecondValue = { $this.Position.Role = $args[0] } # setter
}
$user | Add-Member @addMemberSplat
$user | Get-Member

TypeName: System.Management.Automation.PSCustomObject

Name        MemberType     Definition
----        ----------     ----------
Equals      Method         bool Equals(System.Object obj)
GetHashCode Method         int GetHashCode()
GetType     Method         type GetType()
ToString    Method         string ToString()
Age         NoteProperty   int Age=29
Name        NoteProperty   string Name=User1
Position    NoteProperty   System.Management.Automation.PSCustomObject Position=@{DepartmentName=IT; Role=Manager}
StartDate   NoteProperty   datetime StartDate=5/5/2019 12:00:00 AM
Title       ScriptProperty System.Object Title {get= $this.Position.Role ;set= $this.Position.Role = $args[0] ;}

$user.Title = 'Dev Manager'

Name      : User1
Age       : 29
StartDate : 5/5/2019 12:00:00 AM
Position  : @{DepartmentName=IT; Role=Dev Manager}
Title     : Dev Manager

Observe que a propriedade Title é um ScriptProperty que tem um método Get e set . Quando atribuímos um novo valor à propriedade Title , o método set é chamado e altera o valor da propriedade Role na propriedade Position .

Parâmetros

-Force

-InputObject

-MemberType

-Name

-NotePropertyMembers

-NotePropertyName

-NotePropertyValue

-PassThru

-SecondValue

-TypeName

-Value

Entradas

PSObject

Você pode canalizar qualquer objeto para este cmdlet.

Saídas

None

Por padrão, esse cmdlet não retorna nenhuma saída.

Object

Quando você usa o parâmetro PassThru , esse cmdlet retorna o objeto recém-estendido.

Notas

Você pode adicionar membros somente a objetos do tipo PSObject . Para determinar se um objeto é um objeto PSObject , use o -is operador . Por exemplo, para testar um objeto armazenado na $obj variável, digite $obj -is [psobject].

Os objetos do tipo PSObject mantêm sua lista de membros na ordem em que os membros foram adicionados ao objeto.

Os nomes dos parâmetros MemberType, Name, Value e SecondValue são opcionais. Se você omitir os nomes dos parâmetros, os valores de parâmetros sem nome deverão aparecer nesta ordem: MemberType, Name, Value e SecondValue.

Se você incluir os nomes dos parâmetros, os parâmetros poderão aparecer em qualquer ordem.

Você pode usar a $this variável automática em blocos de script que definem os valores de novas propriedades e métodos. A $this variável refere-se à instância do objeto ao qual as propriedades e métodos estão sendo adicionados. Para obter mais informações sobre a $this variável, consulte about_Automatic_Variables.

Ligações Relacionadas

• Export-Clixml
• Get-Member
• Import-Clixml
• New-Object
• about_Automatic_Variables
• System.Type.GetMethod()