Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Get-MgContact
Get the properties and relationships of an organizational contact.
Note
To view the beta release of this cmdlet, view Get-MgBetaContact
Syntax
List (Default)
Get-MgContact
[-ExpandProperty <string[]>]
[-Property <string[]>]
[-Filter <string>]
[-Search <string>]
[-Skip <int>]
[-Sort <string[]>]
[-Top <int>]
[-ConsistencyLevel <string>]
[-ResponseHeadersVariable <string>]
[-Break]
[-Headers <IDictionary>]
[-HttpPipelineAppend <SendAsyncStep[]>]
[-HttpPipelinePrepend <SendAsyncStep[]>]
[-Proxy <uri>]
[-ProxyCredential <pscredential>]
[-ProxyUseDefaultCredentials]
[-PageSize <int>]
[-All]
[-CountVariable <string>]
[<CommonParameters>]
Get
Get-MgContact
-OrgContactId <string>
[-ExpandProperty <string[]>]
[-Property <string[]>]
[-ResponseHeadersVariable <string>]
[-Break]
[-Headers <IDictionary>]
[-HttpPipelineAppend <SendAsyncStep[]>]
[-HttpPipelinePrepend <SendAsyncStep[]>]
[-Proxy <uri>]
[-ProxyCredential <pscredential>]
[-ProxyUseDefaultCredentials]
[<CommonParameters>]
GetViaIdentity
Get-MgContact
-InputObject <IIdentityDirectoryManagementIdentity>
[-ExpandProperty <string[]>]
[-Property <string[]>]
[-ResponseHeadersVariable <string>]
[-Break]
[-Headers <IDictionary>]
[-HttpPipelineAppend <SendAsyncStep[]>]
[-HttpPipelinePrepend <SendAsyncStep[]>]
[-Proxy <uri>]
[-ProxyCredential <pscredential>]
[-ProxyUseDefaultCredentials]
[<CommonParameters>]
Description
Get the properties and relationships of an organizational contact.
Permissions
| Permission type | Permissions (from least to most privileged) |
|---|---|
| Delegated (work or school account) | OrgContact.Read.All, Directory.ReadWrite.All, Directory.Read.All, |
| Delegated (personal Microsoft account) | Not supported |
| Application | OrgContact.Read.All, Directory.ReadWrite.All, Directory.Read.All, |
Examples
Example 1: Retrieve contact objects in the directory
Get-MgContact | Format-List Id, DisplayName, Mail, MailNickname
Id : 5d58402b-3cb2-4b17-b913-299a72c84204
DisplayName : Bob Kelly (TAILSPIN)
Mail : bobk@tailspintoys.com
MailNickname : BobKTAILSPIN
This example retrieves all contact objects in the directory.
Parameters
-All
List all pages.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Break
Wait for .NET debugger to attach
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ConsistencyLevel
Indicates the requested consistency level. Documentation URL: https://docs.microsoft.com/graph/aad-advanced-queries
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-CountVariable
Specifies a count of the total number of items in a collection. By default, this variable will be set in the global scope.
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | CV |
Parameter sets
-ExpandProperty
Expand related entities
Parameter properties
| Type: | System.String[] |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Expand |
Parameter sets
-Filter
Filter items by property values
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Headers
Optional headers that will be added to the request.
Parameter properties
| Type: | System.Collections.IDictionary |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-HttpPipelineAppend
SendAsync Pipeline Steps to be appended to the front of the pipeline
Parameter properties
| Type: | Microsoft.Graph.PowerShell.Runtime.SendAsyncStep[] |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-HttpPipelinePrepend
SendAsync Pipeline Steps to be prepended to the front of the pipeline
Parameter properties
| Type: | Microsoft.Graph.PowerShell.Runtime.SendAsyncStep[] |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
Parameter properties
| Type: | Microsoft.Graph.PowerShell.Models.IIdentityDirectoryManagementIdentity |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-OrgContactId
The unique identifier of orgContact
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-PageSize
Sets the page size of results.
Parameter properties
| Type: | System.Int32 |
| Default value: | 0 |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Property
Select properties to be returned
Parameter properties
| Type: | System.String[] |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Select |
Parameter sets
-Proxy
The URI for the proxy server to use
Parameter properties
| Type: | System.Uri |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ProxyCredential
Credentials for a proxy server to use for the remote call
Parameter properties
| Type: | System.Management.Automation.PSCredential |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ProxyUseDefaultCredentials
Use the default credentials for the proxy
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ResponseHeadersVariable
Optional Response Headers Variable.
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | RHV |
Parameter sets
-Search
Search items by search phrases
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Skip
Skip the first n items
Parameter properties
| Type: | System.Int32 |
| Default value: | 0 |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Sort
Order items by property values
Parameter properties
| Type: | System.String[] |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | OrderBy |
Parameter sets
-Top
Show only the first n items
Parameter properties
| Type: | System.Int32 |
| Default value: | 0 |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Limit |
Parameter sets
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
Microsoft.Graph.PowerShell.Models.IIdentityDirectoryManagementIdentity
{{ Fill in the Description }}
System.Collections.IDictionary
{{ Fill in the Description }}
Outputs
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphOrgContact
{{ Fill in the Description }}
Notes
COMPLEX PARAMETER PROPERTIES
To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.
INPUTOBJECT <IIdentityDirectoryManagementIdentity>: Identity Parameter
[AdministrativeUnitId <String>]: The unique identifier of administrativeUnit
[AllowedValueId <String>]: The unique identifier of allowedValue
[AttributeSetId <String>]: The unique identifier of attributeSet
[CertificateAuthorityDetailId <String>]: The unique identifier of certificateAuthorityDetail
[CertificateBasedAuthPkiId <String>]: The unique identifier of certificateBasedAuthPki
[CommerceSubscriptionId <String>]: Alternate key of companySubscription
[CompanySubscriptionId <String>]: The unique identifier of companySubscription
[ContractId <String>]: The unique identifier of contract
[CustomSecurityAttributeDefinitionId <String>]: The unique identifier of customSecurityAttributeDefinition
[DeviceId <String>]: The unique identifier of device
[DeviceLocalCredentialInfoId <String>]: The unique identifier of deviceLocalCredentialInfo
[DirectoryObjectId <String>]: The unique identifier of directoryObject
[DirectoryRoleId <String>]: The unique identifier of directoryRole
[DirectoryRoleTemplateId <String>]: The unique identifier of directoryRoleTemplate
[DomainDnsRecordId <String>]: The unique identifier of domainDnsRecord
[DomainId <String>]: The unique identifier of domain
[DomainName <String>]: Usage: domainName='{domainName}'
[ExtensionId <String>]: The unique identifier of extension
[IdentityProviderBaseId <String>]: The unique identifier of identityProviderBase
[InternalDomainFederationId <String>]: The unique identifier of internalDomainFederation
[OnPremisesDirectorySynchronizationId <String>]: The unique identifier of onPremisesDirectorySynchronization
[OrgContactId <String>]: The unique identifier of orgContact
[OrganizationId <String>]: The unique identifier of organization
[OrganizationalBrandingLocalizationId <String>]: The unique identifier of organizationalBrandingLocalization
[ProfileCardPropertyId <String>]: The unique identifier of profileCardProperty
[RoleTemplateId <String>]: Alternate key of directoryRole
[ScopedRoleMembershipId <String>]: The unique identifier of scopedRoleMembership
[SubscribedSkuId <String>]: The unique identifier of subscribedSku
[TenantId <String>]: Usage: tenantId='{tenantId}'
[UserId <String>]: The unique identifier of user