en-US/GDAPRelationships-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>Get-ExistingGDAPRelationship</command:name> <command:verb>Get</command:verb> <command:noun>ExistingGDAPRelationship</command:noun> <maml:description> <maml:para>Retrieves all, filtered, or specific existing GDAP relationships for the current tenant.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieves all, filtered, or specific existing GDAP relationships for the current tenant.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ExistingGDAPRelationship</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GDAPRelationshipID</maml:name> <maml:description> <maml:para>The GDAP relationship ID provided during the GDAP relationship request creation process.</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="False" position="named" aliases="none"> <maml:name>GraphBaseURL</maml:name> <maml:description> <maml:para>The base URL to use to query the Graph API with trailing slash. e.g. https://graph.microsoft.com/v1.0/</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>Https://graph.microsoft.com/v1.0/</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-ExistingGDAPRelationship</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter used to search relationships based on a specific value, uses OData query parameters. e.g. contains(customer/displayName,'Client') and status eq 'active' e.g. displayName eq 'DisplayName'</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="False" position="named" aliases="none"> <maml:name>GraphBaseURL</maml:name> <maml:description> <maml:para>The base URL to use to query the Graph API with trailing slash. e.g. https://graph.microsoft.com/v1.0/</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>Https://graph.microsoft.com/v1.0/</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-ExistingGDAPRelationship</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Switch to specify that all existing GDAP relationships should be retrieved.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GraphBaseURL</maml:name> <maml:description> <maml:para>The base URL to use to query the Graph API with trailing slash. e.g. https://graph.microsoft.com/v1.0/</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>Https://graph.microsoft.com/v1.0/</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>GDAPRelationshipID</maml:name> <maml:description> <maml:para>The GDAP relationship ID provided during the GDAP relationship request creation process.</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="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter used to search relationships based on a specific value, uses OData query parameters. e.g. contains(customer/displayName,'Client') and status eq 'active' e.g. displayName eq 'DisplayName'</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="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Switch to specify that all existing GDAP relationships should be retrieved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GraphBaseURL</maml:name> <maml:description> <maml:para>The base URL to use to query the Graph API with trailing slash. e.g. https://graph.microsoft.com/v1.0/</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>Https://graph.microsoft.com/v1.0/</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None. You can't pipe objects to Get-ExistingGDAPRelationships.</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>List<System.Object>. Returns a List of Objects with contents of type delegatedAdminRelationship.</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 --------------------------</maml:title> <dev:code>Get-ExistingGDAPRelationship -All</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-ExistingGDAPRelationship -GDAPRelationshipId $GDAPRelationshipId</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Get-ExistingGDAPRelationship -Filter "contains(customer/displayName,'Client') and status eq 'active'"</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Graph API Reference - List existing GDAP Relationships: https://learn.microsoft.com/en-us/graph/api/tenantrelationship-list-delegatedadminrelationships</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Graph API Reference - delegatedAdminRelationship: https://learn.microsoft.com/en-us/graph/api/resources/delegatedadminrelationship</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-GDAPAccessRolebyNameorId</command:name> <command:verb>Get</command:verb> <command:noun>GDAPAccessRolebyNameorId</command:noun> <maml:description> <maml:para>Looks up the name or GUID of .</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieves all, filtered, or specific existing GDAP relationships for the current tenant.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-GDAPAccessRolebyNameorId</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RoleDefinitionName</maml:name> <maml:description> <maml:para>The Role Definition Name in GUID format to use to find the associated Role Defition ID GUID.</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>Get-GDAPAccessRolebyNameorId</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RoleDefinitionId</maml:name> <maml:description> <maml:para>The Role Definition ID in GUID format to use to find the associated Role Name.</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>Get-GDAPAccessRolebyNameorId</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>RoleDefinition</maml:name> <maml:description> <maml:para>The Role Definition string to find its matching Role Name or Role ID GUID. Checks what input was provided and automatically chooses if Name or Id should be returned.</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:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RoleDefinitionName</maml:name> <maml:description> <maml:para>The Role Definition Name in GUID format to use to find the associated Role Defition ID GUID.</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="named" aliases="none"> <maml:name>RoleDefinitionId</maml:name> <maml:description> <maml:para>The Role Definition ID in GUID format to use to find the associated Role Name.</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="True (ByValue)" position="1" aliases="none"> <maml:name>RoleDefinition</maml:name> <maml:description> <maml:para>The Role Definition string to find its matching Role Name or Role ID GUID. Checks what input was provided and automatically chooses if Name or Id should be returned.</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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String. Must represent a single role access Name or Id.</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. Returns and object with the found Role Name, ID, and Description.</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 --------------------------</maml:title> <dev:code>Get-GDAPAccessRolebyNameorId -RoleDefinitionName "Directory Readers"</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-GDAPAccessRolebyNameorId -RoleDefinitionId "88d8e3e3-8f55-4a1e-953a-9b9898b8876b"</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://learn.microsoft.com/en-us/partner-center/gdap-least-privileged-roles-by-task</maml:linkText> <maml:uri>https://learn.microsoft.com/en-us/partner-center/gdap-least-privileged-roles-by-task</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-GDAPRelationshipRequestLink</command:name> <command:verb>Get</command:verb> <command:noun>GDAPRelationshipRequestLink</command:noun> <maml:description> <maml:para>Builds the GDAP Request link and optionally the IndirectReseller link and boilerplate email text.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Builds the GDAP Request link and optionally the IndirectReseller link and boilerplate email text.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-GDAPRelationshipRequestLink</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GDAPRelationshipID</maml:name> <maml:description> <maml:para>The GDAP relationship ID provided during the GDAP relationship request creation process.</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="False" position="named" aliases="none"> <maml:name>IndirectResellerLink</maml:name> <maml:description> <maml:para>String containing the link that should be included as an indirect reseller link, generated from https://partner.microsoft.com/en-us/dashboard/commerce2/customers/acquire.</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="named" aliases="none"> <maml:name>GenerateEmailText</maml:name> <maml:description> <maml:para>Should boilerplate email text be generated</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GraphBaseURL</maml:name> <maml:description> <maml:para>The base URL to use to query the Graph API with trailing slash, defaults to the v1.0 Graph API. e.g. https://graph.microsoft.com/v1.0/</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>Https://graph.microsoft.com/v1.0/</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>GDAPRelationshipID</maml:name> <maml:description> <maml:para>The GDAP relationship ID provided during the GDAP relationship request creation process.</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="False" position="named" aliases="none"> <maml:name>IndirectResellerLink</maml:name> <maml:description> <maml:para>String containing the link that should be included as an indirect reseller link, generated from https://partner.microsoft.com/en-us/dashboard/commerce2/customers/acquire.</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="named" aliases="none"> <maml:name>GenerateEmailText</maml:name> <maml:description> <maml:para>Should boilerplate email text be generated</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GraphBaseURL</maml:name> <maml:description> <maml:para>The base URL to use to query the Graph API with trailing slash, defaults to the v1.0 Graph API. e.g. https://graph.microsoft.com/v1.0/</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>Https://graph.microsoft.com/v1.0/</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None. You can't pipe objects to Get-GDAPRelationshipRequestLinks.</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. Returns an Object with one or more of the contents of [string]$_.GDAPInvitationLink, [string]$_.IndirectResellerLink, or [string]$_.EmailText.</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 --------------------------</maml:title> <dev:code>Get-GDAPRelationshipRequestLinks -GDAPRelationshipID $GDAPRelationshipID -IndirectResellerLink "https://admin.microsoft.com/Adminportal/Home?invType=IndirectResellerRelationship&partnerId=8e849ec1-2b10-4c75-b7dc-6c147a3aabae&msppId=5618430&indirectCSPId=2cc9b753-ed2c-488b-a0d0-903f5f82df76#/BillingAccounts/partner-invitation"</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/en-us/partner-center/gdap-least-privileged-roles-by-task</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-GDAPRoleList</command:name> <command:verb>Get</command:verb> <command:noun>GDAPRoleList</command:noun> <maml:description> <maml:para>Gets the list of available GDAP Entra ID Roles.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the list of available GDAP Entra ID Roles</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-GDAPRoleList</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None. You can't pipe objects to Get-GDAPRoleList.</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. Returns an array of Objects with Role Names, IDs, and Descriptions.</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 --------------------------</maml:title> <dev:code>Get-GDAPRoleList</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://learn.microsoft.com/en-us/partner-center/gdap-least-privileged-roles-by-task</maml:linkText> <maml:uri>https://learn.microsoft.com/en-us/partner-center/gdap-least-privileged-roles-by-task</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-GDAPAccessAssignment</command:name> <command:verb>New</command:verb> <command:noun>GDAPAccessAssignment</command:noun> <maml:description> <maml:para>Assign the supplied Security Group with attached Entra ID role IDs to the specified GDAP Relationship.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Assign the supplied Security Group with attached Entra ID role IDs to the specified GDAP Relationship. Checks for and requires that the GDAP Relationship be in a valid state.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-GDAPAccessAssignment</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GDAPRelationshipID</maml:name> <maml:description> <maml:para>The GDAP relationship ID provided during the GDAP relationship request creation process.</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="named" aliases="none"> <maml:name>RoleAccessContainer</maml:name> <maml:description> <maml:para>Object containing Security Group Object ID with a list of Entra ID roles to assign. e.g. @{ Id = "dcd42917-0f97-49b3-88ad-7dd2f96345ba"; RoleDefinitionId = "29232cdf-9323-42fd-ade2-1d097af3e4de","892c5842-a9a6-463a-8041-72aa08ca3cf6","69091246-20e8-4a56-aa4d-066075b2a7a8" }</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</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>GraphBaseURL</maml:name> <maml:description> <maml:para>The base URL to use to query the Graph API with trailing slash, defaults to the v1.0 Graph API. e.g. https://graph.microsoft.com/v1.0/</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>Https://graph.microsoft.com/v1.0/</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-GDAPAccessAssignment</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GDAPRelationshipID</maml:name> <maml:description> <maml:para>The GDAP relationship ID provided during the GDAP relationship request creation process.</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="named" aliases="none"> <maml:name>GroupID</maml:name> <maml:description> <maml:para>Entra ID Group Object ID Guid to assign specific Entra ID roles.</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="named" aliases="none"> <maml:name>RoleDefinitionId</maml:name> <maml:description> <maml:para>Array of Entra ID role Guids to be assigned to the specific Group. e.g. "29232cdf-9323-42fd-ade2-1d097af3e4de","892c5842-a9a6-463a-8041-72aa08ca3cf6","69091246-20e8-4a56-aa4d-066075b2a7a8"</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="False" position="named" aliases="none"> <maml:name>GraphBaseURL</maml:name> <maml:description> <maml:para>The base URL to use to query the Graph API with trailing slash, defaults to the v1.0 Graph API. e.g. https://graph.microsoft.com/v1.0/</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>Https://graph.microsoft.com/v1.0/</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>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="False" position="named" aliases="none"> <maml:name>GDAPRelationshipID</maml:name> <maml:description> <maml:para>The GDAP relationship ID provided during the GDAP relationship request creation process.</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="named" aliases="none"> <maml:name>RoleAccessContainer</maml:name> <maml:description> <maml:para>Object containing Security Group Object ID with a list of Entra ID roles to assign. e.g. @{ Id = "dcd42917-0f97-49b3-88ad-7dd2f96345ba"; RoleDefinitionId = "29232cdf-9323-42fd-ade2-1d097af3e4de","892c5842-a9a6-463a-8041-72aa08ca3cf6","69091246-20e8-4a56-aa4d-066075b2a7a8" }</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</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>GroupID</maml:name> <maml:description> <maml:para>Entra ID Group Object ID Guid to assign specific Entra ID roles.</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="named" aliases="none"> <maml:name>RoleDefinitionId</maml:name> <maml:description> <maml:para>Array of Entra ID role Guids to be assigned to the specific Group. e.g. "29232cdf-9323-42fd-ade2-1d097af3e4de","892c5842-a9a6-463a-8041-72aa08ca3cf6","69091246-20e8-4a56-aa4d-066075b2a7a8"</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="False" position="named" aliases="none"> <maml:name>GraphBaseURL</maml:name> <maml:description> <maml:para>The base URL to use to query the Graph API with trailing slash, defaults to the v1.0 Graph API. e.g. https://graph.microsoft.com/v1.0/</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>Https://graph.microsoft.com/v1.0/</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None. You can't pipe objects to New-GDAPAccessAssignment.</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. Returns a PSObject with contents of type delegatedAdminAccessAssignment.</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 --------------------------</maml:title> <dev:code>New-GDAPAccessAssignment -GDAPRelationshipId $GDAPRelationshipId -GroupID "2e7731c4-4d77-42fb-83dd-a876dc1167f5" -RoleDefinitionId "29232cdf-9323-42fd-ade2-1d097af3e4de","892c5842-a9a6-463a-8041-72aa08ca3cf6","69091246-20e8-4a56-aa4d-066075b2a7a8" -GraphBaseURL "https://graph.microsoft.com/v1.0/" { "@odata.type": "#microsoft.graph.delegatedAdminAccessAssignment", "@odata.context": "https://graph.microsoft.com/v1.0/tenantRelationships/$metadata#accessAssignments", "@odata.etag": "W/\"JyIxODAwZTY4My0wMDAwLTAyMDAtMDAwMC02MTU0OWFmMDAwMDAiJw==\"", "id": "a9d6cf90-083a-47dc-ace2-1da98be3f344", "status": "pending", "createdDateTime": "2022-02-13T10:33:52.3182097Z", "lastModifiedDateTime": "2022-02-13T10:33:52.3182097Z", "accessContainer": { "accessContainerId": "2e7731c4-4d77-42fb-83dd-a876dc1167f5", "accessContainerType": "securityGroup" }, "accessDetails": { "unifiedRoles": [ { "roleDefinitionId": "29232cdf-9323-42fd-ade2-1d097af3e4de" }, { "roleDefinitionId": "892c5842-a9a6-463a-8041-72aa08ca3cf6" }, { "roleDefinitionId": "69091246-20e8-4a56-aa4d-066075b2a7a8" } ] } }</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>New-GDAPAccessAssignment -GDAPRelationshipId $GDAPRelationshipId -RoleAccessContainer @{ Id = "dcd42917-0f97-49b3-88ad-7dd2f96345ba"; Roles = "29232cdf-9323-42fd-ade2-1d097af3e4de","892c5842-a9a6-463a-8041-72aa08ca3cf6","69091246-20e8-4a56-aa4d-066075b2a7a8" } -GraphBaseURL "https://graph.microsoft.com/v1.0/"</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Graph API Reference - Create new GDAP accessAssignments: https://learn.microsoft.com/en-us/graph/api/delegatedadminrelationship-post-accessassignments</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Graph API Reference - delegatedAdminAccessAssignment: https://learn.microsoft.com/en-us/graph/api/resources/delegatedadminaccessassignment</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-GDAPRelationship</command:name> <command:verb>New</command:verb> <command:noun>GDAPRelationship</command:noun> <maml:description> <maml:para>Creates a new GDAP Relationship with the specified parameters. Generates the display name, if required, and returns the ID of the GDAP relationship.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a new GDAP Relationship with the specified parameters. Generates the display name, if required, and returns the ID of the GDAP relationship.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-GDAPRelationship</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ClientTenantName</maml:name> <maml:description> <maml:para>The display name of the client's Entra ID tenant as displayed in the client's Entra Admin Center at https://entra.microsoft.com/#view/Microsoft_AAD_IAM/TenantOverview.ReactView.</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="False" position="named" aliases="none"> <maml:name>ClientTenantID</maml:name> <maml:description> <maml:para>The client's Tenant ID Guid of their Entra ID tenant as displayed in the client's Entra Admin Center at https://entra.microsoft.com/#view/Microsoft_AAD_IAM/TenantOverview.ReactView.</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="False" position="named" aliases="none"> <maml:name>GDAPRelationshipName</maml:name> <maml:description> <maml:para>Enter the name of the new GDAP relationship to create. e.g. "GDAP_2023_<Tenant_ID>"</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="False" position="named" aliases="none"> <maml:name>RelationshipExpirationInDays</maml:name> <maml:description> <maml:para>The number of days for the GDAP relationship to live, maximum of 730 days. Defaults to 730 days. e.g. 730</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>730</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AutoExtendRelationship</maml:name> <maml:description> <maml:para>Switch to indicate that the "autoExtendDuration" value should be set to the allowed extend time of "P180D". May not take effect if the Global Admin role is included in RoleIDs.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RoleDefinitionId</maml:name> <maml:description> <maml:para>Array of strings with the Entra ID roles to be assigned to the GDAP relationship, must be in GUID form. e.g. "29232cdf-9323-42fd-ade2-1d097af3e4de","892c5842-a9a6-463a-8041-72aa08ca3cf6","69091246-20e8-4a56-aa4d-066075b2a7a8"</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="False" position="named" aliases="none"> <maml:name>GraphBaseURL</maml:name> <maml:description> <maml:para>The base URL to use to query the Graph API with trailing slash, defaults to the v1.0 Graph API. e.g. https://graph.microsoft.com/v1.0/</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>Https://graph.microsoft.com/v1.0/</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-GDAPRelationship</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ClientTenantName</maml:name> <maml:description> <maml:para>The display name of the client's Entra ID tenant as displayed in the client's Entra Admin Center at https://entra.microsoft.com/#view/Microsoft_AAD_IAM/TenantOverview.ReactView.</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="False" position="named" aliases="none"> <maml:name>ClientTenantID</maml:name> <maml:description> <maml:para>The client's Tenant ID Guid of their Entra ID tenant as displayed in the client's Entra Admin Center at https://entra.microsoft.com/#view/Microsoft_AAD_IAM/TenantOverview.ReactView.</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="False" position="named" aliases="none"> <maml:name>RelationshipExpirationInDays</maml:name> <maml:description> <maml:para>The number of days for the GDAP relationship to live, maximum of 730 days. Defaults to 730 days. e.g. 730</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>730</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AutoExtendRelationship</maml:name> <maml:description> <maml:para>Switch to indicate that the "autoExtendDuration" value should be set to the allowed extend time of "P180D". May not take effect if the Global Admin role is included in RoleIDs.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RelationshipPrefix</maml:name> <maml:description> <maml:para>The prefix to use in the generated GDAP relationship name. e.g. CompName</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="named" aliases="none"> <maml:name>RoleDefinitionId</maml:name> <maml:description> <maml:para>Array of strings with the Entra ID roles to be assigned to the GDAP relationship, must be in GUID form. e.g. "29232cdf-9323-42fd-ade2-1d097af3e4de","892c5842-a9a6-463a-8041-72aa08ca3cf6","69091246-20e8-4a56-aa4d-066075b2a7a8"</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="False" position="named" aliases="none"> <maml:name>GraphBaseURL</maml:name> <maml:description> <maml:para>The base URL to use to query the Graph API with trailing slash, defaults to the v1.0 Graph API. e.g. https://graph.microsoft.com/v1.0/</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>Https://graph.microsoft.com/v1.0/</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</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>ClientTenantName</maml:name> <maml:description> <maml:para>The display name of the client's Entra ID tenant as displayed in the client's Entra Admin Center at https://entra.microsoft.com/#view/Microsoft_AAD_IAM/TenantOverview.ReactView.</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="False" position="named" aliases="none"> <maml:name>ClientTenantID</maml:name> <maml:description> <maml:para>The client's Tenant ID Guid of their Entra ID tenant as displayed in the client's Entra Admin Center at https://entra.microsoft.com/#view/Microsoft_AAD_IAM/TenantOverview.ReactView.</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="False" position="named" aliases="none"> <maml:name>GDAPRelationshipName</maml:name> <maml:description> <maml:para>Enter the name of the new GDAP relationship to create. e.g. "GDAP_2023_<Tenant_ID>"</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="False" position="named" aliases="none"> <maml:name>RelationshipExpirationInDays</maml:name> <maml:description> <maml:para>The number of days for the GDAP relationship to live, maximum of 730 days. Defaults to 730 days. e.g. 730</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>730</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AutoExtendRelationship</maml:name> <maml:description> <maml:para>Switch to indicate that the "autoExtendDuration" value should be set to the allowed extend time of "P180D". May not take effect if the Global Admin role is included in RoleIDs.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RelationshipPrefix</maml:name> <maml:description> <maml:para>The prefix to use in the generated GDAP relationship name. e.g. CompName</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="named" aliases="none"> <maml:name>RoleDefinitionId</maml:name> <maml:description> <maml:para>Array of strings with the Entra ID roles to be assigned to the GDAP relationship, must be in GUID form. e.g. "29232cdf-9323-42fd-ade2-1d097af3e4de","892c5842-a9a6-463a-8041-72aa08ca3cf6","69091246-20e8-4a56-aa4d-066075b2a7a8"</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="False" position="named" aliases="none"> <maml:name>GraphBaseURL</maml:name> <maml:description> <maml:para>The base URL to use to query the Graph API with trailing slash, defaults to the v1.0 Graph API. e.g. https://graph.microsoft.com/v1.0/</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>Https://graph.microsoft.com/v1.0/</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None. You can't pipe objects to New-GDAPRelationship.</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. Returns a PSObject with contents of type delegatedAdminRelationship.</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 --------------------------</maml:title> <dev:code>New-GDAPRelationship -ClientTenantName "Client Tenant Name" -ClientTenantID "<TenantGUID>" -RelationshipPrefix "<PartnerOrgName>" -RoleDefinitionId "<RoleGuid1>","<RoleGuid2>","<RoleGuid3>" -GraphBaseURL "https://graph.microsoft.com/v1.0/" { "@odata.type": "#microsoft.graph.delegatedAdminRelationship", "accessDetails": { "unifiedRoles": [ { "roleDefinitionId": "<RoleGuid1>" }, { "roleDefinitionId": "<RoleGuid1>" }, { "roleDefinitionId": "<RoleGuid1>" } ] }, "customer": { "displayName": "Client Tenant Name", "tenantId": "<TenantGUID>" }, "displayName": "<PartnerOrgName>_<Year>_<TenantGUID>", "duration": "P730D", "id": "b9236c36-db8a-4945-97d0-6ef64df0c78b-1917a718-62fc-42f2-9712-33fcc2444049" }</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>New-GDAPRelationship -GDAPRelationshipName "NewClient_2023_GDAPRelationship" -RoleDefinitionId $RoleIDs -GraphBaseURL "https://graph.microsoft.com/v1.0/" { "@odata.type": "#microsoft.graph.delegatedAdminRelationship", "accessDetails": {"@odata.type": "microsoft.graph.delegatedAdminAccessDetails"}, "customer": {"@odata.type": "microsoft.graph.delegatedAdminRelationshipCustomerParticipant"}, "displayName": "NewClient_2023_GDAPRelationship", "duration": "P730D", "id": "cc61b71e-ab8e-413e-8e0d-0b93c98cc17d-6f3b3e13-9c0a-410d-9c1f-db65119437ab" }</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Graph API Reference - Create new GDAP Relationship: https://learn.microsoft.com/en-us/graph/api/tenantrelationship-post-delegatedadminrelationships</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Graph API Reference - delegatedAdminRelationship: https://learn.microsoft.com/en-us/graph/api/resources/delegatedadminrelationship</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-ExistingGDAPRelationship</command:name> <command:verb>Remove</command:verb> <command:noun>ExistingGDAPRelationship</command:noun> <maml:description> <maml:para>Terminates an existing GDAP Relationship.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Terminates an existing GDAP Relationship. Verifies the status is capable of being terminated.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-ExistingGDAPRelationship</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>GDAPRelationshipObject</maml:name> <maml:description> <maml:para>delegatedAdminRelationship Object containing, at minimum, GDAP Relationship ID ( .Id), OData eTag ($ ."@odata.etag"), and status ($_.status).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</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>GraphBaseURL</maml:name> <maml:description> <maml:para>The base URL to use to query the Graph API with trailing slash, defaults to the v1.0 Graph API. e.g. https://graph.microsoft.com/v1.0/</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>Https://graph.microsoft.com/v1.0/</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-ExistingGDAPRelationship</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GDAPRelationshipID</maml:name> <maml:description> <maml:para>The GDAP relationship ID provided during the GDAP relationship request creation process.</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="False" position="named" aliases="none"> <maml:name>GraphBaseURL</maml:name> <maml:description> <maml:para>The base URL to use to query the Graph API with trailing slash, defaults to the v1.0 Graph API. e.g. https://graph.microsoft.com/v1.0/</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>Https://graph.microsoft.com/v1.0/</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>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 (ByValue)" position="named" aliases="none"> <maml:name>GDAPRelationshipObject</maml:name> <maml:description> <maml:para>delegatedAdminRelationship Object containing, at minimum, GDAP Relationship ID ( .Id), OData eTag ($ ."@odata.etag"), and status ($_.status).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</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>GDAPRelationshipID</maml:name> <maml:description> <maml:para>The GDAP relationship ID provided during the GDAP relationship request creation process.</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="False" position="named" aliases="none"> <maml:name>GraphBaseURL</maml:name> <maml:description> <maml:para>The base URL to use to query the Graph API with trailing slash, defaults to the v1.0 Graph API. e.g. https://graph.microsoft.com/v1.0/</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>Https://graph.microsoft.com/v1.0/</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>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.Object. Type of delegatedAdminRelationship.</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Bool. Returns a bool with status of the termination request.</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 --------------------------</maml:title> <dev:code>Remove-ExistingGDAPRelationship -GDAPRelationshipObject $GDAPRelationshipObject -GraphBaseURL "https://graph.microsoft.com/v1.0/" @{ GDAPRelationshipID = <Guid>-<Guid>; Terminated = $True }</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Graph API Reference - Delete GDAP delegatedAdminAccessAssignment: https://learn.microsoft.com/en-us/graph/api/delegatedadminrelationship-delete</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Graph API Reference - delegatedAdminRelationship: https://learn.microsoft.com/en-us/graph/api/resources/delegatedadminrelationship</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |