@pnp/cli-microsoft365 7.1.0 → 7.2.0-beta.0642f3a

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.
Files changed (55) hide show
  1. package/.devcontainer/Dockerfile +0 -1
  2. package/.eslintrc.cjs +4 -0
  3. package/Dockerfile +0 -1
  4. package/dist/cli/Cli.js +3 -2
  5. package/dist/m365/aad/commands/administrativeunit/administrativeunit-add.js +61 -0
  6. package/dist/m365/aad/commands/administrativeunit/administrativeunit-get.js +80 -0
  7. package/dist/m365/aad/commands/administrativeunit/administrativeunit-list.js +25 -0
  8. package/dist/m365/aad/commands/administrativeunit/administrativeunit-remove.js +96 -0
  9. package/dist/m365/aad/commands.js +4 -0
  10. package/dist/m365/base/AppCommand.js +3 -12
  11. package/dist/m365/{search/commands/externalconnection/externalconnection-add.js → external/commands/connection/connection-add.js} +16 -13
  12. package/dist/m365/{search/commands/externalconnection/externalconnection-get.js → external/commands/connection/connection-get.js} +16 -13
  13. package/dist/m365/{search/commands/externalconnection/externalconnection-list.js → external/commands/connection/connection-list.js} +7 -4
  14. package/dist/m365/{search/commands/externalconnection/externalconnection-remove.js → external/commands/connection/connection-remove.js} +17 -14
  15. package/dist/m365/{search/commands/externalconnection/externalconnection-schema-add.js → external/commands/connection/connection-schema-add.js} +14 -11
  16. package/dist/m365/external/commands.js +15 -0
  17. package/dist/m365/spfx/commands/project/project-doctor/doctor-1.18.1-rc.0.js +21 -0
  18. package/dist/m365/spfx/commands/project/project-doctor.js +2 -1
  19. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN014010_CODE_settings_filesexclude_jest.js +44 -0
  20. package/dist/m365/spfx/commands/project/project-upgrade/upgrade-1.18.1-rc.0.js +57 -0
  21. package/dist/m365/spfx/commands/project/project-upgrade.js +16 -13
  22. package/dist/m365/spfx/commands/spfx-doctor.js +15 -0
  23. package/dist/m365/spo/commands/site/site-set.js +33 -1
  24. package/dist/m365/teams/commands/app/app-update.js +9 -6
  25. package/dist/m365/tenant/commands/people/people-profilecardproperty-add.js +131 -0
  26. package/dist/m365/tenant/commands/people/people-profilecardproperty-get.js +75 -0
  27. package/dist/m365/tenant/commands/people/people-profilecardproperty-list.js +53 -0
  28. package/dist/m365/tenant/commands/people/people-profilecardproperty-remove.js +84 -0
  29. package/dist/m365/tenant/commands/people/people-profilecardproperty-set.js +118 -0
  30. package/dist/m365/tenant/commands/people/profileCardProperties.js +24 -0
  31. package/dist/m365/tenant/commands.js +5 -0
  32. package/dist/utils/aadAdministrativeUnit.js +25 -0
  33. package/dist/utils/aadGroup.js +3 -1
  34. package/docs/docs/cmd/aad/administrativeunit/administrativeunit-add.mdx +119 -0
  35. package/docs/docs/cmd/aad/administrativeunit/administrativeunit-get.mdx +102 -0
  36. package/docs/docs/cmd/aad/administrativeunit/administrativeunit-list.mdx +87 -0
  37. package/docs/docs/cmd/aad/administrativeunit/administrativeunit-remove.mdx +56 -0
  38. package/docs/docs/cmd/{search/externalconnection/externalconnection-add.mdx → external/connection/connection-add.mdx} +16 -10
  39. package/docs/docs/cmd/{search/externalconnection/externalconnection-get.mdx → external/connection/connection-get.mdx} +16 -11
  40. package/docs/docs/cmd/{search/externalconnection/externalconnection-list.mdx → external/connection/connection-list.mdx} +12 -7
  41. package/docs/docs/cmd/external/connection/connection-remove.mdx +54 -0
  42. package/docs/docs/cmd/external/connection/connection-schema-add.mdx +41 -0
  43. package/docs/docs/cmd/spfx/project/project-upgrade.mdx +1 -1
  44. package/docs/docs/cmd/spo/file/file-rename.mdx +2 -0
  45. package/docs/docs/cmd/spo/site/site-set.mdx +15 -0
  46. package/docs/docs/cmd/tenant/people/people-profilecardproperty-add.mdx +126 -0
  47. package/docs/docs/cmd/tenant/people/people-profilecardproperty-get.mdx +101 -0
  48. package/docs/docs/cmd/tenant/people/people-profilecardproperty-list.mdx +98 -0
  49. package/docs/docs/cmd/tenant/people/people-profilecardproperty-remove.mdx +61 -0
  50. package/docs/docs/cmd/tenant/people/people-profilecardproperty-set.mdx +120 -0
  51. package/npm-shrinkwrap.json +2 -2
  52. package/package.json +5 -7
  53. package/dist/m365/search/commands.js +0 -9
  54. package/docs/docs/cmd/search/externalconnection/externalconnection-remove.mdx +0 -48
  55. package/docs/docs/cmd/search/externalconnection/externalconnection-schema-add.mdx +0 -35
@@ -0,0 +1,53 @@
1
+ import GraphCommand from '../../../base/GraphCommand.js';
2
+ import commands from '../../commands.js';
3
+ import { odata } from '../../../../utils/odata.js';
4
+ class TenantPeopleProfileCardPropertyListCommand extends GraphCommand {
5
+ get name() {
6
+ return commands.PEOPLE_PROFILECARDPROPERTY_LIST;
7
+ }
8
+ get description() {
9
+ return 'Lists all profile card properties';
10
+ }
11
+ async commandAction(logger, args) {
12
+ try {
13
+ if (this.verbose) {
14
+ await logger.logToStderr(`Listing all profile card properties...`);
15
+ }
16
+ const result = await odata.getAllItems(`${this.resource}/v1.0/admin/people/profileCardProperties`);
17
+ let output = result;
18
+ if (args.options.output && args.options.output !== 'json') {
19
+ output = output.sort((n1, n2) => {
20
+ const localizations1 = n1.annotations[0]?.localizations?.length ?? 0;
21
+ const localizations2 = n2.annotations[0]?.localizations?.length ?? 0;
22
+ if (localizations1 > localizations2) {
23
+ return -1;
24
+ }
25
+ if (localizations1 < localizations2) {
26
+ return 1;
27
+ }
28
+ return 0;
29
+ });
30
+ output = output.map((p) => {
31
+ const propertyAnnotations = p.annotations[0]?.localizations?.map((l) => {
32
+ return { ['displayName ' + l.languageTag]: l.displayName };
33
+ }) ?? [];
34
+ const propertyAnnotationsObject = Object.assign({}, ...propertyAnnotations);
35
+ const result = { directoryPropertyName: p.directoryPropertyName };
36
+ if (p.annotations[0]?.displayName) {
37
+ result.displayName = p.annotations[0]?.displayName;
38
+ }
39
+ return {
40
+ ...result,
41
+ ...propertyAnnotationsObject
42
+ };
43
+ });
44
+ }
45
+ await logger.log(output);
46
+ }
47
+ catch (err) {
48
+ this.handleRejectedODataJsonPromise(err);
49
+ }
50
+ }
51
+ }
52
+ export default new TenantPeopleProfileCardPropertyListCommand();
53
+ //# sourceMappingURL=people-profilecardproperty-list.js.map
@@ -0,0 +1,84 @@
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 _TenantPeopleProfileCardPropertyRemoveCommand_instances, _TenantPeopleProfileCardPropertyRemoveCommand_initTelemetry, _TenantPeopleProfileCardPropertyRemoveCommand_initOptions, _TenantPeopleProfileCardPropertyRemoveCommand_initValidators;
7
+ import { Cli } from '../../../../cli/Cli.js';
8
+ import request from '../../../../request.js';
9
+ import GraphCommand from '../../../base/GraphCommand.js';
10
+ import commands from '../../commands.js';
11
+ import { profileCardPropertyNames } from './profileCardProperties.js';
12
+ class TenantPeopleProfileCardPropertyRemoveCommand extends GraphCommand {
13
+ get name() {
14
+ return commands.PEOPLE_PROFILECARDPROPERTY_REMOVE;
15
+ }
16
+ get description() {
17
+ return 'Removes an additional attribute from the profile card properties';
18
+ }
19
+ constructor() {
20
+ super();
21
+ _TenantPeopleProfileCardPropertyRemoveCommand_instances.add(this);
22
+ __classPrivateFieldGet(this, _TenantPeopleProfileCardPropertyRemoveCommand_instances, "m", _TenantPeopleProfileCardPropertyRemoveCommand_initTelemetry).call(this);
23
+ __classPrivateFieldGet(this, _TenantPeopleProfileCardPropertyRemoveCommand_instances, "m", _TenantPeopleProfileCardPropertyRemoveCommand_initOptions).call(this);
24
+ __classPrivateFieldGet(this, _TenantPeopleProfileCardPropertyRemoveCommand_instances, "m", _TenantPeopleProfileCardPropertyRemoveCommand_initValidators).call(this);
25
+ }
26
+ async commandAction(logger, args) {
27
+ const directoryPropertyName = profileCardPropertyNames.find(n => n.toLowerCase() === args.options.name.toLowerCase());
28
+ const removeProfileCardProperty = async () => {
29
+ if (this.verbose) {
30
+ await logger.logToStderr(`Removing '${directoryPropertyName}' as a profile card property...`);
31
+ }
32
+ const requestOptions = {
33
+ url: `${this.resource}/v1.0/admin/people/profileCardProperties/${directoryPropertyName}`,
34
+ headers: {
35
+ 'content-type': 'application/json'
36
+ },
37
+ responseType: 'json'
38
+ };
39
+ try {
40
+ await request.delete(requestOptions);
41
+ }
42
+ catch (err) {
43
+ this.handleRejectedODataJsonPromise(err);
44
+ }
45
+ };
46
+ if (args.options.force) {
47
+ await removeProfileCardProperty();
48
+ }
49
+ else {
50
+ const result = await Cli.prompt({
51
+ type: 'confirm',
52
+ name: 'continue',
53
+ default: false,
54
+ message: `Are you sure you want to remove the profile card property '${directoryPropertyName}'?`
55
+ });
56
+ if (result.continue) {
57
+ await removeProfileCardProperty();
58
+ }
59
+ }
60
+ }
61
+ }
62
+ _TenantPeopleProfileCardPropertyRemoveCommand_instances = new WeakSet(), _TenantPeopleProfileCardPropertyRemoveCommand_initTelemetry = function _TenantPeopleProfileCardPropertyRemoveCommand_initTelemetry() {
63
+ this.telemetry.push((args) => {
64
+ Object.assign(this.telemetryProperties, {
65
+ force: !!args.options.force
66
+ });
67
+ });
68
+ }, _TenantPeopleProfileCardPropertyRemoveCommand_initOptions = function _TenantPeopleProfileCardPropertyRemoveCommand_initOptions() {
69
+ this.options.unshift({
70
+ option: '-n, --name <name>',
71
+ autocomplete: profileCardPropertyNames
72
+ }, {
73
+ option: '-f, --force'
74
+ });
75
+ }, _TenantPeopleProfileCardPropertyRemoveCommand_initValidators = function _TenantPeopleProfileCardPropertyRemoveCommand_initValidators() {
76
+ this.validators.push(async (args) => {
77
+ if (profileCardPropertyNames.every(n => n.toLowerCase() !== args.options.name.toLowerCase())) {
78
+ return `${args.options.name} is not a valid value for name. Allowed values are ${profileCardPropertyNames.join(', ')}`;
79
+ }
80
+ return true;
81
+ });
82
+ };
83
+ export default new TenantPeopleProfileCardPropertyRemoveCommand();
84
+ //# sourceMappingURL=people-profilecardproperty-remove.js.map
@@ -0,0 +1,118 @@
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 _TenantPeopleProfileCardPropertySetCommand_instances, _TenantPeopleProfileCardPropertySetCommand_initTelemetry, _TenantPeopleProfileCardPropertySetCommand_initOptions, _TenantPeopleProfileCardPropertySetCommand_initValidators, _TenantPeopleProfileCardPropertySetCommand_initTypes;
7
+ import GraphCommand from '../../../base/GraphCommand.js';
8
+ import request from '../../../../request.js';
9
+ import { profileCardPropertyNames as allProfileCardPropertyNames } from './profileCardProperties.js';
10
+ import commands from '../../commands.js';
11
+ class TenantPeopleProfileCardPropertySetCommand extends GraphCommand {
12
+ get name() {
13
+ return commands.PEOPLE_PROFILECARDPROPERTY_SET;
14
+ }
15
+ get description() {
16
+ return 'Updates a custom attribute to the profile card property';
17
+ }
18
+ constructor() {
19
+ super();
20
+ _TenantPeopleProfileCardPropertySetCommand_instances.add(this);
21
+ this.profileCardPropertyNames = allProfileCardPropertyNames.filter(p => p.toLowerCase().startsWith('customattribute'));
22
+ __classPrivateFieldGet(this, _TenantPeopleProfileCardPropertySetCommand_instances, "m", _TenantPeopleProfileCardPropertySetCommand_initTelemetry).call(this);
23
+ __classPrivateFieldGet(this, _TenantPeopleProfileCardPropertySetCommand_instances, "m", _TenantPeopleProfileCardPropertySetCommand_initOptions).call(this);
24
+ __classPrivateFieldGet(this, _TenantPeopleProfileCardPropertySetCommand_instances, "m", _TenantPeopleProfileCardPropertySetCommand_initValidators).call(this);
25
+ __classPrivateFieldGet(this, _TenantPeopleProfileCardPropertySetCommand_instances, "m", _TenantPeopleProfileCardPropertySetCommand_initTypes).call(this);
26
+ }
27
+ allowUnknownOptions() {
28
+ return true;
29
+ }
30
+ async commandAction(logger, args) {
31
+ try {
32
+ if (this.verbose) {
33
+ await logger.logToStderr(`Updating profile card property '${args.options.name}'...`);
34
+ }
35
+ // Get the right casing for the profile card property name
36
+ const profileCardProperty = this.profileCardPropertyNames.find(p => p.toLowerCase() === args.options.name.toLowerCase());
37
+ const requestOptions = {
38
+ url: `${this.resource}/v1.0/admin/people/profileCardProperties/${profileCardProperty}`,
39
+ headers: {
40
+ accept: 'application/json;odata.metadata=none'
41
+ },
42
+ responseType: 'json',
43
+ data: {
44
+ annotations: [
45
+ {
46
+ displayName: args.options.displayName,
47
+ localizations: this.getLocalizations(args.options)
48
+ }
49
+ ]
50
+ }
51
+ };
52
+ const result = await request.patch(requestOptions);
53
+ let output = result;
54
+ // Transform the output to make it more readable
55
+ if (args.options.output && args.options.output !== 'json' && result.annotations.length > 0) {
56
+ output = result.annotations[0].localizations.reduce((acc, curr) => ({
57
+ ...acc,
58
+ ['displayName ' + curr.languageTag]: curr.displayName
59
+ }), {
60
+ ...result,
61
+ displayName: result.annotations[0].displayName
62
+ });
63
+ delete output.annotations;
64
+ }
65
+ await logger.log(output);
66
+ }
67
+ catch (err) {
68
+ this.handleRejectedODataJsonPromise(err);
69
+ }
70
+ }
71
+ /**
72
+ * Transform option to localization object.
73
+ * @example Transform "--displayName-en-US 'Cost center'" to { languageTag: 'en-US', displayName: 'Cost center' }
74
+ */
75
+ getLocalizations(options) {
76
+ const unknownOptions = this.getUnknownOptions(options);
77
+ const result = Object.keys(unknownOptions).map(o => ({
78
+ languageTag: o.substring(o.indexOf('-') + 1),
79
+ displayName: unknownOptions[o]
80
+ }));
81
+ return result;
82
+ }
83
+ }
84
+ _TenantPeopleProfileCardPropertySetCommand_instances = new WeakSet(), _TenantPeopleProfileCardPropertySetCommand_initTelemetry = function _TenantPeopleProfileCardPropertySetCommand_initTelemetry() {
85
+ this.telemetry.push((args) => {
86
+ // Add unknown options to telemetry
87
+ const unknownOptions = Object.keys(this.getUnknownOptions(args.options));
88
+ const unknownOptionsObj = unknownOptions.reduce((obj, key) => ({ ...obj, [key]: true }), {});
89
+ Object.assign(this.telemetryProperties, {
90
+ displayName: typeof args.options.displayName !== 'undefined',
91
+ ...unknownOptionsObj
92
+ });
93
+ });
94
+ }, _TenantPeopleProfileCardPropertySetCommand_initOptions = function _TenantPeopleProfileCardPropertySetCommand_initOptions() {
95
+ this.options.unshift({
96
+ option: '-n, --name <name>',
97
+ autocomplete: this.profileCardPropertyNames
98
+ }, {
99
+ option: '-d, --displayName <displayName>'
100
+ });
101
+ }, _TenantPeopleProfileCardPropertySetCommand_initValidators = function _TenantPeopleProfileCardPropertySetCommand_initValidators() {
102
+ this.validators.push(async (args) => {
103
+ if (!this.profileCardPropertyNames.some(p => p.toLowerCase() === args.options.name.toLowerCase())) {
104
+ return `'${args.options.name}' is not a valid value for option name. Allowed values are: ${this.profileCardPropertyNames.join(', ')}.`;
105
+ }
106
+ // Unknown options are allowed only if they start with 'displayName-'
107
+ const unknownOptionKeys = Object.keys(this.getUnknownOptions(args.options));
108
+ const invalidOptionKey = unknownOptionKeys.find(o => !o.startsWith('displayName-'));
109
+ if (invalidOptionKey) {
110
+ return `Invalid option: '${invalidOptionKey}'`;
111
+ }
112
+ return true;
113
+ });
114
+ }, _TenantPeopleProfileCardPropertySetCommand_initTypes = function _TenantPeopleProfileCardPropertySetCommand_initTypes() {
115
+ this.types.string.push('name', 'displayName');
116
+ };
117
+ export default new TenantPeopleProfileCardPropertySetCommand();
118
+ //# sourceMappingURL=people-profilecardproperty-set.js.map
@@ -0,0 +1,24 @@
1
+ export const profileCardPropertyNames = [
2
+ 'UserPrincipalName',
3
+ 'Fax',
4
+ 'StreetAddress',
5
+ 'PostalCode',
6
+ 'StateOrProvince',
7
+ 'Alias',
8
+ 'customAttribute1',
9
+ 'customAttribute2',
10
+ 'customAttribute3',
11
+ 'customAttribute4',
12
+ 'customAttribute5',
13
+ 'customAttribute6',
14
+ 'customAttribute7',
15
+ 'customAttribute8',
16
+ 'customAttribute9',
17
+ 'customAttribute10',
18
+ 'customAttribute11',
19
+ 'customAttribute12',
20
+ 'customAttribute13',
21
+ 'customAttribute14',
22
+ 'customAttribute15'
23
+ ];
24
+ //# sourceMappingURL=profileCardProperties.js.map
@@ -2,6 +2,11 @@ const prefix = 'tenant';
2
2
  export default {
3
3
  ID_GET: `${prefix} id get`,
4
4
  INFO_GET: `${prefix} info get`,
5
+ PEOPLE_PROFILECARDPROPERTY_ADD: `${prefix} people profilecardproperty add`,
6
+ PEOPLE_PROFILECARDPROPERTY_GET: `${prefix} people profilecardproperty get`,
7
+ PEOPLE_PROFILECARDPROPERTY_LIST: `${prefix} people profilecardproperty list`,
8
+ PEOPLE_PROFILECARDPROPERTY_REMOVE: `${prefix} people profilecardproperty remove`,
9
+ PEOPLE_PROFILECARDPROPERTY_SET: `${prefix} people profilecardproperty set`,
5
10
  REPORT_ACTIVEUSERCOUNTS: `${prefix} report activeusercounts`,
6
11
  REPORT_ACTIVEUSERDETAIL: `${prefix} report activeuserdetail`,
7
12
  REPORT_OFFICE365ACTIVATIONCOUNTS: `${prefix} report office365activationcounts`,
@@ -0,0 +1,25 @@
1
+ import { odata } from "./odata.js";
2
+ import { formatting } from "./formatting.js";
3
+ import { Cli } from "../cli/Cli.js";
4
+ const graphResource = 'https://graph.microsoft.com';
5
+ export const aadAdministrativeUnit = {
6
+ /**
7
+ * Get an administrative unit by its display name.
8
+ * @param displayName Administrative unit display name.
9
+ * @returns The administrative unit.
10
+ * @throws Error when administrative unit was not found.
11
+ */
12
+ async getAdministrativeUnitByDisplayName(displayName) {
13
+ const administrativeUnits = await odata.getAllItems(`${graphResource}/v1.0/directory/administrativeUnits?$filter=displayName eq '${formatting.encodeQueryParameter(displayName)}'`);
14
+ if (administrativeUnits.length === 0) {
15
+ throw `The specified administrative unit '${displayName}' does not exist.`;
16
+ }
17
+ if (administrativeUnits.length > 1) {
18
+ const resultAsKeyValuePair = formatting.convertArrayToHashTable('id', administrativeUnits);
19
+ const selectedAdministrativeUnit = await Cli.handleMultipleResultsFound(`Multiple administrative units with name '${displayName}' found.`, resultAsKeyValuePair);
20
+ return selectedAdministrativeUnit;
21
+ }
22
+ return administrativeUnits[0];
23
+ }
24
+ };
25
+ //# sourceMappingURL=aadAdministrativeUnit.js.map
@@ -54,7 +54,9 @@ export const aadGroup = {
54
54
  throw Error(`The specified group '${displayName}' does not exist.`);
55
55
  }
56
56
  if (groups.length > 1) {
57
- throw Error(`Multiple groups with name '${displayName}' found: ${groups.map(x => x.id).join(',')}.`);
57
+ const resultAsKeyValuePair = formatting.convertArrayToHashTable('id', groups);
58
+ const result = await Cli.handleMultipleResultsFound(`Multiple groups with name '${displayName}' found.`, resultAsKeyValuePair);
59
+ return result.id;
58
60
  }
59
61
  return groups[0].id;
60
62
  },
@@ -0,0 +1,119 @@
1
+ import Global from '/docs/cmd/_global.mdx';
2
+ import Tabs from '@theme/Tabs';
3
+ import TabItem from '@theme/TabItem';
4
+
5
+ # aad administrativeunit add
6
+
7
+ Creates a new administrative unit
8
+
9
+ ## Usage
10
+
11
+ ```sh
12
+ m365 aad administrativeunit add [options]
13
+ ```
14
+
15
+ ## Options
16
+
17
+ ```md definition-list
18
+ `-n, --displayname <displayName>`
19
+ : Display name for the administrative unit.
20
+
21
+ `-d, --description [description]`
22
+ : Description for the administrative unit.
23
+
24
+ `--hiddenMembership`
25
+ : Indicates whether the administrative unit and its members are hidden.
26
+ ```
27
+
28
+ <Global />
29
+
30
+ ## Remarks
31
+
32
+ :::info
33
+
34
+ To use this command you must be either **Global Administrator** or **Privileged Role Administrator**.
35
+
36
+ :::
37
+
38
+ ## Examples
39
+
40
+ Create an administrative unit with a specific display name
41
+
42
+ ```sh
43
+ m365 aad administrativeunit add --displayName 'Marketing Division'
44
+ ```
45
+
46
+ Create an administrative unit with a specific display name and description
47
+
48
+ ```sh
49
+ m365 aad administrativeunit add --displayName 'Marketing Division' --description 'Marketing department administration'
50
+ ```
51
+
52
+ Create a hidden administrative unit with a specific display name
53
+
54
+ ```sh
55
+ m365 aad administrativeunit add --displayName 'Marketing Division' --hiddenMembership
56
+ ```
57
+
58
+ ## Response
59
+
60
+ <Tabs>
61
+ <TabItem value="JSON">
62
+
63
+ ```json
64
+ {
65
+ "id": "00b45a1b-7632-4e94-a3bd-f06aec976d31",
66
+ "deletedDateTime": null,
67
+ "displayName": "Marketing Division",
68
+ "description": "Marketing department administration",
69
+ "membershipRule": null,
70
+ "membershipType": null,
71
+ "membershipRuleProcessingState": null,
72
+ "visibility": null
73
+ }
74
+ ```
75
+
76
+ </TabItem>
77
+ <TabItem value="Text">
78
+
79
+ ```text
80
+ deletedDateTime : null
81
+ description : Marketing department administration
82
+ displayName : Marketing Division
83
+ id : 00b45a1b-7632-4e94-a3bd-f06aec976d31
84
+ membershipRule : null
85
+ membershipRuleProcessingState: null
86
+ membershipType : null
87
+ visibility : null
88
+ ```
89
+
90
+ </TabItem>
91
+ <TabItem value="CSV">
92
+
93
+ ```csv
94
+ id,displayName,description,visibility
95
+ 00b45a1b-7632-4e94-a3bd-f06aec976d31,Marketing Division,Marketing department administration,HiddenMembership
96
+ ```
97
+
98
+ </TabItem>
99
+ <TabItem value="Markdown">
100
+
101
+ ```md
102
+ Date: 10/23/2023
103
+
104
+ ## Marketing Division (00b45a1b-7632-4e94-a3bd-f06aec976d31)
105
+
106
+ Property | Value
107
+ ---------|-------
108
+ id | 00b45a1b-7632-4e94-a3bd-f06aec976d31
109
+ displayName | Marketing Division
110
+ description | Marketing department administration
111
+ visibility | HiddenMembership
112
+ ```
113
+
114
+ </TabItem>
115
+ </Tabs>
116
+
117
+ ## More information
118
+
119
+ - Administrative units: https://learn.microsoft.com/entra/identity/role-based-access-control/administrative-units
@@ -0,0 +1,102 @@
1
+ import Global from '/docs/cmd/_global.mdx';
2
+ import Tabs from '@theme/Tabs';
3
+ import TabItem from '@theme/TabItem';
4
+
5
+ # aad administrativeunit get
6
+
7
+ Gets information about a specific administrative unit
8
+
9
+ ## Usage
10
+
11
+ ```sh
12
+ m365 aad administrativeunit get [options]
13
+ ```
14
+
15
+ ## Options
16
+
17
+ ```md definition-list
18
+ `-i, --id [id]`
19
+ : The id of the administrative unit. Specify either `id` or `displayName` but not both.
20
+
21
+ `-n, --displayName [displayName]`
22
+ : The display name of the administrative unit. Specify either `id` or `displayName` but not both.
23
+ ```
24
+
25
+ <Global />
26
+
27
+ ## Examples
28
+
29
+ Get information about the administrative unit by its id
30
+
31
+ ```sh
32
+ m365 aad administrativeunit get --id 03c4c9dc-6f0c-4c4f-a4e6-0c9ed80f54c7
33
+ ```
34
+
35
+ Get information about the administrative unit by its display name
36
+
37
+ ```sh
38
+ m365 aad administrativeunit get --displayName 'Marketing Division'
39
+ ```
40
+
41
+ ## Response
42
+
43
+ <Tabs>
44
+ <TabItem value="JSON">
45
+
46
+ ```json
47
+ {
48
+ "id": "0a22c83d-c4ac-43e2-bb5e-87af3015d49f",
49
+ "deletedDateTime": null,
50
+ "displayName": "Marketing Division",
51
+ "description": "Marketing Department Administration",
52
+ "membershipRule": null,
53
+ "membershipType": null,
54
+ "membershipRuleProcessingState": null,
55
+ "visibility": "HiddenMembership"
56
+ }
57
+ ```
58
+
59
+ </TabItem>
60
+ <TabItem value="Text">
61
+
62
+ ```text
63
+ deletedDateTime : null
64
+ description : Marketing Department Administration
65
+ displayName : Marketing Division
66
+ id : 0a22c83d-c4ac-43e2-bb5e-87af3015d49f
67
+ membershipRule : null
68
+ membershipRuleProcessingState: null
69
+ membershipType : null
70
+ visibility : HiddenMembership
71
+ ```
72
+
73
+ </TabItem>
74
+ <TabItem value="CSV">
75
+
76
+ ```csv
77
+ id,displayName,description,visibility
78
+ 0a22c83d-c4ac-43e2-bb5e-87af3015d49f,Marketing Division,Marketing Department Administration,HiddenMembership
79
+ ```
80
+
81
+ </TabItem>
82
+ <TabItem value="Markdown">
83
+
84
+ ```md
85
+ Date: 10/23/2023
86
+
87
+ ## Marketing Division (0a22c83d-c4ac-43e2-bb5e-87af3015d49f)
88
+
89
+ Property | Value
90
+ ---------|-------
91
+ id | 0a22c83d-c4ac-43e2-bb5e-87af3015d49f
92
+ displayName | Marketing Division
93
+ description | Marketing Department Administration
94
+ visibility | HiddenMembership
95
+ ```
96
+
97
+ </TabItem>
98
+ </Tabs>
99
+
100
+ ## More information
101
+
102
+ - Administrative units: https://learn.microsoft.com/entra/identity/role-based-access-control/administrative-units
@@ -0,0 +1,87 @@
1
+ import Global from '/docs/cmd/_global.mdx';
2
+ import Tabs from '@theme/Tabs';
3
+ import TabItem from '@theme/TabItem';
4
+
5
+ # aad administrativeunit list
6
+
7
+ Retrieves a list of administrative units
8
+
9
+ ## Usage
10
+
11
+ ```sh
12
+ m365 aad administrativeunit list [options]
13
+ ```
14
+
15
+ ## Options
16
+
17
+ <Global />
18
+
19
+ ## Examples
20
+
21
+ Retrieve a list of administrative units
22
+
23
+ ```sh
24
+ m365 aad administrativeunit list
25
+ ```
26
+
27
+ ## Response
28
+
29
+ <Tabs>
30
+ <TabItem value="JSON">
31
+
32
+ ```json
33
+ [
34
+ {
35
+ "id": "0a22c83d-c4ac-43e2-bb5e-87af3015d49f",
36
+ "deletedDateTime": null,
37
+ "displayName": "Marketing Department",
38
+ "description": "Marketing Department Administration",
39
+ "membershipRule": null,
40
+ "membershipType": null,
41
+ "membershipRuleProcessingState": null,
42
+ "visibility": "HiddenMembership"
43
+ }
44
+ ]
45
+ ```
46
+
47
+ </TabItem>
48
+ <TabItem value="Text">
49
+
50
+ ```text
51
+ displayName: 0a22c83d-c4ac-43e2-bb5e-87af3015d49f
52
+ id : Marketing Department
53
+ visibility : HiddenMembership
54
+ ```
55
+
56
+ </TabItem>
57
+ <TabItem value="CSV">
58
+
59
+ ```csv
60
+ id,displayName,description,visibility
61
+ 0a22c83d-c4ac-43e2-bb5e-87af3015d49f,Marketing Department,Marketing Department Administration,HiddenMembership
62
+ ```
63
+
64
+ </TabItem>
65
+ <TabItem value="Markdown">
66
+
67
+ ```md
68
+ # aad administrativeunit list
69
+
70
+ Date: 2023-10-16
71
+
72
+ ## Marketing Department (0a22c83d-c4ac-43e2-bb5e-87af3015d49f)
73
+
74
+ Property | Value
75
+ ---------|-------
76
+ id | 0a22c83d-c4ac-43e2-bb5e-87af3015d49f
77
+ displayName | Marketing Department
78
+ description | Marketing Department Administration
79
+ visibility | HiddenMembership
80
+ ```
81
+
82
+ </TabItem>
83
+ </Tabs>
84
+
85
+ ## More information
86
+
87
+ - Administrative units: https://learn.microsoft.com/entra/identity/role-based-access-control/administrative-units