Skip to content

Latest commit

 

History

History
527 lines (438 loc) · 22.2 KB

New-MgBetaPolicyCrossTenantAccessPolicyPartner.md

File metadata and controls

527 lines (438 loc) · 22.2 KB
Raw
external help file Module Name online version schema
Microsoft.Graph.Beta.Identity.SignIns-help.xml
Microsoft.Graph.Beta.Identity.SignIns
2.0.0

New-MgBetaPolicyCrossTenantAccessPolicyPartner

SYNOPSIS

Create a new partner configuration in a cross-tenant access policy.

Note

To view the v1.0 release of this cmdlet, view New-MgPolicyCrossTenantAccessPolicyPartner

SYNTAX

CreateExpanded (Default)

New-MgBetaPolicyCrossTenantAccessPolicyPartner [-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>]
 [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

Create

New-MgBetaPolicyCrossTenantAccessPolicyPartner
 -BodyParameter <IMicrosoftGraphCrossTenantAccessPolicyConfigurationPartner>
 [-ResponseHeadersVariable <String>] [-Headers <IDictionary>] [-ProgressAction <ActionPreference>] [-WhatIf]
 [-Confirm] [<CommonParameters>]

DESCRIPTION

Create a new partner configuration in a cross-tenant access policy.

EXAMPLES

Example 1: Code snippet

Import-Module Microsoft.Graph.Beta.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-MgBetaPolicyCrossTenantAccessPolicyPartner -BodyParameter $params

This example shows how to use the New-MgBetaPolicyCrossTenantAccessPolicyPartner Cmdlet.

To learn about permissions for this resource, see the permissions reference.

PARAMETERS

-AdditionalProperties

Additional Parameters

Type: Hashtable
Parameter Sets: CreateExpanded
Aliases:

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

-AutomaticUserConsentSettings

inboundOutboundPolicyConfiguration To construct, see NOTES section for AUTOMATICUSERCONSENTSETTINGS properties and create a hash table.

Type: IMicrosoftGraphInboundOutboundPolicyConfiguration
Parameter Sets: CreateExpanded
Aliases:

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

-B2BCollaborationInbound

crossTenantAccessPolicyB2BSetting To construct, see NOTES section for B2BCOLLABORATIONINBOUND properties and create a hash table.

Type: IMicrosoftGraphCrossTenantAccessPolicyB2BSetting
Parameter Sets: CreateExpanded
Aliases:

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

-B2BCollaborationOutbound

crossTenantAccessPolicyB2BSetting To construct, see NOTES section for B2BCOLLABORATIONOUTBOUND properties and create a hash table.

Type: IMicrosoftGraphCrossTenantAccessPolicyB2BSetting
Parameter Sets: CreateExpanded
Aliases:

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

-B2BDirectConnectInbound

crossTenantAccessPolicyB2BSetting To construct, see NOTES section for B2BDIRECTCONNECTINBOUND properties and create a hash table.

Type: IMicrosoftGraphCrossTenantAccessPolicyB2BSetting
Parameter Sets: CreateExpanded
Aliases:

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

-B2BDirectConnectOutbound

crossTenantAccessPolicyB2BSetting To construct, see NOTES section for B2BDIRECTCONNECTOUTBOUND properties and create a hash table.

Type: IMicrosoftGraphCrossTenantAccessPolicyB2BSetting
Parameter Sets: CreateExpanded
Aliases:

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

-BodyParameter

crossTenantAccessPolicyConfigurationPartner To construct, see NOTES section for BODYPARAMETER properties and create a hash table.

Type: IMicrosoftGraphCrossTenantAccessPolicyConfigurationPartner
Parameter Sets: Create
Aliases:

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

-Headers

Optional headers that will be added to the request.

Type: IDictionary
Parameter Sets: (All)
Aliases:

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

-IdentitySynchronization

crossTenantIdentitySyncPolicyPartner To construct, see NOTES section for IDENTITYSYNCHRONIZATION properties and create a hash table.

Type: IMicrosoftGraphCrossTenantIdentitySyncPolicyPartner
Parameter Sets: CreateExpanded
Aliases:

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

-InboundTrust

crossTenantAccessPolicyInboundTrust To construct, see NOTES section for INBOUNDTRUST properties and create a hash table.

Type: IMicrosoftGraphCrossTenantAccessPolicyInboundTrust
Parameter Sets: CreateExpanded
Aliases:

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

-IsInMultiTenantOrganization

Identifies whether a tenant is a member of a multitenant organization.

Type: SwitchParameter
Parameter Sets: CreateExpanded
Aliases:

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

-IsServiceProvider

Identifies whether the partner-specific configuration is a Cloud Service Provider for your organization.

Type: SwitchParameter
Parameter Sets: CreateExpanded
Aliases:

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

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

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

-ResponseHeadersVariable

Optional Response Headers Variable.

Type: String
Parameter Sets: (All)
Aliases: RHV

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

-TenantId

The tenant identifier for the partner Microsoft Entra organization. Read-only. Key.

Type: String
Parameter Sets: CreateExpanded
Aliases:

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

-TenantRestrictions

crossTenantAccessPolicyTenantRestrictions To construct, see NOTES section for TENANTRESTRICTIONS properties and create a hash table.

Type: IMicrosoftGraphCrossTenantAccessPolicyTenantRestrictions
Parameter Sets: CreateExpanded
Aliases:

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphCrossTenantAccessPolicyConfigurationPartner

System.Collections.IDictionary

OUTPUTS

Microsoft.Graph.Beta.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>]: Can be 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 Office365 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>]: Can be 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 Office365 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>]: Can be 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 Office365 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>]: Can be 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 Office365 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>]: Can be 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 Office365 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>]: Can be 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 Office365 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'.

RELATED LINKS

https://learn.microsoft.com/powershell/module/microsoft.graph.beta.identity.signins/new-mgbetapolicycrosstenantaccesspolicypartner

https://learn.microsoft.com/graph/api/crosstenantaccesspolicy-post-partners?view=graph-rest-1.0