Logo

Documentation home for Transend tools

  • Export-M365Applications
  • Export-M365Domains
  • Export-M365Groups
  • Export-M365Mailboxes
  • Export-M365OrgLicenses
  • Export-M365OrgUnits
  • Export-M365Resources
  • Export-M365SharedContacts
  • Export-M365SharedDrives
  • Export-M365SharedMailboxes
  • Export-M365Sites
  • Export-M365Users
  • Import-M365Groups
  • Import-M365Resources
  • Import-M365SharedContacts
  • Import-M365SharedMailboxes
  • Import-M365UserDrives
  • Import-M365Users
  • Update-M365Groups
  • Update-M365Resources
  • Update-M365SharedContacts
  • Update-M365SharedMailboxes
  • Update-M365Users

    • Home

    Update-M365SharedContacts

    SYNOPSIS

    Updates shared contacts in a Microsoft 365 tenant.

    SYNTAX

    Help (Default)

    Update-M365SharedContacts [-ShowPrereqs] [<CommonParameters>]

    Action

    Update-M365SharedContacts -ConfigNode <String> -Csv <String> [-TranslationCsv <String>] [-IgnoreErrors]
 [-SkipValidation] [-ValidateOnly] [<CommonParameters>]

    DESCRIPTION

    Use the Update-M365SharedContacts cmdlet to update shared contacts in a Microsoft 365 tenant.

    See the Notes section for cmdlet requirements.

    EXAMPLES

    Example 1: Validation only

    Update-M365SharedContacts -ConfigNode Target -Csv 'shared_contacts.csv' -ValidateOnly

    This example validates all data for the shared contacts in the shared_contacts.csv file but does not perform the operation. This is a recommended first step so any warnings can be addressed first.

    Example 2: Basic update

    Update-M365SharedContacts -ConfigNode Target -Csv 'shared_contacts.csv'

    This example updates all shared contacts from the shared_contacts.csv file.

    Example 3: Advanced update with translation

    Update-M365SharedContacts -ConfigNode Target -Csv 'shared_contacts.csv' -TranslationCsv 'translations.csv'

    This example updates all shared contacts from the shared_contacts.csv file. Data is translated according to the mappings provided in the translations.csv file.

    PARAMETERS

    -ConfigNode

    The config.psd1 configuration node to use.

    Type: String
Parameter Sets: Action
Aliases:
Accepted values: Source, Target

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

    -Csv

    The path to a CSV file containing objects to update. See the Notes section for the required format.

    Type: String
Parameter Sets: Action
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

    -IgnoreErrors

    Validation errors stop execution prior to the update by default. Use -IgnoreErrors to proceed with error records omitted.

    Note that global errors are not impacted by this option.

    Type: SwitchParameter
Parameter Sets: Action
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

    -ShowPrereqs

    Prints the cmdlet prerequisites.

    Type: SwitchParameter
Parameter Sets: Help
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

    -SkipValidation

    Skips the property validation stage of the import. Data supplied in the via the -Csv parameter will be used as-is, which may lead to runtime errors.

    Type: SwitchParameter
Parameter Sets: Action
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

    -TranslationCsv

    The path to the CSV file containing translation mappings. The file must use SourceName;TargetName as the field identifiers.

    Type: String
Parameter Sets: Action
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

    -ValidateOnly

    Validation and update are both performed by default. Use -ValidateOnly to perform the validation but skip the update.

    It is recommended to run a -ValidateOnly pass first to identify potential issues prior to updating data. Note that records with validation errors will fail to update unless -IgnoreErrors is used, but records with validation warnings proceed without the data triggering the warning. A -ValidateOnly pass allows you to inspect these warnings before data is written and make any necessary changes.

    Type: SwitchParameter
Parameter Sets: Action
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

    CommonParameters

    This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

    INPUTS

    None

    OUTPUTS

    System.Void

    NOTES

    Required PowerShell modules

    • ExchangeOnlineManagement

    Required config.psd1 configurations

    • M365ClientId
    • M365ClientSecret
    • M365SharePointDomain
    • M365Tenant

    Optional config.psd1 configurations

    • M365CloudEnvironment
    • StageIntermissionSeconds

    Required APIs

    • Microsoft Graph

    Required scopes

    • Directory.Read.All (Application)

    Required CSV format

    Property Required Multivalue Notes
    InScope True False Allowed values: Yes, True, No and False
    Identity True False Allowed values: OID, UPN, email address, email alias, display name
    • CSV fields should be separated by semicolons. For example, InScope;Identity....

    TMCTools configuration options