Get-DistributionGroup
Este cmdlet está disponible en Exchange local y en el servicio basado en la nube. Puede que algunos parámetros y opciones de configuración sean exclusivos de un entorno u otro.
Use el cmdlet Get-DistributionGroup para ver los grupos de distribución existentes o los grupos de seguridad habilitados para correo. Para ver los miembros de un grupo, use el cmdlet Get-DistributionGroupMember.
Para obtener más información acerca de los conjuntos de parámetros de la sección Sintaxis a continuación, vea Sintaxis del cmdlet de Exchange.
Syntax
Get-DistributionGroup
[-Anr <String>]
[-Credential <PSCredential>]
[-DomainController <Fqdn>]
[-Filter <String>]
[-IgnoreDefaultScope]
[-OrganizationalUnit <OrganizationalUnitIdParameter>]
[-ReadFromDomainController]
[-RecipientTypeDetails <RecipientTypeDetails[]>]
[-ResultSize <Unlimited>]
[-SortBy <String>]
[<CommonParameters>] Get-DistributionGroup
[[-Identity] <DistributionGroupIdParameter>]
[-Credential <PSCredential>]
[-DomainController <Fqdn>]
[-Filter <String>]
[-IgnoreDefaultScope]
[-OrganizationalUnit <OrganizationalUnitIdParameter>]
[-ReadFromDomainController]
[-RecipientTypeDetails <RecipientTypeDetails[]>]
[-ResultSize <Unlimited>]
[-SortBy <String>]
[<CommonParameters>] Get-DistributionGroup
[-Credential <PSCredential>]
[-DomainController <Fqdn>]
[-Filter <String>]
[-IgnoreDefaultScope]
[-ManagedBy <GeneralRecipientIdParameter>]
[-OrganizationalUnit <OrganizationalUnitIdParameter>]
[-ReadFromDomainController]
[-RecipientTypeDetails <RecipientTypeDetails[]>]
[-ResultSize <Unlimited>]
[-SortBy <String>]
[<CommonParameters>] Description
Deberá tener asignados permisos antes de poder ejecutar este cmdlet. Aunque en este tema se enumeran todos los parámetros correspondientes a este cmdlet, tal vez no tenga acceso a algunos parámetros si no están incluidos en los permisos que se le han asignado. Para obtener los permisos necesarios para ejecutar cualquier cmdlet o parámetro en su organización, consulte Find the permissions required to run any Exchange cmdlet.
Ejemplos
Ejemplo 1
Get-DistributionGroupEn este ejemplo se devuelve una lista resumida de todos los grupos de distribución y los grupos de seguridad habilitados para correo de su organización.
Ejemplo 2
Get-DistributionGroup -Identity "Marketing Reports" | Format-ListEn este ejemplo se devuelve información detallada acerca del grupo de distribución denominado Marketing Reports.
Ejemplo 3
Get-DistributionGroup -Anr marketing | Format-Table Name, ManagedBy -AutoEn este ejemplo se devuelven todos los grupos de distribución y los grupos de seguridad habilitados para correo cuyos nombres contienen la cadena "marketing" y se muestran los propietarios de los grupos.
Parámetros
-Anr
El parámetro Anr especifica una cadena en la que se va a realizar una búsqueda resolución de nombres ambiguos (ANR). Puede especificar una cadena parcial y buscar objetos con un atributo que coincida con esa cadena. Los atributos predeterminados que se buscan son:
- CommonName (CN)
- DisplayName
- FirstName
- LastName
- Alias
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection |
-Credential
El parámetro Credential especifica el nombre de usuario y la contraseña que se usan para ejecutar este comando. Por lo general, este parámetro se usa en scripts o cuando deben proporcionarse credenciales diferentes que disponen de los permisos necesarios.
Un valor para este parámetro requiere el cmdlet Get-Credential. Para pausar este comando y recibir una solicitud de credenciales, use el valor (Get-Credential). O bien, antes de ejecutar este comando, almacene las credenciales en una variable (por ejemplo, $cred = Get-Credential) y, a continuación, use el nombre de variable ($cred) para este parámetro. Para más información, vea Get-Credential.
| Type: | PSCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection |
-DomainController
Este parámetro solo está disponible en Exchange local.
El parámetro DomainController especifica el controlador de dominio que el cmdlet usa para leer datos de Active Directory o escribirlos. El controlador de dominio se identifica por su nombre de dominio completo (FQDN). Por ejemplo, dc01.contoso.com.
| Type: | Fqdn |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-Filter
El parámetro Filter usa la sintaxis de OPATH para filtrar los resultados por las propiedades y valores especificados. Los criterios de búsqueda usan la sintaxis "Property -ComparisonOperator 'Value'".
- Incluya todo el filtro de OPATH entre comillas dobles " ". Si el filtro contiene valores del sistema (por ejemplo, ,
$true$falseo$null), use comillas simples ' ' en su lugar. Aunque este parámetro es una cadena (no un bloque del sistema), también puede usar llaves { }, pero solo si el filtro no contiene variables. - La propiedad es una propiedad filtrable. Para obtener más información sobre las propiedades filtrables, vea Propiedades filtrables para el parámetro Filter.
- ComparisonOperator es un operador de comparación de OPATH (por ejemplo
-eq, para igual y-likepara la comparación de cadenas). Para obtener más información sobre los operadores de comparación, consulte about_Comparison_Operators. - Value es el valor de propiedad que se va a buscar. Incluya valores de texto y variables entre comillas simples (
'Value'o'$Variable'). Si un valor de variable contiene comillas simples, debe identificar (escape) las comillas simples para expandir la variable correctamente. Por ejemplo, en lugar de'$User', use'$($User -Replace "'","''")'. No incluya enteros ni valores del sistema entre comillas (por ejemplo, use500,$true,$falseo$nullen su lugar).
Puede encadenar varios criterios de búsqueda mediante los operadores lógicos -and y -or. Por ejemplo, "Criteria1 -and Criteria2" o "(Criteria1 -and Criteria2) -or Criteria3".
Para obtener información detallada sobre los filtros de OPATH en Exchange, consulte Información adicional de la sintaxis de OPATH.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection |
-Identity
El parámetro Identity especifica el grupo de distribución o el grupo de seguridad habilitado para correo que se desea ver. Puede usar cualquier valor que identifique de forma exclusiva el grupo. Por ejemplo:
- Nombre
- Alias
- Nombre distintivo (DN)
- Nombre distintivo (DN)
- DN canónico
- GUID
| Type: | DistributionGroupIdParameter |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection |
-IgnoreDefaultScope
Este parámetro solo está disponible en Exchange local.
El modificador IgnoreDefaultScope indica al comando que ignore la configuración predeterminada del ámbito del destinatario para la sesión de Exchange PowerShell y que use todo el bosque como ámbito. No es necesario especificar un valor con este modificador.
Este cambio habilita el comando tenga acceso a objetos de Active Directory que no están actualmente disponibles en el ámbito predeterminado, pero también introduce las siguientes restricciones:
- No puede usar el parámetro DomainController. El comando usa un servidor de catálogo global adecuado de forma automática.
- Sólo puede usar el DN para el parámetro Identity. No se aceptan otras formas de identificación, como alias o GUID.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-ManagedBy
El parámetro ManagedBy filtra los resultados por el propietario del grupo. Puede usar cualquier valor que identifique de forma exclusiva al propietario. Por ejemplo:
- Nombre
- Alias
- Nombre distintivo (DN)
- Nombre distintivo (DN)
- DN canónico
- GUID
| Type: | GeneralRecipientIdParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection |
-OrganizationalUnit
El parámetro OrganizationalUnit filtra los resultados en función de la ubicación del objeto en Active Directory. Se devuelven solo los objetos que existen en la ubicación especificada. La entrada válida para este parámetro es una unidad organizativa (UO) o dominio que devuelve el cmdlet Get-OrganizationalUnit. Puede usar cualquier valor que identifique la OU o el dominio de forma exclusiva. Por ejemplo:
- Nombre
- Nombre
- Nombre completo (DN)
- GUID
| Type: | OrganizationalUnitIdParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection |
-ReadFromDomainController
Este parámetro solo está disponible en Exchange local.
El conmutador ReadFromDomainController especifica que la información se debe leer de un controlador de dominio en el dominio del usuario. No es necesario especificar un valor con este modificador.
El comando : Set-AdServerSettings -ViewEntireForest $true para incluir todos los objetos en el bosque, es necesario el modificador ReadFromDomainController. De lo contrario, el comando podría usar un catálogo global que contenga información obsoleta. Además, es posible que tenga que ejecutar varias iteraciones del comando con el modificador ReadFromDomainController para obtener la información.
De forma predeterminada, el ámbito del destinatario se establece en el dominio que hospeda los servidores de Exchange.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-RecipientTypeDetails
El parámetro RecipientTypeDetails filtra los resultados por el subtipo de grupo de distribución especificado. Los valores admitidos son:
- MailNonUniversalGroup
- MailUniversalDistributionGroup
- MailUniversalSecurityGroup
- RoomList
Puede especificar distintos valores separados por comas.
| Type: | RecipientTypeDetails[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection |
-ResultSize
El parámetro ResultSize especifica el número máximo de resultados que se van a devolver. Si desea incluir en los resultados devueltos todas las solicitudes que coincidan con la consulta, use el valor ilimitado para este parámetro. El valor predeterminado es 1000.
| Type: | Unlimited |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection |
-SortBy
El parámetro SortBy especifica la propiedad según la cual se ordenan los resultados. Solo se puede seleccionar una propiedad a la vez. Los resultados se clasifican en orden ascendente.
Si la vista predeterminada no incluye la propiedad por la que va a ordenar, puede anexar el comando con | Format-Table -Auto Property1,Property2,...PropertyX. para crear una nueva vista que contenga todas las propiedades que desea ver. Se admiten caracteres comodín (*) en los nombres de propiedad.
Puede realizar la clasificación por las propiedades siguientes:
- Nombre
- DisplayName
- Alias
- Ciudad
- FirstName
- LastName
- Office
- ServerLegacyDN
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection |
Entradas
Input types
Para ver los tipos de entrada que acepta este cmdlet, consulte Tipos de entrada y salida de cmdlet. Si el campo Tipo de entrada de un cmdlet está en blanco, el cmdlet no acepta datos de entrada.
Salidas
Output types
Para ver los tipos de valor devuelto (también conocidos como tipos de resultado) que acepta este cmdlet, consulte Tipos de entrada y salida de cmdlet. Si el campo Tipo de resultado está en blanco, el cmdlet no devuelve datos.