Update-MgPolicyCrossTenantAccessPolicy
Update the properties of a cross-tenant access policy.
Note
To view the beta release of this cmdlet, view Update-MgBetaPolicyCrossTenantAccessPolicy
Syntax
Update-MgPolicyCrossTenantAccessPolicy
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-AllowedCloudEndpoints <String[]>]
[-Default <IMicrosoftGraphCrossTenantAccessPolicyConfigurationDefault>]
[-DeletedDateTime <DateTime>]
[-Description <String>]
[-DisplayName <String>]
[-Id <String>]
[-Partners <IMicrosoftGraphCrossTenantAccessPolicyConfigurationPartner[]>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Update-MgPolicyCrossTenantAccessPolicy
-BodyParameter <IMicrosoftGraphCrossTenantAccessPolicy>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
Update the properties of a cross-tenant access policy.
Examples
Example 1: Code snippet
Import-Module Microsoft.Graph.Identity.SignIns
$params = @{
allowedCloudEndpoints = @(
"microsoftonline.us"
)
}
Update-MgPolicyCrossTenantAccessPolicy -BodyParameter $paramsThis example shows how to use the Update-MgPolicyCrossTenantAccessPolicy Cmdlet.
To learn about permissions for this resource, see the permissions reference.
Parameters
-AdditionalProperties
Additional Parameters
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AllowedCloudEndpoints
Used to specify which Microsoft clouds an organization would like to collaborate with. By default, this value is empty. Supported values for this field are: microsoftonline.com, microsoftonline.us, and partner.microsoftonline.cn.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BodyParameter
crossTenantAccessPolicy To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
| Type: | IMicrosoftGraphCrossTenantAccessPolicy |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Default
crossTenantAccessPolicyConfigurationDefault To construct, see NOTES section for DEFAULT properties and create a hash table.
| Type: | IMicrosoftGraphCrossTenantAccessPolicyConfigurationDefault |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DeletedDateTime
Date and time when this object was deleted. Always null when the object hasn't been deleted.
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Description
Description for this policy. Required.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DisplayName
Display name for this policy. Required.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Headers
Optional headers that will be added to the request.
| Type: | IDictionary |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Id
The unique identifier for an entity. Read-only.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Partners
Defines partner-specific configurations for external Microsoft Entra organizations. To construct, see NOTES section for PARTNERS properties and create a hash table.
| Type: | IMicrosoftGraphCrossTenantAccessPolicyConfigurationPartner[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProgressAction
{{ Fill ProgressAction Description }}
| Type: | ActionPreference |
| Aliases: | proga |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResponseHeadersVariable
Optional Response Headers Variable.
| Type: | String |
| Aliases: | RHV |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphCrossTenantAccessPolicy
System.Collections.IDictionary
Outputs
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphCrossTenantAccessPolicy
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.
BODYPARAMETER <IMicrosoftGraphCrossTenantAccessPolicy>: crossTenantAccessPolicy
[(Any) <Object>]: This indicates any property can be added to this object.[Description <String>]: Description for this policy. Required.[DisplayName <String>]: Display name for this policy. Required.[DeletedDateTime <DateTime?>]: Date and time when this object was deleted. Always null when the object hasn't been deleted.[Id <String>]: The unique identifier for an entity. Read-only.[AllowedCloudEndpoints <String-[]>]: Used to specify which Microsoft clouds an organization would like to collaborate with. By default, this value is empty. Supported values for this field are: microsoftonline.com, microsoftonline.us, and partner.microsoftonline.cn.[Default <IMicrosoftGraphCrossTenantAccessPolicyConfigurationDefault>]: crossTenantAccessPolicyConfigurationDefault[(Any) <Object>]: This indicates any property can be added to this object.[Id <String>]: The unique identifier for an entity. Read-only.[AutomaticUserConsentSettings <IMicrosoftGraphInboundOutboundPolicyConfiguration>]: inboundOutboundPolicyConfiguration[(Any) <Object>]: This indicates any property can be added to this object.[InboundAllowed <Boolean?>]: Defines whether external users coming inbound are allowed.[OutboundAllowed <Boolean?>]: Defines whether internal users are allowed to go outbound.
[B2BCollaborationInbound <IMicrosoftGraphCrossTenantAccessPolicyB2BSetting>]: crossTenantAccessPolicyB2BSetting[(Any) <Object>]: This indicates any property can be added to this object.[Applications <IMicrosoftGraphCrossTenantAccessPolicyTargetConfiguration>]: crossTenantAccessPolicyTargetConfiguration[(Any) <Object>]: This indicates any property can be added to this object.[AccessType <String>]: crossTenantAccessPolicyTargetConfigurationAccessType[Targets <IMicrosoftGraphCrossTenantAccessPolicyTarget-[]>]: Specifies whether to target users, groups, or applications with this rule.[Target <String>]: The unique identifier of the user, group, or application; one of the following keywords: AllUsers and AllApplications; or for targets that are applications, you may use reserved values.[TargetType <String>]: crossTenantAccessPolicyTargetType
[UsersAndGroups <IMicrosoftGraphCrossTenantAccessPolicyTargetConfiguration>]: crossTenantAccessPolicyTargetConfiguration
[B2BCollaborationOutbound <IMicrosoftGraphCrossTenantAccessPolicyB2BSetting>]: crossTenantAccessPolicyB2BSetting[B2BDirectConnectInbound <IMicrosoftGraphCrossTenantAccessPolicyB2BSetting>]: crossTenantAccessPolicyB2BSetting[B2BDirectConnectOutbound <IMicrosoftGraphCrossTenantAccessPolicyB2BSetting>]: crossTenantAccessPolicyB2BSetting[InboundTrust <IMicrosoftGraphCrossTenantAccessPolicyInboundTrust>]: crossTenantAccessPolicyInboundTrust[(Any) <Object>]: This indicates any property can be added to this object.[IsCompliantDeviceAccepted <Boolean?>]: Specifies whether compliant devices from external Microsoft Entra organizations are trusted.[IsHybridAzureAdJoinedDeviceAccepted <Boolean?>]: Specifies whether Microsoft Entra hybrid joined devices from external Microsoft Entra organizations are trusted.[IsMfaAccepted <Boolean?>]: Specifies whether MFA from external Microsoft Entra organizations is trusted.
[InvitationRedemptionIdentityProviderConfiguration <IMicrosoftGraphDefaultInvitationRedemptionIdentityProviderConfiguration>]: defaultInvitationRedemptionIdentityProviderConfiguration[(Any) <Object>]: This indicates any property can be added to this object.[FallbackIdentityProvider <String>]: b2bIdentityProvidersType[PrimaryIdentityProviderPrecedenceOrder <String-[]>]: Collection of identity providers in priority order of preference to be used for guest invitation redemption. Possible values are: azureActiveDirectory, externalFederation, or socialIdentityProviders.
[IsServiceDefault <Boolean?>]: If true, the default configuration is set to the system default configuration. If false, the default settings are customized.
[Partners <IMicrosoftGraphCrossTenantAccessPolicyConfigurationPartner-[]>]: Defines partner-specific configurations for external Microsoft Entra organizations.[AutomaticUserConsentSettings <IMicrosoftGraphInboundOutboundPolicyConfiguration>]: inboundOutboundPolicyConfiguration[B2BCollaborationInbound <IMicrosoftGraphCrossTenantAccessPolicyB2BSetting>]: crossTenantAccessPolicyB2BSetting[B2BCollaborationOutbound <IMicrosoftGraphCrossTenantAccessPolicyB2BSetting>]: crossTenantAccessPolicyB2BSetting[B2BDirectConnectInbound <IMicrosoftGraphCrossTenantAccessPolicyB2BSetting>]: crossTenantAccessPolicyB2BSetting[B2BDirectConnectOutbound <IMicrosoftGraphCrossTenantAccessPolicyB2BSetting>]: crossTenantAccessPolicyB2BSetting[IdentitySynchronization <IMicrosoftGraphCrossTenantIdentitySyncPolicyPartner>]: crossTenantIdentitySyncPolicyPartner[(Any) <Object>]: This indicates any property can be added to this object.[DisplayName <String>]: Display name for the cross-tenant user synchronization policy. Use the name of the partner Microsoft Entra tenant to easily identify the policy. Optional.[TenantId <String>]: Tenant identifier for the partner Microsoft Entra organization. Read-only.[UserSyncInbound <IMicrosoftGraphCrossTenantUserSyncInbound>]: crossTenantUserSyncInbound[(Any) <Object>]: This indicates any property can be added to this object.[IsSyncAllowed <Boolean?>]: Defines whether user objects should be synchronized from the partner tenant. false causes any current user synchronization from the source tenant to the target tenant to stop. This property has no impact on existing users who have already been synchronized.
[InboundTrust <IMicrosoftGraphCrossTenantAccessPolicyInboundTrust>]: crossTenantAccessPolicyInboundTrust[IsServiceProvider <Boolean?>]: Identifies whether the partner-specific configuration is a Cloud Service Provider for your organization.[TenantId <String>]: The tenant identifier for the partner Microsoft Entra organization. Read-only. Key.
DEFAULT <IMicrosoftGraphCrossTenantAccessPolicyConfigurationDefault>: crossTenantAccessPolicyConfigurationDefault
[(Any) <Object>]: This indicates any property can be added to this object.[Id <String>]: The unique identifier for an entity. Read-only.[AutomaticUserConsentSettings <IMicrosoftGraphInboundOutboundPolicyConfiguration>]: inboundOutboundPolicyConfiguration[(Any) <Object>]: This indicates any property can be added to this object.[InboundAllowed <Boolean?>]: Defines whether external users coming inbound are allowed.[OutboundAllowed <Boolean?>]: Defines whether internal users are allowed to go outbound.
[B2BCollaborationInbound <IMicrosoftGraphCrossTenantAccessPolicyB2BSetting>]: crossTenantAccessPolicyB2BSetting[(Any) <Object>]: This indicates any property can be added to this object.[Applications <IMicrosoftGraphCrossTenantAccessPolicyTargetConfiguration>]: crossTenantAccessPolicyTargetConfiguration[(Any) <Object>]: This indicates any property can be added to this object.[AccessType <String>]: crossTenantAccessPolicyTargetConfigurationAccessType[Targets <IMicrosoftGraphCrossTenantAccessPolicyTarget-[]>]: Specifies whether to target users, groups, or applications with this rule.[Target <String>]: The unique identifier of the user, group, or application; one of the following keywords: AllUsers and AllApplications; or for targets that are applications, you may use reserved values.[TargetType <String>]: crossTenantAccessPolicyTargetType
[UsersAndGroups <IMicrosoftGraphCrossTenantAccessPolicyTargetConfiguration>]: crossTenantAccessPolicyTargetConfiguration
[B2BCollaborationOutbound <IMicrosoftGraphCrossTenantAccessPolicyB2BSetting>]: crossTenantAccessPolicyB2BSetting[B2BDirectConnectInbound <IMicrosoftGraphCrossTenantAccessPolicyB2BSetting>]: crossTenantAccessPolicyB2BSetting[B2BDirectConnectOutbound <IMicrosoftGraphCrossTenantAccessPolicyB2BSetting>]: crossTenantAccessPolicyB2BSetting[InboundTrust <IMicrosoftGraphCrossTenantAccessPolicyInboundTrust>]: crossTenantAccessPolicyInboundTrust[(Any) <Object>]: This indicates any property can be added to this object.[IsCompliantDeviceAccepted <Boolean?>]: Specifies whether compliant devices from external Microsoft Entra organizations are trusted.[IsHybridAzureAdJoinedDeviceAccepted <Boolean?>]: Specifies whether Microsoft Entra hybrid joined devices from external Microsoft Entra organizations are trusted.[IsMfaAccepted <Boolean?>]: Specifies whether MFA from external Microsoft Entra organizations is trusted.
[InvitationRedemptionIdentityProviderConfiguration <IMicrosoftGraphDefaultInvitationRedemptionIdentityProviderConfiguration>]: defaultInvitationRedemptionIdentityProviderConfiguration[(Any) <Object>]: This indicates any property can be added to this object.[FallbackIdentityProvider <String>]: b2bIdentityProvidersType[PrimaryIdentityProviderPrecedenceOrder <String-[]>]: Collection of identity providers in priority order of preference to be used for guest invitation redemption. Possible values are: azureActiveDirectory, externalFederation, or socialIdentityProviders.
[IsServiceDefault <Boolean?>]: If true, the default configuration is set to the system default configuration. If false, the default settings are customized.
PARTNERS <IMicrosoftGraphCrossTenantAccessPolicyConfigurationPartner- []>: Defines partner-specific configurations for external Microsoft Entra organizations.
[AutomaticUserConsentSettings <IMicrosoftGraphInboundOutboundPolicyConfiguration>]: inboundOutboundPolicyConfiguration[(Any) <Object>]: This indicates any property can be added to this object.[InboundAllowed <Boolean?>]: Defines whether external users coming inbound are allowed.[OutboundAllowed <Boolean?>]: Defines whether internal users are allowed to go outbound.
[B2BCollaborationInbound <IMicrosoftGraphCrossTenantAccessPolicyB2BSetting>]: crossTenantAccessPolicyB2BSetting[(Any) <Object>]: This indicates any property can be added to this object.[Applications <IMicrosoftGraphCrossTenantAccessPolicyTargetConfiguration>]: crossTenantAccessPolicyTargetConfiguration[(Any) <Object>]: This indicates any property can be added to this object.[AccessType <String>]: crossTenantAccessPolicyTargetConfigurationAccessType[Targets <IMicrosoftGraphCrossTenantAccessPolicyTarget-[]>]: Specifies whether to target users, groups, or applications with this rule.[Target <String>]: The unique identifier of the user, group, or application; one of the following keywords: AllUsers and AllApplications; or for targets that are applications, you may use reserved values.[TargetType <String>]: crossTenantAccessPolicyTargetType
[UsersAndGroups <IMicrosoftGraphCrossTenantAccessPolicyTargetConfiguration>]: crossTenantAccessPolicyTargetConfiguration
[B2BCollaborationOutbound <IMicrosoftGraphCrossTenantAccessPolicyB2BSetting>]: crossTenantAccessPolicyB2BSetting[B2BDirectConnectInbound <IMicrosoftGraphCrossTenantAccessPolicyB2BSetting>]: crossTenantAccessPolicyB2BSetting[B2BDirectConnectOutbound <IMicrosoftGraphCrossTenantAccessPolicyB2BSetting>]: crossTenantAccessPolicyB2BSetting[IdentitySynchronization <IMicrosoftGraphCrossTenantIdentitySyncPolicyPartner>]: crossTenantIdentitySyncPolicyPartner[(Any) <Object>]: This indicates any property can be added to this object.[DisplayName <String>]: Display name for the cross-tenant user synchronization policy. Use the name of the partner Microsoft Entra tenant to easily identify the policy. Optional.[TenantId <String>]: Tenant identifier for the partner Microsoft Entra organization. Read-only.[UserSyncInbound <IMicrosoftGraphCrossTenantUserSyncInbound>]: crossTenantUserSyncInbound[(Any) <Object>]: This indicates any property can be added to this object.[IsSyncAllowed <Boolean?>]: Defines whether user objects should be synchronized from the partner tenant. false causes any current user synchronization from the source tenant to the target tenant to stop. This property has no impact on existing users who have already been synchronized.
[InboundTrust <IMicrosoftGraphCrossTenantAccessPolicyInboundTrust>]: crossTenantAccessPolicyInboundTrust[(Any) <Object>]: This indicates any property can be added to this object.[IsCompliantDeviceAccepted <Boolean?>]: Specifies whether compliant devices from external Microsoft Entra organizations are trusted.[IsHybridAzureAdJoinedDeviceAccepted <Boolean?>]: Specifies whether Microsoft Entra hybrid joined devices from external Microsoft Entra organizations are trusted.[IsMfaAccepted <Boolean?>]: Specifies whether MFA from external Microsoft Entra organizations is trusted.
[IsServiceProvider <Boolean?>]: Identifies whether the partner-specific configuration is a Cloud Service Provider for your organization.[TenantId <String>]: The tenant identifier for the partner Microsoft Entra organization. Read-only. Key.
RELATED LINKS
https://learn.microsoft.com/graph/api/crosstenantaccesspolicy-update?view=graph-rest-1.0