Microsoft.Entra.Beta.DirectoryManagement-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-EntraBetaAdministrativeUnitMember</command:name> <command:verb>Add</command:verb> <command:noun>EntraBetaAdministrativeUnitMember</command:noun> <maml:description> <maml:para>Adds an administrative unit member.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Add-EntraBetaAdministrativeUnitMember` cmdlet adds a Microsoft Entra ID administrative unit member.</maml:para> <maml:para>Administrative units enable more granular management of permissions and access, particularly in large organizations or where administrative responsibilities are divided across departments or regions.</maml:para> <maml:para>To add a user, group, or device to an administrative unit, the calling principal must be assigned at least the Privileged Role Administrator Microsoft Entra role.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-EntraBetaAdministrativeUnitMember</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>AdministrativeUnitId</maml:name> <maml:description> <maml:para>Specifies the ID of a Microsoft Entra ID administrative unit.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>RefObjectId</maml:name> <maml:description> <maml:para>Specifies the unique ID of the specific Microsoft Entra ID object that is assigned as owner/manager/member.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>AdministrativeUnitId</maml:name> <maml:description> <maml:para>Specifies the ID of a Microsoft Entra ID administrative unit.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>RefObjectId</maml:name> <maml:description> <maml:para>Specifies the unique ID of the specific Microsoft Entra ID object that is assigned as owner/manager/member.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1: Add an administrative unit member ---------</maml:title> <dev:code>Connect-Entra -Scopes 'AdministrativeUnit.ReadWrite.All' $administrativeUnit = Get-EntraBetaAdministrativeUnit -Filter "DisplayName eq '<administrativeunit-display-name>'" $user = Get-EntraBetaUser -UserId 'SawyerM@contoso.com' Add-EntraBetaAdministrativeUnitMember -AdministrativeUnitId $administrativeUnit.Id -RefObjectId $user.Id</dev:code> <dev:remarks> <maml:para>This example demonstrates adding an administrative unit member. Use `Get-EntraBetaAdministrativeUnit` to find the administrative unit ID and `Get-EntraBetaUser` to find the user ID.</maml:para> <maml:para>- `AdministrativeUnitId` parameter specifies the ID of an administrative unit.</maml:para> <maml:para>- `RefObjectId` parameter specifies the ID of the user or group you want to add as a member of the administrative unit.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Add-EntraBetaAdministrativeUnitMember</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaAdministrativeUnitMember</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaAdministrativeUnitMember</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-EntraBetaAdministrativeUnit</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-EntraBetaCustomSecurityAttributeDefinitionAllowedValue</command:name> <command:verb>Add</command:verb> <command:noun>EntraBetaCustomSecurityAttributeDefinitionAllowedValue</command:noun> <maml:description> <maml:para>Adds a predefined value for a custom security attribute definition.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Add-EntraBetaCustomSecurityAttributeDefinitionAllowedValue` adds a predefined value for a Microsoft Entra ID custom security attribute definition.</maml:para> <maml:para>In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role or a custom role with the necessary permissions. The Attribute Definition Administrator is the only privileged role supported for this operation.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-EntraBetaCustomSecurityAttributeDefinitionAllowedValue</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>CustomSecurityAttributeDefinitionId</maml:name> <maml:description> <maml:para>The unique identifier for a custom security attribute definition in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The unique identifier for the predefined value, which can be up to 64 characters long and include Unicode characters. Spaces are allowed, but some special characters aren't. This identifier is case sensitive, can't be changed later, and is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsActive</maml:name> <maml:description> <maml:para>Indicates whether the predefined value is active or deactivated. If set to false, this predefined value can't be assigned to any another supported directory objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>CustomSecurityAttributeDefinitionId</maml:name> <maml:description> <maml:para>The unique identifier for a custom security attribute definition in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The unique identifier for the predefined value, which can be up to 64 characters long and include Unicode characters. Spaces are allowed, but some special characters aren't. This identifier is case sensitive, can't be changed later, and is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsActive</maml:name> <maml:description> <maml:para>Indicates whether the predefined value is active or deactivated. If set to false, this predefined value can't be assigned to any another supported directory objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>`Add-EntraBetaCustomSecurityAttributeDefinitionAllowedValues` is an alias for `Add-EntraBetaCustomSecurityAttributeDefinitionAllowedValue`.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Add a predefined value for a Microsoft Entra ID custom security attribute definition</maml:title> <dev:code>Connect-Entra -Scopes 'CustomSecAttributeDefinition.ReadWrite.All' $CustomSecurityAttributeDefinitionId = (Get-EntraBetaCustomSecurityAttributeDefinition -Id '<attributename_attributedefinition>').Id $params = @{ CustomSecurityAttributeDefinitionId = $CustomSecurityAttributeDefinitionId Id = 'Alpine' IsActive = $true } Add-EntraBetaCustomSecurityAttributeDefinitionAllowedValue @params Id IsActive -- -------- Alpine True</dev:code> <dev:remarks> <maml:para>This example adds a predefined value to a custom security attribute definition.</maml:para> <maml:para>- `-CustomSecurityAttributeDefinitionId` parameter specifies the custom security attribute definition ID. You can use the command `Get-EntraBetaCustomSecurityAttributeDefinition` to get the ID.</maml:para> <maml:para>- `-Id` parameter specifies the identifier for the predefined value.</maml:para> <maml:para>- `-IsActive` parameter specifies the predefined value is active or deactivated.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Add-EntraBetaCustomSecurityAttributeDefinitionAllowedValue</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaCustomSecurityAttributeDefinitionAllowedValue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-EntraBetaCustomSecurityAttributeDefinitionAllowedValue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-EntraBetaDeviceRegisteredOwner</command:name> <command:verb>Add</command:verb> <command:noun>EntraBetaDeviceRegisteredOwner</command:noun> <maml:description> <maml:para>Adds a registered owner for a device.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Add-EntraBetaDeviceRegisteredOwner` cmdlet adds a registered owner for a Microsoft Entra ID device.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-EntraBetaDeviceRegisteredOwner</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>DeviceId</maml:name> <maml:description> <maml:para>Specifies the ID of the device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>RefObjectId</maml:name> <maml:description> <maml:para>Specifies the ID of the Microsoft Entra ID object to add.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>DeviceId</maml:name> <maml:description> <maml:para>Specifies the ID of the device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>RefObjectId</maml:name> <maml:description> <maml:para>Specifies the ID of the Microsoft Entra ID object to add.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1: Add a user as a registered owner ---------</maml:title> <dev:code>Connect-Entra -Scopes 'Device.ReadWrite.All' $User = Get-EntraBetaUser -UserId 'SawyerM@contoso.com' $Device = Get-EntraBetaDevice -SearchString '<device-display-name>' $params = @{ DeviceId = $Device.ObjectId RefObjectId = $User.ObjectId } Add-EntraBetaDeviceRegisteredOwner @params</dev:code> <dev:remarks> <maml:para>This example shows how to add a registered owner to a device.</maml:para> <maml:para>`-DeviceId` parameter specifies the unique identifier (Object ID) of the device to which you want to add a registered owner. The $Device.ObjectId variable should contain the Object ID of the device. You can use the command `Get-EntraBetaDevice` to get device Id.</maml:para> <maml:para>`-RefObjectId` parameter specifies the unique identifier (Object ID) of the user who will be added as a registered owner of the device. The $User.ObjectId variable should contain the Object ID of the user. You can use the command `Get-EntraBetaUser` to get user Id.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Add-EntraBetaDeviceRegisteredOwner</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaDeviceRegisteredOwner</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaDeviceRegisteredOwner</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-EntraBetaDeviceRegisteredUser</command:name> <command:verb>Add</command:verb> <command:noun>EntraBetaDeviceRegisteredUser</command:noun> <maml:description> <maml:para>Adds a registered user for a device.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Add-EntraBetaDeviceRegisteredUser` cmdlet adds a registered user for a Microsoft Entra ID device.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-EntraBetaDeviceRegisteredUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>DeviceId</maml:name> <maml:description> <maml:para>Specifies the ID of the device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>RefObjectId</maml:name> <maml:description> <maml:para>Specifies the ID of the user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>DeviceId</maml:name> <maml:description> <maml:para>Specifies the ID of the device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>RefObjectId</maml:name> <maml:description> <maml:para>Specifies the ID of the user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---------- Example 1: Add a user as a registered user ----------</maml:title> <dev:code>Connect-Entra -Scopes 'Device.ReadWrite.All' $User = Get-EntraBetaUser -UserId 'SawyerM@contoso.com' $Device = Get-EntraBetaDevice -SearchString '<device-display-name>' $params = @{ DeviceId = $Device.ObjectId RefObjectId = $User.ObjectId } Add-EntraBetaDeviceRegisteredUser @params</dev:code> <dev:remarks> <maml:para>This example shows how to add a registered user to a device.</maml:para> <maml:para>- `-DeviceId` parameter specifies the unique identifier (Object ID) of the device to which you want to add a registered user. The $Device.ObjectId variable should contain the Object ID of the device. You can use the command `Get-EntraBetaDevice` to get device Id.</maml:para> <maml:para>- `-RefObjectId` parameter specifies the unique identifier (Object ID) of the user who will be added as a registered user of the device. The $User.ObjectId variable should contain the Object ID of the user. You can use the command `Get-EntraBetaUser` to get user Id.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Add-EntraBetaDeviceRegisteredUser</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaDeviceRegisteredUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaDeviceRegisteredUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-EntraBetaDirectoryRoleMember</command:name> <command:verb>Add</command:verb> <command:noun>EntraBetaDirectoryRoleMember</command:noun> <maml:description> <maml:para>Adds a member to a directory role.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Add-EntraBetaDirectoryRoleMember` cmdlet adds a member to a Microsoft Entra ID role.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-EntraBetaDirectoryRoleMember</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>DirectoryRoleId</maml:name> <maml:description> <maml:para>Specifies the ID of a directory role in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>RefObjectId</maml:name> <maml:description> <maml:para>Specifies the ID of the Microsoft Entra ID object to assign as owner/manager/member.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>DirectoryRoleId</maml:name> <maml:description> <maml:para>Specifies the ID of a directory role in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>RefObjectId</maml:name> <maml:description> <maml:para>Specifies the ID of the Microsoft Entra ID object to assign as owner/manager/member.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----- Example 1: Add a member to a Microsoft Entra ID role -----</maml:title> <dev:code>Connect-Entra -Scopes 'RoleManagement.ReadWrite.Directory' $params = @{ DirectoryRoleId = '019ea7a2-1613-47c9-81cb-20ba35b1ae48' RefObjectId = 'bbbbbbbb-1111-2222-3333-cccccccccccc' } Add-EntraBetaDirectoryRoleMember @params</dev:code> <dev:remarks> <maml:para>This example adds a member to a directory role.</maml:para> <maml:para>- `DirectoryRoleId` parameter specifies the ID of the directory role to which the member will be added. Use the `Get-EntraBetaDirectoryRole` command to retrieve the details of the directory role.</maml:para> <maml:para>- `RefObjectId` parameter specifies the ID of Microsoft Entra ID object to assign as owner/manager/member.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Add-EntraBetaDirectoryRoleMember</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaDirectoryRoleMember</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaDirectoryRoleMember</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-EntraBetaScopedRoleMembership</command:name> <command:verb>Add</command:verb> <command:noun>EntraBetaScopedRoleMembership</command:noun> <maml:description> <maml:para>Assign a Microsoft Entra role with an administrative unit scope.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Add-EntraBetaScopedRoleMembership` cmdlet adds a scoped role membership to an administrative unit. Specify `AdministrativeUnitId` parameter to add a scoped role membership.</maml:para> <maml:para>For delegated scenarios, the calling user needs at least the Privileged Role Administrator Microsoft Entra role.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-EntraBetaScopedRoleMembership</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>AdministrativeUnitId</maml:name> <maml:description> <maml:para>Specifies the ID of an administrative unit.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RoleMemberInfo</maml:name> <maml:description> <maml:para>Specifies a RoleMemberInfo object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.RoleMemberInfo</command:parameterValue> <dev:type> <maml:name>System.RoleMemberInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RoleObjectId</maml:name> <maml:description> <maml:para>Specifies DirectoryRole ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>AdministrativeUnitId</maml:name> <maml:description> <maml:para>Specifies the ID of an administrative unit.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RoleMemberInfo</maml:name> <maml:description> <maml:para>Specifies a RoleMemberInfo object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.RoleMemberInfo</command:parameterValue> <dev:type> <maml:name>System.RoleMemberInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RoleObjectId</maml:name> <maml:description> <maml:para>Specifies DirectoryRole ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Add a scoped role membership to an administrative unit</maml:title> <dev:code>Connect-Entra -Scopes 'RoleManagement.ReadWrite.Directory' $user = Get-EntraBetaUser -UserId 'SawyerM@contoso.com' $role = Get-EntraBetaDirectoryRole -Filter "DisplayName eq 'Helpdesk Administrator'" $administrativeUnit = Get-EntraBetaAdministrativeUnit -Filter "DisplayName eq 'Pacific Administrative Unit'" $roleMember = New-Object -TypeName Microsoft.Open.MSGraph.Model.MsRoleMemberInfo $roleMember.Id = $user.Id Add-EntraBetaScopedRoleMembership -AdministrativeUnitId $administrativeUnit.Id -RoleObjectId $role.Id -RoleMemberInfo $roleMember Id AdministrativeUnitId RoleId -- -------------------- ------ dddddddddddd-bbbb-aaaa-bbbb-cccccccccccc aaaaaaaa-bbbb-aaaa-bbbb-cccccccccccc bbbbbbbb-1111-2222-3333-cccccccccccc</dev:code> <dev:remarks> <maml:para>The example shows how to add a user to the specified role within the specified administrative unit.</maml:para> <maml:para>- `-AdministrativeUnitId` Parameter specifies the ID of an administrative unit.</maml:para> <maml:para>- `-RoleObjectId` Parameter specifies the ID of a directory role.</maml:para> <maml:para>- `-RoleMemberInfo` Parameter specifies a RoleMemberInfo object.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Add-EntraBetaScopedRoleMembership</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaScopedRoleMembership</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaScopedRoleMembership</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Confirm-EntraBetaDomain</command:name> <command:verb>Confirm</command:verb> <command:noun>EntraBetaDomain</command:noun> <maml:description> <maml:para>Validate the ownership of a domain.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Confirm-EntraBetaDomain` cmdlet validates the ownership of an Microsoft Entra ID domain.</maml:para> <maml:para>The work or school account needs to belong to at least the Domain Name Administrator Microsoft Entra role.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Confirm-EntraBetaDomain</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>Specifies the name of the domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ForceTakeover</maml:name> <maml:description> <maml:para>Used for external admin takeover of an unmanaged domain. The default value for this parameter is `false`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>Specifies the name of the domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ForceTakeover</maml:name> <maml:description> <maml:para>Used for external admin takeover of an unmanaged domain. The default value for this parameter is `false`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---------------- Example 1: Confirm the domain ----------------</maml:title> <dev:code>Connect-Entra -Scopes 'Domain.ReadWrite.All' Confirm-EntraBetaDomain -DomainName Contoso.com</dev:code> <dev:remarks> <maml:para>- `DomainName` Specifies the fully qualified domain name to retrieve.</maml:para> <maml:para>This example verifies a domain and updates its status to `verified`.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------- Example 2: External admin takeover of a domain --------</maml:title> <dev:code>Connect-Entra -Scopes 'Domain.ReadWrite.All' Confirm-EntraBetaDomain -DomainName Contoso.com -ForceTakeover $True</dev:code> <dev:remarks> <maml:para>This example illustrates how to confirm a domain when an external administrator needs to assume control of an unmanaged domain.</maml:para> <maml:para>- `DomainName` specifies the fully qualified domain name to retrieve.</maml:para> <maml:para>- `ForceTakeover` specifies whether to forcibly take control of an unmanaged domain associated with a tenant.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Confirm-EntraBetaDomain</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Enable-EntraBetaDirectoryRole</command:name> <command:verb>Enable</command:verb> <command:noun>EntraBetaDirectoryRole</command:noun> <maml:description> <maml:para>Activates an existing directory role in Microsoft Entra ID.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Enable-EntraBetaDirectoryRole` cmdlet activates an existing directory role in Microsoft Entra ID.</maml:para> <maml:para>The Company Administrators and the default user directory roles (User, Guest User, and Restricted Guest User) are activated by default. To access and assign members to other directory roles, you must first activate them using their corresponding directory role template ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-EntraBetaDirectoryRole</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RoleTemplateId</maml:name> <maml:description> <maml:para>The ID of the Role template to enable.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RoleTemplateId</maml:name> <maml:description> <maml:para>The ID of the Role template to enable.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------- Example 1: Enable a directory role --------------</maml:title> <dev:code>Connect-Entra -Scopes 'RoleManagement.ReadWrite.Directory' $InviterRole = Get-EntraBetaDirectoryRoleTemplate | Where-Object {$_.DisplayName -eq 'Guest Inviter'} Enable-EntraBetaDirectoryRole -RoleTemplateId $InviterRole.ObjectId DeletedDateTime Id Description DisplayName RoleTemplateId --------------- -- ----------- ----------- -------------- b5baa59b-86ab-4053-ac3a-0396116d1924 Guest Inviter has access to invite guest users. Guest Inviter 92ed04bf-c94a-4b82-9729-b799a7a4c178</dev:code> <dev:remarks> <maml:para>The example shows how to enable the directory role.</maml:para> <maml:para>You can use `Get-EntraBetaDirectoryRoleTemplate` to fetch a specific directory role to activate.</maml:para> <maml:para>- `RoleTemplateId` parameter specifies the ID of the role template to enable.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Enable-EntraBetaDirectoryRole</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaDirectoryRole</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaDirectoryRoleTemplate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaAccountSku</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaAccountSku</command:noun> <maml:description> <maml:para>Retrieves all the SKUs for a company.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaAccountSku` retrieves the list of commercial subscriptions acquired by an organization.</maml:para> <maml:para>For a list of license names in the Microsoft Entra or Microsoft 365 admin centers and their corresponding Microsoft Graph `skuId` and `skuPartNumber` properties, refer to the mapping information (https://learn.microsoft.com/entra/identity/users/licensing-service-plan-reference).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaAccountSku</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>The unique ID of the tenant to perform the operation on. If this isn't provided, then the value will default to the tenant of the current user. This parameter is only applicable to partner users.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>The unique ID of the tenant to perform the operation on. If this isn't provided, then the value will default to the tenant of the current user. This parameter is only applicable to partner users.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---------------- Example 1: Gets a list of SKUs ----------------</maml:title> <dev:code>Connect-Entra -Scopes 'Organization.Read.All' Get-EntraBetaAccountSku Id AccountId AccountName AppliesTo CapabilityStatus ConsumedUnits SkuId SkuPartNumber -- --------- ----------- --------- ---------------- ------------- ----- ------- eeeeeeee-4444-5555-6666-ffffffffffff aaaabbbb-0000-cccc-1111-dddd2222eeee Contoso-User User Suspended 20 aaaaaaaa-0b0b-1c1c-2d2d-333333333333 EMSPRE… ffffffff-5555-6666-7777-aaaaaaaaaaaa aaaabbbb-0000-cccc-1111-dddd2222eeee Contoso-User User Suspended 20 bbbbbbbb-1c1c-2d2d-3e3e-444444444444 ENTERP… dddddddd-3333-4444-5555-eeeeeeeeeeee aaaabbbb-0000-cccc-1111-dddd2222eeee Contoso-User User Suspended 2 cccccccc-2d2d-3e3e-4f4f-555555555555 ENTERP…</dev:code> <dev:remarks> <maml:para>This command returns a list of SKUs.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- Example 2: Gets a list of SKUs by TenantId ----------</maml:title> <dev:code>Connect-Entra -Scopes 'Organization.Read.All' Get-EntraBetaAccountSku -TenantId 'aaaabbbb-0000-cccc-1111-dddd2222eeee' Id AccountId AccountName AppliesTo CapabilityStatus ConsumedUnits SkuId SkuPartNumber -- --------- ----------- --------- ---------------- ------------- ----- ------- eeeeeeee-4444-5555-6666-ffffffffffff aaaabbbb-0000-cccc-1111-dddd2222eeee Contoso-User User Suspended 20 aaaaaaaa-0b0b-1c1c-2d2d-333333333333 EMSPRE… ffffffff-5555-6666-7777-aaaaaaaaaaaa aaaabbbb-0000-cccc-1111-dddd2222eeee Contoso-User User Suspended 20 bbbbbbbb-1c1c-2d2d-3e3e-444444444444 ENTERP… dddddddd-3333-4444-5555-eeeeeeeeeeee aaaabbbb-0000-cccc-1111-dddd2222eeee Contoso-User User Suspended 2 cccccccc-2d2d-3e3e-4f4f-555555555555 ENTERP…</dev:code> <dev:remarks> <maml:para>This command returns a list of SKUs for a specified tenant.</maml:para> <maml:para>- `-TenantId` parameter specifies the unique ID of the tenant.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaAccountSku</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaAdministrativeUnit</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaAdministrativeUnit</command:noun> <maml:description> <maml:para>Gets an administrative unit.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaAdministrativeUnit` cmdlet gets a Microsoft Entra ID administrative unit. Specify `AdministrativeUnitId` parameter to get a specific administrative unit.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaAdministrativeUnit</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies an OData v4.0 filter statement. This parameter filters which objects are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-EntraBetaAdministrativeUnit</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="Id"> <maml:name>AdministrativeUnitId</maml:name> <maml:description> <maml:para>Specifies the ID of an administrative unit in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies an OData v4.0 filter statement. This parameter filters which objects are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="Id"> <maml:name>AdministrativeUnitId</maml:name> <maml:description> <maml:para>Specifies the ID of an administrative unit in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----------- Example 1: Get all administrative units -----------</maml:title> <dev:code>Connect-Entra -Scopes 'AdministrativeUnit.Read.All' Get-EntraBetaAdministrativeUnit DeletedDateTime Id Description DisplayName IsMemberManagementRestricted Visibility --------------- -- ----------- ----------- ---------------------------- ---------- aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb Updated Description Updated DisplayName bbbbbbbb-1111-2222-3333-cccccccccccc test111 test111 cccccccc-2222-3333-4444-dddddddddddd TestAU dddddddd-3333-4444-5555-eeeeeeeeeeee test_130624_09 eeeeeeee-4444-5555-6666-ffffffffffff test111 test111 ffffffff-5555-6666-7777-aaaaaaaaaaaa test66 aaaaaaaa-6666-7777-8888-bbbbbbbbbbbb test111 test111 True</dev:code> <dev:remarks> <maml:para>This command gets all the administrative units.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Get all administrative units using '-All' parameter</maml:title> <dev:code>Connect-Entra -Scopes 'AdministrativeUnit.Read.All' Get-EntraBetaAdministrativeUnit -All DeletedDateTime Id Description DisplayName IsMemberManagementRestricted Visibility --------------- -- ----------- ----------- ---------------------------- ---------- aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb Updated Description Updated DisplayName bbbbbbbb-1111-2222-3333-cccccccccccc test111 test111 cccccccc-2222-3333-4444-dddddddddddd TestAU dddddddd-3333-4444-5555-eeeeeeeeeeee test_130624_09 eeeeeeee-4444-5555-6666-ffffffffffff test111 test111 ffffffff-5555-6666-7777-aaaaaaaaaaaa test66 aaaaaaaa-6666-7777-8888-bbbbbbbbbbbb test111 test111 True</dev:code> <dev:remarks> <maml:para>This command gets all the administrative units.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------- Example 3: Get a specific administrative unit --------</maml:title> <dev:code>Connect-Entra -Scopes 'AdministrativeUnit.Read.All' Get-EntraBetaAdministrativeUnit -AdministrativeUnitId 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb' DeletedDateTime Id Description DisplayName IsMemberManagementRestricted Visibility --------------- -- ----------- ----------- ---------------------------- ---------- aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb Updated Description Updated DisplayName</dev:code> <dev:remarks> <maml:para>This example returns the details of the specified administrative unit.</maml:para> <maml:para>- `-AdministrativeUnitId` parameter specifies the ID of an administrative unit.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-- Example 4: Get administrative units filter by display name --</maml:title> <dev:code>Connect-Entra -Scopes 'AdministrativeUnit.Read.All' Get-EntraBetaAdministrativeUnit -Filter "DisplayName eq 'Updated DisplayName'" DeletedDateTime Id Description DisplayName IsMemberManagementRestricted Visibility --------------- -- ----------- ----------- ---------------------------- ---------- aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb Updated Description Updated DisplayName</dev:code> <dev:remarks> <maml:para>This example list of administrative units containing display name with the specified name.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- Example 5: Get top one administrative unit ----------</maml:title> <dev:code>Connect-Entra -Scopes 'AdministrativeUnit.Read.All' Get-EntraBetaAdministrativeUnit -Top 1 DeletedDateTime Id Description DisplayName IsMemberManagementRestricted Visibility --------------- -- ----------- ----------- ---------------------------- ---------- aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb Updated Description Updated DisplayName</dev:code> <dev:remarks> <maml:para>This example returns the specified top administrative units.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaAdministrativeUnit</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-EntraBetaAdministrativeUnit</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaAdministrativeUnit</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-EntraBetaAdministrativeUnit</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaAdministrativeUnitMember</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaAdministrativeUnitMember</command:noun> <maml:description> <maml:para>Gets a member of an administrative unit.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaAdministrativeUnitMember` cmdlet gets a member of a Microsoft Entra ID administrative unit. Specify `AdministrativeUnitId` parameters to retrieve an administrative unit member.</maml:para> <maml:para>In delegated scenarios with work or school accounts, the signed-in user must either be a member user or be assigned a supported Microsoft Entra role, or a custom role with the necessary permissions. The following least privileged roles are supported for this operation:</maml:para> <maml:para>- Directory Readers: Read basic properties on administrative units</maml:para> <maml:para>- Global Reader: Read all properties of administrative units, including members</maml:para> <maml:para>- Privileged Role Administrator: Create and manage administrative units (including members)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaAdministrativeUnitMember</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>AdministrativeUnitId</maml:name> <maml:description> <maml:para>Specifies the ID of an administrative unit in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>AdministrativeUnitId</maml:name> <maml:description> <maml:para>Specifies the ID of an administrative unit in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Get an administrative unit member by AdministrativeUnitId</maml:title> <dev:code>Connect-Entra -Scopes 'AdministrativeUnit.ReadWrite.All' $administrativeUnit = Get-EntraBetaAdministrativeUnit -Filter "DisplayName eq '<administrativeunit-display-name>'" Get-EntraBetaAdministrativeUnitMember -AdministrativeUnitId $administrativeUnit.Id Id DeletedDateTime -- --------------- bbbbbbbb-1111-2222-3333-cccccccccccc cccccccc-2222-3333-4444-dddddddddddd dddddddd-3333-4444-5555-eeeeeeeeeeee eeeeeeee-4444-5555-6666-ffffffffffff ffffffff-5555-6666-7777-aaaaaaaaaaaa</dev:code> <dev:remarks> <maml:para>This example returns the list of administrative unit members from specified administrative unit ObjectId.</maml:para> <maml:para>- `-AdministrativeUnitId` parameter specifies the ID of an administrative unit.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Get all administrative unit members by AdministrativeUnitId</maml:title> <dev:code>Connect-Entra -Scopes 'AdministrativeUnit.ReadWrite.All' $administrativeUnit = Get-EntraBetaAdministrativeUnit -Filter "DisplayName eq '<administrativeunit-display-name>'" Get-EntraBetaAdministrativeUnitMember -AdministrativeUnitId $administrativeUnit.Id -All Id DeletedDateTime -- --------------- bbbbbbbb-1111-2222-3333-cccccccccccc cccccccc-2222-3333-4444-dddddddddddd dddddddd-3333-4444-5555-eeeeeeeeeeee eeeeeeee-4444-5555-6666-ffffffffffff ffffffff-5555-6666-7777-aaaaaaaaaaaa</dev:code> <dev:remarks> <maml:para>This example returns the list of all administrative unit members from specified administrative unit ObjectId.</maml:para> <maml:para>- `-AdministrativeUnitId` parameter specifies the ID of an administrative unit.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 3: Get top three administrative unit members by AdministrativeUnitId</maml:title> <dev:code>Connect-Entra -Scopes 'AdministrativeUnit.ReadWrite.All' $administrativeUnit = Get-EntraBetaAdministrativeUnit -Filter "DisplayName eq '<administrativeunit-display-name>'" Get-EntraBetaAdministrativeUnitMember -AdministrativeUnitId $administrativeUnit.Id -Top 3 Id DeletedDateTime -- --------------- bbbbbbbb-1111-2222-3333-cccccccccccc cccccccc-2222-3333-4444-dddddddddddd dddddddd-3333-4444-5555-eeeeeeeeeeee</dev:code> <dev:remarks> <maml:para>This example returns top three administrative unit members from specified administrative unit ObjectId.</maml:para> <maml:para>- `-AdministrativeUnitId` parameter specifies the ID of an administrative unit.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaAdministrativeUnitMember</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-EntraBetaAdministrativeUnitMember</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-EntraBetaAdministrativeUnitMember</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaAdministrativeUnitMember</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaAttributeSet</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaAttributeSet</command:noun> <maml:description> <maml:para>Gets a list of attribute sets.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraABetaAttributeSet` cmdlet gets a list of Microsoft Entra ID attribute sets.</maml:para> <maml:para>In delegated scenarios with work or school accounts, the signed-in user must have a supported Microsoft Entra role or a custom role with the necessary permissions. The supported roles for this operation are:</maml:para> <maml:para>- Attribute Assignment Reader</maml:para> <maml:para>- Attribute Definition Reader</maml:para> <maml:para>- Attribute Assignment Administrator</maml:para> <maml:para>- Attribute Definition Administrator</maml:para> <maml:para></maml:para> <maml:para>By default, other administrator roles cannot read, define, or assign custom security attributes.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaAttributeSet</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="Id"> <maml:name>AttributeSetId</maml:name> <maml:description> <maml:para>Unique identifier for the attribute set within a tenant. </maml:para> <maml:para>This identifier can be up to 32 characters long and may include Unicode characters. It cannot contain spaces or special characters, and it cannot be changed later. The identifier is case insensitive.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="Id"> <maml:name>AttributeSetId</maml:name> <maml:description> <maml:para>Unique identifier for the attribute set within a tenant. </maml:para> <maml:para>This identifier can be up to 32 characters long and may include Unicode characters. It cannot contain spaces or special characters, and it cannot be changed later. The identifier is case insensitive.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------- Example 1: Get an all attribute sets -------------</maml:title> <dev:code>Connect-Entra -Scopes 'CustomSecAttributeDefinition.ReadWrite.All' Get-EntraBetaAttributeSet Id Description MaxAttributesPerSet -- ----------- ------------------- Engineering Attributes for cloud engineering team 25 Contoso Attributes for Contoso 25</dev:code> <dev:remarks> <maml:para>This example returns all attribute sets.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>--------------- Example 2: Get an attribute sets ---------------</maml:title> <dev:code>Connect-Entra -Scopes 'CustomSecAttributeDefinition.ReadWrite.All' Get-EntraBetaAttributeSet -AttributeSetId 'Testing' Id Description MaxAttributesPerSet -- ----------- ------------------- Testing Attributes for engineering team 10</dev:code> <dev:remarks> <maml:para>This example demonstrates how to retrieve an attribute set by Id.</maml:para> <maml:para>- `-AttributeSetId` parameter specifies the unique identifier for the attribute set within a tenant.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaAttributeSet</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-EntraBetaAttributeSet</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-EntraBetaAttributeSet</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaContact</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaContact</command:noun> <maml:description> <maml:para>Gets a contact from Microsoft Entra ID.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaContact` cmdlet gets a contact from Microsoft Entra ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaContact</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies an OData v4.0 filter statement. This parameter controls which objects are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-EntraBetaContact</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>OrgContactId</maml:name> <maml:description> <maml:para>Specifies the ID of a contact in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies an OData v4.0 filter statement. This parameter controls which objects are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>OrgContactId</maml:name> <maml:description> <maml:para>Specifies the ID of a contact in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--- Example 1: Retrieve all contact objects in the directory ---</maml:title> <dev:code>Connect-Entra -Scopes 'OrgContact.Read.All' Get-EntraBetaContact DisplayName Id Mail MailNickname ----------- -- ---- ------------ Contoso Contact aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb contact@contoso.com Contoso Contact Contoso Contact1 bbbbbbbb-1111-2222-3333-cccccccccccc contact1@contoso.com Contoso Contact 1 Contoso Contact2 cccccccc-2222-3333-4444-dddddddddddd contact2@contoso.com Contoso Contact 2 Contoso Contact3 dddddddd-3333-4444-5555-eeeeeeeeeeee contact3@contoso.com Contoso Contact 3</dev:code> <dev:remarks> <maml:para>This example retrieves all contact objects in the directory.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>- Example 2: Retrieve specific contact object in the directory -</maml:title> <dev:code>Connect-Entra -Scopes 'OrgContact.Read.All' Get-EntraBetaContact -OrgContactId 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb' DisplayName Id Mail MailNickname ----------- -- ---- ------------ Contoso Contact aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb contact@contoso.com Contoso Contact</dev:code> <dev:remarks> <maml:para>This example retrieves specified contact in the directory.</maml:para> <maml:para>- `-OrgContactId` parameter specifies the contact Id.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-- Example 3: Retrieve all contacts objects in the directory --</maml:title> <dev:code>Connect-Entra -Scopes 'OrgContact.Read.All' Get-EntraBetaContact -All DisplayName Id Mail MailNickname ----------- -- ---- ------------ Contoso Contact aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb contact@contoso.com Contoso Contact Contoso Contact1 bbbbbbbb-1111-2222-3333-cccccccccccc contact1@contoso.com Contoso Contact 1 Contoso Contact2 cccccccc-2222-3333-4444-dddddddddddd contact2@contoso.com Contoso Contact 2 Contoso Contact3 dddddddd-3333-4444-5555-eeeeeeeeeeee contact3@contoso.com Contoso Contact 3</dev:code> <dev:remarks> <maml:para>This example retrieves all the contacts in the directory.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title> Example 4: Retrieve top two contacts objects in the directory </maml:title> <dev:code>Connect-Entra -Scopes 'OrgContact.Read.All' Get-EntraBetaContact -Top 2 DisplayName Id Mail MailNickname ----------- -- ---- ------------ Contoso Contact aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb contact@contoso.com Contoso Contact Contoso Contact1 bbbbbbbb-1111-2222-3333-cccccccccccc contact1@contoso.com Contoso Contact 1</dev:code> <dev:remarks> <maml:para>This example retrieves top two contacts in the directory.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 5: Retrieve all contacts objects in the directory filter by DisplayName</maml:title> <dev:code>Connect-Entra -Scopes 'OrgContact.Read.All' Get-EntraBetaContact -Filter "DisplayName eq 'Contoso Contact'" DisplayName Id Mail MailNickname ----------- -- ---- ------------ Contoso Contact aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb contact@contoso.com Contoso Contact Contoso Contact1 bbbbbbbb-1111-2222-3333-cccccccccccc contact1@contoso.com Contoso Contact 1 Contoso Contact2 cccccccc-2222-3333-4444-dddddddddddd contact2@contoso.com Contoso Contact 2 Contoso Contact3 dddddddd-3333-4444-5555-eeeeeeeeeeee contact3@contoso.com Contoso Contact 3</dev:code> <dev:remarks> <maml:para>This example retrieves contacts having the specified display name.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaContact</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaContact</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaContactDirectReport</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaContactDirectReport</command:noun> <maml:description> <maml:para>Get the direct reports for a contact.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaContactDirectReport` cmdlet gets the direct reports for a contact.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaContactDirectReport</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>OrgContactId</maml:name> <maml:description> <maml:para>Specifies the ID of a contact in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>OrgContactId</maml:name> <maml:description> <maml:para>Specifies the ID of a contact in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------- Example 1: Get the direct reports of a contact --------</maml:title> <dev:code>Connect-Entra -Scopes 'OrgContact.Read.All' $Contact = Get-EntraBetaContact -Top 1 Get-EntraBetaContactDirectReport -OrgContactId $Contact.ObjectId</dev:code> <dev:remarks> <maml:para>This example shows how to retrieve direct reports for an organizational contact. You can use the command `Get-EntraBetaContact` to get organizational contact.</maml:para> <maml:para>- `-OrgContactId` parameter specifies the contact Id.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------- Example 2: Get all direct reports of a contact --------</maml:title> <dev:code>Connect-Entra -Scopes 'OrgContact.Read.All' $Contact = Get-EntraBetaContact -Top 1 Get-EntraBetaContactDirectReport -OrgContactId $Contact.ObjectId -All</dev:code> <dev:remarks> <maml:para>This example shows how to retrieve all direct reports for an organizational contact.</maml:para> <maml:para>- `-OrgContactId` parameter specifies the contact Id.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------ Example 3: Get top two direct reports of a contact ------</maml:title> <dev:code>Connect-Entra -Scopes 'OrgContact.Read.All' $Contact = Get-EntraBetaContact -Top 1 Get-EntraBetaContactDirectReport -OrgContactId $Contact.ObjectId -Top 2</dev:code> <dev:remarks> <maml:para>This example shows how to retrieve top two direct reports for an organizational contact.</maml:para> <maml:para>- `-OrgContactId` parameter specifies the contact Id.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaContactDirectReport</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaContact</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaContactManager</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaContactManager</command:noun> <maml:description> <maml:para>Gets the manager of a contact.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaContactManager` cmdlet gets the manager of a contact in Microsoft Entra ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaContactManager</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>OrgContactId</maml:name> <maml:description> <maml:para>Specifies the ID of a contact in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>OrgContactId</maml:name> <maml:description> <maml:para>Specifies the ID of a contact in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----------- Example 1: Get the manager of a contact -----------</maml:title> <dev:code>Connect-Entra -Scopes 'OrgContact.Read.All' $Contact = Get-EntraBetaContact -Top 1 Get-EntraBetaContactManager -OrgContactId $Contact.ObjectId</dev:code> <dev:remarks> <maml:para>The example demonstrates how to retrieve the manager of a contact. You can use the command `Get-EntraBetaContact` to get organizational contact.</maml:para> <maml:para>- `-OrgContactId` parameter specifies the contact Id.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaContactManager</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaContact</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaContactMembership</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaContactMembership</command:noun> <maml:description> <maml:para>Get a contact membership.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaContactMembership` cmdlet gets a contact membership in Microsoft Entra ID.</maml:para> <maml:para>This command is useful to administrators who need to understand which groups, roles, or administrative units a particular contact belongs to. This can be important for troubleshooting access issues, auditing memberships, and ensuring that contact memberships are correctly configured.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaContactMembership</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>OrgContactId</maml:name> <maml:description> <maml:para>Specifies the ID of a contact in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>OrgContactId</maml:name> <maml:description> <maml:para>Specifies the ID of a contact in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1: Get the memberships of a contact ---------</maml:title> <dev:code>Connect-Entra -Scopes 'OrgContact.Read.All' $Contact = Get-EntraBetaContact -Filter "DisplayName eq 'Contoso Contact'" Get-EntrabetaContactMembership -OrgContactId $Contact.ObjectId Id DeletedDateTime -- --------------- ffffffff-5555-6666-7777-aaaaaaaaaaaa aaaaaaaa-6666-7777-8888-bbbbbbbbbbbb bbbbbbbb-7777-8888-9999-cccccccccccc</dev:code> <dev:remarks> <maml:para>This command gets all the memberships for specified contact.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>--------- Example 2: Get all memberships of a contact ---------</maml:title> <dev:code>Connect-Entra -Scopes 'OrgContact.Read.All' $Contact = Get-EntraBetaContact -Filter "DisplayName eq 'Contoso Contact'" Get-EntraBetaContactMembership -OrgContactId $Contact.ObjectId -All Id DeletedDateTime -- --------------- ffffffff-5555-6666-7777-aaaaaaaaaaaa aaaaaaaa-6666-7777-8888-bbbbbbbbbbbb bbbbbbbb-7777-8888-9999-cccccccccccc</dev:code> <dev:remarks> <maml:para>This command gets all the memberships for specified contact.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------- Example 3: Get top two memberships of a contact -------</maml:title> <dev:code>Connect-Entra -Scopes 'OrgContact.Read.All' $Contact = Get-EntraBetaContact -Filter "DisplayName eq 'Contoso Contact'" Get-EntraBetaContactMembership -OrgContactId $Contact.ObjectId -Top 2 Id DeletedDateTime -- --------------- ffffffff-5555-6666-7777-aaaaaaaaaaaa aaaaaaaa-6666-7777-8888-bbbbbbbbbbbb</dev:code> <dev:remarks> <maml:para>This command gets top two memberships for specified contact.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaContactMembership</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaContact</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaContract</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaContract</command:noun> <maml:description> <maml:para>Gets a contract.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaContract` cmdlet gets a contract information associated to a partner tenant.</maml:para> <maml:para>In delegated scenarios with work or school accounts, the `Directory Readers` role is the only least privileged role that supports this operation for the signed-in user</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaContract</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies an OData v4.0 filter statement. This parameter controls which objects are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-EntraBetaContract</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ContractId</maml:name> <maml:description> <maml:para>Specifies the ID of a contract.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies an OData v4.0 filter statement. This parameter controls which objects are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ContractId</maml:name> <maml:description> <maml:para>Specifies the ID of a contract.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>The contract object contains the following attributes:</maml:para> <maml:para>`contractType` - type of the contract.</maml:para> <maml:para>Possible values are: SyndicationPartner - indicates a partner that exclusively resells and manages O365 and Intune for this customer. They resell and support their customers. BreadthPartner - indicates that the partner has the ability to provide administrative support for this customer. However the partner isn't allowed to resell to the customer. ResellerPartner - indicates a partner that is similar to a syndication partner, except that it doesn't have exclusive access to a tenant. In the syndication case, the customer can't buy additional direct subscriptions from Microsoft or from other partners.</maml:para> <maml:para>`customerContextId` - unique identifier for the customer tenant referenced by this partnership.</maml:para> <maml:para>Corresponds to the ObjectId property of the customer tenant's TenantDetail object.</maml:para> <maml:para>`defaultDomainName` - a copy of the customer tenant's default domain name. The copy is made when the partnership with the customer is established. It isn't automatically updated if the customer tenant's default domain name changes.</maml:para> <maml:para>`deletionTimestamp` - this property isn't valid for contracts and always returns null.</maml:para> <maml:para>`displayName` - a copy of the customer tenant's display name. The copy is made when the partnership with the customer is established. It isn't automatically updated if the customer tenant's display name changes.</maml:para> <maml:para>`objectType` - a string that identifies the object type. The value is always `Contract`.</maml:para> <maml:para>`ContractId` - the unique identifier for the partnership.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------- Example 1: Get all contracts in the directory --------</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.Read.All' Get-EntraBetaContract</dev:code> <dev:remarks> <maml:para>This command gets all contracts in the Microsoft Entra ID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------ Example 2: Get top two contracts in the directory ------</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.Read.All' Get-EntraBetaContract -Top 2</dev:code> <dev:remarks> <maml:para>This command gets top two contracts in the Microsoft Entra ID.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaContract</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaCustomSecurityAttributeDefinition</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaCustomSecurityAttributeDefinition</command:noun> <maml:description> <maml:para>Gets a list of custom security attribute definitions.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets a list of Microsoft Entra ID custom security attribute definitions. Specify `Id` parameter to get a list of custom security attribute definitions.</maml:para> <maml:para>In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role or a custom role with the necessary permissions. The following privileged roles are supported for this operation:</maml:para> <maml:para>- Attribute Assignment Reader</maml:para> <maml:para>- Attribute Definition Reader</maml:para> <maml:para>- Attribute Assignment Administrator</maml:para> <maml:para>- Attribute Definition Administrator</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaCustomSecurityAttributeDefinition</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The unique identifier of a Microsoft Entra ID custom security attribute definition object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The unique identifier of a Microsoft Entra ID custom security attribute definition object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Get a list of all custom security attribute definitions</maml:title> <dev:code>Connect-Entra -Scopes 'CustomSecAttributeDefinition.Read.All, CustomSecAttributeDefinition.ReadWrite.All' Get-EntraBetaCustomSecurityAttributeDefinition Id AttributeSet Description IsCollection IsSearchable Name Status Type UsePreDefinedValuesOnly -- ------------ ----------- ------------ ------------ ---- ------ ---- ----------------------- Engineering_newvalue Engineering New Eng Value True True NewValue Available String False Engineering_ProjectDate Engineering Target completion date False True ProjectDate Available String False</dev:code> <dev:remarks> <maml:para>This example returns all custom security attribute definitions.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Get a specific custom security attribute definition</maml:title> <dev:code>Connect-Entra -Scopes 'CustomSecAttributeDefinition.Read.All, CustomSecAttributeDefinition.ReadWrite.All' Get-EntraBetaCustomSecurityAttributeDefinition -Id 'Engineering_ProjectDate' Id AttributeSet Description IsCollection IsSearchable Name Status Type UsePreDefinedValuesOnly -- ------------ ----------- ------------ ------------ ---- ------ ---- ----------------------- Engineering_ProjectDate Engineering Target completion date False True ProjectDate Available String False</dev:code> <dev:remarks> <maml:para>This example returns a specific custom security attribute definition.</maml:para> <maml:para>- `Id` parameter specifies the custom security attribute definition object ID.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaCustomSecurityAttributeDefinition</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-EntraBetaCustomSecurityAttributeDefinition</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-EntraBetaCustomSecurityAttributeDefinition</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaCustomSecurityAttributeDefinitionAllowedValue</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaCustomSecurityAttributeDefinitionAllowedValue</command:noun> <maml:description> <maml:para>Gets the predefined value for a custom security attribute definition.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the predefined value for a Microsoft Entra ID custom security attribute definition. Specify `CustomSecurityAttributeDefinitionId` parameter to retrieve the predefined value custom security attribute definition.</maml:para> <maml:para>The signed-in user must be assigned one of the following directory roles:</maml:para> <maml:para>- Attribute Definition Reader</maml:para> <maml:para>- Attribute Definition Administrator</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaCustomSecurityAttributeDefinitionAllowedValue</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>CustomSecurityAttributeDefinitionId</maml:name> <maml:description> <maml:para>The unique identifier of customSecurityAttributeDefinition.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter items by property values.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-EntraBetaCustomSecurityAttributeDefinitionAllowedValue</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>CustomSecurityAttributeDefinitionId</maml:name> <maml:description> <maml:para>The unique identifier of customSecurityAttributeDefinition.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The unique identifier for the predefined value, which can be up to 64 characters long and include Unicode characters. Spaces are allowed, but some special characters are not. This identifier is case sensitive, cannot be changed later, and is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>CustomSecurityAttributeDefinitionId</maml:name> <maml:description> <maml:para>The unique identifier of customSecurityAttributeDefinition.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter items by property values.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The unique identifier for the predefined value, which can be up to 64 characters long and include Unicode characters. Spaces are allowed, but some special characters are not. This identifier is case sensitive, cannot be changed later, and is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------- Example 1: Get all predefined values -------------</maml:title> <dev:code>Connect-Entra -Scopes 'CustomSecAttributeDefinition.ReadWrite.All' $CustomSecurityAttributeDefinition = Get-EntraBetaCustomSecurityAttributeDefinition -Id '<attributename_attributedefinition>' Get-EntraBetaCustomSecurityAttributeDefinitionAllowedValue -CustomSecurityAttributeDefinitionId $CustomSecurityAttributeDefinition.Id Id IsActive -- -------- Apline True</dev:code> <dev:remarks> <maml:para>This example retrieves an all predefined values.</maml:para> <maml:para>- `-CustomSecurityAttributeDefinitionId` parameter specifies the custom security attribute definition ID. You can use `Get-EntraBetaCustomSecurityAttributeDefinition` to get this value.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------ Example 2: Get predefined value with ID parameter ------</maml:title> <dev:code>Connect-Entra -Scopes 'CustomSecAttributeDefinition.ReadWrite.All' $CustomSecurityAttributeDefinition = Get-EntraBetaCustomSecurityAttributeDefinition -Id '<attributename_attributedefinition>' $params = @{ CustomSecurityAttributeDefinitionId = $CustomSecurityAttributeDefinition.Id Id = 'Alpine' } Get-EntraBetaCustomSecurityAttributeDefinitionAllowedValue @params Id IsActive -- -------- Apline True</dev:code> <dev:remarks> <maml:para>This example retrieves a specific predefined value.</maml:para> <maml:para>- `-CustomSecurityAttributeDefinitionId` parameter specifies the custom security attribute definition ID. You can use `Get-EntraBetaCustomSecurityAttributeDefinition` to get this value.</maml:para> <maml:para>- `-Id` parameter specifies the ID of Microsoft Entra ID Object.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---- Example 3: Get predefined value with Filter parameter ----</maml:title> <dev:code>Connect-Entra -Scopes 'CustomSecAttributeDefinition.ReadWrite.All' $CustomSecurityAttributeDefinition = Get-EntraBetaCustomSecurityAttributeDefinition -Id '<attributename_attributedefinition>' $params = @{ CustomSecurityAttributeDefinitionId = $CustomSecurityAttributeDefinition.Id Filter = "Id eq 'Apline'" } Get-EntraBetaCustomSecurityAttributeDefinitionAllowedValue @params Id IsActive -- -------- Apline True</dev:code> <dev:remarks> <maml:para>This example retrieves a predefined value containing Id with the specified value.</maml:para> <maml:para>- `-CustomSecurityAttributeDefinitionId` parameter specifies the custom security attribute definition ID. You can use `Get-EntraBetaCustomSecurityAttributeDefinition` to get this value.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaCustomSecurityAttributeDefinitionAllowedValue</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-EntraBetaCustomSecurityAttributeDefinitionAllowedValue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-EntraBetaCustomSecurityAttributeDefinitionAllowedValue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaDeletedDirectoryObject</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaDeletedDirectoryObject</command:noun> <maml:description> <maml:para>Retrieves a soft deleted directory object from the directory.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaDeletedDirectoryObject` cmdlet retrieves a soft deleted directory object from the directory.</maml:para> <maml:para>Note that soft delete for groups is currently only implemented for Unified Groups (also known as Office 365 Groups).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaDeletedDirectoryObject</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="Id"> <maml:name>DirectoryObjectId</maml:name> <maml:description> <maml:para>The Id of the directory object to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="Id"> <maml:name>DirectoryObjectId</maml:name> <maml:description> <maml:para>The Id of the directory object to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------- Example 1: Retrieve a deleted directory object --------</maml:title> <dev:code>Connect-Entra -Scopes 'AdministrativeUnit.Read.All', 'Application.Read.All','Group.Read.All','User.Read.All' Get-EntraBetaDeletedDirectoryObject -DirectoryObjectId 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb' Id DeletedDateTime -- --------------- aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb 06-08-2024 04:23:34</dev:code> <dev:remarks> <maml:para>This example shows how to retrieve the deleted directory object from the directory.</maml:para> <maml:para>- `-DirectoryObjectId` parameter specifies the Id of the directory object to retrieve.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Retrieve a deleted directory object with more details.</maml:title> <dev:code>Connect-Entra -Scopes 'AdministrativeUnit.Read.All', 'Application.Read.All','Group.Read.All','User.Read.All' Get-EntraBetaDeletedDirectoryObject -Id 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb' | Format-Table -Property Id, displayName, '@odata.type' -AutoSize Id displayName @odata.type -- ----------- ----------- aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb Entra PowerShell App #microsoft.graph.application</dev:code> <dev:remarks> <maml:para>This example shows how to retrieve the deleted directory object details from the directory.</maml:para> <maml:para>- `-Id` parameter specifies the Id of the directory object to retrieve.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaDeletedDirectoryObject</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaDevice</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaDevice</command:noun> <maml:description> <maml:para>Gets a device from Microsoft Entra ID.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaDevice` cmdlet gets a device from Microsoft Entra ID. Specify the `DeviceId` parameter to get a specific device.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaDevice</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies the OData v4.0 filter statement. This parameter controls which objects are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-EntraBetaDevice</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>DeviceId</maml:name> <maml:description> <maml:para>Specifies the ID of a device in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-EntraBetaDevice</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>SearchString</maml:name> <maml:description> <maml:para>Specifies a search string.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies the OData v4.0 filter statement. This parameter controls which objects are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>DeviceId</maml:name> <maml:description> <maml:para>Specifies the ID of a device in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>SearchString</maml:name> <maml:description> <maml:para>Specifies a search string.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---------------- Example 1: Get a device by ID ----------------</maml:title> <dev:code>Connect-Entra -Scopes 'Device.Read.All' Get-EntraBetaDevice -DeviceId 'bbbbbbbb-1111-1111-1111-cccccccccccc' DeletedDateTime Id AccountEnabled ApproximateLastSignInDateTime ComplianceExpirationDateTime DeviceCategory DeviceId DeviceMetada ta --------------- -- -------------- ----------------------------- ---------------------------- -------------- -------- ------------ bbbbbbbb-1111-1111-1111-cccccccccccc True dddddddd-9999-0000-1111-eeeeeeeeeeee MetaData</dev:code> <dev:remarks> <maml:para>This example shows how to retrieve a device using its ID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------ Example 2: Get all devices ------------------</maml:title> <dev:code>Connect-Entra -Scopes 'Device.Read.All' Get-EntraBetaDevice DeletedDateTime Id AccountEnabled ApproximateLastSignInDateTime ComplianceExpirationDateTime DeviceCategory DeviceId DeviceMetada ta --------------- -- -------------- ----------------------------- ---------------------------- -------------- -------- ------------ aaaaaaaa-1111-1111-1111-bbbbbbbbbbbb True aaaaaaaa-6666-7777-8888-bbbbbbbbbbbb MetaData bbbbbbbb-1111-1111-1111-cccccccccccc True aaaaaaaa-6666-7777-8888-bbbbbbbbbbbb MetaData</dev:code> <dev:remarks> <maml:para>This example demonstrates how to retrieve all devices from Microsoft Entra ID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------------- Example 3: Get top two devices ----------------</maml:title> <dev:code>Connect-Entra -Scopes 'Device.Read.All' Get-EntraBetaDevice -Top 2 DeletedDateTime Id AccountEnabled ApproximateLastSignInDateTime ComplianceExpirationDateTime DeviceCategory DeviceId DeviceMetada ta --------------- -- -------------- ----------------------------- ---------------------------- -------------- -------- ------------ aaaaaaaa-1111-1111-1111-bbbbbbbbbbbb True aaaaaaaa-6666-7777-8888-bbbbbbbbbbbb MetaData bbbbbbbb-1111-1111-1111-cccccccccccc True aaaaaaaa-6666-7777-8888-bbbbbbbbbbbb MetaData</dev:code> <dev:remarks> <maml:para>This example demonstrates how to retrieve top two devices from Microsoft Entra ID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>----------- Example 4: Get a device by display name -----------</maml:title> <dev:code>Connect-Entra -Scopes 'Device.Read.All' Get-EntraBetaDevice -Filter "DisplayName eq 'Woodgrove Desktop'" DeletedDateTime Id AccountEnabled ApproximateLastSignInDateTime ComplianceExpirationDateTime DeviceCategory DeviceId DeviceMetada ta --------------- -- -------------- ----------------------------- ---------------------------- -------------- -------- ------------ bbbbbbbb-1111-1111-1111-cccccccccccc True dddddddd-9999-0000-1111-eeeeeeeeeeee MetaData</dev:code> <dev:remarks> <maml:para>This example demonstrates how to retrieve device using the display name.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- Example 5: Get a device using display name ----------</maml:title> <dev:code>Connect-Entra -Scopes 'Device.Read.All' Get-EntraBetaDevice -Filter "startsWith(DisplayName,'Woodgrove')" DeletedDateTime Id AccountEnabled ApproximateLastSignInDateTime ComplianceExpirationDateTime DeviceCategory DeviceId DeviceMetada ta --------------- -- -------------- ----------------------------- ---------------------------- -------------- -------- ------------ bbbbbbbb-1111-1111-1111-cccccccccccc True dddddddd-9999-0000-1111-eeeeeeeeeeee MetaData</dev:code> <dev:remarks> <maml:para>This example demonstrates how to retrieve all the devices whose display name starts with the word `Woodgrove`.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- Example 6: Search among retrieved devices ----------</maml:title> <dev:code>Connect-Entra -Scopes 'Device.Read.All' Get-EntraBetaDevice -SearchString 'DESKTOP' DeletedDateTime Id AccountEnabled ApproximateLastSignInDateTime ComplianceExpirationDateTime DeviceCategory DeviceId DeviceMetada ta --------------- -- -------------- ----------------------------- ---------------------------- -------------- -------- ------------ bbbbbbbb-1111-1111-1111-cccccccccccc True dddddddd-9999-0000-1111-eeeeeeeeeeee MetaData</dev:code> <dev:remarks> <maml:para>This example shows how to retrieve devices containing the word 'DESKTOP.'</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaDevice</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-EntraBetaDevice</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaDevice</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-EntraBetaDevice</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaDeviceRegisteredOwner</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaDeviceRegisteredOwner</command:noun> <maml:description> <maml:para>Gets the registered owner of a device.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaDeviceRegisteredOwner` cmdlet gets the registered owner of a device in Microsoft Entra ID. Specify `DeviceId` parameter gets the registered owner of a device.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaDeviceRegisteredOwner</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>DeviceId</maml:name> <maml:description> <maml:para>Specifies the ID of an object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>DeviceId</maml:name> <maml:description> <maml:para>Specifies the ID of an object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----- Example 1: Retrieve the registered owner of a device -----</maml:title> <dev:code>Connect-Entra -Scopes 'Device.Read.All' $DevId = (Get-EntraDevice -Top 1).ObjectId Get-EntraBetaDeviceRegisteredOwner -DeviceId $DevId ObjectId DisplayName UserPrincipalName UserType -------- ----------- ----------------- -------- aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb Maria Sullivan maria@contoso.com Member</dev:code> <dev:remarks> <maml:para>This example shows how to find the registered owner of a device..</maml:para> <maml:para>- `-DeviceId` parameter specifies the device's ID</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>----- Example 2: Retrieve the registered owner of a device -----</maml:title> <dev:code>Connect-Entra -Scopes 'Device.Read.All' Get-EntraBetaDeviceRegisteredOwner -DeviceId bbbbbbbb-1111-2222-3333-cccccccccccc ObjectId DisplayName UserPrincipalName UserType -------- ----------- ----------------- -------- aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb Maria Sullivan maria@contoso.com Member cccccccc-2222-3333-4444-dddddddddddd Parker McLean parker@contoso.com Member</dev:code> <dev:remarks> <maml:para>This command gets the registered owner of a device.</maml:para> <maml:para>- `-DeviceId` parameter specifies the device's ID</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-- Example 3: Retrieve all the registered owners of a device --</maml:title> <dev:code>Connect-Entra -Scopes 'Device.Read.All' Get-EntraBetaDeviceRegisteredOwner -DeviceId bbbbbbbb-1111-2222-3333-cccccccccccc -All ObjectId DisplayName UserPrincipalName UserType -------- ----------- ----------------- -------- aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb Maria Sullivan maria@contoso.com Member cccccccc-2222-3333-4444-dddddddddddd Parker McLean parker@contoso.com Member</dev:code> <dev:remarks> <maml:para>This command retrieves all the registered owners of a device.</maml:para> <maml:para>- `-DeviceId` parameter specifies the device's ID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>--- Example 4: Retrieve top one registered owner of a device ---</maml:title> <dev:code>Connect-Entra -Scopes 'Device.Read.All' Get-EntraBetaDeviceRegisteredOwner -DeviceId bbbbbbbb-1111-2222-3333-cccccccccccc -Top 1 ObjectId DisplayName UserPrincipalName UserType -------- ----------- ----------------- -------- aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb Maria Sullivan maria@contoso.com Member</dev:code> <dev:remarks> <maml:para>This command retrieves all the registered owners of a device.</maml:para> <maml:para>- `-DeviceId` parameter specifies the device's ID.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaDeviceRegisteredOwner</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-EntraBetaDeviceRegisteredOwner</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaDevice</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaDeviceRegisteredOwner</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaDeviceRegisteredUser</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaDeviceRegisteredUser</command:noun> <maml:description> <maml:para>Retrieve a list of users that are registered users of the device.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaDeviceRegisteredUser` cmdlet gets a registered user for a Microsoft Entra ID device. Specify `DeviceId` parameter to get a registered user for a Microsoft Entra ID device.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaDeviceRegisteredUser</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>DeviceId</maml:name> <maml:description> <maml:para>Specifies an object ID of a device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>DeviceId</maml:name> <maml:description> <maml:para>Specifies an object ID of a device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----- Example 1: Retrieve the registered user of a device -----</maml:title> <dev:code>Connect-Entra -Scopes 'Device.Read.All' $DevId = (Get-EntraDevice -Top 1).ObjectId Get-EntraBetaDeviceRegisteredUser -DeviceId $DevId Id DeletedDateTime -- --------------- bbbbbbbb-1111-2222-3333-cccccccccccc cccccccc-2222-3333-4444-dddddddddddd dddddddd-3333-4444-5555-eeeeeeeeeeee ffffffff-4444-5555-6666-gggggggggggg</dev:code> <dev:remarks> <maml:para>This example demonstrates how to retrieve registered user for a specific Microsoft Entra ID device.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------- Example 2: Get all registered users of a device -------</maml:title> <dev:code>Connect-Entra -Scopes 'Device.Read.All' Get-EntraBetaDeviceRegisteredUser -DeviceId 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb' -All Id DeletedDateTime -- --------------- bbbbbbbb-1111-2222-3333-cccccccccccc cccccccc-2222-3333-4444-dddddddddddd dddddddd-3333-4444-5555-eeeeeeeeeeee ffffffff-4444-5555-6666-gggggggggggg</dev:code> <dev:remarks> <maml:para>This example demonstrates how to retrieve all registered users for a specified device.</maml:para> <maml:para>- `-DeviceId` parameter specifies an object ID of a device, which you want to retrieve.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>----- Example 3: Get top two registered users of a device -----</maml:title> <dev:code>Connect-Entra -Scopes 'Device.Read.All' Get-EntraBetaDeviceRegisteredUser -DeviceId 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb' -Top 2 Id DeletedDateTime -- --------------- bbbbbbbb-1111-2222-3333-cccccccccccc cccccccc-2222-3333-4444-dddddddddddd</dev:code> <dev:remarks> <maml:para>This example demonstrates how to retrieve top two registered users for the specified device.</maml:para> <maml:para>- `-DeviceId` parameter specifies an object ID of a device, which you want to retrieve.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaDeviceRegisteredUser</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-EntraBetaDeviceRegisteredUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaDeviceRegisteredUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaDirectoryObjectOnPremisesProvisioningError</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaDirectoryObjectOnPremisesProvisioningError</command:noun> <maml:description> <maml:para>Returns whether Microsoft Entra ID has objects with DirSync provisioning error.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaDirectoryObjectOnPremisesProvisioningError` returns whether Microsoft Entra ID has objects with DirSync provisioning error.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaDirectoryObjectOnPremisesProvisioningError</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>The unique ID of the tenant to perform the operation on.</maml:para> <maml:para>If this isn't provided then the value defaults to the tenant of the current user.</maml:para> <maml:para>This parameter is only applicable to partner users.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>The unique ID of the tenant to perform the operation on.</maml:para> <maml:para>If this isn't provided then the value defaults to the tenant of the current user.</maml:para> <maml:para>This parameter is only applicable to partner users.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Nullable`1[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Return whether Microsoft Entra ID has objects with DirSync provisioning error</maml:title> <dev:code>Connect-Entra -Scopes 'User.Read.All', 'Directory.Read.All', 'Group.Read.All', 'Contacts.Read' Get-EntraBetaDirectoryObjectOnPremisesProvisioningError False</dev:code> <dev:remarks> <maml:para>This command returns whether Microsoft Entra ID has objects with DirSync provisioning error.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Return whether Microsoft Entra ID has objects with DirSync provisioning error</maml:title> <dev:code>Connect-Entra -Scopes 'User.Read.All', 'Directory.Read.All', 'Group.Read.All', 'Contacts.Read' Get-EntraBetaDirectoryObjectOnPremisesProvisioningError -TenantId '0000aaaa-11bb-cccc-dd22-eeeeee333333' False</dev:code> <dev:remarks> <maml:para>This command returns whether Microsoft Entra ID has objects with DirSync provisioning error.</maml:para> <maml:para>- `-TenantId` Specifies the unique ID of the tenant.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaDirectoryObjectOnPremisesProvisioningError</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaDirectoryRole</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaDirectoryRole</command:noun> <maml:description> <maml:para>Gets a directory role.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaDirectoryRole` cmdlet gets a directory role from Microsoft Entra ID. Specify `DirectoryRoleId` parameter to get a directory role.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaDirectoryRole</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>The OData v4.0 filter statement. Controls which objects are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-EntraBetaDirectoryRole</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>DirectoryRoleId</maml:name> <maml:description> <maml:para>Specifies the ID of a directory role in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>The OData v4.0 filter statement. Controls which objects are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>DirectoryRoleId</maml:name> <maml:description> <maml:para>Specifies the ID of a directory role in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------ Example 1: Get a directory role by ID ------------</maml:title> <dev:code>Connect-Entra -Scopes 'RoleManagement.Read.Directory' Get-EntraBetaDirectoryRole -DirectoryRoleId '56644e28-bf8b-4dad-8595-24448ffa3cb8' DeletedDateTime Id Description --------------- -- ----------- 56644e28-bf8b-4dad-8595-24448ffa3cb8 Perform all migration functionality to migrate content to Microsoft 365 usin...</dev:code> <dev:remarks> <maml:para>This command gets the specified directory role.</maml:para> <maml:para>- `-DirectoryRoleId` parameter specifies the ID of a directory role in Microsoft Entra ID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------- Example 2: Get all directory roles --------------</maml:title> <dev:code>Connect-Entra -Scopes 'RoleManagement.Read.Directory' Get-EntraBetaDirectoryRole DeletedDateTime Id Description --------------- -- ----------- aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb Perform all migration functionality to migrate content to Microsoft 365 usin... aaaaaaaa-6666-7777-8888-bbbbbbbbbbbb Can manage all aspects of users and groups, including resetting passwords fo... bbbbbbbb-7777-8888-9999-cccccccccccc Can read basic directory information. Commonly used to grant directory read ... cccccccc-8888-9999-0000-dddddddddddd Can read and write basic directory information. For granting access to appli...</dev:code> <dev:remarks> <maml:para>This command gets all the directory roles.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------ Example 3: Get a directory role filter by ObjectId ------</maml:title> <dev:code>Connect-Entra -Scopes 'RoleManagement.Read.Directory' Get-EntraBetaDirectoryRole -Filter "ObjectId eq '56644e28-bf8b-4dad-8595-24448ffa3cb8'" DeletedDateTime Id Description --------------- -- ----------- 56644e28-bf8b-4dad-8595-24448ffa3cb8 Perform all migration functionality to migrate content to Microsoft 365 usin...</dev:code> <dev:remarks> <maml:para>This command gets the directory role by ObjectId.</maml:para> <maml:para>- `-ObjectId` parameter specifies the ID of a directory role in Microsoft Entra ID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---- Example 4: Get a directory role filter by displayName ----</maml:title> <dev:code>Connect-Entra -Scopes 'RoleManagement.Read.Directory' Get-EntraBetaDirectoryRole -Filter "displayName eq 'Helpdesk Administrator'" DeletedDateTime Id Description --------------- -- ----------- 56644e28-bf8b-4dad-8595-24448ffa3cb8 Perform all migration functionality to migrate content to Microsoft 365 usin...</dev:code> <dev:remarks> <maml:para>This command gets the directory role by display name.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaDirectoryRole</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-EntraBetaDirectoryRole</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaDirectoryRoleMember</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaDirectoryRoleMember</command:noun> <maml:description> <maml:para>Gets members of a directory role.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaDirectoryRoleMember` cmdlet retrieves the members of a directory role in Microsoft Entra ID. To obtain the members of a specific directory role, specify the `DirectoryRoleId`. Use the `Get-EntraBetaDirectoryRole` cmdlet to get the `DirectoryRoleId` value.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaDirectoryRoleMember</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>DirectoryRoleId</maml:name> <maml:description> <maml:para>Specifies the ID of a directory role in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>DirectoryRoleId</maml:name> <maml:description> <maml:para>Specifies the ID of a directory role in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------- Example 1: Get members by role ID --------------</maml:title> <dev:code>Connect-Entra -Scopes 'RoleManagement.Read.Directory' Get-EntraBetaDirectoryRoleMember -DirectoryRoleId '1708c380-4b8a-4977-a46e-6031676f6b41' Id DeletedDateTime -- --------------- bbbbbbbb-7777-8888-9999-cccccccccccc</dev:code> <dev:remarks> <maml:para>This example retrieves the members of the specified role.</maml:para> <maml:para>- `-DirectoryRoleId` parameter specifies directory role ID.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaDirectoryRoleMember</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-EntraBetaDirectoryRoleMember</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaDirectoryRoleMember</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaDirectoryRoleTemplate</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaDirectoryRoleTemplate</command:noun> <maml:description> <maml:para>Gets directory role templates.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaDirectoryRoleTemplate` cmdlet gets directory role templates in Microsoft Entra ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaDirectoryRoleTemplate</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---------------- Example 1: Get role templates ----------------</maml:title> <dev:code>Connect-Entra -Scopes 'RoleManagement.Read.Directory' Get-EntraBetaDirectoryRoleTemplate DeletedDateTime Id Description --------------- -- ----------- 62e90394-69f5-4237-9190-012177145e10 Can manage all aspects of Microsoft Entra ID and Microsoft services that use Microsoft Entra identities. 10dae51f-b6af-4016-8d66-8c2a99b929b3 Default role for guest users. Can read a limited set of directory information. 2af84b1e-32c8-42b7-82bc-daa82404023b Default role for guest users with restricted access. Can read a limited set of directory information. 95e79109-95c0-4d8e-aee3-d01accf2d47b Can invite guest users independent of the 'members can invite guests' setting. fe930be7-5e62-47db-91af-98c3a49a38b1 Can manage all aspects of users and groups, including resetting passwords for limited admins.</dev:code> <dev:remarks> <maml:para>This example retrieves the role templates in Microsoft Entra ID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>----------- Example 2: Get a specific role template -----------</maml:title> <dev:code>Connect-Entra -Scopes 'RoleManagement.Read.Directory' Get-EntraBetaDirectoryRoleTemplate | Where-Object {$_.DisplayName -eq 'Helpdesk Administrator'} DeletedDateTime Id Description DisplayName --------------- -- ----------- ----------- 729827e3-9c14-49f7-bb1b-9608f156bbb8 Can reset passwords for non-administrators and Helpdesk Administrators. Helpdesk Administrator</dev:code> <dev:remarks> <maml:para>This example retrieves a Helpdesk role template.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaDirectoryRoleTemplate</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaDirectorySetting</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaDirectorySetting</command:noun> <maml:description> <maml:para>Gets a directory setting.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaDirectorySetting` cmdlet gets a directory setting from Microsoft Entra ID. Specify `Id` parameter to get a directory setting.</maml:para> <maml:para>In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role (https://learn.microsoft.com/entra/identity/role-based-access-control/permissions-reference)or a custom role with a supported role permission. The following least privileged roles are supported:</maml:para> <maml:para>- Microsoft Entra Joined Device Local Administrator (Read basic properties on setting templates and settings)</maml:para> <maml:para>- Directory Readers (Read basic properties on setting templates and settings)</maml:para> <maml:para>- Global Reader (Read basic properties on setting templates and settings)</maml:para> <maml:para>- Groups Administrator (Manage all group settings)</maml:para> <maml:para>- Directory Writers (Manage all group settings)</maml:para> <maml:para>- Authentication Policy Administrator (Update Password Rule Settings)</maml:para> <maml:para>- User Administrator (Read basic properties on setting templates and settings)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaDirectorySetting</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of a directory in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-EntraBetaDirectorySetting</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of a directory in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------- Example 1: Get a directory setting --------------</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.ReadWrite.All, Group.Read.All, Group.ReadWrite.All' Get-EntraBetaDirectorySetting -Id 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb' Id DisplayName TemplateId -- ----------- ---------- aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb Application 00001111-aaaa-2222-bbbb-3333cccc4444</dev:code> <dev:remarks> <maml:para>This example gets a directory setting.</maml:para> <maml:para>- `-Id` parameter specifies the ID of a directory.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------- Example 2: Get all directory setting -------------</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.ReadWrite.All, Group.Read.All, Group.ReadWrite.All' Get-EntraBetaDirectorySetting -All Id DisplayName TemplateId -- ----------- ---------- aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb Application 00001111-aaaa-2222-bbbb-3333cccc4444 bbbbbbbb-1111-2222-3333-cccccccccccc Password Rule Settings 11112222-bbbb-3333-cccc-4444dddd5555</dev:code> <dev:remarks> <maml:para>This example gets all directory setting.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------ Example 3: Get top n directory setting ------------</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.ReadWrite.All, Group.Read.All, Group.ReadWrite.All' Get-EntraBetaDirectorySetting -Top 2 Id DisplayName TemplateId -- ----------- ---------- aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb Application 00001111-aaaa-2222-bbbb-3333cccc4444 bbbbbbbb-1111-2222-3333-cccccccccccc Password Rule Settings 11112222-bbbb-3333-cccc-4444dddd5555</dev:code> <dev:remarks> <maml:para>This example gets top two directory setting.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaDirectorySetting</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-EntraBetaDirectorySetting</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaDirectorySetting</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-EntraBetaDirectorySetting</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaDirectorySettingTemplate</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaDirectorySettingTemplate</command:noun> <maml:description> <maml:para>Gets a directory setting template.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaDirectorySettingTemplate` cmdlet gets a directory setting template from A Microsoft Entra ID. Specify `Id` parameter to get a directory setting template.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaDirectorySettingTemplate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID of the settings template you want to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID of the settings template you want to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------- Example 1: Get an all directory setting template -------</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.ReadWrite.All' Get-EntraBetaDirectorySettingTemplate Id DisplayName Description -- ----------- ----------- aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb Group.Unified.Guest Settings for a specific Unified Group bbbbbbbb-1111-2222-3333-cccccccccccc Application ... cccccccc-2222-3333-4444-dddddddddddd Password Rule Settings ...</dev:code> <dev:remarks> <maml:para>This example gets an all directory setting template.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>--------- Example 2: Get a directory setting template ---------</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.ReadWrite.All' Get-EntraBetaDirectorySettingTemplate -Id 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb' Id DisplayName Description -- ----------- ----------- aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb Group.Unified.Guest Settings for a specific Unified Group</dev:code> <dev:remarks> <maml:para>This example gets a directory setting template.</maml:para> <maml:para>- `-Id` parameter specifies the ID of the settings template.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaDirectorySettingTemplate</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaDirSyncConfiguration</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaDirSyncConfiguration</command:noun> <maml:description> <maml:para>Gets the directory synchronization settings.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaDirSyncConfiguration` cmdlet gets the directory synchronization settings. See configuration settings (https://learn.microsoft.com/graph/api/resources/onpremisesaccidentaldeletionprevention#properties)details.</maml:para> <maml:para>For delegated scenarios, the user needs to be assigned the Global Administrator role.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaDirSyncConfiguration</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>The unique ID of the tenant for the operation. If TenantId isn't provided, it defaults to the current user's tenant. This parameter applies only to partner users.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>The unique ID of the tenant for the operation. If TenantId isn't provided, it defaults to the current user's tenant. This parameter applies only to partner users.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System. Nullable`1[[System. Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------ Example 1: Get directory synchronization settings ------</maml:title> <dev:code>Connect-Entra -Scopes 'OnPremDirectorySynchronization.ReadWrite.All' Get-EntraBetaDirSyncConfiguration AccidentalDeletionThreshold DeletionPreventionType --------------------------- ---------------------- 500 enabledForCount</dev:code> <dev:remarks> <maml:para>This example gets directory synchronization settings.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title> Example 2: Get directory synchronization settings by TenantId </maml:title> <dev:code>Connect-Entra -Scopes 'OnPremDirectorySynchronization.ReadWrite.All' $tenant = Get-EntraBetaTenantDetail Get-EntraBetaDirSyncConfiguration -TenantId $tenant.Id AccidentalDeletionThreshold DeletionPreventionType --------------------------- ---------------------- 500 enabledForCount</dev:code> <dev:remarks> <maml:para>This example gets directory synchronization settings by TenantId.</maml:para> <maml:para>- `-TenantId` Specifies the unique ID of the tenant.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaDirSyncConfiguration</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-EntraBetaDirSyncConfiguration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaDirSyncFeature</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaDirSyncFeature</command:noun> <maml:description> <maml:para>Checks the status of directory synchronization features for a tenant.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaDirSyncFeature` cmdlet checks the status of directory sync features for a tenant. If no features are specified, it returns a list of all features and their enabled or disabled status.</maml:para> <maml:para>For delegated scenarios, the user needs to be assigned the Global Administrator role.</maml:para> <maml:para>Some of the features that can be used with this cmdlet include:</maml:para> <maml:para>- DeviceWriteback - DirectoryExtensions - DuplicateProxyAddressResiliency - DuplicateUPNResiliency - EnableSoftMatchOnUpn - PasswordSync - SynchronizeUpnForManagedUsers - UnifiedGroupWriteback - UserWriteback To view all supported features, see the complete feature list (https://learn.microsoft.com/graph/api/resources/onpremisesdirectorysynchronizationfeature#properties).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaDirSyncFeature</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>The unique ID of the tenant on which to perform the operation. If not provided, the operation defaults to the tenant of the current user. This parameter is applicable only to partner users.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Feature</maml:name> <maml:description> <maml:para>The directory sync feature to check. See the complete feature list (https://learn.microsoft.com/graph/api/resources/onpremisesdirectorysynchronizationfeature#properties).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>The unique ID of the tenant on which to perform the operation. If not provided, the operation defaults to the tenant of the current user. This parameter is applicable only to partner users.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Feature</maml:name> <maml:description> <maml:para>The directory sync feature to check. See the complete feature list (https://learn.microsoft.com/graph/api/resources/onpremisesdirectorysynchronizationfeature#properties).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Return a list of all directory synchronization features</maml:title> <dev:code>Connect-Entra -Scopes 'OnPremDirectorySynchronization.Read.All' Get-EntraBetaDirSyncFeature Enabled DirSyncFeature ------- -------------- False BlockCloudObjectTakeoverThroughHardMatch False BlockSoftMatch False BypassDirSyncOverrides False CloudPasswordPolicyForPasswordSyncedUsers False ConcurrentCredentialUpdate True ConcurrentOrgIdProvisioning False DeviceWriteback False DirectoryExtensions False FopeConflictResolution False GroupWriteBack False PasswordSync False PasswordWriteback True QuarantineUponProxyAddressesConflict True QuarantineUponUpnConflict True SoftMatchOnUpn True SynchronizeUpnForManagedUsers False UnifiedGroupWriteback False UserForcePasswordChangeOnLogon False UserWriteback</dev:code> <dev:remarks> <maml:para>This example gets a list of all directory synchronization features and shows if they are enabled (True) or disabled (False).</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------ Example 2: Return the PasswordSync feature status ------</maml:title> <dev:code>Connect-Entra -Scopes 'OnPremDirectorySynchronization.Read.All' Get-EntraBetaDirSyncFeature -Feature 'PasswordSync' Enabled DirSyncFeature ------- -------------- False PasswordSync</dev:code> <dev:remarks> <maml:para>This example shows if PasswordSync is enabled (True) or disabled (False) for the tenant.</maml:para> <maml:para>- `-Feature` specifies the directory synchronization feature to check the status of.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaDirSyncFeature</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-EntraBetaDirSyncFeature</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaDomain</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaDomain</command:noun> <maml:description> <maml:para>Gets a domain.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaDomain` cmdlet gets a domain in Microsoft Entra ID.</maml:para> <maml:para>The work or school account must be assigned to at least one of the following Microsoft Entra roles:</maml:para> <maml:para>- User Administrator</maml:para> <maml:para>- Helpdesk Administrator</maml:para> <maml:para>- Service Support Administrator</maml:para> <maml:para>- Directory Readers</maml:para> <maml:para>- AdHoc License Administrator</maml:para> <maml:para>- Application Administrator</maml:para> <maml:para>- Security Reader</maml:para> <maml:para>- Security Administrator</maml:para> <maml:para>- Privileged Role Administrator</maml:para> <maml:para>- Cloud Application Administrator</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaDomain</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of a domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------ Example 1: Get a list of Domains that are created ------</maml:title> <dev:code>Connect-Entra -Scopes 'Domain.Read.All' Get-EntraBetaDomain Id AuthenticationType AvailabilityStatus IsAdminManaged IsDefault IsInitial IsRoot IsVerified PasswordNotificationWindowInDays -- ------------------ ------------------ -------------- --------- --------- ------ ---------- -------------------------------- test22.com Managed True False False False False 13 test33.com Managed True False False False False 15 test44.com Managed True False False False False 17</dev:code> <dev:remarks> <maml:para>This command retrieves a list of domains.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>--------------- Example 2: Get a specific Domain ---------------</maml:title> <dev:code>Connect-Entra -Scopes 'Domain.Read.All' Get-EntraBetaDomain -Name TEST22.com Id AuthenticationType AvailabilityStatus IsAdminManaged IsDefault IsInitial IsRoot IsVerified PasswordNotificationWindowInDays -- ------------------ ------------------ -------------- --------- --------- ------ ---------- -------------------------------- test22.com Managed True False False False False 13</dev:code> <dev:remarks> <maml:para>This command retrieves a domain with the specified name.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaDomain</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Confirm-EntraBetaDomain</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-EntraBetaDomain</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaDomain</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-EntraBetaDomain</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaDomainFederationSettings</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaDomainFederationSettings</command:noun> <maml:description> <maml:para>Retrieves settings for a federated domain.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaDomainFederationSettings` cmdlet gets key settings from Microsoft Entra ID.</maml:para> <maml:para>Use the `Get-EntraBetaFederationProperty` cmdlet to get settings for both Microsoft Entra ID and the Entra ID Federation Services server.</maml:para> <maml:para>For delegated scenarios, the calling user must be assigned at least one of the following Microsoft Entra roles:</maml:para> <maml:para>- Global Reader</maml:para> <maml:para>- Security Reader</maml:para> <maml:para>- Domain Name Administrator</maml:para> <maml:para>- External Identity Provider Administrator</maml:para> <maml:para>- Hybrid Identity Administrator</maml:para> <maml:para>- Security Administrator</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaDomainFederationSettings</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>The fully qualified domain name to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>The unique ID of the tenant to perform the operation on. If this isn't provided, then the value will default to the tenant of the current user. This parameter is only applicable to partner users.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>The fully qualified domain name to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>The unique ID of the tenant to perform the operation on. If this isn't provided, then the value will default to the tenant of the current user. This parameter is only applicable to partner users.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Online.Administration.DomainFederationSettings</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>This cmdlet returns the following settings</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>ActiveLogOnUri</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>FederationBrandName</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>IssuerUri</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>LogOffUri</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>MetadataExchangeUri</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>NextSigningCertificate</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>PassiveLogOnUri</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>SigningCertificate</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--- Example 1: Get federation settings for specified domain ---</maml:title> <dev:code>Connect-Entra -Scopes 'Domain.Read.All' Get-EntraBetaDomainFederationSettings -DomainName 'contoso.com'</dev:code> <dev:remarks> <maml:para>This command gets federation settings for specified domain.</maml:para> <maml:para>- `-DomainName` parameter specifies the fully qualified domain name to retrieve.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaDomainFederationSettings</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-EntraBetaDomainFederationSettings</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaDomainNameReference</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaDomainNameReference</command:noun> <maml:description> <maml:para>Retrieves the objects that are referenced by a given domain name.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaDomainNameReference` cmdlet retrieves the objects that are referenced with a given domain name. Specify `Name` parameter retrieve the objects.</maml:para> <maml:para>The work or school account needs to belong to at least the Domain Name Administrator or Global Reader Microsoft Entra role.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaDomainNameReference</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the domain name for which the referenced objects are retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the domain name for which the referenced objects are retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Retrieve the domain name reference objects for a domain</maml:title> <dev:code>Connect-Entra -Scopes 'Domain.Read.All' Get-EntraBetaDomainNameReference -Name contoso.com Id DeletedDateTime -- --------------- aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb bbbbbbbb-1111-2222-3333-cccccccccccc cccccccc-2222-3333-4444-dddddddddddd dddddddd-3333-4444-5555-eeeeeeeeeeee ffffffff-4444-5555-6666-gggggggggggg hhhhhhhh-5555-6666-7777-iiiiiiiiiiii</dev:code> <dev:remarks> <maml:para>This example shows how to retrieve the domain name reference objects for a domain that is specified through the -Name parameter.</maml:para> <maml:para>- `-Name` parameter specifies the name of the domain name for which the referenced objects are retrieved.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaDomainNameReference</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaDomainServiceConfigurationRecord</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaDomainServiceConfigurationRecord</command:noun> <maml:description> <maml:para>Gets the domain's service configuration records from the `serviceConfigurationRecords` navigation property.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the domain's service configuration records from the `serviceConfigurationRecords` navigation property.</maml:para> <maml:para>After you have successfully verified the ownership of a domain and you have indicated what services you plan to use with the domain, you can request Microsoft Entra ID to return you a set of DNS records which you need to add to the zone file of the domain so that the services can work properly with your domain.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaDomainServiceConfigurationRecord</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the domain for which the domain service configuration records are to be retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the domain for which the domain service configuration records are to be retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Retrieve domain service configuration records by Name</maml:title> <dev:code>Connect-Entra -Scopes 'Domain.Read.All' Get-EntraBetaDomainServiceConfigurationRecord -Name 'test.mail.contoso.com' Id IsOptional Label RecordType SupportedService Ttl -- ---------- ----- ---------- ---------------- --- aaaa0000-bb11-2222-33cc-444444dddddd False test.mail.contoso.com Mx Email 3600 bbbb1111-cc22-3333-44dd-555555eeeeee False test.mail.contoso.com Txt Email 3600 cccc2222-dd33-4444-55ee-666666ffffff False autodiscover.test.mail.contoso.com CName Email 3600 dddd3333-ee44-5555-66ff-777777aaaaaa False msoid.test.mail.contoso.com CName OrgIdAuthentication 3600 eeee4444-ff55-6666-77aa-888888bbbbbb False enterpriseregistration.test.mail.contoso.com CName Intune 3600 ffff5555-aa66-7777-88bb-999999cccccc False enterpriseenrollment.test.mail.contoso.com CName Intune 3600</dev:code> <dev:remarks> <maml:para>This example shows how to retrieve the Domain service configuration records for a domain with the given name.</maml:para> <maml:para>- `-Name` parameter specifies domain name for which the domain service configuration records are to be retrieved.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaDomainServiceConfigurationRecord</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaDomainVerificationDnsRecord</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaDomainVerificationDnsRecord</command:noun> <maml:description> <maml:para>Retrieve the domain verification DNS record for a domain.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the domain's verification records from the `verificationDnsRecords` navigation property.</maml:para> <maml:para>You can't use the domain with your Microsoft Entra ID tenant until you have successfully verified that you own the domain.</maml:para> <maml:para>To verify the ownership of the domain, you need to first retrieve a set of domain verification records that you need to add to the zone file of the domain. This can be done through the domain registrar or DNS server configuration.</maml:para> <maml:para>Root domains require verification. For example, contoso.com requires verification. If a root domain is verified, subdomains of the root domain are automatically verified. For example, subdomain.contoso.com is automatically be verified if contoso.com has been verified.</maml:para> <maml:para>The work or school account needs to belong to at least the Domain Name Administrator or Global Reader Microsoft Entra role.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaDomainVerificationDnsRecord</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The domain name for which the domain verification Domain Name System (DNS) records are to be retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The domain name for which the domain verification Domain Name System (DNS) records are to be retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---- Example 1: Retrieve the domain verification DNS record ----</maml:title> <dev:code>Connect-Entra -Scopes 'Domain.Read.All' Get-EntraBetaDomainVerificationDnsRecord -Name mail.contoso.com Id IsOptional Label RecordType SupportedService Ttl -- ---------- ----- ---------- ---------------- ---- aaaabbbb-0000-cccc-1111-dddd2222eeee False contoso.com Txt Email 3600 aaaabbbb-1111-cccc-1111-dddd2222eeee False contoso.com Mx Email 3600</dev:code> <dev:remarks> <maml:para>This example shows how to retrieve the Domain verification DNS records for a domain with the given name.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaDomainVerificationDnsRecord</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaFederationProperty</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaFederationProperty</command:noun> <maml:description> <maml:para>Displays the properties of the Microsoft Entra ID Federation Services 2.0 server and Microsoft Online.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaFederationProperty` cmdlet gets key settings from both the Microsoft Entra ID Federation Services 2.0 server and Microsoft Online.</maml:para> <maml:para>You can use this information to troubleshoot authentication problems caused by mismatched settings between the Microsoft Entra ID Federation Services 2.0 server and Microsoft Online.</maml:para> <maml:para>For delegated scenarios, the calling user must be assigned at least one of the following Microsoft Entra roles:</maml:para> <maml:para>- Global Reader</maml:para> <maml:para>- Security Reader</maml:para> <maml:para>- Domain Name Administrator</maml:para> <maml:para>- External Identity Provider Administrator</maml:para> <maml:para>- Hybrid Identity Administrator</maml:para> <maml:para>- Security Administrator</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaFederationProperty</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>The domain name for which the properties from both the Microsoft Entra ID Federation Services 2.0 server and Microsoft Online are displayed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>The domain name for which the properties from both the Microsoft Entra ID Federation Services 2.0 server and Microsoft Online are displayed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------ Example 1: Display properties for specified domain ------</maml:title> <dev:code>Connect-Entra -Scopes 'Domain.Read.All' Get-EntraBetaFederationProperty -DomainName 'contoso.com'</dev:code> <dev:remarks> <maml:para>This command displays properties for specified domain.</maml:para> <maml:para>- `-DomainName` Specifies the domain name.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaFederationProperty</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaPartnerInformation</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaPartnerInformation</command:noun> <maml:description> <maml:para>Retrieves company-level information for partners.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaPartnerInformation` cmdlet is used to retrieve partner-specific information. This cmdlet should only be used for partner tenants.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaPartnerInformation</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>The unique ID of the tenant to perform the operation on. If this is not provided, then the value will default to the tenant of the current user. This parameter is only applicable to partner users.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>The unique ID of the tenant to perform the operation on. If this is not provided, then the value will default to the tenant of the current user. This parameter is only applicable to partner users.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Company level information outputs</maml:name> </dev:type> <maml:description> <maml:para>- CompanyType: The type of this company (can be partner or regular tenant)</maml:para> <maml:para>- DapEnabled: Flag to determine if the partner has delegated admin privileges</maml:para> <maml:para>- PartnerCompanyName: The name of the company</maml:para> <maml:para>- PartnerSupportTelephones: Support Telephone numbers for the partner</maml:para> <maml:para>- PartnerSupportEmails: Support E-Mail address for the partner</maml:para> <maml:para>- PartnerCommerceUrl: URL for the partner's commerce web site</maml:para> <maml:para>- PartnerSupportUrl: URL for the Partner's support website</maml:para> <maml:para>- PartnerHelpUrl: URL for the partner's help web site</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----------- Example 1: Retrieve partner information -----------</maml:title> <dev:code>Connect-Entra -Scopes 'Organization.Read.All' Get-EntraBetaPartnerInformation PartnerCompanyName : Contoso companyType : PartnerSupportTelephones : {12123, +1911} PartnerSupportEmails : {} PartnerHelpUrl : http://www.help.contoso.com PartnerCommerceUrl : ObjectID : bbbbbbbb-1111-2222-3333-cccccccccccc PartnerSupportUrl :</dev:code> <dev:remarks> <maml:para>This command retrieves partner-specific information.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Retrieve partner information with specific TenantId</maml:title> <dev:code>Connect-Entra -Scopes 'Organization.Read.All' $tenantId = (Get-EntraContext).TenantId Get-EntraBetaPartnerInformation -TenantId $tenantId PartnerCompanyName : Contoso companyType : PartnerSupportTelephones : {12123, +1911} PartnerSupportEmails : {} PartnerHelpUrl : http://www.help.contoso.com PartnerCommerceUrl : ObjectID : bbbbbbbb-1111-2222-3333-cccccccccccc PartnerSupportUrl :</dev:code> <dev:remarks> <maml:para>This command retrieves partner-specific information.</maml:para> <maml:para>`-TenantId` Parameter specifies unique ID of the tenant to perform the operation on.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaPartnerInformation</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-EntraBetaPartnerInformation</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaPasswordPolicy</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaPasswordPolicy</command:noun> <maml:description> <maml:para>Retrieves the current password policy for the tenant or the specified domain.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaPasswordPolicy` cmdlet can be used to retrieve the values associated with the Password Expiry window or Password Expiry Notification window for a tenant or specified domain.</maml:para> <maml:para>When a domain name is specified, it must be a verified domain for the company.</maml:para> <maml:para>The work or school account needs to belong to one of the following Microsoft Entra roles:</maml:para> <maml:para>- Domain Name Administrator</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaPasswordPolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>The fully qualified name of the domain to be retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>The fully qualified name of the domain to be retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---- Example 1: Get password policy for a specified domain ----</maml:title> <dev:code>Connect-Entra -Scopes 'Domain.Read.All' Get-EntraBetaPasswordPolicy -DomainName 'contoso.com' NotificationDays ValidityPeriod ---------------- -------------- 90 180</dev:code> <dev:remarks> <maml:para>Returns the password policy for the specified domain.</maml:para> <maml:para>- `-DomainName` parameter specifies the fully qualified domain name to retrieve.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaPasswordPolicy</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaScopedRoleMembership</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaScopedRoleMembership</command:noun> <maml:description> <maml:para>List Microsoft Entra role assignments with administrative unit scope.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaScopedRoleMembership` cmdlet lists Microsoft Entra role assignments with an administrative unit scope. Use the `AdministrativeUnitId` parameter to retrieve a specific scoped role membership.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaScopedRoleMembership</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>AdministrativeUnitId</maml:name> <maml:description> <maml:para>Specifies the ID of an administrative unit object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ScopedRoleMembershipId</maml:name> <maml:description> <maml:para>Specifies the ID of a scoped role membership.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>AdministrativeUnitId</maml:name> <maml:description> <maml:para>Specifies the ID of an administrative unit object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>ScopedRoleMembershipId</maml:name> <maml:description> <maml:para>Specifies the ID of a scoped role membership.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----------- Example 1: Get Scoped Role Administrator -----------</maml:title> <dev:code>Connect-Entra -Scopes 'RoleManagement.Read.Directory' $role = Get-EntraBetaDirectoryRole -Filter "DisplayName eq 'Helpdesk Administrator'" $administrativeUnit = Get-EntraBetaAdministrativeUnit -Filter "DisplayName eq 'Pacific Administrative Unit'" $roleMembership = Get-EntraBetaScopedRoleMembership -AdministrativeUnitId $administrativeUnit.Id | Where-Object {$_.RoleId -eq $role.Id} Get-EntraBetaScopedRoleMembership -AdministrativeUnitId $administrativeUnit.Id -ScopedRoleMembershipId $roleMembership.Id Id AdministrativeUnitId RoleId -- -------------------- ------ dddddddddddd-bbbb-aaaa-bbbb-cccccccccccc aaaaaaaa-bbbb-aaaa-bbbb-cccccccccccc bbbbbbbb-1111-2222-3333-cccccccccccc</dev:code> <dev:remarks> <maml:para>This example gets scoped role administrator. You cane use the command `Get-EntraBetaAdministrativeUnit` to get administrative unit Id.</maml:para> <maml:para>- `-AdministrativeUnitId` parameter specifies the ID of an administrative unit.</maml:para> <maml:para>- `-ScopedRoleMembershipId` parameter specifies the scoped role membership Id.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: List scoped administrators for administrative unit by AdministrativeUnitId</maml:title> <dev:code>Connect-Entra -Scopes 'RoleManagement.Read.Directory' $administrativeUnit = Get-EntraBetaAdministrativeUnit -Filter "DisplayName eq 'Pacific Administrative Unit'" Get-EntraBetaScopedRoleMembership -AdministrativeUnitId $administrativeUnit.Id Id AdministrativeUnitId RoleId -- -------------------- ------ dddddddddddd-bbbb-aaaa-bbbb-cccccccccccc aaaaaaaa-bbbb-aaaa-bbbb-cccccccccccc bbbbbbbb-1111-2222-3333-cccccccccccc</dev:code> <dev:remarks> <maml:para>This example list scoped administrators with AdministrativeUnitId.</maml:para> <maml:para>- `-AdministrativeUnitId` parameter specifies the ID of an administrative unit.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaScopedRoleMembership</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-EntraBetaScopedRoleMembership</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaScopedRoleMembership</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaSubscribedSku</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaSubscribedSku</command:noun> <maml:description> <maml:para>Gets subscribed SKUs to Microsoft services.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaSubscribedSku` cmdlet gets subscribed SKUs to Microsoft services.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaSubscribedSku</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>SubscribedSkuId</maml:name> <maml:description> <maml:para>The object ID of the SKU (Stock Keeping Unit).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>SubscribedSkuId</maml:name> <maml:description> <maml:para>The object ID of the SKU (Stock Keeping Unit).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---------------- Example 1: Get subscribed SKUs ----------------</maml:title> <dev:code>Connect-Entra -Scopes 'Organization.Read.All' Get-EntraBetaSubscribedSku Id AccountId AccountName AppliesTo CapabilityStatus ConsumedUnits SkuId SkuPartNumber -- --------- ----------- --------- ---------------- ------------- ----- ------- aaaa0000-bb11-2222-33cc-444444dddddd 0000aaaa-11bb-cccc-dd22-eeeeee333333 M365x99297270 User Enabled 20 aaaaaaaa-0b0b-1c1c-2d2d-333333333333 EMSP... bbbb1111-cc22-3333-44dd-555555eeeeee 1111bbbb-22cc-dddd-ee33-ffffff444444 M365x99297270 User Enabled 20 bbbbbbbb-1c1c-2d2d-3e3e-444444444444 ENTE... cccc2222-dd33-4444-55ee-666666ffffff 2222cccc-33dd-eeee-ff44-aaaaaa555555 M365x99297270 User Enabled 2 cccccccc-2d2d-3e3e-4f4f-555555555555 ENTE...</dev:code> <dev:remarks> <maml:para>This example demonstrates how to retrieve subscribed SKUs to Microsoft services.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------ Example 2: Get subscribed SKUs by SubscribedSkuId ------</maml:title> <dev:code>Connect-Entra -Scopes 'Organization.Read.All' Get-EntraBetaSubscribedSku -SubscribedSkuId 'aaaaaaaa-0b0b-1c1c-2d2d-333333333333' Id AccountId AccountName AppliesTo CapabilityStatus ConsumedUnits SkuId SkuPartNumber -- --------- ----------- --------- ---------------- ------------- ----- ------- aaaa0000-bb11-2222-33cc-444444dddddd 0000aaaa-11bb-cccc-dd22-eeeeee333333 M365x99297270 User Enabled 20 aaaaaaaa-0b0b-1c1c-2d2d-333333333333 EMSP...</dev:code> <dev:remarks> <maml:para>This example demonstrates how to retrieve specified subscribed SKUs to Microsoft services.</maml:para> <maml:para>- `-SubscribedSkuId` parameter specifies the ID of the SKU (Stock Keeping Unit).</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------ Example 3: Get available license plans ------------</maml:title> <dev:code>Connect-Entra -Scopes 'User.ReadWrite.All','Organization.Read.All' Get-EntraBetaSubscribedSku | Select-Object -Property Sku*, ConsumedUnits -ExpandProperty PrepaidUnits Enabled : 5 LockedOut : 0 Suspended : 0 Warning : 0 AdditionalProperties : SkuId : efccb6f7-5641-4e0e-bd10-b4976e1bf68e SkuPartNumber : EMS ConsumedUnits : 3</dev:code> <dev:remarks> <maml:para>This example demonstrates how to retrieve available license plans.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-- Example 4: Retrieve all users assigned a specific license --</maml:title> <dev:code>Connect-Entra -Scopes 'Organization.Read.All' $sku = Get-EntraBetaSubscribedSku | Where-Object { $_.SkuPartNumber -eq 'DEVELOPERPACK_E5' } $skuId = $sku.SkuId $usersWithDeveloperPackE5 = Get-EntraBetaUser -All | Where-Object { $_.AssignedLicenses -and ($_.AssignedLicenses.SkuId -contains $skuId) } $usersWithDeveloperPackE5 | Select-Object Id, DisplayName, UserPrincipalName, AccountEnabled, UserType | Format-Table -AutoSize Id DisplayName UserPrincipalName AccountEnabled UserType -- ----------- ----------------- -------------- -------- cccccccc-2222-3333-4444-dddddddddddd Angel Brown AngelB@contoso.com True Member dddddddd-3333-4444-5555-eeeeeeeeeeee Avery Smith AveryS@contoso.com True Member eeeeeeee-4444-5555-6666-ffffffffffff Sawyer Miller SawyerM@contoso.com True Member</dev:code> <dev:remarks> <maml:para>This example demonstrates how to retrieve all users assigned a specific license.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 5: Get a list of users, their assigned licenses, and licensing source</maml:title> <dev:code>Connect-Entra -Scopes 'Organization.Read.All','User.Read.All','Group.Read.All' # Get all users with specified properties $Users = Get-EntraBetaUser -All -Property AssignedLicenses, LicenseAssignmentStates, DisplayName, UserPrincipalName, ObjectId $SelectedUsers = $Users | Select-Object ObjectId, UserPrincipalName, DisplayName, AssignedLicenses -ExpandProperty LicenseAssignmentStates # Group Name lookup $GroupDisplayNames = @{} # Sku Part Number lookup $SkuPartNumbers = @{} # Populate the hashtable with group display names and SKU part numbers foreach ($User in $SelectedUsers) { $AssignedByGroup = $User.AssignedByGroup $SkuId = $User.SkuId try { # Check if the group display name is already in the hashtable if (-not $GroupDisplayNames.ContainsKey($AssignedByGroup)) { $Group = Get-EntraBetaGroup -GroupId $AssignedByGroup $GroupDisplayNames[$AssignedByGroup] = $Group.DisplayName } $User | Add-Member -NotePropertyName 'GroupDisplayName' -NotePropertyValue $GroupDisplayNames[$AssignedByGroup] } catch { $User | Add-Member -NotePropertyName 'GroupDisplayName' -NotePropertyValue 'N/A (Direct Assignment)' } try { # Check if the SKU part number is already in the hashtable if (-not $SkuPartNumbers.ContainsKey($SkuId)) { $Sku = Get-EntraBetaSubscribedSku | Where-Object { $_.SkuId -eq $SkuId } | Select-Object -ExpandProperty SkuPartNumber $SkuPartNumbers[$SkuId] = $Sku } $User | Add-Member -NotePropertyName 'SkuPartNumber' -NotePropertyValue $SkuPartNumbers[$SkuId] } catch { $User | Add-Member -NotePropertyName 'SkuPartNumber' -NotePropertyValue 'N/A' } } $SelectedUsers | Format-Table UserPrincipalName, DisplayName, AssignedByGroup, GroupDisplayName, SkuId, SkuPartNumber, State, Error -AutoSize userPrincipalName displayName assignedByGroup GroupDisplayName skuId SkuPartNumber state error ----------------- ----------- --------------- ---------------- ----- ------------- ----- ----- averyh@contoso.com Avery Howard cccccccc-2222-3333-4444-dddddddddddd Contoso Team abcdefgh-1111-2222-bbbb-cccc33333333 ENTERPRISEPACK Active None devont@contoso.com Devon Torres ffffffff-5555-6666-7777-aaaaaaaaaaaa Retail abcdefgh-1111-2222-bbbb-cccc33333333 ENTERPRISEPACK Active None</dev:code> <dev:remarks> <maml:para>This example shows a list of users, their licenses, and the source of the license such as directly assigned or group assigned.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaSubscribedSku</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EntraBetaTenantDetail</command:name> <command:verb>Get</command:verb> <command:noun>EntraBetaTenantDetail</command:noun> <maml:description> <maml:para>Gets the details of a tenant.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-EntraBetaTenantDetail` cmdlet gets the details of a tenant in Microsoft Entra ID.</maml:para> <maml:para>In delegated scenarios involving work or school accounts, the signed-in user must be assigned either a supported Microsoft Entra role or a custom role with the necessary permissions. The following least-privileged roles are supported for this operation:</maml:para> <maml:para>- Application Administrator</maml:para> <maml:para>- Authentication Administrator</maml:para> <maml:para>- Cloud Application Administrator</maml:para> <maml:para>- Directory Readers</maml:para> <maml:para>- Directory Reviewer</maml:para> <maml:para>- Global Reader</maml:para> <maml:para>- Helpdesk Administrator</maml:para> <maml:para>- Security Administrator</maml:para> <maml:para>- Security Operator</maml:para> <maml:para>- Security Reader</maml:para> <maml:para>- Service Support Administrator</maml:para> <maml:para>- User Administrator</maml:para> <maml:para>- Privileged Role Administrator</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EntraBetaTenantDetail</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>List all pages.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number of records to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>Specifies properties to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------- Example 1: Get all tenant details --------------</maml:title> <dev:code>Connect-Entra -Scopes 'Organization.Read.All' Get-EntraBetaTenantDetail -All DisplayName Id CountryLetterCode VerifiedDomains ----------- -- ----------------- --------------- Contoso aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb NL {@{Capabilities=Email, OfficeCommunicationsOnline; IsDefault=False; IsInitial=True; Name=contoso.onmicrosoft.com; Type=Managed; Addition…}} Contoso1 bbbbbbbb-1111-2222-3333-cccccccccccc NL {@{Capabilities=Email, OfficeCommunicationsOnline; IsDefault=False; IsInitial=True; Name=contoso.onmicrosoft.com; Type=Managed; Addition…}}</dev:code> <dev:remarks> <maml:para>This example shows how to retrieve all tenant details.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------ Example 2: Get top one tenant details ------------</maml:title> <dev:code>Connect-Entra -Scopes 'Organization.Read.All' Get-EntraBetaTenantDetail -Top 1 DisplayName Id CountryLetterCode VerifiedDomains ----------- -- ----------------- --------------- Contoso aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb NL {@{Capabilities=Email, OfficeCommunicationsOnline; IsDefault=False; IsInitial=True; Name=contoso.onmicrosoft.com; Type=Managed; Addition…}}</dev:code> <dev:remarks> <maml:para>This example shows how to retrieve details of a top one tenant in Microsoft Entra ID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- Example 3: Get directory tenant size quota ----------</maml:title> <dev:code>Connect-Entra -Scopes 'Organization.Read.All' (Get-EntraBetaTenantDetail).AdditionalProperties.directorySizeQuota Key Value --- ----- used 339 total 50000</dev:code> <dev:remarks> <maml:para>This example shows how to retrieve the directory tenant size quota.</maml:para> <maml:para>A directory quota represents the maximum number of objects allowed in a tenant, including user accounts, app registrations, and groups. Once this limit is reached, attempts to create new objects will result in an error.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Get-EntraBetaTenantDetail</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-EntraBetaTenantDetail</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-EntraBetaAdministrativeUnit</command:name> <command:verb>New</command:verb> <command:noun>EntraBetaAdministrativeUnit</command:noun> <maml:description> <maml:para>Creates an administrative unit.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `New-EntraBetaAdministrativeUnit` cmdlet creates an administrative unit in Microsoft Entra ID. Specify `DisplayName` parameter to create an administrative unit.</maml:para> <maml:para>In delegated scenarios, the signed-in user must be assigned a supported Microsoft Entra role or a custom role that includes the `microsoft.directory/administrativeUnits/allProperties/allTasks` permission. The Privileged Role Administrator role is the least privileged role that meets this requirement.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-EntraBetaAdministrativeUnit</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a description for the new administrative unit.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Specifies the display name of the new administrative unit.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsMemberManagementRestricted</maml:name> <maml:description> <maml:para>Indicates whether the management rights on resources in the administrative units should be restricted to ONLY the administrators scoped on the administrative unit object. If no value is specified, it defaults to false.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a description for the new administrative unit.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Specifies the display name of the new administrative unit.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsMemberManagementRestricted</maml:name> <maml:description> <maml:para>Indicates whether the management rights on resources in the administrative units should be restricted to ONLY the administrators scoped on the administrative unit object. If no value is specified, it defaults to false.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----------- Example 1: Create an administrative unit -----------</maml:title> <dev:code>Connect-Entra -Scopes 'AdministrativeUnit.ReadWrite.All' New-EntraBetaAdministrativeUnit -DisplayName 'TestAU' DeletedDateTime Id Description DisplayName IsMemberManagementRestricted Visibility --------------- -- ----------- ----------- ---------------------------- ---------- aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb TestAU False</dev:code> <dev:remarks> <maml:para>This example demonstrates how to create an administrative unit.</maml:para> <maml:para>- `-DisplayName` parameter specifies the display name for the Administrative unit object.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Create an administrative unit using '-Description' parameter</maml:title> <dev:code>Connect-Entra -Scopes 'AdministrativeUnit.ReadWrite.All' New-EntraBetaAdministrativeUnit -DisplayName 'Pacific Administrative Unit' -Description 'Administrative Unit for Pacific region' DeletedDateTime Id Description DisplayName IsMemberManagementRestricted Visibility --------------- -- ----------- ----------- ---------------------------- ---------- bbbbbbbb-1111-2222-3333-cccccccccccc New AdminiatrativeUnit test1 False</dev:code> <dev:remarks> <maml:para>This example demonstrates how to create an administrative unit.</maml:para> <maml:para>- `-DisplayName` parameter specifies the display name for the Administrative unit object.</maml:para> <maml:para>- `-Description` parameter specifies the description for the new administrative unit.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 3: Create an administrative unit using '-IsMemberManagementRestricted' parameter</maml:title> <dev:code>Connect-Entra -Scopes 'AdministrativeUnit.ReadWrite.All' New-EntraBetaAdministrativeUnit -DisplayName 'NewUnit' -IsMemberManagementRestricted $True DeletedDateTime Id Description DisplayName IsMemberManagementRestricted Visibility --------------- -- ----------- ----------- ---------------------------- ---------- cccccccc-2222-3333-4444-dddddddddddd NewUnit True</dev:code> <dev:remarks> <maml:para>This example demonstrates how to create an administrative unit.</maml:para> <maml:para>- `-DisplayName` parameter specifies the display name for the Administrative unit object.</maml:para> <maml:para>- `-IsMemberManagementRestricted` parameter specifies the management rights on resources in the administrative units should be restricted to ONLY the administrators scoped on the administrative unit object.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/New-EntraBetaAdministrativeUnit</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaAdministrativeUnit</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaAdministrativeUnit</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-EntraBetaAdministrativeUnit</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-EntraBetaAdministrativeUnitMember</command:name> <command:verb>New</command:verb> <command:noun>EntraBetaAdministrativeUnitMember</command:noun> <maml:description> <maml:para>Create a new object as a member of the administrative unit. Currently only group objects are supported.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `New-EntraBetaAdministrativeUnitMember` cmdlet creates a Microsoft Entra ID object as a member of an administrative unit. Specify `AdministrativeUnitId`, `DisplayName`, `MailNickname`, `SecurityEnabled` and `MailEnabled` parameters for create a new administrative unit member.</maml:para> <maml:para>Currently only Microsoft Entra ID groups are supported to create administrative unit members.</maml:para> <maml:para>For information about creating dynamic groups, see Using attributes to create advanced rules (<https://azure.microsoft.com/documentation/articles/active-directory-accessmanagement-groups-with-advanced-rules/>).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-EntraBetaAdministrativeUnitMember</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="Id"> <maml:name>AdministrativeUnitId</maml:name> <maml:description> <maml:para>Specifies the AdministrativeUnitId of a Microsoft Entra ID administrative unit.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OdataType</maml:name> <maml:description> <maml:para>Specifies the odata type of the object to create in the administrative unit.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a description for the group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Specifies a display name for the group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MailEnabled</maml:name> <maml:description> <maml:para>Specifies whether this group is mail enabled.</maml:para> <maml:para>Currently, you can't create mail enabled groups in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MailNickname</maml:name> <maml:description> <maml:para>Specifies a mail nickname for the group. If MailEnabled is $False, you must still specify a mail nickname.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SecurityEnabled</maml:name> <maml:description> <maml:para>Specifies whether the group is security enabled. For security groups, this value must be $True.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GroupTypes</maml:name> <maml:description> <maml:para>Specifies that the group is a dynamic group. To create a dynamic group, specify a value of DynamicMembership.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MembershipRule</maml:name> <maml:description> <maml:para>Specifies the membership rule for a dynamic group.</maml:para> <maml:para>For more information about the rules that you can use for dynamic groups, see Using attributes to create advanced rules (https://learn.microsoft.com/entra/identity/users/groups-dynamic-membership).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MembershipRuleProcessingState</maml:name> <maml:description> <maml:para>Specifies the rule processing state. The acceptable values for this parameter are:</maml:para> <maml:para>* "On". Process the group rule.</maml:para> <maml:para>* "Paused". Stop processing the group rule.</maml:para> <maml:para></maml:para> <maml:para>Changing the value of the processing state doesn't change the members list of the group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Visibility</maml:name> <maml:description> <maml:para>This parameter determines the visibility of the group's content and members list. This parameter can take one of the following values:</maml:para> <maml:para>* "Public" - Anyone can view the contents of the group</maml:para> <maml:para>* "Private" - Only members can view the content of the group</maml:para> <maml:para>* "HiddenMembership" - Only members can view the content of the group and only members, owners, Global/Company Administrator, User Administrator and Helpdesk Administrators can view the members list of the group.</maml:para> <maml:para></maml:para> <maml:para>If no value is provided, the default value will be "Public".</maml:para> <maml:para>Notes:</maml:para> <maml:para>* This parameter is only valid for groups that have the groupType set to "Unified".</maml:para> <maml:para>* If a group has this attribute set to "HiddenMembership", it can't be changed later.</maml:para> <maml:para>* Anyone can join a group that has this attribute set to "Public". If the attribute is set to Private or HiddenMembership, only owner(s) can add new members to the group and requests to join the group need approval of the owner(s).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AssignedLabels</maml:name> <maml:description> <maml:para>This parameter allows the assignment of sensitivity labels to groups. For more information on how sensitivity labels can be assigned to groups, refer to Assign sensitivity labels (https://learn.microsoft.com/entra/identity/users/groups-dynamic-membership)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.AssignedLabel]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.AssignedLabel]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsAssignableToRole</maml:name> <maml:description> <maml:para>Flag indicates whether group can be assigned to a role. This property can only be set at the time of group creation and can't be modified on an existing group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProxyAddresses</maml:name> <maml:description> <maml:para>Sets the proxyAddresses attribute.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="Id"> <maml:name>AdministrativeUnitId</maml:name> <maml:description> <maml:para>Specifies the AdministrativeUnitId of a Microsoft Entra ID administrative unit.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OdataType</maml:name> <maml:description> <maml:para>Specifies the odata type of the object to create in the administrative unit.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a description for the group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Specifies a display name for the group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MailEnabled</maml:name> <maml:description> <maml:para>Specifies whether this group is mail enabled.</maml:para> <maml:para>Currently, you can't create mail enabled groups in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MailNickname</maml:name> <maml:description> <maml:para>Specifies a mail nickname for the group. If MailEnabled is $False, you must still specify a mail nickname.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SecurityEnabled</maml:name> <maml:description> <maml:para>Specifies whether the group is security enabled. For security groups, this value must be $True.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GroupTypes</maml:name> <maml:description> <maml:para>Specifies that the group is a dynamic group. To create a dynamic group, specify a value of DynamicMembership.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MembershipRule</maml:name> <maml:description> <maml:para>Specifies the membership rule for a dynamic group.</maml:para> <maml:para>For more information about the rules that you can use for dynamic groups, see Using attributes to create advanced rules (https://learn.microsoft.com/entra/identity/users/groups-dynamic-membership).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MembershipRuleProcessingState</maml:name> <maml:description> <maml:para>Specifies the rule processing state. The acceptable values for this parameter are:</maml:para> <maml:para>* "On". Process the group rule.</maml:para> <maml:para>* "Paused". Stop processing the group rule.</maml:para> <maml:para></maml:para> <maml:para>Changing the value of the processing state doesn't change the members list of the group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Visibility</maml:name> <maml:description> <maml:para>This parameter determines the visibility of the group's content and members list. This parameter can take one of the following values:</maml:para> <maml:para>* "Public" - Anyone can view the contents of the group</maml:para> <maml:para>* "Private" - Only members can view the content of the group</maml:para> <maml:para>* "HiddenMembership" - Only members can view the content of the group and only members, owners, Global/Company Administrator, User Administrator and Helpdesk Administrators can view the members list of the group.</maml:para> <maml:para></maml:para> <maml:para>If no value is provided, the default value will be "Public".</maml:para> <maml:para>Notes:</maml:para> <maml:para>* This parameter is only valid for groups that have the groupType set to "Unified".</maml:para> <maml:para>* If a group has this attribute set to "HiddenMembership", it can't be changed later.</maml:para> <maml:para>* Anyone can join a group that has this attribute set to "Public". If the attribute is set to Private or HiddenMembership, only owner(s) can add new members to the group and requests to join the group need approval of the owner(s).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AssignedLabels</maml:name> <maml:description> <maml:para>This parameter allows the assignment of sensitivity labels to groups. For more information on how sensitivity labels can be assigned to groups, refer to Assign sensitivity labels (https://learn.microsoft.com/entra/identity/users/groups-dynamic-membership)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.AssignedLabel]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.AssignedLabel]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsAssignableToRole</maml:name> <maml:description> <maml:para>Flag indicates whether group can be assigned to a role. This property can only be set at the time of group creation and can't be modified on an existing group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProxyAddresses</maml:name> <maml:description> <maml:para>Sets the proxyAddresses attribute.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>- Example 1: Create a dynamic group in an administrative unit -</maml:title> <dev:code>Connect-Entra -Scopes 'AdministrativeUnit.ReadWrite.All' $params = @{ AdministrativeUnitId = 'bbbbbbbb-1111-2222-3333-cccccccccccc' OdataType = 'Microsoft.Graph.Group' DisplayName = 'NewAUMember' Description = 'createdUnitMember' MailEnabled = $True MailNickname = 'new' SecurityEnabled = $False GroupTypes = @('Unified', 'DynamicMembership') MembershipRule = "(user.department -contains 'Marketing')" MembershipRuleProcessingState = 'On' IsAssignableToRole = $false Visibility = 'Public' ProxyAddresses = @('SMTP:Ahiresh@M365x99297270.onmicrosoft.com') } New-EntraBetaAdministrativeUnitMember @params Id DeletedDateTime -- --------------- dddddddd-2222-2222-3333-cccccccccccc</dev:code> <dev:remarks> <maml:para>This command creates a new dynamic group in an administrative unit with the following rule:</maml:para> <maml:para>`user.department -contains "Marketing"`</maml:para> <maml:para>The double quotation marks are replaced with single quotation marks.</maml:para> <maml:para>The processing state is On. It means that all users in the directory that qualify the rule are added as members to the group. Any users that don't qualify are removed from the group.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/New-EntraBetaAdministrativeUnitMember</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-EntraBetaAdministrativeUnitMember</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaAdministrativeUnitMember</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaAdministrativeUnitMember</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-EntraBetaAttributeSet</command:name> <command:verb>New</command:verb> <command:noun>EntraBetaAttributeSet</command:noun> <maml:description> <maml:para>Adds a new attribute set.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Adds a new Microsoft Entra ID attribute set object.</maml:para> <maml:para>In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role or a custom role with the necessary permissions. The Attribute Definition Administrator is the only privileged role supported for this operation.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-EntraBetaAttributeSet</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the attribute set, up to 128 characters long, including Unicode characters. This description can be changed later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Id"> <maml:name>AttributeSetId</maml:name> <maml:description> <maml:para>Name of the attribute set. Unique identifier for the attribute set within a tenant, up to 32 Unicode characters. It can't contain spaces or special characters, is case sensitive, and can't be changed later. Required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxAttributesPerSet</maml:name> <maml:description> <maml:para>Maximum number of custom security attributes that can be defined in this attribute set. The default value is null. If not specified, the administrator can add up to 500 active attributes per tenant. This setting can be changed later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the attribute set, up to 128 characters long, including Unicode characters. This description can be changed later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Id"> <maml:name>AttributeSetId</maml:name> <maml:description> <maml:para>Name of the attribute set. Unique identifier for the attribute set within a tenant, up to 32 Unicode characters. It can't contain spaces or special characters, is case sensitive, and can't be changed later. Required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxAttributesPerSet</maml:name> <maml:description> <maml:para>Maximum number of custom security attributes that can be defined in this attribute set. The default value is null. If not specified, the administrator can add up to 500 active attributes per tenant. This setting can be changed later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------ Example 1: Add a single attribute set ------------</maml:title> <dev:code>Connect-Entra -Scopes 'CustomSecAttributeDefinition.ReadWrite.All' $params = @{ AttributeSetId = 'Testing' Description = 'Attributes for engineering team' MaxAttributesPerSet = 10 } New-EntraBetaAttributeSet @params Id Description MaxAttributesPerSet -- ----------- ------------------- Testing Attributes for engineering team 10</dev:code> <dev:remarks> <maml:para>This example demonstrates hoe to add a single attribute set.</maml:para> <maml:para>- `-AttributeSetId` parameter specifies the name of the attribute set.</maml:para> <maml:para>- `-Description` parameter specifies the description for the attribute set.</maml:para> <maml:para>- `-MaxAttributesPerSet` parameter specifies the maximum number of custom security attributes.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/New-EntraBetaAttributeSet</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-EntraBetaAttributeSet</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaAttributeSet</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-EntraBetaCustomSecurityAttributeDefinition</command:name> <command:verb>New</command:verb> <command:noun>EntraBetaCustomSecurityAttributeDefinition</command:noun> <maml:description> <maml:para>Create a new customSecurityAttributeDefinition object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `New-EntraBetaCustomSecurityAttributeDefinition` cmdlet creates a new customSecurityAttributeDefinition object. Specify `IsSearchable`, `IsCollection`, `AttributeSet`, `Type`, `Name`, `Status` and `UsePreDefinedValuesOnly` parameters for create a new custom security attribute definition.</maml:para> <maml:para>You can define up to 500 active objects in a tenant.</maml:para> <maml:para>In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role or a custom role with the necessary permissions. The Attribute Definition Administrator is the only privileged role supported for this operation.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-EntraBetaCustomSecurityAttributeDefinition</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AttributeSet</maml:name> <maml:description> <maml:para>Name of the attribute set. Case insensitive.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the custom security attribute, up to 128 characters long and including Unicode characters. This description can be changed later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsCollection</maml:name> <maml:description> <maml:para>Indicates whether multiple values can be assigned to the custom security attribute. Can't be changed later. If type is set to Boolean, isCollection can't be set to true.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsSearchable</maml:name> <maml:description> <maml:para>Indicates whether custom security attribute values are indexed for searching on objects that are assigned attribute values. Can't be changed later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the custom security attribute. Must be unique within an attribute set. Can be up to 32 characters long and include Unicode characters. Can't contain spaces or special characters. Can't be changed later. Case insensitive.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Status</maml:name> <maml:description> <maml:para>Specifies whether the custom security attribute is active or deactivated. Acceptable values are: Available and Deprecated. Can be changed later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Data type for the custom security attribute values. Supported types are: Boolean, Integer, and String. Can't be changed later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UsePreDefinedValuesOnly</maml:name> <maml:description> <maml:para>Indicates whether only predefined values can be assigned to the custom security attribute. If set to false, free-form values are allowed. Can later be changed from true to false, but can't be changed from false to true. If type is set to Boolean, usePreDefinedValuesOnly can't be set to true.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AttributeSet</maml:name> <maml:description> <maml:para>Name of the attribute set. Case insensitive.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the custom security attribute, up to 128 characters long and including Unicode characters. This description can be changed later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsCollection</maml:name> <maml:description> <maml:para>Indicates whether multiple values can be assigned to the custom security attribute. Can't be changed later. If type is set to Boolean, isCollection can't be set to true.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsSearchable</maml:name> <maml:description> <maml:para>Indicates whether custom security attribute values are indexed for searching on objects that are assigned attribute values. Can't be changed later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the custom security attribute. Must be unique within an attribute set. Can be up to 32 characters long and include Unicode characters. Can't contain spaces or special characters. Can't be changed later. Case insensitive.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Status</maml:name> <maml:description> <maml:para>Specifies whether the custom security attribute is active or deactivated. Acceptable values are: Available and Deprecated. Can be changed later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Data type for the custom security attribute values. Supported types are: Boolean, Integer, and String. Can't be changed later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UsePreDefinedValuesOnly</maml:name> <maml:description> <maml:para>Indicates whether only predefined values can be assigned to the custom security attribute. If set to false, free-form values are allowed. Can later be changed from true to false, but can't be changed from false to true. If type is set to Boolean, usePreDefinedValuesOnly can't be set to true.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---------- Example 1: Add a custom security attribute ----------</maml:title> <dev:code>Connect-Entra -Scopes 'CustomSecAttributeDefinition.Read.All', 'CustomSecAttributeDefinition.ReadWrite.All' $AttributeSet = Get-EntraBetaAttributeSet -Id '<CustomAttributeSetId>' $params = @{ Name = 'ProjectTest' Description = 'Target completion' Type = 'String' Status = 'Available' AttributeSet = $AttributeSet.Id IsCollection = $False IsSearchable = $True UsePreDefinedValuesOnly = $True } New-EntraBetaCustomSecurityAttributeDefinition @params Id AttributeSet Description IsCollection IsSearchable Name Status Type UsePreDefinedValuesOnly -- ------------ ----------- ------------ ------------ ---- ------ ---- ----------------------- Test_ProjectTest Test Target completion False True ProjectTest Available String False</dev:code> <dev:remarks> <maml:para>This example demonstrates how to add a custom security attribute.</maml:para> <maml:para>- `-Name` parameter specifies the name of the custom security attribute.</maml:para> <maml:para>- `-Description` parameter specifies the description of the custom security attribute.</maml:para> <maml:para>- `-Type` parameter specifies the data type for the custom security attribute values.</maml:para> <maml:para>- `-Status` parameter specifies the custom security attribute is active or deactivated.</maml:para> <maml:para>- `-AttributeSet` parameter specifies the name of attribute set.</maml:para> <maml:para>- `-IsCollection` parameter specifies the allows multiple values can be assigned to the custom security attribute.</maml:para> <maml:para>- `-IsSearchable` parameter specifies the custom security attribute values are indexed for searching on objects.</maml:para> <maml:para>- `-UsePreDefinedValuesOnly` parameter specifies the only predefined values can be assigned to the custom security attribute.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/New-EntraBetaCustomSecurityAttributeDefinition</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-EntraBetaCustomSecurityAttributeDefinition</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaCustomSecurityAttributeDefinition</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-EntraBetaDevice</command:name> <command:verb>New</command:verb> <command:noun>EntraBetaDevice</command:noun> <maml:description> <maml:para>Creates a device.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `New-EntraBetaDevice` cmdlet creates a device in Microsoft Entra ID.</maml:para> <maml:para>The calling user must be in one of the following Microsoft Entra roles: Intune Administrator or Windows 365 Administrator.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-EntraBetaDevice</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AccountEnabled</maml:name> <maml:description> <maml:para>Indicates whether the account is enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AlternativeSecurityIds</maml:name> <maml:description> <maml:para>Specifies alternative security IDs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.AlternativeSecurityId]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.AlternativeSecurityId]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ApproximateLastLogonTimeStamp</maml:name> <maml:description> <maml:para>Specifies last sign-in date time.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DeviceId</maml:name> <maml:description> <maml:para>Specifies the ID of the device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DeviceMetadata</maml:name> <maml:description> <maml:para>The metadata for this device</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DeviceObjectVersion</maml:name> <maml:description> <maml:para>Specifies the object version of the device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DeviceOSType</maml:name> <maml:description> <maml:para>Specifies the operating system type of the new device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DeviceOSVersion</maml:name> <maml:description> <maml:para>Specifies the operating system version of the new device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DevicePhysicalIds</maml:name> <maml:description> <maml:para>Specifies the physical ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DeviceTrustType</maml:name> <maml:description> <maml:para>The trust type for this device</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Specifies the display name of the new device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsCompliant</maml:name> <maml:description> <maml:para>True if the device complies with Mobile Device Management (MDM) policies; otherwise, false.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsManaged</maml:name> <maml:description> <maml:para>True if the device is managed by a Mobile Device Management (MDM) app such as Intune; otherwise, false.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProfileType</maml:name> <maml:description> <maml:para>Specifies profile type of the device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SystemLabels</maml:name> <maml:description> <maml:para>Specifies labels for the device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AccountEnabled</maml:name> <maml:description> <maml:para>Indicates whether the account is enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AlternativeSecurityIds</maml:name> <maml:description> <maml:para>Specifies alternative security IDs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.AlternativeSecurityId]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.AlternativeSecurityId]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ApproximateLastLogonTimeStamp</maml:name> <maml:description> <maml:para>Specifies last sign-in date time.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DeviceId</maml:name> <maml:description> <maml:para>Specifies the ID of the device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DeviceMetadata</maml:name> <maml:description> <maml:para>The metadata for this device</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DeviceObjectVersion</maml:name> <maml:description> <maml:para>Specifies the object version of the device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DeviceOSType</maml:name> <maml:description> <maml:para>Specifies the operating system type of the new device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DeviceOSVersion</maml:name> <maml:description> <maml:para>Specifies the operating system version of the new device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DevicePhysicalIds</maml:name> <maml:description> <maml:para>Specifies the physical ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DeviceTrustType</maml:name> <maml:description> <maml:para>The trust type for this device</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Specifies the display name of the new device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsCompliant</maml:name> <maml:description> <maml:para>True if the device complies with Mobile Device Management (MDM) policies; otherwise, false.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsManaged</maml:name> <maml:description> <maml:para>True if the device is managed by a Mobile Device Management (MDM) app such as Intune; otherwise, false.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProfileType</maml:name> <maml:description> <maml:para>Specifies profile type of the device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SystemLabels</maml:name> <maml:description> <maml:para>Specifies labels for the device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------ Example 1: Create a device ------------------</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.AccessAsUser.All','Device.ReadWrite.All' $params = @{ AccountEnabled = $true DisplayName = 'My new device' AlternativeSecurityIds = $altsecid DeviceId = $guid DeviceOSType = 'OS/2' DeviceOSVersion = '9.3' } New-EntraBetaDevice @params ObjectId DeviceId DisplayName -------- -------- ----------- aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb dddddddd-3333-4444-5555-eeeeeeeeeeee My new device</dev:code> <dev:remarks> <maml:para>This command creates a new device.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/New-EntraBetaDevice</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaDevice</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaDevice</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-EntraBetaDevice</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-EntraBetaDirectorySetting</command:name> <command:verb>New</command:verb> <command:noun>EntraBetaDirectorySetting</command:noun> <maml:description> <maml:para>Creates a directory settings object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `New-EntraBetaDirectorySetting` cmdlet creates a directory settings object in Microsoft Entra ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-EntraBetaDirectorySetting</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>DirectorySetting</maml:name> <maml:description> <maml:para>Specifies directory settings.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DirectorySetting</command:parameterValue> <dev:type> <maml:name>DirectorySetting</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>DirectorySetting</maml:name> <maml:description> <maml:para>Specifies directory settings.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DirectorySetting</command:parameterValue> <dev:type> <maml:name>DirectorySetting</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------ Example 1: Creates new settings object ------------</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.ReadWrite.All', 'Group.Read.All' , 'Group.ReadWrite.All' $TemplateId = (Get-EntraBetaDirectorySettingTemplate | where { $_.DisplayName -eq "Group.Unified" }).Id $Template = Get-EntraBetaDirectorySettingTemplate | where -Property Id -Value $TemplateId -EQ $Setting = $Template.CreateDirectorySetting() $Setting["UsageGuidelinesUrl"] = "https://guideline.example.com" $Setting["EnableMIPLabels"] = "True" New-EntraBetaDirectorySetting -DirectorySetting $Setting Id DisplayName TemplateId -- ----------- ---------- aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb 00aa00aa-bb11-cc22-dd33-44ee44ee44ee</dev:code> <dev:remarks> <maml:para>This example Creates new settings object in Microsoft Entra ID.</maml:para> <maml:para>- `-DirectorySetting` Parameter Create a new setting using templates from `DirectorySettingTemplates`</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/New-EntraBetaDirectorySetting</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaDirectorySetting</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaDirectorySetting</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-EntraBetaDirectorySetting</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-EntraBetaDomain</command:name> <command:verb>New</command:verb> <command:noun>EntraBetaDomain</command:noun> <maml:description> <maml:para>Creates a domain.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `New-EntraBetaDomain` cmdlet creates a domain in Microsoft Entra ID.</maml:para> <maml:para>The work or school account needs to belong to at least the Domain Name Administrator role.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-EntraBetaDomain</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsDefault</maml:name> <maml:description> <maml:para>Indicates whether or not this is the default domain that is used for user creation.</maml:para> <maml:para>There is only one default domain per company.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The fully qualified name of the domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SupportedServices</maml:name> <maml:description> <maml:para>The capabilities assigned to the domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsDefault</maml:name> <maml:description> <maml:para>Indicates whether or not this is the default domain that is used for user creation.</maml:para> <maml:para>There is only one default domain per company.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The fully qualified name of the domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SupportedServices</maml:name> <maml:description> <maml:para>The capabilities assigned to the domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---------------- Example 1: Create a new Domain ----------------</maml:title> <dev:code>Connect-Entra -Scopes 'Domain.ReadWrite.All' New-EntraBetaDomain -Name test22.com Id AuthenticationType AvailabilityStatus IsAdminManaged IsDefault IsInitial IsRoot IsVerified PasswordNotificationWindowInDays -- ------------------ ------------------ -------------- --------- --------- ------ ---------- -------------------------------- test22.com Managed True False False False False 13</dev:code> <dev:remarks> <maml:para>This example demonstrates how to create a new domain in Microsoft Entra ID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Create a new Domain with a list of domain capabilities</maml:title> <dev:code>Connect-Entra -Scopes 'Domain.ReadWrite.All' New-EntraBetaDomain -Name test22.com -SupportedServices @('Email', 'OfficeCommunicationsOnline') Id AuthenticationType AvailabilityStatus IsAdminManaged IsDefault IsInitial IsRoot IsVerified PasswordNotificationWindowInDays -- ------------------ ------------------ -------------- --------- --------- ------ ---------- -------------------------------- test22.com Managed True False False False False 13</dev:code> <dev:remarks> <maml:para>This example demonstrates how to create a new domain with the specified services in Microsoft Entra ID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 3: Create a new Domain and make if the default new user creation</maml:title> <dev:code>Connect-Entra -Scopes 'Domain.ReadWrite.All' New-EntraBetaDomain -Name test22.com -IsDefault $true Id AuthenticationType AvailabilityStatus IsAdminManaged IsDefault IsInitial IsRoot IsVerified PasswordNotificationWindowInDays -- ------------------ ------------------ -------------- --------- --------- ------ ---------- -------------------------------- test22.com Managed True False False False False 13</dev:code> <dev:remarks> <maml:para>This example demonstrates how to create a new domain in Microsoft Entra ID and marks it as the default to be used for new user creation.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/New-EntraBetaDomain</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Confirm-EntraBetaDomain</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaDomain</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaDomain</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-EntraBetaDomain</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-EntraBetaAdministrativeUnit</command:name> <command:verb>Remove</command:verb> <command:noun>EntraBetaAdministrativeUnit</command:noun> <maml:description> <maml:para>Removes an administrative unit.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Remove-EntraBetaAdministrativeUnit` cmdlet removes an administrative unit from Microsoft Entra ID. Specify `AdministrativeUnitId` parameter to delete an administrative unit.</maml:para> <maml:para>To delete an administrative unit, the calling principal must have at least the Privileged Role Administrator role in Microsoft Entra.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-EntraBetaAdministrativeUnit</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="Id"> <maml:name>AdministrativeUnitId</maml:name> <maml:description> <maml:para>Specifies the ID of an administrative unit in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="Id"> <maml:name>AdministrativeUnitId</maml:name> <maml:description> <maml:para>Specifies the ID of an administrative unit in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----------- Example 1: Remove an administrative unit -----------</maml:title> <dev:code>Connect-Entra -Scopes 'AdministrativeUnit.ReadWrite.All' $administrativeUnit = Get-EntraBetaAdministrativeUnit -Filter "DisplayName eq '<administrative-unit-display-name>'" Remove-EntraBetaAdministrativeUnit -AdministrativeUnitId $administrativeUnit.Id</dev:code> <dev:remarks> <maml:para>This command removes the specified administrative unit from Microsoft Entra ID.</maml:para> <maml:para>- `-AdministrativeUnitId` parameter specifies the ID of an administrative unit.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Remove-EntraBetaAdministrativeUnit</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-EntraBetaAdministrativeUnit</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-EntraBetaAdministrativeUnit</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaAdministrativeUnit</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-EntraBetaAdministrativeUnitMember</command:name> <command:verb>Remove</command:verb> <command:noun>EntraBetaAdministrativeUnitMember</command:noun> <maml:description> <maml:para>Removes an administrative unit member.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Remove-EntraBetaAdministrativeUnitMember` cmdlet removes an administrative unit member in Microsoft Entra ID. Specify `AdministrativeUnitId` and `MemberId` to remove an administrative unit member.</maml:para> <maml:para>To remove a member from an administrative unit, the calling principal must have at least the Privileged Role Administrator role in Microsoft Entra.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-EntraBetaAdministrativeUnitMember</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>MemberId</maml:name> <maml:description> <maml:para>Specifies the ID of the administrative unit member.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>AdministrativeUnitId</maml:name> <maml:description> <maml:para>Specifies the ID of an administrative unit in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>MemberId</maml:name> <maml:description> <maml:para>Specifies the ID of the administrative unit member.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>AdministrativeUnitId</maml:name> <maml:description> <maml:para>Specifies the ID of an administrative unit in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------- Example 1: Remove an administrative unit member -------</maml:title> <dev:code>Connect-Entra -Scopes 'AdministrativeUnit.Read.All' $administrativeUnit = Get-EntraBetaAdministrativeUnit -Filter "DisplayName eq 'Pacific Administrative Unit'" $adminUnitMember = Get-EntraBetaAdministrativeUnitMember -AdministrativeUnitId $administrativeUnit.Id | Select-Object Id, DisplayName,'@odata.type' | Where-Object {$_.DisplayName -eq 'Saywer Miller'} Remove-EntraBetaAdministrativeUnitMember -AdministrativeUnitId $administrativeUnit.Id -MemberId $adminUnitMember.Id</dev:code> <dev:remarks> <maml:para>This command removes a specified member (user or group) from a specified administrative unit.</maml:para> <maml:para>- `-AdministrativeUnitId` parameter specifies the ID of an administrative unit.</maml:para> <maml:para>- `-MemberId` parameter specifies the ID of the administrative unit member.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Remove-EntraBetaAdministrativeUnitMember</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-EntraBetaAdministrativeUnitMember</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaAdministrativeUnitMember</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-EntraBetaAdministrativeUnitMember</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-EntraBetaContact</command:name> <command:verb>Remove</command:verb> <command:noun>EntraBetaContact</command:noun> <maml:description> <maml:para>Removes a contact.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Remove-EntraBetaContact` removes a contact from Microsoft Entra ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-EntraBetaContact</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>OrgContactId</maml:name> <maml:description> <maml:para>Specifies the object ID of a contact in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>OrgContactId</maml:name> <maml:description> <maml:para>Specifies the object ID of a contact in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----------------- Example 1: Remove a contact -----------------</maml:title> <dev:code>Connect-Entra -Scopes 'OrgContact.Read.All' $Contact = Get-EntraBetaContact -Filter "DisplayName eq 'Contoso Contact'" Remove-EntraBetaContact -OrgContactId $Contact.ObjectId</dev:code> <dev:remarks> <maml:para>The example shows how to remove a contact.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Remove-EntraBetaContact</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaContact</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-EntraBetaDevice</command:name> <command:verb>Remove</command:verb> <command:noun>EntraBetaDevice</command:noun> <maml:description> <maml:para>Deletes a device.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Remove-EntraBetaDevice` cmdlet removes a device from Microsoft Entra ID.</maml:para> <maml:para>The calling user must be in one of the following Microsoft Entra roles: Intune Administrator, Windows 365 Administrator, or Cloud Device Administrator.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-EntraBetaDevice</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>DeviceId</maml:name> <maml:description> <maml:para>Specifies the object ID of a device in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>DeviceId</maml:name> <maml:description> <maml:para>Specifies the object ID of a device in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------ Example 1: Remove a device ------------------</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.AccessAsUser.All','Device.ReadWrite.All' $Device = Get-EntraBetaDevice -Filter "DisplayName eq 'Woodgrove Desktop'" Remove-EntraBetaDevice -DeviceId $Device.ObjectId</dev:code> <dev:remarks> <maml:para>This command removes the specified device.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Remove-EntraBetaDevice</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaDevice</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-EntraBetaDevice</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-EntraBetaDevice</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-EntraBetaDeviceRegisteredOwner</command:name> <command:verb>Remove</command:verb> <command:noun>EntraBetaDeviceRegisteredOwner</command:noun> <maml:description> <maml:para>Removes the registered owner of a device.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Remove-EntraBetaDeviceRegisteredOwner` cmdlet removes the registered owner of a device in Microsoft Entra ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-EntraBetaDeviceRegisteredOwner</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>DeviceId</maml:name> <maml:description> <maml:para>Specifies an object ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>OwnerId</maml:name> <maml:description> <maml:para>Specifies an owner ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>DeviceId</maml:name> <maml:description> <maml:para>Specifies an object ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>OwnerId</maml:name> <maml:description> <maml:para>Specifies an owner ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----------- Example 1: Remove an owner from a device -----------</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.AccessAsUser.All' $Device = Get-EntraBetaDevice -Top 1 $Owner = Get-EntraBetaDeviceRegisteredOwner -ObjectId $Device.ObjectId Remove-EntraBetaDeviceRegisteredOwner -DeviceId $Device.ObjectId -OwnerId $Owner.ObjectId</dev:code> <dev:remarks> <maml:para>This examples shows how to remove the owner of a device.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Remove-EntraBetaDeviceRegisteredOwner</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-EntraBetaDeviceRegisteredOwner</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaDevice</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaDeviceRegisteredOwner</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-EntraBetaDeviceRegisteredUser</command:name> <command:verb>Remove</command:verb> <command:noun>EntraBetaDeviceRegisteredUser</command:noun> <maml:description> <maml:para>Removes a registered user from a device.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Remove-EntraBetaDeviceRegisteredUser` cmdlet removes a registered user from a Microsoft Entra ID device.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-EntraBetaDeviceRegisteredUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>DeviceId</maml:name> <maml:description> <maml:para>Specifies the ID of an object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Specifies the ID of a user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>DeviceId</maml:name> <maml:description> <maml:para>Specifies the ID of an object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Specifies the ID of a user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------ Example 1: Remove a registered user from a device ------</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.AccessAsUser.All' $Device = Get-EntraBetaDevice -Top 1 $User = Get-EntraBetaDeviceRegisteredUser -DeviceId $Device.ObjectId Remove-EntraBetaDeviceRegisteredUser -DeviceId $Device.ObjectId -UserId $User.ObjectId</dev:code> <dev:remarks> <maml:para>This example shows how to remove the registered user from device.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Remove-EntraBetaDeviceRegisteredUser</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-EntraBetaDeviceRegisteredUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaDeviceRegisteredUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-EntraBetaDirectoryRoleMember</command:name> <command:verb>Remove</command:verb> <command:noun>EntraBetaDirectoryRoleMember</command:noun> <maml:description> <maml:para>Removes a member of a directory role.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Remove-EntraBetaDirectoryRoleMember` cmdlet removes a member from a directory role in Microsoft Entra ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-EntraBetaDirectoryRoleMember</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>MemberId</maml:name> <maml:description> <maml:para>Specifies the object ID of a role member.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>DirectoryRoleId</maml:name> <maml:description> <maml:para>Specifies the object ID of a directory role in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>MemberId</maml:name> <maml:description> <maml:para>Specifies the object ID of a role member.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>DirectoryRoleId</maml:name> <maml:description> <maml:para>Specifies the object ID of a directory role in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------- Example 1: Remove a member from a directory role -------</maml:title> <dev:code>Connect-Entra -Scopes 'RoleManagement.ReadWrite.Directory' $params = @{ DirectoryRoleId = 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb' MemberId = 'bbbbbbbb-1111-2222-3333-cccccccccccc' } Remove-EntraBetaDirectoryRoleMember @params</dev:code> <dev:remarks> <maml:para>This example removes the specified member from the specified role.</maml:para> <maml:para>- `-DirectoryRoleId` parameter specifies the object ID of the directory role.</maml:para> <maml:para>- `-MemberId` parameter specifies the object ID of the role member to removed.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Remove-EntraBetaDirectoryRoleMember</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-EntraBetaDirectoryRoleMember</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaDirectoryRoleMember</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-EntraBetaDirectorySetting</command:name> <command:verb>Remove</command:verb> <command:noun>EntraBetaDirectorySetting</command:noun> <maml:description> <maml:para>Deletes a directory setting in Microsoft Entra ID.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Remove-EntraBetaDirectorySetting` cmdlet removes a directory setting from Microsoft Entra ID.</maml:para> <maml:para>In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role or a custom role with the necessary permissions. The following least privileged roles are supported:</maml:para> <maml:para>- Microsoft Entra Joined Device Local Administrator: Read basic properties on setting templates and settings.</maml:para> <maml:para>- Directory Readers: Read basic properties on setting templates and settings.</maml:para> <maml:para>- Global Reader: Read basic properties on setting templates and settings.</maml:para> <maml:para>- Groups Administrator: Manage all group settings.</maml:para> <maml:para>- Directory Writers: Manage all group settings.</maml:para> <maml:para>- Authentication Policy Administrator: Update Password Rule Settings.</maml:para> <maml:para>- User Administrator: Read basic properties on setting templates and settings.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-EntraBetaDirectorySetting</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the object ID of a settings object in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the object ID of a settings object in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Removes a directory setting from Microsoft Entra ID</maml:title> <dev:code>Connect-Entra -Scopes 'RoleManagement.ReadWrite.Directory' Remove-EntraBetaDirectorySetting -Id 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb'</dev:code> <dev:remarks> <maml:para>This command removes a directory setting from Microsoft Entra ID.</maml:para> <maml:para>- `-Id` Specifies the object ID of a settings object.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Remove-EntraBetaDirectorySetting</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaDirectorySetting</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-EntraBetaDirectorySetting</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-EntraBetaDirectorySetting</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-EntraBetaDomain</command:name> <command:verb>Remove</command:verb> <command:noun>EntraBetaDomain</command:noun> <maml:description> <maml:para>Removes a domain.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Remove-EntraBetaDomain` cmdlet removes a domain from Microsoft Entra ID.</maml:para> <maml:para>Important:</maml:para> <maml:para>- Deleted domains are not recoverable.</maml:para> <maml:para>- Attempts to delete will fail if there are any resources or objects still dependent on the domain.</maml:para> <maml:para></maml:para> <maml:para>The work or school account needs to belong to at least the `Domain Name Administrator` Microsoft Entra role.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-EntraBetaDomain</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the domain to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the domain to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------ Example 1: Remove a domain ------------------</maml:title> <dev:code>Connect-Entra -Scopes 'Domain.ReadWrite.All' Remove-EntraBetaDomain -Name Contoso.com</dev:code> <dev:remarks> <maml:para>This command removes a domain from Microsoft Entra ID.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Remove-EntraBetaDomain</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Confirm-EntraBetaDomain</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaDomain</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-EntraBetaDomain</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-EntraBetaDomain</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-EntraBetaScopedRoleMembership</command:name> <command:verb>Remove</command:verb> <command:noun>EntraBetaScopedRoleMembership</command:noun> <maml:description> <maml:para>Removes a scoped role membership.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Remove-EntraBetaScopedRoleMembership` cmdlet removes a scoped role membership from Microsoft Entra ID. Specify `AdministrativeUnitId` and `ScopedRoleMembershipId` parameter to remove a scoped role membership.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-EntraBetaScopedRoleMembership</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>AdministrativeUnitId</maml:name> <maml:description> <maml:para>Specifies the ID of an administrative unit object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ScopedRoleMembershipId</maml:name> <maml:description> <maml:para>Specifies the ID of the scoped role membership to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>AdministrativeUnitId</maml:name> <maml:description> <maml:para>Specifies the ID of an administrative unit object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>ScopedRoleMembershipId</maml:name> <maml:description> <maml:para>Specifies the ID of the scoped role membership to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---------- Example 1: Remove a scoped role membership ----------</maml:title> <dev:code>Connect-Entra -Scopes 'RoleManagement.Read.Directory' $role = Get-EntraBetaDirectoryRole -Filter "DisplayName eq 'Helpdesk Administrator'" $administrativeUnit = Get-EntraBetaAdministrativeUnit -Filter "DisplayName eq 'Pacific Administrative Unit'" $roleMembership = Get-EntraBetaScopedRoleMembership -AdministrativeUnitId $administrativeUnit.Id | Where-Object {$_.RoleId -eq $role.Id} Remove-EntraBetaScopedRoleMembership -AdministrativeUnitId $administrativeUnit.Id -ScopedRoleMembershipId $roleMembership.Id</dev:code> <dev:remarks> <maml:para>This cmdlet removes a specific scoped role membership from Microsoft Entra ID. You can use the command `Get-EntraBetaAdministrativeUnit` to get administrative unit Id.</maml:para> <maml:para>- `-AdministrativeUnitId` parameter specifies the ID of an administrative unit.</maml:para> <maml:para>- `-ScopedRoleMembershipId` parameter specifies the ID of the scoped role membership to remove. To obtain the details of a scoped role membership, you can use the `Get-EntraBetaScopedRoleMembership` command.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Remove-EntraBetaScopedRoleMembership</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-EntraBetaScopedRoleMembership</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaScopedRoleMembership</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Restore-EntraBetaDeletedDirectoryObject</command:name> <command:verb>Restore</command:verb> <command:noun>EntraBetaDeletedDirectoryObject</command:noun> <maml:description> <maml:para>Restore a previously deleted object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Restore-EntraBetaDeletedDirectoryObject` cmdlet is used to restore previously deleted objects, such as application, group, service principal, administrative unit, or user objects.</maml:para> <maml:para>When a group or application is deleted, it is initially soft deleted and can be recovered within the first 30 days. After 30 days, the deleted object is permanently deleted and cannot be recovered. Notes: - Only Unified Groups (also known as Office 365 Groups) can be restored; Security groups cannot be restored.</maml:para> <maml:para>- Restoring an application does not automatically restore its associated service principal. You must explicitly use this cmdlet to restore the deleted service principal.</maml:para> <maml:para></maml:para> <maml:para>For delegated scenarios, the calling user needs to have at least one of the following Microsoft Entra roles:</maml:para> <maml:para>- To restore deleted applications or service principals: Application Administrator, Cloud Application Administrator, or Hybrid Identity Administrator. - To restore deleted users: User Administrator. - However, to restore users with privileged administrator roles: - In delegated scenarios, the app must be assigned the `Directory.AccessAsUser.All` delegated permission, and the calling user must also be assigned a higher privileged administrator role. - In app-only scenarios, in addition to being granted the `User.ReadWrite.All` application permission, the app must be assigned a higher privileged administrator role. - To restore deleted groups: Groups Administrator. - However, to restore role-assignable groups, the calling user must be assigned the Privileged Role Administrator role.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Restore-EntraBetaDeletedDirectoryObject</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The Id of the directory object to restore.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>AutoReconcileProxyConflict</maml:name> <maml:description> <maml:para>Specifies whether Microsoft Entra ID should remove conflicting proxy addresses when restoring a soft-deleted user, if any of the user's proxy addresses are currently in use by an active user. This parameter applies only when restoring a soft-deleted user. The default value is `false`.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The Id of the directory object to restore.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>AutoReconcileProxyConflict</maml:name> <maml:description> <maml:para>Specifies whether Microsoft Entra ID should remove conflicting proxy addresses when restoring a soft-deleted user, if any of the user's proxy addresses are currently in use by an active user. This parameter applies only when restoring a soft-deleted user. The default value is `false`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1: Restore a deleted object with ID ---------</maml:title> <dev:code>Connect-Entra -Scopes 'AdministrativeUnit.ReadWrite.All' #administrativeUnit resource Connect-Entra -Scopes 'Application.ReadWrite.All' #application resource Connect-Entra -Scopes 'Group.ReadWrite.All' #group resource Connect-Entra -Scopes 'Application.ReadWrite.All' #servicePrincipal resource Connect-Entra -Scopes 'User.ReadWrite.All' #user resource Restore-EntraBetaDeletedDirectoryObject -Id 'dddddddd-3333-4444-5555-eeeeeeeeeeee' Id DeletedDateTime -- --------------- dddddddd-3333-4444-5555-eeeeeeeeeeee</dev:code> <dev:remarks> <maml:para>This example shows how to restore a deleted object in Microsoft Entra ID.</maml:para> <maml:para>- `-Id` parameter specifies the Id of the directory object to restore.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Restoring a Soft-Deleted User and Removing Conflicting Proxy Addresses</maml:title> <dev:code>Connect-Entra -Scopes 'User.ReadWrite.All' Restore-EntraBetaDeletedDirectoryObject -Id 'dddddddd-3333-4444-5555-eeeeeeeeeeee' -AutoReconcileProxyConflict Id DeletedDateTime -- --------------- dddddddd-3333-4444-5555-eeeeeeeeeeee</dev:code> <dev:remarks> <maml:para>This example shows how to restore a deleted object in Microsoft Entra ID.</maml:para> <maml:para>- `-Id` parameter specifies the Id of the directory object to restore.</maml:para> <maml:para>- `-AutoReconcileProxyConflict` parameter removes any conflicting proxy addresses while restoring a soft-deleted user whose one or more proxy addresses are currently used for an active user.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Restore-EntraBetaDeletedDirectoryObject</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaDeletedApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Restore-EntraBetaDeletedApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaDeletedDirectoryObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaDeletedApplication</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaDeletedDirectoryObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-EntraBetaAdministrativeUnit</command:name> <command:verb>Set</command:verb> <command:noun>EntraBetaAdministrativeUnit</command:noun> <maml:description> <maml:para>Updates an administrative unit.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Set-EntraBetaAdministrativeUnit` cmdlet updates an administrative unit in Microsoft Entra ID. Specify `AdministrativeUnitId` parameter to update a specific administrative unit.</maml:para> <maml:para>In delegated scenarios, the signed-in user must be assigned a supported Microsoft Entra role or a custom role with the `microsoft.directory/administrativeUnits/allProperties/allTasks` permission.</maml:para> <maml:para>The Privileged Role Administrator is the least privileged role required for this operation.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-EntraBetaAdministrativeUnit</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a description.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Specifies a display name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsMemberManagementRestricted</maml:name> <maml:description> <maml:para>Indicates whether the management rights on resources in the administrative units should be restricted to ONLY the administrators scoped on the administrative unit object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="Id"> <maml:name>AdministrativeUnitId</maml:name> <maml:description> <maml:para>Specifies the Id of an administrative unit in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a description.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Specifies a display name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsMemberManagementRestricted</maml:name> <maml:description> <maml:para>Indicates whether the management rights on resources in the administrative units should be restricted to ONLY the administrators scoped on the administrative unit object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="Id"> <maml:name>AdministrativeUnitId</maml:name> <maml:description> <maml:para>Specifies the Id of an administrative unit in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------- Example 1: Update DisplayName and description --------</maml:title> <dev:code>Connect-Entra -Scopes 'AdministrativeUnit.ReadWrite.All' $administrativeUnit = Get-EntraBetaAdministrativeUnit -Filter "DisplayName eq 'Pacific Administrative Unit'" Set-EntraBetaAdministrativeUnit -AdministrativeUnitId $administrativeUnit.Id -DisplayName 'Pacific Admin Unit' -Description 'Pacific Admin Unit Description'</dev:code> <dev:remarks> <maml:para>This Command update DisplayName of specific administrative unit.</maml:para> <maml:para>- `-AdministrativeUnitId` parameter specifies the Id of an administrative unit.</maml:para> <maml:para>- `-DisplayName` parameter specifies the display name for the administrative unit.</maml:para> <maml:para>- `-Description` parameter specifies the description for the administrative unit.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------- Example 2: Update IsMemberManagementRestricted --------</maml:title> <dev:code>Connect-Entra -Scopes 'AdministrativeUnit.ReadWrite.All' $administrativeUnit = Get-EntraBetaAdministrativeUnit -Filter "DisplayName eq '<administrative-unit-display-name>'" Set-EntraBetaAdministrativeUnit -AdministrativeUnitId $administrativeUnit.Id -IsMemberManagementRestricted $True</dev:code> <dev:remarks> <maml:para>This example shows how to update the `IsMemberManagementRestricted` setting for a specific administrative unit.</maml:para> <maml:para>- `-AdministrativeUnitId` parameter specifies the Id of an administrative unit.</maml:para> <maml:para>- `-IsMemberManagementRestricted` parameter specifies the management rights on resources in the administrative units should be restricted to ONLY the administrators scoped on the administrative unit object.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Set-EntraBetaAdministrativeUnit</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaAdministrativeUnit</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-EntraBetaAdministrativeUnit</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaAdministrativeUnit</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-EntraBetaAttributeSet</command:name> <command:verb>Set</command:verb> <command:noun>EntraBetaAttributeSet</command:noun> <maml:description> <maml:para>Updates an existing attribute set.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Set-EntraBetaAttributeSet` cmdlet updates a Microsoft Entra ID attribute set object specified by its ID. Specify `AttributeSetId` parameter to Update a Microsoft Entra ID attribute set object.</maml:para> <maml:para>In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role or a custom role with a supported role permission.</maml:para> <maml:para>Note: Only the Attribute Definition Administrator role is supported for this operation. Ensure the signed-in user is assigned this role.</maml:para> <maml:para>You can only update the `description` and `maxAttributesPerSet` properties.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-EntraBetaAttributeSet</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the attribute set, up to 128 characters long, including Unicode characters. This description can be changed later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="Id"> <maml:name>AttributeSetId</maml:name> <maml:description> <maml:para>Name of the attribute set. Unique identifier for the attribute set within a tenant. This identifier can be up to 32 characters long and may include Unicode characters. It cannot contain spaces or special characters, and it cannot be changed later. The identifier is case insensitive.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxAttributesPerSet</maml:name> <maml:description> <maml:para>Maximum number of custom security attributes that can be defined in this attribute set. The default value is null. If not specified, the administrator can add up to 500 active attributes per tenant. This setting can be changed later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the attribute set, up to 128 characters long, including Unicode characters. This description can be changed later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="Id"> <maml:name>AttributeSetId</maml:name> <maml:description> <maml:para>Name of the attribute set. Unique identifier for the attribute set within a tenant. This identifier can be up to 32 characters long and may include Unicode characters. It cannot contain spaces or special characters, and it cannot be changed later. The identifier is case insensitive.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxAttributesPerSet</maml:name> <maml:description> <maml:para>Maximum number of custom security attributes that can be defined in this attribute set. The default value is null. If not specified, the administrator can add up to 500 active attributes per tenant. This setting can be changed later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------- Example 1: Update an attribute set --------------</maml:title> <dev:code>Connect-Entra -Scopes 'CustomSecAttributeDefinition.ReadWrite.All' $params = @{ AttributeSetId = 'Engineering' Description = 'Attributes for engineering team' } Set-EntraBetaAttributeSet @params</dev:code> <dev:remarks> <maml:para>This example update an attribute set.</maml:para> <maml:para>- `AttributeSetId` parameter specifies the name of the attribute set. You can `Get-EntraBetaAttributeSet` to get more details.</maml:para> <maml:para>- `Description` parameter specifies the description for the attribute set.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>- Example 2: Update an attribute set using MaxAttributesPerSet -</maml:title> <dev:code>Connect-Entra -Scopes 'CustomSecAttributeDefinition.ReadWrite.All' $params = @{ AttributeSetId = 'Engineering' MaxAttributesPerSet = 10 } Set-EntraBetaAttributeSet @params</dev:code> <dev:remarks> <maml:para>This example update an attribute set using MaxAttributesPerSet.</maml:para> <maml:para>- `-AttributeSetId` parameter specifies the name of the attribute set. You can `Get-EntraBetaAttributeSet` to get more details.</maml:para> <maml:para>- `-MaxAttributesPerSet` parameter specifies the maximum number of custom security attributes.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Set-EntraBetaAttributeSet</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-EntraBetaAttributeSet</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaAttributeSet</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-EntraBetaCustomSecurityAttributeDefinition</command:name> <command:verb>Set</command:verb> <command:noun>EntraBetaCustomSecurityAttributeDefinition</command:noun> <maml:description> <maml:para>Update the properties of a customSecurityAttributeDefinition object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update the properties of a customSecurityAttributeDefinition object. Specify `Id` parameter to update a custom security attribute definition.</maml:para> <maml:para>In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role or a custom role with the necessary permissions. The Attribute Definition Administrator is the only privileged role supported for this operation.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-EntraBetaCustomSecurityAttributeDefinition</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the custom security attribute, up to 128 characters long and including Unicode characters. This description can be changed later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The unique identifier of a Microsoft Entra ID custom security attribute definition object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Status</maml:name> <maml:description> <maml:para>Specifies whether the custom security attribute is active or deactivated. Acceptable values are: Available and Deprecated. Can be changed later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UsePreDefinedValuesOnly</maml:name> <maml:description> <maml:para>Indicates whether only predefined values can be assigned to the custom security attribute. If set to false, free-form values are allowed. Can later be changed from true to false, but can't be changed from false to true. If type is set to Boolean, usePreDefinedValuesOnly can't be set to true.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the custom security attribute, up to 128 characters long and including Unicode characters. This description can be changed later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The unique identifier of a Microsoft Entra ID custom security attribute definition object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Status</maml:name> <maml:description> <maml:para>Specifies whether the custom security attribute is active or deactivated. Acceptable values are: Available and Deprecated. Can be changed later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UsePreDefinedValuesOnly</maml:name> <maml:description> <maml:para>Indicates whether only predefined values can be assigned to the custom security attribute. If set to false, free-form values are allowed. Can later be changed from true to false, but can't be changed from false to true. If type is set to Boolean, usePreDefinedValuesOnly can't be set to true.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------- Example 1: Update a custom security attribute --------</maml:title> <dev:code>Connect-Entra -Scopes 'CustomSecAttributeDefinition.Read.All', 'CustomSecAttributeDefinition.ReadWrite.All' $params = @{ Id = 'Test_ProjectTest' Description = 'Target completion' Status = 'Available' } Set-EntraBetaCustomSecurityAttributeDefinition @params</dev:code> <dev:remarks> <maml:para>This example update a custom security attribute.</maml:para> <maml:para>- `-Id` parameter specifies the custom security attribute definition object ID.</maml:para> <maml:para>- `-Description` parameter specifies the description of the custom security attribute.</maml:para> <maml:para>- `-Status` parameter specifies the custom security attribute is active or deactivated.</maml:para> <maml:para>- `-UsePreDefinedValuesOnly` parameter specifies the only predefined values can be assigned to the custom security attribute.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Set-EntraBetaCustomSecurityAttributeDefinition</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-EntraBetaCustomSecurityAttributeDefinition</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaCustomSecurityAttributeDefinition</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-EntraBetaCustomSecurityAttributeDefinitionAllowedValue</command:name> <command:verb>Set</command:verb> <command:noun>EntraBetaCustomSecurityAttributeDefinitionAllowedValue</command:noun> <maml:description> <maml:para>Updates an existing custom security attribute definition predefined value.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Set-EntraBetaCustomSecurityAttributeDefinitionAllowedValue` cmdlet update a Microsoft Entra ID custom security attribute definition predefined value object identified by ID. Specify `CustomSecurityAttributeDefinitionId` and `Id` parameter to update a Microsoft Entra ID custom security attribute definition predefined value.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-EntraBetaCustomSecurityAttributeDefinitionAllowedValue</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>CustomSecurityAttributeDefinitionId</maml:name> <maml:description> <maml:para>The unique identifier of customSecurityAttributeDefinition.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Indicates whether the predefined value is active or deactivated. If set to false, this predefined value cannot be assigned to any additional supported directory objects. This field is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsActive</maml:name> <maml:description> <maml:para>Indicates whether the predefined value is active or deactivated. If set to false, this predefined value can't be assigned to any other supported directory objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>CustomSecurityAttributeDefinitionId</maml:name> <maml:description> <maml:para>The unique identifier of customSecurityAttributeDefinition.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Indicates whether the predefined value is active or deactivated. If set to false, this predefined value cannot be assigned to any additional supported directory objects. This field is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsActive</maml:name> <maml:description> <maml:para>Indicates whether the predefined value is active or deactivated. If set to false, this predefined value can't be assigned to any other supported directory objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Update a custom security attribute definition predefined value</maml:title> <dev:code>Connect-Entra -Scopes 'CustomSecAttributeDefinition.ReadWrite.All' $params = @{ CustomSecurityAttributeDefinitionId = 'Engineering_Project' Id = 'Alpine' IsActive = $true } Set-EntraBetaCustomSecurityAttributeDefinitionAllowedValue @params</dev:code> <dev:remarks> <maml:para>This example update a custom security attribute definition predefined value.</maml:para> <maml:para>- `-CustomSecurityAttributeDefinitionId` parameter specifies the custom security attribute definition ID.</maml:para> <maml:para>- `-Id` parameter specifies the ID of Microsoft Entra ID Object.</maml:para> <maml:para>- `-IsActive` parameter specifies the predefined value is active or deactivated.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Set-EntraBetaCustomSecurityAttributeDefinitionAllowedValue</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-EntraBetaCustomSecurityAttributeDefinitionAllowedValue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaCustomSecurityAttributeDefinitionAllowedValue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-EntraBetaDevice</command:name> <command:verb>Set</command:verb> <command:noun>EntraBetaDevice</command:noun> <maml:description> <maml:para>Updates a device.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Set-EntraBetaDevice` cmdlet updates a device in Microsoft Entra ID.</maml:para> <maml:para>The calling user must have at least the Intune Administrator role in Microsoft Entra. A user with the Cloud Device Administrator role can only enable or disable devices, while a user with the Windows 365 Administrator role can only update basic device properties.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-EntraBetaDevice</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AccountEnabled</maml:name> <maml:description> <maml:para>Indicates whether the account is enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AlternativeSecurityIds</maml:name> <maml:description> <maml:para>Specifies alternative security IDs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.AlternativeSecurityId]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.AlternativeSecurityId]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ApproximateLastLogonTimeStamp</maml:name> <maml:description> <maml:para>The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Supports $filter (eq, ne, not, ge, le, and eq on null values) and $orderby.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DeviceId</maml:name> <maml:description> <maml:para>Specifies the device ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DeviceMetadata</maml:name> <maml:description> <maml:para>The device metadata for this device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DeviceObjectVersion</maml:name> <maml:description> <maml:para>Specifies the object version of the device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DeviceOSType</maml:name> <maml:description> <maml:para>Specifies the operating system.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DeviceOSVersion</maml:name> <maml:description> <maml:para>Specifies the operating system version.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DevicePhysicalIds</maml:name> <maml:description> <maml:para>Specifies the physical ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DeviceTrustType</maml:name> <maml:description> <maml:para>Specifies the device trust type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Specifies the display name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsCompliant</maml:name> <maml:description> <maml:para>Indicates whether the device is compliant.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsManaged</maml:name> <maml:description> <maml:para>Indicates whether the device is managed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>DeviceObjectId</maml:name> <maml:description> <maml:para>Specifies the object ID of a device in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProfileType</maml:name> <maml:description> <maml:para>Specifies the profile type of the device. Possible values: RegisteredDevice (default), SecureVM, Printer, Shared, IoT.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SystemLabels</maml:name> <maml:description> <maml:para>Specifies list of labels applied to the device by the system.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AccountEnabled</maml:name> <maml:description> <maml:para>Indicates whether the account is enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AlternativeSecurityIds</maml:name> <maml:description> <maml:para>Specifies alternative security IDs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.AlternativeSecurityId]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.AlternativeSecurityId]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ApproximateLastLogonTimeStamp</maml:name> <maml:description> <maml:para>The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Supports $filter (eq, ne, not, ge, le, and eq on null values) and $orderby.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DeviceId</maml:name> <maml:description> <maml:para>Specifies the device ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DeviceMetadata</maml:name> <maml:description> <maml:para>The device metadata for this device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DeviceObjectVersion</maml:name> <maml:description> <maml:para>Specifies the object version of the device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DeviceOSType</maml:name> <maml:description> <maml:para>Specifies the operating system.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DeviceOSVersion</maml:name> <maml:description> <maml:para>Specifies the operating system version.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DevicePhysicalIds</maml:name> <maml:description> <maml:para>Specifies the physical ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DeviceTrustType</maml:name> <maml:description> <maml:para>Specifies the device trust type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>Specifies the display name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsCompliant</maml:name> <maml:description> <maml:para>Indicates whether the device is compliant.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsManaged</maml:name> <maml:description> <maml:para>Indicates whether the device is managed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="ObjectId"> <maml:name>DeviceObjectId</maml:name> <maml:description> <maml:para>Specifies the object ID of a device in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProfileType</maml:name> <maml:description> <maml:para>Specifies the profile type of the device. Possible values: RegisteredDevice (default), SecureVM, Printer, Shared, IoT.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SystemLabels</maml:name> <maml:description> <maml:para>Specifies list of labels applied to the device by the system.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----------- Example 1: Update a device display name -----------</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.AccessAsUser.All','Device.ReadWrite.All' Set-EntraBetaDevice -DeviceObjectId 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb' -DisplayName 'My OS/2 computer'</dev:code> <dev:remarks> <maml:para>This example shows how to update a display name of a specified.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------ Example 2: Update a device alternative security ID ------</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.AccessAsUser.All','Device.ReadWrite.All' $NewId= New-Object Microsoft.Open.AzureAD.Model.AlternativeSecurityId $NewId.Key =[System.Text.Encoding]::UTF8.GetBytes('test') $NewId.type = 2 Set-EntraBetaDevice -DeviceObjectId 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb' -AlternativeSecurityIds $NewId</dev:code> <dev:remarks> <maml:para>This example shows how to update an alternative security ID of a specified device.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- Example 3: Update a device account enabled ----------</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.AccessAsUser.All','Device.ReadWrite.All' Set-EntraBetaDevice -DeviceObjectId 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb' -AccountEnabled $true</dev:code> <dev:remarks> <maml:para>This example shows how to update an account enabled of a specified device.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------- Example 4: Update a device OS type --------------</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.AccessAsUser.All','Device.ReadWrite.All' Set-EntraBetaDevice -DeviceObjectId 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb' -DeviceOSType Windows</dev:code> <dev:remarks> <maml:para>This example shows how to update an OS type of a specified device.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------ Example 5: Update a device ------------------</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.AccessAsUser.All','Device.ReadWrite.All' $params = @{ DeviceObjectId = 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb' DeviceMetadata = 'Testdevice' DeviceObjectVersion = 4 DevicePhysicalIds = '[GID]:g:1234567890123456' IsCompliant = $false } Set-EntraBetaDevice @params</dev:code> <dev:remarks> <maml:para>This example shows how to update multiple properties of a specified device.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Set-EntraBetaDevice</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaDevice</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-EntraBetaDevice</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaDevice</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-EntraBetaDirectorySetting</command:name> <command:verb>Set</command:verb> <command:noun>EntraBetaDirectorySetting</command:noun> <maml:description> <maml:para>Updates a directory setting in Microsoft Entra ID.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Set-EntraBetaDirectorySetting` cmdlet updates a directory setting in Microsoft Entra ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-EntraBetaDirectorySetting</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>DirectorySetting</maml:name> <maml:description> <maml:para>Specifies the directory settings.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DirectorySetting</command:parameterValue> <dev:type> <maml:name>DirectorySetting</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of a settings object in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>DirectorySetting</maml:name> <maml:description> <maml:para>Specifies the directory settings.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DirectorySetting</command:parameterValue> <dev:type> <maml:name>DirectorySetting</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of a settings object in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------ Example 1: updates a directory setting ------------</maml:title> <dev:code>Connect-Entra -Scopes 'Directory.ReadWrite.All', 'Policy.ReadWrite.Authorization' $TemplateId = (Get-EntraBetaDirectorySettingTemplate | where { $_.DisplayName -eq 'Group.Unified' }).Id $Template = Get-EntraBetaDirectorySettingTemplate | where -Property Id -Value $TemplateId -EQ $Setting = $Template.CreateDirectorySetting() $Setting["EnableMIPLabels"] = 'False' $params = @{ Id = 'aaaaaaaa-1111-1111-1111-000000000000' DirectorySetting = $Setting } Set-EntraBetaDirectorySetting @params</dev:code> <dev:remarks> <maml:para>This example updates directory settings object in Microsoft Entra ID.</maml:para> <maml:para>- `-DirectorySetting` Parameter updates the property of directory settings.</maml:para> <maml:para>- `-Id` Parameter specifies the ID of a setting object</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Set-EntraBetaDirectorySetting</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaDirectorySetting</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-EntraBetaDirectorySetting</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaDirectorySetting</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-EntraBetaDirSyncConfiguration</command:name> <command:verb>Set</command:verb> <command:noun>EntraBetaDirSyncConfiguration</command:noun> <maml:description> <maml:para>Modifies the directory synchronization settings.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Set-EntraBetaDirSyncConfiguration` cmdlet modifies the directory synchronization settings.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-EntraBetaDirSyncConfiguration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>AccidentalDeletionThreshold</maml:name> <maml:description> <maml:para>Specifies the accidental deletion prevention configuration for a tenant.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.UInt32</command:parameterValue> <dev:type> <maml:name>System.UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>The unique ID of the tenant on which to perform the operation. If not provided, the operation defaults to the tenant of the current user. This parameter is applicable only to partner users.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>AccidentalDeletionThreshold</maml:name> <maml:description> <maml:para>Specifies the accidental deletion prevention configuration for a tenant.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.UInt32</command:parameterValue> <dev:type> <maml:name>System.UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>The unique ID of the tenant on which to perform the operation. If not provided, the operation defaults to the tenant of the current user. This parameter is applicable only to partner users.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.UInt32</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Guid</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>- For additional details see Update onPremisesDirectorySynchronization (https://learn.microsoft.com/graph/api/onpremisesdirectorysynchronization-update).</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------ Example 1: Set directory synchronization settings ------</maml:title> <dev:code>Connect-Entra -Scopes 'OnPremDirectorySynchronization.ReadWrite.All' Set-EntraBetaDirSyncConfiguration -AccidentalDeletionThreshold 600 -Force</dev:code> <dev:remarks> <maml:para>This command sets directory synchronization settings.</maml:para> <maml:para>- `-AccidentalDeletionThreshold` Specifies the accidental deletion prevention configuration for a tenant.</maml:para> <maml:para>- `-Force` Forces the command to run without asking for user confirmation.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Set directory synchronization settings for a Tenant</maml:title> <dev:code>Connect-Entra -Scopes 'OnPremDirectorySynchronization.ReadWrite.All' $tenantID = (Get-EntraContext).TenantId $params = @{ AccidentalDeletionThreshold = 600 TenantId = $tenantID Force = $true } Set-EntraBetaDirSyncConfiguration @params</dev:code> <dev:remarks> <maml:para>This command sets directory synchronization settings.</maml:para> <maml:para>- `-AccidentalDeletionThreshold` Specifies the accidental deletion prevention configuration for a tenant.</maml:para> <maml:para>- `-Force` Forces the command to run without asking for user confirmation.</maml:para> <maml:para>- `-TenantId` Specifies the unique ID of the tenant.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Set-EntraBetaDirSyncConfiguration</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaDirSyncConfiguration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-EntraBetaDirSyncEnabled</command:name> <command:verb>Set</command:verb> <command:noun>EntraBetaDirSyncEnabled</command:noun> <maml:description> <maml:para>Turns directory synchronization on or off for a company.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Set-EntraBetaDirSyncEnabled` cmdlet turns directory synchronization on or off for a company.</maml:para> <maml:para>>[!IMPORTANT] >It may take up to 72 hours to complete deactivation once you have disabled DirSync through this cmdlet. The time depends on the number of objects that are in your cloud service subscription account. You cannot cancel the disable action . It will need to complete before you can take any other action, including re-enabling of DirSync. If you choose to re-enable DirSync, a full synchronization of your synced objects will happen. This may take a considerable time depending on the number of objects in your Microsoft Entra ID.</maml:para> <maml:para>>[!NOTE] >If you disable DirSync and you decide to re-enable it, and you have enabled the BlockCloudObjectTakeoverThroughHardMatch feature, OnPrem to cloud object takeover/update for all objects mastered in the Microsoft Entra ID will be blocked. If this is the case and you want to resume syncing Microsoft Entra ID mastered objects with Microsoft Entra ID, set BlockCloudObjectTakeoverThroughHardMatch feature to false.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-EntraBetaDirSyncEnabled</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>EnableDirsync</maml:name> <maml:description> <maml:para>Specifies whether to turn on directory synchronization on for your company.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>Specifies the unique ID of the tenant on which to perform the operation. The default value is the tenant of the current user. This parameter applies only to partner users.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>EnableDirsync</maml:name> <maml:description> <maml:para>Specifies whether to turn on directory synchronization on for your company.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>Specifies the unique ID of the tenant on which to perform the operation. The default value is the tenant of the current user. This parameter applies only to partner users.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1: Turn on directory synchronization ---------</maml:title> <dev:code>Connect-Entra -Scopes 'OnPremDirectorySynchronization.ReadWrite.All', 'Organization.ReadWrite.All' $params = @{ EnableDirsync = $True Force = $True } Set-EntraBetaDirSyncEnabled @params</dev:code> <dev:remarks> <maml:para>This example turns on directory synchronization for a company.</maml:para> <maml:para>- `-EnableDirsync` Specifies whether to turn on directory synchronization on for your company.</maml:para> <maml:para>- `-Force` Forces the command to run without asking for user confirmation.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------- Example 2: Turn off directory synchronization --------</maml:title> <dev:code>Connect-Entra -Scopes 'OnPremDirectorySynchronization.ReadWrite.All', 'Organization.ReadWrite.All' $params = @{ EnableDirsync = $False TenantId = 'aaaaaaaa-1111-1111-1111-000000000000' Force = $True } Set-EntraBetaDirSyncEnabled @params</dev:code> <dev:remarks> <maml:para>This example turns off directory synchronization for a company.</maml:para> <maml:para>- `-EnableDirsync` Specifies whether to turn on directory synchronization on for your company.</maml:para> <maml:para>- `-Force` Forces the command to run without asking for user confirmation.</maml:para> <maml:para>- `-TenantId` Specifies the unique ID of the tenant on which to perform the operation.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Set-EntraBetaDirSyncEnabled</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-EntraBetaDirSyncFeature</command:name> <command:verb>Set</command:verb> <command:noun>EntraBetaDirSyncFeature</command:noun> <maml:description> <maml:para>Used to set identity synchronization features for a tenant.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Set-EntraBetaDirSyncFeature` cmdlet sets identity synchronization features for a tenant. You can use the following synchronization features with this cmdlet: - EnableSoftMatchOnUpn : Soft match is the process used to link an object being synced from on-premises for the first time with one that already exists in the cloud. When this feature is enabled, soft match is attempted using the standard logic, based on the primary SMTP address. If a match isn't found based on primary SMTP, then a match is attempted based on UserPrincipalName. Once this feature is enabled, it can't be disabled. - PasswordSync : Used to indicate on-premise password synchronization. - SynchronizeUpnForManagedUsers : Allows for the synchronization of UserPrincipalName updates from on-premises for managed (nonfederated) users that are assigned a license. These updates are blocked if this feature isn't enabled. Once this feature is enabled, it can't be disabled. - BlockSoftMatch : When this feature is enabled, it blocks the soft match feature. Customers are encouraged to enable this feature and keep it enabled until soft matching is required again for their tenancy. This flag should be enabled again after any soft matching is completed and is no longer needed. - BlockCloudObjectTakeoverThroughHardMatch : Used to block cloud object takeover via source anchor hard match.</maml:para> <maml:para>Enabling some of these features, such as EnableSoftMatchOnUpn and SynchronizationUpnForManagedUsers, is a permanent operation. You can't disable these features once they're enabled.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-EntraBetaDirSyncFeature</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Feature</maml:name> <maml:description> <maml:para>The DirSync feature to turn on or off.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Enable</maml:name> <maml:description> <maml:para>Indicates whether the specified features are turned on for the company.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>The unique ID of the tenant on which to perform the operation. If not provided, the operation defaults to the tenant of the current user. This parameter is applicable only to partner users.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Feature</maml:name> <maml:description> <maml:para>The DirSync feature to turn on or off.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Enable</maml:name> <maml:description> <maml:para>Indicates whether the specified features are turned on for the company.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>The unique ID of the tenant on which to perform the operation. If not provided, the operation defaults to the tenant of the current user. This parameter is applicable only to partner users.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>- For additional details see Update onPremisesDirectorySynchronization (https://learn.microsoft.com/graph/api/onpremisesdirectorysynchronization-update). - For the feature list see the onPremisesDirectorySynchronizationFeature resource type (https://learn.microsoft.com/graph/api/resources/onpremisesdirectorysynchronizationfeature).</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---------- Example 1: Enable a feature for the tenant ----------</maml:title> <dev:code>Connect-Entra -Scopes 'OnPremDirectorySynchronization.ReadWrite.All' $params = @{ Feature = 'BlockCloudObjectTakeoverThroughHardMatch' Enable = $True Force = $true } Set-EntraBetaDirSyncFeature @params</dev:code> <dev:remarks> <maml:para>This command enables the SoftMatchOnUpn feature for the tenant.</maml:para> <maml:para>- `-Feature` specifies the directory synchronization feature to turn on or off.</maml:para> <maml:para>- `-Enable` specifies whether the specified features are turned on for the company.</maml:para> <maml:para>- `-Force` Forces the command to run without asking for user confirmation.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------- Example 2: Block Soft Matching for the tenant --------</maml:title> <dev:code>Connect-Entra -Scopes 'OnPremDirectorySynchronization.ReadWrite.All' $params = @{ Feature = 'BlockSoftMatch' Enable = $True } Set-EntraBetaDirSyncFeature @params</dev:code> <dev:remarks> <maml:para>This command enables the BlockSoftMatch feature for the tenant - effectively blocking the Soft Matching feature in the tenant.</maml:para> <maml:para>- `-Feature` specifies the directory synchronization feature to turn on or off.</maml:para> <maml:para>- `-Enable` specifies whether the specified features are turned on for the company.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 3: Block Cloud object takeover through Hard Matching for the tenant</maml:title> <dev:code>Connect-Entra -Scopes 'OnPremDirectorySynchronization.ReadWrite.All' $tenantID = (Get-EntraContext).TenantId $params = @{ Feature = 'BlockCloudObjectTakeoverThroughHardMatch' Enable = $True TenantId = $tenantID } Set-EntraBetaDirSyncFeature @params</dev:code> <dev:remarks> <maml:para>This command enables the BlockCloudObjectTakeoverThroughHardMatch feature for the tenant - effectively blocking the Hard Match object takeover.</maml:para> <maml:para>- `-Feature` specifies the directory synchronization feature to turn on or off.</maml:para> <maml:para>- `-Enable` specifies whether the specified features are turned on for the company.</maml:para> <maml:para>- `-TenantId` Specifies the unique ID of the tenant.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Set-EntraBetaDirSyncFeature</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaDirSyncFeature</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-EntraBetaDomain</command:name> <command:verb>Set</command:verb> <command:noun>EntraBetaDomain</command:noun> <maml:description> <maml:para>Updates a domain.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Set-EntraBetaDomain` cmdlet updates a verified domain in Microsoft Entra ID.</maml:para> <maml:para>The work or school account needs to belong to at least one of the following Microsoft Entra roles:</maml:para> <maml:para>- Domain Name Administrator</maml:para> <maml:para>- Security Administrator</maml:para> <maml:para>- External Identity Provider Administrator</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-EntraBetaDomain</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsDefault</maml:name> <maml:description> <maml:para>Indicates whether or not this is the default domain that is used for user creation. There's only one default domain per company.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The fully qualified name of the domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SupportedServices</maml:name> <maml:description> <maml:para>The capabilities assigned to the domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsDefault</maml:name> <maml:description> <maml:para>Indicates whether or not this is the default domain that is used for user creation. There's only one default domain per company.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The fully qualified name of the domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SupportedServices</maml:name> <maml:description> <maml:para>The capabilities assigned to the domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Set the domain as the default domain for new user account creation</maml:title> <dev:code>Connect-Entra -Scopes 'Domain.ReadWrite.All' Set-EntraBetaDomain -Name Contoso.com -IsDefault $true</dev:code> <dev:remarks> <maml:para>This example demonstrates how to set default domain for new user account in Microsoft Entra ID. </maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------- Example 2: Set the list of domain capabilities --------</maml:title> <dev:code>Connect-Entra -Scopes 'Domain.ReadWrite.All' Set-EntraBetaDomain -Name Contoso.com -SupportedServices @('Email', 'OfficeCommunicationsOnline')</dev:code> <dev:remarks> <maml:para>This example demonstrates how to set domain capabilities for new user account in Microsoft Entra ID. </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Set-EntraBetaDomain</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Confirm-EntraBetaDomain</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaDomain</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-EntraBetaDomain</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntraBetaDomain</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-EntraBetaDomainFederationSettings</command:name> <command:verb>Set</command:verb> <command:noun>EntraBetaDomainFederationSettings</command:noun> <maml:description> <maml:para>Updates settings for a federated domain.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Set-EntraBetaDomainFederationSettings` cmdlet is used to update the settings of a single sign-on domain.</maml:para> <maml:para>For delegated scenarios, the calling user must be assigned at least one of the following Microsoft Entra roles:</maml:para> <maml:para>- Domain Name Administrator</maml:para> <maml:para>- External Identity Provider Administrator</maml:para> <maml:para>- Hybrid Identity Administrator</maml:para> <maml:para>- Security Administrator</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-EntraBetaDomainFederationSettings</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>The fully qualified domain name (FQDN) to update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="10" aliases="none"> <maml:name>PreferredAuthenticationProtocol</maml:name> <maml:description> <maml:para>Specifies the preferred authentication protocol.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="11" aliases="none"> <maml:name>SigningCertificateUpdateStatus</maml:name> <maml:description> <maml:para>Specifies the update status of the signing certificate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="12" aliases="none"> <maml:name>PromptLoginBehavior</maml:name> <maml:description> <maml:para>Specifies the prompt login behavior.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="none"> <maml:name>SigningCertificate</maml:name> <maml:description> <maml:para>The current certificate used to sign tokens passed to the Microsoft Entra ID Identity platform.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="3" aliases="none"> <maml:name>NextSigningCertificate</maml:name> <maml:description> <maml:para>The next token signing certificate that will be used to sign tokens when the primary signing certificate expires.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="4" aliases="none"> <maml:name>LogOffUri</maml:name> <maml:description> <maml:para>The URL clients are redirected to when they sign out of Microsoft Entra ID services.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="5" aliases="none"> <maml:name>PassiveLogOnUri</maml:name> <maml:description> <maml:para>The URL that web-based clients will be directed to when signing in to Microsoft Entra ID services.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="6" aliases="none"> <maml:name>ActiveLogOnUri</maml:name> <maml:description> <maml:para>A URL that specifies the end point used by active clients when authenticating with domains set up for single sign-on (also known as identity federation) in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="7" aliases="none"> <maml:name>IssuerUri</maml:name> <maml:description> <maml:para>The unique identifier of the domain in the Microsoft Entra ID Identity platform derived from the federation server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="8" aliases="none"> <maml:name>FederationBrandName</maml:name> <maml:description> <maml:para>The name of the string value shown to users when signing in to Microsoft Entra ID. We recommend that customers use something that is familiar to users such as "Contoso Inc."</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="9" aliases="none"> <maml:name>MetadataExchangeUri</maml:name> <maml:description> <maml:para>The URL that specifies the metadata exchange end point used for authentication from rich client applications such as Lync Online.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>The fully qualified domain name (FQDN) to update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="none"> <maml:name>SigningCertificate</maml:name> <maml:description> <maml:para>The current certificate used to sign tokens passed to the Microsoft Entra ID Identity platform.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="3" aliases="none"> <maml:name>NextSigningCertificate</maml:name> <maml:description> <maml:para>The next token signing certificate that will be used to sign tokens when the primary signing certificate expires.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="4" aliases="none"> <maml:name>LogOffUri</maml:name> <maml:description> <maml:para>The URL clients are redirected to when they sign out of Microsoft Entra ID services.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="5" aliases="none"> <maml:name>PassiveLogOnUri</maml:name> <maml:description> <maml:para>The URL that web-based clients will be directed to when signing in to Microsoft Entra ID services.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="6" aliases="none"> <maml:name>ActiveLogOnUri</maml:name> <maml:description> <maml:para>A URL that specifies the end point used by active clients when authenticating with domains set up for single sign-on (also known as identity federation) in Microsoft Entra ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="7" aliases="none"> <maml:name>IssuerUri</maml:name> <maml:description> <maml:para>The unique identifier of the domain in the Microsoft Entra ID Identity platform derived from the federation server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="8" aliases="none"> <maml:name>FederationBrandName</maml:name> <maml:description> <maml:para>The name of the string value shown to users when signing in to Microsoft Entra ID. We recommend that customers use something that is familiar to users such as "Contoso Inc."</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="9" aliases="none"> <maml:name>MetadataExchangeUri</maml:name> <maml:description> <maml:para>The URL that specifies the metadata exchange end point used for authentication from rich client applications such as Lync Online.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="10" aliases="none"> <maml:name>PreferredAuthenticationProtocol</maml:name> <maml:description> <maml:para>Specifies the preferred authentication protocol.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="11" aliases="none"> <maml:name>SigningCertificateUpdateStatus</maml:name> <maml:description> <maml:para>Specifies the update status of the signing certificate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="12" aliases="none"> <maml:name>PromptLoginBehavior</maml:name> <maml:description> <maml:para>Specifies the prompt login behavior.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------ Example 1: Set the PromptLoginBehavior ------------</maml:title> <dev:code>Connect-Entra -Scopes 'Domain.ReadWrite.All' $params = @{ DomainName = 'contoso.com' PreferredAuthenticationProtocol = 'WsFed' PromptLoginBehavior = 'TranslateToFreshPasswordAuth' # Or 'NativeSupport' or 'Disabled', depending on the requirement } Set-EntraBetaDomainFederationSettings @params</dev:code> <dev:remarks> <maml:para>This command updates the `PromptLoginBehavior` to either `TranslateToFreshPasswordAuth`, `NativeSupport`, or `Disabled`. These possible values are described:</maml:para> <maml:para>- `TranslateToFreshPasswordAuth` - means the default Microsoft Entra ID behavior of translating `prompt=login` to `wauth=https://schemas.microsoft.com/ws/2008/06/identity/authenticationmethod/password` and `wfresh=0`.</maml:para> <maml:para>- `NativeSupport` - means that the `prompt=login` parameter is sent as is to ADFS.</maml:para> <maml:para>- `Disabled` - means that only wfresh=0 is sent to ADFS</maml:para> <maml:para></maml:para> <maml:para>Use the `Get-EntraBetaDomainFederationSettings -DomainName <your_domain_name> | Format-List *` to get the values for `PreferredAuthenticationProtocol` and `PromptLoginBehavior` for the federated domain.</maml:para> <maml:para>- `-DomainName` parameter specifies the fully qualified domain name to retrieve.</maml:para> <maml:para>- `-PreferredAuthenticationProtocol` parameter specifies the preferred authentication protocol.</maml:para> <maml:para>- `-PromptLoginBehavior` parameter specifies the prompt sign-in behavior.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- Example 2: Set the domain federation uri's ----------</maml:title> <dev:code>Connect-Entra -Scopes 'Domain.ReadWrite.All' $params = @{ DomainName = 'contoso.com' LogOffUri = 'https://adfs1.entra.lab/adfs/' PassiveLogOnUri = 'https://adfs1.entra.lab/adfs/' ActiveLogOnUri = 'https://adfs1.entra.lab/adfs/services/trust/2005/' IssuerUri = 'http://adfs1.entra.lab/adfs/services/' MetadataExchangeUri = 'https://adfs1.entra.lab/adfs/services/trust/' } Set-EntraBetaDomainFederationSettings @params</dev:code> <dev:remarks> <maml:para>This command updates the domain federation domain settings.</maml:para> <maml:para>- `-DomainName` parameter specifies the fully qualified domain name to retrieve.</maml:para> <maml:para>- `-LogOffUri` parameter specifies the URL clients are redirected to when they sign out of Microsoft Entra ID services.</maml:para> <maml:para>- `-PassiveLogOnUri` parameter specifies URL that web-based clients will be directed to when signing in to Microsoft Entra ID services.</maml:para> <maml:para>- `-ActiveLogOnUri` parameter specifies the end point used by active clients when authenticating with domains set up for single sign-on.</maml:para> <maml:para>- `-IssuerUri` parameter specifies the unique identifier of the domain in the Microsoft Entra ID Identity platform derived from the federation server.</maml:para> <maml:para>- `-MetadataExchangeUri` parameter specifies the metadata exchange end point used for authentication from client applications.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Set-EntraBetaDomainFederationSettings</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaDomainFederationSettings</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-EntraBetaPartnerInformation</command:name> <command:verb>Set</command:verb> <command:noun>EntraBetaPartnerInformation</command:noun> <maml:description> <maml:para>Sets company information for partners.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Set-EntraBetaPartnerInformation` cmdlet is used by partners to set partner-specific properties.</maml:para> <maml:para>These properties can view by all tenants that the partner has access to.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-EntraBetaPartnerInformation</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>PartnerCommerceUrl</maml:name> <maml:description> <maml:para>Specifies the URL for the partner's commerce website.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>PartnerHelpUrl</maml:name> <maml:description> <maml:para>Specifies the URL for the partner's Help website.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>PartnerSupportEmails</maml:name> <maml:description> <maml:para>Specifies the support email address for the partner.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>PartnerSupportTelephones</maml:name> <maml:description> <maml:para>Specifies the support telephone numbers for the partner.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>PartnerSupportUrl</maml:name> <maml:description> <maml:para>Specifies the URL for the partner's support website.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>Specifies the unique ID of the tenant on which to perform the operation. The default value is the tenant of the current user. This parameter applies only to partner users.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>CompanyType</maml:name> <maml:description> <maml:para>Specifies the partner's company type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CompanyType</command:parameterValue> <dev:type> <maml:name>CompanyType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>PartnerCompanyName</maml:name> <maml:description> <maml:para>Specifies the partner's company name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>PartnerCommerceUrl</maml:name> <maml:description> <maml:para>Specifies the URL for the partner's commerce website.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>PartnerHelpUrl</maml:name> <maml:description> <maml:para>Specifies the URL for the partner's Help website.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>PartnerSupportEmails</maml:name> <maml:description> <maml:para>Specifies the support email address for the partner.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>PartnerSupportTelephones</maml:name> <maml:description> <maml:para>Specifies the support telephone numbers for the partner.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>PartnerSupportUrl</maml:name> <maml:description> <maml:para>Specifies the URL for the partner's support website.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>Specifies the unique ID of the tenant on which to perform the operation. The default value is the tenant of the current user. This parameter applies only to partner users.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>CompanyType</maml:name> <maml:description> <maml:para>Specifies the partner's company type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CompanyType</command:parameterValue> <dev:type> <maml:name>CompanyType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>PartnerCompanyName</maml:name> <maml:description> <maml:para>Specifies the partner's company name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---------------- Example 1: Update the help URL ----------------</maml:title> <dev:code>Connect-Entra -Scopes 'Organization.ReadWrite.All' Set-EntraBetaPartnerInformation -PartnerHelpUrl 'http://www.help.contoso.com'</dev:code> <dev:remarks> <maml:para>This example shows how to update the help URL.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------- Example 2: Update the Support URL --------------</maml:title> <dev:code>Connect-Entra -Scopes 'Organization.ReadWrite.All' Set-EntraBetaPartnerInformation -PartnerSupportUrl 'http://www.test1.com'</dev:code> <dev:remarks> <maml:para>This example shows how to update the support URL.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------- Example 3: Update the Commerce URL --------------</maml:title> <dev:code>Connect-Entra -Scopes 'Organization.ReadWrite.All' Set-EntraBetaPartnerInformation -PartnerCommerceUrl 'http://www.test1.com'</dev:code> <dev:remarks> <maml:para>This example shows how to update the commerce URL.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------- Example 4: Update the SupportEmails -------------</maml:title> <dev:code>Connect-Entra -Scopes 'Organization.ReadWrite.All' Set-EntraBetaPartnerInformation -PartnerSupportEmails 'contoso@example.com'</dev:code> <dev:remarks> <maml:para>This example shows how to update the support email addresses.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>----------- Example 5: Update the SupportTelephones -----------</maml:title> <dev:code>Connect-Entra -Scopes 'Organization.ReadWrite.All' $tenantId = (Get-EntraContext).TenantId $params = @{ PartnerSupportTelephones = '234234234' TenantId = $tenantId } Set-EntraBetaPartnerInformation @params</dev:code> <dev:remarks> <maml:para>This example shows how to update support telephone numbers.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Set-EntraBetaPartnerInformation</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaPartnerInformation</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-EntraBetaTenantDetail</command:name> <command:verb>Set</command:verb> <command:noun>EntraBetaTenantDetail</command:noun> <maml:description> <maml:para>Set contact details for a tenant.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet is used to set various contact details for a tenant.</maml:para> <maml:para>For delegated scenarios, the signed-in user must have at least one of the following Microsoft Entra roles.</maml:para> <maml:para>- Application Administrator</maml:para> <maml:para>- Cloud Application Administrator</maml:para> <maml:para>- Privileged Role Administrator</maml:para> <maml:para>- User Administrator</maml:para> <maml:para>- Helpdesk Administrator</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-EntraBetaTenantDetail</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MarketingNotificationEmails</maml:name> <maml:description> <maml:para>The email addresses that are used to send marketing notification emails.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SecurityComplianceNotificationMails</maml:name> <maml:description> <maml:para>The email addresses that are used to send security compliance emails.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SecurityComplianceNotificationPhones</maml:name> <maml:description> <maml:para>One or more phone numbers that are used for security compliance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TechnicalNotificationMails</maml:name> <maml:description> <maml:para>The email addresses that are used for technical notification emails.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PrivacyProfile</maml:name> <maml:description> <maml:para>Represents a company's privacy profile, which includes a privacy statement URL and a contact person for questions regarding the privacy statement.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PrivacyProfile</command:parameterValue> <dev:type> <maml:name>PrivacyProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MarketingNotificationEmails</maml:name> <maml:description> <maml:para>The email addresses that are used to send marketing notification emails.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SecurityComplianceNotificationMails</maml:name> <maml:description> <maml:para>The email addresses that are used to send security compliance emails.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SecurityComplianceNotificationPhones</maml:name> <maml:description> <maml:para>One or more phone numbers that are used for security compliance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TechnicalNotificationMails</maml:name> <maml:description> <maml:para>The email addresses that are used for technical notification emails.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PrivacyProfile</maml:name> <maml:description> <maml:para>Represents a company's privacy profile, which includes a privacy statement URL and a contact person for questions regarding the privacy statement.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PrivacyProfile</command:parameterValue> <dev:type> <maml:name>PrivacyProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>- For more details see Update organization (https://learn.microsoft.com/graph/api/organization-update).</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1: Set contact details for a tenant ---------</maml:title> <dev:code>Connect-Entra -Scopes 'Organization.ReadWrite.All' $params = @{ MarketingNotificationEmails = @('amy@contoso.com', 'henry@contoso.com') SecurityComplianceNotificationMails = @('john@contoso.com', 'mary@contoso.com') SecurityComplianceNotificationPhones = @('1-555-625-9999', '1-555-233-5544') TechnicalNotificationMails = 'peter@contoso.com' } Set-EntraBetaTenantDetail @params</dev:code> <dev:remarks> <maml:para>This example demonstrates how to set various contact details for a tenant.</maml:para> <maml:para>- `-MarketingNotificationEmails` parameter indicates the email addresses that are used to send marketing notification emails.</maml:para> <maml:para>- `-SecurityComplianceNotificationMails` parameter indicates the email addresses that are used to send security compliance emails.</maml:para> <maml:para>- `-SecurityComplianceNotificationPhones` parameter specifies the phone numbers that are used for security compliance.</maml:para> <maml:para>- `-TechnicalNotificationMails` parameter indicates the email addresses that are used for technical notification emails.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>--- Example 2: Set MarketingNotificationEmails for a tenant ---</maml:title> <dev:code>Connect-Entra -Scopes 'Organization.ReadWrite.All' Set-EntraBetaTenantDetail -MarketingNotificationEmails @('amy@contoso.com','henry@contoso.com')</dev:code> <dev:remarks> <maml:para>This example demonstrates how to set MarketingNotificationEmails detail for a tenant.</maml:para> <maml:para>- `-MarketingNotificationEmails` parameter indicates the email addresses that are used to send marketing notification emails.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 3: Set SecurityComplianceNotificationMails for a tenant</maml:title> <dev:code>Connect-Entra -Scopes 'Organization.ReadWrite.All' Set-EntraBetaTenantDetail -SecurityComplianceNotificationMails @('john@contoso.com','mary@contoso.com')</dev:code> <dev:remarks> <maml:para>This example demonstrates how to set SecurityComplianceNotificationMails detail for a tenant.</maml:para> <maml:para>- `-SecurityComplianceNotificationMails` parameter indicates the email addresses that are used to send security compliance emails.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 4: Set -SecurityComplianceNotificationPhones for a tenant</maml:title> <dev:code>Connect-Entra -Scopes 'Organization.ReadWrite.All' Set-EntraBetaTenantDetail -SecurityComplianceNotificationPhones @('1-555-625-9999', '1-555-233-5544')</dev:code> <dev:remarks> <maml:para>This example demonstrates how to set MarketingNotificationEmails detail for a tenant.</maml:para> <maml:para>- `-SecurityComplianceNotificationPhones` parameter specifies the phone numbers that are used for security compliance.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---- Example 5: Set TechnicalNotificationMails for a tenant ----</maml:title> <dev:code>Connect-Entra -Scopes 'Organization.ReadWrite.All' Set-EntraBetaTenantDetail -TechnicalNotificationMails 'peter@contoso.com'</dev:code> <dev:remarks> <maml:para>This example demonstrates how to set TechnicalNotificationMails detail for a tenant.</maml:para> <maml:para>- `-TechnicalNotificationMails` parameter indicates the email addresses that are used for technical notification emails.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/Microsoft.Entra.Beta/Set-EntraBetaTenantDetail</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-EntraBetaTenantDetail</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |