New-MgPolicyCrossTenantAccessPolicyPartner
Create a new partner configuration in a cross-tenant access policy.
Note
To view the beta release of this cmdlet, view New-MgBetaPolicyCrossTenantAccessPolicyPartner
Syntax
CreateExpanded (Default)
New-MgPolicyCrossTenantAccessPolicyPartner
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-AutomaticUserConsentSettings <IMicrosoftGraphInboundOutboundPolicyConfiguration>]
[-B2BCollaborationInbound <IMicrosoftGraphCrossTenantAccessPolicyB2BSetting>]
[-B2BCollaborationOutbound <IMicrosoftGraphCrossTenantAccessPolicyB2BSetting>]
[-B2BDirectConnectInbound <IMicrosoftGraphCrossTenantAccessPolicyB2BSetting>]
[-B2BDirectConnectOutbound <IMicrosoftGraphCrossTenantAccessPolicyB2BSetting>]
[-IdentitySynchronization <IMicrosoftGraphCrossTenantIdentitySyncPolicyPartner>]
[-InboundTrust <IMicrosoftGraphCrossTenantAccessPolicyInboundTrust>]
[-IsInMultiTenantOrganization]
[-IsServiceProvider]
[-TenantId <String>]
[-TenantRestrictions <IMicrosoftGraphCrossTenantAccessPolicyTenantRestrictions>]
[-Headers <IDictionary>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Create
New-MgPolicyCrossTenantAccessPolicyPartner
-BodyParameter <IMicrosoftGraphCrossTenantAccessPolicyConfigurationPartner>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Create a new partner configuration in a cross-tenant access policy.
Permissions
| Permission type | Permissions (from least to most privileged) |
|---|---|
| Delegated (work or school account) | Policy.ReadWrite.CrossTenantAccess, |
| Delegated (personal Microsoft account) | Not supported |
| Application | Policy.ReadWrite.CrossTenantAccess, |
Examples
Example 1: Code snippet
Import-Module Microsoft.Graph.Identity.SignIns
$params = @{
tenantId = "3d0f5dec-5d3d-455c-8016-e2af1ae4d31a"
b2bDirectConnectOutbound = @{
usersAndGroups = @{
accessType = "blocked"
targets = @(
@{
target = "6f546279-4da5-4b53-a095-09ea0cef9971"
targetType = "group"
}
)
}
}
b2bDirectConnectInbound = @{
applications = @{
accessType = "allowed"
targets = @(
@{
target = "Office365"
targetType = "application"
}
)
}
}
}
New-MgPolicyCrossTenantAccessPolicyPartner -BodyParameter $params
This example shows how to use the New-MgPolicyCrossTenantAccessPolicyPartner Cmdlet.
Parameters
-AdditionalProperties
Additional Parameters
Parameter properties
| Type: | Hashtable |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
CreateExpanded
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-AutomaticUserConsentSettings
inboundOutboundPolicyConfiguration To construct, see NOTES section for AUTOMATICUSERCONSENTSETTINGS properties and create a hash table.
Parameter properties
| Type: | IMicrosoftGraphInboundOutboundPolicyConfiguration |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
CreateExpanded
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-B2BCollaborationInbound
crossTenantAccessPolicyB2BSetting To construct, see NOTES section for B2BCOLLABORATIONINBOUND properties and create a hash table.
Parameter properties
| Type: | IMicrosoftGraphCrossTenantAccessPolicyB2BSetting |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
CreateExpanded
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-B2BCollaborationOutbound
crossTenantAccessPolicyB2BSetting To construct, see NOTES section for B2BCOLLABORATIONOUTBOUND properties and create a hash table.
Parameter properties
| Type: | IMicrosoftGraphCrossTenantAccessPolicyB2BSetting |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
CreateExpanded
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-B2BDirectConnectInbound
crossTenantAccessPolicyB2BSetting To construct, see NOTES section for B2BDIRECTCONNECTINBOUND properties and create a hash table.
Parameter properties
| Type: | IMicrosoftGraphCrossTenantAccessPolicyB2BSetting |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
CreateExpanded
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-B2BDirectConnectOutbound
crossTenantAccessPolicyB2BSetting To construct, see NOTES section for B2BDIRECTCONNECTOUTBOUND properties and create a hash table.
Parameter properties
| Type: | IMicrosoftGraphCrossTenantAccessPolicyB2BSetting |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
CreateExpanded
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-BodyParameter
crossTenantAccessPolicyConfigurationPartner To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
Parameter properties
| Type: | IMicrosoftGraphCrossTenantAccessPolicyConfigurationPartner |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Create
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Headers
Optional headers that will be added to the request.
Parameter properties
| Type: | IDictionary |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-IdentitySynchronization
crossTenantIdentitySyncPolicyPartner To construct, see NOTES section for IDENTITYSYNCHRONIZATION properties and create a hash table.
Parameter properties
| Type: | IMicrosoftGraphCrossTenantIdentitySyncPolicyPartner |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
CreateExpanded
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InboundTrust
crossTenantAccessPolicyInboundTrust To construct, see NOTES section for INBOUNDTRUST properties and create a hash table.
Parameter properties
| Type: | IMicrosoftGraphCrossTenantAccessPolicyInboundTrust |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
CreateExpanded
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-IsInMultiTenantOrganization
Identifies whether a tenant is a member of a multitenant organization.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
CreateExpanded
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-IsServiceProvider
Identifies whether the partner-specific configuration is a Cloud Service Provider for your organization.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
CreateExpanded
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ResponseHeadersVariable
Optional Response Headers Variable.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | RHV |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TenantId
The tenant identifier for the partner Microsoft Entra organization. Read-only. Key.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
CreateExpanded
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TenantRestrictions
crossTenantAccessPolicyTenantRestrictions To construct, see NOTES section for TENANTRESTRICTIONS properties and create a hash table.
Parameter properties
| Type: | IMicrosoftGraphCrossTenantAccessPolicyTenantRestrictions |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
CreateExpanded
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
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.IMicrosoftGraphCrossTenantAccessPolicyConfigurationPartner
System.Collections.IDictionary
Outputs
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphCrossTenantAccessPolicyConfigurationPartner
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.
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>]: Defines the target for cross-tenant access policy settings and can have one of the following values: The unique identifier of the user, group, or application AllUsers AllApplications - Refers to any Microsoft cloud application. Office365 - Includes the applications mentioned as part of the Office 365 suite.[TargetType <String>]: crossTenantAccessPolicyTargetType
[UsersAndGroups <IMicrosoftGraphCrossTenantAccessPolicyTargetConfiguration>]: crossTenantAccessPolicyTargetConfiguration
B2BCOLLABORATIONOUTBOUND <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>]: Defines the target for cross-tenant access policy settings and can have one of the following values: The unique identifier of the user, group, or application AllUsers AllApplications - Refers to any Microsoft cloud application. Office365 - Includes the applications mentioned as part of the Office 365 suite.[TargetType <String>]: crossTenantAccessPolicyTargetType
[UsersAndGroups <IMicrosoftGraphCrossTenantAccessPolicyTargetConfiguration>]: crossTenantAccessPolicyTargetConfiguration
B2BDIRECTCONNECTINBOUND <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>]: Defines the target for cross-tenant access policy settings and can have one of the following values: The unique identifier of the user, group, or application AllUsers AllApplications - Refers to any Microsoft cloud application. Office365 - Includes the applications mentioned as part of the Office 365 suite.[TargetType <String>]: crossTenantAccessPolicyTargetType
[UsersAndGroups <IMicrosoftGraphCrossTenantAccessPolicyTargetConfiguration>]: crossTenantAccessPolicyTargetConfiguration
B2BDIRECTCONNECTOUTBOUND <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>]: Defines the target for cross-tenant access policy settings and can have one of the following values: The unique identifier of the user, group, or application AllUsers AllApplications - Refers to any Microsoft cloud application. Office365 - Includes the applications mentioned as part of the Office 365 suite.[TargetType <String>]: crossTenantAccessPolicyTargetType
[UsersAndGroups <IMicrosoftGraphCrossTenantAccessPolicyTargetConfiguration>]: crossTenantAccessPolicyTargetConfiguration
BODYPARAMETER <IMicrosoftGraphCrossTenantAccessPolicyConfigurationPartner>: crossTenantAccessPolicyConfigurationPartner
[(Any) <Object>]: This indicates any property can be added to this object.[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>]: Defines the target for cross-tenant access policy settings and can have one of the following values: The unique identifier of the user, group, or application AllUsers AllApplications - Refers to any Microsoft cloud application. Office365 - Includes the applications mentioned as part of the Office 365 suite.[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.
[IsInMultiTenantOrganization <Boolean?>]: Identifies whether a tenant is a member of a multitenant organization.[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.[TenantRestrictions <IMicrosoftGraphCrossTenantAccessPolicyTenantRestrictions>]: crossTenantAccessPolicyTenantRestrictions[(Any) <Object>]: This indicates any property can be added to this object.[Applications <IMicrosoftGraphCrossTenantAccessPolicyTargetConfiguration>]: crossTenantAccessPolicyTargetConfiguration[UsersAndGroups <IMicrosoftGraphCrossTenantAccessPolicyTargetConfiguration>]: crossTenantAccessPolicyTargetConfiguration[Devices <IMicrosoftGraphDevicesFilter>]: devicesFilter[(Any) <Object>]: This indicates any property can be added to this object.[Mode <String>]: crossTenantAccessPolicyTargetConfigurationAccessType[Rule <String>]: Defines the rule to filter the devices. For example, device.deviceAttribute2 -eq 'PrivilegedAccessWorkstation'.
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.
TENANTRESTRICTIONS <IMicrosoftGraphCrossTenantAccessPolicyTenantRestrictions>: crossTenantAccessPolicyTenantRestrictions
[(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>]: Defines the target for cross-tenant access policy settings and can have one of the following values: The unique identifier of the user, group, or application AllUsers AllApplications - Refers to any Microsoft cloud application. Office365 - Includes the applications mentioned as part of the Office 365 suite.[TargetType <String>]: crossTenantAccessPolicyTargetType
[UsersAndGroups <IMicrosoftGraphCrossTenantAccessPolicyTargetConfiguration>]: crossTenantAccessPolicyTargetConfiguration[Devices <IMicrosoftGraphDevicesFilter>]: devicesFilter[(Any) <Object>]: This indicates any property can be added to this object.[Mode <String>]: crossTenantAccessPolicyTargetConfigurationAccessType[Rule <String>]: Defines the rule to filter the devices. For example, device.deviceAttribute2 -eq 'PrivilegedAccessWorkstation'.