@pnp/cli-microsoft365 9.0.0-beta.e69e8d0 → 10.0.0-beta.48e9f7d
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/allCommands.json +1 -1
- package/allCommandsFull.json +1 -1
- package/dist/Command.js +1 -3
- package/dist/cli/cli.js +54 -14
- package/dist/m365/cli/commands/cli-consent.js +3 -7
- package/dist/m365/commands/login.js +10 -5
- package/dist/m365/entra/commands/enterpriseapp/enterpriseapp-remove.js +123 -0
- package/dist/m365/entra/commands/group/group-set.js +256 -0
- package/dist/m365/entra/commands.js +3 -0
- package/dist/m365/onenote/commands/notebook/notebook-add.js +132 -0
- package/dist/m365/onenote/commands.js +1 -0
- package/dist/m365/spo/commands/applicationcustomizer/applicationcustomizer-get.js +0 -1
- package/dist/m365/spo/commands/site/site-get.js +12 -16
- package/dist/m365/teams/commands/message/message-restore.js +106 -0
- package/dist/m365/teams/commands.js +1 -0
- package/dist/m365/viva/commands/engage/engage-group-list.js +0 -5
- package/dist/m365/viva/commands/engage/engage-group-user-add.js +0 -5
- package/dist/m365/viva/commands/engage/engage-group-user-remove.js +0 -5
- package/dist/m365/viva/commands/engage/engage-message-add.js +0 -5
- package/dist/m365/viva/commands/engage/engage-message-get.js +0 -5
- package/dist/m365/viva/commands/engage/engage-message-like-set.js +0 -5
- package/dist/m365/viva/commands/engage/engage-message-list.js +0 -5
- package/dist/m365/viva/commands/engage/engage-message-remove.js +0 -5
- package/dist/m365/viva/commands/engage/engage-network-list.js +0 -5
- package/dist/m365/viva/commands/engage/engage-report-activitycounts.js +0 -8
- package/dist/m365/viva/commands/engage/engage-report-activityusercounts.js +0 -8
- package/dist/m365/viva/commands/engage/engage-report-activityuserdetail.js +0 -8
- package/dist/m365/viva/commands/engage/engage-report-deviceusagedistributionusercounts.js +0 -8
- package/dist/m365/viva/commands/engage/engage-report-deviceusageusercounts.js +0 -8
- package/dist/m365/viva/commands/engage/engage-report-deviceusageuserdetail.js +0 -8
- package/dist/m365/viva/commands/engage/engage-report-groupsactivitycounts.js +0 -8
- package/dist/m365/viva/commands/engage/engage-report-groupsactivitydetail.js +0 -8
- package/dist/m365/viva/commands/engage/engage-report-groupsactivitygroupcounts.js +0 -8
- package/dist/m365/viva/commands/engage/engage-search.js +0 -5
- package/dist/m365/viva/commands/engage/engage-user-get.js +0 -5
- package/dist/m365/viva/commands/engage/engage-user-list.js +0 -5
- package/docs/docs/cmd/cli/cli-consent.mdx +1 -1
- package/docs/docs/cmd/entra/enterpriseapp/enterpriseapp-remove.mdx +65 -0
- package/docs/docs/cmd/entra/group/group-add.mdx +0 -4
- package/docs/docs/cmd/entra/group/group-set.mdx +89 -0
- package/docs/docs/cmd/onenote/notebook/notebook-add.mdx +169 -0
- package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-get.mdx +6 -5
- package/docs/docs/cmd/teams/message/message-remove.mdx +2 -1
- package/docs/docs/cmd/teams/message/message-restore.mdx +62 -0
- package/npm-shrinkwrap.json +2 -3
- package/package.json +1 -2
- package/dist/m365/viva/commands/engage/yammerCommands.js +0 -25
package/dist/Command.js
CHANGED
|
@@ -111,9 +111,7 @@ class Command {
|
|
|
111
111
|
prompted = true;
|
|
112
112
|
await cli.error('🌶️ Provide values for the following parameters:');
|
|
113
113
|
}
|
|
114
|
-
const answer = optionInfo
|
|
115
|
-
? await prompt.forSelection({ message: `${optionInfo.name}: `, choices: optionInfo.autocomplete.map((choice) => { return { name: choice, value: choice }; }) })
|
|
116
|
-
: await prompt.forInput({ message: `${optionInfo.name}: ` });
|
|
114
|
+
const answer = await cli.promptForValue(optionInfo);
|
|
117
115
|
args.options[optionInfo.name] = answer;
|
|
118
116
|
}
|
|
119
117
|
if (prompted) {
|
package/dist/cli/cli.js
CHANGED
|
@@ -36,6 +36,14 @@ const defaultHelpMode = 'options';
|
|
|
36
36
|
const defaultHelpTarget = 'console';
|
|
37
37
|
const helpModes = ['options', 'examples', 'remarks', 'response', 'full'];
|
|
38
38
|
const helpTargets = ['console', 'web'];
|
|
39
|
+
const yargsConfiguration = {
|
|
40
|
+
'parse-numbers': true,
|
|
41
|
+
'strip-aliased': true,
|
|
42
|
+
'strip-dashed': true,
|
|
43
|
+
'dot-notation': false,
|
|
44
|
+
'boolean-negation': true,
|
|
45
|
+
'camel-case-expansion': false
|
|
46
|
+
};
|
|
39
47
|
function getConfig() {
|
|
40
48
|
if (!_config) {
|
|
41
49
|
_config = new Configstore(config.configstoreName);
|
|
@@ -129,14 +137,38 @@ async function execute(rawArgs) {
|
|
|
129
137
|
}
|
|
130
138
|
let finalArgs = cli.optionsFromArgs.options;
|
|
131
139
|
if (cli.commandToExecute?.command.schema) {
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
140
|
+
while (true) {
|
|
141
|
+
const startValidation = process.hrtime.bigint();
|
|
142
|
+
const result = cli.commandToExecute.command.getSchemaToParse().safeParse(cli.optionsFromArgs.options);
|
|
143
|
+
const endValidation = process.hrtime.bigint();
|
|
144
|
+
timings.validation.push(Number(endValidation - startValidation));
|
|
145
|
+
if (result.success) {
|
|
146
|
+
finalArgs = result.data;
|
|
147
|
+
break;
|
|
148
|
+
}
|
|
149
|
+
else {
|
|
150
|
+
const hasNonRequiredErrors = result.error.errors.some(e => e.code !== 'invalid_type' || e.received !== 'undefined');
|
|
151
|
+
const shouldPrompt = cli.getSettingWithDefaultValue(settingsNames.prompt, true);
|
|
152
|
+
if (hasNonRequiredErrors === false &&
|
|
153
|
+
shouldPrompt) {
|
|
154
|
+
await cli.error('🌶️ Provide values for the following parameters:');
|
|
155
|
+
for (const error of result.error.errors) {
|
|
156
|
+
const optionInfo = cli.commandToExecute.options.find(o => o.name === error.path.join('.'));
|
|
157
|
+
const answer = await cli.promptForValue(optionInfo);
|
|
158
|
+
cli.optionsFromArgs.options[error.path.join('.')] = answer;
|
|
159
|
+
}
|
|
160
|
+
}
|
|
161
|
+
else {
|
|
162
|
+
result.error.errors.forEach(e => {
|
|
163
|
+
if (e.code === 'invalid_type' &&
|
|
164
|
+
e.received === 'undefined') {
|
|
165
|
+
e.message = `Required option not specified`;
|
|
166
|
+
}
|
|
167
|
+
});
|
|
168
|
+
return cli.closeWithError(result.error, cli.optionsFromArgs, true);
|
|
169
|
+
}
|
|
170
|
+
}
|
|
138
171
|
}
|
|
139
|
-
finalArgs = result.data;
|
|
140
172
|
}
|
|
141
173
|
else {
|
|
142
174
|
const startValidation = process.hrtime.bigint();
|
|
@@ -404,11 +436,7 @@ function getCommandOptions(command) {
|
|
|
404
436
|
function getCommandOptionsFromArgs(args, commandInfo) {
|
|
405
437
|
const yargsOptions = {
|
|
406
438
|
alias: {},
|
|
407
|
-
configuration:
|
|
408
|
-
"parse-numbers": false,
|
|
409
|
-
"strip-aliased": true,
|
|
410
|
-
"strip-dashed": true
|
|
411
|
-
}
|
|
439
|
+
configuration: yargsConfiguration
|
|
412
440
|
};
|
|
413
441
|
let argsToParse = args;
|
|
414
442
|
if (commandInfo) {
|
|
@@ -749,7 +777,7 @@ async function closeWithError(error, args, showHelpIfEnabled = false) {
|
|
|
749
777
|
}
|
|
750
778
|
let errorMessage = error instanceof CommandError ? error.message : error;
|
|
751
779
|
if (error instanceof ZodError) {
|
|
752
|
-
errorMessage = error.errors.map(e => `${e.path}: ${e.message}`).join(os.EOL);
|
|
780
|
+
errorMessage = error.errors.map(e => `${e.path.join('.')}: ${e.message}`).join(os.EOL);
|
|
753
781
|
}
|
|
754
782
|
if ((!args.options.output || args.options.output === 'json') &&
|
|
755
783
|
!cli.getSettingWithDefaultValue(settingsNames.printErrorsAsPlainText, true)) {
|
|
@@ -789,6 +817,16 @@ async function error(message, ...optionalParams) {
|
|
|
789
817
|
console.error(message, ...optionalParams);
|
|
790
818
|
}
|
|
791
819
|
}
|
|
820
|
+
async function promptForValue(optionInfo) {
|
|
821
|
+
return optionInfo.autocomplete !== undefined
|
|
822
|
+
? await prompt.forSelection({
|
|
823
|
+
message: `${optionInfo.name}: `,
|
|
824
|
+
choices: optionInfo.autocomplete.map((choice) => {
|
|
825
|
+
return { name: choice, value: choice };
|
|
826
|
+
})
|
|
827
|
+
})
|
|
828
|
+
: await prompt.forInput({ message: `${optionInfo.name}: ` });
|
|
829
|
+
}
|
|
792
830
|
async function promptForSelection(config) {
|
|
793
831
|
const answer = await prompt.forSelection(config);
|
|
794
832
|
await cli.error('');
|
|
@@ -853,6 +891,8 @@ export const cli = {
|
|
|
853
891
|
printAvailableCommands,
|
|
854
892
|
promptForConfirmation,
|
|
855
893
|
promptForSelection,
|
|
856
|
-
|
|
894
|
+
promptForValue,
|
|
895
|
+
shouldTrimOutput,
|
|
896
|
+
yargsConfiguration
|
|
857
897
|
};
|
|
858
898
|
//# sourceMappingURL=cli.js.map
|
|
@@ -23,12 +23,8 @@ class CliConsentCommand extends AnonymousCommand {
|
|
|
23
23
|
}
|
|
24
24
|
async commandAction(logger, args) {
|
|
25
25
|
let scope = '';
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
await this.warn(logger, 'The yammer service is deprecated. Please use the VivaEngage service instead.');
|
|
29
|
-
case 'VivaEngage':
|
|
30
|
-
scope = 'https://api.yammer.com/user_impersonation';
|
|
31
|
-
break;
|
|
26
|
+
if (args.options.service === 'VivaEngage') {
|
|
27
|
+
scope = 'https://api.yammer.com/user_impersonation';
|
|
32
28
|
}
|
|
33
29
|
await logger.log(`To consent permissions for executing ${args.options.service} commands, navigate in your web browser to https://login.microsoftonline.com/${config.tenant}/oauth2/v2.0/authorize?client_id=${config.cliEntraAppId}&response_type=code&scope=${encodeURIComponent(scope)}`);
|
|
34
30
|
}
|
|
@@ -50,7 +46,7 @@ _CliConsentCommand_instances = new WeakSet(), _CliConsentCommand_initTelemetry =
|
|
|
50
46
|
});
|
|
51
47
|
}, _CliConsentCommand_initValidators = function _CliConsentCommand_initValidators() {
|
|
52
48
|
this.validators.push(async (args) => {
|
|
53
|
-
if (args.options.service !== 'VivaEngage'
|
|
49
|
+
if (args.options.service !== 'VivaEngage') {
|
|
54
50
|
return `${args.options.service} is not a valid value for the service option. Allowed values: VivaEngage`;
|
|
55
51
|
}
|
|
56
52
|
return true;
|
|
@@ -38,19 +38,24 @@ class LoginCommand extends Command {
|
|
|
38
38
|
getRefinedSchema(schema) {
|
|
39
39
|
return schema
|
|
40
40
|
.refine(options => options.authType !== 'password' || options.userName, {
|
|
41
|
-
message: 'Username is required when using password authentication'
|
|
41
|
+
message: 'Username is required when using password authentication',
|
|
42
|
+
path: ['userName']
|
|
42
43
|
})
|
|
43
44
|
.refine(options => options.authType !== 'password' || options.password, {
|
|
44
|
-
message: 'Password is required when using password authentication'
|
|
45
|
+
message: 'Password is required when using password authentication',
|
|
46
|
+
path: ['password']
|
|
45
47
|
})
|
|
46
48
|
.refine(options => options.authType !== 'certificate' || !(options.certificateFile && options.certificateBase64Encoded), {
|
|
47
|
-
message: 'Specify either certificateFile or certificateBase64Encoded, but not both.'
|
|
49
|
+
message: 'Specify either certificateFile or certificateBase64Encoded, but not both.',
|
|
50
|
+
path: ['certificateBase64Encoded']
|
|
48
51
|
})
|
|
49
52
|
.refine(options => options.authType !== 'certificate' || options.certificateFile || options.certificateBase64Encoded, {
|
|
50
|
-
message: 'Specify either certificateFile or certificateBase64Encoded'
|
|
53
|
+
message: 'Specify either certificateFile or certificateBase64Encoded',
|
|
54
|
+
path: ['certificateFile']
|
|
51
55
|
})
|
|
52
56
|
.refine(options => options.authType !== 'secret' || options.secret, {
|
|
53
|
-
message: 'Secret is required when using secret authentication'
|
|
57
|
+
message: 'Secret is required when using secret authentication',
|
|
58
|
+
path: ['secret']
|
|
54
59
|
});
|
|
55
60
|
}
|
|
56
61
|
async commandAction(logger, args) {
|
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
|
|
2
|
+
if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
|
|
3
|
+
if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
|
|
4
|
+
return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
|
|
5
|
+
};
|
|
6
|
+
var _EntraEnterpriseAppRemoveCommand_instances, _EntraEnterpriseAppRemoveCommand_initTelemetry, _EntraEnterpriseAppRemoveCommand_initOptions, _EntraEnterpriseAppRemoveCommand_initValidators, _EntraEnterpriseAppRemoveCommand_initOptionSets, _EntraEnterpriseAppRemoveCommand_initTypes;
|
|
7
|
+
import { cli } from '../../../../cli/cli.js';
|
|
8
|
+
import request from '../../../../request.js';
|
|
9
|
+
import { odata } from '../../../../utils/odata.js';
|
|
10
|
+
import { formatting } from '../../../../utils/formatting.js';
|
|
11
|
+
import { validation } from '../../../../utils/validation.js';
|
|
12
|
+
import GraphCommand from '../../../base/GraphCommand.js';
|
|
13
|
+
import commands from '../../commands.js';
|
|
14
|
+
class EntraEnterpriseAppRemoveCommand extends GraphCommand {
|
|
15
|
+
get name() {
|
|
16
|
+
return commands.ENTERPRISEAPP_REMOVE;
|
|
17
|
+
}
|
|
18
|
+
get description() {
|
|
19
|
+
return 'Deletes an enterprise application (or service principal)';
|
|
20
|
+
}
|
|
21
|
+
alias() {
|
|
22
|
+
return [commands.SP_REMOVE];
|
|
23
|
+
}
|
|
24
|
+
constructor() {
|
|
25
|
+
super();
|
|
26
|
+
_EntraEnterpriseAppRemoveCommand_instances.add(this);
|
|
27
|
+
__classPrivateFieldGet(this, _EntraEnterpriseAppRemoveCommand_instances, "m", _EntraEnterpriseAppRemoveCommand_initTelemetry).call(this);
|
|
28
|
+
__classPrivateFieldGet(this, _EntraEnterpriseAppRemoveCommand_instances, "m", _EntraEnterpriseAppRemoveCommand_initOptions).call(this);
|
|
29
|
+
__classPrivateFieldGet(this, _EntraEnterpriseAppRemoveCommand_instances, "m", _EntraEnterpriseAppRemoveCommand_initValidators).call(this);
|
|
30
|
+
__classPrivateFieldGet(this, _EntraEnterpriseAppRemoveCommand_instances, "m", _EntraEnterpriseAppRemoveCommand_initOptionSets).call(this);
|
|
31
|
+
__classPrivateFieldGet(this, _EntraEnterpriseAppRemoveCommand_instances, "m", _EntraEnterpriseAppRemoveCommand_initTypes).call(this);
|
|
32
|
+
}
|
|
33
|
+
async commandAction(logger, args) {
|
|
34
|
+
const removeEnterpriseApplication = async () => {
|
|
35
|
+
if (this.verbose) {
|
|
36
|
+
await logger.logToStderr(`Removing enterprise application ${args.options.id || args.options.displayName || args.options.objectId}...`);
|
|
37
|
+
}
|
|
38
|
+
try {
|
|
39
|
+
let url = `${this.resource}/v1.0`;
|
|
40
|
+
if (args.options.id) {
|
|
41
|
+
url += `/servicePrincipals(appId='${args.options.id}')`;
|
|
42
|
+
}
|
|
43
|
+
else {
|
|
44
|
+
const id = await this.getSpId(args.options);
|
|
45
|
+
url += `/servicePrincipals/${id}`;
|
|
46
|
+
}
|
|
47
|
+
const requestOptions = {
|
|
48
|
+
url: url,
|
|
49
|
+
headers: {
|
|
50
|
+
accept: 'application/json;odata.metadata=none'
|
|
51
|
+
},
|
|
52
|
+
responseType: 'json'
|
|
53
|
+
};
|
|
54
|
+
await request.delete(requestOptions);
|
|
55
|
+
}
|
|
56
|
+
catch (err) {
|
|
57
|
+
this.handleRejectedODataJsonPromise(err);
|
|
58
|
+
}
|
|
59
|
+
};
|
|
60
|
+
if (args.options.force) {
|
|
61
|
+
await removeEnterpriseApplication();
|
|
62
|
+
}
|
|
63
|
+
else {
|
|
64
|
+
const result = await cli.promptForConfirmation({ message: `Are you sure you want to remove enterprise application '${args.options.id || args.options.displayName || args.options.objectId}'?` });
|
|
65
|
+
if (result) {
|
|
66
|
+
await removeEnterpriseApplication();
|
|
67
|
+
}
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
async getSpId(options) {
|
|
71
|
+
if (options.objectId) {
|
|
72
|
+
return options.objectId;
|
|
73
|
+
}
|
|
74
|
+
const spItemsResponse = await odata.getAllItems(`${this.resource}/v1.0/servicePrincipals?$filter=displayName eq '${formatting.encodeQueryParameter(options.displayName)}'&$select=id`);
|
|
75
|
+
if (spItemsResponse.length === 0) {
|
|
76
|
+
throw `The specified enterprise application does not exist.`;
|
|
77
|
+
}
|
|
78
|
+
if (spItemsResponse.length > 1) {
|
|
79
|
+
const resultAsKeyValuePair = formatting.convertArrayToHashTable('id', spItemsResponse);
|
|
80
|
+
const result = await cli.handleMultipleResultsFound(`Multiple enterprise applications with name '${options.displayName}' found.`, resultAsKeyValuePair);
|
|
81
|
+
return result.id;
|
|
82
|
+
}
|
|
83
|
+
const spItem = spItemsResponse[0];
|
|
84
|
+
return spItem.id;
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
_EntraEnterpriseAppRemoveCommand_instances = new WeakSet(), _EntraEnterpriseAppRemoveCommand_initTelemetry = function _EntraEnterpriseAppRemoveCommand_initTelemetry() {
|
|
88
|
+
this.telemetry.push((args) => {
|
|
89
|
+
Object.assign(this.telemetryProperties, {
|
|
90
|
+
id: typeof args.options.id !== 'undefined',
|
|
91
|
+
displayName: typeof args.options.displayName !== 'undefined',
|
|
92
|
+
objectId: typeof args.options.objectId !== 'undefined',
|
|
93
|
+
force: !!args.options.force
|
|
94
|
+
});
|
|
95
|
+
});
|
|
96
|
+
}, _EntraEnterpriseAppRemoveCommand_initOptions = function _EntraEnterpriseAppRemoveCommand_initOptions() {
|
|
97
|
+
this.options.unshift({
|
|
98
|
+
option: '-i, --id [id]'
|
|
99
|
+
}, {
|
|
100
|
+
option: '-n, --displayName [displayName]'
|
|
101
|
+
}, {
|
|
102
|
+
option: '--objectId [objectId]'
|
|
103
|
+
}, {
|
|
104
|
+
option: '-f, --force'
|
|
105
|
+
});
|
|
106
|
+
}, _EntraEnterpriseAppRemoveCommand_initValidators = function _EntraEnterpriseAppRemoveCommand_initValidators() {
|
|
107
|
+
this.validators.push(async (args) => {
|
|
108
|
+
if (args.options.id && !validation.isValidGuid(args.options.id)) {
|
|
109
|
+
return `The option 'id' with value '${args.options.id}' is not a valid GUID.`;
|
|
110
|
+
}
|
|
111
|
+
if (args.options.objectId && !validation.isValidGuid(args.options.objectId)) {
|
|
112
|
+
return `The option 'objectId' with value '${args.options.objectId}' is not a valid GUID.`;
|
|
113
|
+
}
|
|
114
|
+
return true;
|
|
115
|
+
});
|
|
116
|
+
}, _EntraEnterpriseAppRemoveCommand_initOptionSets = function _EntraEnterpriseAppRemoveCommand_initOptionSets() {
|
|
117
|
+
this.optionSets.push({ options: ['id', 'displayName', 'objectId'] });
|
|
118
|
+
}, _EntraEnterpriseAppRemoveCommand_initTypes = function _EntraEnterpriseAppRemoveCommand_initTypes() {
|
|
119
|
+
this.types.string.push('id', 'displayName', 'objectId');
|
|
120
|
+
this.types.boolean.push('force');
|
|
121
|
+
};
|
|
122
|
+
export default new EntraEnterpriseAppRemoveCommand();
|
|
123
|
+
//# sourceMappingURL=enterpriseapp-remove.js.map
|
|
@@ -0,0 +1,256 @@
|
|
|
1
|
+
var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
|
|
2
|
+
if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
|
|
3
|
+
if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
|
|
4
|
+
return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
|
|
5
|
+
};
|
|
6
|
+
var _EntraGroupSetCommand_instances, _EntraGroupSetCommand_initTelemetry, _EntraGroupSetCommand_initOptions, _EntraGroupSetCommand_initValidators, _EntraGroupSetCommand_initOptionSets, _EntraGroupSetCommand_initTypes;
|
|
7
|
+
import GraphCommand from '../../../base/GraphCommand.js';
|
|
8
|
+
import commands from '../../commands.js';
|
|
9
|
+
import { validation } from '../../../../utils/validation.js';
|
|
10
|
+
import request from '../../../../request.js';
|
|
11
|
+
import { entraUser } from '../../../../utils/entraUser.js';
|
|
12
|
+
import { entraGroup } from '../../../../utils/entraGroup.js';
|
|
13
|
+
import { formatting } from '../../../../utils/formatting.js';
|
|
14
|
+
import { odata } from '../../../../utils/odata.js';
|
|
15
|
+
class EntraGroupSetCommand extends GraphCommand {
|
|
16
|
+
get name() {
|
|
17
|
+
return commands.GROUP_SET;
|
|
18
|
+
}
|
|
19
|
+
get description() {
|
|
20
|
+
return 'Updates a Microsoft Entra group';
|
|
21
|
+
}
|
|
22
|
+
constructor() {
|
|
23
|
+
super();
|
|
24
|
+
_EntraGroupSetCommand_instances.add(this);
|
|
25
|
+
this.allowedVisibility = ['Public', 'Private'];
|
|
26
|
+
__classPrivateFieldGet(this, _EntraGroupSetCommand_instances, "m", _EntraGroupSetCommand_initTelemetry).call(this);
|
|
27
|
+
__classPrivateFieldGet(this, _EntraGroupSetCommand_instances, "m", _EntraGroupSetCommand_initOptions).call(this);
|
|
28
|
+
__classPrivateFieldGet(this, _EntraGroupSetCommand_instances, "m", _EntraGroupSetCommand_initValidators).call(this);
|
|
29
|
+
__classPrivateFieldGet(this, _EntraGroupSetCommand_instances, "m", _EntraGroupSetCommand_initOptionSets).call(this);
|
|
30
|
+
__classPrivateFieldGet(this, _EntraGroupSetCommand_instances, "m", _EntraGroupSetCommand_initTypes).call(this);
|
|
31
|
+
}
|
|
32
|
+
async commandAction(logger, args) {
|
|
33
|
+
let groupId = args.options.id;
|
|
34
|
+
try {
|
|
35
|
+
if (args.options.displayName) {
|
|
36
|
+
if (this.verbose) {
|
|
37
|
+
await logger.logToStderr(`Retrieving group id...`);
|
|
38
|
+
}
|
|
39
|
+
groupId = await entraGroup.getGroupIdByDisplayName(args.options.displayName);
|
|
40
|
+
}
|
|
41
|
+
const requestOptions = {
|
|
42
|
+
url: `${this.resource}/v1.0/groups/${groupId}`,
|
|
43
|
+
headers: {
|
|
44
|
+
accept: 'application/json;odata.metadata=none'
|
|
45
|
+
},
|
|
46
|
+
data: {
|
|
47
|
+
displayName: args.options.newDisplayName,
|
|
48
|
+
description: args.options.description === '' ? null : args.options.description,
|
|
49
|
+
mailNickName: args.options.mailNickname,
|
|
50
|
+
visibility: args.options.visibility
|
|
51
|
+
}
|
|
52
|
+
};
|
|
53
|
+
await request.patch(requestOptions);
|
|
54
|
+
const ownerIds = await this.getUserIds(logger, args.options.ownerIds, args.options.ownerUserNames);
|
|
55
|
+
if (ownerIds.length !== 0) {
|
|
56
|
+
await this.updateUsers(logger, groupId, 'owners', ownerIds);
|
|
57
|
+
}
|
|
58
|
+
else if (this.verbose) {
|
|
59
|
+
await logger.logToStderr(`No owners to update.`);
|
|
60
|
+
}
|
|
61
|
+
const memberIds = await this.getUserIds(logger, args.options.memberIds, args.options.memberUserNames);
|
|
62
|
+
if (memberIds.length !== 0) {
|
|
63
|
+
await this.updateUsers(logger, groupId, 'members', memberIds);
|
|
64
|
+
}
|
|
65
|
+
else if (this.verbose) {
|
|
66
|
+
await logger.logToStderr(`No members to update.`);
|
|
67
|
+
}
|
|
68
|
+
}
|
|
69
|
+
catch (err) {
|
|
70
|
+
this.handleRejectedODataJsonPromise(err);
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
;
|
|
74
|
+
async getUserIds(logger, userIds, userNames) {
|
|
75
|
+
if (userIds) {
|
|
76
|
+
return formatting.splitAndTrim(userIds);
|
|
77
|
+
}
|
|
78
|
+
if (userNames) {
|
|
79
|
+
if (this.verbose) {
|
|
80
|
+
await logger.logToStderr(`Retrieving user IDs...`);
|
|
81
|
+
}
|
|
82
|
+
return entraUser.getUserIdsByUpns(formatting.splitAndTrim(userNames));
|
|
83
|
+
}
|
|
84
|
+
return [];
|
|
85
|
+
}
|
|
86
|
+
async updateUsers(logger, groupId, role, userIds) {
|
|
87
|
+
const groupUsers = await odata.getAllItems(`${this.resource}/v1.0/groups/${groupId}/${role}/microsoft.graph.user?$select=id`);
|
|
88
|
+
const userIdsToAdd = userIds.filter(userId => !groupUsers.some(groupUser => groupUser.id === userId));
|
|
89
|
+
const userIdsToRemove = groupUsers.filter(groupUser => !userIds.some(userId => groupUser.id === userId)).map(user => user.id);
|
|
90
|
+
if (this.verbose) {
|
|
91
|
+
await logger.logToStderr(`Adding ${userIdsToAdd.length} ${role}...`);
|
|
92
|
+
}
|
|
93
|
+
for (let i = 0; i < userIdsToAdd.length; i += 400) {
|
|
94
|
+
const userIdsBatch = userIdsToAdd.slice(i, i + 400);
|
|
95
|
+
const batchRequestOptions = this.getBatchRequestOptions();
|
|
96
|
+
// only 20 requests per one batch are allowed
|
|
97
|
+
for (let j = 0; j < userIdsBatch.length; j += 20) {
|
|
98
|
+
// only 20 users can be added in one request
|
|
99
|
+
const userIdsChunk = userIdsBatch.slice(j, j + 20);
|
|
100
|
+
batchRequestOptions.data.requests.push({
|
|
101
|
+
id: j + 1,
|
|
102
|
+
method: 'PATCH',
|
|
103
|
+
url: `/groups/${groupId}`,
|
|
104
|
+
headers: {
|
|
105
|
+
'content-type': 'application/json;odata.metadata=none',
|
|
106
|
+
accept: 'application/json;odata.metadata=none'
|
|
107
|
+
},
|
|
108
|
+
body: {
|
|
109
|
+
[`${role}@odata.bind`]: userIdsChunk.map(u => `${this.resource}/v1.0/directoryObjects/${u}`)
|
|
110
|
+
}
|
|
111
|
+
});
|
|
112
|
+
}
|
|
113
|
+
const res = await request.post(batchRequestOptions);
|
|
114
|
+
for (const response of res.responses) {
|
|
115
|
+
if (response.status !== 204) {
|
|
116
|
+
throw response.body;
|
|
117
|
+
}
|
|
118
|
+
}
|
|
119
|
+
}
|
|
120
|
+
if (this.verbose) {
|
|
121
|
+
await logger.logToStderr(`Removing ${userIdsToRemove.length} ${role}...`);
|
|
122
|
+
}
|
|
123
|
+
for (let i = 0; i < userIdsToRemove.length; i += 20) {
|
|
124
|
+
const userIdsBatch = userIdsToRemove.slice(i, i + 20);
|
|
125
|
+
const batchRequestOptions = this.getBatchRequestOptions();
|
|
126
|
+
userIdsBatch.map(userId => {
|
|
127
|
+
batchRequestOptions.data.requests.push({
|
|
128
|
+
id: userId,
|
|
129
|
+
method: 'DELETE',
|
|
130
|
+
url: `/groups/${groupId}/${role}/${userId}/$ref`
|
|
131
|
+
});
|
|
132
|
+
});
|
|
133
|
+
const res = await request.post(batchRequestOptions);
|
|
134
|
+
for (const response of res.responses) {
|
|
135
|
+
if (response.status !== 204) {
|
|
136
|
+
throw response.body;
|
|
137
|
+
}
|
|
138
|
+
}
|
|
139
|
+
}
|
|
140
|
+
}
|
|
141
|
+
getBatchRequestOptions() {
|
|
142
|
+
const requestOptions = {
|
|
143
|
+
url: `${this.resource}/v1.0/$batch`,
|
|
144
|
+
headers: {
|
|
145
|
+
'content-type': 'application/json;odata.metadata=none',
|
|
146
|
+
accept: 'application/json;odata.metadata=none'
|
|
147
|
+
},
|
|
148
|
+
responseType: 'json',
|
|
149
|
+
data: {
|
|
150
|
+
requests: []
|
|
151
|
+
}
|
|
152
|
+
};
|
|
153
|
+
return requestOptions;
|
|
154
|
+
}
|
|
155
|
+
}
|
|
156
|
+
_EntraGroupSetCommand_instances = new WeakSet(), _EntraGroupSetCommand_initTelemetry = function _EntraGroupSetCommand_initTelemetry() {
|
|
157
|
+
this.telemetry.push((args) => {
|
|
158
|
+
Object.assign(this.telemetryProperties, {
|
|
159
|
+
id: typeof args.options.id !== 'undefined',
|
|
160
|
+
displayName: typeof args.options.displayName !== 'undefined',
|
|
161
|
+
newDisplayName: typeof args.options.newDisplayName !== 'undefined',
|
|
162
|
+
description: typeof args.options.description !== 'undefined',
|
|
163
|
+
mailNickname: typeof args.options.mailNickname !== 'undefined',
|
|
164
|
+
ownerIds: typeof args.options.ownerIds !== 'undefined',
|
|
165
|
+
ownerUserNames: typeof args.options.ownerUserNames !== 'undefined',
|
|
166
|
+
memberIds: typeof args.options.memberIds !== 'undefined',
|
|
167
|
+
memberUserNames: typeof args.options.memberUserNames !== 'undefined',
|
|
168
|
+
visibility: typeof args.options.visibility !== 'undefined'
|
|
169
|
+
});
|
|
170
|
+
});
|
|
171
|
+
}, _EntraGroupSetCommand_initOptions = function _EntraGroupSetCommand_initOptions() {
|
|
172
|
+
this.options.unshift({
|
|
173
|
+
option: '-i, --id [id]'
|
|
174
|
+
}, {
|
|
175
|
+
option: '--mailNickname [mailNickname]'
|
|
176
|
+
}, {
|
|
177
|
+
option: '-n, --displayName [displayName]'
|
|
178
|
+
}, {
|
|
179
|
+
option: '--newDisplayName [newDisplayName]'
|
|
180
|
+
}, {
|
|
181
|
+
option: '--description [description]'
|
|
182
|
+
}, {
|
|
183
|
+
option: '--ownerIds [ownerIds]'
|
|
184
|
+
}, {
|
|
185
|
+
option: '--ownerUserNames [ownerUserNames]'
|
|
186
|
+
}, {
|
|
187
|
+
option: '--memberIds [memberIds]'
|
|
188
|
+
}, {
|
|
189
|
+
option: '--memberUserNames [memberUserNames]'
|
|
190
|
+
}, {
|
|
191
|
+
option: '--visibility [visibility]',
|
|
192
|
+
autocomplete: this.allowedVisibility
|
|
193
|
+
});
|
|
194
|
+
}, _EntraGroupSetCommand_initValidators = function _EntraGroupSetCommand_initValidators() {
|
|
195
|
+
this.validators.push(async (args) => {
|
|
196
|
+
if (args.options.id && !validation.isValidGuid(args.options.id)) {
|
|
197
|
+
return `Value '${args.options.id}' is not a valid GUID for option 'id'.`;
|
|
198
|
+
}
|
|
199
|
+
if (args.options.newDisplayName && args.options.newDisplayName.length > 256) {
|
|
200
|
+
return `The maximum amount of characters for 'newDisplayName' is 256.`;
|
|
201
|
+
}
|
|
202
|
+
if (args.options.mailNickname) {
|
|
203
|
+
if (!validation.isValidMailNickname(args.options.mailNickname)) {
|
|
204
|
+
return `Value '${args.options.mailNickname}' for option 'mailNickname' must contain only characters in the ASCII character set 0-127 except the following: @ () \ [] " ; : <> , SPACE.`;
|
|
205
|
+
}
|
|
206
|
+
if (args.options.mailNickname.length > 64) {
|
|
207
|
+
return `The maximum amount of characters for 'mailNickname' is 64.`;
|
|
208
|
+
}
|
|
209
|
+
}
|
|
210
|
+
if (args.options.ownerIds) {
|
|
211
|
+
const isValidGUIDArrayResult = validation.isValidGuidArray(args.options.ownerIds);
|
|
212
|
+
if (isValidGUIDArrayResult !== true) {
|
|
213
|
+
return `The following GUIDs are invalid for option 'ownerIds': ${isValidGUIDArrayResult}.`;
|
|
214
|
+
}
|
|
215
|
+
}
|
|
216
|
+
if (args.options.ownerUserNames) {
|
|
217
|
+
const isValidUPNArrayResult = validation.isValidUserPrincipalNameArray(args.options.ownerUserNames);
|
|
218
|
+
if (isValidUPNArrayResult !== true) {
|
|
219
|
+
return `The following user principal names are invalid for option 'ownerUserNames': ${isValidUPNArrayResult}.`;
|
|
220
|
+
}
|
|
221
|
+
}
|
|
222
|
+
if (args.options.memberIds) {
|
|
223
|
+
const isValidGUIDArrayResult = validation.isValidGuidArray(args.options.memberIds);
|
|
224
|
+
if (isValidGUIDArrayResult !== true) {
|
|
225
|
+
return `The following GUIDs are invalid for option 'memberIds': ${isValidGUIDArrayResult}.`;
|
|
226
|
+
}
|
|
227
|
+
}
|
|
228
|
+
if (args.options.memberUserNames) {
|
|
229
|
+
const isValidUPNArrayResult = validation.isValidUserPrincipalNameArray(args.options.memberUserNames);
|
|
230
|
+
if (isValidUPNArrayResult !== true) {
|
|
231
|
+
return `The following user principal names are invalid for option 'memberUserNames': ${isValidUPNArrayResult}.`;
|
|
232
|
+
}
|
|
233
|
+
}
|
|
234
|
+
if (args.options.visibility && !this.allowedVisibility.includes(args.options.visibility)) {
|
|
235
|
+
return `Option 'visibility' must be one of the following values: ${this.allowedVisibility.join(', ')}.`;
|
|
236
|
+
}
|
|
237
|
+
if (args.options.newDisplayName === undefined && args.options.description === undefined && args.options.visibility === undefined
|
|
238
|
+
&& args.options.ownerIds === undefined && args.options.ownerUserNames === undefined && args.options.memberIds === undefined
|
|
239
|
+
&& args.options.memberUserNames === undefined && args.options.mailNickname === undefined) {
|
|
240
|
+
return `Specify at least one of the following options: 'newDisplayName', 'description', 'visibility', 'ownerIds', 'ownerUserNames', 'memberIds', 'memberUserNames', 'mailNickname'.`;
|
|
241
|
+
}
|
|
242
|
+
return true;
|
|
243
|
+
});
|
|
244
|
+
}, _EntraGroupSetCommand_initOptionSets = function _EntraGroupSetCommand_initOptionSets() {
|
|
245
|
+
this.optionSets.push({ options: ['id', 'displayName'] }, {
|
|
246
|
+
options: ['ownerIds', 'ownerUserNames'],
|
|
247
|
+
runsWhen: (args) => args.options.ownerIds || args.options.ownerUserNames
|
|
248
|
+
}, {
|
|
249
|
+
options: ['memberIds', 'memberUserNames'],
|
|
250
|
+
runsWhen: (args) => args.options.memberIds || args.options.memberUserNames
|
|
251
|
+
});
|
|
252
|
+
}, _EntraGroupSetCommand_initTypes = function _EntraGroupSetCommand_initTypes() {
|
|
253
|
+
this.types.string.push('id', 'displayName', 'newDisplayName', 'description', 'mailNickname', 'ownerIds', 'ownerUserNames', 'memberIds', 'memberUserNames', 'visibility');
|
|
254
|
+
};
|
|
255
|
+
export default new EntraGroupSetCommand();
|
|
256
|
+
//# sourceMappingURL=group-set.js.map
|
|
@@ -35,10 +35,12 @@ export default {
|
|
|
35
35
|
ENTERPRISEAPP_ADD: `${prefix} enterpriseapp add`,
|
|
36
36
|
ENTERPRISEAPP_GET: `${prefix} enterpriseapp get`,
|
|
37
37
|
ENTERPRISEAPP_LIST: `${prefix} enterpriseapp list`,
|
|
38
|
+
ENTERPRISEAPP_REMOVE: `${prefix} enterpriseapp remove`,
|
|
38
39
|
GROUP_ADD: `${prefix} group add`,
|
|
39
40
|
GROUP_GET: `${prefix} group get`,
|
|
40
41
|
GROUP_LIST: `${prefix} group list`,
|
|
41
42
|
GROUP_REMOVE: `${prefix} group remove`,
|
|
43
|
+
GROUP_SET: `${prefix} group set`,
|
|
42
44
|
GROUP_USER_ADD: `${prefix} group user add`,
|
|
43
45
|
GROUP_USER_LIST: `${prefix} group user list`,
|
|
44
46
|
GROUP_USER_SET: `${prefix} group user set`,
|
|
@@ -92,6 +94,7 @@ export default {
|
|
|
92
94
|
SP_ADD: `${prefix} sp add`,
|
|
93
95
|
SP_GET: `${prefix} sp get`,
|
|
94
96
|
SP_LIST: `${prefix} sp list`,
|
|
97
|
+
SP_REMOVE: `${prefix} sp remove`,
|
|
95
98
|
USER_ADD: `${prefix} user add`,
|
|
96
99
|
USER_GET: `${prefix} user get`,
|
|
97
100
|
USER_GUEST_ADD: `${prefix} user guest add`,
|