Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Update-MgApplicationSynchronizationJobSchemaDirectory
Update the navigation property directories in applications
Note
To view the beta release of this cmdlet, view Update-MgBetaApplicationSynchronizationJobSchemaDirectory
Syntax
UpdateExpanded (Default)
Update-MgApplicationSynchronizationJobSchemaDirectory
-ApplicationId <string>
-DirectoryDefinitionId <string>
-SynchronizationJobId <string>
[-ResponseHeadersVariable <string>]
[-AdditionalProperties <hashtable>]
[-Discoverabilities <string>]
[-DiscoveryDateTime <datetime>]
[-Id <string>]
[-Name <string>]
[-Objects <IMicrosoftGraphObjectDefinition[]>]
[-ReadOnly]
[-Version <string>]
[-Break]
[-Headers <IDictionary>]
[-HttpPipelineAppend <SendAsyncStep[]>]
[-HttpPipelinePrepend <SendAsyncStep[]>]
[-Proxy <uri>]
[-ProxyCredential <pscredential>]
[-ProxyUseDefaultCredentials]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update
Update-MgApplicationSynchronizationJobSchemaDirectory
-ApplicationId <string>
-DirectoryDefinitionId <string>
-SynchronizationJobId <string>
-BodyParameter <IMicrosoftGraphDirectoryDefinition>
[-ResponseHeadersVariable <string>]
[-Break]
[-Headers <IDictionary>]
[-HttpPipelineAppend <SendAsyncStep[]>]
[-HttpPipelinePrepend <SendAsyncStep[]>]
[-Proxy <uri>]
[-ProxyCredential <pscredential>]
[-ProxyUseDefaultCredentials]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaIdentityExpanded
Update-MgApplicationSynchronizationJobSchemaDirectory
-InputObject <IApplicationsIdentity>
[-ResponseHeadersVariable <string>]
[-AdditionalProperties <hashtable>]
[-Discoverabilities <string>]
[-DiscoveryDateTime <datetime>]
[-Id <string>]
[-Name <string>]
[-Objects <IMicrosoftGraphObjectDefinition[]>]
[-ReadOnly]
[-Version <string>]
[-Break]
[-Headers <IDictionary>]
[-HttpPipelineAppend <SendAsyncStep[]>]
[-HttpPipelinePrepend <SendAsyncStep[]>]
[-Proxy <uri>]
[-ProxyCredential <pscredential>]
[-ProxyUseDefaultCredentials]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaIdentity
Update-MgApplicationSynchronizationJobSchemaDirectory
-InputObject <IApplicationsIdentity>
-BodyParameter <IMicrosoftGraphDirectoryDefinition>
[-ResponseHeadersVariable <string>]
[-Break]
[-Headers <IDictionary>]
[-HttpPipelineAppend <SendAsyncStep[]>]
[-HttpPipelinePrepend <SendAsyncStep[]>]
[-Proxy <uri>]
[-ProxyCredential <pscredential>]
[-ProxyUseDefaultCredentials]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Parameters
-AdditionalProperties
Additional Parameters
Parameter properties
| Type: | System.Collections.Hashtable |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ApplicationId
The unique identifier of application
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | ObjectId |
Parameter sets
-BodyParameter
directoryDefinition To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
Parameter properties
| Type: | Microsoft.Graph.PowerShell.Models.IMicrosoftGraphDirectoryDefinition |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Break
Wait for .NET debugger to attach
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
-DirectoryDefinitionId
The unique identifier of directoryDefinition
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Discoverabilities
directoryDefinitionDiscoverabilities
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DiscoveryDateTime
Represents the discovery date and time using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
Parameter properties
| Type: | System.DateTime |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Headers
Optional headers that will be added to the request.
Parameter properties
| Type: | System.Collections.IDictionary |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-HttpPipelineAppend
SendAsync Pipeline Steps to be appended to the front of the pipeline
Parameter properties
| Type: | Microsoft.Graph.PowerShell.Runtime.SendAsyncStep[] |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-HttpPipelinePrepend
SendAsync Pipeline Steps to be prepended to the front of the pipeline
Parameter properties
| Type: | Microsoft.Graph.PowerShell.Runtime.SendAsyncStep[] |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Id
The unique identifier for an entity. Read-only.
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
Parameter properties
| Type: | Microsoft.Graph.PowerShell.Models.IApplicationsIdentity |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Name
Name of the directory. Must be unique within the synchronization schema. Not nullable.
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Objects
Collection of objects supported by the directory. To construct, see NOTES section for OBJECTS properties and create a hash table.
Parameter properties
| Type: | Microsoft.Graph.PowerShell.Models.IMicrosoftGraphObjectDefinition[] |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Proxy
The URI for the proxy server to use
Parameter properties
| Type: | System.Uri |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ProxyCredential
Credentials for a proxy server to use for the remote call
Parameter properties
| Type: | System.Management.Automation.PSCredential |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ProxyUseDefaultCredentials
Use the default credentials for the proxy
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ReadOnly
Whether this object is read-only.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ResponseHeadersVariable
Optional Response Headers Variable.
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | RHV |
Parameter sets
-SynchronizationJobId
The unique identifier of synchronizationJob
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Version
Read only value that indicates version discovered. null if discovery hasn't yet occurred.
Parameter properties
| Type: | System.String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-WhatIf
Runs the command in a mode that only reports what would happen without performing the actions.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
Microsoft.Graph.PowerShell.Models.IApplicationsIdentity
{{ Fill in the Description }}
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphDirectoryDefinition
{{ Fill in the Description }}
System.Collections.IDictionary
{{ Fill in the Description }}
Outputs
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphDirectoryDefinition
{{ Fill in the Description }}
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 <IMicrosoftGraphDirectoryDefinition>: directoryDefinition
[(Any) <Object>]: This indicates any property can be added to this object.
[Id <String>]: The unique identifier for an entity.
Read-only.
[Discoverabilities <String>]: directoryDefinitionDiscoverabilities
[DiscoveryDateTime <DateTime?>]: Represents the discovery date and time using ISO 8601 format and is always in UTC time.
For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
[Name <String>]: Name of the directory.
Must be unique within the synchronization schema.
Not nullable.
[Objects <IMicrosoftGraphObjectDefinition[]>]: Collection of objects supported by the directory.
[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.
[ReadOnly <Boolean?>]: Whether this object is read-only.
[Version <String>]: Read only value that indicates version discovered.
null if discovery hasn't yet occurred.
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
OBJECTS <IMicrosoftGraphObjectDefinition[]>: Collection of objects supported by the directory. [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.
