diff --git a/microsoft-graph.d.ts b/microsoft-graph.d.ts index 8e48499..695f793 100644 --- a/microsoft-graph.d.ts +++ b/microsoft-graph.d.ts @@ -153,6 +153,15 @@ export type PhoneType = export type EducationAddedStudentAction = "none" | "assignIfOpen" | "unknownFutureValue"; export type EducationAssignmentStatus = "draft" | "published" | "assigned" | "unknownFutureValue"; export type EducationSubmissionStatus = "working" | "submitted" | "released" | "returned" | "unknownFutureValue"; +export type ContactRelationship = + | "parent" + | "relative" + | "aide" + | "doctor" + | "guardian" + | "child" + | "other" + | "unknownFutureValue"; export type EducationExternalSource = "sis" | "manual" | "unknownFutureValue"; export type EducationGender = "female" | "male" | "other" | "unknownFutureValue"; export type EducationUserRole = "student" | "teacher" | "none" | "unknownFutureValue"; @@ -2421,131 +2430,132 @@ export interface DirectoryObject extends Entity { export interface User extends DirectoryObject { /** * true if the account is enabled; otherwise, false. This property is required when a user is created. Returned only on - * $select. Supports $filter (eq, ne, NOT, and in). + * $select. Supports $filter (eq, ne, not, and in). */ accountEnabled?: NullableOption; /** * Sets the age group of the user. Allowed values: null, minor, notAdult and adult. Refer to the legal age group property - * definitions for further information. Returned only on $select. Supports $filter (eq, ne, NOT, and in). + * definitions for further information. Returned only on $select. Supports $filter (eq, ne, not, and in). */ ageGroup?: NullableOption; /** * The licenses that are assigned to the user, including inherited (group-based) licenses. Not nullable. Returned only on - * $select. Supports $filter (eq and NOT). + * $select. Supports $filter (eq and not). */ assignedLicenses?: AssignedLicense[]; /** * The plans that are assigned to the user. Read-only. Not nullable. Returned only on $select. Supports $filter (eq and - * NOT). + * not). */ assignedPlans?: AssignedPlan[]; /** * The telephone numbers for the user. NOTE: Although this is a string collection, only one number can be set for this - * property. Read-only for users synced from on-premises directory. Returned by default. Supports $filter (eq and NOT). + * property. Read-only for users synced from on-premises directory. Returned by default. Supports $filter (eq, not, ge, + * le, startsWith). */ businessPhones?: string[]; /** * The city in which the user is located. Maximum length is 128 characters. Returned only on $select. Supports $filter - * (eq, ne, NOT, ge, le, in, startsWith). + * (eq, ne, not, ge, le, in, startsWith, and eq on null values). */ city?: NullableOption; /** * The company name which the user is associated. This property can be useful for describing the company that an external * user comes from. The maximum length of the company name is 64 characters.Returned only on $select. Supports $filter - * (eq, ne, NOT, ge, le, in, startsWith). + * (eq, ne, not, ge, le, in, startsWith, and eq on null values). */ companyName?: NullableOption; /** * Sets whether consent has been obtained for minors. Allowed values: null, granted, denied and notRequired. Refer to the - * legal age group property definitions for further information. Returned only on $select. Supports $filter (eq, ne, NOT, + * legal age group property definitions for further information. Returned only on $select. Supports $filter (eq, ne, not, * and in). */ consentProvidedForMinor?: NullableOption; /** * The country/region in which the user is located; for example, US or UK. Maximum length is 128 characters. Returned only - * on $select. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + * on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values). */ country?: NullableOption; - /** - * The created date of the user object. Read-only. Returned only on $select. Supports $filter (eq, ne, NOT , ge, le, and - * in operators). - */ + // The created date of the user object. Read-only. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in). createdDateTime?: NullableOption; /** * Indicates whether the user account was created through one of the following methods: As a regular school or work * account (null). As an external account (Invitation). As a local account for an Azure Active Directory B2C tenant * (LocalAccount). Through self-service sign-up by an internal user using email verification (EmailVerified). Through * self-service sign-up by an external user signing up through a link that is part of a user flow (SelfServiceSignUp). - * Read-only.Returned only on $select. Supports $filter (eq, ne, NOT, and in). + * Read-only.Returned only on $select. Supports $filter (eq, ne, not, in). */ creationType?: NullableOption; /** * The name for the department in which the user works. Maximum length is 64 characters. Returned only on $select. - * Supports $filter (eq, ne, NOT , ge, le, and in operators). + * Supports $filter (eq, ne, not , ge, le, in, and eq on null values). */ department?: NullableOption; /** * The name displayed in the address book for the user. This is usually the combination of the user's first name, middle * initial and last name. This property is required when a user is created and it cannot be cleared during updates. - * Maximum length is 256 characters. Returned by default. Supports $filter (eq, ne, NOT , ge, le, in, startsWith), - * $orderBy, and $search. + * Maximum length is 256 characters. Returned by default. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq + * on null values), $orderBy, and $search. */ displayName?: NullableOption; /** * The date and time when the user was hired or will start work in case of a future hire. Returned only on $select. - * Supports $filter (eq, ne, NOT , ge, le, in). + * Supports $filter (eq, ne, not , ge, le, in). */ employeeHireDate?: NullableOption; /** * The employee identifier assigned to the user by the organization. Returned only on $select. Supports $filter (eq, ne, - * NOT , ge, le, in, startsWith). + * not , ge, le, in, startsWith, and eq on null values). */ employeeId?: NullableOption; /** * Represents organization data (e.g. division and costCenter) associated with a user. Returned only on $select. Supports - * $filter (eq, ne, NOT , ge, le, in). + * $filter (eq, ne, not , ge, le, in). */ employeeOrgData?: NullableOption; /** * Captures enterprise worker type. For example, Employee, Contractor, Consultant, or Vendor. Returned only on $select. - * Supports $filter (eq, ne, NOT , ge, le, in, startsWith). + * Supports $filter (eq, ne, not , ge, le, in, startsWith). */ employeeType?: NullableOption; /** * For an external user invited to the tenant using the invitation API, this property represents the invited user's * invitation status. For invited users, the state can be PendingAcceptance or Accepted, or null for all other users. - * Returned only on $select. Supports $filter (eq, ne, NOT , in). + * Returned only on $select. Supports $filter (eq, ne, not , in). */ externalUserState?: NullableOption; /** * Shows the timestamp for the latest change to the externalUserState property. Returned only on $select. Supports $filter - * (eq, ne, NOT , in). + * (eq, ne, not , in). */ externalUserStateChangeDateTime?: NullableOption; - // The fax number of the user. Returned only on $select. Supports $filter (eq, ne, NOT , ge, le, in, startsWith). + /** + * The fax number of the user. Returned only on $select. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on + * null values). + */ faxNumber?: NullableOption; /** * The given name (first name) of the user. Maximum length is 64 characters. Returned by default. Supports $filter (eq, - * ne, NOT , ge, le, in, startsWith). + * ne, not , ge, le, in, startsWith, and eq on null values). */ givenName?: NullableOption; /** * Represents the identities that can be used to sign in to this user account. An identity can be provided by Microsoft * (also known as a local account), by organizations, or by social identity providers such as Facebook, Google, and * Microsoft, and tied to a user account. May contain multiple items with the same signInType value. Returned only on - * $select. Supports $filter (eq) only where the signInType is not userPrincipalName. + * $select. Supports $filter (eq) including on null values, only where the signInType is not userPrincipalName. */ identities?: NullableOption; /** * The instant message voice over IP (VOIP) session initiation protocol (SIP) addresses for the user. Read-only. Returned - * only on $select. Supports $filter (eq, NOT, ge, le, startsWith). + * only on $select. Supports $filter (eq, not, ge, le, startsWith). */ imAddresses?: NullableOption; // Do not use – reserved for future use. isResourceAccount?: NullableOption; /** - * The user's job title. Maximum length is 128 characters. Returned by default. Supports $filter (eq, ne, NOT , ge, le, - * in, startsWith). + * The user's job title. Maximum length is 128 characters. Returned by default. Supports $filter (eq, ne, not , ge, le, + * in, startsWith, and eq on null values). */ jobTitle?: NullableOption; /** @@ -2567,22 +2577,23 @@ export interface User extends DirectoryObject { * The SMTP address for the user, for example, jeff@contoso.onmicrosoft.com.Changes to this property will also update the * user's proxyAddresses collection to include the value as an SMTP address. For Azure AD B2C accounts, this property can * be updated up to only ten times with unique SMTP addresses. This property cannot contain accent characters.Returned by - * default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith, endsWith). + * default. Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith, and eq on null values). */ mail?: NullableOption; /** * The mail alias for the user. This property must be specified when a user is created. Maximum length is 64 characters. - * Returned only on $select. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + * Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values). */ mailNickname?: NullableOption; /** * The primary cellular telephone number for the user. Read-only for users synced from on-premises directory. Maximum - * length is 64 characters. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + * length is 64 characters. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null + * values). */ mobilePhone?: NullableOption; /** - * The office location in the user's place of business. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, - * startsWith). + * The office location in the user's place of business. Returned by default. Supports $filter (eq, ne, not, ge, le, in, + * startsWith, and eq on null values). */ officeLocation?: NullableOption; /** @@ -2602,54 +2613,54 @@ export interface User extends DirectoryObject { * nor filterable. For an onPremisesSyncEnabled user, the source of authority for this set of properties is the * on-premises and is read-only. For a cloud-only user (where onPremisesSyncEnabled is false), these properties may be set * during creation or update. These extension attributes are also known as Exchange custom attributes 1-15. Returned only - * on $select. Supports $filter (eq, NOT, ge, le, in). + * on $select. Supports $filter (eq, not, ge, le, in, and eq on null values). */ onPremisesExtensionAttributes?: NullableOption; /** * This property is used to associate an on-premises Active Directory user account to their Azure AD user object. This * property must be specified when creating a new user account in the Graph if you are using a federated domain for the * user's userPrincipalName (UPN) property. NOTE: The $ and _ characters cannot be used when specifying this property. - * Returned only on $select. Supports $filter (eq, ne, NOT, ge, le, in).. + * Returned only on $select. Supports $filter (eq, ne, not, ge, le, in).. */ onPremisesImmutableId?: NullableOption; /** * Indicates the last time at which the object was synced with the on-premises directory; for example: * 2013-02-16T03:04:54Z. The Timestamp type represents date and time information using ISO 8601 format and is always in * UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Returned only on $select. - * Supports $filter (eq, ne, NOT, ge, le, in). + * Supports $filter (eq, ne, not, ge, le, in). */ onPremisesLastSyncDateTime?: NullableOption; /** * Errors when using Microsoft synchronization product during provisioning. Returned only on $select. Supports $filter - * (eq, NOT, ge, le). + * (eq, not, ge, le). */ onPremisesProvisioningErrors?: NullableOption; /** * Contains the on-premises samAccountName synchronized from the on-premises directory. The property is only populated for * customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect. Read-only. - * Returned only on $select. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + * Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith). */ onPremisesSamAccountName?: NullableOption; /** * Contains the on-premises security identifier (SID) for the user that was synchronized from on-premises to the cloud. - * Read-only. Returned only on $select. + * Read-only. Returned only on $select. Supports $filter (eq) on null values only. */ onPremisesSecurityIdentifier?: NullableOption; /** * true if this object is synced from an on-premises directory; false if this object was originally synced from an * on-premises directory but is no longer synced; null if this object has never been synced from an on-premises directory - * (default). Read-only. Returned only on $select. Supports $filter (eq, ne, NOT, in). + * (default). Read-only. Returned only on $select. Supports $filter (eq, ne, not, in, and eq on null values). */ onPremisesSyncEnabled?: NullableOption; /** * Contains the on-premises userPrincipalName synchronized from the on-premises directory. The property is only populated * for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect. - * Read-only. Returned only on $select. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + * Read-only. Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith). */ onPremisesUserPrincipalName?: NullableOption; /** * A list of additional email addresses for the user; for example: ['bob@contoso.com', 'Robert@fabrikam.com']. NOTE: This - * property cannot contain accent characters. Returned only on $select. Supports $filter (eq, NOT, ge, le, in, + * property cannot contain accent characters. Returned only on $select. Supports $filter (eq, not, ge, le, in, * startsWith). */ otherMails?: string[]; @@ -2658,7 +2669,7 @@ export interface User extends DirectoryObject { * DisableStrongPassword, which allows weaker passwords than the default policy to be specified. DisablePasswordExpiration * can also be specified. The two may be specified together; for example: DisablePasswordExpiration, * DisableStrongPassword. Returned only on $select. For more information on the default password policies, see Azure AD - * pasword policies. Supports $filter (ne, NOT). + * pasword policies. Supports $filter (ne, not, and eq on null values). */ passwordPolicies?: NullableOption; /** @@ -2666,35 +2677,36 @@ export interface User extends DirectoryObject { * user is created. The password in the profile must satisfy minimum requirements as specified by the passwordPolicies * property. By default, a strong password is required. NOTE: For Azure B2C tenants, the forceChangePasswordNextSignIn * property should be set to false and instead use custom policies and user flows to force password reset at first logon. - * See Force password reset at first logon.Returned only on $select. Supports $filter (eq, ne, NOT, in). + * See Force password reset at first logon.Returned only on $select. Supports $filter (eq, ne, not, in, and eq on null + * values). */ passwordProfile?: NullableOption; /** * The postal code for the user's postal address. The postal code is specific to the user's country/region. In the United * States of America, this attribute contains the ZIP code. Maximum length is 40 characters. Returned only on $select. - * Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + * Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values). */ postalCode?: NullableOption; /** * The preferred language for the user. Should follow ISO 639-1 Code; for example en-US. Returned by default. Supports - * $filter (eq, ne, NOT, ge, le, in, startsWith) + * $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values) */ preferredLanguage?: NullableOption; /** * The plans that are provisioned for the user. Read-only. Not nullable. Returned only on $select. Supports $filter (eq, - * NOT, ge, le). + * not, ge, le). */ provisionedPlans?: ProvisionedPlan[]; /** * For example: ['SMTP: bob@contoso.com', 'smtp: bob@sales.contoso.com']. For Azure AD B2C accounts, this property has a - * limit of ten unique addresses. Read-only, Not nullable. Returned only on $select. Supports $filter (eq, NOT, ge, le, + * limit of ten unique addresses. Read-only, Not nullable. Returned only on $select. Supports $filter (eq, not, ge, le, * startsWith). */ proxyAddresses?: string[]; /** * true if the Outlook global address list should contain this user, otherwise false. If not set, this will be treated as * true. For users invited through the invitation manager, this property will be set to false. Returned only on $select. - * Supports $filter (eq, ne, NOT, in). + * Supports $filter (eq, ne, not, in). */ showInAddressList?: NullableOption; /** @@ -2706,23 +2718,23 @@ export interface User extends DirectoryObject { signInSessionsValidFromDateTime?: NullableOption; /** * The state or province in the user's address. Maximum length is 128 characters. Returned only on $select. Supports - * $filter (eq, ne, NOT, ge, le, in, startsWith). + * $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values). */ state?: NullableOption; /** * The street address of the user's place of business. Maximum length is 1024 characters. Returned only on $select. - * Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + * Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values). */ streetAddress?: NullableOption; /** * The user's surname (family name or last name). Maximum length is 64 characters. Returned by default. Supports $filter - * (eq, ne, NOT, ge, le, in, startsWith). + * (eq, ne, not, ge, le, in, startsWith, and eq on null values). */ surname?: NullableOption; /** * A two letter country code (ISO standard 3166). Required for users that will be assigned licenses due to legal * requirement to check for availability of services in countries. Examples include: US, JP, and GB. Not nullable. - * Returned only on $select. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + * Returned only on $select. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values). */ usageLocation?: NullableOption; /** @@ -2730,14 +2742,14 @@ export interface User extends DirectoryObject { * standard RFC 822. By convention, this should map to the user's email name. The general format is alias@domain, where * domain must be present in the tenant's collection of verified domains. This property is required when a user is * created. The verified domains for the tenant can be accessed from the verifiedDomains property of organization.NOTE: - * This property cannot contain accent characters. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, + * This property cannot contain accent characters. Returned by default. Supports $filter (eq, ne, not, ge, le, in, * startsWith, endsWith) and $orderBy. */ userPrincipalName?: NullableOption; /** * A string value that can be used to classify user types in your directory, such as Member and Guest. Returned only on - * $select. Supports $filter (eq, ne, NOT, in). NOTE: For more information about the permissions for member and guest - * users, see What are the default user permissions in Azure Active Directory? + * $select. Supports $filter (eq, ne, not, in, and eq on null values). NOTE: For more information about the permissions + * for member and guest users, see What are the default user permissions in Azure Active Directory? */ userType?: NullableOption; /** @@ -3914,7 +3926,7 @@ export interface Application extends DirectoryObject { api?: NullableOption; // The unique identifier for the application that is assigned to an application by Azure AD. Not nullable. Read-only. appId?: NullableOption; - // Unique identifier of the applicationTemplate. + // Unique identifier of the applicationTemplate. Supports $filter (eq, not, ne). applicationTemplateId?: NullableOption; /** * The collection of roles assigned to the application. With app role assignments, these roles can be assigned to users, @@ -3924,18 +3936,24 @@ export interface Application extends DirectoryObject { /** * The date and time the application was registered. The DateTimeOffset type represents date and time information using * ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. - * Supports $filter (eq, ne, NOT, ge, le, in) and $orderBy. + * Supports $filter (eq, ne, not, ge, le, in, and eq on null values) and $orderBy. */ createdDateTime?: NullableOption; - // An optional description of the application. Supports $filter (eq, ne, NOT, ge, le, startsWith) and $search. + /** + * Free text field to provide a description of the application object to end users. The maximum allowed size is 1024 + * characters. Supports $filter (eq, ne, not, ge, le, startsWith) and $search. + */ description?: NullableOption; /** * Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), * NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious - * activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + * activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, not). */ disabledByMicrosoftStatus?: NullableOption; - // The display name for the application. Supports $filter (eq, ne, NOT, ge, le, in, startsWith), $search, and $orderBy. + /** + * The display name for the application. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), + * $search, and $orderBy. + */ displayName?: NullableOption; /** * Configures the groups claim issued in a user or OAuth 2.0 access token that the application expects. To set this @@ -3956,7 +3974,7 @@ export interface Application extends DirectoryObject { * Basic profile information of the application such as app's marketing, support, terms of service and privacy statement * URLs. The terms of service and privacy statement are surfaced to users through the user consent experience. For more * info, see How to: Add Terms of service and privacy statement for registered Azure AD apps. Supports $filter (eq, ne, - * NOT, ge, le). + * not, ge, le, and eq on null values). */ info?: NullableOption; // Specifies whether this application supports device authentication without a user. The default is false. @@ -3969,7 +3987,7 @@ export interface Application extends DirectoryObject { * value of this property. */ isFallbackPublicClient?: NullableOption; - // The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, NOT, ge, le). + // The collection of key credentials associated with the application. Not nullable. Supports $filter (eq, not, ge, le). keyCredentials?: KeyCredential[]; // The main logo for the application. Not nullable. logo?: any; @@ -3998,13 +4016,13 @@ export interface Application extends DirectoryObject { * permissions and application roles that it needs for each of those resources. This configuration of access to the * required resources drives the consent experience. No more than 50 resource services (APIs) can be configured. Beginning * mid-October 2021, the total number of required permissions must not exceed 400. Not nullable. Supports $filter (eq, - * NOT, ge, le). + * not, ge, le). */ requiredResourceAccess?: RequiredResourceAccess[]; /** * Specifies the Microsoft accounts that are supported for the current application. The possible values are: AzureADMyOrg, * AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount (default), and PersonalMicrosoftAccount. See more in the table - * below. Supports $filter (eq, ne, NOT). + * below. Supports $filter (eq, ne, not). */ signInAudience?: NullableOption; /** @@ -4013,7 +4031,7 @@ export interface Application extends DirectoryObject { */ spa?: NullableOption; /** - * Custom strings that can be used to categorize and identify the application. Not nullable. Supports $filter (eq, NOT, + * Custom strings that can be used to categorize and identify the application. Not nullable. Supports $filter (eq, not, * ge, le, startsWith). */ tags?: string[]; @@ -4039,7 +4057,7 @@ export interface Application extends DirectoryObject { tokenLifetimePolicies?: NullableOption; } export interface ServicePrincipal extends DirectoryObject { - // true if the service principal account is enabled; otherwise, false. Supports $filter (eq, ne, NOT, in). + // true if the service principal account is enabled; otherwise, false. Supports $filter (eq, ne, not, in). accountEnabled?: NullableOption; /** * Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications @@ -4049,14 +4067,17 @@ export interface ServicePrincipal extends DirectoryObject { addIns?: AddIn[]; /** * Used to retrieve service principals by subscription, identify resource group and full resource ids for managed - * identities. Supports $filter (eq, NOT, ge, le, startsWith). + * identities. Supports $filter (eq, not, ge, le, startsWith). */ alternativeNames?: string[]; // The description exposed by the associated application. appDescription?: NullableOption; // The display name exposed by the associated application. appDisplayName?: NullableOption; - // The unique identifier for the associated application (its appId property). + /** + * The unique identifier for the associated application (its appId property). Supports $filter (eq, ne, not, in, + * startsWith). + */ appId?: NullableOption; /** * Unique identifier of the applicationTemplate that the servicePrincipal was created from. Read-only. Supports $filter @@ -4082,18 +4103,18 @@ export interface ServicePrincipal extends DirectoryObject { /** * Free text field to provide an internal end-user facing description of the service principal. End-user portals such * MyApps will display the application description in this field. The maximum allowed size is 1024 characters. Supports - * $filter (eq, ne, NOT, ge, le, startsWith) and $search. + * $filter (eq, ne, not, ge, le, startsWith) and $search. */ description?: NullableOption; /** * Specifies whether Microsoft has disabled the registered application. Possible values are: null (default value), * NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons may include suspicious, abusive, or malicious - * activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, NOT). + * activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, not). */ disabledByMicrosoftStatus?: NullableOption; /** - * The display name for the service principal. Supports $filter (eq, ne, NOT, ge, le, in, startsWith), $search, and - * $orderBy. + * The display name for the service principal. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null + * values), $search, and $orderBy. */ displayName?: NullableOption; // Home page or landing page of the application. @@ -4102,11 +4123,11 @@ export interface ServicePrincipal extends DirectoryObject { * Basic profile information of the acquired application such as app's marketing, support, terms of service and privacy * statement URLs. The terms of service and privacy statement are surfaced to users through the user consent experience. * For more info, see How to: Add Terms of service and privacy statement for registered Azure AD apps. Supports $filter - * (eq, ne, NOT, ge, le). + * (eq, ne, not, ge, le, and eq on null values). */ info?: NullableOption; /** - * The collection of key credentials associated with the service principal. Not nullable. Supports $filter (eq, NOT, ge, + * The collection of key credentials associated with the service principal. Not nullable. Supports $filter (eq, not, ge, * le). */ keyCredentials?: KeyCredential[]; @@ -4160,7 +4181,7 @@ export interface ServicePrincipal extends DirectoryObject { * hybrid applications. These values can be used to identify the permissions exposed by this app within Azure AD. For * example,Client apps can specify a resource URI which is based on the values of this property to acquire an access * token, which is the URI returned in the 'aud' claim.The any operator is required for filter expressions on multi-valued - * properties. Not nullable. Supports $filter (eq, NOT, ge, le, startsWith). + * properties. Not nullable. Supports $filter (eq, not, ge, le, startsWith). */ servicePrincipalNames?: string[]; /** @@ -4187,7 +4208,7 @@ export interface ServicePrincipal extends DirectoryObject { signInAudience?: NullableOption; /** * Custom strings that can be used to categorize and identify the service principal. Not nullable. Supports $filter (eq, - * NOT, ge, le, startsWith). + * not, ge, le, startsWith). */ tags?: string[]; /** @@ -4701,38 +4722,39 @@ export interface Group extends DirectoryObject { /** * Describes a classification for the group (such as low, medium or high business impact). Valid values for this property * are defined by creating a ClassificationList setting value, based on the template definition.Returned by default. - * Supports $filter (eq, ne, NOT, ge, le, startsWith). + * Supports $filter (eq, ne, not, ge, le, startsWith). */ classification?: NullableOption; /** * Timestamp of when the group was created. The value cannot be modified and is automatically populated when the group is * created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For - * example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Supports $filter (eq, ne, NOT, ge, + * example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Supports $filter (eq, ne, not, ge, * le, in). Read-only. */ createdDateTime?: NullableOption; /** - * An optional description for the group. Returned by default. Supports $filter (eq, ne, NOT, ge, le, startsWith) and + * An optional description for the group. Returned by default. Supports $filter (eq, ne, not, ge, le, startsWith) and * $search. */ description?: NullableOption; /** * The display name for the group. This property is required when a group is created and cannot be cleared during updates. - * Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith), $search, and $orderBy. + * Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and + * $orderBy. */ displayName?: NullableOption; /** * Timestamp of when the group is set to expire. The value cannot be modified and is automatically populated when the * group is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC * time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Supports $filter (eq, ne, - * NOT, ge, le, in). Read-only. + * not, ge, le, in). Read-only. */ expirationDateTime?: NullableOption; /** * Specifies the group type and its membership. If the collection contains Unified, the group is a Microsoft 365 group; * otherwise, it's either a security group or distribution group. For details, see groups overview.If the collection * includes DynamicMembership, the group has dynamic membership; otherwise, membership is static. Returned by default. - * Supports $filter (eq, NOT). + * Supports $filter (eq, not). */ groupTypes?: string[]; /** @@ -4747,7 +4769,7 @@ export interface Group extends DirectoryObject { * and the group cannot be a dynamic group (that is, groupTypes cannot contain DynamicMembership). Only callers in Global * administrator and Privileged role administrator roles can set this property. The caller must be assigned the * RoleManagement.ReadWrite.Directory permission to set this property or update the membership of such groups. For more, - * see Using a group to manage Azure AD role assignmentsReturned by default. Supports $filter (eq, ne, NOT). + * see Using a group to manage Azure AD role assignmentsReturned by default. Supports $filter (eq, ne, not). */ isAssignableToRole?: NullableOption; /** @@ -4757,26 +4779,26 @@ export interface Group extends DirectoryObject { licenseProcessingState?: NullableOption; /** * The SMTP address for the group, for example, 'serviceadmins@contoso.onmicrosoft.com'. Returned by default. Read-only. - * Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + * Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values). */ mail?: NullableOption; - // Specifies whether the group is mail-enabled. Required. Returned by default. Supports $filter (eq, ne, NOT). + // Specifies whether the group is mail-enabled. Required. Returned by default. Supports $filter (eq, ne, not). mailEnabled?: NullableOption; /** * The mail alias for the group, unique in the organization. Maximum length is 64 characters. This property can contain * only characters in the ASCII character set 0 - 127 except the following: @ () / [] ' ; : . <> , SPACE. - * Required. Returned by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + * Required. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values). */ mailNickname?: NullableOption; /** * The rule that determines members for this group if the group is a dynamic group (groupTypes contains * DynamicMembership). For more information about the syntax of the membership rule, see Membership Rules syntax. Returned - * by default. Supports $filter (eq, ne, NOT, ge, le, startsWith). + * by default. Supports $filter (eq, ne, not, ge, le, startsWith). */ membershipRule?: NullableOption; /** * Indicates whether the dynamic membership processing is on or paused. Possible values are On or Paused. Returned by - * default. Supports $filter (eq, ne, NOT, in). + * default. Supports $filter (eq, ne, not, in). */ membershipRuleProcessingState?: NullableOption; /** @@ -4788,7 +4810,7 @@ export interface Group extends DirectoryObject { /** * Indicates the last time at which the group was synced with the on-premises directory.The Timestamp type represents date * and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is - * 2014-01-01T00:00:00Z. Returned by default. Read-only. Supports $filter (eq, ne, NOT, ge, le, in). + * 2014-01-01T00:00:00Z. Returned by default. Read-only. Supports $filter (eq, ne, not, ge, le, in). */ onPremisesLastSyncDateTime?: NullableOption; /** @@ -4799,13 +4821,13 @@ export interface Group extends DirectoryObject { onPremisesNetBiosName?: NullableOption; /** * Errors when using Microsoft synchronization product during provisioning. Returned by default. Supports $filter (eq, - * NOT). + * not). */ onPremisesProvisioningErrors?: NullableOption; /** * Contains the on-premises SAM account name synchronized from the on-premises directory. The property is only populated * for customers who are synchronizing their on-premises directory to Azure Active Directory via Azure AD Connect.Returned - * by default. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). Read-only. + * by default. Supports $filter (eq, ne, not, ge, le, in, startsWith). Read-only. */ onPremisesSamAccountName?: NullableOption; /** @@ -4816,7 +4838,7 @@ export interface Group extends DirectoryObject { /** * true if this group is synced from an on-premises directory; false if this group was originally synced from an * on-premises directory but is no longer synced; null if this object has never been synced from an on-premises directory - * (default). Returned by default. Read-only. Supports $filter (eq, ne, NOT, in). + * (default). Returned by default. Read-only. Supports $filter (eq, ne, not, in, and eq on null values). */ onPremisesSyncEnabled?: NullableOption; /** @@ -4828,23 +4850,23 @@ export interface Group extends DirectoryObject { preferredDataLocation?: NullableOption; /** * The preferred language for a Microsoft 365 group. Should follow ISO 639-1 Code; for example en-US. Returned by default. - * Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + * Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values). */ preferredLanguage?: NullableOption; /** * Email addresses for the group that direct to the same group mailbox. For example: ['SMTP: bob@contoso.com', 'smtp: * bob@sales.contoso.com']. The any operator is required to filter expressions on multi-valued properties. Returned by - * default. Read-only. Not nullable. Supports $filter (eq, NOT, ge, le, startsWith). + * default. Read-only. Not nullable. Supports $filter (eq, not, ge, le, startsWith). */ proxyAddresses?: string[]; /** * Timestamp of when the group was last renewed. This cannot be modified directly and is only updated via the renew * service action. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC * time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Supports $filter (eq, ne, - * NOT, ge, le, in). Read-only. + * not, ge, le, in). Read-only. */ renewedDateTime?: NullableOption; - // Specifies whether the group is a security group. Required. Returned by default. Supports $filter (eq, ne, NOT, in). + // Specifies whether the group is a security group. Required. Returned by default. Supports $filter (eq, ne, not, in). securityEnabled?: NullableOption; // Security identifier of the group, used in Windows scenarios. Returned by default. securityIdentifier?: NullableOption; @@ -5035,9 +5057,8 @@ export interface Schedule extends Entity { // The instances of times off in the schedule. timesOff?: NullableOption; } -export interface Compliance { - ediscovery?: NullableOption; -} +// tslint:disable-next-line: no-empty-interface +export interface Compliance {} export interface ResourceSpecificPermissionGrant extends DirectoryObject { // ID of the service principal of the Azure AD app that has been granted access. Read-only. clientAppId?: NullableOption; @@ -5277,15 +5298,15 @@ export interface Permission extends Entity { * indicates there is no expiration set for this permission. Optional. */ expirationDateTime?: NullableOption; - // For user type permissions, the details of the users & applications for this permission. Read-only. grantedTo?: NullableOption; - // For link type permissions, the details of the users to whom permission was granted. Read-only. grantedToIdentities?: NullableOption; + // For link type permissions, the details of the users to whom permission was granted. Read-only. grantedToIdentitiesV2?: NullableOption; + // For user type permissions, the details of the users and applications for this permission. Read-only. grantedToV2?: NullableOption; /** - * This indicates whether password is set for this permission, it's only showing in response. Optional and Read-only and - * for OneDrive Personal only. + * Indicates whether the password is set for this permission. This property only appears in the response. Optional. + * Read-only. For OneDrive Personal only.. */ hasPassword?: NullableOption; // Provides a reference to the ancestor of the current permission, if it is inherited from an ancestor. Read-only. @@ -5294,7 +5315,7 @@ export interface Permission extends Entity { invitation?: NullableOption; // Provides the link details of the current permission, if it is a link type permissions. Read-only. link?: NullableOption; - // The type of permission, e.g. read. See below for the full list of roles. Read-only. + // The type of permission, for example, read. See below for the full list of roles. Read-only. roles?: NullableOption; // A unique token that can be used to access this shared item via the **shares** API. Read-only. shareId?: NullableOption; @@ -5317,7 +5338,7 @@ export interface IdentityProviderBase extends Entity { displayName?: NullableOption; } export interface AppleManagedIdentityProvider extends IdentityProviderBase { - // The certificate data which is a long string of text from the certificate, can be null. + // The certificate data, which is a long string of text from the certificate. Can be null. certificateData?: NullableOption; // The Apple developer identifier. Required. developerId?: NullableOption; @@ -5475,9 +5496,12 @@ export interface SocialIdentityProvider extends IdentityProviderBase { // tslint:disable-next-line: no-empty-interface export interface UserFlowLanguagePage extends Entity {} export interface AdministrativeUnit extends DirectoryObject { - // An optional description for the administrative unit. + // An optional description for the administrative unit. Supports $filter (eq, ne, in, startsWith). description?: NullableOption; - // Display name for the administrative unit. + /** + * Display name for the administrative unit. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null + * values), $search, and $orderBy. + */ displayName?: NullableOption; /** * Controls whether the administrative unit and its members are hidden or public. Can be set to HiddenMembership or @@ -5486,16 +5510,16 @@ export interface AdministrativeUnit extends DirectoryObject { */ visibility?: NullableOption; /** - * Users and groups that are members of this Adminsitrative Unit. HTTP Methods: GET (list members), POST (add members), + * Users and groups that are members of this administrative unit. HTTP Methods: GET (list members), POST (add members), * DELETE (remove members). */ members?: NullableOption; /** - * Scoped-role members of this Administrative Unit. HTTP Methods: GET (list scopedRoleMemberships), POST (add + * Scoped-role members of this administrative unit. HTTP Methods: GET (list scopedRoleMemberships), POST (add * scopedRoleMembership), DELETE (remove scopedRoleMembership). */ scopedRoleMembers?: NullableOption; - // The collection of open extensions defined for this Administrative Unit. Nullable. + // The collection of open extensions defined for this administrative unit. Nullable. extensions?: NullableOption; } export interface AppScope extends Entity { @@ -5538,15 +5562,16 @@ export interface Contract extends DirectoryObject { } export interface Device extends DirectoryObject { /** - * true if the account is enabled; otherwise, false. Required. Default is true. Supports $filter (eq, ne, NOT, in). Only + * true if the account is enabled; otherwise, false. Required. Default is true. Supports $filter (eq, ne, not, in). Only * callers in Global Administrator and Cloud Device Administrator roles can set this property. */ accountEnabled?: NullableOption; - // For internal use only. Not nullable. Supports $filter (eq, NOT, ge, le). + // For internal use only. Not nullable. Supports $filter (eq, not, ge, le). alternativeSecurityIds?: AlternativeSecurityId[]; /** * The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, - * midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Supports $filter (eq, ne, NOT, ge, le) and $orderBy. + * midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Supports $filter (eq, ne, not, ge, le, and eq on null + * values) and $orderBy. */ approximateLastSignInDateTime?: NullableOption; /** @@ -5556,7 +5581,7 @@ export interface Device extends DirectoryObject { */ complianceExpirationDateTime?: NullableOption; /** - * Unique identifier set by Azure Device Registration Service at the time of registration. Supports $filter (eq, ne, NOT, + * Unique identifier set by Azure Device Registration Service at the time of registration. Supports $filter (eq, ne, not, * startsWith). */ deviceId?: NullableOption; @@ -5565,40 +5590,46 @@ export interface Device extends DirectoryObject { // For internal use only. deviceVersion?: NullableOption; /** - * The display name for the device. Required. Supports $filter (eq, ne, NOT, ge, le, in, startsWith), $search, and - * $orderBy. + * The display name for the device. Required. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null + * values), $search, and $orderBy. */ displayName?: NullableOption; /** * true if the device complies with Mobile Device Management (MDM) policies; otherwise, false. Read-only. This can only be * updated by Intune for any device OS type or by an approved MDM app for Windows OS devices. Supports $filter (eq, ne, - * NOT). + * not). */ isCompliant?: NullableOption; /** * true if the device is managed by a Mobile Device Management (MDM) app; otherwise, false. This can only be updated by - * Intune for any device OS type or by an approved MDM app for Windows OS devices. Supports $filter (eq, ne, NOT). + * Intune for any device OS type or by an approved MDM app for Windows OS devices. Supports $filter (eq, ne, not). */ isManaged?: NullableOption; - // Application identifier used to register device into MDM. Read-only. Supports $filter (eq, ne, NOT, startsWith). + // Application identifier used to register device into MDM. Read-only. Supports $filter (eq, ne, not, startsWith). mdmAppId?: NullableOption; /** * The last time at which the object was synced with the on-premises directory. The Timestamp type represents date and * time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is - * 2014-01-01T00:00:00Z Read-only. Supports $filter (eq, ne, NOT, ge, le, in). + * 2014-01-01T00:00:00Z Read-only. Supports $filter (eq, ne, not, ge, le, in). */ onPremisesLastSyncDateTime?: NullableOption; /** * true if this object is synced from an on-premises directory; false if this object was originally synced from an * on-premises directory but is no longer synced; null if this object has never been synced from an on-premises directory - * (default). Read-only. Supports $filter (eq, ne, NOT, in). + * (default). Read-only. Supports $filter (eq, ne, not, in, and eq on null values). */ onPremisesSyncEnabled?: NullableOption; - // The type of operating system on the device. Required. Supports $filter (eq, ne, NOT, ge, le, startsWith). + /** + * The type of operating system on the device. Required. Supports $filter (eq, ne, not, ge, le, startsWith, and eq on null + * values). + */ operatingSystem?: NullableOption; - // The version of the operating system on the device. Required. Supports $filter (eq, ne, NOT, ge, le, startsWith). + /** + * The version of the operating system on the device. Required. Supports $filter (eq, ne, not, ge, le, startsWith, and eq + * on null values). + */ operatingSystemVersion?: NullableOption; - // For internal use only. Not nullable. Supports $filter (eq, NOT, ge, le, startsWith). + // For internal use only. Not nullable. Supports $filter (eq, not, ge, le, startsWith). physicalIds?: string[]; // The profile type of the device. Possible values: RegisteredDevice (default), SecureVM, Printer, Shared, IoT. profileType?: NullableOption; @@ -5873,11 +5904,26 @@ export interface OrganizationalBrandingProperties extends Entity { * not larger than 1920 × 1080 pixels. A smaller image will reduce bandwidth requirements and make the page load faster. */ backgroundImage?: NullableOption; + /** + * A relative URL for the backgroundImage property that is combined with a CDN base URL from the cdnList to provide the + * version served by a CDN. Read-only. + */ + backgroundImageRelativeUrl?: NullableOption; /** * A banner version of your company logo that appears on the sign-in page. The allowed types are PNG or JPEG no larger * than 36 × 245 pixels. We recommend using a transparent image with no padding around the logo. */ bannerLogo?: NullableOption; + /** + * A relative url for the bannerLogo property that is combined with a CDN base URL from the cdnList to provide the + * read-only version served by a CDN. Read-only. + */ + bannerLogoRelativeUrl?: NullableOption; + /** + * A list of base URLs for all available CDN providers that are serving the assets of the current resource. Several CDN + * providers are used at the same time for high availability of read requests. Read-only. + */ + cdnList?: NullableOption; /** * Text that appears at the bottom of the sign-in box. You can use this to communicate additional information, such as the * phone number to your help desk or a legal statement. This text must be Unicode and not exceed 1024 characters. @@ -5889,6 +5935,11 @@ export interface OrganizationalBrandingProperties extends Entity { * KB in size. We recommend using a transparent image with no padding around the logo. */ squareLogo?: NullableOption; + /** + * A relative url for the squareLogo property that is combined with a CDN base URL from the cdnList to provide the version + * served by a CDN. Read-only. + */ + squareLogoRelativeUrl?: NullableOption; /** * String that shows as the hint in the username textbox on the sign-in screen. This text must be a Unicode, without links * or code, and can't exceed 64 characters. @@ -5904,54 +5955,69 @@ export interface OrganizationalBrandingLocalization extends OrganizationalBrandi export interface OrgContact extends DirectoryObject { // Postal addresses for this organizational contact. For now a contact can only have one physical address. addresses?: NullableOption; - // Name of the company that this organizational contact belong to. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + /** + * Name of the company that this organizational contact belong to. Supports $filter (eq, ne, not, ge, le, in, startsWith, + * and eq on null values). + */ companyName?: NullableOption; - // The name for the department in which the contact works. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + /** + * The name for the department in which the contact works. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq + * on null values). + */ department?: NullableOption; /** - * Display name for this organizational contact. Supports $filter (eq, ne, NOT, ge, le, in, startsWith), $search, and - * $orderBy. + * Display name for this organizational contact. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null + * values), $search, and $orderBy. */ displayName?: NullableOption; - // First name for this organizational contact. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + /** + * First name for this organizational contact. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null + * values). + */ givenName?: NullableOption; - // Job title for this organizational contact. Supports $filter (eq, ne, NOT, ge, le, in, startsWith). + /** + * Job title for this organizational contact. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null + * values). + */ jobTitle?: NullableOption; /** - * The SMTP address for the contact, for example, 'jeff@contoso.onmicrosoft.com'. Supports $filter (eq, ne, NOT, ge, le, - * in, startsWith). + * The SMTP address for the contact, for example, 'jeff@contoso.onmicrosoft.com'. Supports $filter (eq, ne, not, ge, le, + * in, startsWith, and eq on null values). */ mail?: NullableOption; /** * Email alias (portion of email address pre-pending the @ symbol) for this organizational contact. Supports $filter (eq, - * ne, NOT, ge, le, in, startsWith). + * ne, not, ge, le, in, startsWith, and eq on null values). */ mailNickname?: NullableOption; /** * Date and time when this organizational contact was last synchronized from on-premises AD. The Timestamp type represents * date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is - * 2014-01-01T00:00:00Z. Supports $filter (eq, ne, NOT, ge, le, in). + * 2014-01-01T00:00:00Z. Supports $filter (eq, ne, not, ge, le, in). */ onPremisesLastSyncDateTime?: NullableOption; - // List of any synchronization provisioning errors for this organizational contact. Supports $filter (eq, NOT). + // List of any synchronization provisioning errors for this organizational contact. Supports $filter (eq, not). onPremisesProvisioningErrors?: NullableOption; /** * true if this object is synced from an on-premises directory; false if this object was originally synced from an * on-premises directory but is no longer synced and now mastered in Exchange; null if this object has never been synced - * from an on-premises directory (default). + * from an on-premises directory (default). Supports $filter (eq, ne, not, in, and eq on null values). */ onPremisesSyncEnabled?: NullableOption; /** * List of phones for this organizational contact. Phone types can be mobile, business, and businessFax. Only one of each - * type can ever be present in the collection. Supports $filter (eq, ne, NOT, in). + * type can ever be present in the collection. Supports $filter (eq, ne, not, in). */ phones?: NullableOption; /** * For example: 'SMTP: bob@contoso.com', 'smtp: bob@sales.contoso.com'. The any operator is required for filter - * expressions on multi-valued properties. Supports $filter (eq, NOT, ge, le, startsWith). + * expressions on multi-valued properties. Supports $filter (eq, not, ge, le, startsWith). */ proxyAddresses?: string[]; - // Last name for this organizational contact. Supports $filter (eq, ne, NOT, ge, le, in, startsWith) + /** + * Last name for this organizational contact. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null + * values) + */ surname?: NullableOption; /** * The contact's direct reports. (The users and contacts that have their manager property set to this contact.) Read-only. @@ -6088,7 +6154,7 @@ export interface UnifiedRoleDefinition extends Entity { export interface RoleManagement { // Read-only. Nullable. directory?: NullableOption; - // The RbacApplication for Entitlement Management + // Container for all entitlement management resources in Azure AD identity governance. entitlementManagement?: NullableOption; } export interface SubscribedSku extends Entity { @@ -6296,7 +6362,7 @@ export interface EducationAssignmentSettings extends Entity { export interface EducationClass extends Entity { // Class code used by the school to identify the class. classCode?: NullableOption; - // Course information for the class + // Course information for the class. course?: NullableOption; // Entity who created the class createdBy?: NullableOption; @@ -6333,6 +6399,11 @@ export interface EducationClass extends Entity { teachers?: NullableOption; } export interface EducationUser extends Entity { + /** + * Related records related to the user. Possible relationships are parent, relative, aide, doctor, guardian, child, other, + * unknownFutureValue + */ + relatedContacts?: NullableOption; // True if the account is enabled; otherwise, false. This property is required when a user is created. Supports $filter. accountEnabled?: NullableOption; // The licenses that are assigned to the user. Not nullable. @@ -7895,11 +7966,17 @@ export interface ApprovalStage extends Entity { } export interface EntitlementManagement extends Entity { accessPackageAssignmentApprovals?: NullableOption; + // Access packages. accessPackages?: NullableOption; + // Access package assignment requests. assignmentRequests?: NullableOption; + // Access package assignments. assignments?: NullableOption; + // Access package catalogs. catalogs?: NullableOption; + // Connected organizations. connectedOrganizations?: NullableOption; + // Entitlement management settings. settings?: NullableOption; } export interface AccessPackage extends Entity { @@ -7919,6 +7996,7 @@ export interface AccessPackage extends Entity { * midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. */ modifiedDateTime?: NullableOption; + // Read-only. Nullable. catalog?: NullableOption; } export interface AccessPackageAssignmentRequest extends Entity { @@ -7929,13 +8007,19 @@ export interface AccessPackageAssignmentRequest extends Entity { */ createdDateTime?: NullableOption; /** - * One of UserAdd, UserRemove, AdminAdd, AdminRemove or SystemRemove. A request from the user themselves would have - * requestType of UserAdd or UserRemove. Read-only. + * The type of the request. The possible values are: notSpecified, userAdd, userUpdate, userRemove, adminAdd, adminUpdate, + * adminRemove, systemAdd, systemUpdate, systemRemove, onBehalfAdd, unknownFutureValue. A request from the user themselves + * would have requestType of UserAdd or UserRemove. This property cannot be changed once set. */ requestType?: NullableOption; - // The range of dates that access is to be assigned to the requestor. Read-only. + // The range of dates that access is to be assigned to the requestor. This property cannot be changed once set. schedule?: NullableOption; + /** + * The state of the request. The possible values are: submitted, pendingApproval, delivering, delivered, deliveryFailed, + * denied, scheduled, canceled, partiallyDelivered, unknownFutureValue. Read-only. + */ state?: NullableOption; + // More information on the request processing status. Read-only. status?: NullableOption; /** * The access package associated with the accessPackageAssignmentRequest. An access package defines the collections of @@ -7943,6 +8027,11 @@ export interface AccessPackageAssignmentRequest extends Entity { * Supports $expand. */ accessPackage?: NullableOption; + /** + * For a requestType of UserAdd or AdminAdd, this is an access package assignment requested to be created. For a + * requestType of UserRemove, AdminRemove or SystemRemove, this has the id property of an existing assignment to be + * removed. Supports $expand. + */ assignment?: NullableOption; // The subject who requested or, if a direct assignment, was assigned. Read-only. Nullable. Supports $expand. requestor?: NullableOption; @@ -7950,12 +8039,20 @@ export interface AccessPackageAssignmentRequest extends Entity { export interface AccessPackageAssignment extends Entity { /** * The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, - * midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z + * midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. */ expiredDateTime?: NullableOption; // When the access assignment is to be in place. Read-only. schedule?: NullableOption; + /** + * The state of the access package assignment. The possible values are: delivering, partiallyDelivered, delivered, + * expired, deliveryFailed, unknownFutureValue. Read-only. + */ state?: NullableOption; + /** + * More information about the assignment lifecycle. Possible values include Delivering, Delivered, + * NearExpiry1DayNotificationTriggered, or ExpiredNotificationTriggered. Read-only. + */ status?: NullableOption; // Read-only. Nullable. accessPackage?: NullableOption; @@ -7963,7 +8060,10 @@ export interface AccessPackageAssignment extends Entity { target?: NullableOption; } export interface AccessPackageCatalog extends Entity { - // One of UserManaged or ServiceDefault. + /** + * Whether the catalog is created by a user or entitlement management. The possible values are: userManaged, + * serviceDefault, serviceManaged, unknownFutureValue. + */ catalogType?: NullableOption; /** * The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, @@ -7981,6 +8081,10 @@ export interface AccessPackageCatalog extends Entity { * midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. */ modifiedDateTime?: NullableOption; + /** + * Has the value published if the access packages are available for management. The possible values are: unpublished, + * published, unknownFutureValue. + */ state?: NullableOption; // The access packages in this catalog. Read-only. Nullable. accessPackages?: NullableOption; @@ -7995,6 +8099,10 @@ export interface ConnectedOrganization extends Entity { description?: NullableOption; // The display name of the connected organization. displayName?: NullableOption; + /** + * The identity sources in this connected organization, one of azureActiveDirectoryTenant, domainIdentitySource or + * externalDomainFederation. Nullable. + */ identitySources?: NullableOption; /** * The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, @@ -8003,7 +8111,8 @@ export interface ConnectedOrganization extends Entity { modifiedDateTime?: NullableOption; /** * The state of a connected organization defines whether assignment policies with requestor scope type - * AllConfiguredConnectedOrganizationSubjects are applicable or not. Possible values are: configured, proposed. + * AllConfiguredConnectedOrganizationSubjects are applicable or not. The possible values are: configured, proposed, + * unknownFutureValue. */ state?: NullableOption; // Nullable. @@ -8012,8 +8121,15 @@ export interface ConnectedOrganization extends Entity { internalSponsors?: NullableOption; } export interface EntitlementManagementSettings extends Entity { + /** + * If externalUserLifecycleAction is blockSignInAndDelete, the duration, typically a number of days, after an external + * user is blocked from sign in before their account is deleted. + */ durationUntilExternalUserDeletedAfterBlocked?: NullableOption; - // One of None, BlockSignIn, or BlockSignInAndDelete. + /** + * Automatic action that the service should take when an external user's last access package assignment is removed. The + * possible values are: none, blockSignIn, blockSignInAndDelete, unknownFutureValue. + */ externalUserLifecycleAction?: NullableOption; } // tslint:disable-next-line: interface-name @@ -8117,9 +8233,14 @@ export interface AccessPackageSubject extends Entity { email?: NullableOption; // The object identifier of the subject. null if the subject is not yet a user in the tenant. objectId?: NullableOption; + /** + * A string representation of the principal's security identifier, if known, or null if the subject does not have a + * security identifier. + */ onPremisesSecurityIdentifier?: NullableOption; // The principal name, if known, of the subject. principalName?: NullableOption; + // The resource type of the subject. The possible values are: notSpecified, user, servicePrincipal, unknownFutureValue. subjectType?: NullableOption; // The connected organization of the subject. Read-only. Nullable. connectedOrganization?: NullableOption; @@ -13092,7 +13213,7 @@ export interface ChatMessage extends Entity { etag?: NullableOption; /** * Read-only. If present, represents details of an event that happened in a chat, a channel, or a team, for example, - * members were added, and so on. For event messages, the messageType property will be set to systemEventMessage. + * adding new members. For event messages, the messageType property will be set to systemEventMessage. */ eventDetail?: NullableOption; // Details of the sender of the chat message. Can only be set during migration. @@ -14081,25 +14202,25 @@ export interface AuthenticationMethodsRegistrationCampaign { // Users and groups of users that are prompted to set up the authentication method. includeTargets?: AuthenticationMethodsRegistrationCampaignIncludeTarget[]; /** - * Specifies the number of days that the user sees a prompt again if they select 'Not now' and snoozes the prompt. Minimum - * 0 days. Maximum: 14 days. If the value is '0' – The user is prompted during every MFA attempt. + * Specifies the number of days that the user sees a prompt again if they select 'Not now' and snoozes the prompt. + * Minimum: 0 days. Maximum: 14 days. If the value is '0', the user is prompted during every MFA attempt. */ snoozeDurationInDays?: number; /** * Enable or disable the feature. Possible values are: default, enabled, disabled, unknownFutureValue. The default value - * is used when the configuration hasn't been explicitly set and uses the default behavior of Azure AD for the setting. - * The default value is disabled. + * is used when the configuration hasn't been explicitly set and uses the default behavior of Azure Active Directory for + * the setting. The default value is disabled. */ state?: AdvancedConfigState; } export interface ExcludeTarget { - // The object identifier of an Azure AD user or group. + // The object identifier of an Azure Active Directory user or group. id?: string; // The type of the authentication method target. Possible values are: user, group, unknownFutureValue. targetType?: AuthenticationMethodTargetType; } export interface AuthenticationMethodsRegistrationCampaignIncludeTarget { - // The object identifier of an Azure AD user or group. + // The object identifier of an Azure Active Directory user or group. id?: string; // The authentication method that the user is prompted to register. The value must be microsoftAuthenticator. targetedAuthenticationMethod?: NullableOption; @@ -14115,7 +14236,7 @@ export interface Fido2KeyRestrictions { isEnforced?: NullableOption; } export interface RegistrationEnforcement { - // Run campaigns to remind users to setup targeted authentication methods. + // Run campaigns to remind users to set up targeted authentication methods. authenticationMethodsRegistrationCampaign?: NullableOption; } export interface DataSubject { @@ -14749,6 +14870,21 @@ export interface EducationTerm { // Start of the term. startDate?: NullableOption; } +export interface RelatedContact { + // Indicates whether the user has been consented to access student data. + accessConsent?: NullableOption; + // Name of the contact. Required. + displayName?: string; + // Primary email address of the contact. + emailAddress?: string; + // Mobile phone number of the contact. + mobilePhone?: NullableOption; + /** + * Relationship to the user. Possible values are parent, relative, aide, doctor, guardian, child, other, + * unknownFutureValue. + */ + relationship?: ContactRelationship; +} export interface PhysicalAddress { // The city. city?: NullableOption; @@ -15256,10 +15392,12 @@ export interface Attendee extends AttendeeBase { export interface ResponseStatus { /** * The response type. Possible values are: none, organizer, tentativelyAccepted, accepted, declined, notResponded.To - * differentiate between none and notResponded: as an example, if attendee Alex hasn't responded to a meeting request, - * getting Alex' response status for that event in Alex' calendar returns notResponded. Getting Alex' response from the - * calendar of any other attendee or the organizer's returns none. Getting the organizer's response for the event in - * anybody's calendar also returns none. + * differentiate between none and notResponded: none – from organizer's perspective. This value is used when the status of + * an attendee/participant is reported to the organizer of a meeting. notResponded – from attendde's perspective. + * Indicates the attendee has not responded to the meeting request. Clients can treat notResponded == none. As an example, + * if attendee Alex hasn't responded to a meeting request, getting Alex' response status for that event in Alex' calendar + * returns notResponded. Getting Alex' response from the calendar of any other attendee or the organizer's returns none. + * Getting the organizer's response for the event in anybody's calendar also returns none. */ response?: NullableOption; /** @@ -16005,11 +16143,15 @@ export interface StoragePlanInformation { upgradeAvailable?: NullableOption; } export interface SharePointIdentity extends Identity { + // The sign in name of the SharePoint identity. loginName?: NullableOption; } export interface SharePointIdentitySet extends IdentitySet { + // The group associated with this action. Optional. group?: NullableOption; + // The SharePoint group associated with this action. Optional. siteGroup?: NullableOption; + // The SharePoint user associated with this action. Optional. siteUser?: NullableOption; } export interface SharingInvitation { @@ -16373,8 +16515,11 @@ export interface IPv6CidrRange extends IpRange { cidrAddress?: string; } export interface AccessPackageAssignmentRequestRequirements { + // Indicates whether the requestor is allowed to set a custom schedule. allowCustomAssignmentSchedule?: NullableOption; + // Indicates whether a request to add must be approved by an approver. isApprovalRequiredForAdd?: NullableOption; + // Indicates whether a request to update must be approved by an approver. isApprovalRequiredForUpdate?: NullableOption; // The description of the policy that the user is trying to request access using. policyDescription?: NullableOption; @@ -16389,15 +16534,22 @@ export interface AccessPackageAssignmentRequestRequirements { schedule?: NullableOption; } export interface EntitlementManagementSchedule { + // When the access should expire. expiration?: NullableOption; + // For recurring access. Not used at present. recurrence?: NullableOption; + /** + * The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, + * midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. + */ startDateTime?: NullableOption; } // tslint:disable-next-line: no-empty-interface export interface SubjectSet {} export interface ConnectedOrganizationMembers extends SubjectSet { + // The ID of the connected organization in entitlement management. connectedOrganizationId?: NullableOption; - // The name of the connected organization. Read only. + // The name of the connected organization. description?: NullableOption; } export interface ConnectionInfo { @@ -16416,7 +16568,10 @@ export interface ExpirationPattern { * Jan 1, 2014 is 2014-01-01T00:00:00Z. */ endDateTime?: NullableOption; - // The requestor's desired expiration pattern type. + /** + * The requestor's desired expiration pattern type. The possible values are: notSpecified, noExpiration, afterDateTime, + * afterDuration. + */ type?: NullableOption; } // tslint:disable-next-line: no-empty-interface @@ -16424,6 +16579,7 @@ export interface ExternalSponsors extends SubjectSet {} export interface GroupMembers extends SubjectSet { // The name of the group in Azure AD. Read only. description?: NullableOption; + // The ID of the group in Azure AD. groupId?: NullableOption; } // tslint:disable-next-line: interface-name no-empty-interface @@ -16437,12 +16593,15 @@ export interface RequestorManager extends SubjectSet { managerLevel?: NullableOption; } export interface SingleServicePrincipal extends SubjectSet { + // Description of this service principal. description?: NullableOption; + // ID of the servicePrincipal. servicePrincipalId?: NullableOption; } export interface SingleUser extends SubjectSet { // The name of the user in Azure AD. Read only. description?: NullableOption; + // The ID of the user in Azure AD. userId?: NullableOption; } // tslint:disable-next-line: interface-name no-empty-interface @@ -19279,7 +19438,7 @@ export interface MembersAddedEventMessageDetail extends EventMessageDetail { initiator?: NullableOption; // List of members added. members?: NullableOption; - // The timestamp denoting how far back a conversation's history is shared with the conversation members. + // The timestamp that denotes how far back a conversation's history is shared with the conversation members. visibleHistoryStartDateTime?: NullableOption; } export interface MembersDeletedEventMessageDetail extends EventMessageDetail { @@ -19497,373 +19656,6 @@ export interface WorkforceIntegrationEncryption { secret?: NullableOption; } -export namespace Ediscovery { - type AdditionalDataOptions = "allVersions" | "linkedFiles" | "unknownFutureValue"; - type CaseAction = - | "contentExport" - | "applyTags" - | "convertToPdf" - | "index" - | "estimateStatistics" - | "addToReviewSet" - | "unknownFutureValue"; - type CaseOperationStatus = "notStarted" | "submissionFailed" | "running" | "succeeded" | "partiallySucceeded" | "failed"; - type CaseStatus = "unknown" | "active" | "pendingDelete" | "closing" | "closed" | "closedWithError"; - type ChildSelectability = "One" | "Many"; - type DataSourceContainerStatus = "Active" | "Released" | "UnknownFutureValue"; - type DataSourceScopes = - | "none" - | "allTenantMailboxes" - | "allTenantSites" - | "allCaseCustodians" - | "allCaseNoncustodialDataSources" - | "unknownFutureValue"; - type ExportFileStructure = "none" | "directory" | "pst" | "unknownFutureValue"; - type ExportOptions = "originalFiles" | "text" | "pdfReplacement" | "fileInfo" | "tags" | "unknownFutureValue"; - type LegalHoldStatus = "Pending" | "Error" | "Success" | "UnknownFutureValue"; - type SourceType = "mailbox" | "site"; - interface Ediscoveryroot extends microsoftgraph.Entity { - cases?: NullableOption; - } - interface CaseOperation extends microsoftgraph.Entity { - /** - * The type of action the operation represents. Possible values are: - * addToReviewSet,applyTags,contentExport,convertToPdf,estimateStatistics - */ - action?: NullableOption; - // The date and time the operation was completed. - completedDateTime?: NullableOption; - // The user that created the operation. - createdBy?: NullableOption; - // The date and time the operation was created. - createdDateTime?: NullableOption; - // The progress of the operation. - percentProgress?: NullableOption; - // Contains success and failure-specific result information. - resultInfo?: NullableOption; - /** - * The status of the case operation. Possible values are: notStarted, submissionFailed, running, succeeded, - * partiallySucceeded, failed. - */ - status?: NullableOption; - } - interface AddToReviewSetOperation extends CaseOperation { - // The review set to which items matching the source collection query are added to. - reviewSet?: NullableOption; - // The sourceCollection that items are being added from. - sourceCollection?: NullableOption; - } - interface ReviewSet extends microsoftgraph.Entity { - // The user who created the review set. Read-only. - createdBy?: NullableOption; - /** - * The datetime when the review set was created. The Timestamp type represents date and time information using ISO 8601 - * format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. - */ - createdDateTime?: NullableOption; - // The review set name. The name is unique with a maximum limit of 64 characters. - displayName?: NullableOption; - // Read-only. Nullable. - queries?: NullableOption; - } - interface SourceCollection extends microsoftgraph.Entity { - /** - * The query string in KQL (Keyword Query Language) query. For details, see Keyword queries and search conditions for - * Content Search and eDiscovery. You can refine searches by using fields paired with values; for example, - * subject:'Quarterly Financials' AND Date>=06/01/2016 AND Date<=07/01/2016. - */ - contentQuery?: NullableOption; - // The user who created the sourceCollection. - createdBy?: NullableOption; - // The date and time the sourceCollection was created. - createdDateTime?: NullableOption; - /** - * When specified, the collection will span across a service for an entire workload. Possible values are: none, - * allTenantMailboxes, allTenantSites, allCaseCustodians, allCaseNoncustodialDataSources. - */ - dataSourceScopes?: NullableOption; - // The description of the sourceCollection. - description?: NullableOption; - // The display name of the sourceCollection. - displayName?: NullableOption; - // The last user who modified the sourceCollection. - lastModifiedBy?: NullableOption; - // The last date and time the sourceCollection was modified. - lastModifiedDateTime?: NullableOption; - // Adds an additional source to the sourceCollection. - additionalSources?: NullableOption; - // Adds the results of the sourceCollection to the specified reviewSet. - addToReviewSetOperation?: NullableOption; - // Custodian sources that are included in the sourceCollection. - custodianSources?: NullableOption; - // The last estimate operation associated with the sourceCollection. - lastEstimateStatisticsOperation?: NullableOption; - // noncustodialDataSource sources that are included in the sourceCollection - noncustodialSources?: NullableOption; - } - interface Case extends microsoftgraph.Entity { - // The user who closed the case. - closedBy?: NullableOption; - /** - * The date and time when the case was closed. The Timestamp type represents date and time information using ISO 8601 - * format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z - */ - closedDateTime?: NullableOption; - /** - * The date and time when the entity was created. The Timestamp type represents date and time information using ISO 8601 - * format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z - */ - createdDateTime?: NullableOption; - // The case description. - description?: NullableOption; - // The case name. - displayName?: NullableOption; - // The external case number for customer reference. - externalId?: NullableOption; - // The last user who modified the entity. - lastModifiedBy?: NullableOption; - /** - * The latest date and time when the case was modified. The Timestamp type represents date and time information using ISO - * 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z - */ - lastModifiedDateTime?: NullableOption; - /** - * The case status. Possible values are unknown, active, pendingDelete, closing, closed, and closedWithError. For details, - * see the following table. - */ - status?: NullableOption; - // Returns a list of case custodian objects for this case. Nullable. - custodians?: NullableOption; - // Returns a list of case legalHold objects for this case. Nullable. - legalHolds?: NullableOption; - // Returns a list of case noncustodialDataSource objects for this case. Nullable. - noncustodialDataSources?: NullableOption; - // Returns a list of case operation objects for this case. Nullable. - operations?: NullableOption; - // Returns a list of reviewSet objects in the case. Read-only. Nullable. - reviewSets?: NullableOption; - settings?: NullableOption; - // Returns a list of sourceCollection objects associated with this case. - sourceCollections?: NullableOption; - // Returns a list of tag objects associated to this case. - tags?: NullableOption; - } - interface DataSourceContainer extends microsoftgraph.Entity { - // Created date and time of the dataSourceContainer entity. - createdDateTime?: NullableOption; - // Display name of the dataSourceContainer entity. - displayName?: NullableOption; - // Last modified date and time of the dataSourceContainer. - lastModifiedDateTime?: NullableOption; - // Date and time that the dataSourceContainer was released from the case. - releasedDateTime?: NullableOption; - // Latest status of the dataSourceContainer. Possible values are: Active, Released. - status?: NullableOption; - lastIndexOperation?: NullableOption; - } - interface Custodian extends DataSourceContainer { - // Date and time the custodian acknowledged a hold notification. - acknowledgedDateTime?: NullableOption; - // Identifies whether a custodian's sources were placed on hold during creation. - applyHoldToSources?: NullableOption; - // Email address of the custodian. - email?: string; - // Data source entity for SharePoint sites associated with the custodian. - siteSources?: NullableOption; - // Data source entity for groups associated with the custodian. - unifiedGroupSources?: NullableOption; - // Data source entity for a the custodian. This is the container for a custodian's mailbox and OneDrive for Business site. - userSources?: NullableOption; - } - interface LegalHold extends microsoftgraph.Entity { - /** - * KQL query that specifies content to be held in the specified locations. To learn more, see Keyword queries and search - * conditions for Content Search and eDiscovery. To hold all content in the specified locations, leave contentQuery blank. - */ - contentQuery?: NullableOption; - // The user who created the legal hold. - createdBy?: NullableOption; - // The date and time the legal hold was created. - createdDateTime?: NullableOption; - // The legal hold description. - description?: NullableOption; - // The display name of the legal hold. - displayName?: NullableOption; - // Lists any errors that happened while placing the hold. - errors?: NullableOption; - // Indicates whether the hold is enabled and actively holding content. - isEnabled?: NullableOption; - // the user who last modified the legal hold. - lastModifiedBy?: NullableOption; - // The date and time the legal hold was last modified. - lastModifiedDateTime?: NullableOption; - // The status of the legal hold. Possible values are: Pending, Error, Success, UnknownFutureValue. - status?: NullableOption; - // Data source entity for SharePoint sites associated with the legal hold. - siteSources?: NullableOption; - // Data source entity for a the legal hold. This is the container for a mailbox and OneDrive for Business site. - userSources?: NullableOption; - } - interface NoncustodialDataSource extends DataSourceContainer { - // Indicates if hold is applied to non-custodial data source (such as mailbox or site). - applyHoldToSource?: NullableOption; - // User source or SharePoint site data source as non-custodial data source. - dataSource?: NullableOption; - } - interface CaseSettings extends microsoftgraph.Entity { - // The OCR (Optical Character Recognition) settings for the case. - ocr?: NullableOption; - // The redundancy (near duplicate and email threading) detection settings for the case. - redundancyDetection?: NullableOption; - // The Topic Modeling (Themes) settings for the case. - topicModeling?: NullableOption; - } - interface Tag extends microsoftgraph.Entity { - /** - * Indicates whether a single or multiple child tags can be associated with a document. Possible values are: One, Many. - * This value controls whether the UX presents the tags as checkboxes or a radio button group. - */ - childSelectability?: NullableOption; - // The user who created the tag. - createdBy?: NullableOption; - // The description for the tag. - description?: NullableOption; - // Display name of the tag. - displayName?: NullableOption; - // The date and time the tag was last modified. - lastModifiedDateTime?: NullableOption; - // Returns the tags that are a child of a tag. - childTags?: NullableOption; - // Returns the parent tag of the specified tag. - parent?: NullableOption; - } - interface CaseExportOperation extends CaseOperation { - /** - * The name of the Azure storage location where the export will be stored. This only applies to exports stored in your own - * Azure storage location. - */ - azureBlobContainer?: NullableOption; - // The SAS token for the Azure storage location. This only applies to exports stored in your own Azure storage location. - azureBlobToken?: NullableOption; - // The description provided for the export. - description?: NullableOption; - /** - * The options provided for the export. For more details, see reviewSet: export. Possible values are: originalFiles, text, - * pdfReplacement, fileInfo, tags. - */ - exportOptions?: NullableOption; - /** - * The options provided that specify the structure of the export. For more details, see reviewSet: export. Possible values - * are: none, directory, pst. - */ - exportStructure?: NullableOption; - outputFolderId?: NullableOption; - // The name provided for the export. - outputName?: NullableOption; - // The review set the content is being exported from. - reviewSet?: NullableOption; - } -// tslint:disable-next-line: no-empty-interface - interface CaseIndexOperation extends CaseOperation {} - interface DataSource extends microsoftgraph.Entity { - // The user who created the dataSource. - createdBy?: NullableOption; - // The date and time the dataSource was created. - createdDateTime?: NullableOption; - // The display name of the dataSource. This will be the name of the SharePoint site. - displayName?: NullableOption; - } - interface SiteSource extends DataSource { - // The SharePoint site associated with the siteSource. - site?: microsoftgraph.Site; - } - interface UnifiedGroupSource extends DataSource { - // Specifies which sources are included in this group. Possible values are: mailbox, site. - includedSources?: NullableOption; - // The group associated with the unifiedGroupSource. - group?: microsoftgraph.Group; - } - interface UserSource extends DataSource { - // Email address of the user's mailbox. - email?: string; - // Specifies which sources are included in this group. Possible values are: mailbox, site. - includedSources?: NullableOption; - } - interface EstimateStatisticsOperation extends CaseOperation { - // The estimated count of items for the sourceCollection that matched the content query. - indexedItemCount?: NullableOption; - // The estimated size of items for the sourceCollection that matched the content query. - indexedItemsSize?: NullableOption; - // The number of mailboxes that had search hits. - mailboxCount?: NullableOption; - // The number of mailboxes that had search hits. - siteCount?: NullableOption; - // The estimated count of unindexed items for the collection. - unindexedItemCount?: NullableOption; - // The estimated size of unindexed items for the collection. - unindexedItemsSize?: NullableOption; - // eDiscovery collection, commonly known as a search. - sourceCollection?: NullableOption; - } - interface ReviewSetQuery extends microsoftgraph.Entity { - // The user who created the query. - createdBy?: NullableOption; - /** - * The time and date when the query was created. The Timestamp type represents date and time information using ISO 8601 - * format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z - */ - createdDateTime?: NullableOption; - // The name of the query. - displayName?: NullableOption; - // The user who last modified the query. - lastModifiedBy?: NullableOption; - /** - * The date and time the query was last modified. The Timestamp type represents date and time information using ISO 8601 - * format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z - */ - lastModifiedDateTime?: NullableOption; - /** - * The query string in KQL (Keyword Query Language) query. For details, see Document metadata fields in Advanced - * eDiscovery. This field maps directly to the keywords condition. You can refine searches by using fields listed in the - * searchable field name paired with values; for example, subject:'Quarterly Financials' AND Date>=06/01/2016 AND - * Date<=07/01/2016. - */ - query?: NullableOption; - } -// tslint:disable-next-line: no-empty-interface - interface TagOperation extends CaseOperation {} - interface OcrSettings { - // Indicates whether or not OCR is enabled for the case. - isEnabled?: NullableOption; - // Maximum image size that will be processed in KB). - maxImageSize?: NullableOption; - /** - * The timeout duration for the OCR engine. A longer timeout may increase success of OCR, but may add to the total - * processing time. - */ - timeout?: NullableOption; - } - interface RedundancyDetectionSettings { - // Indicates whether email threading and near duplicate detection are enabled. - isEnabled?: NullableOption; - // See Minimum/maximum number of words to learn more. - maxWords?: NullableOption; - // See Minimum/maximum number of words to learn more. - minWords?: NullableOption; - // See Document and email similarity threshold to learn more. - similarityThreshold?: NullableOption; - } - interface TopicModelingSettings { - // To learn more, see Adjust maximum number of themes dynamically. - dynamicallyAdjustTopicCount?: NullableOption; - // To learn more, see Include numbers in themes. - ignoreNumbers?: NullableOption; - // Indicates whether themes is enabled for the case. - isEnabled?: NullableOption; - // To learn more, see Maximum number of themes. - topicCount?: NullableOption; - } -} export namespace TermStore { type RelationType = "pin" | "reuse" | "unknownFutureValue"; type TermGroupScope = "global" | "system" | "siteCollection" | "unknownFutureValue";