en-US/ConvertTo-ImmutableId-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>ConvertTo-ImmutableId</command:name> <command:verb>ConvertTo</command:verb> <command:noun>ImmutableId</command:noun> <maml:description> <maml:para>Converts an Active Directory GUID to an Azure AD Immutable ID.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Given a single or multiple Active Directory user identity, will return the ImmutableId.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>ConvertTo-ImmutableId</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="2" aliases="none"> <maml:name>Identity</maml:name> <maml:Description> <maml:para>{{Fill Identity Description}}</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:syntaxItem> <command:syntaxItem> <maml:name>ConvertTo-ImmutableId</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>UserGUID</maml:name> <maml:Description> <maml:para>{{Fill UserGUID Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</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 (ByValue)" position="2" aliases="none"> <maml:name>Identity</maml:name> <maml:Description> <maml:para>{{Fill Identity Description}}</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="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>UserGUID</maml:name> <maml:Description> <maml:para>{{Fill UserGUID Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</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 --------------------------</maml:title> <dev:code>ConvertTo-ImmutableId jdoe</dev:code> <dev:remarks> <maml:para>ConvertTo-ImmutableId -UserGUID '00000000-0000-0000-0000-00000000000'</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-ADUser -Filter * -SearchBase 'OU=Finance,OU=UserAccounts,DC=FABRIKAM,DC=COM' | Convert-ToImmutableId</dev:code> <dev:remarks> <maml:para>$guid = Get-AdUser -Identity jdoe | Select ObjectGUID ConvertTo-ImmutableId -UserGUID $guid</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://rearmedhalo.github.io/DUST/ConvertTo-ImmutableId.html</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |