@pnp/cli-microsoft365 10.0.0-beta.7dfc31a → 10.0.0-beta.a4e89de
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/Auth.js +11 -12
- package/dist/cli/cli.js +14 -0
- package/dist/config.js +60 -5
- package/dist/m365/base/PowerAutomateCommand.js +1 -1
- package/dist/m365/base/SpoCommand.js +1 -1
- package/dist/m365/cli/commands/cli-consent.js +2 -2
- package/dist/m365/cli/commands/cli-doctor.js +2 -2
- package/dist/m365/cli/commands/cli-reconsent.js +2 -3
- package/dist/m365/cli/commands/config/config-set.js +12 -4
- package/dist/m365/commands/login.js +28 -9
- package/dist/m365/commands/setup.js +256 -33
- package/dist/m365/commands/setupPresets.js +2 -4
- package/dist/m365/connection/commands/connection-list.js +4 -4
- package/dist/m365/entra/commands/app/app-add.js +52 -288
- package/dist/m365/flow/commands/environment/environment-get.js +1 -1
- package/dist/m365/flow/commands/environment/environment-list.js +1 -1
- package/dist/m365/flow/commands/flow-disable.js +1 -1
- package/dist/m365/flow/commands/flow-enable.js +1 -1
- package/dist/m365/flow/commands/flow-export.js +17 -16
- package/dist/m365/flow/commands/flow-get.js +1 -1
- package/dist/m365/flow/commands/flow-list.js +1 -1
- package/dist/m365/flow/commands/flow-remove.js +1 -1
- package/dist/m365/flow/commands/owner/owner-ensure.js +1 -1
- package/dist/m365/flow/commands/owner/owner-list.js +1 -1
- package/dist/m365/flow/commands/owner/owner-remove.js +1 -1
- package/dist/m365/flow/commands/recyclebinitem/recyclebinitem-list.js +47 -0
- package/dist/m365/flow/commands/recyclebinitem/recyclebinitem-restore.js +48 -0
- package/dist/m365/flow/commands/run/run-cancel.js +1 -1
- package/dist/m365/flow/commands/run/run-get.js +1 -1
- package/dist/m365/flow/commands/run/run-list.js +1 -1
- package/dist/m365/flow/commands/run/run-resubmit.js +2 -2
- package/dist/m365/flow/commands.js +2 -0
- package/dist/m365/spo/commands/contenttype/contenttype-field-remove.js +8 -8
- package/dist/m365/spo/commands/contenttype/contenttype-field-set.js +2 -2
- package/dist/m365/spo/commands/file/file-roleassignment-add.js +17 -54
- package/dist/m365/spo/commands/file/file-roleassignment-remove.js +13 -40
- package/dist/m365/spo/commands/file/file-roleinheritance-break.js +5 -13
- package/dist/m365/spo/commands/file/file-roleinheritance-reset.js +5 -13
- package/dist/m365/spo/commands/folder/folder-sharinglink-add.js +143 -0
- package/dist/m365/spo/commands/folder/folder-sharinglink-clear.js +111 -0
- package/dist/m365/spo/commands/folder/folder-sharinglink-remove.js +95 -0
- package/dist/m365/spo/commands/list/list-get.js +17 -4
- package/dist/m365/spo/commands/page/page-section-add.js +185 -34
- package/dist/m365/spo/commands/site/SiteAdmin.js +2 -0
- package/dist/m365/spo/commands/site/site-admin-add.js +252 -0
- package/dist/m365/spo/commands/site/site-admin-list.js +2 -27
- package/dist/m365/spo/commands/user/user-get.js +67 -9
- package/dist/m365/spo/commands.js +4 -0
- package/dist/m365/spp/commands/contentcenter/contentcenter-list.js +56 -0
- package/dist/m365/spp/commands.js +5 -0
- package/dist/settingsNames.js +6 -1
- package/dist/utils/entraApp.js +283 -0
- package/dist/utils/spo.js +75 -7
- package/docs/docs/_clisettings.mdx +6 -1
- package/docs/docs/cmd/flow/recyclebinitem/recyclebinitem-list.mdx +132 -0
- package/docs/docs/cmd/flow/recyclebinitem/recyclebinitem-restore.mdx +55 -0
- package/docs/docs/cmd/setup.mdx +17 -6
- package/docs/docs/cmd/spo/contenttype/contenttype-field-remove.mdx +7 -7
- package/docs/docs/cmd/spo/contenttype/contenttype-field-set.mdx +2 -2
- package/docs/docs/cmd/spo/folder/folder-sharinglink-add.mdx +125 -0
- package/docs/docs/cmd/spo/folder/folder-sharinglink-clear.mdx +50 -0
- package/docs/docs/cmd/spo/folder/folder-sharinglink-remove.mdx +50 -0
- package/docs/docs/cmd/spo/page/page-section-add.mdx +57 -2
- package/docs/docs/cmd/spo/site/site-admin-add.mdx +67 -0
- package/docs/docs/cmd/spo/user/user-get.mdx +35 -9
- package/docs/docs/cmd/spp/contentcenter/contentcenter-list.mdx +289 -0
- package/package.json +1 -1
|
@@ -0,0 +1,283 @@
|
|
|
1
|
+
import fs from 'fs';
|
|
2
|
+
import request from '../request.js';
|
|
3
|
+
import { odata } from './odata.js';
|
|
4
|
+
async function getCertificateBase64Encoded({ options, logger, debug }) {
|
|
5
|
+
if (options.certificateBase64Encoded) {
|
|
6
|
+
return options.certificateBase64Encoded;
|
|
7
|
+
}
|
|
8
|
+
if (debug) {
|
|
9
|
+
await logger.logToStderr(`Reading existing ${options.certificateFile}...`);
|
|
10
|
+
}
|
|
11
|
+
try {
|
|
12
|
+
return fs.readFileSync(options.certificateFile, { encoding: 'base64' });
|
|
13
|
+
}
|
|
14
|
+
catch (e) {
|
|
15
|
+
throw new Error(`Error reading certificate file: ${e}. Please add the certificate using base64 option '--certificateBase64Encoded'.`);
|
|
16
|
+
}
|
|
17
|
+
}
|
|
18
|
+
async function createServicePrincipal(appId) {
|
|
19
|
+
const requestOptions = {
|
|
20
|
+
url: `https://graph.microsoft.com/v1.0/myorganization/servicePrincipals`,
|
|
21
|
+
headers: {
|
|
22
|
+
'content-type': 'application/json'
|
|
23
|
+
},
|
|
24
|
+
data: {
|
|
25
|
+
appId: appId
|
|
26
|
+
},
|
|
27
|
+
responseType: 'json'
|
|
28
|
+
};
|
|
29
|
+
return request.post(requestOptions);
|
|
30
|
+
}
|
|
31
|
+
async function grantOAuth2Permission({ appId, resourceId, scopeName }) {
|
|
32
|
+
const grantAdminConsentApplicationRequestOptions = {
|
|
33
|
+
url: `https://graph.microsoft.com/v1.0/myorganization/oauth2PermissionGrants`,
|
|
34
|
+
headers: {
|
|
35
|
+
accept: 'application/json;odata.metadata=none'
|
|
36
|
+
},
|
|
37
|
+
responseType: 'json',
|
|
38
|
+
data: {
|
|
39
|
+
clientId: appId,
|
|
40
|
+
consentType: "AllPrincipals",
|
|
41
|
+
principalId: null,
|
|
42
|
+
resourceId: resourceId,
|
|
43
|
+
scope: scopeName
|
|
44
|
+
}
|
|
45
|
+
};
|
|
46
|
+
return request.post(grantAdminConsentApplicationRequestOptions);
|
|
47
|
+
}
|
|
48
|
+
async function addRoleToServicePrincipal({ objectId, resourceId, appRoleId }) {
|
|
49
|
+
const requestOptions = {
|
|
50
|
+
url: `https://graph.microsoft.com/v1.0/myorganization/servicePrincipals/${objectId}/appRoleAssignments`,
|
|
51
|
+
headers: {
|
|
52
|
+
'Content-Type': 'application/json'
|
|
53
|
+
},
|
|
54
|
+
responseType: 'json',
|
|
55
|
+
data: {
|
|
56
|
+
appRoleId: appRoleId,
|
|
57
|
+
principalId: objectId,
|
|
58
|
+
resourceId: resourceId
|
|
59
|
+
}
|
|
60
|
+
};
|
|
61
|
+
return request.post(requestOptions);
|
|
62
|
+
}
|
|
63
|
+
async function getRequiredResourceAccessForApis({ servicePrincipals, apis, scopeType, logger, debug }) {
|
|
64
|
+
if (!apis) {
|
|
65
|
+
return [];
|
|
66
|
+
}
|
|
67
|
+
const resolvedApis = [];
|
|
68
|
+
const requestedApis = apis.split(',').map(a => a.trim());
|
|
69
|
+
for (const api of requestedApis) {
|
|
70
|
+
const pos = api.lastIndexOf('/');
|
|
71
|
+
const permissionName = api.substring(pos + 1);
|
|
72
|
+
const servicePrincipalName = api.substring(0, pos);
|
|
73
|
+
if (debug) {
|
|
74
|
+
await logger.logToStderr(`Resolving ${api}...`);
|
|
75
|
+
await logger.logToStderr(`Permission name: ${permissionName}`);
|
|
76
|
+
await logger.logToStderr(`Service principal name: ${servicePrincipalName}`);
|
|
77
|
+
}
|
|
78
|
+
const servicePrincipal = servicePrincipals.find(sp => (sp.servicePrincipalNames.indexOf(servicePrincipalName) > -1 ||
|
|
79
|
+
sp.servicePrincipalNames.indexOf(`${servicePrincipalName}/`) > -1));
|
|
80
|
+
if (!servicePrincipal) {
|
|
81
|
+
throw `Service principal ${servicePrincipalName} not found`;
|
|
82
|
+
}
|
|
83
|
+
const scopesOfType = scopeType === 'Scope' ? servicePrincipal.oauth2PermissionScopes : servicePrincipal.appRoles;
|
|
84
|
+
const permission = scopesOfType.find(scope => scope.value === permissionName);
|
|
85
|
+
if (!permission) {
|
|
86
|
+
throw `Permission ${permissionName} for service principal ${servicePrincipalName} not found`;
|
|
87
|
+
}
|
|
88
|
+
let resolvedApi = resolvedApis.find(a => a.resourceAppId === servicePrincipal.appId);
|
|
89
|
+
if (!resolvedApi) {
|
|
90
|
+
resolvedApi = {
|
|
91
|
+
resourceAppId: servicePrincipal.appId,
|
|
92
|
+
resourceAccess: []
|
|
93
|
+
};
|
|
94
|
+
resolvedApis.push(resolvedApi);
|
|
95
|
+
}
|
|
96
|
+
const resourceAccessPermission = {
|
|
97
|
+
id: permission.id,
|
|
98
|
+
type: scopeType
|
|
99
|
+
};
|
|
100
|
+
resolvedApi.resourceAccess.push(resourceAccessPermission);
|
|
101
|
+
updateAppPermissions({
|
|
102
|
+
spId: servicePrincipal.id,
|
|
103
|
+
resourceAccessPermission,
|
|
104
|
+
oAuth2PermissionValue: permission.value
|
|
105
|
+
});
|
|
106
|
+
}
|
|
107
|
+
return resolvedApis;
|
|
108
|
+
}
|
|
109
|
+
function updateAppPermissions({ spId, resourceAccessPermission, oAuth2PermissionValue }) {
|
|
110
|
+
// During API resolution, we store globally both app role assignments and oauth2permissions
|
|
111
|
+
// So that we'll be able to parse them during the admin consent process
|
|
112
|
+
let existingPermission = entraApp.appPermissions.find(oauth => oauth.resourceId === spId);
|
|
113
|
+
if (!existingPermission) {
|
|
114
|
+
existingPermission = {
|
|
115
|
+
resourceId: spId,
|
|
116
|
+
resourceAccess: [],
|
|
117
|
+
scope: []
|
|
118
|
+
};
|
|
119
|
+
entraApp.appPermissions.push(existingPermission);
|
|
120
|
+
}
|
|
121
|
+
if (resourceAccessPermission.type === 'Scope' && oAuth2PermissionValue && !existingPermission.scope.find(scp => scp === oAuth2PermissionValue)) {
|
|
122
|
+
existingPermission.scope.push(oAuth2PermissionValue);
|
|
123
|
+
}
|
|
124
|
+
if (!existingPermission.resourceAccess.find(res => res.id === resourceAccessPermission.id)) {
|
|
125
|
+
existingPermission.resourceAccess.push(resourceAccessPermission);
|
|
126
|
+
}
|
|
127
|
+
}
|
|
128
|
+
export const entraApp = {
|
|
129
|
+
appPermissions: [],
|
|
130
|
+
createAppRegistration: async ({ options, apis, logger, verbose, debug }) => {
|
|
131
|
+
const applicationInfo = {
|
|
132
|
+
displayName: options.name,
|
|
133
|
+
signInAudience: options.multitenant ? 'AzureADMultipleOrgs' : 'AzureADMyOrg'
|
|
134
|
+
};
|
|
135
|
+
if (apis.length > 0) {
|
|
136
|
+
applicationInfo.requiredResourceAccess = apis;
|
|
137
|
+
}
|
|
138
|
+
if (options.redirectUris) {
|
|
139
|
+
applicationInfo[options.platform] = {
|
|
140
|
+
redirectUris: options.redirectUris.split(',').map(u => u.trim())
|
|
141
|
+
};
|
|
142
|
+
}
|
|
143
|
+
if (options.implicitFlow) {
|
|
144
|
+
if (!applicationInfo.web) {
|
|
145
|
+
applicationInfo.web = {};
|
|
146
|
+
}
|
|
147
|
+
applicationInfo.web.implicitGrantSettings = {
|
|
148
|
+
enableAccessTokenIssuance: true,
|
|
149
|
+
enableIdTokenIssuance: true
|
|
150
|
+
};
|
|
151
|
+
}
|
|
152
|
+
if (options.certificateFile || options.certificateBase64Encoded) {
|
|
153
|
+
const certificateBase64Encoded = await getCertificateBase64Encoded({ options, logger, debug });
|
|
154
|
+
const newKeyCredential = {
|
|
155
|
+
type: 'AsymmetricX509Cert',
|
|
156
|
+
usage: 'Verify',
|
|
157
|
+
displayName: options.certificateDisplayName,
|
|
158
|
+
key: certificateBase64Encoded
|
|
159
|
+
};
|
|
160
|
+
applicationInfo.keyCredentials = [newKeyCredential];
|
|
161
|
+
}
|
|
162
|
+
if (options.allowPublicClientFlows) {
|
|
163
|
+
applicationInfo.isFallbackPublicClient = true;
|
|
164
|
+
}
|
|
165
|
+
if (verbose) {
|
|
166
|
+
await logger.logToStderr(`Creating Microsoft Entra app registration...`);
|
|
167
|
+
}
|
|
168
|
+
const createApplicationRequestOptions = {
|
|
169
|
+
url: `https://graph.microsoft.com/v1.0/myorganization/applications`,
|
|
170
|
+
headers: {
|
|
171
|
+
accept: 'application/json;odata.metadata=none'
|
|
172
|
+
},
|
|
173
|
+
responseType: 'json',
|
|
174
|
+
data: applicationInfo
|
|
175
|
+
};
|
|
176
|
+
return request.post(createApplicationRequestOptions);
|
|
177
|
+
},
|
|
178
|
+
grantAdminConsent: async ({ appInfo, appPermissions, adminConsent, logger, debug }) => {
|
|
179
|
+
if (!adminConsent || appPermissions.length === 0) {
|
|
180
|
+
return appInfo;
|
|
181
|
+
}
|
|
182
|
+
const sp = await createServicePrincipal(appInfo.appId);
|
|
183
|
+
if (debug) {
|
|
184
|
+
await logger.logToStderr("Service principal created, returned object id: " + sp.id);
|
|
185
|
+
}
|
|
186
|
+
const tasks = [];
|
|
187
|
+
appPermissions.forEach(async (permission) => {
|
|
188
|
+
if (permission.scope.length > 0) {
|
|
189
|
+
tasks.push(grantOAuth2Permission({
|
|
190
|
+
appId: sp.id,
|
|
191
|
+
resourceId: permission.resourceId,
|
|
192
|
+
scopeName: permission.scope.join(' ')
|
|
193
|
+
}));
|
|
194
|
+
if (debug) {
|
|
195
|
+
await logger.logToStderr(`Admin consent granted for following resource ${permission.resourceId}, with delegated permissions: ${permission.scope.join(',')}`);
|
|
196
|
+
}
|
|
197
|
+
}
|
|
198
|
+
permission.resourceAccess.filter(access => access.type === "Role").forEach(async (access) => {
|
|
199
|
+
tasks.push(addRoleToServicePrincipal({
|
|
200
|
+
objectId: sp.id,
|
|
201
|
+
resourceId: permission.resourceId,
|
|
202
|
+
appRoleId: access.id
|
|
203
|
+
}));
|
|
204
|
+
if (debug) {
|
|
205
|
+
await logger.logToStderr(`Admin consent granted for following resource ${permission.resourceId}, with application permission: ${access.id}`);
|
|
206
|
+
}
|
|
207
|
+
});
|
|
208
|
+
});
|
|
209
|
+
await Promise.all(tasks);
|
|
210
|
+
return appInfo;
|
|
211
|
+
},
|
|
212
|
+
resolveApis: async ({ options, manifest, logger, verbose, debug }) => {
|
|
213
|
+
if (!options.apisDelegated && !options.apisApplication
|
|
214
|
+
&& (typeof manifest?.requiredResourceAccess === 'undefined' || manifest.requiredResourceAccess.length === 0)) {
|
|
215
|
+
return [];
|
|
216
|
+
}
|
|
217
|
+
if (verbose) {
|
|
218
|
+
await logger.logToStderr('Resolving requested APIs...');
|
|
219
|
+
}
|
|
220
|
+
const servicePrincipals = await odata.getAllItems(`https://graph.microsoft.com/v1.0/myorganization/servicePrincipals?$select=appId,appRoles,id,oauth2PermissionScopes,servicePrincipalNames`);
|
|
221
|
+
let resolvedApis = [];
|
|
222
|
+
if (options.apisDelegated || options.apisApplication) {
|
|
223
|
+
resolvedApis = await getRequiredResourceAccessForApis({
|
|
224
|
+
servicePrincipals,
|
|
225
|
+
apis: options.apisDelegated,
|
|
226
|
+
scopeType: 'Scope',
|
|
227
|
+
logger,
|
|
228
|
+
debug
|
|
229
|
+
});
|
|
230
|
+
if (verbose) {
|
|
231
|
+
await logger.logToStderr(`Resolved delegated permissions: ${JSON.stringify(resolvedApis, null, 2)}`);
|
|
232
|
+
}
|
|
233
|
+
const resolvedApplicationApis = await getRequiredResourceAccessForApis({
|
|
234
|
+
servicePrincipals,
|
|
235
|
+
apis: options.apisApplication,
|
|
236
|
+
scopeType: 'Role',
|
|
237
|
+
logger,
|
|
238
|
+
debug
|
|
239
|
+
});
|
|
240
|
+
if (verbose) {
|
|
241
|
+
await logger.logToStderr(`Resolved application permissions: ${JSON.stringify(resolvedApplicationApis, null, 2)}`);
|
|
242
|
+
}
|
|
243
|
+
// merge resolved application APIs onto resolved delegated APIs
|
|
244
|
+
resolvedApplicationApis.forEach(resolvedRequiredResource => {
|
|
245
|
+
const requiredResource = resolvedApis.find(api => api.resourceAppId === resolvedRequiredResource.resourceAppId);
|
|
246
|
+
if (requiredResource) {
|
|
247
|
+
requiredResource.resourceAccess.push(...resolvedRequiredResource.resourceAccess);
|
|
248
|
+
}
|
|
249
|
+
else {
|
|
250
|
+
resolvedApis.push(resolvedRequiredResource);
|
|
251
|
+
}
|
|
252
|
+
});
|
|
253
|
+
}
|
|
254
|
+
else {
|
|
255
|
+
const manifestApis = manifest.requiredResourceAccess;
|
|
256
|
+
manifestApis.forEach(manifestApi => {
|
|
257
|
+
resolvedApis.push(manifestApi);
|
|
258
|
+
const app = servicePrincipals.find(servicePrincipals => servicePrincipals.appId === manifestApi.resourceAppId);
|
|
259
|
+
if (app) {
|
|
260
|
+
manifestApi.resourceAccess.forEach((res => {
|
|
261
|
+
const resourceAccessPermission = {
|
|
262
|
+
id: res.id,
|
|
263
|
+
type: res.type
|
|
264
|
+
};
|
|
265
|
+
const oAuthValue = app.oauth2PermissionScopes.find(scp => scp.id === res.id)?.value;
|
|
266
|
+
updateAppPermissions({
|
|
267
|
+
spId: app.id,
|
|
268
|
+
resourceAccessPermission,
|
|
269
|
+
oAuth2PermissionValue: oAuthValue
|
|
270
|
+
});
|
|
271
|
+
}));
|
|
272
|
+
}
|
|
273
|
+
});
|
|
274
|
+
}
|
|
275
|
+
if (verbose) {
|
|
276
|
+
await logger.logToStderr(`Merged delegated and application permissions: ${JSON.stringify(resolvedApis, null, 2)}`);
|
|
277
|
+
await logger.logToStderr(`App role assignments: ${JSON.stringify(entraApp.appPermissions.flatMap(permission => permission.resourceAccess.filter(access => access.type === "Role")), null, 2)}`);
|
|
278
|
+
await logger.logToStderr(`OAuth2 permissions: ${JSON.stringify(entraApp.appPermissions.flatMap(permission => permission.scope), null, 2)}`);
|
|
279
|
+
}
|
|
280
|
+
return resolvedApis;
|
|
281
|
+
}
|
|
282
|
+
};
|
|
283
|
+
//# sourceMappingURL=entraApp.js.map
|
package/dist/utils/spo.js
CHANGED
|
@@ -500,10 +500,10 @@ export const spo = {
|
|
|
500
500
|
* @param webUrl Web url
|
|
501
501
|
* @param email The email of the user
|
|
502
502
|
* @param logger the Logger object
|
|
503
|
-
* @param verbose set
|
|
503
|
+
* @param verbose set for verbose logging
|
|
504
504
|
*/
|
|
505
505
|
async getUserByEmail(webUrl, email, logger, verbose) {
|
|
506
|
-
if (verbose) {
|
|
506
|
+
if (verbose && logger) {
|
|
507
507
|
await logger.logToStderr(`Retrieving the spo user by email ${email}`);
|
|
508
508
|
}
|
|
509
509
|
const requestUrl = `${webUrl}/_api/web/siteusers/GetByEmail('${formatting.encodeQueryParameter(email)}')`;
|
|
@@ -574,10 +574,10 @@ export const spo = {
|
|
|
574
574
|
* @param webUrl Web url
|
|
575
575
|
* @param name The name of the group
|
|
576
576
|
* @param logger the Logger object
|
|
577
|
-
* @param verbose set
|
|
577
|
+
* @param verbose set for verbose logging
|
|
578
578
|
*/
|
|
579
579
|
async getGroupByName(webUrl, name, logger, verbose) {
|
|
580
|
-
if (verbose) {
|
|
580
|
+
if (verbose && logger) {
|
|
581
581
|
await logger.logToStderr(`Retrieving the group by name ${name}`);
|
|
582
582
|
}
|
|
583
583
|
const requestUrl = `${webUrl}/_api/web/sitegroups/GetByName('${formatting.encodeQueryParameter(name)}')`;
|
|
@@ -596,10 +596,10 @@ export const spo = {
|
|
|
596
596
|
* @param webUrl Web url
|
|
597
597
|
* @param name the name of the role definition
|
|
598
598
|
* @param logger the Logger object
|
|
599
|
-
* @param
|
|
599
|
+
* @param verbose set for verbose logging
|
|
600
600
|
*/
|
|
601
|
-
async getRoleDefinitionByName(webUrl, name, logger,
|
|
602
|
-
if (
|
|
601
|
+
async getRoleDefinitionByName(webUrl, name, logger, verbose) {
|
|
602
|
+
if (verbose && logger) {
|
|
603
603
|
await logger.logToStderr(`Retrieving the role definitions for ${name}`);
|
|
604
604
|
}
|
|
605
605
|
const roledefinitions = await odata.getAllItems(`${webUrl}/_api/web/roledefinitions`);
|
|
@@ -1527,6 +1527,29 @@ export const spo = {
|
|
|
1527
1527
|
const itemsResponse = await request.get(requestOptionsItems);
|
|
1528
1528
|
return (itemsResponse);
|
|
1529
1529
|
},
|
|
1530
|
+
/**
|
|
1531
|
+
* Retrieves the file by id.
|
|
1532
|
+
* Returns a FileProperties object
|
|
1533
|
+
* @param webUrl Web url
|
|
1534
|
+
* @param id the id of the file
|
|
1535
|
+
* @param logger the Logger object
|
|
1536
|
+
* @param verbose set for verbose logging
|
|
1537
|
+
*/
|
|
1538
|
+
async getFileById(webUrl, id, logger, verbose) {
|
|
1539
|
+
if (verbose && logger) {
|
|
1540
|
+
await logger.logToStderr(`Retrieving the file with id ${id}`);
|
|
1541
|
+
}
|
|
1542
|
+
const requestUrl = `${webUrl}/_api/web/GetFileById('${formatting.encodeQueryParameter(id)}')`;
|
|
1543
|
+
const requestOptions = {
|
|
1544
|
+
url: requestUrl,
|
|
1545
|
+
headers: {
|
|
1546
|
+
'accept': 'application/json;odata=nometadata'
|
|
1547
|
+
},
|
|
1548
|
+
responseType: 'json'
|
|
1549
|
+
};
|
|
1550
|
+
const file = await request.get(requestOptions);
|
|
1551
|
+
return file;
|
|
1552
|
+
},
|
|
1530
1553
|
/**
|
|
1531
1554
|
* Create a SharePoint copy job to copy a file/folder to another location.
|
|
1532
1555
|
* @param webUrl Absolute web URL where the source file/folder is located.
|
|
@@ -1590,6 +1613,51 @@ export const spo = {
|
|
|
1590
1613
|
// Get the destination object information
|
|
1591
1614
|
const objectInfo = logs.find(l => l.Event === 'JobFinishedObjectInfo');
|
|
1592
1615
|
return objectInfo;
|
|
1616
|
+
},
|
|
1617
|
+
/**
|
|
1618
|
+
* Gets the site collection URL for a given web URL using SP Admin site.
|
|
1619
|
+
* @param adminUrl The SharePoint admin URL
|
|
1620
|
+
* @param siteId The site ID
|
|
1621
|
+
* @param logger The logger object
|
|
1622
|
+
* @param verbose If in verbose mode
|
|
1623
|
+
* @returns Owner login name
|
|
1624
|
+
*/
|
|
1625
|
+
async getPrimaryAdminLoginNameAsAdmin(adminUrl, siteId, logger, verbose) {
|
|
1626
|
+
if (verbose) {
|
|
1627
|
+
await logger.logToStderr('Getting the primary admin login name...');
|
|
1628
|
+
}
|
|
1629
|
+
const requestOptions = {
|
|
1630
|
+
url: `${adminUrl}/_api/SPO.Tenant/sites('${siteId}')?$select=OwnerLoginName`,
|
|
1631
|
+
headers: {
|
|
1632
|
+
accept: 'application/json;odata=nometadata',
|
|
1633
|
+
'content-type': 'application/json;charset=utf-8'
|
|
1634
|
+
}
|
|
1635
|
+
};
|
|
1636
|
+
const response = await request.get(requestOptions);
|
|
1637
|
+
const responseContent = JSON.parse(response);
|
|
1638
|
+
return responseContent.OwnerLoginName;
|
|
1639
|
+
},
|
|
1640
|
+
/**
|
|
1641
|
+
* Gets the primary owner login from a site.
|
|
1642
|
+
* @param siteUrl The site URL
|
|
1643
|
+
* @param logger The logger object
|
|
1644
|
+
* @param verbose If in verbose mode
|
|
1645
|
+
* @returns Owner login name
|
|
1646
|
+
*/
|
|
1647
|
+
async getPrimaryOwnerLoginFromSite(siteUrl, logger, verbose) {
|
|
1648
|
+
if (verbose) {
|
|
1649
|
+
await logger.logToStderr('Getting the primary admin login name...');
|
|
1650
|
+
}
|
|
1651
|
+
const requestOptions = {
|
|
1652
|
+
url: `${siteUrl}/_api/site/owner`,
|
|
1653
|
+
method: 'GET',
|
|
1654
|
+
headers: {
|
|
1655
|
+
'accept': 'application/json;odata=nometadata'
|
|
1656
|
+
},
|
|
1657
|
+
responseType: 'json'
|
|
1658
|
+
};
|
|
1659
|
+
const responseContent = await request.get(requestOptions);
|
|
1660
|
+
return responseContent?.LoginName;
|
|
1593
1661
|
}
|
|
1594
1662
|
};
|
|
1595
1663
|
//# sourceMappingURL=spo.js.map
|
|
@@ -2,6 +2,11 @@ Setting name|Definition|Default value
|
|
|
2
2
|
------------|----------|-------------
|
|
3
3
|
`authType`|Default login method to use when running `m365 login` without the `--authType` option.|`deviceCode`
|
|
4
4
|
`autoOpenLinksInBrowser`|Automatically open the browser for all commands which return a url and expect the user to copy paste this to the browser. For example when logging in, using `m365 login` in device code mode.|`false`
|
|
5
|
+
`clientId`|ID of the default Entra ID app use by the CLI to authenticate|``
|
|
6
|
+
`clientSecret`|Secret of the default Entra ID app use by the CLI to authenticate|``
|
|
7
|
+
`clientCertificateFile`|Path to the file containing the client certificate to use for authentication|``
|
|
8
|
+
`clientCertificateBase64Encoded`|Base64-encoded client certificate contents|``
|
|
9
|
+
`clientCertificatePassword`|Password to the client certificate file|``
|
|
5
10
|
`copyDeviceCodeToClipboard`|Automatically copy the device code to the clipboard when running `m365 login` command in device code mode|`false`
|
|
6
11
|
`csvEscape`|Single character used for escaping; only apply to characters matching the quote and the escape options|`"`
|
|
7
12
|
`csvHeader`|Display the column names on the first line|`true`
|
|
@@ -17,4 +22,4 @@ Setting name|Definition|Default value
|
|
|
17
22
|
`prompt`|Prompts for missing values in required options and enables interactive selection when multiple values are available for a command that requires a specific value to be retrieved.|`true`
|
|
18
23
|
`promptListPageSize`|By default, lists of choices longer than 7 will be paginated. Use this option to control how many choices will appear on the screen at once.|7
|
|
19
24
|
`showHelpOnFailure`|Automatically display help when executing a command failed|`true`
|
|
20
|
-
`
|
|
25
|
+
`tenantId`|ID of the default tenant to use when authenticating with|``
|
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
import Global from '/docs/cmd/_global.mdx';
|
|
2
|
+
import Tabs from '@theme/Tabs';
|
|
3
|
+
import TabItem from '@theme/TabItem';
|
|
4
|
+
|
|
5
|
+
# flow recyclebinitem list
|
|
6
|
+
|
|
7
|
+
Lists all soft-deleted Power Automate flows within an environment
|
|
8
|
+
|
|
9
|
+
## Usage
|
|
10
|
+
|
|
11
|
+
```sh
|
|
12
|
+
m365 flow recyclebinitem list [options]
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Options
|
|
16
|
+
|
|
17
|
+
```md definition-list
|
|
18
|
+
`-e, --environmentName <environmentName>`
|
|
19
|
+
: The name of the environment.
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
<Global />
|
|
23
|
+
|
|
24
|
+
## Remarks
|
|
25
|
+
|
|
26
|
+
:::warning
|
|
27
|
+
|
|
28
|
+
This command is based on an API that is currently in preview and is subject to change once the API reaches general availability.
|
|
29
|
+
|
|
30
|
+
:::
|
|
31
|
+
|
|
32
|
+
:::info
|
|
33
|
+
|
|
34
|
+
To use this command, you must be a Global or Power Platform administrator.
|
|
35
|
+
|
|
36
|
+
:::
|
|
37
|
+
|
|
38
|
+
A Power Automate flow is soft-deleted when:
|
|
39
|
+
- It's a non-solution flow.
|
|
40
|
+
- It's been deleted less than 21 days ago.
|
|
41
|
+
|
|
42
|
+
If the environment with the name you specified doesn't exist, you will get the `Access to the environment 'xyz' is denied.` error.
|
|
43
|
+
|
|
44
|
+
## Examples
|
|
45
|
+
|
|
46
|
+
List all soft-deleted flows within a specific environment
|
|
47
|
+
|
|
48
|
+
```sh
|
|
49
|
+
m365 flow recyclebinitem list --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## Response
|
|
53
|
+
|
|
54
|
+
<Tabs>
|
|
55
|
+
<TabItem value="JSON">
|
|
56
|
+
|
|
57
|
+
```json
|
|
58
|
+
[
|
|
59
|
+
{
|
|
60
|
+
"name": "26a9a283-af42-4c09-aa3e-60c3cc166b90",
|
|
61
|
+
"id": "/providers/Microsoft.ProcessSimple/environments/Default-d87a7535-dd31-4437-bfe1-95340acd55c5/flows/26a9a283-af42-4c09-aa3e-60c3cc166b90",
|
|
62
|
+
"type": "Microsoft.ProcessSimple/environments/flows",
|
|
63
|
+
"properties": {
|
|
64
|
+
"apiId": "/providers/Microsoft.PowerApps/apis/shared_logicflows",
|
|
65
|
+
"displayName": "Invoicing flow",
|
|
66
|
+
"state": "Deleted",
|
|
67
|
+
"createdTime": "2024-08-05T23:13:54Z",
|
|
68
|
+
"lastModifiedTime": "2024-08-05T23:14:00Z",
|
|
69
|
+
"flowSuspensionReason": "None",
|
|
70
|
+
"environment": {
|
|
71
|
+
"name": "Default-d87a7535-dd31-4437-bfe1-95340acd55c5",
|
|
72
|
+
"type": "Microsoft.ProcessSimple/environments",
|
|
73
|
+
"id": "/providers/Microsoft.ProcessSimple/environments/Default-d87a7535-dd31-4437-bfe1-95340acd55c5"
|
|
74
|
+
},
|
|
75
|
+
"definitionSummary": {
|
|
76
|
+
"triggers": [],
|
|
77
|
+
"actions": []
|
|
78
|
+
},
|
|
79
|
+
"creator": {
|
|
80
|
+
"tenantId": "a16e76a1-837f-4bf9-82dc-78874d18e434",
|
|
81
|
+
"objectId": "bd51c64d-c262-4184-ba3f-5361ea553820",
|
|
82
|
+
"userId": "bd51c64d-c262-4184-ba3f-5361ea553820",
|
|
83
|
+
"userType": "ActiveDirectory"
|
|
84
|
+
},
|
|
85
|
+
"flowFailureAlertSubscribed": false,
|
|
86
|
+
"isManaged": false,
|
|
87
|
+
"machineDescriptionData": {},
|
|
88
|
+
"flowOpenAiData": {
|
|
89
|
+
"isConsequential": false,
|
|
90
|
+
"isConsequentialFlagOverwritten": false
|
|
91
|
+
}
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
]
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
</TabItem>
|
|
98
|
+
<TabItem value="Text">
|
|
99
|
+
|
|
100
|
+
```text
|
|
101
|
+
name displayName
|
|
102
|
+
------------------------------------ --------------
|
|
103
|
+
26a9a283-af42-4c09-aa3e-60c3cc166b90 Invoicing flow
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
</TabItem>
|
|
107
|
+
<TabItem value="CSV">
|
|
108
|
+
|
|
109
|
+
```csv
|
|
110
|
+
name,id,type
|
|
111
|
+
26a9a283-af42-4c09-aa3e-60c3cc166b90,/providers/Microsoft.ProcessSimple/environments/Default-d87a7535-dd31-4437-bfe1-95340acd55c5/flows/26a9a283-af42-4c09-aa3e-60c3cc166b90,Microsoft.ProcessSimple/environments/flows
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
</TabItem>
|
|
115
|
+
<TabItem value="Markdown">
|
|
116
|
+
|
|
117
|
+
```md
|
|
118
|
+
# flow recyclebinitem list --environmentName "Default-d87a7535-dd31-4437-bfe1-95340acd55c5"
|
|
119
|
+
|
|
120
|
+
Date: 06/08/2024
|
|
121
|
+
|
|
122
|
+
## 26a9a283-af42-4c09-aa3e-60c3cc166b90 (/providers/Microsoft.ProcessSimple/environments/Default-d87a7535-dd31-4437-bfe1-95340acd55c5/flows/26a9a283-af42-4c09-aa3e-60c3cc166b90)
|
|
123
|
+
|
|
124
|
+
Property | Value
|
|
125
|
+
---------|-------
|
|
126
|
+
name | 26a9a283-af42-4c09-aa3e-60c3cc166b90
|
|
127
|
+
id | /providers/Microsoft.ProcessSimple/environments/Default-d87a7535-dd31-4437-bfe1-95340acd55c5/flows/26a9a283-af42-4c09-aa3e-60c3cc166b90
|
|
128
|
+
type | Microsoft.ProcessSimple/environments/flows
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
</TabItem>
|
|
132
|
+
</Tabs>
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
import Global from '/docs/cmd/_global.mdx';
|
|
2
|
+
import Tabs from '@theme/Tabs';
|
|
3
|
+
import TabItem from '@theme/TabItem';
|
|
4
|
+
|
|
5
|
+
# flow recyclebinitem restore
|
|
6
|
+
|
|
7
|
+
Restores a soft-deleted Power Automate flow
|
|
8
|
+
|
|
9
|
+
## Usage
|
|
10
|
+
|
|
11
|
+
```sh
|
|
12
|
+
m365 flow recyclebinitem restore [options]
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Options
|
|
16
|
+
|
|
17
|
+
```md definition-list
|
|
18
|
+
`-e, --environmentName <environmentName>`
|
|
19
|
+
: The name of the environment where the flow is located.
|
|
20
|
+
|
|
21
|
+
`-n, --flowName <flowName>`
|
|
22
|
+
: The name of the Power Automate flow.
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
<Global />
|
|
26
|
+
|
|
27
|
+
## Remarks
|
|
28
|
+
|
|
29
|
+
:::warning
|
|
30
|
+
|
|
31
|
+
This command is based on an API that is currently in preview and is subject to change once the API reaches general availability.
|
|
32
|
+
|
|
33
|
+
:::
|
|
34
|
+
|
|
35
|
+
:::info
|
|
36
|
+
|
|
37
|
+
To use this command, you must be a Global or Power Platform administrator.
|
|
38
|
+
|
|
39
|
+
:::
|
|
40
|
+
|
|
41
|
+
When a Power Automate flow is restored, it will be automatically disabled. To make it operational again, you must [enable](../flow-enable.mdx) it.
|
|
42
|
+
|
|
43
|
+
If the environment with the name you specified doesn't exist, you will get the `Access to the environment 'xyz' is denied.` error.
|
|
44
|
+
|
|
45
|
+
## Examples
|
|
46
|
+
|
|
47
|
+
Restores a soft-deleted flow within a specific environment
|
|
48
|
+
|
|
49
|
+
```sh
|
|
50
|
+
m365 flow recyclebinitem restore --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --flowName 5923cb07-ce1a-4a5c-ab81-257ce820109a
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
## Response
|
|
54
|
+
|
|
55
|
+
The command won't return a response on success.
|
package/docs/docs/cmd/setup.mdx
CHANGED
|
@@ -18,6 +18,9 @@ m365 setup [options]
|
|
|
18
18
|
|
|
19
19
|
`--scripting`
|
|
20
20
|
: Configure CLI for Microsoft 365 for use in scripts without prompting for additional information.
|
|
21
|
+
|
|
22
|
+
`--skipApp`
|
|
23
|
+
: Skip configuring an Entra app for use with CLI for Microsoft 365.
|
|
21
24
|
```
|
|
22
25
|
|
|
23
26
|
<Global />
|
|
@@ -28,9 +31,13 @@ The `m365 setup` command is a wizard that helps you configure the CLI for Micros
|
|
|
28
31
|
|
|
29
32
|
The command will ask you the following questions:
|
|
30
33
|
|
|
34
|
+
- _CLI for Microsoft 365 requires a Microsoft Entra app. Do you want to create a new app registration or use an existing one?_
|
|
35
|
+
|
|
36
|
+
You can choose between using an existing Entra app or creating a new one. If you choose to create a new app, the CLI will ask you to choose between a minimal and a full set of permissions. It then signs in as Azure CLI to your tenant, creates a new app registration, and stores its information in the CLI configuration.
|
|
37
|
+
|
|
31
38
|
- _How do you plan to use the CLI?_
|
|
32
39
|
|
|
33
|
-
You can choose between **interactive** and **scripting** use. In interactive mode, the CLI for Microsoft 365 will prompt you for additional information when needed, automatically open links browser, automatically show help on errors
|
|
40
|
+
You can choose between **interactive** and **scripting** use. In interactive mode, the CLI for Microsoft 365 will prompt you for additional information when needed, automatically open links browser, automatically show help on errors. In **scripting** mode, the CLI will not use interactivity to prevent blocking your scripts.
|
|
34
41
|
|
|
35
42
|
- _Are you going to use the CLI in PowerShell?_ (asked only when you chose to configure CLI for scripting)
|
|
36
43
|
|
|
@@ -53,7 +60,6 @@ The `m365 setup` command uses the following presets:
|
|
|
53
60
|
- printErrorsAsPlainText: true,
|
|
54
61
|
- prompt: true,
|
|
55
62
|
- showHelpOnFailure: true,
|
|
56
|
-
- showSpinner: true
|
|
57
63
|
- scripting use:
|
|
58
64
|
- autoOpenLinksInBrowser: false,
|
|
59
65
|
- copyDeviceCodeToClipboard: false,
|
|
@@ -61,7 +67,6 @@ The `m365 setup` command uses the following presets:
|
|
|
61
67
|
- printErrorsAsPlainText: false,
|
|
62
68
|
- prompt: false,
|
|
63
69
|
- showHelpOnFailure: false,
|
|
64
|
-
- showSpinner: false
|
|
65
70
|
- use in PowerShell:
|
|
66
71
|
- errorOutput: 'stdout'
|
|
67
72
|
- beginner:
|
|
@@ -71,24 +76,30 @@ The `m365 setup` command uses the following presets:
|
|
|
71
76
|
|
|
72
77
|
## Examples
|
|
73
78
|
|
|
74
|
-
Configure CLI for Microsoft based on your preferences interactively
|
|
79
|
+
Configure CLI for Microsoft 365 based on your preferences interactively
|
|
75
80
|
|
|
76
81
|
```sh
|
|
77
82
|
m365 setup
|
|
78
83
|
```
|
|
79
84
|
|
|
80
|
-
Configure CLI for Microsoft for interactive use without prompting for additional information
|
|
85
|
+
Configure CLI for Microsoft 365 for interactive use without prompting for additional information
|
|
81
86
|
|
|
82
87
|
```sh
|
|
83
88
|
m365 setup --interactive
|
|
84
89
|
```
|
|
85
90
|
|
|
86
|
-
Configure CLI for Microsoft for use in scripts without prompting for additional information
|
|
91
|
+
Configure CLI for Microsoft 365 for use in scripts without prompting for additional information
|
|
87
92
|
|
|
88
93
|
```sh
|
|
89
94
|
m365 setup --scripting
|
|
90
95
|
```
|
|
91
96
|
|
|
97
|
+
Configure CLI for Microsoft 365 without setting up an Entra app
|
|
98
|
+
|
|
99
|
+
```sh
|
|
100
|
+
m365 setup --skipApp
|
|
101
|
+
```
|
|
102
|
+
|
|
92
103
|
## Response
|
|
93
104
|
|
|
94
105
|
The command won't return a response on success.
|