Invoke-MgParseServicePrincipalSynchronizationTemplateSchemaExpression
Parse a given string expression into an attributeMappingSource object. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.
Note
To view the beta release of this cmdlet, view Invoke-MgBetaParseServicePrincipalSynchronizationTemplateSchemaExpression
Syntax
Invoke-MgParseServicePrincipalSynchronizationTemplateSchemaExpression
-ServicePrincipalId <String>
-SynchronizationTemplateId <String>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-Expression <String>]
[-TargetAttributeDefinition <IMicrosoftGraphAttributeDefinition>]
[-TestInputObject <IMicrosoftGraphExpressionInputObject>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Invoke-MgParseServicePrincipalSynchronizationTemplateSchemaExpression
-ServicePrincipalId <String>
-SynchronizationTemplateId <String>
-BodyParameter <IPaths1Ia9XfcServiceprincipalsServiceprincipalIdSynchronizationTemplatesSynchronizationtemplateIdSchemaMicrosoftGraphParseexpressionPostRequestbodyContentApplicationJsonSchema>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Invoke-MgParseServicePrincipalSynchronizationTemplateSchemaExpression
-InputObject <IApplicationsIdentity>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-Expression <String>]
[-TargetAttributeDefinition <IMicrosoftGraphAttributeDefinition>]
[-TestInputObject <IMicrosoftGraphExpressionInputObject>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Invoke-MgParseServicePrincipalSynchronizationTemplateSchemaExpression
-InputObject <IApplicationsIdentity>
-BodyParameter <IPaths1Ia9XfcServiceprincipalsServiceprincipalIdSynchronizationTemplatesSynchronizationtemplateIdSchemaMicrosoftGraphParseexpressionPostRequestbodyContentApplicationJsonSchema>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
Parse a given string expression into an attributeMappingSource object. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.
Permissions
| Permission type | Least privileged permissions | Higher privileged permissions |
|---|---|---|
| Delegated (work or school account) | Synchronization.ReadWrite.All | Not available. |
| Delegated (personal Microsoft account) | Not supported. | Not supported. |
| Application | Application.ReadWrite.OwnedBy | Synchronization.ReadWrite.All |
Parameters
-AdditionalProperties
Additional Parameters
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BodyParameter
. To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
| Type: | IPaths1Ia9XfcServiceprincipalsServiceprincipalIdSynchronizationTemplatesSynchronizationtemplateIdSchemaMicrosoftGraphParseexpressionPostRequestbodyContentApplicationJsonSchema |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Expression
.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Headers
Optional headers that will be added to the request.
| Type: | IDictionary |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
| Type: | IApplicationsIdentity |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ProgressAction
{{ Fill ProgressAction Description }}
| Type: | ActionPreference |
| Aliases: | proga |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResponseHeadersVariable
Optional Response Headers Variable.
| Type: | String |
| Aliases: | RHV |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ServicePrincipalId
The unique identifier of servicePrincipal
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SynchronizationTemplateId
The unique identifier of synchronizationTemplate
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TargetAttributeDefinition
attributeDefinition To construct, see NOTES section for TARGETATTRIBUTEDEFINITION properties and create a hash table.
| Type: | IMicrosoftGraphAttributeDefinition |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TestInputObject
expressionInputObject To construct, see NOTES section for TESTINPUTOBJECT properties and create a hash table.
| Type: | IMicrosoftGraphExpressionInputObject |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Microsoft.Graph.PowerShell.Models.IApplicationsIdentity
Microsoft.Graph.PowerShell.Models.IPaths1Ia9XfcServiceprincipalsServiceprincipalIdSynchronizationTemplatesSynchronizationtemplateIdSchemaMicrosoftGraphParseexpressionPostRequestbodyContentApplicationJsonSchema
System.Collections.IDictionary
Outputs
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphParseExpressionResponse
Notes
COMPLEX PARAMETER PROPERTIES
To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.
BODYPARAMETER <IPaths1Ia9XfcServiceprincipalsServiceprincipalIdSynchronizationTemplatesSynchronizationtemplateIdSchemaMicrosoftGraphParseexpressionPostRequestbodyContentApplicationJsonSchema>: .
[(Any) <Object>]: This indicates any property can be added to this object.[Expression <String>]:[TargetAttributeDefinition <IMicrosoftGraphAttributeDefinition>]: attributeDefinition[(Any) <Object>]: This indicates any property can be added to this object.[Anchor <Boolean?>]: true if the attribute should be used as the anchor for the object. Anchor attributes must have a unique value identifying an object, and must be immutable. Default is false. One, and only one, of the object's attributes must be designated as the anchor to support synchronization.[ApiExpressions <IMicrosoftGraphStringKeyStringValuePair-[]>]:[Key <String>]: Key.[Value <String>]: Value.
[CaseExact <Boolean?>]: true if value of this attribute should be treated as case-sensitive. This setting affects how the synchronization engine detects changes for the attribute.[DefaultValue <String>]: The default value of the attribute.[FlowNullValues <Boolean?>]: 'true' to allow null values for attributes.[Metadata <IMicrosoftGraphAttributeDefinitionMetadataEntry-[]>]: Metadata for the given object.[Key <String>]: attributeDefinitionMetadata[Value <String>]: Value of the metadata property.
[Multivalued <Boolean?>]: true if an attribute can have multiple values. Default is false.[Mutability <String>]: mutability[Name <String>]: Name of the attribute. Must be unique within the object definition. Not nullable.[ReferencedObjects <IMicrosoftGraphReferencedObject-[]>]: For attributes with reference type, lists referenced objects (for example, the manager attribute would list User as the referenced object).[ReferencedObjectName <String>]: Name of the referenced object. Must match one of the objects in the directory definition.[ReferencedProperty <String>]: Currently not supported. Name of the property in the referenced object, the value for which is used as the reference.
[Required <Boolean?>]: true if attribute is required. Object can not be created if any of the required attributes are missing. If during synchronization, the required attribute has no value, the default value will be used. If default the value was not set, synchronization will record an error.[Type <String>]: attributeType
[TestInputObject <IMicrosoftGraphExpressionInputObject>]: expressionInputObject[(Any) <Object>]: This indicates any property can be added to this object.[Definition <IMicrosoftGraphObjectDefinition>]: objectDefinition[(Any) <Object>]: This indicates any property can be added to this object.[Attributes <IMicrosoftGraphAttributeDefinition-[]>]: Defines attributes of the object.[Metadata <IMicrosoftGraphObjectDefinitionMetadataEntry-[]>]: Metadata for the given object.[Key <String>]: objectDefinitionMetadata[Value <String>]: Value of the metadata property.
[Name <String>]: Name of the object. Must be unique within a directory definition. Not nullable.[SupportedApis <String-[]>]: The API that the provisioning service queries to retrieve data for synchronization.
[Properties <IMicrosoftGraphStringKeyObjectValuePair-[]>]: Property values of the test object.[Key <String>]: Key.
INPUTOBJECT <IApplicationsIdentity>: Identity Parameter
[AppId <String>]: Alternate key of application[AppManagementPolicyId <String>]: The unique identifier of appManagementPolicy[AppRoleAssignmentId <String>]: The unique identifier of appRoleAssignment[ApplicationId <String>]: The unique identifier of application[ApplicationTemplateId <String>]: The unique identifier of applicationTemplate[ClaimsMappingPolicyId <String>]: The unique identifier of claimsMappingPolicy[DelegatedPermissionClassificationId <String>]: The unique identifier of delegatedPermissionClassification[DirectoryDefinitionId <String>]: The unique identifier of directoryDefinition[DirectoryObjectId <String>]: The unique identifier of directoryObject[EndpointId <String>]: The unique identifier of endpoint[ExtensionPropertyId <String>]: The unique identifier of extensionProperty[FederatedIdentityCredentialId <String>]: The unique identifier of federatedIdentityCredential[GroupId <String>]: The unique identifier of group[HomeRealmDiscoveryPolicyId <String>]: The unique identifier of homeRealmDiscoveryPolicy[Name <String>]: Alternate key of federatedIdentityCredential[OAuth2PermissionGrantId <String>]: The unique identifier of oAuth2PermissionGrant[ServicePrincipalId <String>]: The unique identifier of servicePrincipal[SynchronizationJobId <String>]: The unique identifier of synchronizationJob[SynchronizationTemplateId <String>]: The unique identifier of synchronizationTemplate[TargetDeviceGroupId <String>]: The unique identifier of targetDeviceGroup[TokenIssuancePolicyId <String>]: The unique identifier of tokenIssuancePolicy[TokenLifetimePolicyId <String>]: The unique identifier of tokenLifetimePolicy[UniqueName <String>]: Alternate key of application[UserId <String>]: The unique identifier of user
TARGETATTRIBUTEDEFINITION <IMicrosoftGraphAttributeDefinition>: attributeDefinition
[(Any) <Object>]: This indicates any property can be added to this object.[Anchor <Boolean?>]: true if the attribute should be used as the anchor for the object. Anchor attributes must have a unique value identifying an object, and must be immutable. Default is false. One, and only one, of the object's attributes must be designated as the anchor to support synchronization.[ApiExpressions <IMicrosoftGraphStringKeyStringValuePair-[]>]:[Key <String>]: Key.[Value <String>]: Value.
[CaseExact <Boolean?>]: true if value of this attribute should be treated as case-sensitive. This setting affects how the synchronization engine detects changes for the attribute.[DefaultValue <String>]: The default value of the attribute.[FlowNullValues <Boolean?>]: 'true' to allow null values for attributes.[Metadata <IMicrosoftGraphAttributeDefinitionMetadataEntry-[]>]: Metadata for the given object.[Key <String>]: attributeDefinitionMetadata[Value <String>]: Value of the metadata property.
[Multivalued <Boolean?>]: true if an attribute can have multiple values. Default is false.[Mutability <String>]: mutability[Name <String>]: Name of the attribute. Must be unique within the object definition. Not nullable.[ReferencedObjects <IMicrosoftGraphReferencedObject-[]>]: For attributes with reference type, lists referenced objects (for example, the manager attribute would list User as the referenced object).[ReferencedObjectName <String>]: Name of the referenced object. Must match one of the objects in the directory definition.[ReferencedProperty <String>]: Currently not supported. Name of the property in the referenced object, the value for which is used as the reference.
[Required <Boolean?>]: true if attribute is required. Object can not be created if any of the required attributes are missing. If during synchronization, the required attribute has no value, the default value will be used. If default the value was not set, synchronization will record an error.[Type <String>]: attributeType
TESTINPUTOBJECT <IMicrosoftGraphExpressionInputObject>: expressionInputObject
[(Any) <Object>]: This indicates any property can be added to this object.[Definition <IMicrosoftGraphObjectDefinition>]: objectDefinition[(Any) <Object>]: This indicates any property can be added to this object.[Attributes <IMicrosoftGraphAttributeDefinition-[]>]: Defines attributes of the object.[Anchor <Boolean?>]: true if the attribute should be used as the anchor for the object. Anchor attributes must have a unique value identifying an object, and must be immutable. Default is false. One, and only one, of the object's attributes must be designated as the anchor to support synchronization.[ApiExpressions <IMicrosoftGraphStringKeyStringValuePair-[]>]:[Key <String>]: Key.[Value <String>]: Value.
[CaseExact <Boolean?>]: true if value of this attribute should be treated as case-sensitive. This setting affects how the synchronization engine detects changes for the attribute.[DefaultValue <String>]: The default value of the attribute.[FlowNullValues <Boolean?>]: 'true' to allow null values for attributes.[Metadata <IMicrosoftGraphAttributeDefinitionMetadataEntry-[]>]: Metadata for the given object.[Key <String>]: attributeDefinitionMetadata[Value <String>]: Value of the metadata property.
[Multivalued <Boolean?>]: true if an attribute can have multiple values. Default is false.[Mutability <String>]: mutability[Name <String>]: Name of the attribute. Must be unique within the object definition. Not nullable.[ReferencedObjects <IMicrosoftGraphReferencedObject-[]>]: For attributes with reference type, lists referenced objects (for example, the manager attribute would list User as the referenced object).[ReferencedObjectName <String>]: Name of the referenced object. Must match one of the objects in the directory definition.[ReferencedProperty <String>]: Currently not supported. Name of the property in the referenced object, the value for which is used as the reference.
[Required <Boolean?>]: true if attribute is required. Object can not be created if any of the required attributes are missing. If during synchronization, the required attribute has no value, the default value will be used. If default the value was not set, synchronization will record an error.[Type <String>]: attributeType
[Metadata <IMicrosoftGraphObjectDefinitionMetadataEntry-[]>]: Metadata for the given object.[Key <String>]: objectDefinitionMetadata[Value <String>]: Value of the metadata property.
[Name <String>]: Name of the object. Must be unique within a directory definition. Not nullable.[SupportedApis <String-[]>]: The API that the provisioning service queries to retrieve data for synchronization.
[Properties <IMicrosoftGraphStringKeyObjectValuePair-[]>]: Property values of the test object.[Key <String>]: Key.