Compartilhar via

Find-DscResource

Módulo:
PowerShellGet Module

Localiza recursos de DSC (Configuração de Estado Desejado).

Sintaxe

All 

Find-DscResource
    [[-Name] <String[]>]
    [-ModuleName <String>]
    [-MinimumVersion <String>]
    [-MaximumVersion <String>]
    [-RequiredVersion <String>]
    [-AllVersions]
    [-AllowPrerelease]
    [-Tag <String[]>]
    [-Filter <String>]
    [-Proxy <Uri>]
    [-ProxyCredential <PSCredential>]
    [-Repository <String[]>]
    [<CommonParameters>]

Description

O cmdlet Find-DscResource pesquisa repositórios registrados para localizar recursos DSC contidos em módulos. Por padrão, Find-DscResource pesquisa todos os repositórios registrados.

Para cada módulo encontrado por Find-DscResource, um objeto PSGetDscResourceInfo é retornado. objetos PSGetDscResourceInfo podem ser enviados pelo pipeline para o cmdlet Install-Module. Install-Module instala o módulo.

Exemplos

Exemplo 1: localizar todos os recursos de DSC

Find-DscResource retorna recursos DSC de repositórios registrados. Para pesquisar um repositório específico, use o parâmetro Repositório.

Find-DscResource

Name                           Version    ModuleName                     Repository
----                           -------    ----------                     ----------
Carbon_Privilege               2.8.1      Carbon                         PSGallery
Carbon_ScheduledTask           2.8.1      Carbon                         PSGallery
Carbon_Service                 2.8.1      Carbon                         PSGallery
PackageManagement              1.4        PackageManagement              PSGallery
PackageManagementSource        1.4        PackageManagement              PSGallery
PSModule                       2.1.4      PowerShellGet                  PSGallery
PSRepository                   2.1.4      PowerShellGet                  PSGallery
xArchive                       8.7.0.0    xPSDesiredStateConfiguration   PSGallery
xDSCWebService                 8.7.0.0    xPSDesiredStateConfiguration   PSGallery
xEnvironment                   8.7.0.0    xPSDesiredStateConfiguration   PSGallery

Exemplo 2: localizar um recurso DSC pelo nome

Find-DscResource localiza recursos DSC por nome. Use vírgulas para separar uma matriz de nomes de recursos.

Find-DscResource -Name xWebsite, xWebApplication, xWebSiteDefaults

Name               Version    ModuleName            Repository
----               -------    ----------            ----------
xWebApplication    2.6.0.0    xWebAdministration    PSGallery
xWebsite           2.6.0.0    xWebAdministration    PSGallery
xWebSiteDefaults   2.6.0.0    xWebAdministration    PSGallery

Find-DscResource usa o parâmetro Name para localizar a matriz especificada de recursos DSC.

Exemplo 3: localizar um recurso DSC e instalá-lo

Find-DscResource localiza um recurso DSC e envia o objeto pelo pipeline a ser instalado. Após a instalação, use Get-InstalledModule para exibir os resultados.

Vários recursos do mesmo módulo podem ser enviados pelo pipeline para o Install-Module. Install-Module tenta instalar o módulo apenas uma vez.

Find-DscResource -Name xWebsite | Install-Module

Find-DscResource usa o parâmetro Name para localizar o recurso chamado xWebsite. O objeto é enviado pelo pipeline para o cmdlet Install-Module. instala o módulo xWebAdministration para o recurso.

Exemplo 4: localizar todos os recursos de DSC em um módulo

Find-DscResource localiza todos os recursos de DSC contidos em um módulo especificado. Por padrão, a versão atual é exibida. Para exibir outras versões, use os parâmetros AllVersions ou RequiredVersions.

Find-DscResource -ModuleName xWebAdministration

Name                                Version    ModuleName              Repository
----                                -------    ----------              ----------
WebApplicationHandler               2.6.0.0    xWebAdministration      PSGallery
xIisFeatureDelegation               2.6.0.0    xWebAdministration      PSGallery
xIisHandler                         2.6.0.0    xWebAdministration      PSGallery
xIisLogging                         2.6.0.0    xWebAdministration      PSGallery

usa o parâmetro ModuleName para especificar o xWebAdministration e localizar os recursos DSC contidos no módulo. A versão atual de cada recurso é exibida.

Exemplo 5: localizar um recurso DSC por marca e versão necessária

Os recursos DSC podem ser localizados usando os parâmetros Tag e RequiredVersion. Marca exibe a versão atual de cada recurso que contém a marca especificada no repositório. requiredVersion precisa do parâmetro ModuleName e o parâmetro Name é opcional. Os parâmetros de Nome do e limitam a saída. Use o parâmetro AllVersions para exibir as versões disponíveis de um recurso DSC.

Find-DscResource -ModuleName xWebAdministration -Tag DSC -RequiredVersion 1.20

Name                    Version    ModuleName             Repository
----                    -------    ----------             ----------
xIisFeatureDelegation   1.20.0.0   xWebAdministration     PSGallery
xIisHandler             1.20.0.0   xWebAdministration     PSGallery
xIisLogging             1.20.0.0   xWebAdministration     PSGallery
xIisMimeTypeMapping     1.20.0.0   xWebAdministration     PSGallery

Exemplo 6: localizar um recurso usando um filtro

Find-DscResource localiza todos os recursos e usa o parâmetro Filter para especificar os resultados Domínio. O parâmetro Filter localiza o valor do filtro na descrição ou no nome do módulo do objeto. Use o cmdlet Select-Object para exibir as propriedades de um objeto.

Find-DscResource -Filter Domain

Name                    Version    ModuleName                 Repository
----                    -------    ----------                 ---------
xComputer               4.1.0.0    xComputerManagement        PSGallery
Computer                6.4.0.0    ComputerManagementDsc      PSGallery
xDSCDomainjoin          1.1        xDSCDomainjoin             PSGallery
xDisk                   1.0        xDisk                      PSGallery
xDSCFirewall            1.6.21     xDSCFirewall               PSGallery
dmAwsTagInstance        1.0.1      domainAwsDSCResources      PSGallery

Parâmetros

-AllowPrerelease

Inclui recursos marcados como pré-lançamento nos resultados.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-AllVersions

O parâmetro AllVersions exibe cada uma das versões disponíveis de um recurso DSC. Não é possível usar o parâmetro AllVersions com os parâmetros MinimumVersion, MaximumVersionou RequiredVersion.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Filter

Localiza recursos com base na sintaxe de pesquisa do PackageManagement provedor. Por exemplo, especifique palavras para pesquisar dentro das propriedades moduleName e Description.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-MaximumVersion

Especifica a versão máxima do recurso a ser incluída nos resultados. O MaximumVersion e os parâmetros RequiredVersion não podem ser usados no mesmo comando.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-MinimumVersion

Especifica a versão mínima do recurso a ser incluída nos resultados. Os parâmetros MinimumVersion e RequiredVersion não podem ser usados no mesmo comando.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-ModuleName

Especifica um módulo que contém o recurso DSC.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Name

Especifica o nome de um recurso. O padrão é todos os recursos. Use vírgulas para separar uma matriz de nomes de recursos.

Propriedades do parâmetro

Tipo:

String[]

Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:0
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Proxy

Especifica um servidor proxy para a solicitação, em vez de uma conexão direta com o recurso de Internet.

Propriedades do parâmetro

Tipo:Uri
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-ProxyCredential

Especifica uma conta de usuário com permissão para usar o servidor proxy especificado no parâmetro Proxy .

Propriedades do parâmetro

Tipo:PSCredential
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-Repository

Especifica um repositório para pesquisar recursos. Use vírgulas para separar uma matriz de nomes de repositório.

Propriedades do parâmetro

Tipo:

String[]

Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-RequiredVersion

Especifica o número exato da versão do módulo a ser incluído nos resultados. Os parâmetros RequiredVersion e MinimumVersion não podem ser usados no mesmo comando.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Tag

Especifica marcas que categorizam módulos em um repositório. Use vírgulas para separar uma matriz de marcas.

Propriedades do parâmetro

Tipo:

String[]

Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Saídas

PSGetDscResourceInfo

retorna um objeto PSGetDscResourceInfo .

Observações

Importante

A partir de abril de 2020, a Galeria do PowerShell não dá mais suporte ao TLS (Transport Layer Security) versões 1.0 e 1.1. Se você não estiver usando o TLS 1.2 ou superior, receberá um erro ao tentar acessar a Galeria do PowerShell. Use o seguinte comando para garantir que você esteja usando o TLS 1.2:

[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12

Para obter mais informações, consulte o comunicado no blog do PowerShell.