synchronizationMetadataEntry resource type

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Metadata for the given object.

Properties

Property Type Description
key synchronizationMetadata Possible values are: GalleryApplicationIdentifier, GalleryApplicationKey, IsOAuthEnabled, IsSynchronizationAgentAssignmentRequired, IsSynchronizationAgentRequired, IsSynchronizationInPreview, OAuthSettings, SynchronizationLearnMoreIbizaFwLink, ConfigurationFields.
value String Value of the metadata property.

Supported key-value pairs

Key Value
GalleryApplicationIdentifier The GUID that represents this enterprise application in Microsoft Entra ID.
GalleryApplicationKey The name that represents this enterprise application in Microsoft Entra ID (same value as the factoryTag attribute within the synchronizationTemplate resource type).
IsOAuthEnabled Indicates whether OAuth is enabled for this synchronization job's application.
IsSynchronizationAgentAssignmentRequired Indicates whether to display certain UI elements applicable only during synchronization that requires an on-premises agent.
IsSynchronizationAgentRequired Indicates whether an on-premises synchronization agent is required for this synchronization job.
IsSynchronizationInPreview Indicates whether provisioning for this enterprise application is generally available.
OAuthSettings A JSON containing values necessary for OAuth authentication, such as the token exchange URI and client identifier.
SynchronizationLearnMoreIbizaFwLink The documentation link that's displayed in the Microsoft Entra admin center.
ConfigurationFields A JSON containing the textbox configuration names that are displayed in the Microsoft Entra admin center.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.synchronizationMetadataEntry",
  "key": "String",
  "value": "String"
}