Parâmetros do PowerShell: sintaxe, tipos, atributos, argumentos e exemplos

15 de junho de 2021 16760 Visualizações Parâmetros do PowerShell: sintaxe, tipos, atributos, argumentos e exemplos

Os desenvolvedores de script do PowerShell usam o bloco Powershell Param para adicionar parâmetros a funções avançadas. Qualquer pessoa executando a função pode acessar os parâmetros adicionados com o PowerShell Param.





Além disso, além dos parâmetros adicionados a uma função com o bloco Param, o Windows PowerShell adiciona automaticamente Common Parameters .



Este guia abrange a sintaxe do Powershell Param, tipos de parâmetros do Powershell, seus atributos e argumentos. Ele também fornece alguns exemplos de como usar o bloco Param para adicionar parâmetros a um script ou função.

Procurar tópicos de postagem



Sintaxe de um bloco de parâmetros do PowerShell

Sintaxe de um bloco de parâmetros do PowerShell

A sintaxe do PowerShell Param é…



|_+_|

Para adicionar um parâmetro a uma função , comece com a palavra Param , seguido pelo bloco de parâmetros, (). Aqui está uma forma simples de um bloco de parâmetros…

|_+_| O CmdletBinding atributo é opcional e é o único atributo definido fora do bloco param. Mais sobre isso mais adiante no guia

Dentro do bloco Param – param() – você definirá os atributos do parâmetro e seus argumentos. Além disso, um atributo de parâmetro é incluído em um bloco [()].



No código de sintaxe acima, coloquei todos os argumentos de parâmetro em negrito. Existem muito mais argumentos de parâmetro – os da sintaxe são apenas para fins de ilustração e não são de forma alguma exaustivos.

Dentro do bloco de parâmetros, você definirá os argumentos dos parâmetros, separados por vírgulas. Um exemplo de um atributo PowerShell Param é o parâmetro atributo.



Além disso, um exemplo de um argumento param é o obrigatoriedade argumento. Outro exemplo de um argumento param é Nome do conjunto de parâmetros .

Por fim, você definirá o nome do parâmetro. Além disso, você também especificará o tipo de dados do parâmetro.

Na próxima seção, discutirei os tipos comuns de parâmetros do PowerShell. Em seguida, a seção três abrange atributos de parâmetros comuns e seus argumentos.

Finalmente, na última seção deste guia, darei um exemplo SysAdmin da vida real de um PowerShell Param. A seção também dará exemplos de como usar o bloco param em uma função avançada.

Tipos de parâmetros do PowerShell

Tipos de parâmetro de parâmetro do PowerShell

Os tipos mais comuns de parâmetros que você pode definir são corda ou chave parâmetros. Além disso, você também pode definir int , bool , Data hora ou tipos de parâmetro char.

Nesta seção, explicarei alguns desses tipos de parâmetros. Também darei alguns exemplos de como defini-los em um bloco de parâmetros.

Parâmetro do PowerShell Corda Parâmetro

Ao criar parâmetros do PowerShell, é provável que você crie um corda parâmetro. UMA corda parâmetro aceita qualquer valor de string.

No Windows PowerShell, uma string pode ser números, palavras ou caracteres. Especificamente, qualquer coisa que você declarar entre aspas duplas ou simples é uma string.

No PowerShell, o tipo de objeto de uma string é System.String .

Para declarar um parâmetro do PowerShell como um parâmetro de string, antes do nome do parâmetro, coloque a palavra corda em suportes. Aqui está um exemplo…

|_+_|

Parâmetro do PowerShell int Parâmetro

Um int tipo de dados é um inteiro com sinal de 32 bits. Em inglês, um int é um número, por exemplo 1, 2 ou 3.

Ao contrário de um corda tipo de dados de parâmetro que pode receber qualquer tipo de dados, um int parâmetro é muito prescritivo.

Se você definir um int parâmetro, o parâmetro só pode aceitar números. Além disso, se você inserir palavras como o valor para o int parâmetro, o PowerShell lançará uma mensagem de erro.

Antes de mostrar como definir um parâmetro do PowerShell int parâmetro, aqui está um exemplo geral de como definir um tipo de dados int…

|_+_|

Se eu executar o código no PowerShell, ele retornará 123 .

Parâmetro do PowerShell Param int

Pelo contrário, se eu substituir, 123 por isso é um int, o PowerShell lançará uma mensagem de erro.

|_+_|

Agora que você teve um int curso intensivo de tipo de dados, para criar um PowerShell Param int parâmetro chamado número, aqui está o código…

|_+_|

Isso forçará os usuários de seu script ou função a fornecer o tipo de dados correto.

Parâmetro do PowerShell Data hora Parâmetro

Como um int parâmetro, um Data hora parâmetro também é muito prescritivo do tipo de entrada que aceita. Como o nome indica, o Data hora parâmetro só aceitará entradas de formato Data e Hora.

Se você quiser definir um parâmetro do PowerShell que aceite apenas datas, use o código de exemplo abaixo…

|_+_|

Neste exemplo, Digite Data é o nome do parâmetro. Adicionalmente, Data hora define o tipo de dados.

Parâmetro do PowerShell Chave Parâmetro

Nas primeiras três subseções desta seção, discuti os tipos de parâmetro do PowerShell que exigem entrada de um usuário.

No entanto, há um tipo de parâmetro do PowerShell que não requer entrada de um usuário. Ao contrário dos outros tipos de parâmetros, um chave parâmetro não requer entrada do usuário.

A maneira como você define um chave parâmetro é semelhante à forma como você define outros tipos de parâmetros. No entanto, no lugar de chave , int , ou data hora , use a palavra chave .

Por exemplo, para definir um parâmetro do PowerShell Chave parâmetro, Exportar CSV , use o código abaixo…

|_+_|

Finalmente, para esta seção, você pode estar se perguntando sobre a aplicação de chave parâmetros. Pense em um script ou função do PowerShell que possa exibir resultados no console do Powershell.

Você também pode dar ao usuário a opção de exportar o resultado para um arquivo de texto ou um arquivo CSV.

Uma maneira de codificar a função é criar 3 parâmetros de switch. Um usuário pode então selecionar um dos parâmetros, dependendo de como deseja que a função entregue o resultado.

Este tipo de parâmetro não requer que o usuário insira uma entrada. Simplesmente selecionando o parâmetro, a função exibirá a saída de acordo.

Você também pode definir outros parâmetros do PowerShell com tipos de dados específicos. Para saber mais sobre os tipos de dados do PowerShell, visite este link – Como definir tipos de dados do PowerShell .

Atributos e argumentos do parâmetro de parâmetro do PowerShell

Atributos e argumentos do parâmetro de parâmetro do PowerShell

Na sintaxe de parâmetro do PowerShell deste guia, sugeri que um parâmetro do PowerShell tem atributos. Além disso, também apontei que cada atributo de parâmetro também possui argumentos.

Nesta seção, discutirei atributos de parâmetro e seus argumentos.

Para explicar os atributos de parâmetro e seus argumentos, farei referência à sintaxe do parâmetro do PowerShell apresentada na primeira seção deste guia.

|_+_|

Parâmetro do PowerShell CmdletBinding Atributo

O CmdletBinding O atributo geralmente é especificado antes do bloco param. Quando você define o CmdletBinding atributo, o PowerShell reconhecerá o script como uma função avançada.

Na seção de sintaxe deste guia, usei esse código como uma versão simplificada de um bloco de parâmetros.

|_+_|

Nesta seção, vou me concentrar na CmdletBinding Atributo parte do código. Aqui está como definir o Atributo

|_+_|

Nas próximas 3 subseções, discutirei alguns dos argumentos comuns, que você pode definir no CmdletBinding atributo.

Para evitar dúvidas, você deve definir todos os Argumentos dentro do bloco () do Atributo . Além disso, você DEVE separar todos os atributos por uma vírgula (,), exceto o último Argumentos dentro do Atributo .

Parâmetro do PowerShell DefaultParameterSetName Argumento

Quando você desenvolve uma função do PowerShell, ela pode conter vários parâmetros que um usuário pode usar no mesmo comando. Além disso, a mesma função do PowerShell pode conter outro conjunto de parâmetros que um usuário pode usar em outro comando.

No entanto, o usuário não pode misturar os parâmetros do primeiro conjunto com os parâmetros do segundo conjunto.

Além disso, um desenvolvedor de função define todos os parâmetros que um usuário pode usar no mesmo comando com o Nome do conjunto de parâmetros argumento. O Nome do conjunto de parâmetros argumento é definido dentro do atributo Parameter (mais sobre isso na próxima seção).

A implicação de ter diferentes conjuntos de parâmetros agrupados é que você terá diferentes Nome do conjunto de parâmetros s.

Com diferentes Nome do conjunto de parâmetros s desafiado em seu bloco de parâmetros, você pode decidir definir um dos Nome do conjunto de parâmetros s como padrão. É aqui que você usa o DefaultParameterSetName Argumento.

O DefaultParameterSetName O argumento é definido dentro do CmdletBinding bloco de atributo. Aqui está um exemplo…

|_+_|

Por fim, para manter nosso formato de bloco de parâmetro do PowerShell, reintroduzirei o bloco de parâmetro abaixo…

|_+_|

Parâmetro do PowerShell SuportaDeve Processar Argumento

Este é outro argumento que você pode definir no CmdletBinding Atributo . Como o DefaultParameterSetName Argumento, o SuportaDeve Processar O argumento é opcional.

O SuportaDeve Processar O argumento adiciona o confirme e E se parâmetros comuns à função.

Para adicionar este argumento, adicione uma vírgula (,) ao final do DefaultParameterSetName argumento. Em seguida, adicione a linha - SuportaDeve Processar =$verdadeiro ou $falso.

Com este novo argumento incluído, o CmdletBinding Atributo agora vai ficar assim...

|_+_|

Parâmetro do PowerShell AjudaURI Argumento

Se você estiver familiarizado com o PowerShell Obter ajuda Cmdlet, você pode ter encontrado seu Conectados parâmetro. Quando você corre Obter ajuda com o Conectados parâmetro, o PowerShell abre a página de ajuda online do Cmdlet.

Por exemplo, para abrir a página de ajuda online do cmdlet Out-File, execute o comando abaixo…

|_+_|

A página aberta por este comando é definida em uma função pelo AjudaURI Argumento. Portanto, se você deseja que os usuários acessem a página de ajuda online de sua função, defina o AjudaURI Argumento.

Aqui está um exemplo…

|_+_|

Vou agora incluir este último argumento no CmdletBinding Atributo . Segue o código atualizado…

|_+_|

Parâmetro do PowerShell Parâmetro Atributo

No parâmetro PowerShell CmdletBinding Subseção de atributos, discuti 3 argumentos que você pode incluir no CmdletBinding Bloco de atributo.

Como você viu, o CmdletBinding O bloco de atributos é o único atributo definido fora do bloco param.

avast usando 25 cpu

Nesta subseção, você aprenderá sobre o atributo Parameter. Além disso, você também aprenderá sobre os Argumentos comuns que você pode adicionar a este Atributo.

Como você pode ter deduzido dos exemplos já usados ​​neste guia, o Parameter Attribute define argumentos que controlam o comportamento de um parâmetro de parâmetro do PowerShell.

Você pode definir o atributo Parameter colocando a palavra Parameter, seguida por colchetes () em um bloco []. Aqui está um exemplo…

|_+_|

Seguindo em frente, você DEVE definir todos os argumentos do Parameter Attribute dentro do bloco ().

Nas subseções a seguir da seção Atributo de parâmetro de parâmetro do PowerShell, apresentarei e explicarei os argumentos comuns que você pode definir no atributo de parâmetro.

Parâmetro do PowerShell Nome do conjunto de parâmetros Argumento

quando eu explicar DefaultParameterSetName anteriormente neste guia, apresentei Nome do conjunto de parâmetros Argumento. Você pode usar esse argumento para parâmetros de lote ou grupo que um usuário pode executar no mesmo comando.

Por exemplo, para definir um Nome do conjunto de parâmetros chamado ParameterSetName1 , insira o código abaixo no bloco Parameter Attribute().

|_+_|

Quando eu introduzir este código atualizado, o bloco de parâmetros do meu código de exemplo agora terá esta aparência.

|_+_|

Se eu trouxer de volta o CmdletBinding atributo, meu código de parâmetro do PowerShell de exemplo agora será assim…

|_+_|

Parâmetro do PowerShell Obrigatoriedade Argumento

Você pode usar o Obrigatoriedade argumento para definir se um parâmetro é obrigatório ou opcional. O Obrigatoriedade O argumento aceita um valor $true ou $false – $true significa exigir, $false, não obrigatório.

Além disso, o Obrigatoriedade argumento é opcional. No entanto, se este argumento não for definido, o parâmetro será tratado como opcional.

Para definir o Obrigatoriedade Argumento, adicione o código abaixo ao bloco Parameter Attribute…

|_+_|

Finalmente, se eu incluir o Obrigatoriedade Código de argumento para meu código de parâmetro do PowerShell, agora terei…

|_+_|

Parâmetro do PowerShell Posição Argumento

O Posição Argumento do Atributo de Parâmetro define a posição do parâmetro. O valor é um número inteiro, começando em 0 (zero).

O benefício do Posição O argumento é para permitir que os usuários executem a função usando a posição dos parâmetros. Especificamente, quando você define o Posição Argumento, um usuário pode inserir valores para cada parâmetro na linha de comando sem especificar o parâmetro.

O PowerShell atribuirá cada valor na linha de comando de acordo com a posição do parâmetro.

Por exemplo, o Get-ChildItem O cmdlet tem um parâmetro chamado Caminho (com posição 0). O Cmdlet também tem outro parâmetro, Filtro (com a posição 1).

Por padrão, se eu executar o Get-ChildItem comando, eu tenho que incluir os nomes dos parâmetros antes de adicionar seus valores. Veja o comando abaixo…

|_+_|

Nesse comando, chamei os parâmetros e especifiquei seus valores.

Argumento de posição de parâmetro do PowerShell

No entanto, como conheço as posições desses 2 parâmetros, posso adicionar valores em suas posições, sem chamar expressamente os parâmetros. Em seguida, modificarei meu comando conforme mostrado abaixo…

|_+_|

Obviamente, isso me poupa tempo! No entanto, se você estiver olhando para um código longo do PowerShell, isso pode causar alguma confusão.

O comando dá o mesmo resultado no PowerShell…

O PowerShell atribuirá automaticamente os valores nas posições aos parâmetros com base em seus Posição Argumento.

Seguindo em frente, aqui está como você define o Posição Argumento…

|_+_| Neste exemplo, a posição do meu parâmetro é 0 (zero). Quando eu definir meu próximo parâmetro, ele estará na posição 1 e assim por diante. Você não pode ter dois parâmetros na mesma posição. Mais adiante no guia, você aprenderá como adicionar um parâmetro na mesma posição, mas com ParameterSetNames diferentes.

Agora vou adicionar este argumento ao meu código de exemplo…

|_+_|

Parâmetro do PowerShell Valor do pipeline Argumento

Outro aumento de parâmetro comumente usado é o Valor do pipeline Argumento. Como o nome indica, esse argumento determina se um parâmetro aceita valores do pipeline.

Ela é como você define esse argumento…

|_+_|

Se eu adicionar este novo argumento ao meu código, ficará assim…

|_+_|

Há outro argumento chamado ValueFromPipelineByPropertyName . Para ler sobre esse argumento, visite about_Functions_Advanced_Parameters .

Parâmetro do PowerShell Mensagem de Ajuda Argumento

Você pode usar esse argumento para especificar a mensagem para mostrar aos usuários como usar um parâmetro. Para definir um Mensagem de Ajuda Argumento para um parâmetro, use um código semelhante ao abaixo…

|_+_|

E aqui está agora meu código atualizado…

|_+_|

Até agora nesta seção, discuti 2 atributos de parâmetro do PowerShell – CmdletBinding e Parâmetro . Além disso, também discuti os argumentos comuns que você pode definir para esses atributos.

Nas 3 subseções restantes desta seção, ensinarei 3 atributos de parâmetro do PowerShell mais usados. No entanto, esses 3 atributos não exigem que você defina argumentos.

Parâmetro do PowerShell Alias Atributo

O atributo alias é usado para especificar os aliases de um parâmetro. Como você deve ter adivinhado, o alias de um parâmetro do PowerShell pode ser usado em vez do parâmetro.

Antes de mostrar como definir o atributo alias para um parâmetro, deixe-me mostrar primeiro como encontrar aliases de todos os cmdlets e funções em seu computador.

Para listar todos os aliases de Cmdlets e Funções, execute o comando abaixo

|_+_|

Isso listará todos os aliases…

Atributo de alias de parâmetro do PowerShell

Passando para Alias Atributo, para definir um para um parâmetro de parâmetro do PowerShell, use um código semelhante ao abaixo…

|_+_| Neste exemplo, FP é o alias para o parâmetro.

Se eu adicionar isso ao meu código, a versão atualizada ficará assim…

|_+_|

Parâmetro do PowerShell Suporta Curingas Atributo

Esse atributo de parâmetro de parâmetro determina se um parâmetro aceita curingas. Aqui está como você define esse atributo…

|_+_|

Parâmetro do PowerShell ValidateNotNullOrEmpty Atributo de validação

Como a maioria dos atributos já abordados neste guia, o nome desse atributo também o revela. É um atributo de validação.

Ao definir este atributo, o parâmetro NÃO aceitará um valor nulo ($null). Além disso, ele não aceitará um valor vazio ().

Se um usuário inserir $null ou , a função gerará um erro. Para definir este atributo, digite o código abaixo…

|_+_|

Por fim, atualizarei meu código com os 2 últimos atributos…

|_+_|

Nome do parâmetro de parâmetro do PowerShell

Depois de definir todos os atributos e argumentos de um parâmetro, você precisa adicionar o nome do parâmetro. Um parâmetro de parâmetro do PowerShell é definido como uma variável – com um cifrão ($), seguido pelo nome do parâmetro.

Você também pode, opcionalmente, inserir um tipo de dados para o parâmetro. Na seção 2 deste guia, discuti diferentes tipos de parâmetros do PowerShell.

Aqui está como você define um parâmetro que pode aceitar corda tipo de dados.

|_+_|

Aqui está meu exemplo de código atualizado…

|_+_|

Como definir um parâmetro do PowerShell em vários conjuntos de parâmetros

Como definir um parâmetro do PowerShell em vários conjuntos de parâmetros

Se você é novo na codificação de funções do PowerShell, é provável que caia na tentação de definir um parâmetro várias vezes.

Uma razão pela qual você pode querer ter um parâmetro várias vezes é quando um parâmetro é usado em vários ParameterSetNames (vários conjuntos de parâmetros).

Para levar isso para casa, digamos que você esteja desenvolvendo uma função do PowerShell que tenha um Caminho parâmetro. No entanto, você tem 2 ParameterSetNames que exigem o parâmetro Path.

A maioria das pessoas novas no script do PowerShell provavelmente definirá os parâmetros mostrados abaixo…

|_+_|

Se você definir os parâmetros, conforme mostrado acima, receberá uma mensagem de erro. Para testar essa teoria, copiarei o código para o PowerShell ISE .

Como definir um parâmetro do PowerShell em vários conjuntos de parâmetros

Então, como você conserta isso? A solução é definir os 2 atributos de parâmetro e seus argumentos – incluindo seus ParameterSetNames.

Em seguida, no final de ambos os atributos de parâmetro, defina um único nome de parâmetro que seja comum a ambos os atributos de parâmetro. No exemplo anterior, removerei o nome do primeiro parâmetro e deixarei o último.

|_+_|

Agora, se eu copiar este código para o PowerShell ISE, tudo ficará bem.

Neste exemplo, observe que os argumentos de parâmetro para ambos os atributos de parâmetro podem ser completamente diferentes. Além disso, você pode definir quantos atributos de parâmetro desejar.

Exemplos de parâmetros do PowerShell

Exemplos de parâmetros do PowerShell

Nesta última seção do guia, darei um exemplo de parâmetro SysAdmin PowerShell da vida real.

Enquanto escrevia este guia, comecei a desenvolver um script/função do PowerShell para obter o tamanho da pasta e a contagem de arquivos. Aqui está a parte param da função…

|_+_|

Nas próximas subseções desta seção, explicarei os diferentes elementos do parâmetro. Finalmente, a última seção apresenta um bloco funcional e adiciona o bloco param à função.

Para facilitar o acompanhamento das linhas no código referenciado nas próximas subseções, baixe PowerShellParamExample.zip . Em seguida, descompacte o arquivo e abra o arquivo .ps1 no PowerShell ISE .

ParameterSetName Exemplo de parâmetro do PowerShell

Meu código de exemplo de parâmetro do PowerShell tem três ParameterSetNames – Mostrar resultado , Export Txt e Exportar CSV . Usei esses nomes para facilitar a identificação do que eles fazem.

Na introdução desta seção, mencionei que a função que estou construindo com este código de parâmetro exibirá o tamanho da pasta e a contagem de arquivos para cada subpasta em uma pasta especificada.

Portanto, os três ParameterSetNames oferecem ao usuário a opção de exibir resultados no console do PowerShell. Alternativamente, um usuário tem a opção de exportar o resultado para um arquivo de texto ou um arquivo CSV.

Além disso, cada Nome do conjunto de parâmetros defina todos os parâmetros que um usuário pode chamar em um único comando. Com base nessa ideia, a função que estou construindo terá três opções de comandos ou sintaxes.

Vou expandir essa ideia nas subseções e exemplos subsequentes.

CmdletBinding Atributo E DefaultParameterSetName Exemplos de argumentos

Nas seções anteriores deste guia, você se deparou com o CmdletBinding Atributo. Além disso, você também se deparou com um de seus argumentos – DefaultParameterSetName .

O DefaultParameterSetName O argumento é usado para definir o conjunto de parâmetros padrão que uma função chama. Neste exemplo, o nome do conjunto de parâmetros padrão é Mostrar resultado .

O DefaultParameterSetName é declarado na linha 1 do código.

O PowerShell tentará usar o conjunto de parâmetros declarado pelo DefaultParameterSetName se não puder determinar qual conjunto de parâmetros usar. No entanto, se você definir parâmetros obrigatórios, poderá evitar esse problema.

De qualquer forma, não há problema em declarar um nome de conjunto de parâmetros padrão.

Caminho da pasta Exemplo de parâmetro de string

Isto é onde a diversão começa! O Caminho da pasta parâmetro é usado para inserir o caminho da pasta, a função obterá o tamanho de suas subpastas - e contará o número de arquivos em cada subpasta.

Este é um parâmetro de string. O que significa que ele aceita qualquer string como entrada.

Uma característica interessante do Caminho da pasta parâmetro é que é comum aos 3 nomes de conjuntos de parâmetros. Anteriormente neste artigo, expliquei o desafio que os novos desenvolvedores de script do PowerShell podem enfrentar com essa situação.

Para declarar o Caminho da pasta parâmetro nos três nomes do conjunto de parâmetros, criei três atributos de parâmetro.

O primeiro atributo de parâmetro está entre as linhas 5 e 11. Além disso, esse primeiro atributo de parâmetro tem vários argumentos.

No entanto, gostaria que prestasse especial atenção ao Nome do conjunto de parâmetros argumento - Mostrar resultado .

Exemplo de parâmetro de string FolderPath

Em segundo lugar, entre as linhas 12 e 18, declarei outro atributo de parâmetro com um Nome do conjunto de parâmetros argumento chamado Export Txt .

Finalmente, entre as linhas 19 e 25, declarei um terceiro atributo de parâmetro com um Nome do conjunto de parâmetros argumento chamado Exportar CSV .

Exemplo de parâmetro de string FolderPath

Além disso, se você notar, diferentemente de declarar 3 atributos de parâmetro, eu declarei um único Alias , e ValidateNotNullOrEmpty atributos. Esses atributos podem ser encontrados nas linhas 26 e 27.

Exemplo de parâmetro de string FolderPath

Por fim, logo abaixo de todos os atributos e seus argumentos, incluí o nome do parâmetro – Caminho da pasta . O nome do parâmetro está na linha 28.

Exemplo de parâmetro de string FolderPathNa última subseção desta seção, você verá como a função exibe este parâmetro em 3 sintaxes de comando.

Mostrar resultado , Export Txt E Exportar CSV Exemplo de parâmetro de comutação

A partir da linha 29 do código de parâmetro, declarei outro conjunto de atributos de parâmetro e seus argumentos.

Primeiramente, entre as linhas 29 e 37, declaro os atributos e argumentos do parâmetro para o Mostrar resultado parâmetro.

Então, entre as linhas 38 e 47, declaro outro parâmetro chamado Export Txt .

Exemplo de parâmetro de alternância DisplayResult, ExportTxt e ExportCSV

Finalmente, entre as linhas 48 e 57, declarei a Exportar CSV parâmetro.

Os 3 parâmetros que descrevi nesta seção são todos Chave parâmetros. Como você já sabe, isso significa que os parâmetros não requerem nenhuma entrada do usuário.

Quando um usuário seleciona qualquer um dos parâmetros, a função altera a maneira como exibe os resultados.

limpar partição de cache lg v10

Como usar o parâmetro do PowerShell em uma função do PowerShell

Nesta subseção, quero apresentar o bloco de funções do PowerShell em meu código de exemplo.

A sintaxe de um bloco de funções do PowerShell é…

|_+_|

Para o exemplo final deste guia, substituirei o bloco de parâmetro do PowerShell na sintaxe da função pelo meu código de parâmetro da última subseção. Além disso, substituirei a função por Get-FolderSizeFileCount , o nome da função.

A função final agora ficará assim…

|_+_| Para este exemplo, os blocos Begin {}, Process {} e End {} estão vazios.

Testando meus parâmetros do PowerShell na função do PowerShell

Nesta seção final, testarei os parâmetros na função que criei na última seção.

Se você gosta de testar você mesmo, pode baixar o código clicando neste link – Get-FolderSizeFileCount.zip . Em seguida, descompacte o arquivo zip.

Depois de descompactar o arquivo, abra o PowerShell e execute o comando abaixo:

|_+_| Altere para o caminho completo para o arquivo descompactado.

Ao executar o comando, você receberá uma mensagem de aviso. No prompt de mensagem, digite R e pressione a tecla Enter em seu teclado.

Testando meus parâmetros do PowerShell na função do PowerShell

Depois que o módulo for importado, no mesmo console do PowerShell, execute o comando abaixo:

|_+_|

Aqui está o resultado do comando…

O que eu quero mostrar é a seção SYNTAX da página de ajuda do meu Function. Na captura de tela acima, você pode executar o comando Get-FolderSizeFileCount em 3 comandos diferentes:

|_+_|

A primeira coisa a notar é que as três sintaxes têm a Caminho da pasta parâmetro de string. Se você ler este guia, você saberá o porquê.

Além disso, você notará que a primeira sintaxe tem a Mostrar resultado parâmetro de comutação também. Finalmente, na segunda e terceira sintaxes, você tem a Exportar CSV , e Export Txt parâmetro de comutação respectivamente.

Em adição a Caminho da pasta , e Exportar CSV parâmetros e Export Txt parâmetros na segunda e terceira sintaxes, respectivamente, eles também têm a ReportPath parâmetro de string. Eu não mencionei este parâmetro porque o código de declaração é semelhante ao Caminho da pasta código, com algumas pequenas diferenças. O ReportPath é usado para especificar o caminho em que a função salvará os relatórios de texto e arquivo CSV.

É isso – um guia completo sobre os parâmetros do PowerShell! Espero que tenha achado útil?

Se você achou útil, por favor, vote sim para a pergunta Foi este post útil abaixo.

Alternativamente, você pode fazer uma pergunta, deixar um comentário ou fornecer mais feedback com o formulário Deixe uma resposta encontrado no final desta página.

Por fim, para obter mais zonas S de tecnologia do PowerShell, visite nossa página de guia de instruções do Windows PowerShell. Você também pode achar nossa página Work from Home muito útil.

Referências e Leituras Adicionais

  1. Como definir tipos de dados do PowerShell
  2. about_Functions_Advanced_Parameters
  3. about_Functions_CmdletBindingAttribute