diff --git a/lib/services/graphManagement/lib/models/aDGroup.js b/lib/services/graphManagement/lib/models/aDGroup.js index cf18d4c62a..4b860380aa 100644 --- a/lib/services/graphManagement/lib/models/aDGroup.js +++ b/lib/services/graphManagement/lib/models/aDGroup.js @@ -20,13 +20,14 @@ const models = require('./index'); class ADGroup extends models['DirectoryObject'] { /** * Create a ADGroup. - * @member {string} [displayName] The display name of the group. - * @member {boolean} [mailEnabled] Whether the group is mail-enabled. Must be - * false. This is because only pure security groups can be created using the - * Graph API. - * @member {string} [mailNickname] The mail alias for the group. - * @member {boolean} [securityEnabled] Whether the group is security-enable. - * @member {string} [mail] The primary email address of the group. + * @property {string} [displayName] The display name of the group. + * @property {boolean} [mailEnabled] Whether the group is mail-enabled. Must + * be false. This is because only pure security groups can be created using + * the Graph API. + * @property {string} [mailNickname] The mail alias for the group. + * @property {boolean} [securityEnabled] Whether the group is + * security-enable. + * @property {string} [mail] The primary email address of the group. */ constructor() { super(); diff --git a/lib/services/graphManagement/lib/models/addOwnerParameters.js b/lib/services/graphManagement/lib/models/addOwnerParameters.js index 58e49cb1d4..5a82a7a606 100644 --- a/lib/services/graphManagement/lib/models/addOwnerParameters.js +++ b/lib/services/graphManagement/lib/models/addOwnerParameters.js @@ -17,7 +17,7 @@ class AddOwnerParameters { /** * Create a AddOwnerParameters. - * @member {string} url A owner object URL, such as + * @property {string} url A owner object URL, such as * "https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd", * where "0b1f9851-1bf0-433f-aec3-cb9272f093dc" is the tenantId and * "f260bbc4-c254-447b-94cf-293b5ec434dd" is the objectId of the owner (user, diff --git a/lib/services/graphManagement/lib/models/appRole.js b/lib/services/graphManagement/lib/models/appRole.js index c440fb20e3..73286258de 100644 --- a/lib/services/graphManagement/lib/models/appRole.js +++ b/lib/services/graphManagement/lib/models/appRole.js @@ -16,21 +16,21 @@ class AppRole { /** * Create a AppRole. - * @member {string} [id] Unique role identifier inside the appRoles + * @property {string} [id] Unique role identifier inside the appRoles * collection. - * @member {array} [allowedMemberTypes] Specifies whether this app role + * @property {array} [allowedMemberTypes] Specifies whether this app role * definition can be assigned to users and groups by setting to 'User', or to * other applications (that are accessing this application in daemon service * scenarios) by setting to 'Application', or to both. - * @member {string} [description] Permission help text that appears in the + * @property {string} [description] Permission help text that appears in the * admin app assignment and consent experiences. - * @member {string} [displayName] Display name for the permission that + * @property {string} [displayName] Display name for the permission that * appears in the admin consent and app assignment experiences. - * @member {boolean} [isEnabled] When creating or updating a role definition, - * this must be set to true (which is the default). To delete a role, this - * must first be set to false. At that point, in a subsequent call, this role - * may be removed. - * @member {string} [value] Specifies the value of the roles claim that the + * @property {boolean} [isEnabled] When creating or updating a role + * definition, this must be set to true (which is the default). To delete a + * role, this must first be set to false. At that point, in a subsequent + * call, this role may be removed. + * @property {string} [value] Specifies the value of the roles claim that the * application should expect in the authentication and access tokens. */ constructor() { diff --git a/lib/services/graphManagement/lib/models/application.js b/lib/services/graphManagement/lib/models/application.js index cde51e7052..75aad9291e 100644 --- a/lib/services/graphManagement/lib/models/application.js +++ b/lib/services/graphManagement/lib/models/application.js @@ -20,25 +20,29 @@ const models = require('./index'); class Application extends models['DirectoryObject'] { /** * Create a Application. - * @member {string} [appId] The application ID. - * @member {array} [appRoles] The collection of application roles that an + * @property {string} [appId] The application ID. + * @property {array} [appRoles] The collection of application roles that an * application may declare. These roles can be assigned to users, groups or * service principals. - * @member {array} [appPermissions] The application permissions. - * @member {boolean} [availableToOtherTenants] Whether the application is be - * available to other tenants. - * @member {string} [displayName] The display name of the application. - * @member {array} [identifierUris] A collection of URIs for the application. - * @member {array} [replyUrls] A collection of reply URLs for the + * @property {array} [appPermissions] The application permissions. + * @property {boolean} [availableToOtherTenants] Whether the application is + * be available to other tenants. + * @property {string} [displayName] The display name of the application. + * @property {array} [identifierUris] A collection of URIs for the * application. - * @member {string} [homepage] The home page of the application. - * @member {boolean} [oauth2AllowImplicitFlow] Whether to allow implicit + * @property {array} [replyUrls] A collection of reply URLs for the + * application. + * @property {string} [homepage] The home page of the application. + * @property {boolean} [oauth2AllowImplicitFlow] Whether to allow implicit * grant flow for OAuth2 - * @member {array} [requiredResourceAccess] Specifies resources that this + * @property {array} [requiredResourceAccess] Specifies resources that this * application requires access to and the set of OAuth permission scopes and * application roles that it needs under each of those resources. This * pre-configuration of required resource access drives the consent * experience. + * @property {array} [keyCredentials] A collection of KeyCredential objects. + * @property {array} [passwordCredentials] A collection of PasswordCredential + * objects */ constructor() { super(); @@ -205,6 +209,60 @@ class Application extends models['DirectoryObject'] { } } } + }, + keyCredentials: { + required: false, + serializedName: 'keyCredentials', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'KeyCredentialElementType', + type: { + name: 'Composite', + additionalProperties: { + type: { + name: 'Dictionary', + value: { + required: false, + serializedName: 'ObjectElementType', + type: { + name: 'Object' + } + } + } + }, + className: 'KeyCredential' + } + } + } + }, + passwordCredentials: { + required: false, + serializedName: 'passwordCredentials', + type: { + name: 'Sequence', + element: { + required: false, + serializedName: 'PasswordCredentialElementType', + type: { + name: 'Composite', + additionalProperties: { + type: { + name: 'Dictionary', + value: { + required: false, + serializedName: 'ObjectElementType', + type: { + name: 'Object' + } + } + } + }, + className: 'PasswordCredential' + } + } + } } } } diff --git a/lib/services/graphManagement/lib/models/applicationCreateParameters.js b/lib/services/graphManagement/lib/models/applicationCreateParameters.js index 9ad3b2398f..6d651b41b7 100644 --- a/lib/services/graphManagement/lib/models/applicationCreateParameters.js +++ b/lib/services/graphManagement/lib/models/applicationCreateParameters.js @@ -17,22 +17,22 @@ class ApplicationCreateParameters { /** * Create a ApplicationCreateParameters. - * @member {array} [appRoles] The collection of application roles that an + * @property {array} [appRoles] The collection of application roles that an * application may declare. These roles can be assigned to users, groups or * service principals. - * @member {boolean} availableToOtherTenants Whether the application is + * @property {boolean} availableToOtherTenants Whether the application is * available to other tenants. - * @member {string} displayName The display name of the application. - * @member {string} [homepage] The home page of the application. - * @member {array} identifierUris A collection of URIs for the application. - * @member {array} [replyUrls] A collection of reply URLs for the + * @property {string} displayName The display name of the application. + * @property {string} [homepage] The home page of the application. + * @property {array} identifierUris A collection of URIs for the application. + * @property {array} [replyUrls] A collection of reply URLs for the * application. - * @member {array} [keyCredentials] The list of KeyCredential objects. - * @member {array} [passwordCredentials] The list of PasswordCredential + * @property {array} [keyCredentials] The list of KeyCredential objects. + * @property {array} [passwordCredentials] The list of PasswordCredential * objects. - * @member {boolean} [oauth2AllowImplicitFlow] Whether to allow implicit + * @property {boolean} [oauth2AllowImplicitFlow] Whether to allow implicit * grant flow for OAuth2 - * @member {array} [requiredResourceAccess] Specifies resources that this + * @property {array} [requiredResourceAccess] Specifies resources that this * application requires access to and the set of OAuth permission scopes and * application roles that it needs under each of those resources. This * pre-configuration of required resource access drives the consent diff --git a/lib/services/graphManagement/lib/models/applicationListResult.js b/lib/services/graphManagement/lib/models/applicationListResult.js index b7ec05b49f..37ec0800ee 100644 --- a/lib/services/graphManagement/lib/models/applicationListResult.js +++ b/lib/services/graphManagement/lib/models/applicationListResult.js @@ -16,7 +16,7 @@ class ApplicationListResult extends Array { /** * Create a ApplicationListResult. - * @member {string} [odatanextLink] The URL to get the next set of results. + * @property {string} [odatanextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/graphManagement/lib/models/applicationUpdateParameters.js b/lib/services/graphManagement/lib/models/applicationUpdateParameters.js index 31ac3cb8c4..db801f8238 100644 --- a/lib/services/graphManagement/lib/models/applicationUpdateParameters.js +++ b/lib/services/graphManagement/lib/models/applicationUpdateParameters.js @@ -17,22 +17,23 @@ class ApplicationUpdateParameters { /** * Create a ApplicationUpdateParameters. - * @member {array} [appRoles] The collection of application roles that an + * @property {array} [appRoles] The collection of application roles that an * application may declare. These roles can be assigned to users, groups or * service principals. - * @member {boolean} [availableToOtherTenants] Whether the application is + * @property {boolean} [availableToOtherTenants] Whether the application is * available to other tenants - * @member {string} [displayName] The display name of the application. - * @member {string} [homepage] The home page of the application. - * @member {array} [identifierUris] A collection of URIs for the application. - * @member {array} [replyUrls] A collection of reply URLs for the + * @property {string} [displayName] The display name of the application. + * @property {string} [homepage] The home page of the application. + * @property {array} [identifierUris] A collection of URIs for the * application. - * @member {array} [keyCredentials] The list of KeyCredential objects. - * @member {array} [passwordCredentials] The list of PasswordCredential + * @property {array} [replyUrls] A collection of reply URLs for the + * application. + * @property {array} [keyCredentials] The list of KeyCredential objects. + * @property {array} [passwordCredentials] The list of PasswordCredential * objects. - * @member {boolean} [oauth2AllowImplicitFlow] Whether to allow implicit + * @property {boolean} [oauth2AllowImplicitFlow] Whether to allow implicit * grant flow for OAuth2 - * @member {array} [requiredResourceAccess] Specifies resources that this + * @property {array} [requiredResourceAccess] Specifies resources that this * application requires access to and the set of OAuth permission scopes and * application roles that it needs under each of those resources. This * pre-configuration of required resource access drives the consent diff --git a/lib/services/graphManagement/lib/models/checkGroupMembershipParameters.js b/lib/services/graphManagement/lib/models/checkGroupMembershipParameters.js index d0cf630d12..e831ed3c7d 100644 --- a/lib/services/graphManagement/lib/models/checkGroupMembershipParameters.js +++ b/lib/services/graphManagement/lib/models/checkGroupMembershipParameters.js @@ -17,8 +17,8 @@ class CheckGroupMembershipParameters { /** * Create a CheckGroupMembershipParameters. - * @member {string} groupId The object ID of the group to check. - * @member {string} memberId The object ID of the contact, group, user, or + * @property {string} groupId The object ID of the group to check. + * @property {string} memberId The object ID of the contact, group, user, or * service principal to check for membership in the specified group. */ constructor() { diff --git a/lib/services/graphManagement/lib/models/checkGroupMembershipResult.js b/lib/services/graphManagement/lib/models/checkGroupMembershipResult.js index a98312b9ff..b02f7ea336 100644 --- a/lib/services/graphManagement/lib/models/checkGroupMembershipResult.js +++ b/lib/services/graphManagement/lib/models/checkGroupMembershipResult.js @@ -17,7 +17,7 @@ class CheckGroupMembershipResult { /** * Create a CheckGroupMembershipResult. - * @member {boolean} [value] True if the specified user, group, contact, or + * @property {boolean} [value] True if the specified user, group, contact, or * service principal has either direct or transitive membership in the * specified group; otherwise, false. */ diff --git a/lib/services/graphManagement/lib/models/directoryObject.js b/lib/services/graphManagement/lib/models/directoryObject.js index e90c0ebad4..93011a4764 100644 --- a/lib/services/graphManagement/lib/models/directoryObject.js +++ b/lib/services/graphManagement/lib/models/directoryObject.js @@ -17,10 +17,10 @@ class DirectoryObject { /** * Create a DirectoryObject. - * @member {string} [objectId] The object ID. - * @member {date} [deletionTimestamp] The time at which the directory object - * was deleted. - * @member {string} objectType Polymorphic Discriminator + * @property {string} [objectId] The object ID. + * @property {date} [deletionTimestamp] The time at which the directory + * object was deleted. + * @property {string} objectType Polymorphic Discriminator */ constructor() { } diff --git a/lib/services/graphManagement/lib/models/directoryObjectListResult.js b/lib/services/graphManagement/lib/models/directoryObjectListResult.js index 25d5bfff6e..54846d976b 100644 --- a/lib/services/graphManagement/lib/models/directoryObjectListResult.js +++ b/lib/services/graphManagement/lib/models/directoryObjectListResult.js @@ -16,7 +16,7 @@ class DirectoryObjectListResult extends Array { /** * Create a DirectoryObjectListResult. - * @member {string} [odatanextLink] The URL to get the next set of results. + * @property {string} [odatanextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/graphManagement/lib/models/domain.js b/lib/services/graphManagement/lib/models/domain.js index c2465d0ca3..3f18264877 100644 --- a/lib/services/graphManagement/lib/models/domain.js +++ b/lib/services/graphManagement/lib/models/domain.js @@ -17,11 +17,12 @@ class Domain { /** * Create a Domain. - * @member {string} [authenticationType] the type of the authentication into - * the domain. - * @member {boolean} [isDefault] if this is the default domain in the tenant. - * @member {boolean} [isVerified] if this domain's ownership is verified. - * @member {string} name the domain name. + * @property {string} [authenticationType] the type of the authentication + * into the domain. + * @property {boolean} [isDefault] if this is the default domain in the + * tenant. + * @property {boolean} [isVerified] if this domain's ownership is verified. + * @property {string} name the domain name. */ constructor() { } diff --git a/lib/services/graphManagement/lib/models/getObjectsParameters.js b/lib/services/graphManagement/lib/models/getObjectsParameters.js index a05cfd7fed..63a38df4ab 100644 --- a/lib/services/graphManagement/lib/models/getObjectsParameters.js +++ b/lib/services/graphManagement/lib/models/getObjectsParameters.js @@ -17,9 +17,9 @@ class GetObjectsParameters { /** * Create a GetObjectsParameters. - * @member {array} [objectIds] The requested object IDs. - * @member {array} [types] The requested object types. - * @member {boolean} [includeDirectoryObjectReferences] If true, also + * @property {array} [objectIds] The requested object IDs. + * @property {array} [types] The requested object types. + * @property {boolean} [includeDirectoryObjectReferences] If true, also * searches for object IDs in the partner tenant. */ constructor() { diff --git a/lib/services/graphManagement/lib/models/graphError.js b/lib/services/graphManagement/lib/models/graphError.js index 23cb3eff35..b3031d9013 100644 --- a/lib/services/graphManagement/lib/models/graphError.js +++ b/lib/services/graphManagement/lib/models/graphError.js @@ -17,8 +17,8 @@ class GraphError { /** * Create a GraphError. - * @member {string} [code] Error code. - * @member {string} [message] Error message value. + * @property {string} [code] Error code. + * @property {string} [message] Error message value. */ constructor() { } diff --git a/lib/services/graphManagement/lib/models/groupAddMemberParameters.js b/lib/services/graphManagement/lib/models/groupAddMemberParameters.js index fb4956bcfe..f201c3dae0 100644 --- a/lib/services/graphManagement/lib/models/groupAddMemberParameters.js +++ b/lib/services/graphManagement/lib/models/groupAddMemberParameters.js @@ -17,7 +17,7 @@ class GroupAddMemberParameters { /** * Create a GroupAddMemberParameters. - * @member {string} url A member object URL, such as + * @property {string} url A member object URL, such as * "https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd", * where "0b1f9851-1bf0-433f-aec3-cb9272f093dc" is the tenantId and * "f260bbc4-c254-447b-94cf-293b5ec434dd" is the objectId of the member diff --git a/lib/services/graphManagement/lib/models/groupCreateParameters.js b/lib/services/graphManagement/lib/models/groupCreateParameters.js index f2e8570a59..263043aa00 100644 --- a/lib/services/graphManagement/lib/models/groupCreateParameters.js +++ b/lib/services/graphManagement/lib/models/groupCreateParameters.js @@ -17,8 +17,8 @@ class GroupCreateParameters { /** * Create a GroupCreateParameters. - * @member {string} displayName Group display name - * @member {string} mailNickname Mail nickname + * @property {string} displayName Group display name + * @property {string} mailNickname Mail nickname */ constructor() { } diff --git a/lib/services/graphManagement/lib/models/groupGetMemberGroupsParameters.js b/lib/services/graphManagement/lib/models/groupGetMemberGroupsParameters.js index 810ac8971b..00a60d278c 100644 --- a/lib/services/graphManagement/lib/models/groupGetMemberGroupsParameters.js +++ b/lib/services/graphManagement/lib/models/groupGetMemberGroupsParameters.js @@ -17,7 +17,7 @@ class GroupGetMemberGroupsParameters { /** * Create a GroupGetMemberGroupsParameters. - * @member {boolean} securityEnabledOnly If true, only membership in + * @property {boolean} securityEnabledOnly If true, only membership in * security-enabled groups should be checked. Otherwise, membership in all * groups should be checked. */ diff --git a/lib/services/graphManagement/lib/models/groupListResult.js b/lib/services/graphManagement/lib/models/groupListResult.js index 328199b3b4..4c164fc034 100644 --- a/lib/services/graphManagement/lib/models/groupListResult.js +++ b/lib/services/graphManagement/lib/models/groupListResult.js @@ -16,7 +16,7 @@ class GroupListResult extends Array { /** * Create a GroupListResult. - * @member {string} [odatanextLink] The URL to get the next set of results. + * @property {string} [odatanextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/graphManagement/lib/models/index.d.ts b/lib/services/graphManagement/lib/models/index.d.ts index 5faedd14fe..bf32a0bed7 100644 --- a/lib/services/graphManagement/lib/models/index.d.ts +++ b/lib/services/graphManagement/lib/models/index.d.ts @@ -1,958 +1,1004 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. + * Licensed under the MIT License. See License.txt in the project root for license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is - * regenerated. + * Changes may cause incorrect behavior and will be lost if the code is regenerated. */ -import { BaseResource } from 'ms-rest-azure'; -import { CloudError } from 'ms-rest-azure'; -import * as moment from 'moment'; +import { BaseResource, CloudError } from "ms-rest-azure"; +import * as moment from "moment"; -export { BaseResource } from 'ms-rest-azure'; -export { CloudError } from 'ms-rest-azure'; +export { + BaseResource, + CloudError +}; /** - * @class - * Initializes a new instance of the GraphError class. - * @constructor * Active Directory error information. - * - * @member {string} [code] Error code. - * @member {string} [message] Error message value. */ export interface GraphError { + /** + * Error code. + */ code?: string; + /** + * Error message value. + */ message?: string; } /** - * @class - * Initializes a new instance of the DirectoryObject class. - * @constructor * Represents an Azure Active Directory object. - * - * @member {string} [objectId] The object ID. - * @member {date} [deletionTimestamp] The time at which the directory object - * was deleted. - * @member {string} objectType Polymorphic Discriminator */ export interface DirectoryObject { + /** + * The object ID. + */ readonly objectId?: string; + /** + * The time at which the directory object was deleted. + */ readonly deletionTimestamp?: Date; + /** + * Polymorphic Discriminator + */ objectType: string; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. + * Describes unknown properties. The value of an unknown property can be of "any" type. */ - [property: string]: any; + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the KeyCredential class. - * @constructor * Active Directory Key Credential information. - * - * @member {date} [startDate] Start date. - * @member {date} [endDate] End date. - * @member {string} [value] Key value. - * @member {string} [keyId] Key ID. - * @member {string} [usage] Usage. Acceptable values are 'Verify' and 'Sign'. - * @member {string} [type] Type. Acceptable values are 'AsymmetricX509Cert' and - * 'Symmetric'. - * @member {buffer} [customKeyIdentifier] Custom Key Identifier */ export interface KeyCredential { + /** + * Start date. + */ startDate?: Date; + /** + * End date. + */ endDate?: Date; + /** + * Key value. + */ value?: string; + /** + * Key ID. + */ keyId?: string; + /** + * Usage. Acceptable values are 'Verify' and 'Sign'. + */ usage?: string; + /** + * Type. Acceptable values are 'AsymmetricX509Cert' and 'Symmetric'. + */ type?: string; - customKeyIdentifier?: Buffer; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. + * Custom Key Identifier */ - [property: string]: any; + customKeyIdentifier?: string; + /** + * Describes unknown properties. The value of an unknown property can be of "any" type. + */ + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the PasswordCredential class. - * @constructor * Active Directory Password Credential information. - * - * @member {date} [startDate] Start date. - * @member {date} [endDate] End date. - * @member {string} [keyId] Key ID. - * @member {string} [value] Key value. */ export interface PasswordCredential { + /** + * Start date. + */ startDate?: Date; + /** + * End date. + */ endDate?: Date; + /** + * Key ID. + */ keyId?: string; + /** + * Key value. + */ value?: string; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. + * Custom Key Identifier + */ + customKeyIdentifier?: Buffer; + /** + * Describes unknown properties. The value of an unknown property can be of "any" type. */ - [property: string]: any; + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the ResourceAccess class. - * @constructor - * Specifies an OAuth 2.0 permission scope or an app role that an application - * requires. The resourceAccess property of the RequiredResourceAccess type is - * a collection of ResourceAccess. - * - * @member {string} id The unique identifier for one of the OAuth2Permission or - * AppRole instances that the resource application exposes. - * @member {string} [type] Specifies whether the id property references an - * OAuth2Permission or an AppRole. Possible values are "scope" or "role". + * Specifies an OAuth 2.0 permission scope or an app role that an application requires. The + * resourceAccess property of the RequiredResourceAccess type is a collection of ResourceAccess. */ export interface ResourceAccess { + /** + * The unique identifier for one of the OAuth2Permission or AppRole instances that the resource + * application exposes. + */ id: string; + /** + * Specifies whether the id property references an OAuth2Permission or an AppRole. Possible + * values are "scope" or "role". + */ type?: string; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. + * Describes unknown properties. The value of an unknown property can be of "any" type. */ - [property: string]: any; + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the RequiredResourceAccess class. - * @constructor - * Specifies the set of OAuth 2.0 permission scopes and app roles under the - * specified resource that an application requires access to. The specified - * OAuth 2.0 permission scopes may be requested by client applications (through - * the requiredResourceAccess collection) when calling a resource application. - * The requiredResourceAccess property of the Application entity is a - * collection of ReqiredResourceAccess. - * - * @member {array} resourceAccess The list of OAuth2.0 permission scopes and - * app roles that the application requires from the specified resource. - * @member {string} [resourceAppId] The unique identifier for the resource that - * the application requires access to. This should be equal to the appId - * declared on the target resource application. + * Specifies the set of OAuth 2.0 permission scopes and app roles under the specified resource that + * an application requires access to. The specified OAuth 2.0 permission scopes may be requested by + * client applications (through the requiredResourceAccess collection) when calling a resource + * application. The requiredResourceAccess property of the Application entity is a collection of + * RequiredResourceAccess. */ export interface RequiredResourceAccess { + /** + * The list of OAuth2.0 permission scopes and app roles that the application requires from the + * specified resource. + */ resourceAccess: ResourceAccess[]; + /** + * The unique identifier for the resource that the application requires access to. This should be + * equal to the appId declared on the target resource application. + */ resourceAppId?: string; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. + * Describes unknown properties. The value of an unknown property can be of "any" type. */ - [property: string]: any; -} - -/** - * @class - * Initializes a new instance of the AppRole class. - * @constructor - * @member {string} [id] Unique role identifier inside the appRoles collection. - * @member {array} [allowedMemberTypes] Specifies whether this app role - * definition can be assigned to users and groups by setting to 'User', or to - * other applications (that are accessing this application in daemon service - * scenarios) by setting to 'Application', or to both. - * @member {string} [description] Permission help text that appears in the - * admin app assignment and consent experiences. - * @member {string} [displayName] Display name for the permission that appears - * in the admin consent and app assignment experiences. - * @member {boolean} [isEnabled] When creating or updating a role definition, - * this must be set to true (which is the default). To delete a role, this must - * first be set to false. At that point, in a subsequent call, this role may be - * removed. - * @member {string} [value] Specifies the value of the roles claim that the - * application should expect in the authentication and access tokens. - */ + [additionalPropertyName: string]: any; +} + export interface AppRole { + /** + * Unique role identifier inside the appRoles collection. + */ id?: string; + /** + * Specifies whether this app role definition can be assigned to users and groups by setting to + * 'User', or to other applications (that are accessing this application in daemon service + * scenarios) by setting to 'Application', or to both. + */ allowedMemberTypes?: string[]; + /** + * Permission help text that appears in the admin app assignment and consent experiences. + */ description?: string; + /** + * Display name for the permission that appears in the admin consent and app assignment + * experiences. + */ displayName?: string; + /** + * When creating or updating a role definition, this must be set to true (which is the default). + * To delete a role, this must first be set to false. At that point, in a subsequent call, this + * role may be removed. + */ isEnabled?: boolean; + /** + * Specifies the value of the roles claim that the application should expect in the + * authentication and access tokens. + */ value?: string; } /** - * @class - * Initializes a new instance of the ApplicationCreateParameters class. - * @constructor * Request parameters for creating a new application. - * - * @member {array} [appRoles] The collection of application roles that an - * application may declare. These roles can be assigned to users, groups or - * service principals. - * @member {boolean} availableToOtherTenants Whether the application is - * available to other tenants. - * @member {string} displayName The display name of the application. - * @member {string} [homepage] The home page of the application. - * @member {array} identifierUris A collection of URIs for the application. - * @member {array} [replyUrls] A collection of reply URLs for the application. - * @member {array} [keyCredentials] The list of KeyCredential objects. - * @member {array} [passwordCredentials] The list of PasswordCredential - * objects. - * @member {boolean} [oauth2AllowImplicitFlow] Whether to allow implicit grant - * flow for OAuth2 - * @member {array} [requiredResourceAccess] Specifies resources that this - * application requires access to and the set of OAuth permission scopes and - * application roles that it needs under each of those resources. This - * pre-configuration of required resource access drives the consent experience. - */ +*/ export interface ApplicationCreateParameters { + /** + * The collection of application roles that an application may declare. These roles can be + * assigned to users, groups or service principals. + */ appRoles?: AppRole[]; + /** + * Whether the application is available to other tenants. + */ availableToOtherTenants: boolean; + /** + * The display name of the application. + */ displayName: string; + /** + * The home page of the application. + */ homepage?: string; + /** + * A collection of URIs for the application. + */ identifierUris: string[]; + /** + * A collection of reply URLs for the application. + */ replyUrls?: string[]; + /** + * The list of KeyCredential objects. + */ keyCredentials?: KeyCredential[]; + /** + * The list of PasswordCredential objects. + */ passwordCredentials?: PasswordCredential[]; + /** + * Whether to allow implicit grant flow for OAuth2 + */ oauth2AllowImplicitFlow?: boolean; + /** + * Specifies resources that this application requires access to and the set of OAuth permission + * scopes and application roles that it needs under each of those resources. This + * pre-configuration of required resource access drives the consent experience. + */ requiredResourceAccess?: RequiredResourceAccess[]; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. - */ - [property: string]: any; + * Describes unknown properties. The value of an unknown property can be of "any" type. + */ + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the ApplicationUpdateParameters class. - * @constructor * Request parameters for updating an existing application. - * - * @member {array} [appRoles] The collection of application roles that an - * application may declare. These roles can be assigned to users, groups or - * service principals. - * @member {boolean} [availableToOtherTenants] Whether the application is - * available to other tenants - * @member {string} [displayName] The display name of the application. - * @member {string} [homepage] The home page of the application. - * @member {array} [identifierUris] A collection of URIs for the application. - * @member {array} [replyUrls] A collection of reply URLs for the application. - * @member {array} [keyCredentials] The list of KeyCredential objects. - * @member {array} [passwordCredentials] The list of PasswordCredential - * objects. - * @member {boolean} [oauth2AllowImplicitFlow] Whether to allow implicit grant - * flow for OAuth2 - * @member {array} [requiredResourceAccess] Specifies resources that this - * application requires access to and the set of OAuth permission scopes and - * application roles that it needs under each of those resources. This - * pre-configuration of required resource access drives the consent experience. - */ +*/ export interface ApplicationUpdateParameters { + /** + * The collection of application roles that an application may declare. These roles can be + * assigned to users, groups or service principals. + */ appRoles?: AppRole[]; + /** + * Whether the application is available to other tenants + */ availableToOtherTenants?: boolean; + /** + * The display name of the application. + */ displayName?: string; + /** + * The home page of the application. + */ homepage?: string; + /** + * A collection of URIs for the application. + */ identifierUris?: string[]; + /** + * A collection of reply URLs for the application. + */ replyUrls?: string[]; + /** + * The list of KeyCredential objects. + */ keyCredentials?: KeyCredential[]; + /** + * The list of PasswordCredential objects. + */ passwordCredentials?: PasswordCredential[]; + /** + * Whether to allow implicit grant flow for OAuth2 + */ oauth2AllowImplicitFlow?: boolean; + /** + * Specifies resources that this application requires access to and the set of OAuth permission + * scopes and application roles that it needs under each of those resources. This + * pre-configuration of required resource access drives the consent experience. + */ requiredResourceAccess?: RequiredResourceAccess[]; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. - */ - [property: string]: any; + * Describes unknown properties. The value of an unknown property can be of "any" type. + */ + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the Application class. - * @constructor * Active Directory application information. - * - * @member {string} [appId] The application ID. - * @member {array} [appRoles] The collection of application roles that an - * application may declare. These roles can be assigned to users, groups or - * service principals. - * @member {array} [appPermissions] The application permissions. - * @member {boolean} [availableToOtherTenants] Whether the application is be - * available to other tenants. - * @member {string} [displayName] The display name of the application. - * @member {array} [identifierUris] A collection of URIs for the application. - * @member {array} [replyUrls] A collection of reply URLs for the application. - * @member {string} [homepage] The home page of the application. - * @member {boolean} [oauth2AllowImplicitFlow] Whether to allow implicit grant - * flow for OAuth2 - * @member {array} [requiredResourceAccess] Specifies resources that this - * application requires access to and the set of OAuth permission scopes and - * application roles that it needs under each of those resources. This - * pre-configuration of required resource access drives the consent experience. - */ +*/ export interface Application extends DirectoryObject { + /** + * The application ID. + */ appId?: string; + /** + * The collection of application roles that an application may declare. These roles can be + * assigned to users, groups or service principals. + */ appRoles?: AppRole[]; + /** + * The application permissions. + */ appPermissions?: string[]; + /** + * Whether the application is be available to other tenants. + */ availableToOtherTenants?: boolean; + /** + * The display name of the application. + */ displayName?: string; + /** + * A collection of URIs for the application. + */ identifierUris?: string[]; + /** + * A collection of reply URLs for the application. + */ replyUrls?: string[]; + /** + * The home page of the application. + */ homepage?: string; + /** + * Whether to allow implicit grant flow for OAuth2 + */ oauth2AllowImplicitFlow?: boolean; + /** + * Specifies resources that this application requires access to and the set of OAuth permission + * scopes and application roles that it needs under each of those resources. This + * pre-configuration of required resource access drives the consent experience. + */ requiredResourceAccess?: RequiredResourceAccess[]; + /** + * A collection of KeyCredential objects. + */ + keyCredentials?: KeyCredential[]; + /** + * A collection of PasswordCredential objects + */ + passwordCredentials?: PasswordCredential[]; } /** - * @class - * Initializes a new instance of the AddOwnerParameters class. - * @constructor * Request parameters for adding a owner to an application. - * - * @member {string} url A owner object URL, such as - * "https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd", - * where "0b1f9851-1bf0-433f-aec3-cb9272f093dc" is the tenantId and - * "f260bbc4-c254-447b-94cf-293b5ec434dd" is the objectId of the owner (user, - * application, servicePrincipal, group) to be added. - */ +*/ export interface AddOwnerParameters { + /** + * A owner object URL, such as + * "https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd", + * where "0b1f9851-1bf0-433f-aec3-cb9272f093dc" is the tenantId and + * "f260bbc4-c254-447b-94cf-293b5ec434dd" is the objectId of the owner (user, application, + * servicePrincipal, group) to be added. + */ url: string; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. - */ - [property: string]: any; + * Describes unknown properties. The value of an unknown property can be of "any" type. + */ + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the KeyCredentialsUpdateParameters class. - * @constructor * Request parameters for a KeyCredentials update operation - * - * @member {array} value A collection of KeyCredentials. - */ +*/ export interface KeyCredentialsUpdateParameters { + /** + * A collection of KeyCredentials. + */ value: KeyCredential[]; } /** - * @class - * Initializes a new instance of the PasswordCredentialsUpdateParameters class. - * @constructor * Request parameters for a PasswordCredentials update operation. - * - * @member {array} value A collection of PasswordCredentials. - */ +*/ export interface PasswordCredentialsUpdateParameters { + /** + * A collection of PasswordCredentials. + */ value: PasswordCredential[]; } /** - * @class - * Initializes a new instance of the GroupAddMemberParameters class. - * @constructor * Request parameters for adding a member to a group. - * - * @member {string} url A member object URL, such as - * "https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd", - * where "0b1f9851-1bf0-433f-aec3-cb9272f093dc" is the tenantId and - * "f260bbc4-c254-447b-94cf-293b5ec434dd" is the objectId of the member (user, - * application, servicePrincipal, group) to be added. - */ +*/ export interface GroupAddMemberParameters { + /** + * A member object URL, such as + * "https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd", + * where "0b1f9851-1bf0-433f-aec3-cb9272f093dc" is the tenantId and + * "f260bbc4-c254-447b-94cf-293b5ec434dd" is the objectId of the member (user, application, + * servicePrincipal, group) to be added. + */ url: string; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. - */ - [property: string]: any; + * Describes unknown properties. The value of an unknown property can be of "any" type. + */ + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the GroupCreateParameters class. - * @constructor * Request parameters for creating a new group. - * - * @member {string} displayName Group display name - * @member {string} mailNickname Mail nickname - */ +*/ export interface GroupCreateParameters { + /** + * Group display name + */ displayName: string; + /** + * Mail nickname + */ mailNickname: string; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. - */ - [property: string]: any; + * Describes unknown properties. The value of an unknown property can be of "any" type. + */ + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the ADGroup class. - * @constructor * Active Directory group information. - * - * @member {string} [displayName] The display name of the group. - * @member {boolean} [mailEnabled] Whether the group is mail-enabled. Must be - * false. This is because only pure security groups can be created using the - * Graph API. - * @member {string} [mailNickname] The mail alias for the group. - * @member {boolean} [securityEnabled] Whether the group is security-enable. - * @member {string} [mail] The primary email address of the group. - */ +*/ export interface ADGroup extends DirectoryObject { + /** + * The display name of the group. + */ displayName?: string; + /** + * Whether the group is mail-enabled. Must be false. This is because only pure security groups + * can be created using the Graph API. + */ mailEnabled?: boolean; + /** + * The mail alias for the group. + */ mailNickname?: string; + /** + * Whether the group is security-enable. + */ securityEnabled?: boolean; + /** + * The primary email address of the group. + */ mail?: string; } /** - * @class - * Initializes a new instance of the GroupGetMemberGroupsParameters class. - * @constructor * Request parameters for GetMemberGroups API call. - * - * @member {boolean} securityEnabledOnly If true, only membership in - * security-enabled groups should be checked. Otherwise, membership in all - * groups should be checked. - */ +*/ export interface GroupGetMemberGroupsParameters { + /** + * If true, only membership in security-enabled groups should be checked. Otherwise, membership + * in all groups should be checked. + */ securityEnabledOnly: boolean; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. - */ - [property: string]: any; + * Describes unknown properties. The value of an unknown property can be of "any" type. + */ + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the CheckGroupMembershipParameters class. - * @constructor * Request parameters for IsMemberOf API call. - * - * @member {string} groupId The object ID of the group to check. - * @member {string} memberId The object ID of the contact, group, user, or - * service principal to check for membership in the specified group. - */ +*/ export interface CheckGroupMembershipParameters { + /** + * The object ID of the group to check. + */ groupId: string; + /** + * The object ID of the contact, group, user, or service principal to check for membership in the + * specified group. + */ memberId: string; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. - */ - [property: string]: any; + * Describes unknown properties. The value of an unknown property can be of "any" type. + */ + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the CheckGroupMembershipResult class. - * @constructor * Server response for IsMemberOf API call - * - * @member {boolean} [value] True if the specified user, group, contact, or - * service principal has either direct or transitive membership in the - * specified group; otherwise, false. - */ +*/ export interface CheckGroupMembershipResult { + /** + * True if the specified user, group, contact, or service principal has either direct or + * transitive membership in the specified group; otherwise, false. + */ value?: boolean; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. - */ - [property: string]: any; + * Describes unknown properties. The value of an unknown property can be of "any" type. + */ + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the ServicePrincipalCreateParameters class. - * @constructor * Request parameters for creating a new service principal. - * - * @member {boolean} [accountEnabled] Whether the account is enabled - * @member {string} appId application Id - * @member {boolean} [appRoleAssignmentRequired] Specifies whether an - * AppRoleAssignment to a user or group is required before Azure AD will issue - * a user or access token to the application. - * @member {string} [displayName] The display name for the service principal. - * @member {string} [errorUrl] - * @member {string} [homepage] The URL to the homepage of the associated - * application. - * @member {array} [keyCredentials] A collection of KeyCredential objects. - * @member {array} [passwordCredentials] A collection of PasswordCredential - * objects - * @member {string} [publisherName] The display name of the tenant in which the - * associated application is specified. - * @member {array} [replyUrls] A collection of reply URLs for the service - * principal. - * @member {string} [samlMetadataUrl] - * @member {array} [servicePrincipalNames] A collection of service principal - * names. - * @member {array} [tags] - */ +*/ export interface ServicePrincipalCreateParameters { + /** + * Whether the account is enabled + */ accountEnabled?: boolean; + /** + * application Id + */ appId: string; + /** + * Specifies whether an AppRoleAssignment to a user or group is required before Azure AD will + * issue a user or access token to the application. + */ appRoleAssignmentRequired?: boolean; + /** + * The display name for the service principal. + */ displayName?: string; errorUrl?: string; + /** + * The URL to the homepage of the associated application. + */ homepage?: string; + /** + * A collection of KeyCredential objects. + */ keyCredentials?: KeyCredential[]; + /** + * A collection of PasswordCredential objects + */ passwordCredentials?: PasswordCredential[]; + /** + * The display name of the tenant in which the associated application is specified. + */ publisherName?: string; + /** + * A collection of reply URLs for the service principal. + */ replyUrls?: string[]; samlMetadataUrl?: string; + /** + * A collection of service principal names. + */ servicePrincipalNames?: string[]; tags?: string[]; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. - */ - [property: string]: any; + * Describes unknown properties. The value of an unknown property can be of "any" type. + */ + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the ServicePrincipalUpdateParameters class. - * @constructor * Request parameters for creating a new service principal. - * - * @member {boolean} [accountEnabled] Whether the account is enabled - * @member {string} [appId] application Id - * @member {boolean} [appRoleAssignmentRequired] Specifies whether an - * AppRoleAssignment to a user or group is required before Azure AD will issue - * a user or access token to the application. - * @member {string} [displayName] The display name for the service principal. - * @member {string} [errorUrl] - * @member {string} [homepage] The URL to the homepage of the associated - * application. - * @member {array} [keyCredentials] A collection of KeyCredential objects. - * @member {array} [passwordCredentials] A collection of PasswordCredential - * objects - * @member {string} [publisherName] The display name of the tenant in which the - * associated application is specified. - * @member {array} [replyUrls] A collection of reply URLs for the service - * principal. - * @member {string} [samlMetadataUrl] - * @member {array} [servicePrincipalNames] A collection of service principal - * names. - * @member {array} [tags] - */ +*/ export interface ServicePrincipalUpdateParameters { + /** + * Whether the account is enabled + */ accountEnabled?: boolean; + /** + * application Id + */ appId?: string; + /** + * Specifies whether an AppRoleAssignment to a user or group is required before Azure AD will + * issue a user or access token to the application. + */ appRoleAssignmentRequired?: boolean; + /** + * The display name for the service principal. + */ displayName?: string; errorUrl?: string; + /** + * The URL to the homepage of the associated application. + */ homepage?: string; + /** + * A collection of KeyCredential objects. + */ keyCredentials?: KeyCredential[]; + /** + * A collection of PasswordCredential objects + */ passwordCredentials?: PasswordCredential[]; + /** + * The display name of the tenant in which the associated application is specified. + */ publisherName?: string; + /** + * A collection of reply URLs for the service principal. + */ replyUrls?: string[]; samlMetadataUrl?: string; + /** + * A collection of service principal names. + */ servicePrincipalNames?: string[]; tags?: string[]; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. - */ - [property: string]: any; + * Describes unknown properties. The value of an unknown property can be of "any" type. + */ + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the ServicePrincipal class. - * @constructor * Active Directory service principal information. - * - * @member {string} [displayName] The display name of the service principal. - * @member {string} [appId] The application ID. - * @member {array} [appRoles] The collection of application roles that an - * application may declare. These roles can be assigned to users, groups or - * service principals. - * @member {array} [servicePrincipalNames] A collection of service principal - * names. - */ +*/ export interface ServicePrincipal extends DirectoryObject { + /** + * The display name of the service principal. + */ displayName?: string; + /** + * The application ID. + */ appId?: string; + /** + * The collection of application roles that an application may declare. These roles can be + * assigned to users, groups or service principals. + */ appRoles?: AppRole[]; + /** + * A collection of service principal names. + */ servicePrincipalNames?: string[]; } /** - * @class - * Initializes a new instance of the PasswordProfile class. - * @constructor * The password profile associated with a user. - * - * @member {string} password Password - * @member {boolean} [forceChangePasswordNextLogin] Whether to force a password - * change on next login. - */ +*/ export interface PasswordProfile { + /** + * Password + */ password: string; + /** + * Whether to force a password change on next login. + */ forceChangePasswordNextLogin?: boolean; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. - */ - [property: string]: any; -} - -/** - * @class - * Initializes a new instance of the UserBase class. - * @constructor - * @member {string} [immutableId] This must be specified if you are using a - * federated domain for the user's userPrincipalName (UPN) property when - * creating a new user account. It is used to associate an on-premises Active - * Directory user account with their Azure AD user object. - * @member {string} [usageLocation] 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". - * @member {string} [givenName] The given name for the user. - * @member {string} [surname] The user's surname (family name or last name). - * @member {string} [userType] A string value that can be used to classify user - * types in your directory, such as 'Member' and 'Guest'. Possible values - * include: 'Member', 'Guest' - */ + * Describes unknown properties. The value of an unknown property can be of "any" type. + */ + [additionalPropertyName: string]: any; +} + export interface UserBase { + /** + * This must be specified if you are using a federated domain for the user's userPrincipalName + * (UPN) property when creating a new user account. It is used to associate an on-premises Active + * Directory user account with their Azure AD user object. + */ immutableId?: string; + /** + * 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". + */ usageLocation?: string; + /** + * The given name for the user. + */ givenName?: string; + /** + * The user's surname (family name or last name). + */ surname?: string; + /** + * A string value that can be used to classify user types in your directory, such as 'Member' and + * 'Guest'. Possible values include: 'Member', 'Guest' + */ userType?: string; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. - */ - [property: string]: any; + * Describes unknown properties. The value of an unknown property can be of "any" type. + */ + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the UserCreateParameters class. - * @constructor * Request parameters for creating a new work or school account user. - * - * @member {boolean} accountEnabled Whether the account is enabled. - * @member {string} displayName The display name of the user. - * @member {object} passwordProfile Password Profile - * @member {string} [passwordProfile.password] Password - * @member {boolean} [passwordProfile.forceChangePasswordNextLogin] Whether to - * force a password change on next login. - * @member {string} userPrincipalName The user principal name - * (someuser@contoso.com). It must contain one of the verified domains for the - * tenant. - * @member {string} mailNickname The mail alias for the user. - * @member {string} [mail] The primary email address of the user. - */ +*/ export interface UserCreateParameters extends UserBase { + /** + * Whether the account is enabled. + */ accountEnabled: boolean; + /** + * The display name of the user. + */ displayName: string; + /** + * Password Profile + */ passwordProfile: PasswordProfile; + /** + * The user principal name (someuser@contoso.com). It must contain one of the verified domains + * for the tenant. + */ userPrincipalName: string; + /** + * The mail alias for the user. + */ mailNickname: string; + /** + * The primary email address of the user. + */ mail?: string; } /** - * @class - * Initializes a new instance of the UserUpdateParameters class. - * @constructor * Request parameters for updating an existing work or school account user. - * - * @member {boolean} [accountEnabled] Whether the account is enabled. - * @member {string} [displayName] The display name of the user. - * @member {object} [passwordProfile] The password profile of the user. - * @member {string} [passwordProfile.password] Password - * @member {boolean} [passwordProfile.forceChangePasswordNextLogin] Whether to - * force a password change on next login. - * @member {string} [userPrincipalName] The user principal name - * (someuser@contoso.com). It must contain one of the verified domains for the - * tenant. - * @member {string} [mailNickname] The mail alias for the user. - */ +*/ export interface UserUpdateParameters extends UserBase { + /** + * Whether the account is enabled. + */ accountEnabled?: boolean; + /** + * The display name of the user. + */ displayName?: string; + /** + * The password profile of the user. + */ passwordProfile?: PasswordProfile; + /** + * The user principal name (someuser@contoso.com). It must contain one of the verified domains + * for the tenant. + */ userPrincipalName?: string; + /** + * The mail alias for the user. + */ mailNickname?: string; } /** - * @class - * Initializes a new instance of the SignInName class. - * @constructor - * Contains information about a sign-in name of a local account user in an - * Azure Active Directory B2C tenant. - * - * @member {string} [type] A string value that can be used to classify user - * sign-in types in your directory, such as 'emailAddress' or 'userName'. - * @member {string} [value] The sign-in used by the local account. Must be - * unique across the company/tenant. For example, 'johnc@example.com'. - */ + * Contains information about a sign-in name of a local account user in an Azure Active Directory + * B2C tenant. +*/ export interface SignInName { + /** + * A string value that can be used to classify user sign-in types in your directory, such as + * 'emailAddress' or 'userName'. + */ type?: string; + /** + * The sign-in used by the local account. Must be unique across the company/tenant. For example, + * 'johnc@example.com'. + */ value?: string; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. - */ - [property: string]: any; + * Describes unknown properties. The value of an unknown property can be of "any" type. + */ + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the User class. - * @constructor * Active Directory user information. - * - * @member {string} [immutableId] This must be specified if you are using a - * federated domain for the user's userPrincipalName (UPN) property when - * creating a new user account. It is used to associate an on-premises Active - * Directory user account with their Azure AD user object. - * @member {string} [usageLocation] 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". - * @member {string} [givenName] The given name for the user. - * @member {string} [surname] The user's surname (family name or last name). - * @member {string} [userType] A string value that can be used to classify user - * types in your directory, such as 'Member' and 'Guest'. Possible values - * include: 'Member', 'Guest' - * @member {boolean} [accountEnabled] Whether the account is enabled. - * @member {string} [displayName] The display name of the user. - * @member {string} [userPrincipalName] The principal name of the user. - * @member {string} [mailNickname] The mail alias for the user. - * @member {string} [mail] The primary email address of the user. - * @member {array} [signInNames] The sign-in names of the user. - */ +*/ export interface User extends DirectoryObject { + /** + * This must be specified if you are using a federated domain for the user's userPrincipalName + * (UPN) property when creating a new user account. It is used to associate an on-premises Active + * Directory user account with their Azure AD user object. + */ immutableId?: string; + /** + * 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". + */ usageLocation?: string; + /** + * The given name for the user. + */ givenName?: string; + /** + * The user's surname (family name or last name). + */ surname?: string; + /** + * A string value that can be used to classify user types in your directory, such as 'Member' and + * 'Guest'. Possible values include: 'Member', 'Guest' + */ userType?: string; + /** + * Whether the account is enabled. + */ accountEnabled?: boolean; + /** + * The display name of the user. + */ displayName?: string; + /** + * The principal name of the user. + */ userPrincipalName?: string; + /** + * The mail alias for the user. + */ mailNickname?: string; + /** + * The primary email address of the user. + */ mail?: string; + /** + * The sign-in names of the user. + */ signInNames?: SignInName[]; } /** - * @class - * Initializes a new instance of the UserGetMemberGroupsParameters class. - * @constructor * Request parameters for GetMemberGroups API call. - * - * @member {boolean} securityEnabledOnly If true, only membership in - * security-enabled groups should be checked. Otherwise, membership in all - * groups should be checked. - */ +*/ export interface UserGetMemberGroupsParameters { + /** + * If true, only membership in security-enabled groups should be checked. Otherwise, membership + * in all groups should be checked. + */ securityEnabledOnly: boolean; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. - */ - [property: string]: any; + * Describes unknown properties. The value of an unknown property can be of "any" type. + */ + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the GetObjectsParameters class. - * @constructor * Request parameters for the GetObjectsByObjectIds API. - * - * @member {array} [objectIds] The requested object IDs. - * @member {array} [types] The requested object types. - * @member {boolean} [includeDirectoryObjectReferences] If true, also searches - * for object IDs in the partner tenant. - */ +*/ export interface GetObjectsParameters { + /** + * The requested object IDs. + */ objectIds?: string[]; + /** + * The requested object types. + */ types?: string[]; + /** + * If true, also searches for object IDs in the partner tenant. + */ includeDirectoryObjectReferences?: boolean; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. - */ - [property: string]: any; + * Describes unknown properties. The value of an unknown property can be of "any" type. + */ + [additionalPropertyName: string]: any; } /** - * @class - * Initializes a new instance of the Domain class. - * @constructor * Active Directory Domain information. - * - * @member {string} [authenticationType] the type of the authentication into - * the domain. - * @member {boolean} [isDefault] if this is the default domain in the tenant. - * @member {boolean} [isVerified] if this domain's ownership is verified. - * @member {string} name the domain name. - */ +*/ export interface Domain { + /** + * the type of the authentication into the domain. + */ readonly authenticationType?: string; + /** + * if this is the default domain in the tenant. + */ readonly isDefault?: boolean; + /** + * if this domain's ownership is verified. + */ readonly isVerified?: boolean; + /** + * the domain name. + */ name: string; /** - * @property Describes unknown properties. The value of an unknown property - * can be of "any" type. - */ - [property: string]: any; -} - -/** - * @class - * Initializes a new instance of the Permissions class. - * @constructor - * @member {string} [odatatype] - * Microsoft.DirectoryServices.OAuth2PermissionGrant - * @member {string} [clientId] The objectId of the Service Principal associated - * with the app - * @member {string} [consentType] Typically set to AllPrincipals - * @member {object} [principalId] Set to null if AllPrincipals is set - * @member {string} [resourceId] Service Principal Id of the resource you want - * to grant - * @member {string} [scope] Typically set to user_impersonation - * @member {string} [startTime] Start time for TTL - * @member {string} [expiryTime] Expiry time for TTL - */ + * Describes unknown properties. The value of an unknown property can be of "any" type. + */ + [additionalPropertyName: string]: any; +} + export interface Permissions { + /** + * Microsoft.DirectoryServices.OAuth2PermissionGrant + */ odatatype?: string; + /** + * The objectId of the Service Principal associated with the app + */ clientId?: string; + /** + * Typically set to AllPrincipals + */ consentType?: string; + /** + * Set to null if AllPrincipals is set + */ principalId?: any; + /** + * Service Principal Id of the resource you want to grant + */ resourceId?: string; + /** + * Typically set to user_impersonation + */ scope?: string; + /** + * Start time for TTL + */ startTime?: string; + /** + * Expiry time for TTL + */ expiryTime?: string; } - /** - * @class - * Initializes a new instance of the DirectoryObjectListResult class. - * @constructor * DirectoryObject list operation result. - * - * @member {string} [odatanextLink] The URL to get the next set of results. - */ +*/ export interface DirectoryObjectListResult extends Array { + /** + * The URL to get the next set of results. + */ odatanextLink?: string; } /** - * @class - * Initializes a new instance of the ApplicationListResult class. - * @constructor * Application list operation result. - * - * @member {string} [odatanextLink] The URL to get the next set of results. - */ +*/ export interface ApplicationListResult extends Array { + /** + * The URL to get the next set of results. + */ odatanextLink?: string; } /** - * @class - * Initializes a new instance of the KeyCredentialListResult class. - * @constructor * KeyCredential list operation result. - * - */ +*/ export interface KeyCredentialListResult extends Array { } /** - * @class - * Initializes a new instance of the PasswordCredentialListResult class. - * @constructor * PasswordCredential list operation result. - * - */ +*/ export interface PasswordCredentialListResult extends Array { } /** - * @class - * Initializes a new instance of the GroupListResult class. - * @constructor * Server response for Get tenant groups API call - * - * @member {string} [odatanextLink] The URL to get the next set of results. - */ +*/ export interface GroupListResult extends Array { + /** + * The URL to get the next set of results. + */ odatanextLink?: string; } /** - * @class - * Initializes a new instance of the GroupGetMemberGroupsResult class. - * @constructor * Server response for GetMemberGroups API call. - * - */ +*/ export interface GroupGetMemberGroupsResult extends Array { } /** - * @class - * Initializes a new instance of the ServicePrincipalListResult class. - * @constructor * Server response for get tenant service principals API call. - * - * @member {string} [odatanextLink] the URL to get the next set of results. - */ +*/ export interface ServicePrincipalListResult extends Array { + /** + * the URL to get the next set of results. + */ odatanextLink?: string; } /** - * @class - * Initializes a new instance of the UserListResult class. - * @constructor * Server response for Get tenant users API call. - * - * @member {string} [odatanextLink] The URL to get the next set of results. - */ +*/ export interface UserListResult extends Array { + /** + * The URL to get the next set of results. + */ odatanextLink?: string; } /** - * @class - * Initializes a new instance of the UserGetMemberGroupsResult class. - * @constructor * Server response for GetMemberGroups API call. - * - */ +*/ export interface UserGetMemberGroupsResult extends Array { } /** - * @class - * Initializes a new instance of the DomainListResult class. - * @constructor * Server response for Get tenant domains API call. - * - */ +*/ export interface DomainListResult extends Array { } diff --git a/lib/services/graphManagement/lib/models/keyCredential.js b/lib/services/graphManagement/lib/models/keyCredential.js index 742322cbbc..f127c00479 100644 --- a/lib/services/graphManagement/lib/models/keyCredential.js +++ b/lib/services/graphManagement/lib/models/keyCredential.js @@ -17,14 +17,15 @@ class KeyCredential { /** * Create a KeyCredential. - * @member {date} [startDate] Start date. - * @member {date} [endDate] End date. - * @member {string} [value] Key value. - * @member {string} [keyId] Key ID. - * @member {string} [usage] Usage. Acceptable values are 'Verify' and 'Sign'. - * @member {string} [type] Type. Acceptable values are 'AsymmetricX509Cert' + * @property {date} [startDate] Start date. + * @property {date} [endDate] End date. + * @property {string} [value] Key value. + * @property {string} [keyId] Key ID. + * @property {string} [usage] Usage. Acceptable values are 'Verify' and + * 'Sign'. + * @property {string} [type] Type. Acceptable values are 'AsymmetricX509Cert' * and 'Symmetric'. - * @member {buffer} [customKeyIdentifier] Custom Key Identifier + * @property {string} [customKeyIdentifier] Custom Key Identifier */ constructor() { } @@ -101,7 +102,7 @@ class KeyCredential { required: false, serializedName: 'customKeyIdentifier', type: { - name: 'ByteArray' + name: 'String' } } } diff --git a/lib/services/graphManagement/lib/models/keyCredentialsUpdateParameters.js b/lib/services/graphManagement/lib/models/keyCredentialsUpdateParameters.js index 6496544fd8..aaf3334c41 100644 --- a/lib/services/graphManagement/lib/models/keyCredentialsUpdateParameters.js +++ b/lib/services/graphManagement/lib/models/keyCredentialsUpdateParameters.js @@ -17,7 +17,7 @@ class KeyCredentialsUpdateParameters { /** * Create a KeyCredentialsUpdateParameters. - * @member {array} value A collection of KeyCredentials. + * @property {array} value A collection of KeyCredentials. */ constructor() { } diff --git a/lib/services/graphManagement/lib/models/passwordCredential.js b/lib/services/graphManagement/lib/models/passwordCredential.js index 02120fcc77..b1901ef48b 100644 --- a/lib/services/graphManagement/lib/models/passwordCredential.js +++ b/lib/services/graphManagement/lib/models/passwordCredential.js @@ -17,10 +17,11 @@ class PasswordCredential { /** * Create a PasswordCredential. - * @member {date} [startDate] Start date. - * @member {date} [endDate] End date. - * @member {string} [keyId] Key ID. - * @member {string} [value] Key value. + * @property {date} [startDate] Start date. + * @property {date} [endDate] End date. + * @property {string} [keyId] Key ID. + * @property {string} [value] Key value. + * @property {buffer} [customKeyIdentifier] Custom Key Identifier */ constructor() { } @@ -78,6 +79,13 @@ class PasswordCredential { type: { name: 'String' } + }, + customKeyIdentifier: { + required: false, + serializedName: 'customKeyIdentifier', + type: { + name: 'ByteArray' + } } } } diff --git a/lib/services/graphManagement/lib/models/passwordCredentialsUpdateParameters.js b/lib/services/graphManagement/lib/models/passwordCredentialsUpdateParameters.js index ca2cc587c1..6bb7de753e 100644 --- a/lib/services/graphManagement/lib/models/passwordCredentialsUpdateParameters.js +++ b/lib/services/graphManagement/lib/models/passwordCredentialsUpdateParameters.js @@ -17,7 +17,7 @@ class PasswordCredentialsUpdateParameters { /** * Create a PasswordCredentialsUpdateParameters. - * @member {array} value A collection of PasswordCredentials. + * @property {array} value A collection of PasswordCredentials. */ constructor() { } diff --git a/lib/services/graphManagement/lib/models/passwordProfile.js b/lib/services/graphManagement/lib/models/passwordProfile.js index 5be23506eb..ce8955eea0 100644 --- a/lib/services/graphManagement/lib/models/passwordProfile.js +++ b/lib/services/graphManagement/lib/models/passwordProfile.js @@ -17,8 +17,8 @@ class PasswordProfile { /** * Create a PasswordProfile. - * @member {string} password Password - * @member {boolean} [forceChangePasswordNextLogin] Whether to force a + * @property {string} password Password + * @property {boolean} [forceChangePasswordNextLogin] Whether to force a * password change on next login. */ constructor() { diff --git a/lib/services/graphManagement/lib/models/permissions.js b/lib/services/graphManagement/lib/models/permissions.js index b2961bb5f6..815cb2d112 100644 --- a/lib/services/graphManagement/lib/models/permissions.js +++ b/lib/services/graphManagement/lib/models/permissions.js @@ -16,17 +16,17 @@ class Permissions { /** * Create a Permissions. - * @member {string} [odatatype] + * @property {string} [odatatype] * Microsoft.DirectoryServices.OAuth2PermissionGrant - * @member {string} [clientId] The objectId of the Service Principal + * @property {string} [clientId] The objectId of the Service Principal * associated with the app - * @member {string} [consentType] Typically set to AllPrincipals - * @member {object} [principalId] Set to null if AllPrincipals is set - * @member {string} [resourceId] Service Principal Id of the resource you + * @property {string} [consentType] Typically set to AllPrincipals + * @property {object} [principalId] Set to null if AllPrincipals is set + * @property {string} [resourceId] Service Principal Id of the resource you * want to grant - * @member {string} [scope] Typically set to user_impersonation - * @member {string} [startTime] Start time for TTL - * @member {string} [expiryTime] Expiry time for TTL + * @property {string} [scope] Typically set to user_impersonation + * @property {string} [startTime] Start time for TTL + * @property {string} [expiryTime] Expiry time for TTL */ constructor() { } diff --git a/lib/services/graphManagement/lib/models/requiredResourceAccess.js b/lib/services/graphManagement/lib/models/requiredResourceAccess.js index fa512813cb..82275b9fac 100644 --- a/lib/services/graphManagement/lib/models/requiredResourceAccess.js +++ b/lib/services/graphManagement/lib/models/requiredResourceAccess.js @@ -16,15 +16,15 @@ * OAuth 2.0 permission scopes may be requested by client applications (through * the requiredResourceAccess collection) when calling a resource application. * The requiredResourceAccess property of the Application entity is a - * collection of ReqiredResourceAccess. + * collection of RequiredResourceAccess. * */ class RequiredResourceAccess { /** * Create a RequiredResourceAccess. - * @member {array} resourceAccess The list of OAuth2.0 permission scopes and - * app roles that the application requires from the specified resource. - * @member {string} [resourceAppId] The unique identifier for the resource + * @property {array} resourceAccess The list of OAuth2.0 permission scopes + * and app roles that the application requires from the specified resource. + * @property {string} [resourceAppId] The unique identifier for the resource * that the application requires access to. This should be equal to the appId * declared on the target resource application. */ diff --git a/lib/services/graphManagement/lib/models/resourceAccess.js b/lib/services/graphManagement/lib/models/resourceAccess.js index 95ed68e953..045b88105f 100644 --- a/lib/services/graphManagement/lib/models/resourceAccess.js +++ b/lib/services/graphManagement/lib/models/resourceAccess.js @@ -19,9 +19,10 @@ class ResourceAccess { /** * Create a ResourceAccess. - * @member {string} id The unique identifier for one of the OAuth2Permission - * or AppRole instances that the resource application exposes. - * @member {string} [type] Specifies whether the id property references an + * @property {string} id The unique identifier for one of the + * OAuth2Permission or AppRole instances that the resource application + * exposes. + * @property {string} [type] Specifies whether the id property references an * OAuth2Permission or an AppRole. Possible values are "scope" or "role". */ constructor() { diff --git a/lib/services/graphManagement/lib/models/servicePrincipal.js b/lib/services/graphManagement/lib/models/servicePrincipal.js index 884bfe3290..f8f1cc52a7 100644 --- a/lib/services/graphManagement/lib/models/servicePrincipal.js +++ b/lib/services/graphManagement/lib/models/servicePrincipal.js @@ -20,13 +20,14 @@ const models = require('./index'); class ServicePrincipal extends models['DirectoryObject'] { /** * Create a ServicePrincipal. - * @member {string} [displayName] The display name of the service principal. - * @member {string} [appId] The application ID. - * @member {array} [appRoles] The collection of application roles that an + * @property {string} [displayName] The display name of the service + * principal. + * @property {string} [appId] The application ID. + * @property {array} [appRoles] The collection of application roles that an * application may declare. These roles can be assigned to users, groups or * service principals. - * @member {array} [servicePrincipalNames] A collection of service principal - * names. + * @property {array} [servicePrincipalNames] A collection of service + * principal names. */ constructor() { super(); diff --git a/lib/services/graphManagement/lib/models/servicePrincipalCreateParameters.js b/lib/services/graphManagement/lib/models/servicePrincipalCreateParameters.js index ac86b0b7d6..edd05d2e7a 100644 --- a/lib/services/graphManagement/lib/models/servicePrincipalCreateParameters.js +++ b/lib/services/graphManagement/lib/models/servicePrincipalCreateParameters.js @@ -17,26 +17,27 @@ class ServicePrincipalCreateParameters { /** * Create a ServicePrincipalCreateParameters. - * @member {boolean} [accountEnabled] Whether the account is enabled - * @member {string} appId application Id - * @member {boolean} [appRoleAssignmentRequired] Specifies whether an + * @property {boolean} [accountEnabled] Whether the account is enabled + * @property {string} appId application Id + * @property {boolean} [appRoleAssignmentRequired] Specifies whether an * AppRoleAssignment to a user or group is required before Azure AD will * issue a user or access token to the application. - * @member {string} [displayName] The display name for the service principal. - * @member {string} [errorUrl] - * @member {string} [homepage] The URL to the homepage of the associated + * @property {string} [displayName] The display name for the service + * principal. + * @property {string} [errorUrl] + * @property {string} [homepage] The URL to the homepage of the associated * application. - * @member {array} [keyCredentials] A collection of KeyCredential objects. - * @member {array} [passwordCredentials] A collection of PasswordCredential + * @property {array} [keyCredentials] A collection of KeyCredential objects. + * @property {array} [passwordCredentials] A collection of PasswordCredential * objects - * @member {string} [publisherName] The display name of the tenant in which + * @property {string} [publisherName] The display name of the tenant in which * the associated application is specified. - * @member {array} [replyUrls] A collection of reply URLs for the service + * @property {array} [replyUrls] A collection of reply URLs for the service * principal. - * @member {string} [samlMetadataUrl] - * @member {array} [servicePrincipalNames] A collection of service principal - * names. - * @member {array} [tags] + * @property {string} [samlMetadataUrl] + * @property {array} [servicePrincipalNames] A collection of service + * principal names. + * @property {array} [tags] */ constructor() { } diff --git a/lib/services/graphManagement/lib/models/servicePrincipalListResult.js b/lib/services/graphManagement/lib/models/servicePrincipalListResult.js index c0f153512f..a8b374f172 100644 --- a/lib/services/graphManagement/lib/models/servicePrincipalListResult.js +++ b/lib/services/graphManagement/lib/models/servicePrincipalListResult.js @@ -16,7 +16,7 @@ class ServicePrincipalListResult extends Array { /** * Create a ServicePrincipalListResult. - * @member {string} [odatanextLink] the URL to get the next set of results. + * @property {string} [odatanextLink] the URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/graphManagement/lib/models/servicePrincipalUpdateParameters.js b/lib/services/graphManagement/lib/models/servicePrincipalUpdateParameters.js index e77c75ca62..ac38988ebe 100644 --- a/lib/services/graphManagement/lib/models/servicePrincipalUpdateParameters.js +++ b/lib/services/graphManagement/lib/models/servicePrincipalUpdateParameters.js @@ -17,26 +17,27 @@ class ServicePrincipalUpdateParameters { /** * Create a ServicePrincipalUpdateParameters. - * @member {boolean} [accountEnabled] Whether the account is enabled - * @member {string} [appId] application Id - * @member {boolean} [appRoleAssignmentRequired] Specifies whether an + * @property {boolean} [accountEnabled] Whether the account is enabled + * @property {string} [appId] application Id + * @property {boolean} [appRoleAssignmentRequired] Specifies whether an * AppRoleAssignment to a user or group is required before Azure AD will * issue a user or access token to the application. - * @member {string} [displayName] The display name for the service principal. - * @member {string} [errorUrl] - * @member {string} [homepage] The URL to the homepage of the associated + * @property {string} [displayName] The display name for the service + * principal. + * @property {string} [errorUrl] + * @property {string} [homepage] The URL to the homepage of the associated * application. - * @member {array} [keyCredentials] A collection of KeyCredential objects. - * @member {array} [passwordCredentials] A collection of PasswordCredential + * @property {array} [keyCredentials] A collection of KeyCredential objects. + * @property {array} [passwordCredentials] A collection of PasswordCredential * objects - * @member {string} [publisherName] The display name of the tenant in which + * @property {string} [publisherName] The display name of the tenant in which * the associated application is specified. - * @member {array} [replyUrls] A collection of reply URLs for the service + * @property {array} [replyUrls] A collection of reply URLs for the service * principal. - * @member {string} [samlMetadataUrl] - * @member {array} [servicePrincipalNames] A collection of service principal - * names. - * @member {array} [tags] + * @property {string} [samlMetadataUrl] + * @property {array} [servicePrincipalNames] A collection of service + * principal names. + * @property {array} [tags] */ constructor() { } diff --git a/lib/services/graphManagement/lib/models/signInName.js b/lib/services/graphManagement/lib/models/signInName.js index 39f967e795..9c7fa82f7f 100644 --- a/lib/services/graphManagement/lib/models/signInName.js +++ b/lib/services/graphManagement/lib/models/signInName.js @@ -18,9 +18,9 @@ class SignInName { /** * Create a SignInName. - * @member {string} [type] A string value that can be used to classify user + * @property {string} [type] A string value that can be used to classify user * sign-in types in your directory, such as 'emailAddress' or 'userName'. - * @member {string} [value] The sign-in used by the local account. Must be + * @property {string} [value] The sign-in used by the local account. Must be * unique across the company/tenant. For example, 'johnc@example.com'. */ constructor() { diff --git a/lib/services/graphManagement/lib/models/user.js b/lib/services/graphManagement/lib/models/user.js index 600108e146..80779764be 100644 --- a/lib/services/graphManagement/lib/models/user.js +++ b/lib/services/graphManagement/lib/models/user.js @@ -20,25 +20,26 @@ const models = require('./index'); class User extends models['DirectoryObject'] { /** * Create a User. - * @member {string} [immutableId] This must be specified if you are using a + * @property {string} [immutableId] This must be specified if you are using a * federated domain for the user's userPrincipalName (UPN) property when * creating a new user account. It is used to associate an on-premises Active * Directory user account with their Azure AD user object. - * @member {string} [usageLocation] A two letter country code (ISO standard + * @property {string} [usageLocation] 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". - * @member {string} [givenName] The given name for the user. - * @member {string} [surname] The user's surname (family name or last name). - * @member {string} [userType] A string value that can be used to classify + * @property {string} [givenName] The given name for the user. + * @property {string} [surname] The user's surname (family name or last + * name). + * @property {string} [userType] A string value that can be used to classify * user types in your directory, such as 'Member' and 'Guest'. Possible * values include: 'Member', 'Guest' - * @member {boolean} [accountEnabled] Whether the account is enabled. - * @member {string} [displayName] The display name of the user. - * @member {string} [userPrincipalName] The principal name of the user. - * @member {string} [mailNickname] The mail alias for the user. - * @member {string} [mail] The primary email address of the user. - * @member {array} [signInNames] The sign-in names of the user. + * @property {boolean} [accountEnabled] Whether the account is enabled. + * @property {string} [displayName] The display name of the user. + * @property {string} [userPrincipalName] The principal name of the user. + * @property {string} [mailNickname] The mail alias for the user. + * @property {string} [mail] The primary email address of the user. + * @property {array} [signInNames] The sign-in names of the user. */ constructor() { super(); diff --git a/lib/services/graphManagement/lib/models/userBase.js b/lib/services/graphManagement/lib/models/userBase.js index c50f11342d..7a831cc859 100644 --- a/lib/services/graphManagement/lib/models/userBase.js +++ b/lib/services/graphManagement/lib/models/userBase.js @@ -16,17 +16,18 @@ class UserBase { /** * Create a UserBase. - * @member {string} [immutableId] This must be specified if you are using a + * @property {string} [immutableId] This must be specified if you are using a * federated domain for the user's userPrincipalName (UPN) property when * creating a new user account. It is used to associate an on-premises Active * Directory user account with their Azure AD user object. - * @member {string} [usageLocation] A two letter country code (ISO standard + * @property {string} [usageLocation] 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". - * @member {string} [givenName] The given name for the user. - * @member {string} [surname] The user's surname (family name or last name). - * @member {string} [userType] A string value that can be used to classify + * @property {string} [givenName] The given name for the user. + * @property {string} [surname] The user's surname (family name or last + * name). + * @property {string} [userType] A string value that can be used to classify * user types in your directory, such as 'Member' and 'Guest'. Possible * values include: 'Member', 'Guest' */ diff --git a/lib/services/graphManagement/lib/models/userCreateParameters.js b/lib/services/graphManagement/lib/models/userCreateParameters.js index 7680e2ae42..5ea2cb3f20 100644 --- a/lib/services/graphManagement/lib/models/userCreateParameters.js +++ b/lib/services/graphManagement/lib/models/userCreateParameters.js @@ -20,17 +20,17 @@ const models = require('./index'); class UserCreateParameters extends models['UserBase'] { /** * Create a UserCreateParameters. - * @member {boolean} accountEnabled Whether the account is enabled. - * @member {string} displayName The display name of the user. - * @member {object} passwordProfile Password Profile - * @member {string} [passwordProfile.password] Password - * @member {boolean} [passwordProfile.forceChangePasswordNextLogin] Whether + * @property {boolean} accountEnabled Whether the account is enabled. + * @property {string} displayName The display name of the user. + * @property {object} passwordProfile Password Profile + * @property {string} [passwordProfile.password] Password + * @property {boolean} [passwordProfile.forceChangePasswordNextLogin] Whether * to force a password change on next login. - * @member {string} userPrincipalName The user principal name + * @property {string} userPrincipalName The user principal name * (someuser@contoso.com). It must contain one of the verified domains for * the tenant. - * @member {string} mailNickname The mail alias for the user. - * @member {string} [mail] The primary email address of the user. + * @property {string} mailNickname The mail alias for the user. + * @property {string} [mail] The primary email address of the user. */ constructor() { super(); diff --git a/lib/services/graphManagement/lib/models/userGetMemberGroupsParameters.js b/lib/services/graphManagement/lib/models/userGetMemberGroupsParameters.js index 5ba64e6efa..524a8faa47 100644 --- a/lib/services/graphManagement/lib/models/userGetMemberGroupsParameters.js +++ b/lib/services/graphManagement/lib/models/userGetMemberGroupsParameters.js @@ -17,7 +17,7 @@ class UserGetMemberGroupsParameters { /** * Create a UserGetMemberGroupsParameters. - * @member {boolean} securityEnabledOnly If true, only membership in + * @property {boolean} securityEnabledOnly If true, only membership in * security-enabled groups should be checked. Otherwise, membership in all * groups should be checked. */ diff --git a/lib/services/graphManagement/lib/models/userListResult.js b/lib/services/graphManagement/lib/models/userListResult.js index 9c4465bb9c..f8419fa94a 100644 --- a/lib/services/graphManagement/lib/models/userListResult.js +++ b/lib/services/graphManagement/lib/models/userListResult.js @@ -16,7 +16,7 @@ class UserListResult extends Array { /** * Create a UserListResult. - * @member {string} [odatanextLink] The URL to get the next set of results. + * @property {string} [odatanextLink] The URL to get the next set of results. */ constructor() { super(); diff --git a/lib/services/graphManagement/lib/models/userUpdateParameters.js b/lib/services/graphManagement/lib/models/userUpdateParameters.js index 5c99c86054..7fc9c5df0f 100644 --- a/lib/services/graphManagement/lib/models/userUpdateParameters.js +++ b/lib/services/graphManagement/lib/models/userUpdateParameters.js @@ -20,16 +20,16 @@ const models = require('./index'); class UserUpdateParameters extends models['UserBase'] { /** * Create a UserUpdateParameters. - * @member {boolean} [accountEnabled] Whether the account is enabled. - * @member {string} [displayName] The display name of the user. - * @member {object} [passwordProfile] The password profile of the user. - * @member {string} [passwordProfile.password] Password - * @member {boolean} [passwordProfile.forceChangePasswordNextLogin] Whether + * @property {boolean} [accountEnabled] Whether the account is enabled. + * @property {string} [displayName] The display name of the user. + * @property {object} [passwordProfile] The password profile of the user. + * @property {string} [passwordProfile.password] Password + * @property {boolean} [passwordProfile.forceChangePasswordNextLogin] Whether * to force a password change on next login. - * @member {string} [userPrincipalName] The user principal name + * @property {string} [userPrincipalName] The user principal name * (someuser@contoso.com). It must contain one of the verified domains for * the tenant. - * @member {string} [mailNickname] The mail alias for the user. + * @property {string} [mailNickname] The mail alias for the user. */ constructor() { super(); diff --git a/lib/services/graphManagement/lib/operations/index.d.ts b/lib/services/graphManagement/lib/operations/index.d.ts index 6c07de1e44..89ac79ab51 100644 --- a/lib/services/graphManagement/lib/operations/index.d.ts +++ b/lib/services/graphManagement/lib/operations/index.d.ts @@ -4050,7 +4050,7 @@ export interface OAuth2 { * @param {object} [options] Optional Parameters. * * @param {object} [options.body] The relevant app Service Principal Object Id - * and the Service Principal Objecit Id you want to grant. + * and the Service Principal Object Id you want to grant. * * @param {string} [options.body.odatatype] * Microsoft.DirectoryServices.OAuth2PermissionGrant @@ -4089,7 +4089,7 @@ export interface OAuth2 { * @param {object} [options] Optional Parameters. * * @param {object} [options.body] The relevant app Service Principal Object Id - * and the Service Principal Objecit Id you want to grant. + * and the Service Principal Object Id you want to grant. * * @param {string} [options.body.odatatype] * Microsoft.DirectoryServices.OAuth2PermissionGrant diff --git a/lib/services/graphManagement/lib/operations/oAuth2.js b/lib/services/graphManagement/lib/operations/oAuth2.js index a38d0b851f..c9d2fe0aeb 100644 --- a/lib/services/graphManagement/lib/operations/oAuth2.js +++ b/lib/services/graphManagement/lib/operations/oAuth2.js @@ -163,7 +163,7 @@ function _get(options, callback) { * @param {object} [options] Optional Parameters. * * @param {object} [options.body] The relevant app Service Principal Object Id - * and the Service Principal Objecit Id you want to grant. + * and the Service Principal Object Id you want to grant. * * @param {string} [options.body.odatatype] * Microsoft.DirectoryServices.OAuth2PermissionGrant @@ -430,7 +430,7 @@ class OAuth2 { * @param {object} [options] Optional Parameters. * * @param {object} [options.body] The relevant app Service Principal Object Id - * and the Service Principal Objecit Id you want to grant. + * and the Service Principal Object Id you want to grant. * * @param {string} [options.body.odatatype] * Microsoft.DirectoryServices.OAuth2PermissionGrant @@ -481,7 +481,7 @@ class OAuth2 { * @param {object} [options] Optional Parameters. * * @param {object} [options.body] The relevant app Service Principal Object Id - * and the Service Principal Objecit Id you want to grant. + * and the Service Principal Object Id you want to grant. * * @param {string} [options.body.odatatype] * Microsoft.DirectoryServices.OAuth2PermissionGrant diff --git a/lib/services/graphManagement/package.json b/lib/services/graphManagement/package.json index 206a3b5b38..2242630873 100644 --- a/lib/services/graphManagement/package.json +++ b/lib/services/graphManagement/package.json @@ -22,4 +22,4 @@ "bugs": { "url": "https://github.com/azure/azure-sdk-for-node/issues" } -} \ No newline at end of file +}