Provance.Dyn365.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: Get-ProvDyn365Entity --> <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-ProvDyn365Entity</command:name> <command:verb>Get</command:verb> <command:noun>ProvDyn365Entity</command:noun> <maml:description> <maml:para>Get an entity from a Dynamics365/Provance ITSM instance via the Web-API.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet connects to a Dynamics365/ProvanceITSM instance and reads entities based on ID, alternate Key or on a filter criteria</maml:para> <maml:para>It supports 3 different Parametersets.</maml:para> <maml:para>1.) "Entity by Filter" This parameter set allows you to filter entities by a specific field and its content. To use this parameterset you need two parameters: -EntityName and -FilterSelection</maml:para> <maml:para>2.) "Entity by ID" Each Dynamics365/ProvanceITSM entity has a unique identifier, created by Dynamics365. When you know this ID, you can get the entity by this GUID. Parameters used are: -EntityName and -ID Hint: To get the ID, either use Get-ProvDyn365Entity with the -FilterSelect Parameterset, or record it during creation with New-ProvDyn365Entity</maml:para> <maml:para>3.) "Entity by Alternate Key" Entities in Dynamics 365 have the GUID as their primary Key. By customizations, you can define an alternate Key. To figure out if your entity has an alternate key open your Dynamics 365 instance in a browser and go to: Settings ==> Customizations ==> Customize the System ==> Entities ==> Select your entity ==> Keys If you find one or more entities in this list, you can use them as an alternate key. Parameters used are: -entityName and -alternateKey</maml:para> <maml:para>The cmdlet generates a key/value pair list of the data coming from the Dynamics365 WebAPI. By default, the Web-API sends a maximum of 5000 objects and all fields of an entity, which can be limited with the -TopSelection Parameter</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Entity By Alternate Key --> <command:syntaxItem> <maml:name>Get-ProvDyn365Entity</maml:name> <!-- Parameter: AlternateKey --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AlternateKey</maml:name> <maml:description> <maml:para>The Alternate Key of the entity in Dynamics365/ProvanceITSM.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>The Authentication context generated by Get-ProvAzureAuthContext</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EntityName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>EntityName</maml:name> <maml:description> <maml:para>The logical name of the entity in Dynamics365/ProvanceITSM. This value is case sensitive !</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: APIVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>APIVersion</maml:name> <maml:description> <maml:para>The Web-API Version used to query. Default is 'v9.0'".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IncludeFormattedValue --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeFormattedValue</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: SelectSection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SelectSection</maml:name> <maml:description> <maml:para>The output filter for the entities, defined by a field name array, i.e. "name,address1". (PS: the id of the entity will always be returned) When you select more than one value put the values inside quotes and seperate them by commas.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TopSection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TopSection</maml:name> <maml:description> <maml:para>The output can be limited to a maximum amount". use this parameter, when you expect a large amount of objects and want to limit them to a specific number.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Entity By Id --> <command:syntaxItem> <maml:name>Get-ProvDyn365Entity</maml:name> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>The Authentication context generated by Get-ProvAzureAuthContext</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EntityName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>EntityName</maml:name> <maml:description> <maml:para>The logical name of the entity in Dynamics365/ProvanceITSM. This value is case sensitive !</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The GUID(id) of the entity generated by Dynamics365/ProvanceITSM.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: APIVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>APIVersion</maml:name> <maml:description> <maml:para>The Web-API Version used to query. Default is 'v9.0'".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IncludeFormattedValue --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeFormattedValue</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: SelectSection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SelectSection</maml:name> <maml:description> <maml:para>The output filter for the entities, defined by a field name array, i.e. "name,address1". (PS: the id of the entity will always be returned) When you select more than one value put the values inside quotes and seperate them by commas.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TopSection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TopSection</maml:name> <maml:description> <maml:para>The output can be limited to a maximum amount". use this parameter, when you expect a large amount of objects and want to limit them to a specific number.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Entity By Filter --> <command:syntaxItem> <maml:name>Get-ProvDyn365Entity</maml:name> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>The Authentication context generated by Get-ProvAzureAuthContext</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: APIVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>APIVersion</maml:name> <maml:description> <maml:para>The Web-API Version used to query. Default is 'v9.0'".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EntityName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EntityName</maml:name> <maml:description> <maml:para>The logical name of the entity in Dynamics365/ProvanceITSM. This value is case sensitive !</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FilterSection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FilterSection</maml:name> <maml:description> <maml:para>The input filter for the selection, i.e. "contains(name,'Contoso')". Other examples for a filter is: "startswith(apitil_name,'Apple')" You can also combine filters with logical arguments like this example: "startswith(apitil_name,'Apple') and contains(apitil_description,'service')" use https://docs.microsoft.com/en-us/dynamics365/customer-engagement/developer/webapi/query-data-web-api?view=dynamics-ce-odata-9 for examples how to use the filter</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IncludeFormattedValue --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeFormattedValue</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: SelectSection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SelectSection</maml:name> <maml:description> <maml:para>The output filter for the entities, defined by a field name array, i.e. "name,address1". (PS: the id of the entity will always be returned) When you select more than one value put the values inside quotes and seperate them by commas.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TopSection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TopSection</maml:name> <maml:description> <maml:para>The output can be limited to a maximum amount". use this parameter, when you expect a large amount of objects and want to limit them to a specific number.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>The Authentication context generated by Get-ProvAzureAuthContext</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EntityName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>EntityName</maml:name> <maml:description> <maml:para>The logical name of the entity in Dynamics365/ProvanceITSM. This value is case sensitive !</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The GUID(id) of the entity generated by Dynamics365/ProvanceITSM.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: AlternateKey --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AlternateKey</maml:name> <maml:description> <maml:para>The Alternate Key of the entity in Dynamics365/ProvanceITSM.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SelectSection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SelectSection</maml:name> <maml:description> <maml:para>The output filter for the entities, defined by a field name array, i.e. "name,address1". (PS: the id of the entity will always be returned) When you select more than one value put the values inside quotes and seperate them by commas.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FilterSection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FilterSection</maml:name> <maml:description> <maml:para>The input filter for the selection, i.e. "contains(name,'Contoso')". Other examples for a filter is: "startswith(apitil_name,'Apple')" You can also combine filters with logical arguments like this example: "startswith(apitil_name,'Apple') and contains(apitil_description,'service')" use https://docs.microsoft.com/en-us/dynamics365/customer-engagement/developer/webapi/query-data-web-api?view=dynamics-ce-odata-9 for examples how to use the filter</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TopSection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TopSection</maml:name> <maml:description> <maml:para>The output can be limited to a maximum amount". use this parameter, when you expect a large amount of objects and want to limit them to a specific number.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IncludeFormattedValue --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeFormattedValue</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: APIVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>APIVersion</maml:name> <maml:description> <maml:para>The Web-API Version used to query. Default is 'v9.0'".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Hashtable --> <command:returnValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get entities by a filter and show the name and id Get-ProvDyn365Entity -AuthContext $token -EntityName 'account' -FilterSection "contains(name,'Fabrikam')" -SelectSection 'name' Parameterset used is "Entity by Filter", and we look for the entity type "accounts" in the entity 'accounts', ther is a field called 'name'. Our filter criteria looks for all entities where the name contains the word 'Fabrikam'. As the cmdlet would show all fields, we limit the output to 'name' with the -SelectSection parameter. When you test this, the cmdlet will also output the id, which is a default setting and cannot be changed. The $token object is generated by the cmdlet Provance.AzureAuthcontext which can be found in the Provance.Azure Module.</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Get entities by id and show all fields Get-ProvDyn365Entity -AuthContext $token -EntityName 'account' -id '2a01fcb8-d877-42fd-b700-b3da13d8f472' Parameterset used is "Entity by id", and we look for the entity type accounts where the entity GUID (id) has the value of the above example. The $token object is generated by the cmdlet Provance.AzureAuthcontext which can be found in the Provance.Azure Module.</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>Get entities by alternate Key and show some Get-ProvDyn365Entity -AuthContext $token -Entity 'apitil_coudtenant' -alternateKey '2a01fcb8-d877-42fd-b700-b3da13d8f472' -SelectSection 'apitil_name,statuscode' Parameterset used is "Entity by Alternateid", and we look for an entity of type "apitil_cloudtenant" where the alternate key of the entity has the value of the above example. To reduce the number of output field, we limit the fields to "apitil_name" and "statecode" with the select parameter The $token object is generated by the cmdlet Provance.AzureAuthcontext which can be found in the Provance.Azure Module.</dev:code> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Provance Technologies Inc.</maml:linkText> <maml:uri>(http://provance.com)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Help</maml:linkText> <maml:uri>(http://help.provance.com)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-ProvDyn365Entity --> <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-ProvDyn365Entity</command:name> <command:verb>New</command:verb> <command:noun>ProvDyn365Entity</command:noun> <maml:description> <maml:para>Create a new entity in Dynamics365/ProvanceITSM.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet creates a new entity in a Dynamics365/ProvanceITSM instance via the WEB API with defined values</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-ProvDyn365Entity</maml:name> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>The Authentication context generated by Get-ProvAzureAuthContext</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Body --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Body</maml:name> <maml:description> <maml:para>A hasttable or properties for the new entity. Refer to the entities metadata, to figure out possible properties and values.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EntityName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>EntityName</maml:name> <maml:description> <maml:para>The logical name of the entity in Dynamics365/ProvanceITSM. This value is case sensitive !</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: APIVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>APIVersion</maml:name> <maml:description> <maml:para>The Web-API Version used to query. Default is 'v9.0'".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IncludeFormattedValue --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeFormattedValue</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: SelectSection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SelectSection</maml:name> <maml:description> <maml:para>The output filter for the entities, defined by a field name array, i.e. "name,address1". (PS: the id of the entity will always be returned) When you select more than one value put the values inside quotes and seperate them by commas.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>The Authentication context generated by Get-ProvAzureAuthContext</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EntityName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>EntityName</maml:name> <maml:description> <maml:para>The logical name of the entity in Dynamics365/ProvanceITSM. This value is case sensitive !</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Body --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Body</maml:name> <maml:description> <maml:para>A hasttable or properties for the new entity. Refer to the entities metadata, to figure out possible properties and values.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SelectSection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SelectSection</maml:name> <maml:description> <maml:para>The output filter for the entities, defined by a field name array, i.e. "name,address1". (PS: the id of the entity will always be returned) When you select more than one value put the values inside quotes and seperate them by commas.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IncludeFormattedValue --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeFormattedValue</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: APIVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>APIVersion</maml:name> <maml:description> <maml:para>The Web-API Version used to query. Default is 'v9.0'".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Hashtable --> <command:returnValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code> Create a new Account New-ProvDyn365Entity -AuthContext $token -EntityName account -Body $bodyAcc -selectSection "name, description" The "body" object is a hashtable, providing the values for the new account. Creation of the body hastable works like the example below: $bodyAcc = @{ "name" = "Provance" "creditonhold" = $false "description" = "This is the description of the Provance account" "accountcategorycode" = 1 } The -Selectsection parameter defines, which values are returned after successful creation of the entity. By default, the cmdlet returns all values. The example above limits the output to description and name. The id of the entity is always returned. The $token object is generated by the cmdlet Provance.AzureAuthcontext which can be found in the Provance.Azure Module.</dev:code> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Provance Technologies Inc.</maml:linkText> <maml:uri>(http://provance.com)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Help</maml:linkText> <maml:uri>(http://help.provance.com)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-ProvDyn365Entity --> <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-ProvDyn365Entity</command:name> <command:verb>Remove</command:verb> <command:noun>ProvDyn365Entity</command:noun> <maml:description> <maml:para>Delete an entity from Dynamics365/ProvanceITSM.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet deletes aentity in a Dynamics365/ProvanceITSM instance via the WEB API forever!</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Remove By Id --> <command:syntaxItem> <maml:name>Remove-ProvDyn365Entity</maml:name> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>The Authentication context generated by Get-ProvAzureAuthContext</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EntityName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>EntityName</maml:name> <maml:description> <maml:para>The logical name of the entity in Dynamics365/ProvanceITSM. This value is case sensitive !</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The GUID(id) of the entity generated by Dynamics365/ProvanceITSM.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: APIVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>APIVersion</maml:name> <maml:description> <maml:para>The Web-API Version used to query. Default is 'v9.0'".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Remove By Alternate Key --> <command:syntaxItem> <maml:name>Remove-ProvDyn365Entity</maml:name> <!-- Parameter: AlternateKey --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AlternateKey</maml:name> <maml:description> <maml:para>The Alternate Key of the entity in Dynamics365/ProvanceITSM.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>The Authentication context generated by Get-ProvAzureAuthContext</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EntityName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>EntityName</maml:name> <maml:description> <maml:para>The logical name of the entity in Dynamics365/ProvanceITSM. This value is case sensitive !</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: APIVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>APIVersion</maml:name> <maml:description> <maml:para>The Web-API Version used to query. Default is 'v9.0'".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>The Authentication context generated by Get-ProvAzureAuthContext</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EntityName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>EntityName</maml:name> <maml:description> <maml:para>The logical name of the entity in Dynamics365/ProvanceITSM. This value is case sensitive !</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The GUID(id) of the entity generated by Dynamics365/ProvanceITSM.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AlternateKey --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AlternateKey</maml:name> <maml:description> <maml:para>The Alternate Key of the entity in Dynamics365/ProvanceITSM.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: APIVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>APIVersion</maml:name> <maml:description> <maml:para>The Web-API Version used to query. Default is 'v9.0'".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: String --> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code> Remove a contact Remove-ProvDyn365Entity -AuthContext $token -EntityName contact -Id $rc.contactid ParameterSet name used is "Remove By Id" The -Id Parameter requires the unique id of the contact which can be found by using the below example. $rc = Get-ProvDyn365Entity -AuthContext $token -EntityName contact -FilterSection "contains(fullname,'max')" -SelectSection fullname The $token object is generated by the cmdlet Provance.AzureAuthcontext which can be found in the Provance.Azure Module.</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code> Remove a Provance ITSM cloud tenant entity by alternate key Remove-ProvDyn365Entity -AuthContext $token -EntityName apitil_cloudtenant -AlternateKey '3b73821b-c07e-4c26-9b0a-2aea92fd4100' ParameterSet name used is "Remove By Alternate Key", and we look for an entity of type "apitil_cloudtenant" where the alternate key of the entity has the value of the above example. The $token object is generated by the cmdlet Provance.AzureAuthcontext which can be found in the Provance.Azure Module.</dev:code> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Provance Technologies Inc.</maml:linkText> <maml:uri>(http://provance.com)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Help</maml:linkText> <maml:uri>(http://help.provance.com)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-ProvDyn365Entity --> <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-ProvDyn365Entity</command:name> <command:verb>Set</command:verb> <command:noun>ProvDyn365Entity</command:noun> </command:details> <command:syntax> <!-- Parameter set: Update By Id --> <command:syntaxItem> <maml:name>Set-ProvDyn365Entity</maml:name> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>The Authentication context generated by Get-ProvAzureAuthContext</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Body --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Body</maml:name> <maml:description> <maml:para>A hashtable of key/value pairs to define the properties fritten to field. See examples on how to generate those.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EntityName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>EntityName</maml:name> <maml:description> <maml:para>The logical name of the entity in Dynamics365/ProvanceITSM. This value is case sensitive !</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The GUID(id) of the entity generated by Dynamics365/ProvanceITSM.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: APIVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>APIVersion</maml:name> <maml:description> <maml:para>The Web-API Version used to query. Default is 'v9.0'".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IncludeFormattedValue --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeFormattedValue</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PreventUpdate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PreventUpdate</maml:name> <maml:description> <maml:para>A switch parameter to prevent the cmdlet to update an existing entity.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: SelectSection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SelectSection</maml:name> <maml:description> <maml:para>The output filter for the entities, defined by a field name array, i.e. "name,address1". (PS: the id of the entity will always be returned) When you select more than one value put the values inside quotes and seperate them by commas.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Update By Alternate Key --> <command:syntaxItem> <maml:name>Set-ProvDyn365Entity</maml:name> <!-- Parameter: AlternateKey --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AlternateKey</maml:name> <maml:description> <maml:para>The Alternate Key of the entity in Dynamics365/ProvanceITSM.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>The Authentication context generated by Get-ProvAzureAuthContext</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Body --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Body</maml:name> <maml:description> <maml:para>A hashtable of key/value pairs to define the properties fritten to field. See examples on how to generate those.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EntityName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>EntityName</maml:name> <maml:description> <maml:para>The logical name of the entity in Dynamics365/ProvanceITSM. This value is case sensitive !</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: APIVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>APIVersion</maml:name> <maml:description> <maml:para>The Web-API Version used to query. Default is 'v9.0'".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IncludeFormattedValue --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeFormattedValue</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PreventUpdate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PreventUpdate</maml:name> <maml:description> <maml:para>A switch parameter to prevent the cmdlet to update an existing entity.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: SelectSection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SelectSection</maml:name> <maml:description> <maml:para>The output filter for the entities, defined by a field name array, i.e. "name,address1". (PS: the id of the entity will always be returned) When you select more than one value put the values inside quotes and seperate them by commas.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>The Authentication context generated by Get-ProvAzureAuthContext</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EntityName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>EntityName</maml:name> <maml:description> <maml:para>The logical name of the entity in Dynamics365/ProvanceITSM. This value is case sensitive !</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The GUID(id) of the entity generated by Dynamics365/ProvanceITSM.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: AlternateKey --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AlternateKey</maml:name> <maml:description> <maml:para>The Alternate Key of the entity in Dynamics365/ProvanceITSM.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Body --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Body</maml:name> <maml:description> <maml:para>A hashtable of key/value pairs to define the properties fritten to field. See examples on how to generate those.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SelectSection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SelectSection</maml:name> <maml:description> <maml:para>The output filter for the entities, defined by a field name array, i.e. "name,address1". (PS: the id of the entity will always be returned) When you select more than one value put the values inside quotes and seperate them by commas.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IncludeFormattedValue --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeFormattedValue</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: PreventUpdate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PreventUpdate</maml:name> <maml:description> <maml:para>A switch parameter to prevent the cmdlet to update an existing entity.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: APIVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>APIVersion</maml:name> <maml:description> <maml:para>The Web-API Version used to query. Default is 'v9.0'".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Guid --> <command:returnValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Update-ProvDyn365Entity --> <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>Update-ProvDyn365Entity</command:name> <command:verb>Update</command:verb> <command:noun>ProvDyn365Entity</command:noun> <maml:description> <maml:para>Update an entity from a Dynamics365/Provance ITSM instance via the Web-API.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet connects to a Dynamics365/ProvanceITSM instance and sets new values on an entitiy.</maml:para> <maml:para>It supports 2 Parametersets.</maml:para> <maml:para>2.) "Entity by ID"</maml:para> <maml:para>3.) "Entity by Alternate Key"</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Update By Id --> <command:syntaxItem> <maml:name>Update-ProvDyn365Entity</maml:name> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>The Authentication context generated by Get-ProvAzureAuthContext</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Body --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Body</maml:name> <maml:description> <maml:para>A hashtable of key/value pairs to define the properties fritten to field. See examples on how to generate those.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EntityName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>EntityName</maml:name> <maml:description> <maml:para>The logical name of the entity in Dynamics365/ProvanceITSM. This value is case sensitive !</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The GUID(id) of the entity generated by Dynamics365/ProvanceITSM.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: APIVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>APIVersion</maml:name> <maml:description> <maml:para>The Web-API Version used to query. Default is 'v9.0'".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IncludeFormattedValue --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeFormattedValue</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: SelectSection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SelectSection</maml:name> <maml:description> <maml:para>The output filter for the entities, defined by a field name array, i.e. "name,address1". (PS: the id of the entity will always be returned) When you select more than one value put the values inside quotes and seperate them by commas.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Update By Alternate Key --> <command:syntaxItem> <maml:name>Update-ProvDyn365Entity</maml:name> <!-- Parameter: AlternateKey --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AlternateKey</maml:name> <maml:description> <maml:para>The Alternate Key of the entity in Dynamics365/ProvanceITSM.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>The Authentication context generated by Get-ProvAzureAuthContext</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Body --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Body</maml:name> <maml:description> <maml:para>A hashtable of key/value pairs to define the properties fritten to field. See examples on how to generate those.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EntityName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>EntityName</maml:name> <maml:description> <maml:para>The logical name of the entity in Dynamics365/ProvanceITSM. This value is case sensitive !</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: APIVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>APIVersion</maml:name> <maml:description> <maml:para>The Web-API Version used to query. Default is 'v9.0'".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IncludeFormattedValue --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeFormattedValue</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: SelectSection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SelectSection</maml:name> <maml:description> <maml:para>The output filter for the entities, defined by a field name array, i.e. "name,address1". (PS: the id of the entity will always be returned) When you select more than one value put the values inside quotes and seperate them by commas.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>The Authentication context generated by Get-ProvAzureAuthContext</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EntityName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>EntityName</maml:name> <maml:description> <maml:para>The logical name of the entity in Dynamics365/ProvanceITSM. This value is case sensitive !</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The GUID(id) of the entity generated by Dynamics365/ProvanceITSM.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: AlternateKey --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AlternateKey</maml:name> <maml:description> <maml:para>The Alternate Key of the entity in Dynamics365/ProvanceITSM.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Body --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Body</maml:name> <maml:description> <maml:para>A hashtable of key/value pairs to define the properties fritten to field. See examples on how to generate those.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SelectSection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SelectSection</maml:name> <maml:description> <maml:para>The output filter for the entities, defined by a field name array, i.e. "name,address1". (PS: the id of the entity will always be returned) When you select more than one value put the values inside quotes and seperate them by commas.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IncludeFormattedValue --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeFormattedValue</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: APIVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>APIVersion</maml:name> <maml:description> <maml:para>The Web-API Version used to query. Default is 'v9.0'".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Hashtable --> <command:returnValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Set an entity with the logical name "apitil_configurationitem" with a new description Update-ProvDyn365Entity -AuthContext $token -EntityName 'apitil_configurationitem' -id '81df8c29-d4b6-4c3f-8f7b-0e6bbabd0d78' -body $ciBody Parameterset used is "Update by id", and we look for the entity with the logical name "apitil_configurationitem" The $cibody variable is a hashtable, containing the key/value pair of the field which shall be udpated. Example of $cibody: $cibody = @{ "apitil_description"= "Laptop Lenovo T440s with SerialNumber ABC0815" } The -id is the GUID in Dynamics365/ProvanceITSM. When you test this, the cmdlet will also output the id, which is a default setting and cannot be changed. The $token object is generated by the cmdlet Provance.AzureAuthcontext which can be found in the Provance.Azure Module.</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Update an entity found by an alternate key. Update-ProvDyn365Entity -AuthContext $token -Entity 'apitil_configurationitem' -alternateKey '2a01fcb8-d877-42fd-b700-b3da13d8f472' -body $cibody Parameterset used is "Update by Alternate Key", and we look for an entity of type "apitil_configurationitem" where the alternate key of the entity has the value of the above example. The $cibody variable is a hashtable, containing the key/value pair of the field which shall be udpated. Example of $cibody: $cibody = @{ "apitil_description"= "Laptop Lenovo T440s with SerialNumber ABC0815" } The $token object is generated by the cmdlet Provance.AzureAuthcontext which can be found in the Provance.Azure Module.</dev:code> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Provance Technologies Inc.</maml:linkText> <maml:uri>(http://provance.com)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Help</maml:linkText> <maml:uri>(http://help.provance.com)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-ProvDyn365EntityAssociation --> <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-ProvDyn365EntityAssociation</command:name> <command:verb>New</command:verb> <command:noun>ProvDyn365EntityAssociation</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-ProvDyn365EntityAssociation</maml:name> <!-- Parameter: RelationshipName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>RelationshipName</maml:name> <maml:description> <maml:para>The logical name of the relationship between the primary and the related entity. Use Dynamics 365 Customization page to find possible relationships.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PrimaryEntityName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>PrimaryEntityName</maml:name> <maml:description> <maml:para>The logical name of the primary (source) entity in Dynamics365/ProvanceITSM you want to build the relationship with. This value is case sensitive !</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PrimaryEntityId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>PrimaryEntityId</maml:name> <maml:description> <maml:para>The id of the primary (source) entity in Dynamics365/ProvanceITSM you want to build the relationship with.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: RelatedEntityName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="4"> <maml:name>RelatedEntityName</maml:name> <maml:description> <maml:para>The logical name of the related (target) entity in Dynamics365/ProvanceITSM you want to build the relationship with. This value is case sensitive !</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RelatedEntityId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="5"> <maml:name>RelatedEntityId</maml:name> <maml:description> <maml:para>The id of the related (target) entity in Dynamics365/ProvanceITSM you want to build the relationship with.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>The Authentication context generated by Get-ProvAzureAuthContext</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: APIVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>APIVersion</maml:name> <maml:description> <maml:para>The Web-API Version used to query. Default is 'v9.0'".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>The Authentication context generated by Get-ProvAzureAuthContext</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RelationshipName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>RelationshipName</maml:name> <maml:description> <maml:para>The logical name of the relationship between the primary and the related entity. Use Dynamics 365 Customization page to find possible relationships.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PrimaryEntityName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>PrimaryEntityName</maml:name> <maml:description> <maml:para>The logical name of the primary (source) entity in Dynamics365/ProvanceITSM you want to build the relationship with. This value is case sensitive !</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PrimaryEntityId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>PrimaryEntityId</maml:name> <maml:description> <maml:para>The id of the primary (source) entity in Dynamics365/ProvanceITSM you want to build the relationship with.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: RelatedEntityName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="4"> <maml:name>RelatedEntityName</maml:name> <maml:description> <maml:para>The logical name of the related (target) entity in Dynamics365/ProvanceITSM you want to build the relationship with. This value is case sensitive !</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RelatedEntityId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="5"> <maml:name>RelatedEntityId</maml:name> <maml:description> <maml:para>The id of the related (target) entity in Dynamics365/ProvanceITSM you want to build the relationship with.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: APIVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>APIVersion</maml:name> <maml:description> <maml:para>The Web-API Version used to query. Default is 'v9.0'".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: Remove-ProvDyn365EntityAssociation --> <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-ProvDyn365EntityAssociation</command:name> <command:verb>Remove</command:verb> <command:noun>ProvDyn365EntityAssociation</command:noun> <maml:description> <maml:para>Deletes a relationship between two entityies in Dynamics365/ProvanceITSM.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet removes a relationship in a Dynamics365/ProvanceITSM instance via the WEB API. Primary and related entity name, primary entity id and the relationshipname are required</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Collection-valued navigation property --> <command:syntaxItem> <maml:name>Remove-ProvDyn365EntityAssociation</maml:name> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>The Authentication context generated by Get-ProvAzureAuthContext</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PrimaryEntityId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>PrimaryEntityId</maml:name> <maml:description> <maml:para>The id of the primary (source) entity in Dynamics365/ProvanceITSM you want to remove the relationship from.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: PrimaryEntityName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>PrimaryEntityName</maml:name> <maml:description> <maml:para>The logical name of the primary (source) entity in Dynamics365/ProvanceITSM you want to remove the relationship from. This value is case sensitive !</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RelatedEntityId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RelatedEntityId</maml:name> <maml:description> <maml:para>The id of the related (target) entity in Dynamics365/ProvanceITSM you want to remove the relationship from.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: RelationshipName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RelationshipName</maml:name> <maml:description> <maml:para>The logical name of the relationship between the primary and the related entity. Use Dynamics 365 Customization page to find possible relationships. This value is case sensitive !</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: APIVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>APIVersion</maml:name> <maml:description> <maml:para>The Web-API Version used to query. Default is 'v9.0'".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Single-valued navigation property --> <command:syntaxItem> <maml:name>Remove-ProvDyn365EntityAssociation</maml:name> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>The Authentication context generated by Get-ProvAzureAuthContext</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PrimaryEntityId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>PrimaryEntityId</maml:name> <maml:description> <maml:para>The id of the primary (source) entity in Dynamics365/ProvanceITSM you want to remove the relationship from.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: PrimaryEntityName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>PrimaryEntityName</maml:name> <maml:description> <maml:para>The logical name of the primary (source) entity in Dynamics365/ProvanceITSM you want to remove the relationship from. This value is case sensitive !</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PropertyName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>PropertyName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: APIVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>APIVersion</maml:name> <maml:description> <maml:para>The Web-API Version used to query. Default is 'v9.0'".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>The Authentication context generated by Get-ProvAzureAuthContext</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PrimaryEntityName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>PrimaryEntityName</maml:name> <maml:description> <maml:para>The logical name of the primary (source) entity in Dynamics365/ProvanceITSM you want to remove the relationship from. This value is case sensitive !</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PrimaryEntityId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>PrimaryEntityId</maml:name> <maml:description> <maml:para>The id of the primary (source) entity in Dynamics365/ProvanceITSM you want to remove the relationship from.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: RelationshipName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RelationshipName</maml:name> <maml:description> <maml:para>The logical name of the relationship between the primary and the related entity. Use Dynamics 365 Customization page to find possible relationships. This value is case sensitive !</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RelatedEntityId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>RelatedEntityId</maml:name> <maml:description> <maml:para>The id of the related (target) entity in Dynamics365/ProvanceITSM you want to remove the relationship from.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: PropertyName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>PropertyName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: APIVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>APIVersion</maml:name> <maml:description> <maml:para>The Web-API Version used to query. Default is 'v9.0'".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code> Unlink a contact from an account Remove-ProvDyn365EntityAssociation -AuthContext $token -PrimaryEntityName account -PrimaryEntityId $ra.accountid -RelationshipName contact_customer_accounts -RelatedEntityId $rc.contactid In this example we have retrieves account and contact before and stored them in variables. $ra is the related account and $rc is the related contact. To retrieve those values, you would run the following commands before: $ra = Get-ProvDyn365Entity -AuthContext $token -EntityName account -FilterSection "contains(name,'Contoso')" -selectsection name $rc = Get-ProvDyn365Entity -AuthContext $token -EntityName contact -FilterSection "contains(fullname,'John Smith')" -SelectSection fullname Explanaition of parameters and values: -relationshipName 'contact_customer_accounts' This is the logical name of the relationship between the account and the contact. Use Dynamics 365 Customization page to find possible relationships. -PrimaryEntityName 'account' This is the logical name of the primary (source) entity -PrimaryEntityId $ra.accountid This is the id or the source entity you want to remove the relationip from. To get the id of an entity use Get-ProvDyn365Entity. -RelatedEntityId $rc.contactid This is the id or the target entity you want to remove the relationip from. To get the id of an entity use Get-ProvDyn365Entity. For easier reading of the command you could also use parameter splatting and create a parameter hashtable $removeContactFromAccount = @{ 'AuthContext' = $token 'RelationshipName' = 'contact_customer_accounts' 'PrimaryEntityName' = 'account' 'PrimaryEntityId' = $($ra.accountid) 'RelatedEntityId' = $($rc.contactid) } Remove-ProvDyn365EntityAssociation @removeContactFromAccount The $token object is generated by the cmdlet Provance.AzureAuthcontext which can be found in the Provance.Azure Module.</dev:code> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Provance Technologies Inc.</maml:linkText> <maml:uri>(http://provance.com)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Help</maml:linkText> <maml:uri>(http://help.provance.com)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-ProvDyn365EntityMetadata --> <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-ProvDyn365EntityMetadata</command:name> <command:verb>Get</command:verb> <command:noun>ProvDyn365EntityMetadata</command:noun> <maml:description> <maml:para>Get entity metadata of an entity in Dynamics365/ProvanceITSM.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet reads the metdata by specifying a filter for entity logical names in a Dynamics365/ProvanceITSM instance via the WEB API.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ProvDyn365EntityMetadata</maml:name> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>The Authentication context generated by Get-ProvAzureAuthContext</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: APIVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>APIVersion</maml:name> <maml:description> <maml:para>The Web-API Version used to query. Default is 'v9.0'".</maml:para> <maml:para>Change only if you know what you are doing ....</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FilterSection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FilterSection</maml:name> <maml:description> <maml:para>The input filter for the selection. i.e "LogicalName eq 'incident'" i.e "SchemaName eq 'Incident'" Important: The filter for this cmdlet allows only operators which return unique values. Dont use 'contains', instead use 'eq' !!!</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SelectSection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SelectSection</maml:name> <maml:description> <maml:para>The output filter for the entities, defined by a field name array, i.e. "LogicalName,SchemaName,PrimaryIdAttribute,LogicalCollectionName"</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>The Authentication context generated by Get-ProvAzureAuthContext</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SelectSection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SelectSection</maml:name> <maml:description> <maml:para>The output filter for the entities, defined by a field name array, i.e. "LogicalName,SchemaName,PrimaryIdAttribute,LogicalCollectionName"</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FilterSection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FilterSection</maml:name> <maml:description> <maml:para>The input filter for the selection. i.e "LogicalName eq 'incident'" i.e "SchemaName eq 'Incident'" Important: The filter for this cmdlet allows only operators which return unique values. Dont use 'contains', instead use 'eq' !!!</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: APIVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>APIVersion</maml:name> <maml:description> <maml:para>The Web-API Version used to query. Default is 'v9.0'".</maml:para> <maml:para>Change only if you know what you are doing ....</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Hashtable --> <command:returnValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code> Get the entity metadata of a contact Get-ProvDyn365EntityMetadata -AuthContext $token -FilterSection "LogicalName eq 'account'" -SelectSection 'DisplayName,IsLogicalEntity,Description' The -FilterSelection defines which entity´s metadata shall be retrieved. !!! For this cmdlet, the filter allows operators which return unique values. Dont use 'contains', instead use 'eq' !!! The -Selectsection parameter limits the number of returned metadata values and must be a string, so put it in qotes. Without this parameter, the cmdlet returns all metadata values. The example above limits the output to DisplayName, IsLogicalEntity and Description. The metadataid of the entity is always returned. The $token object is generated by the cmdlet Provance.AzureAuthcontext which can be found in the Provance.Azure Module.</dev:code> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Provance Technologies Inc.</maml:linkText> <maml:uri>(http://provance.com)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Help</maml:linkText> <maml:uri>(http://help.provance.com)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> </helpItems> |