Delegate365.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>Delegate365</name> </assembly> <members> <member name="T:Delegate365.Api.Client.ConnectDelegate365Cmdlet"> <summary> <para type="synopsis">Connects to the API in Delegate365. </para> <para type="description">Connect-Delegate365 connects to the API in Delegate365. Use this command to connect to your Delegate365 tenant at the beginning of any PowerShell commands or scripts. This command requires a WebApiBaseUrl and a WebApiSasKey parameter. The WebApiBaseUrl is the URI of your Delegate365 tenant, as https://[mycompany].delegate365.com. The WebApiSasKey must be provided by your Delegate365 Portal Admin. It's a key that identifies your admin account and is specific for your use. The key is a string as "123456..". Keep this key well and do not hand it over to other persons, it's your personal access to the API. As output, an informational string is returned. If no error occurs, it should respond with "successfully connected" within some seconds. After a successful connection is established, you can start working with the Delegate365 cmdlets. Afterwards, use Disconnect-Delegate365 to close the connection. Use Get-Command -Module Delegate365 to see a list of available commands in this module, or Get-Help [command] for information about a specific command. Happy automating with Delegate365! </para> <para type="link" uri="https://support.delegate365.com/">Delegate365 support</para> </summary> <example> <code> $apiKey = '123456...' $baseUrl = 'https://mycompany.delegate365.com' Connect-Delegate365 -WebApiSasKey $apiKey -WebApiBaseUrl $baseUrl </code> <para>Connect to your Delegate365 API with your key and your portal-URL.</para> </example> </member> <member name="P:Delegate365.Api.Client.ConnectDelegate365Cmdlet.WebApiSasKey"> <summary> <para type="description">The API-key can be generated by a Portal Admin in the Delegate365 portal in the administration/administrators menu for each admin. Select a user and click Edit admin. In the user pane, scroll down to the WebApiKey field and generate a new key if needed anytime. </para> </summary> </member> <member name="P:Delegate365.Api.Client.ConnectDelegate365Cmdlet.WebApiBaseUrl"> <summary> <para type="description">The Base-URL is the URL of your Delegate365 portal, e.g. https://mycompany.delegate365.com</para> </summary> </member> <member name="T:Delegate365.Api.Client.D365Cmdlet"> <summary> <para type="synopsis">This is the Delegate365 API client.</para> <para type="description">The Delegate365 API client allows Administrators to programmatically access Delegate365 and specific Office 365 services. For authentication, each Admin needs to connect and provide a WebAPIKey and the baseURL of his Delegate365 portal. An Administrator has only access to his entitled objects. </para> <para type="link" uri="http://www.delegate365.com">Delegate365 API reference</para> </summary> <example> <para>This is the Delegate365 API client.</para> </example> </member> <member name="M:Delegate365.Api.Client.D365Cmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="T:Delegate365.Api.Client.DeleteDAdministratorCmdlet"> <summary> <para type="synopsis">Delete an existing administrator from Delegate365. This command is available starting with Delegate365 v8.2 </para> <para type="description">Delete-DAdministrator removes a specific administrator from the Delegate365. Alias commands are: Delete-DAdmin, Remove-DAdmin. The user object itself stays untouched, just he or she gets removed from them Delegate365 Administrator's list. When deleted, that user no longer has access to the Delegate365 portal. There is no Undo function. In case that user shall get access again, he or she must be created, e.g. with the New-DAdministrator cmdlet. The Delegate365 Audit Logs stay unchanged and Portal Admins can see all logged actions of that user from the past. To remove any user data from the Audit logs, use the GDPR function in Delegate365. The output shows "Successfully deleted", or "Administrator not found" if the user is not existing in the Administrator's list or the error message if another error was thrown. </para> <para type="link" uri="https://support.delegate365.com/">Delegate365 support</para> </summary> <example> <code> Delete-DAdministrator -Identity john.doe@delegate365.com </code> <para>Deletes the administrator from the Delegate365 administrator list.</para> </example> <example> <code> Delete-DAdministrator -UserPrincipalName john.doe@delegate365.com </code> <para>Alternatively, the parameter -UserPrincipalName can be used instead of the -Identity parameter.</para> </example> </member> <member name="P:Delegate365.Api.Client.DeleteDAdministratorCmdlet.Identity"> <summary> <para type="description">Find a specific item. Wildcards are not supported, use the UserPrincipalName.</para> </summary> </member> <member name="P:Delegate365.Api.Client.DeleteDAdministratorCmdlet.UserPrincipalName"> <summary> <para type="description">The UserPrincipalName can be used instead of the Identity parameter.</para> </summary> </member> <member name="T:Delegate365.Api.Client.DisconnectDelegate365Cmdlet"> <summary> <para type="synopsis">Disconnects from the API in Delegate365. </para> <para type="description">Disconnect-Delegate365 disconnects your session from the API in Delegate365. Use this command to disconnect from your Delegate365 tenant after being connected. This closes the session. Thanks for using Delegate365! </para> <para type="link" uri="https://support.delegate365.com/">Delegate365 support</para> </summary> <example> <code> Disconnect-Delegate365 </code> <para>Disconnect from your Delegate365 API.</para> </example> </member> <member name="T:Delegate365.Api.Client.GetDAadUserCmdlet"> <summary> <para type="synopsis">Gets one or multiple users from Azure Active Directory. </para> <para type="description">Get-DAADUser returns a list of users from Azure Active Directory. This command allows to directly query the AAD, without any filtering. Therefore, the runtime can be longer than other cmdlets that deliver data from Delegate365. Parameters allow to get all users or a specific user. By default, the first 100 users are returned. Use the -All parameter to get the full list of users. Filter for one user by using the -Identity Parameter and the full UserPrincipalName or the ID. The ouput delivers all user properties from AAD. </para> <para type="description">Important: By default, the command shows all users that are assigned to any OU in Delegate365. When using the -Unassigned parameter, all users are returned that are not assigned to an OU. Be aware that this parameter only delivers the unassigned users if the authenticated user is PowerShell Administrator. Scope Admins that are not PowerShell Administrator will see no output (an empty list), while PowerShell Administrators get all the unassigned users. </para> <para type="link" uri="https://support.delegate365.com/">Delegate365 support</para> </summary> <example> <code> Get-DAADUser </code> <para>By default, the command returns the first 100 assigned users.</para> </example> <example> <code> Get-DAADUser -All </code> <para>Add -All to get all users.</para> </example> <example> <code> Get-DAADUser -Unassigned -All </code> <para>Add -Unassigned to get users that are NOT assigned to an OU (can be combined with -All).</para> </example> <example> <code> Get-DAADUser -OU Seattle </code> <para>Add -OU to get users that are assigned to a specific OU.</para> </example> <example> <code> Get-DAADUser -Identity john.doe@delegate365.com </code> <para>Get one specific user by UPN or by ID,</para> </example> </member> <member name="P:Delegate365.Api.Client.GetDAadUserCmdlet.UnAssigned"> <summary> <para type="description">Delivers all users from AAD that are not assigned to an OU. Requires the PowerShell Administration permission.</para> </summary> </member> <member name="P:Delegate365.Api.Client.GetDAadUserCmdlet.All"> <summary> <para type="description">Delivers all users (and not only the first 100 users).</para> </summary> </member> <member name="F:Delegate365.Api.Client.GetDAadUserCmdlet.Identity"> <summary> <para type="description">Filter for one specific user. Wildcards are not supported, use the full UserPrincipalName or the ID.</para> </summary> </member> <member name="F:Delegate365.Api.Client.GetDAadUserCmdlet.OU"> <summary> <para type="description">Filter by the name of an OU.</para> </summary> </member> <member name="T:Delegate365.Api.Client.GetDAdministratorCmdlet"> <summary> <para type="synopsis">Gets one or multiple administrators from Delegate365. </para> <para type="description">Get-DAdministrator returns a list of administrators from Delegate365. To use Delegate365, a user must be added as Administrator in the Administrator's list. Permissions and assignments to OU's and to domains define the scope for an administrator. Parameters allow to get all administrators or one specific administrator. Filter for one administrator by using the -Identity Parameter and the full UserPrincipalName or the ID. The output shows assigned policies and settings for each admin. </para> <para type="link" uri="https://support.delegate365.com/">Delegate365 support</para> </summary> <example> <code> Get-DAdministrator </code> <para>By default, the command returns the first 100 assigned admins.</para> </example> <example> <code> Get-DAdministrator -All </code> <para>Add -All to get all admins.</para> </example> <example> <code> Get-DAdministrator -Identity john.doe@delegate365.com </code> <para>Get one specific admin by UPN or by ID.</para> </example> </member> <member name="P:Delegate365.Api.Client.GetDAdministratorCmdlet.All"> <summary> <para type="description">Delivers all items (and not only the first 100 items).</para> </summary> </member> <member name="F:Delegate365.Api.Client.GetDAdministratorCmdlet.Identity"> <summary> <para type="description">Filter for one specific item. Wildcards are not supported, use the full name or the ID.</para> </summary> </member> <member name="T:Delegate365.Api.Client.GetDContactCmdlet"> <summary> <para type="synopsis">Gets one or multiple contacts from Delegate365. </para> <para type="description">Get-DContact returns a list of contacts from Delegate365. Contacts usually store external person's data in the Office 365 tenant. Parameters allow to get all contacts or one specific contact. Filter for one contact by using the -Identity Parameter and the full name or the ID. The output shows the most essential properties for each contact. </para> <para type="link" uri="https://support.delegate365.com/">Delegate365 support</para> </summary> <example> <code> Get-DContact </code> <para>By default, the command returns the first 100 assigned contacts.</para> </example> <example> <code> Get-DContact -All </code> <para>Add -All to get all contacts.</para> </example> <example> <code> Get-DContact -Unassigned -All </code> <para>Add -Unassigned to get contacts that are NOT assigned to an OU (can be combined with -All).</para> </example> <example> <code>Get-DContact -OU Seattle </code> <para>Add -OU to get contacts that are assigned to a specific OU.</para> </example> <example> <code> Get-DContact -Identity john.doe@outlook.com </code> <para>Get one specific contact by name or by ID.</para> </example> </member> <member name="P:Delegate365.Api.Client.GetDContactCmdlet.UnAssigned"> <summary> <para type="description">Delivers all contacts that are not assigned to an OU.</para> </summary> </member> <member name="P:Delegate365.Api.Client.GetDContactCmdlet.All"> <summary> <para type="description">Delivers all contacts (and not only the first 100 items).</para> </summary> </member> <member name="P:Delegate365.Api.Client.GetDContactCmdlet.Identity"> <summary> <para type="description">Filter for one specific contact. Wildcards are not supported, use the full name or the ID.</para> </summary> </member> <member name="F:Delegate365.Api.Client.GetDContactCmdlet.OU"> <summary> <para type="description">Filter by the name of an OU.</para> </summary> </member> <member name="T:Delegate365.Api.Client.GetDDistributionGroupCmdlet"> <summary> <para type="synopsis">Gets one or multiple distribution groups from Delegate365. </para> <para type="description">Get-DDistributionGroup returns a list of distribution groups from Delegate365. Distribution groups (DG) allow to deliver emails to multiple users. Parameters allow to get all distribution groups or one specific distribution group. Filter for one distribution group by using the -Identity Parameter and the full name or the ID. The output shows the most essential properties for each distribution group. </para> <para type="link" uri="https://support.delegate365.com/">Delegate365 support</para> </summary> <example> <code> Get-DDistributionGroup </code> <para>By default, the command returns the first 100 assigned distribution groups.</para> </example> <example> <code> Get-DDistributionGroup -All </code> <para>Add -All to get all distribution groups.</para> </example> <example> <code> Get-DDistributionGroup -Unassigned -All </code> <para>Add -Unassigned to get distribution groups that are NOT assigned to an OU (can be combined with -All).</para> </example> <example> <code> Get-DDistributionGroup -OU Seattle </code> <para>Add -OU to get distribution groups that are assigned to a specific OU.</para> </example> <example> <code> Get-DDistributionGroup -Identity it-department@delegate365.com </code> <para>Get one specific distribution group by name or by ID.</para> </example> </member> <member name="P:Delegate365.Api.Client.GetDDistributionGroupCmdlet.UnAssigned"> <summary> <para type="description">Delivers all distribution groups that are not assigned to an OU.</para> </summary> </member> <member name="P:Delegate365.Api.Client.GetDDistributionGroupCmdlet.All"> <summary> <para type="description">Delivers all distribution groups (and not only the first 100 items).</para> </summary> </member> <member name="F:Delegate365.Api.Client.GetDDistributionGroupCmdlet.Identity"> <summary> <para type="description">Filter for one specific distribution group. Wildcards are not supported, use the full name or the ID.</para> </summary> </member> <member name="F:Delegate365.Api.Client.GetDDistributionGroupCmdlet.OU"> <summary> <para type="description">Filter by the name of an OU.</para> </summary> </member> <member name="T:Delegate365.Api.Client.GetDDomainCmdlet"> <summary> <para type="synopsis">Gets one or multiple items of the domains in the tenant. </para> <para type="description">Get-DDomain returns a list of domains from Delegate365. Domains that are added to the Office 365 tenant are updated during each sync in Delegate365. Admins can only see users and groups if they are entitled to use the domain. Parameters allow to get all items or one specific item. The output shows the Id and the name of existing domains. </para> <para type="link" uri="https://support.delegate365.com/">Delegate365 support</para> </summary> <example> <code> Get-DDomain </code> <para>By default, the command returns the first 100 assigned items.</para> </example> <example> <code> Get-DDomain -All </code> <para>Add -All to get all items.</para> </example> <example> <code> Get-DDomain -Identity 'Switzerland' </code> <para>Get one specific item by name or by ID.</para> </example> </member> <member name="P:Delegate365.Api.Client.GetDDomainCmdlet.All"> <summary> <para type="description">Delivers all domains (and not only the first 100 items).</para> </summary> </member> <member name="F:Delegate365.Api.Client.GetDDomainCmdlet.Identity"> <summary> <para type="description">Filter for one specific domains. Wildcards are not supported, use the full name or the ID.</para> </summary> </member> <member name="T:Delegate365.Api.Client.GetDDynamicGroupCmdlet"> <summary> <para type="synopsis">Gets one or multiple dynamic groups from Delegate365. </para> <para type="description">Get-DDynamicGroup returns a list of dynamic groups from Delegate365. Dynamic groups allow to specify rules for adding members dynamically based on user properties. Parameters allow to get all dynamic groups or one specific dynamic group. Filter for one dynamic group by using the -Identity Parameter and the full name or the ID. The output shows the most essential properties for each dynamic group. </para> <para type="link" uri="https://support.delegate365.com/">Delegate365 support</para> </summary> <example> <code> Get-DDynamicGroup </code> <para>By default, the command returns the first 100 assigned dynamic groups.</para> </example> <example> <code> Get-DDynamicGroup -All </code> <para>Add -All to get all dynamic groups.</para> </example> <example> <code> Get-DDynamicGroup -Unassigned -All </code> <para>Add -Unassigned to get dynamic groups that are NOT assigned to an OU (can be combined with -All).</para> </example> <example> <code> Get-DDynamicGroup -OU Seattle </code> <para>Add -OU to get dynamic groups that are assigned to a specific OU.</para> </example> <example> <code> Get-DDynamicGroup -Identity hr-department@delegate365.com </code> <para>Get one specific dynamic group by name or by ID.</para> </example> </member> <member name="P:Delegate365.Api.Client.GetDDynamicGroupCmdlet.UnAssigned"> <summary> <para type="description">Delivers all dynamic groups that are not assigned to an OU.</para> </summary> </member> <member name="P:Delegate365.Api.Client.GetDDynamicGroupCmdlet.All"> <summary> <para type="description">Delivers all dynamic groups (and not only the first 100 items).</para> </summary> </member> <member name="F:Delegate365.Api.Client.GetDDynamicGroupCmdlet.Identity"> <summary> <para type="description">Filter for one specific dynamic group. Wildcards are not supported, use the full name or the ID.</para> </summary> </member> <member name="F:Delegate365.Api.Client.GetDDynamicGroupCmdlet.OU"> <summary> <para type="description">Filter by the name of an OU.</para> </summary> </member> <member name="T:Delegate365.Api.Client.GetDLicenseQuotasCmdlet"> <summary> <para type="synopsis">Gets one or multiple licenses quotas from Delegate365. </para> <para type="description">Get-DLicenseQuotas returns a list of licenses quotas from Delegate365. Licenses quotas allow to restrict the number of Office 365 licenses that can be consumed by users per OU. This command creates a new license quota for an OU. </para> <para type="link" uri="https://support.delegate365.com/">Delegate365 support</para> </summary> <example> <code> Get-DLicenseQuotas </code> <para>By default, the command returns the first 100 assigned licenses quotas.</para> </example> <example> <code> Get-DLicenseQuotas -All </code> <para>Add -All to get all licenses quotas.</para> </example> <example> <code> Get-DLicenseQuotas -Unassigned -All </code> <para>Add -Unassigned to get licenses quotas that are NOT assigned to an OU (can be combined with -All).</para> </example> <example> <code> Get-DLicenseQuotas -OU Seattle </code> <para>Add -OU to get licenses quotas that are assigned to a specific OU.</para> </example> <example> <code> Get-DLicenseQuotas -Identity it-department@delegate365.com </code> <para>Get one specific licenses quota by name or by ID.</para> </example> </member> <member name="P:Delegate365.Api.Client.GetDLicenseQuotasCmdlet.All"> <summary> <para type="description">Delivers all Licenses quota (and not only the first 100 items).</para> </summary> </member> <member name="F:Delegate365.Api.Client.GetDLicenseQuotasCmdlet.OU"> <summary> <para type="description">Filter by the name of an OU.</para> </summary> </member> <member name="F:Delegate365.Api.Client.GetDLicenseQuotasCmdlet.Identity"> <summary> <para type="description">Filter for one specific Licenses quota. Wildcards are not supported, use the full name or the ID.</para> </summary> </member> <member name="T:Delegate365.Api.Client.GetDLicensesCmdlet"> <summary> <para type="synopsis">Gets one or multiple licenses from Delegate365. </para> <para type="description">Get-DLicenses returns a list of licenses from Delegate365. Licenses (SKU's) are a set of license plans that can be assigned to a user to allow access to an Office 365 service. Licenses are syncronized to Delegate365 from the Office 365 tenant and can be renamed within Delegate365 if needed. Parameters allow to get all licenses or one specific license. Filter for one license by using the -Identity Parameter and the full name or the ID. The output shows the existing licenses (SKU) in the Office 365 tenant. </para> <para type="link" uri="https://support.delegate365.com/">Delegate365 support</para> </summary> <example> <code> Get-DLicenses </code> <para>By default, the command returns the first 100 available licenses in the tenant.</para> </example> <example> <code> Get-DLicenses -All </code> <para>Add -All to get all licenses.</para> </example> <example> <code> Get-DLicenses -Identity 'Enterprise Mobility + Security E5' </code> <para>Get one specific license by name or by ID.</para> </example> </member> <member name="P:Delegate365.Api.Client.GetDLicensesCmdlet.All"> <summary> <para type="description">Delivers all Licenses (and not only the first 100 items).</para> </summary> </member> <member name="F:Delegate365.Api.Client.GetDLicensesCmdlet.Identity"> <summary> <para type="description">Filter for one specific Licenses. Wildcards are not supported, use the full name or the ID.</para> </summary> </member> <member name="T:Delegate365.Api.Client.GetDOffice365GroupCmdlet"> <summary> <para type="synopsis">Gets one or multiple Office 365 groups from Delegate365. </para> <para type="description">Get-DOffice365Group returns a list of Office 365 groups from Delegate365. Office 365 groups (or Unified Groups) live in Azure Active Directory and allow collaboration over mutliple Office 365 services. Parameters allow to get all Office 365 groups or one specific Office 365 group. Filter for one Office 365 group by using the -Identity Parameter and the full name or the ID. The output shows the most essential properties for each Office 365 group. </para> <para type="link" uri="https://support.delegate365.com/">Delegate365 support</para> </summary> <example> <code> Get-DOffice365Group </code> <para>By default, the command returns the first 100 assigned Office 365 groups.</para> </example> <example> <code> Get-DOffice365Group -All </code> <para>Add -All to get all Office 365 groups.</para> </example> <example> <code> Get-DOffice365Group -Unassigned -All </code> <para>Add -Unassigned to get Office 365 groups that are NOT assigned to an OU (can be combined with -All).</para> </example> <example> <code> Get-DOffice365Group -OU Seattle </code> <para>Add -OU to get Office 365 groups that are assigned to a specific OU.</para> </example> <example> <code> Get-DOffice365Group -Identity project-tango@delegate365.com </code> <para>Get one specific Office 365 group by name or by ID.</para> </example> </member> <member name="P:Delegate365.Api.Client.GetDOffice365GroupCmdlet.UnAssigned"> <summary> <para type="description">Delivers all Office 365 groups that are not assigned to an OU.</para> </summary> </member> <member name="P:Delegate365.Api.Client.GetDOffice365GroupCmdlet.All"> <summary> <para type="description">Delivers all Office 365 groups (and not only the first 100 items).</para> </summary> </member> <member name="P:Delegate365.Api.Client.GetDOffice365GroupCmdlet.Identity"> <summary> <para type="description">Filter for one specific Office 365 group. Wildcards are not supported, use the full name or the ID.</para> </summary> </member> <member name="F:Delegate365.Api.Client.GetDOffice365GroupCmdlet.OU"> <summary> <para type="description">Filter by the name of an OU.</para> </summary> </member> <member name="T:Delegate365.Api.Client.GetDOrganizationalUnitCmdlet"> <summary> <para type="synopsis">Gets one or multiple OUs from Delegate365. </para> <para type="description">Get-DOrganizationalUnit returns a list of OUs from Delegate365. Organizational Units (OUs) are used as container to allow delegated management within Delegate365. Parameters allow to get all OUs or one specific OU. Filter for one OU by using the -Identity Parameter and the full name or the ID. The output shows the ID and the name of each OU. </para> <para type="link" uri="https://support.delegate365.com/">Delegate365 support</para> </summary> <example> <code> Get-DOrganizationalUnit </code> <para>By default, the command returns the first 100 assigned OUs.</para> </example> <example> <code> Get-DOrganizationalUnit -All </code> <para>Add -All to get all OUs.</para> </example> <example> <code> Get-DOrganizationalUnit -Unassigned -All </code> <para>Add -Unassigned to get OUs that are NOT assigned to an OU (can be combined with -All).</para> </example> <example> <code> Get-DOrganizationalUnit -Identity Seattle </code> <para>Get one specific OU by name or by ID.</para> </example> </member> <member name="P:Delegate365.Api.Client.GetDOrganizationalUnitCmdlet.All"> <summary> <para type="description">Delivers all OUs that are not assigned to an OU.</para> </summary> </member> <member name="F:Delegate365.Api.Client.GetDOrganizationalUnitCmdlet.Identity"> <summary> <para type="description">Filter for one specific OU. Wildcards are not supported, use the full name or the ID.</para> </summary> </member> <member name="T:Delegate365.Api.Client.GetDPermissionCmdlet"> <summary> <para type="synopsis">Gets one or multiple permission policies from Delegate365. </para> <para type="description">Get-DPermission returns a list of permission policies from Delegate365. Permission policies define what modules and permissions Delegate365 administrators get. Parameters allow to get all permission policies or one specific permission policy. Filter for one permission policy by using the -Identity Parameter and the full name or the ID. The output shows the properties for each permission policy. </para> <para type="link" uri="https://support.delegate365.com/">Delegate365 support</para> </summary> <example> <code> Get-DPermission </code> <para>By default, the command returns the first 100 assigned permission policies.</para> </example> <example> <code> Get-DPermission -All </code> <para>Add -All to get all permission policies.</para> </example> <example> <code> Get-DPermission -Identity 'Scope Admins New York' </code> <para>Get one specific permission policy by name or by ID.</para> </example> </member> <member name="P:Delegate365.Api.Client.GetDPermissionCmdlet.All"> <summary> <para type="description">Delivers all permission policies that are not assigned to an OU.</para> </summary> </member> <member name="F:Delegate365.Api.Client.GetDPermissionCmdlet.Identity"> <summary> <para type="description">Filter for one specific permission policy. Wildcards are not supported, use the full name or the ID.</para> </summary> </member> <member name="T:Delegate365.Api.Client.GetDResourceCmdlet"> <summary> <para type="synopsis">Gets one or multiple resources from Delegate365. </para> <para type="description">Get-DResource returns a list of resources from Delegate365. Mailbox of type 'resource' are used to store information about equipment and rooms. Parameters allow to get all resources or one specific resource. Filter for one resource by using the -Identity Parameter and the full name or the ID. The output shows the most essential properties for each resource. </para> <para type="link" uri="https://support.delegate365.com/">Delegate365 support</para> </summary> <example> <code> Get-DResource </code> <para>By default, the command returns the first 100 assigned resources.</para> </example> <example> <code> Get-DResource -All </code> <para>Add -All to get all resources.</para> </example> <example> <code> Get-DResource -Unassigned -All </code> <para>Add -Unassigned to get resources that are NOT assigned to an OU (can be combined with -All).</para> </example> <example> <code> Get-DResource -OU Seattle </code> <para>Add -OU to get resources that are assigned to a specific OU.</para> </example> <example> <code> Get-DResource -Identity ConfRoomCrystal@delegate365.com </code> <para>Get one specific resource by name or by ID.</para> </example> </member> <member name="P:Delegate365.Api.Client.GetDResourceCmdlet.UnAssigned"> <summary> <para type="description">Delivers all resources that are not assigned to an OU.</para> </summary> </member> <member name="P:Delegate365.Api.Client.GetDResourceCmdlet.All"> <summary> <para type="description">Delivers all resources (and not only the first 100 items).</para> </summary> </member> <member name="F:Delegate365.Api.Client.GetDResourceCmdlet.Identity"> <summary> <para type="description">Filter for one specific resource. Wildcards are not supported, use the full name or the ID.</para> </summary> </member> <member name="F:Delegate365.Api.Client.GetDResourceCmdlet.OU"> <summary> <para type="description">Filter by the name of an OU.</para> </summary> </member> <member name="T:Delegate365.Api.Client.GetDSecurityGroupCmdlet"> <summary> <para type="synopsis">Gets one or multiple security groups from Delegate365. </para> <para type="description">Get-DSecurityGroup returns a list of security groups from Delegate365. Security groups (SG) are an essential part in organizing users and can be used to automate OU and license assignments in Delegate365. Parameters allow to get all security groups or one specific security group. Filter for one security group by using the -Identity Parameter and the full name or the ID. The output shows the most essential properties for each security group. </para> <para type="link" uri="https://support.delegate365.com/">Delegate365 support</para> </summary> <example> <code> Get-DSecurityGroup </code> <para>By default, the command returns the first 100 assigned security groups.</para> </example> <example> <code> Get-DSecurityGroup -All </code> <para>Add -All to get all security groups.</para> </example> <example> <code> Get-DSecurityGroup -Unassigned -All </code> <para>Add -Unassigned to get security groups that are NOT assigned to an OU (can be combined with -All).</para> </example> <example> <code> Get-DSecurityGroup -OU Seattle </code> <para>Add -OU to get security groups that are assigned to a specific OU.</para> </example> <example> <code> Get-DSecurityGroup -Identity 'Sales department' </code> <para>Get one specific security group by name or by ID.</para> </example> </member> <member name="P:Delegate365.Api.Client.GetDSecurityGroupCmdlet.UnAssigned"> <summary> <para type="description">Delivers all security groups that are not assigned to an OU.</para> </summary> </member> <member name="P:Delegate365.Api.Client.GetDSecurityGroupCmdlet.All"> <summary> <para type="description">Delivers all security groups (and not only the first 100 items).</para> </summary> </member> <member name="P:Delegate365.Api.Client.GetDSecurityGroupCmdlet.Identity"> <summary> <para type="description">Filter for one specific security group. Wildcards are not supported, use the full name or the ID.</para> </summary> </member> <member name="F:Delegate365.Api.Client.GetDSecurityGroupCmdlet.OU"> <summary> <para type="description">Filter by the name of an OU.</para> </summary> </member> <member name="T:Delegate365.Api.Client.GetDDSharedMailboxCmdlet"> <summary> <para type="synopsis">Gets one or multiple shared mailboxes from Delegate365. </para> <para type="description">Get-DSharedMailbox returns a list of shared mailboxes from Delegate365. Shared mailboxes can be used as mailbox for mutliple users. Parameters allow to get all shared mailboxes or one specific shared mailbox. Filter for one shared mailbox by using the -Identity Parameter and the full name or the ID. The output shows the most essential properties for each shared mailbox. </para> <para type="link" uri="https://support.delegate365.com/">Delegate365 support</para> </summary> <example> <code> Get-DSharedMailbox </code> <para>By default, the command returns the first 100 assigned shared mailboxes.</para> </example> <example> <code> Get-DSharedMailbox -All </code> <para>Add -All to get all shared mailboxes.</para> </example> <example> <code> Get-DSharedMailbox -Unassigned -All </code> <para>Add -Unassigned to get shared mailboxes that are NOT assigned to an OU (can be combined with -All).</para> </example> <example> <code> Get-DSharedMailbox -OU Seattle </code> <para>Add -OU to get shared mailboxes that are assigned to a specific OU.</para> </example> <example> <code> Get-DSharedMailbox -Identity support@delegate365.com </code> <para>Get one specific shared mailbox by name or by ID.</para> </example> </member> <member name="P:Delegate365.Api.Client.GetDDSharedMailboxCmdlet.UnAssigned"> <summary> <para type="description">Delivers all shared mailboxes that are not assigned to an OU.</para> </summary> </member> <member name="P:Delegate365.Api.Client.GetDDSharedMailboxCmdlet.All"> <summary> <para type="description">Delivers all shared mailboxes (and not only the first 100 items).</para> </summary> </member> <member name="F:Delegate365.Api.Client.GetDDSharedMailboxCmdlet.Identity"> <summary> <para type="description">Filter for one specific shared mailboxe. Wildcards are not supported, use the full name or the ID.</para> </summary> </member> <member name="F:Delegate365.Api.Client.GetDDSharedMailboxCmdlet.OU"> <summary> <para type="description">Filter by the name of an OU.</para> </summary> </member> <member name="T:Delegate365.Api.Client.GetDUsageLocationCmdlet"> <summary> <para type="synopsis">Gets one or multiple items of the usage locations. </para> <para type="description">Get-DUsageLocation returns a list of usage locations from Delegate365. Usage locations are required to set an Office 365 license to a user and can be managed in Delegate365. Parameters allow to get all items or one specific item. The output shows the Id and the name of existing usage locations. </para> <para type="link" uri="https://support.delegate365.com/">Delegate365 support</para> </summary> <example> <code> Get-DUsageLocation </code> <para>By default, the command returns the first 100 assigned items.</para> </example> <example> <code> Get-DUsageLocation -All </code> <para>Add -All to get all items.</para> </example> <example> <code> Get-DUsageLocation -Identity 'Switzerland' </code> <para>Get one specific item by name or by ID.</para> </example> </member> <member name="P:Delegate365.Api.Client.GetDUsageLocationCmdlet.All"> <summary> <para type="description">Delivers all items (and not only the first 100 items).</para> </summary> </member> <member name="F:Delegate365.Api.Client.GetDUsageLocationCmdlet.Identity"> <summary> <para type="description">Filter for one specific item. Wildcards are not supported, use the full name or the ID.</para> </summary> </member> <member name="T:Delegate365.Api.Client.GetDUserCmdlet"> <summary> <para type="synopsis">Gets one or multiple users from Delegate365. </para> <para type="description">Get-DUser returns a list of users from Delegate365. In Delegate365, users can be managed by Scope Admins if they are assigned to an OU. Parameters allow to get all users, users of a specific OU, or unassigned users. By default, the first 100 users are returned. Use the -All parameter to get the full list of users. Filter for one user by using the -Identity Parameter and the full UserPrincipalName or the ObjectID. The ouput delivers the most essential user properties: the Id in the Delegate365 database, the Identity is the AAD ObjectID, the UserPrincipalName, the DisplayName and the OU assignment. </para> <para type="description">Important: By default, the command shows all users that are assigned to any OU in Delegate365. When using the -Unassigned parameter, all users are returned that are not assigned to an OU. Be aware that this parameter only delivers the unassigned users if the authenticated user is PowerShell Administrator. Scope Admins that are not PowerShell Administrator will see no output (an empty list), while PowerShell Administrators get all the unassigned users. </para> <para type="link" uri="https://support.delegate365.com/">Delegate365 support</para> </summary> <example> <code> Get-DUser </code> <para>By default, the command returns the first 100 assigned users.</para> </example> <example> <code> Get-DUser -All </code> <para>Add -All to get all users.</para> </example> <example> <code> Get-DUser -Unassigned -All </code> <para>Add -Unassigned to get users that are NOT assigned to an OU (can be combined with -All).</para> </example> <example> <code> Get-DUser -OU Seattle </code> <para>Add -OU to get users that are assigned to a specific OU.</para> </example> <example> <code> Get-DUser -Identity john.doe@delegate365.com </code> <para>Get one specific user by UPN or by ID.</para> </example> </member> <member name="P:Delegate365.Api.Client.GetDUserCmdlet.UnAssigned"> <summary> <para type="description">Delivers all users from Delegate365 that are not assigned to an OU. Requires the PowerShell Administration permission.</para> </summary> </member> <member name="P:Delegate365.Api.Client.GetDUserCmdlet.All"> <summary> <para type="description">Delivers all users (and not only the first 100 users).</para> </summary> </member> <member name="P:Delegate365.Api.Client.GetDUserCmdlet.Identity"> <summary> <para type="description">Filter for one specific user. Wildcards are not supported, use the full UserPrincipalName or the ID.</para> </summary> </member> <member name="F:Delegate365.Api.Client.GetDUserCmdlet.OU"> <summary> <para type="description">Filter by the name of an OU.</para> </summary> </member> <member name="T:Delegate365.Api.Client.NewDAdministratorCmdlet"> <summary> <para type="synopsis">Creates a new administrator in Delegate365. </para> <para type="description">New-DAdministrator creates a new administrator in Delegate365. To use Delegate365, a user must be added as Administrator in the Administrator's list. Permissions and assignments to OU's and to domains define the scope for an administrator. Administrators can be users in the same Office 365 tenant, or can be external users with an Office 365 work account. Optional, additional properties can be handed over to the command, see the example. The output shows the created admin object. </para> <para type="link" uri="https://support.delegate365.com/">Delegate365 support</para> </summary> <example> <code> New-DAdministrator -UserPrincipalName 'john.doe@delegate365.com' </code> <para>For creating a new admin, a UPN is required.</para> </example> <example> <code> $settings = New-Object Delegate365.Api.Core.Models.AdministratorSettings $settings.Email = 'john.doe@delegate365.com' $settings.Phone = '' $settings.UsageLocation = 'US' $settings.DailyNotifications = $false New-DAdministrator -UserPrincipalName john.doe@delegate365.com ` -OrganizationalUnits 'Paris', 'New York' ` -GroupOrganizationalUnits 'Seattle', 'Vienna' ` -Domains 'atwork-it.com', 'delegate365.com' ` -D365Permission 'Portal Admin'` -Settings $settings </code> <para>Additional parameters and settings can be set the new user in one step.</para> </example> </member> <member name="F:Delegate365.Api.Client.NewDAdministratorCmdlet.UserPrincipalName"> <summary> <para type="description">UserPrincipalName is the login name of the new admin and is required.</para> </summary> </member> <member name="F:Delegate365.Api.Client.NewDAdministratorCmdlet.OrganizationalUnits"> <summary> <para type="description">OrganizationalUnits can be a string array, that can be separated by comma, e.g. 'Paris', 'New York'.</para> </summary> </member> <member name="F:Delegate365.Api.Client.NewDAdministratorCmdlet.GroupOrganizationalUnits"> <summary> <para type="description">GroupOrganizationalUnits can be a string array, that can be separated by comma, e.g. 'Seattle', 'Vienna'. To remove OU's, use ''.</para> </summary> </member> <member name="F:Delegate365.Api.Client.NewDAdministratorCmdlet.Domains"> <summary> <para type="description">Domains can be a string array, that can be separated by comma, e.g. 'atwork-it.com', 'delegate365.com'.</para> </summary> </member> <member name="F:Delegate365.Api.Client.NewDAdministratorCmdlet.Settings"> <summary> <para type="description">Settings allow to set the notification email, phone number and other settings for the admin.</para> </summary> </member> <member name="F:Delegate365.Api.Client.NewDAdministratorCmdlet.D365Permission"> <summary> <para type="description">D365Permission define the name of the permission policy that shall be assigned.</para> </summary> </member> <member name="T:Delegate365.Api.Client.NewDLicenseDefaultQuotasCmdlet"> <summary> <para type="synopsis">Creates license quotas for all OU's and licenses in Delegate365. </para> <para type="description">New-DLicenseDefaultQuotas license quotas for all OU's and licenses in Delegate365. Licenses quotas allow to restrict the number of Office 365 licenses that can be consumed by users per OU. This command does not require any parameters and creates new quotas if not existing for each license and OU with a quota of 0. Existing quotas stay untouched. This helps administrators just to modify a quota and not to create it manually. The output shows the created license quota object. </para> <para type="link" uri="https://support.delegate365.com/">Delegate365 support</para> </summary> <example> <code> New-DLicenseDefaultQuotas </code> <para>For filling new license quotas for all OU's and licenses with a quota value of 0. The created quotas and their values should then be modified as needed. </para> </example> </member> <member name="T:Delegate365.Api.Client.NewDLicenseQuotaCmdlet"> <summary> <para type="synopsis">Creates a new license quota in Delegate365. </para> <para type="description">New-DLicenseQuota creates a new license quota in Delegate365. Licenses quotas allow to restrict the number of Office 365 licenses that can be consumed by users per OU. The Quota parameter requires an object representing the desired values to be set, see the example. The output shows the created license quota object. </para> <para type="link" uri="https://support.delegate365.com/">Delegate365 support</para> </summary> <example> <code> $quota = New-Object Delegate365.Api.Core.Models.LicenseQuota $quota.OrganizationalUnit = 'Seattle' $quota.SkuDisplayName = 'SkuDisplayName' $quota.Quota = 10 $quota.Enforce = $true New-DLicenseQuota -Quota $quota </code> <para>For creating a new license quotas, create a new object and assign that to the new quota.</para> </example> </member> <member name="F:Delegate365.Api.Client.NewDLicenseQuotaCmdlet.Quota"> <summary> <para type="description">Quota is the object representing the desired values to be set.</para> </summary> </member> <member name="T:Delegate365.Api.Client.NewDOrganizationalUnitCmdlet"> <summary> <para type="synopsis">Creates a new OU in Delegate365. </para> <para type="description">New-DOrganizationalUnit creates a new OU in Delegate365. Organizational Units (OUs) are used as container to allow delegated management within Delegate365. The output shows the created OU object. Once the OU has been created, it can be used for any assignments. </para> <para type="link" uri="https://support.delegate365.com/">Delegate365 support</para> </summary> <example> <code> New-DOrganizationalUnit -Name 'New York' </code> <para>For creating a new OU, a name is required.</para> </example> </member> <member name="F:Delegate365.Api.Client.NewDOrganizationalUnitCmdlet.Name"> <summary> <para type="description">The name of the new OU is required.</para> </summary> </member> <member name="T:Delegate365.Api.Client.SetDAdministratorCmdlet"> <summary> <para type="synopsis">Updates an existing administrator in Delegate365. This command is available starting with Delegate365 v8.2 </para> <para type="description">Set-DAdministrator modifies an existing administrator in Delegate365. Alias commands are: Set-DAdmin. The administrator that shall be modified must be existing and must be set with the -Identity parameter. This command allows to enable or disable an Administrator, to overwrite his OU and domain settings and to define other admin settings. To remove any existing OU or domain assignments, or the permission policy, use an empty string ''. Otherwise, use a string array to define new OU's or domains, as in the sample below. Optional, additional properties can be handed over to the command, see the example. The output shows the updated admin object. </para> <para type="link" uri="https://support.delegate365.com/">Delegate365 support</para> </summary> <example> <code> Set-DAdministrator -Identity 'john.doe@delegate365.com' -Active $false </code> <para>This disables the administrator from using the Delegate365 portal or using Powershell.</para> </example> <example> <code> Set-DAdministrator -Identity 'john.doe@delegate365.com' -OrganizationalUnits '' </code> <para>Remove all OU assignments from that administrator.</para> </example> <example> <code> Set-DAdministrator -Identity 'john.doe@delegate365.com' -Domains '' </code> <para>Remove all domain assignments from that administrator.</para> </example> <example> <code> Set-DAdministrator -Identity 'john.doe@delegate365.com' -D365Permission '' </code> <para>Remove the existing permission policy from that administrator. That user no longer will see any modules in Delegate365.</para> </example> <example> <code> Set-DAdministrator -Identity 'john.doe@delegate365.com' -OrganizationalUnits 'Paris', 'New York', 'Kuala Lumpur' </code> <para>Overwrite any existing OU assignments with new ones for that administrator.</para> </example> <example> <code> $settings = New-Object Delegate365.Api.Core.Models.AdministratorSettings $settings.Email = 'john.doe@delegate365.com' $settings.Phone = '' $settings.UsageLocation = 'US' $settings.DailyNotifications = $false Set-DAdministrator -Identity john.doe@delegate365.com ` -Active $true -OrganizationalUnits 'Paris', 'New York' ` -GroupOrganizationalUnits 'Seattle', 'Vienna' ` -Domains 'atwork-it.com', 'delegate365.com' ` -D365Permission 'Scope Admin'` -Settings $settings </code> <para>Overwrite all possible settings of that admin.</para> </example> </member> <member name="P:Delegate365.Api.Client.SetDAdministratorCmdlet.Identity"> <summary> <para type="description">Find a specific item. Wildcards are not supported, use the UserPrincipalName.</para> </summary> </member> <member name="P:Delegate365.Api.Client.SetDAdministratorCmdlet.UserPrincipalName"> <summary> <para type="description">The UserPrincipalName can be used instead of the Identity parameter.</para> </summary> </member> <member name="F:Delegate365.Api.Client.SetDAdministratorCmdlet.OrganizationalUnits"> <summary> <para type="description">OrganizationalUnits can be a string array, that can be separated by comma, e.g. 'Paris', 'New York'. To remove OU's, use ''.</para> </summary> </member> <member name="F:Delegate365.Api.Client.SetDAdministratorCmdlet.GroupOrganizationalUnits"> <summary> <para type="description">GroupOrganizationalUnits can be a string array, that can be separated by comma, e.g. 'Seattle', 'Vienna'. To remove OU's, use ''.</para> </summary> </member> <member name="F:Delegate365.Api.Client.SetDAdministratorCmdlet.Domains"> <summary> <para type="description">Domains can be a string array, that can be separated by comma, e.g. 'atwork-it.com', 'delegate365.com'. To remove domains, use ''.</para> </summary> </member> <member name="F:Delegate365.Api.Client.SetDAdministratorCmdlet.Settings"> <summary> <para type="description">Settings allow to set the notification email, phone number and other settings for the admin.</para> </summary> </member> <member name="F:Delegate365.Api.Client.SetDAdministratorCmdlet.D365Permission"> <summary> <para type="description">D365Permission define the name of the permission policy that shall be assigned. To remove an existing permission, use ''.</para> </summary> </member> <member name="F:Delegate365.Api.Client.SetDAdministratorCmdlet.Active"> <summary> <para type="description">Active sets the Administrator active or disabled. Disabled Admins cannot access the Delegate365 portal or use PowerShell.</para> </summary> </member> <member name="T:Delegate365.Api.Client.SetDContactCmdlet"> <summary> <para type="synopsis">Assigns an existing contact to an OU in Delegate365. </para> <para type="description">Set-DContact assigns an existing contact to an OU in Delegate365. An existing OU assignment is overwritten. If the contact is unassigned, he gets assigned. As parameters, the Identity (or the WindowsEmailAddress which is the same address) and the OU name must be provided. The output shows the contact object and an operation status. For a successful operation, the Error property is False and the Message property is empty. </para> <para type="link" uri="https://support.delegate365.com/">Delegate365 support</para> </summary> <example> <code> Set-DContact -Identity bobk@tailspintoys.com -OU Chicago </code> <para>Assign a contact to an OU. The Identity must be provided by email address or by ID.</para> </example> <example> <code> Set-DContact -WindowsEmailAddress bobk@tailspintoys.com -OU Chicago </code> <para>Alternatively, use the WindowsEmailAddress parameter.</para> </example> </member> <member name="P:Delegate365.Api.Client.SetDContactCmdlet.Identity"> <summary> <para type="description">Find a specific item. Wildcards are not supported, use the email address or the ID.</para> </summary> </member> <member name="P:Delegate365.Api.Client.SetDContactCmdlet.WindowsEmailAddress"> <summary> <para type="description">The WindowsEmailAddress can be used instead of the Identity parameter.</para> </summary> </member> <member name="F:Delegate365.Api.Client.SetDContactCmdlet.OU"> <summary> <para type="description">Setting the OU name assigns the contact to that OU.</para> </summary> </member> <member name="T:Delegate365.Api.Client.SetDDistributionGroupCmdlet"> <summary> <para type="synopsis">Assigns an existing distribution group to an OU in Delegate365. </para> <para type="description">Set-DDistributionGroup assigns an existing distribution group to an OU in Delegate365. An existing OU assignment is overwritten. If the distribution group is unassigned, it gets assigned. As parameters, the Identity and the OU name must be provided. The output shows the distribution group object and an operation status. For a successful operation, the Error property is False and the Message property is empty. </para> <para type="link" uri="https://support.delegate365.com/">Delegate365 support</para> </summary> <example> <code> Set-DDistributionGroup -Identity hr-department@delegate365.com -OU Chicago </code> <para>Assign a distribution group to an OU. The Identity must be provided by email address or by ID.</para> </example> <example> <code> Set-DDistributionGroup -PrimarySmtpAddress hr-department@delegate365.com -OU Chicago </code> <para>Alternatively, use the PrimarySmtpAddress parameter.</para> </example> </member> <member name="P:Delegate365.Api.Client.SetDDistributionGroupCmdlet.Identity"> <summary> <para type="description">Find a specific item. Wildcards are not supported, use the email address or the ID.</para> </summary> </member> <member name="P:Delegate365.Api.Client.SetDDistributionGroupCmdlet.PrimarySmtpAddress"> <summary> <para type="description">The PrimarySmtpAddress can be used instead of the Identity parameter.</para> </summary> </member> <member name="F:Delegate365.Api.Client.SetDDistributionGroupCmdlet.OU"> <summary> <para type="description">Setting the OU name assigns the distribution group to that OU.</para> </summary> </member> <member name="T:Delegate365.Api.Client.SetDDynamicGroupCmdlet"> <summary> <para type="synopsis">Assigns an existing distribution group to an OU in Delegate365. </para> <para type="description">Set-DDynamicGroup assigns an existing distribution group to an OU in Delegate365. An existing OU assignment is overwritten. If the distribution group is unassigned, it gets assigned. As parameters, the Identity and the OU name must be provided. The output shows the distribution group object and an operation status. For a successful operation, the Error property is False and the Message property is empty. </para> <para type="link" uri="https://support.delegate365.com/">Delegate365 support</para> </summary> <example> <code> Set-DDynamicGroup -Identity it-department@delegate365.com -OU Chicago </code> <para>Assign a distribution group to an OU. The Identity must be provided by email address or by ID.</para> </example> <example> <code> Set-DDynamicGroup -PrimarySmtpAddress it-department@delegate365.com -OU Chicago </code> <para>Alternatively, use the PrimarySmtpAddress parameter.</para> </example> </member> <member name="P:Delegate365.Api.Client.SetDDynamicGroupCmdlet.Identity"> <summary> <para type="description">Find a specific item. Wildcards are not supported, use the full name or the ID.</para> </summary> </member> <member name="P:Delegate365.Api.Client.SetDDynamicGroupCmdlet.PrimarySmtpAddress"> <summary> <para type="description">The PrimarySmtpAddress can be used instead of the Identity parameter.</para> </summary> </member> <member name="F:Delegate365.Api.Client.SetDDynamicGroupCmdlet.OU"> <summary> <para type="description">Setting the OU name assigns the distribution group to that OU.</para> </summary> </member> <member name="T:Delegate365.Api.Client.SetDOffice365GroupCmdlet"> <summary> <para type="synopsis">Assigns an existing Office 365 group to an OU in Delegate365. </para> <para type="description">Set-DOffice365Group assigns an existing Office 365 group to an OU in Delegate365. An existing OU assignment is overwritten. If the Office 365 group is unassigned, it gets assigned. As parameters, the Identity and the OU name must be provided. The output shows the Office 365 group object and an operation status. For a successful operation, the Error property is False and the Message property is empty. </para> <para type="link" uri="https://support.delegate365.com/">Delegate365 support</para> </summary> <example> <code> Set-DOffice365Group -Identity project-tango@delegate365.com -OU Chicago </code> <para>Assign an Office 365 group to an OU. The Identity must be provided by email address or by ID.</para> </example> <example> <code> Set-DOffice365Group -PrimarySmtpAddress project-tango@delegate365.com -OU Chicago </code> <para>Alternatively, use the PrimarySmtpAddress parameter.</para> </example> </member> <member name="P:Delegate365.Api.Client.SetDOffice365GroupCmdlet.Identity"> <summary> <para type="description">Find a specific item. Wildcards are not supported, use the email address or the ID.</para> </summary> </member> <member name="P:Delegate365.Api.Client.SetDOffice365GroupCmdlet.PrimarySmtpAddress"> <summary> <para type="description">The PrimarySmtpAddress can be used instead of the Identity parameter.</para> </summary> </member> <member name="F:Delegate365.Api.Client.SetDOffice365GroupCmdlet.OU"> <summary> <para type="description">Setting the OU name assigns the Office 365 group to that OU.</para> </summary> </member> <member name="T:Delegate365.Api.Client.SetDResourceCmdlet"> <summary> <para type="synopsis">Assigns an existing resource to an OU in Delegate365. </para> <para type="description">Set-DResource assigns an existing resource to an OU in Delegate365. An existing OU assignment is overwritten. If the resource is unassigned, it gets assigned. As parameters, the Identity and the OU name must be provided. The output shows the resource object and an operation status. For a successful operation, the Error property is False and the Message property is empty. </para> <para type="link" uri="https://support.delegate365.com/">Delegate365 support</para> </summary> <example> <code> Set-DResource -Identity ConfRoomCrystal@delegate365.com -OU Chicago </code> <para>Assign a resource to an OU. The Identity must be provided by email address or by ID.</para> </example> <example> <code> Set-DResource -PrimarySmtpAddress ConfRoomCrystal@delegate365.com -OU Chicago </code> <para>Alternatively, use the PrimarySmtpAddress parameter.</para> </example> </member> <member name="P:Delegate365.Api.Client.SetDResourceCmdlet.Identity"> <summary> <para type="description">Find a specific item. Wildcards are not supported, use the email address or the ID.</para> </summary> </member> <member name="P:Delegate365.Api.Client.SetDResourceCmdlet.PrimarySmtpAddress"> <summary> <para type="description">The PrimarySmtpAddress can be used instead of the Identity parameter.</para> </summary> </member> <member name="F:Delegate365.Api.Client.SetDResourceCmdlet.OU"> <summary> <para type="description">Setting the OU name assigns the resource to that OU.</para> </summary> </member> <member name="T:Delegate365.Api.Client.SetDSecurityGroupCmdlet"> <summary> <para type="synopsis">Assigns an existing security group to an OU in Delegate365. </para> <para type="description">Set-DSecurityGroup assigns an existing security group to an OU in Delegate365. An existing OU assignment is overwritten. If the security group is unassigned, it gets assigned. As parameters, the Identity and the OU name must be provided. The output shows the security group object and an operation status. For a successful operation, the Error property is False and the Message property is empty. </para> <para type="link" uri="https://support.delegate365.com/">Delegate365 support</para> </summary> <example> <code> Set-DSecurityGroup -Identity 'Sales department' -OU Chicago </code> <para>Assign a security group to an OU. The Identity must be provided by email address or by ID.</para> </example> <example> <code> Set-DSecurityGroup -GroupName 'Sales department' -OU Chicago </code> <para>Alternatively, use the GroupName parameter.</para> </example> </member> <member name="P:Delegate365.Api.Client.SetDSecurityGroupCmdlet.Identity"> <summary> <para type="description">Find a specific item. Wildcards are not supported, use the group name or the ID.</para> </summary> </member> <member name="P:Delegate365.Api.Client.SetDSecurityGroupCmdlet.GroupName"> <summary> <para type="description">The GroupName can be used instead of the Identity parameter.</para> </summary> </member> <member name="F:Delegate365.Api.Client.SetDSecurityGroupCmdlet.OU"> <summary> <para type="description">Setting the OU name assigns the security group to that OU.</para> </summary> </member> <member name="T:Delegate365.Api.Client.SetDSharedMailboxCmdlet"> <summary> <para type="synopsis">Assigns an existing shared mailbox to an OU in Delegate365. </para> <para type="description">Set-DSharedMailbox assigns an existing shared mailbox to an OU in Delegate365. An existing OU assignment is overwritten. If the shared mailbox is unassigned, it gets assigned. As parameters, the Identity and the OU name must be provided. The output shows the shared mailbox object and an operation status. For a successful operation, the Error property is False and the Message property is empty. </para> <para type="link" uri="https://support.delegate365.com/">Delegate365 support</para> </summary> <example> <code> Set-DSharedMailbox -Identity support@delegate365.com -OU Chicago </code> <para>Assign a shared mailbox to an OU. The Identity must be provided by email address or by ID.</para> </example> <example> <code> Set-DSharedMailbox -PrimarySmtpAddress support@delegate365.com -OU Chicago </code> <para>Alternatively, use the PrimarySmtpAddress parameter.</para> </example> </member> <member name="P:Delegate365.Api.Client.SetDSharedMailboxCmdlet.Identity"> <summary> <para type="description">Find a specific item. Wildcards are not supported, use the email address or the ID.</para> </summary> </member> <member name="P:Delegate365.Api.Client.SetDSharedMailboxCmdlet.PrimarySmtpAddress"> <summary> <para type="description">The PrimarySmtpAddress can be used instead of the Identity parameter.</para> </summary> </member> <member name="F:Delegate365.Api.Client.SetDSharedMailboxCmdlet.OU"> <summary> <para type="description">Setting the OU name assigns the distribution group to that OU.</para> </summary> </member> <member name="T:Delegate365.Api.Client.SetDUserCmdlet"> <summary> <para type="synopsis">Assigns an existing user to an OU in Delegate365. </para> <para type="description">Set-DUser assigns an existing user to an OU in Delegate365. An existing OU assignment is overwritten. If the user is unassigned, he gets assigned. As parameters, the Identity and the OU name must be provided. The output shows the user object and an operation status. For a successful operation, the Error property is False and the Message property is empty. </para> <para type="link" uri="https://support.delegate365.com/">Delegate365 support</para> </summary> <example> <code> Set-DUser -Identity support@delegate365.com -OU Chicago </code> <para>Assign a user to an OU. The Identity must be provided by UserPrincipalName or by ID.</para> </example> <example> <code> Set-DUser -UserPrincipalName support@delegate365.com -OU Chicago </code> <para>Alternatively, use the UserPrincipalName parameter.</para> </example> </member> <member name="P:Delegate365.Api.Client.SetDUserCmdlet.Identity"> <summary> <para type="description">Find a specific item. Wildcards are not supported, use the UserPrincipalName or the ID.</para> </summary> </member> <member name="P:Delegate365.Api.Client.SetDUserCmdlet.UserPrincipalName"> <summary> <para type="description">The UserPrincipalName can be used instead of the Identity parameter.</para> </summary> </member> <member name="F:Delegate365.Api.Client.SetDUserCmdlet.OU"> <summary> <para type="description">Setting the OU name assigns the user to that OU.</para> </summary> </member> <member name="T:Delegate365.Api.Client.StartDMfaSyncCmdlet"> <summary> <para type="synopsis">Starts the MFA synchronization job in Delegate365. </para> <para type="description">Start-DMfaSync starts the Multi Factor Authentication (MFA) synchronization job in Delegate365. This command does not require any parameters. The job runs through the rules defined in the sync rules and sets the desired MFA status to members of the provided security groups. If nor MFA rules are defined, no MFA operations happen. Usually, this job runs automated in the background perodically during the day. The MFA sync duration will vary on the size of the Office 365 tenant and the MFA sync rules defined in Delegate365. As output, an informational string is returned. If no error occurs, it should respond with "Started successfully" within some seconds. </para> <para type="link" uri="https://support.delegate365.com/">Delegate365 support</para> </summary> <example> <code> Start-DMfaSync </code> <para>Start the MFA sync now.</para> </example> </member> <member name="T:Delegate365.Api.Client.StartDSyncCmdlet"> <summary> <para type="synopsis">Starts the synchronization job in Delegate365. </para> <para type="description">Start-DSync starts the synchronization job in Delegate365. This command does not require any parameters. The job checks the delta between the Office 365 tenant and Delegate365 and updates modified objects in Delegate365. Furthermore, the job runs through the rules defined in the sync rules and performs all defined and active operations. If nor custom sync rules are defined, just the update of Delegate365 happens. Usually, this job runs automated in the background perodically during the day. The sync duration will vary on the size of the Office 365 tenant and the sync rules defined in Delegate365. So, a sync can run for some seconds only or for hours. A manual sync makes only sense, if you modified objects outside of Delegate365 in the Office 365 portal or with another tool and you need to surface the changes in Delegate365 immediately. As output, an informational string is returned. If no error occurs, it should respond with "Started successfully" within some seconds. </para> <para type="link" uri="https://support.delegate365.com/">Delegate365 support</para> </summary> <example> <code> Start-DSync </code> <para>Start the sync now.</para> </example> </member> </members> </doc> |