Parâmetros de atividade

A tabela a seguir lista os nomes e a funcionalidade recomendados para parâmetros de atividade.

Parâmetro Funcionalidade
Append
Tipo de dados: SwitchParameter		 Implemente esse parâmetro para que o usuário possa adicionar conteúdo ao final de um recurso quando o parâmetro for especificado.
sensível a maiúsculas e minúsculas
Tipo de dados: SwitchParameter		 Implemente esse parâmetro para que o usuário possa exigir diferenciação de maiúsculas e minúsculas quando o parâmetro for especificado.
Command
Tipo de dados: String		 Implemente esse parâmetro para que o usuário possa especificar uma cadeia de caracteres de comando a ser executada.
CompatibleVersion
Tipo de dados: System.Version objeto		 Implemente esse parâmetro para que o usuário possa especificar a semântica com a qual o cmdlet deve ser compatível para compatibilidade com versões anteriores.
Compress
Tipo de dados: SwitchParameter		 Implemente esse parâmetro para que a compactação de dados seja usada quando o parâmetro for especificado.
Nível de compressão
Tipo de dados: Keyword		 Implemente esse parâmetro para que o usuário possa especificar o algoritmo a ser usado para compactação de dados.
Continuous
Tipo de dados: SwitchParameter		 Implemente esse parâmetro para que os dados sejam processados até que o usuário encerre o cmdlet quando o parâmetro for especificado. Se o parâmetro não for especificado, o cmdlet processará uma quantidade predefinida de dados e, em seguida, encerrará a operação.
Create
Tipo de dados: SwitchParameter		 Implemente esse parâmetro para indicar que um recurso é criado se ainda não existir quando o parâmetro for especificado.
Delete
Tipo de dados: SwitchParameter		 Implemente esse parâmetro para que os recursos sejam excluídos quando o cmdlet tiver concluído sua operação quando o parâmetro for especificado.
Drain
Tipo de dados: SwitchParameter		 Implemente esse parâmetro para indicar que os itens de trabalho pendentes são processados antes que o cmdlet processe novos dados quando o parâmetro for especificado. Se o parâmetro não for especificado, os itens de trabalho serão processados imediatamente.
Erase
Tipo de dados: Int32		 Implemente esse parâmetro para que o usuário possa especificar o número de vezes que um recurso é apagado antes de ser excluído.
ErrorLevel
Tipo de dados: Int32		 Implemente esse parâmetro para que o usuário possa especificar o nível de erros a serem relatados.
Excluir
Tipo de dados: String[]		 Implemente esse parâmetro para que o usuário possa excluir algo de uma atividade. Para obter mais informações sobre como usar filtros de entrada, consulte Parâmetros do filtro de entrada.
Filtrar
Tipo de dados: Keyword		 Implemente esse parâmetro para que o usuário possa especificar um filtro que selecione os recursos nos quais executar a ação do cmdlet. Para obter mais informações sobre como usar filtros de entrada, consulte Parâmetros do filtro de entrada.
Siga
Tipo de dados: SwitchParameter		 Implemente esse parâmetro para que o progresso seja controlado quando o parâmetro for especificado.
Força
Tipo de dados: SwitchParameter		 Implemente esse parâmetro para indicar que o usuário pode executar uma ação mesmo se forem encontradas restrições quando o parâmetro for especificado. O parâmetro não permite que a segurança seja comprometida. Por exemplo, esse parâmetro permite que um usuário substitua um arquivo somente leitura.
Include
Tipo de dados: String[]		 Implemente esse parâmetro para que o usuário possa incluir algo em uma atividade. Para obter mais informações sobre como usar filtros de entrada, consulte Parâmetros do filtro de entrada.
Incremental
Tipo de dados: SwitchParameter		 Implemente esse parâmetro para indicar que o processamento é executado incrementalmente quando o parâmetro é especificado. Por exemplo, esse parâmetro permite que um usuário execute backups incrementais que fazem backup de arquivos somente desde o último backup.
InputObject
Tipo de dados: Object		 Implemente esse parâmetro quando o cmdlet receber entrada de outros cmdlets. Ao definir um parâmetro InputObject, sempre especifique a palavra-chave ValueFromPipeline ao declarar o Parameter atributo. Para obter mais informações sobre como usar filtros de entrada, consulte Parâmetros do filtro de entrada.
Insert
Tipo de dados: SwitchParameter		 Implemente esse parâmetro para que o cmdlet insira um item quando o parâmetro for especificado.
interativo
Tipo de dados: SwitchParameter		 Implemente esse parâmetro para que o cmdlet funcione interativamente com o usuário quando o parâmetro for especificado.
Interval
Tipo de dados: HashTable		 Implemente esse parâmetro para que o usuário possa especificar uma tabela de hash de palavras-chave que contenha os valores. O exemplo a seguir mostra valores de exemplo para o parâmetro Interval: -interval @{ResumeScan=15; Retry=3}.
Registo
Tipo de dados: SwitchParameter		 Implemente esse parâmetro para auditar as ações do cmdlet quando o parâmetro for especificado.
NoClobber
Tipo de dados: SwitchParameter		 Implemente esse parâmetro para que o recurso não seja substituído quando o parâmetro for especificado. Esse parâmetro geralmente se aplica a cmdlets que criam novos objetos para que possam ser impedidos de substituir objetos existentes com o mesmo nome.
Notify
Tipo de dados: SwitchParameter		 Implemente esse parâmetro para que o usuário seja notificado de que a atividade foi concluída quando o parâmetro for especificado.
NotifyAddress
Tipo de dados: Endereço de e-mail		 Implemente esse parâmetro para que o usuário possa especificar o endereço de email a ser usado para enviar uma notificação quando o parâmetro Notify for especificado.
Substituir
Tipo de dados: SwitchParameter		 Implemente esse parâmetro para que o cmdlet substitua quaisquer dados existentes quando o parâmetro for especificado.
Prompt
Tipo de dados: String		 Implemente esse parâmetro para que o usuário possa especificar um prompt para o cmdlet.
Quiet
Tipo de dados: SwitchParameter		 Implemente esse parâmetro para que o cmdlet suprima os comentários do usuário durante suas ações quando o parâmetro for especificado.
Recurse
Tipo de dados: SwitchParameter		 Implemente esse parâmetro para que o cmdlet execute recursivamente suas ações em recursos quando o parâmetro for especificado.
Reparação
Tipo de dados: SwitchParameter		 Implemente esse parâmetro para que o cmdlet tente corrigir algo de um estado quebrado quando o parâmetro for especificado.
RepairString
Tipo de dados: String		 Implemente esse parâmetro para que o usuário possa especificar uma cadeia de caracteres a ser usada quando o parâmetro Repair for especificado.
Retry
Tipo de dados: Int32		 Implemente esse parâmetro para que o usuário possa especificar o número de vezes que o cmdlet tentará uma ação.
Select
Tipo de dados: Keywordarray		 Implemente esse parâmetro para que o usuário possa especificar uma array dos tipos de itens.
Transmissão
Tipo de dados: SwitchParameter		 Implemente esse parâmetro para que o usuário possa transmitir vários objetos de saída através do pipeline quando o parâmetro for especificado.
Strict
Tipo de dados: SwitchParameter		 Implemente esse parâmetro para que todos os erros sejam tratados como erros de encerramento quando o parâmetro for especificado.
TempLocation
Tipo de dados: String		 Implemente esse parâmetro para que o usuário possa especificar o local dos dados temporários usados durante a operação do cmdlet.
Tempo limite
Tipo de dados: Int32		 Implemente esse parâmetro para que o usuário possa especificar o intervalo de tempo limite (em milissegundos).
Truncate
Tipo de dados: SwitchParameter		 Implemente esse parâmetro para que o cmdlet trunce suas ações quando o parâmetro for especificado. Se o parâmetro não for especificado, o cmdlet executará outra ação.
Verify
Tipo de dados: SwitchParameter		 Implemente esse parâmetro para que o cmdlet seja testado para determinar se uma ação ocorreu quando o parâmetro é especificado.
Aguarde
Tipo de dados: SwitchParameter		 Implemente esse parâmetro para que o cmdlet aguarde a entrada do usuário antes de continuar quando o parâmetro for especificado.
Tempo de espera
Tipo de dados: Int32		 Implemente esse parâmetro para que o usuário possa especificar a duração (em segundos) que o cmdlet aguardará a entrada do usuário quando o parâmetro Wait for especificado.

Ver também

parâmetros do cmdlet

Escrevendo um cmdlet do Windows PowerShell

SDK do Windows PowerShell

  • Last updated on