Register-M365App

SYNOPSIS

Registers a TMCTools app in a Microsoft 365 tenant.

SYNTAX

Help (Default)

Register-M365App [-ShowPrereqs] [<CommonParameters>]

Action

Register-M365App -Tenant <String> -Access <String> [-AppName <String>] [-CloudEnvironment <String>]
 [<CommonParameters>]

DESCRIPTION

Use the Register-M365App cmdlet to register a TMCTools app in a Microsoft 365 tenant.

EXAMPLES

Example 1: Register an app for export tools only

Register-M365App -Tenant 'example.org' -Access 'ReadOnly'

This example registers an app with the default TMCTools name into the example.org tenant with application scopes that support export tools.

Example 2: Register an app for export and import tools

Register-M365App -Tenant 'example.org' -Access 'ReadWrite' -AppName 'Provisioning'

This example registers an app with the custom Provisioning name into the example.org tenant with application scopes that support export and import tools.

PARAMETERS

-Access

Specifies the application scopes to associate with the new app. If you are only performing exports, ReadOnly is sufficient. If you also need to perform imports, choose ReadWrite.

Type: String
Parameter Sets: Action
Aliases:
Accepted values: ReadOnly, ReadWrite

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

-AppName

The newly registered app is named TMCTools by default. Use -AppName to choose a custom name.

Type: String
Parameter Sets: Action
Aliases:

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

-CloudEnvironment

The cloud environment to authenticate against.

Type: String
Parameter Sets: Action
Aliases:
Accepted values: Production, China, Germany, PPE, USGovernment, USGovernmentDoD, USGovernmentHigh, Custom

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

-Tenant

Specifies the tenant name. For example, example.org.

Type: String
Parameter Sets: Action
Aliases:

Required: True
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

You only need to create an app via Register-M365App if you are using provisioning tools for Microsoft 365 (i.e., Export-* and Import-* cmdlets).
The following steps must be performed manually after running Register-M365App:
1. Assign the Global Administrator role.
2. Add the Exchange.ManageAsApp permission.
3. Add a client secret.

TMCTools configuration options