Microsoft.OrganizationAddInPowerShell.dll-help.xml
|
<?xml version="1.0" encoding="utf-8" ?>
<!--Copyright (c) Microsoft Corporation. All rights reserved.--> <helpItems xmlns="http://msh" schema="maml"> <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"> <command:details> <command:name>Connect-OrganizationAddInService</command:name> <command:verb>Connect</command:verb> <command:noun>OrganizationAddInService</command:noun> <maml:description> <maml:para>Authenticates the user and initializes a new Organization Add-In Service session.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Connect-OrganizationAddInService cmdlet authenticates the user and initializes a new Organization Add-In Service session.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Connect-OrganizationAddInService</maml:name> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <command:parameterValue required="true">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>A PowerShell PSCredential object used to authenticate the user. If the parameter is not specified, a prompt will appear asking the user to sign in.</maml:para> </maml:description> <command:parameterValue>PSCredential</command:parameterValue> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Url</maml:name> <maml:description> <maml:para>Used to specify a custom URL for the Office 365 instance to connect to. In almost all cases this parameter will not be required.</maml:para> </maml:description> <command:parameterValue>Uri</command:parameterValue> <dev:defaultValue>https://portal.office.com</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <maml:description> <maml:para>This cmdlet does not accept any piped input.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para>This cmdlet does not return any output data.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:>Connect-OrganizationAddInService -Credential $UserCredential</dev:code> <dev:remarks> <maml:para>Initializes a new Organization Add-In Service session authenticating using the provided PSCredential object.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:>Connect-OrganizationAddInService</dev:code> <dev:remarks> <maml:para>Prompts the user for credentials and initializes a new Organization Add-In Service session.</maml:para> </dev:remarks> </command:example> </command:examples> </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" > <command:details> <command:name>New-OrganizationAddIn</command:name> <command:verb>New</command:verb> <command:noun>OrganizationAddIn</command:noun> <maml:description> <maml:para>Registers and uploads a new Add-In for the Organization.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-OrganizationAddIn cmdlet is used to register and upload a new Add-In for the Organization. The manifest files uploaded must be of the correct Office Add-In XML format otherwise they will not be uploaded. For more information on the XML manifest format please look here: https://dev.office.com/docs/add-ins/overview/add-in-manifests</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-OrganizationAddIn</maml:name> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ManifestPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Locale</maml:name> <command:parameterValue required="true">string</command:parameterValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Disabled</maml:name> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserDefault</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:defaultValue>OptionalEnabled</dev:defaultValue> <dev:possibleValues> <dev:possibleValue> <dev:value>OptionalEnabled</dev:value> <maml:description> <maml:para>The Add-In will automatically be deployed to the assigned users but they can choose to remove it.</maml:para> </maml:description> </dev:possibleValue> <dev:possibleValue> <dev:value>OptionalDisabled</dev:value> <maml:description> <maml:para>The Add-In will not be automatically deployed to the assigned users but they can choose to install it.</maml:para> </maml:description> </dev:possibleValue> <dev:possibleValue> <dev:value>Mandatory</dev:value> <maml:description> <maml:para>The Add-In will be automatically deployed to the assigned users and they will not be able to remove it.</maml:para> </maml:description> </dev:possibleValue> </dev:possibleValues> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Members</maml:name> <command:parameterValue required="true">List<string></command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-OrganizationAddIn</maml:name> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ManifestPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Locale</maml:name> <command:parameterValue required="true">string</command:parameterValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AssignToEveryone</maml:name> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Disabled</maml:name> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserDefault</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:defaultValue>OptionalEnabled</dev:defaultValue> <dev:possibleValues> <dev:possibleValue> <dev:value>OptionalEnabled</dev:value> <maml:description> <maml:para>The Add-In will automatically be deployed to the assigned users but they can choose to remove it.</maml:para> </maml:description> </dev:possibleValue> <dev:possibleValue> <dev:value>OptionalDisabled</dev:value> <maml:description> <maml:para>The Add-In will not be automatically deployed to the assigned users but they can choose to install it.</maml:para> </maml:description> </dev:possibleValue> <dev:possibleValue> <dev:value>Mandatory</dev:value> <maml:description> <maml:para>The Add-In will be automatically deployed to the assigned users and they will not be able to remove it.</maml:para> </maml:description> </dev:possibleValue> </dev:possibleValues> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-OrganizationAddIn</maml:name> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AssetId</maml:name> <command:parameterValue required="true">string</command:parameterValue> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Locale</maml:name> <command:parameterValue required="true">string</command:parameterValue> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ContentMarket</maml:name> <command:parameterValue required="true">string</command:parameterValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Disabled</maml:name> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserDefault</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:defaultValue>OptionalEnabled</dev:defaultValue> <dev:possibleValues> <dev:possibleValue> <dev:value>OptionalEnabled</dev:value> <maml:description> <maml:para>The Add-In will automatically be deployed to the assigned users but they can choose to remove it.</maml:para> </maml:description> </dev:possibleValue> <dev:possibleValue> <dev:value>OptionalDisabled</dev:value> <maml:description> <maml:para>The Add-In will not be automatically deployed to the assigned users but they can choose to install it.</maml:para> </maml:description> </dev:possibleValue> <dev:possibleValue> <dev:value>Mandatory</dev:value> <maml:description> <maml:para>The Add-In will be automatically deployed to the assigned users and they will not be able to remove it.</maml:para> </maml:description> </dev:possibleValue> </dev:possibleValues> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Members</maml:name> <command:parameterValue required="true">List<string></command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ManifestPath</maml:name> <maml:description> <maml:para>The path to the manifest XML file on your local machine or a network share. For Internet locations, HTTP and HTTPS protocols are supported.</maml:para> </maml:description> <command:parameterValue>string</command:parameterValue> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AssetId</maml:name> <maml:description> <maml:para>The Office store asset id of the add-in that you want to upload.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ContentMarket</maml:name> <maml:description> <maml:para>The content market of the add-in e.g. en-US.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Locale</maml:name> <maml:description> <maml:para>The locale of the tenant e.g. en-US.</maml:para> </maml:description> <command:parameterValue>string</command:parameterValue> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AssignToEveryone</maml:name> <maml:description> <maml:para>If the parameter is present, the new Add-In will be assigned to all users in the Organization.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Disabled</maml:name> <maml:description> <maml:para>If the parameter is present, the state of the new Add-In will be set to 'disabled' making it invisible to users.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserDefault</maml:name> <maml:description> <maml:para>Currently only Outlook Add-Ins are supported for this setting! Sets the default state of the Add-In for the end user of the Add-In. Value can be of OptionalEnabled, OptionalDisabled and Mandatory</maml:para> </maml:description> <dev:defaultValue>OptionalEnabled</dev:defaultValue> <dev:possibleValues> <dev:possibleValue> <dev:value>OptionalEnabled</dev:value> <maml:description> <maml:para>The Add-In will automatically be deployed to the assigned users but they can choose to remove it.</maml:para> </maml:description> </dev:possibleValue> <dev:possibleValue> <dev:value>OptionalDisabled</dev:value> <maml:description> <maml:para>The Add-In will not be automatically deployed to the assigned users but they can choose to install it.</maml:para> </maml:description> </dev:possibleValue> <dev:possibleValue> <dev:value>Mandatory</dev:value> <maml:description> <maml:para>The Add-In will be automatically deployed to the assigned users and they will not be able to remove it.</maml:para> </maml:description> </dev:possibleValue> </dev:possibleValues> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Members</maml:name> <maml:description> <maml:para> A comma separated list of users and/or groups to which you want to deploy the Add-In. Email addresses or object IDs can be used to identify members. If none are specified then the Add-In isn't assigned to any members. For example: 'sales@contoso.com','security@contoso.com','b9fe9de6-6088-4e50-8706-1b270cb1d709' </maml:para> </maml:description> <command:parameterValue>List<string></command:parameterValue> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <maml:description> <maml:para>This cmdlet does not accept any piped input.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.OrganizationAddInPowerShell.Model.AddInDetails</maml:name> <maml:description>Represents an Add-In uploaded for an Organization.</maml:description> </dev:type> <maml:description> <maml:para>Returns the metadata of the newly uploaded Add-In.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:>New-OrganizationAddIn -ManifestPath 'C:\Users\Me\Desktop\taskpane.xml' -Locale 'en-US'</dev:code> <dev:remarks> <maml:para>This is the simplest case where only the path to the Add-In is specified and locale of the tenant are specified. No users or groups are assigned.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:>New-OrganizationAddIn -AssetId 'WA104380602' -Locale 'en-US' -ContentMarket 'en-US'</dev:code> <dev:remarks> <maml:para>This command uploads the specified Add-In from the Office store.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:>New-OrganizationAddIn -ManifestPath 'C:\Users\Me\Desktop\taskpane.xml' -Locale 'en-US' -Members 'ShirleyBrown@contoso.com','SkyeZaher@contoso.com','b9fe9de6-6088-4e50-8706-1b270cb1d709'</dev:code> <dev:remarks> <maml:para>This command uploads the specified Add-In for the Organization and assigns it to the specified users.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:>New-OrganizationAddIn -ManifestPath 'C:\Users\Me\Desktop\taskpane.xml' -Locale 'en-US' -AssignToEveryone</dev:code> <dev:remarks> <maml:para>This command uploads the specified Add-In for the Organization and assigns it to all users.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 5 ----------</maml:title> <dev:code>PS C:>New-OrganizationAddIn -ManifestPath 'C:\Users\Me\Desktop\taskpane.xml' -Locale 'en-US' -AssignToEveryone -UserDefault OptionalDisabled</dev:code> <dev:remarks> <maml:para>This command uploads the specified Add-In for the Organization and assigns it to all users, setting the default state for end users. In this case, the Add-In will not be automatically deployed to the assigned users but they can choose to install it.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 6 ----------</maml:title> <dev:code>PS C:>New-OrganizationAddIn -ManifestPath 'C:\Users\Me\Desktop\taskpane.xml' -Locale 'en-US' -Disabled</dev:code> <dev:remarks> <maml:para>This command uploads the specified Add-In for the Organization and sets it state to 'disabled' making it invisible to users.</maml:para> </dev:remarks> </command:example> </command:examples> </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"> <command:details> <command:name>Get-OrganizationAddIn</command:name> <command:verb>Get</command:verb> <command:noun>OrganizationAddIn</command:noun> <maml:description> <maml:para>Retrieves metadata about Add-Ins uploaded for the Organization.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-OrganizationAddIn cmdlet retrieves metadata about Add-Ins uploaded for the Organization.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-OrganizationAddIn</maml:name> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProductId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>The product ID of the Add-In. If none is specified then all Add-Ins uploaded for the Organization are returned.</maml:para> </maml:description> <command:parameterValue>Guid</command:parameterValue> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <maml:description> <maml:para>This cmdlet does not accept any piped input.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.OrganizationAddInPowerShell.Model.AddInDetails</maml:name> <maml:description>Represents an Add-In uploaded for an Organization.</maml:description> </dev:type> <maml:description> <maml:para>Returns the metadata of Add-Ins uploaded for the Organization.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:>Get-OrganizationAddIn</dev:code> <dev:remarks> <maml:para>Retrieves metadata for all Add-Ins that were uploaded for the Organization.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:>Get-OrganizationAddIn -ProductId 6a75788e-1c6b-4e9b-b5db-5975a2072122</dev:code> <dev:remarks> <maml:para>Retrieves metadata for the specified Add-In.</maml:para> </dev:remarks> </command:example> </command:examples> </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"> <command:details> <command:name>Remove-OrganizationAddIn</command:name> <command:verb>Remove</command:verb> <command:noun>OrganizationAddIn</command:noun> <maml:description> <maml:para>Removes an Add-In previously uploaded for the Organization.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-OrganizationAddIn cmdlet removes an Add-In previously uploaded for the Organization. The Application object in Azure Active Directory will not be removed, but all user and groups assignments will be deleted.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-OrganizationAddIn</maml:name> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ProductId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>The product ID of the Add-In to be removed.</maml:para> </maml:description> <command:parameterValue>Guid</command:parameterValue> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.OrganizationAddInPowerShell.Model.AddInDetails</maml:name> <maml:description>Represents an Add-In uploaded for an Organization.</maml:description> </dev:type> <maml:description> <maml:para>An AddInDetails object representing the removed Add-In.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para>The cmdlet does not return any output data.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title>Objects removed from Azure Active Directory</maml:title> <maml:alert> <maml:para>The cmdlet will not remove the Application object from Azure Active Directory. It will however remove any user or group assignments for these objects.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:>Remove-OrganizationAddIn -ProductId 6a75788e-1c6b-4e9b-b5db-5975a2072122</dev:code> <dev:remarks> <maml:para>Removes the specified Add-In from the Organization.</maml:para> </dev:remarks> </command:example> </command:examples> </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"> <command:details> <command:name>Set-OrganizationAddIn</command:name> <command:verb>Set</command:verb> <command:noun>OrganizationAddIn</command:noun> <maml:description> <maml:para>Updates metadata for an Add-In previously uploaded for the Organization.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-OrganizationAddIn cmdlet allows metadata updates to an Add-In previously uploaded for the Organization.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-OrganizationAddIn</maml:name> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ProductId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Enabled</maml:name> <command:parameterValue required="true">bool</command:parameterValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserDefault</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:defaultValue>none</dev:defaultValue> <dev:possibleValues> <dev:possibleValue> <dev:value>OptionalEnabled</dev:value> <maml:description> <maml:para>The Add-In will automatically be deployed to the assigned users but they can choose to remove it.</maml:para> </maml:description> </dev:possibleValue> <dev:possibleValue> <dev:value>OptionalDisabled</dev:value> <maml:description> <maml:para>The Add-In will not be automatically deployed to the assigned users but they can choose to install it.</maml:para> </maml:description> </dev:possibleValue> <dev:possibleValue> <dev:value>Mandatory</dev:value> <maml:description> <maml:para>The Add-In will be automatically deployed to the assigned users and they will not be able to remove it.</maml:para> </maml:description> </dev:possibleValue> </dev:possibleValues> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ManifestPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Locale</maml:name> <command:parameterValue required="true">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>The product ID of the Add-In to be updated.</maml:para> </maml:description> <command:parameterValue>Guid</command:parameterValue> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Enabled</maml:name> <maml:description> <maml:para>Specify a true or false value to set the current on/off state of the Add-In.</maml:para> </maml:description> <command:parameterValue>bool</command:parameterValue> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserDefault</maml:name> <maml:description> <maml:para>Currently only Outlook Add-Ins are supported for this setting! Sets the default state of the Add-In for the end user of the Add-In. Value can be of OptionalEnabled, OptionalDisabled and Mandatory</maml:para> </maml:description> <command:parameterValue>string</command:parameterValue> <dev:defaultValue>none</dev:defaultValue> <dev:possibleValues> <dev:possibleValue> <dev:value>OptionalEnabled</dev:value> <maml:description> <maml:para>The Add-In will automatically be deployed to the assigned users but they can choose to remove it.</maml:para> </maml:description> </dev:possibleValue> <dev:possibleValue> <dev:value>OptionalDisabled</dev:value> <maml:description> <maml:para>The Add-In will not be automatically deployed to the assigned users but they can choose to install it.</maml:para> </maml:description> </dev:possibleValue> <dev:possibleValue> <dev:value>Mandatory</dev:value> <maml:description> <maml:para>The Add-In will be automatically deployed to the assigned users and they will not be able to remove it.</maml:para> </maml:description> </dev:possibleValue> </dev:possibleValues> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ManifestPath</maml:name> <maml:description> <maml:para>The path to the manifest XML file on your local machine or a network share. This will update the existing manifest file with the new file. The version number in the manifest file must be greater than the previous manifest's version number.</maml:para> </maml:description> <command:parameterValue>string</command:parameterValue> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Locale</maml:name> <maml:description> <maml:para>The locale of the tenant e.g. en-US.</maml:para> </maml:description> <command:parameterValue>string</command:parameterValue> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.OrganizationAddInPowerShell.Model.AddInDetails</maml:name> <maml:description>Represents an Add-In uploaded for an Organization.</maml:description> </dev:type> <maml:description> <maml:para>An AddInDetails object representing the updated Add-In.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.OrganizationAddInPowerShell.Model.AddInDetails</maml:name> <maml:description>Represents an Add-In uploaded for an Organization.</maml:description> </dev:type> <maml:description> <maml:para>Returns the metadata of the updated Add-In.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title>Updating the Add-In Manifest</maml:title> <maml:alert> <maml:para>When a new Manifest XML file is uploaded for an Add-In, the version number of the Add-In should be incremented. The Add-In can never be downgraded to a previous version. Instead it needs to be deleted and uploaded again.</maml:para> <maml:para></maml:para> <maml:para>User and group assignments do not change when the Manifest XML file is updated.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:>Set-OrganizationAddIn -ProductId 6a75788e-1c6b-4e9b-b5db-5975a2072122 -Enabled $false</dev:code> <dev:remarks> <maml:para>Disables the specified Add-In making it invisible to users.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:>Set-OrganizationAddIn -ProductId 6a75788e-1c6b-4e9b-b5db-5975a2072122 -Enabled $true -UserDefault OptionalDisabled</dev:code> <dev:remarks> <maml:para>Enables the specified Add-In making it visible to users, setting the default state for end users. In this case, the Add-In will not be automatically deployed to the assigned users but they can choose to install it.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:>Set-OrganizationAddIn -ProductId 6a75788e-1c6b-4e9b-b5db-5975a2072122 -ManifestPath 'C:\Users\Me\Desktop\taskpane.xml' -Locale 'en-US'</dev:code> <dev:remarks> <maml:para>Updates the Add-In using metadata from a newer Manifest XML file.</maml:para> </dev:remarks> </command:example> </command:examples> </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"> <command:details> <command:name>Set-OrganizationAddInAssignments</command:name> <command:verb>Set</command:verb> <command:noun>OrganizationAddInAssignments</command:noun> <maml:description> <maml:para>Modifies the user and group assignments of an Add-In previously uploaded for the Organization.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-OrganizationAddInAssignments cmdlet modifies the user and group assignments of an Add-In previously uploaded for the Organization.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-OrganizationAddInAssignments</maml:name> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ProductId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Add</maml:name> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Members</maml:name> <command:parameterValue required="true">List<string></command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-OrganizationAddInAssignments</maml:name> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ProductId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Remove</maml:name> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Members</maml:name> <command:parameterValue required="true">List<string></command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-OrganizationAddInAssignments</maml:name> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ProductId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AssignToEveryone</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>The product ID of the Add-In to be updated.</maml:para> </maml:description> <command:parameterValue>Guid</command:parameterValue> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Add</maml:name> <maml:description> <maml:para>If present, the specified users and groups will be added to the list of Organization members to who the Add-In is assigned.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Remove</maml:name> <maml:description> <maml:para>If present, the specified users and groups will be removed from the list of Organization members to who the Add-In is assigned.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AssignToEveryone</maml:name> <maml:description> <maml:para>If present, the specified Add-In will be assigned to all members of the Organization. Assignments to individual Organization members will be removed.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Members</maml:name> <maml:description> <maml:para> A comma separated list of users and/or groups which should be added to or removed from the list of Organization members to who the Add-In is assigned. Email addresses or object IDs can be used to identify members. For example: 'ShirleyBrown@contoso.com','sales@contoso.com','b9fe9de6-6088-4e50-8706-1b270cb1d709' </maml:para> </maml:description> <command:parameterValue required="true">List<string></command:parameterValue> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.OrganizationAddInPowerShell.Model.AddInDetails</maml:name> <maml:description>Represents an Add-In uploaded for an Organization.</maml:description> </dev:type> <maml:description> <maml:para>An AddInDetails object representing the updated Add-In.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.OrganizationAddInPowerShell.Model.AddInDetails</maml:name> <maml:description>Represents an Add-In uploaded for an Organization.</maml:description> </dev:type> <maml:description> <maml:para>Returns the metadata of the updated Add-In.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:>Set-OrganizationAddInAssignments -ProductId 6a75788e-1c6b-4e9b-b5db-5975a2072122 -Add -Members 'ShirleyBrown@contoso.com','sales@contoso.com','b9fe9de6-6088-4e50-8706-1b270cb1d709'</dev:code> <dev:remarks> <maml:para>Adds the specified user and group to the list of Organization members to who the Add-In is assigned.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:>Set-OrganizationAddInAssignments -ProductId 6a75788e-1c6b-4e9b-b5db-5975a2072122 -Remove -Members 'ShirleyBrown@contoso.com','sales@contoso.com','b9fe9de6-6088-4e50-8706-1b270cb1d709'</dev:code> <dev:remarks> <maml:para>Removes the specified user and group from the list of Organization members to who the Add-In is assigned.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:>Set-OrganizationAddInAssignments -ProductId 6a75788e-1c6b-4e9b-b5db-5975a2072122 -AssignToEveryone $true</dev:code> <dev:remarks> <maml:para>Assigns the Add-In to all members of the Organization.</maml:para> </dev:remarks> </command:example> </command:examples> </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"> <command:details> <command:name>Set-OrganizationAddInRefresh</command:name> <command:verb>Set</command:verb> <command:noun>OrganizationAddInRefresh</command:noun> <maml:description> <maml:para>Refreshes platform and consent information about an Add-In previously uploaded for the Organization.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-OrganizationAddInRefresh cmdlet refreshes platform and consent information about an Add-In previously uploaded for the Organization.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-OrganizationAddInRefresh</maml:name> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ProductId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Locale</maml:name> <command:parameterValue required="true">string</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>The product ID of the Add-In to be refreshed.</maml:para> </maml:description> <command:parameterValue>Guid</command:parameterValue> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Locale</maml:name> <maml:description> <maml:para>The locale of the tenant e.g. en-US.</maml:para> </maml:description> <command:parameterValue>string</command:parameterValue> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:>Set-OrganizationAddInRefresh -ProductId 6a75788e-1c6b-4e9b-b5db-5975a2072122</dev:code> <dev:remarks> <maml:para>Refreshes the Organization Add-In infromation.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!--Add-in overrides--> <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"> <command:details> <command:name>Get-OrganizationAddInOverrides</command:name> <command:verb>Get</command:verb> <command:noun>OrganizationAddInOverrides</command:noun> <maml:description> <maml:para>Retrieves add-in(s) overrides for the organization.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-OrganizationAddInOverrides cmdlet retrieves add-in(s) overrides for the organization.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-OrganizationAddInOverrides</maml:name> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProductId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>The product ID of the add-in. If none is specified then all add-ins overrides for the Organization are returned.</maml:para> </maml:description> <command:parameterValue>Guid</command:parameterValue> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <maml:description> <maml:para>This cmdlet does not accept any piped input.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.OrganizationAddInPowerShell.Model.AddInOverridesModel</maml:name> <maml:description>Represents add-in overrides uploaded for the organization.</maml:description> </dev:type> <maml:description> <maml:para>Returns add-in overrides uploaded for the organization.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:>Get-OrganizationAddInOverrides</dev:code> <dev:remarks> <maml:para>Retrieves overrides for all the add-ins uploaded for the organization.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:>Get-OrganizationAddInOverrides -ProductId 6a75788e-1c6b-4e9b-b5db-5975a2072122</dev:code> <dev:remarks> <maml:para>Retrieves overrides for the specified add-In.</maml:para> </dev:remarks> </command:example> </command:examples> </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"> <command:details> <command:name>Set-OrganizationAddInOverrides</command:name> <command:verb>Set</command:verb> <command:noun>OrganizationAddInOverrides</command:noun> <maml:description> <maml:para>Sets add-in overrides for the organization.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-OrganizationAddInOverrides cmdlet applies add-in overrides for the organization.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-OrganizationAddInOverrides</maml:name> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProductId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisplayName</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IconUrl</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SupportUrl</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceLocation</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Hosts</maml:name> <command:parameterValue required="true">List<string></command:parameterValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AppDomains</maml:name> <command:parameterValue required="true">List<string></command:parameterValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Resources</maml:name> <command:parameterValue required="false">Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>The product ID of the add-in.</maml:para> </maml:description> <command:parameterValue>Guid</command:parameterValue> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>The display name.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IconUrl</maml:name> <maml:description> <maml:para>The IconUrl (should be a valid URI).</maml:para> </maml:description> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SupportUrl</maml:name> <maml:description> <maml:para>The SupportUrl (should be a valid URI).</maml:para> </maml:description> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceLocation</maml:name> <maml:description> <maml:para>The SourceLocation (should be a valid URI).</maml:para> </maml:description> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Hosts</maml:name> <maml:description> <maml:para>The list of Hosts.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AppDomains</maml:name> <maml:description> <maml:para>The list of AppDomains.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Resources</maml:name> <maml:description> <maml:para>The list of Resources.</maml:para> </maml:description> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <maml:description> <maml:para>This cmdlet does not accept any piped input.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.OrganizationAddInPowerShell.Model.AddInOverridesModel</maml:name> <maml:description>Represents add-in overrides uploaded for the organization.</maml:description> </dev:type> <maml:description> <maml:para>Returns add-in overrides uploaded for the organization.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:>Set-OrganizationAddInOverrides -ProductId 6a75788e-1c6b-4e9b-b5db-5975a2072122 -DisplayName "Custom Add-In name" -Hosts "host1;host2" -IconUrl "http://images.com/rwe344.jpg"</dev:code> <dev:remarks> <maml:para>Applies overrides for the add-ins uploaded for the organization.</maml:para> </dev:remarks> </command:example> </command:examples> </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"> <command:details> <command:name>Remove-OrganizationAddInOverrides</command:name> <command:verb>Remove</command:verb> <command:noun>OrganizationAddInOverrides</command:noun> <maml:description> <maml:para>Removes add-in overrides for the organization.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-OrganizationAddInOverrides cmdlet applies add-in overrides for the organization.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-OrganizationAddInOverrides</maml:name> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProductId</maml:name> <command:parameterValue required="true">Guid</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>The product ID of the add-in.</maml:para> </maml:description> <command:parameterValue>Guid</command:parameterValue> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <maml:description> <maml:para>This cmdlet does not accept any piped input.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <maml:description> <maml:para>The cmdlet does not return any output data.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:>Remove-OrganizationAddInOverrides -ProductId 6a75788e-1c6b-4e9b-b5db-5975a2072122</dev:code> <dev:remarks> <maml:para>Removes all overrides for the add-ins uploaded for the organization.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> </helpItems> |