[Index]

Model: relation/CustomerBuild-AddMicrosoftTenant-WFC_REL

CustomerBuild-AddMicrosoftTenant-WFC_REL

Model Details: relation/CustomerBuild-AddMicrosoftTenant-WFC_REL

Title Description Details
Name *
  • Field Name: name
  • Type: String
  • MaxLength: 1024
Relation Microsoft Tenant
  • Field Name: relation_MicrosoftTenant.[n]
  • Type: Array
  • Cardinality: [0..1]
Name * Microsoft Tenant user defined name can have a max length of 255 charactors within the following regex pattern - ^[a-zA-Z0-9-_ ]+$
  • Field Name: relation_MicrosoftTenant.[n].name
  • Type: String
  • MaxLength: 255
  • Pattern: ^[a-zA-Z0-9-_. ]+$
Description Microsoft Tenant user defined description can have a max length of 255 charactors.
  • Field Name: relation_MicrosoftTenant.[n].description
  • Type: String
  • MaxLength: 255
Cloud Environment Type Cloud environment type Default: Commercial
  • Field Name: relation_MicrosoftTenant.[n].cloud_env_type
  • Type: String
  • Default: Commercial
  • MaxLength: 1024
Show Advanced Settings and Internet Proxy Settings Show Advanced Settings
  • Field Name: relation_MicrosoftTenant.[n].show_advanced_settings
  • Type: Boolean
UC Automation UC Automation feature toggle
  • Field Name: relation_MicrosoftTenant.[n].uc_automation
  • Type: Boolean
UC Monitoring UC Assurance/Monitoring feature toggle
  • Field Name: relation_MicrosoftTenant.[n].uc_assurance
  • Type: Boolean
UC Analytics UC Analytics feature toggle
  • Field Name: relation_MicrosoftTenant.[n].uc_analytics
  • Type: Boolean
Security Security feature toggle
  • Field Name: relation_MicrosoftTenant.[n].security
  • Type: Boolean
Email Email feature toggle
  • Field Name: relation_MicrosoftTenant.[n].email
  • Type: Boolean
License Management License Management feature toggle
  • Field Name: relation_MicrosoftTenant.[n].license_management
  • Type: Boolean
Meeting Rooms Meeting Rooms feature toggle
  • Field Name: relation_MicrosoftTenant.[n].meeting_rooms
  • Type: Boolean
Microsoft Application Authentication
  • Field Name: microsoft_application_authentication
  • Type: Object
Use VOSS Central App Registration In shared central app registration, VOSS builds and maintains the app registration in their Microsoft Entra ID tenant, and performs organizational and application validation with Microsoft Default: true
  • Field Name: relation_MicrosoftTenant.[n].microsoft_application_authentication.use_central_app_reg
  • Type: Boolean
  • Default: true
Application ID * The Client ID or Application ID located in the Azure AD app registration portal.
  • Field Name: relation_MicrosoftTenant.[n].microsoft_application_authentication.client_id
  • Type: String
  • MaxLength: 1024
Tenant ID * The Tenant ID or Directory ID located in the Azure AD app registration portal.
  • Field Name: relation_MicrosoftTenant.[n].microsoft_application_authentication.tenant_id
  • Type: String
  • MaxLength: 1024
Certificate Thumbprint Certificate Thumbprint for a certificate which has been previously uploaded in the Azure AD app registration portal. Required for Exchange.
  • Field Name: relation_MicrosoftTenant.[n].microsoft_application_authentication.certificate_thumbprint
  • Type: String
  • MaxLength: 1024
Secret A Client secret previously created in the Azure AD app registration portal. Not used for Exchange.
  • Field Name: relation_MicrosoftTenant.[n].microsoft_application_authentication.client_secret
  • Type: String
  • Is Password: True
  • Store Encrypted: True
  • MaxLength: 1024
Note A Client secret previously created in the Azure AD app registration portal. Not used for Exchange.
  • Field Name: relation_MicrosoftTenant.[n].microsoft_application_authentication.client_secret_note
  • Type: String
  • MaxLength: 1024
Certificate A locally stored certificate the public portion of which has been previously uploaded in the Azure AD app registration portal.
  • Field Name: relation_MicrosoftTenant.[n].microsoft_application_authentication.certificate_pkid
  • Type: String
  • MaxLength: 1024
Authorize Microsoft Tenant This is the link to initiate the Microsoft grant process to obtain access to the Tenant.
  • Field Name: relation_MicrosoftTenant.[n].microsoft_application_authentication.authorize_microsoft_link
  • Type: String
  • MaxLength: 1024
  • Format: link
Data Sync Settings
  • Field Name: datasync_settings
  • Type: Object
Sync Type Select the type of data sync to be performed. Create default data syncs will create the default data syncs that is shipped with the product. Create a new MIF will create a new Model Instance Filter for a specific model. Use Datasync Builder will use the custom datasync template to create the data syncs. Default: sync_all_users
  • Field Name: relation_MicrosoftTenant.[n].datasync_settings.sync_type
  • Type: String
  • Default: sync_all_users
  • MaxLength: 1024
  • Choices: ["Create default data syncs", "Create default data syncs with custom MS365 MIF", "Use Datasync Builder"]
Datasync Profile Select the datasync profile to be used. The datasync profile is a predefined set of data sync templates. The datasyncs in the profile are used to create the data syncs.
  • Field Name: relation_MicrosoftTenant.[n].datasync_settings.datasync_profile
  • Type: String
  • MaxLength: 1024
Datasync Templates Select the datasync templates to be used. The datasync template list will be used to create the data syncs.
  • Field Name: datasyncs.[n]
  • Type: Array
Datasync Template Specify the predifined datasync template
  • Field Name: relation_MicrosoftTenant.[n].datasync_settings.datasyncs.[n].datasync_template_name
  • Type: String
  • MaxLength: 1024
First Execution Date (YYYY-MM-DD. Local date) Execution Date
  • Field Name: relation_MicrosoftTenant.[n].datasync_settings.datasyncs.[n].first_date
  • Type: String
  • MaxLength: 1024
  • Pattern: ^\d{4}\-(0[1-9]|1[012])\-(0[1-9]|[12]\d|3[01])$
First Execution Time (HH:MM:SS. Local time) Execution Time
  • Field Name: relation_MicrosoftTenant.[n].datasync_settings.datasyncs.[n].first_time
  • Type: String
  • MaxLength: 1024
  • Pattern: ^([0-1]\d|2[0-3]):(0[0-9]|[1-5]\d):(0[0-9]|[1-5]\d)$
Display date fields
  • Field Name: relation_MicrosoftTenant.[n].datasync_settings.datasyncs.[n].display_date_fields
  • Type: Boolean
User Filters User Filters are treated as OR conditions when syncing users
  • Field Name: mif_filters.[n]
  • Type: Array
Custom Filter Specify Custom filter parameters or use predifined filters Default: false
  • Field Name: relation_MicrosoftTenant.[n].datasync_settings.mif_filters.[n].use_custom_filter
  • Type: Boolean
  • Default: false
Filter Name
  • Field Name: relation_MicrosoftTenant.[n].datasync_settings.mif_filters.[n].filter_name
  • Type: String
  • MaxLength: 1024
Attribute Filters
  • Field Name: attr_filters.[n]
  • Type: Array
Attribute Name The model attribute name for which the filter applies.
  • Field Name: relation_MicrosoftTenant.[n].datasync_settings.mif_filters.[n].attr_filters.[n].attr_name
  • Type: String
  • MaxLength: 1024
Condition The nature of comparison to be made for the filter. Condition can be 'Equals', 'Not Equals', 'Greater Than', 'Less Than', 'In', 'Not In' or 'Like'
  • Field Name: relation_MicrosoftTenant.[n].datasync_settings.mif_filters.[n].attr_filters.[n].condition
  • Type: String
  • MaxLength: 1024
  • Choices: ["Equals", "Not Equals", "Greater Than", "Less Than", "In", "Not In", "Like"]
Value A single value to which the condition is applied. Value is used when the condition is one of 'Equals', 'Not Equals', 'Greater Than', or 'Less Than'
  • Field Name: relation_MicrosoftTenant.[n].datasync_settings.mif_filters.[n].attr_filters.[n].value
  • Type: String
  • MaxLength: 1024
Values A list of multiple values to which the condition is applied. Values are used when the condition is either 'In' or 'Not In'
  • Field Name: value_list.[n]
  • Type: Array
summary_value
  • Field Name: relation_MicrosoftTenant.[n].datasync_settings.mif_filters.[n].summary_value
  • Type: String
  • MaxLength: 1024
Security Configuration
  • Field Name: security_configuration
  • Type: Object
Domain Microsoft Defender admin domain used to authenticate.
  • Field Name: relation_MicrosoftTenant.[n].security_configuration.security_admin_domain
  • Type: String
  • MaxLength: 1024
Email Configuration
  • Field Name: email_configuration
  • Type: Object
Domain Microsoft Exchange admin domain used to authenticate.
  • Field Name: relation_MicrosoftTenant.[n].email_configuration.exchange_admin_domain
  • Type: String
  • MaxLength: 1024
Advanced Settings
  • Field Name: advanced_settings
  • Type: Object
Maximum Rendered Template Size The maximum allowed size of any rendered template for all models for all managed drivers. Size in bytes, so 900000000 is 900MB. Only set this value if the amount of data returned when using the default value is causing an error. The default value used if this is not set will be 900MB.
  • Field Name: relation_MicrosoftTenant.[n].advanced_settings.max_rendered_template_size
  • Type: String
  • MaxLength: 1024
MS Teams CsOnlineUser page size The page size for the msteamsonline/CsOnlineUser device model. Only set this value if the amount of data returned when using the default value is causing an error. The default value used if this is not set will be 120000.
  • Field Name: relation_MicrosoftTenant.[n].advanced_settings.CsOnlineUser_page_size
  • Type: String
  • MaxLength: 1024
MS Teams Number page size The page size for the msteamsonline/Number device model. The default value is 1000 when left empty. Only set this value lower if the amount of data returned, when using the default maximum value of 1000, is causing an error.
  • Field Name: relation_MicrosoftTenant.[n].advanced_settings.Number_page_size
  • Type: String
  • MaxLength: 1024
MS 365 MsolUser page size Controls the number of records retrieved at a time from the device/msgraph/MSOLUser related API. Leaving it blank uses a default of 999 for optimal performance. Only modify this value if you encounter sync errors (e.g., 'Template output exceeded memory limit'), where you can specify a smaller value to resolve the issue. Note that reducing the value may affect sync performance, so use the largest value that doesn't cause errors.
  • Field Name: relation_MicrosoftTenant.[n].advanced_settings.msol_user_api_page_size
  • Type: String
  • MaxLength: 1024
MS 365 Group page size Governs the number of records fetched at once from the device/msgraph/Group related APIs. When left empty, it defaults to 999 for efficient performance. Adjust this value only if you encounter synchronization errors, like ('Template output exceeded memory limit.'). You can specify a smaller value to resolve errors, but be aware that reducing the value may impact sync performance, so use the largest suitable page size.
  • Field Name: relation_MicrosoftTenant.[n].advanced_settings.groups_api_page_size
  • Type: String
  • MaxLength: 1024
Auto filter Teams users Add a default filter to all CsOnlineUser syncs to only return records which match MsolUsers in the cache
  • Field Name: relation_MicrosoftTenant.[n].advanced_settings.auto_filter_teams_users
  • Type: Boolean
Outbound Internet Proxy Settings
  • Field Name: outbound_internet_proxy_settings
  • Type: Object
Proxy address Proxy address (RFC 3986 compliant)
  • Field Name: relation_MicrosoftTenant.[n].outbound_internet_proxy_settings.outbound_proxy_address
  • Type: String
  • MaxLength: 255
Proxy username Proxy username
  • Field Name: relation_MicrosoftTenant.[n].outbound_internet_proxy_settings.outbound_proxy_username
  • Type: String
  • MaxLength: 255
Proxy password Proxy password
  • Field Name: relation_MicrosoftTenant.[n].outbound_internet_proxy_settings.outbound_proxy_password
  • Type: String
  • Is Password: True
  • Store Encrypted: True
  • MaxLength: 255
Shadow
  • Field Name: shadow.[n]
  • Type: Array
  • Cardinality: [0..1]
Name *
  • Field Name: relation_MicrosoftTenant.[n].shadow.[n].name
  • Type: String
  • MaxLength: 1024