@pnp/cli-microsoft365 7.1.0 → 7.2.0-beta.2970c86

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 (33) hide show
  1. package/.eslintrc.cjs +4 -0
  2. package/dist/cli/Cli.js +3 -2
  3. package/dist/m365/aad/commands/administrativeunit/administrativeunit-add.js +61 -0
  4. package/dist/m365/aad/commands/administrativeunit/administrativeunit-get.js +93 -0
  5. package/dist/m365/aad/commands/administrativeunit/administrativeunit-list.js +25 -0
  6. package/dist/m365/aad/commands/administrativeunit/administrativeunit-remove.js +108 -0
  7. package/dist/m365/aad/commands.js +4 -0
  8. package/dist/m365/base/AppCommand.js +3 -12
  9. package/dist/m365/spfx/commands/project/project-doctor/doctor-1.18.1-rc.0.js +21 -0
  10. package/dist/m365/spfx/commands/project/project-doctor.js +2 -1
  11. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN014010_CODE_settings_filesexclude_jest.js +44 -0
  12. package/dist/m365/spfx/commands/project/project-upgrade/upgrade-1.18.1-rc.0.js +57 -0
  13. package/dist/m365/spfx/commands/project/project-upgrade.js +16 -13
  14. package/dist/m365/spfx/commands/spfx-doctor.js +15 -0
  15. package/dist/m365/teams/commands/app/app-update.js +9 -6
  16. package/dist/m365/tenant/commands/people/people-profilecardproperty-add.js +128 -0
  17. package/dist/m365/tenant/commands/people/people-profilecardproperty-get.js +73 -0
  18. package/dist/m365/tenant/commands/people/people-profilecardproperty-list.js +63 -0
  19. package/dist/m365/tenant/commands/people/people-profilecardproperty-remove.js +84 -0
  20. package/dist/m365/tenant/commands/people/profileCardProperties.js +24 -0
  21. package/dist/m365/tenant/commands.js +4 -0
  22. package/dist/utils/aadGroup.js +3 -1
  23. package/docs/docs/cmd/aad/administrativeunit/administrativeunit-add.mdx +119 -0
  24. package/docs/docs/cmd/aad/administrativeunit/administrativeunit-get.mdx +102 -0
  25. package/docs/docs/cmd/aad/administrativeunit/administrativeunit-list.mdx +87 -0
  26. package/docs/docs/cmd/aad/administrativeunit/administrativeunit-remove.mdx +56 -0
  27. package/docs/docs/cmd/spfx/project/project-upgrade.mdx +1 -1
  28. package/docs/docs/cmd/tenant/people/people-profilecardproperty-add.mdx +174 -0
  29. package/docs/docs/cmd/tenant/people/people-profilecardproperty-get.mdx +97 -0
  30. package/docs/docs/cmd/tenant/people/people-profilecardproperty-list.mdx +106 -0
  31. package/docs/docs/cmd/tenant/people/people-profilecardproperty-remove.mdx +61 -0
  32. package/npm-shrinkwrap.json +2 -2
  33. package/package.json +3 -2
@@ -0,0 +1,128 @@
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 _TenantPeopleProfileCardPropertyAddCommand_instances, _TenantPeopleProfileCardPropertyAddCommand_initTelemetry, _TenantPeopleProfileCardPropertyAddCommand_initOptions, _TenantPeopleProfileCardPropertyAddCommand_initValidators;
7
+ import request from '../../../../request.js';
8
+ import GraphCommand from '../../../base/GraphCommand.js';
9
+ import commands from '../../commands.js';
10
+ import { profileCardPropertyNames } from './profileCardProperties.js';
11
+ class TenantPeopleProfileCardPropertyAddCommand extends GraphCommand {
12
+ get name() {
13
+ return commands.PEOPLE_PROFILECARDPROPERTY_ADD;
14
+ }
15
+ get description() {
16
+ return 'Adds an additional attribute to the profile card properties';
17
+ }
18
+ constructor() {
19
+ super();
20
+ _TenantPeopleProfileCardPropertyAddCommand_instances.add(this);
21
+ this.excludeOptions = ['name', 'displayName', 'debug', 'verbose', 'output'];
22
+ __classPrivateFieldGet(this, _TenantPeopleProfileCardPropertyAddCommand_instances, "m", _TenantPeopleProfileCardPropertyAddCommand_initTelemetry).call(this);
23
+ __classPrivateFieldGet(this, _TenantPeopleProfileCardPropertyAddCommand_instances, "m", _TenantPeopleProfileCardPropertyAddCommand_initOptions).call(this);
24
+ __classPrivateFieldGet(this, _TenantPeopleProfileCardPropertyAddCommand_instances, "m", _TenantPeopleProfileCardPropertyAddCommand_initValidators).call(this);
25
+ }
26
+ allowUnknownOptions() {
27
+ return true;
28
+ }
29
+ async commandAction(logger, args) {
30
+ const directoryPropertyName = profileCardPropertyNames.find(n => n.toLowerCase() === args.options.name.toLowerCase());
31
+ if (this.verbose) {
32
+ await logger.logToStderr(`Adding '${directoryPropertyName}' as a profile card property...`);
33
+ }
34
+ const requestOptions = {
35
+ url: `${this.resource}/v1.0/admin/people/profileCardProperties`,
36
+ headers: {
37
+ 'content-type': 'application/json',
38
+ accept: 'application/json;odata.metadata=none'
39
+ },
40
+ responseType: 'json',
41
+ data: {
42
+ directoryPropertyName,
43
+ annotations: this.getAnnotations(args.options)
44
+ }
45
+ };
46
+ try {
47
+ const response = await request.post(requestOptions);
48
+ // Transform the output to make it more readable
49
+ if (args.options.output && args.options.output !== 'json' && response.annotations.length > 0) {
50
+ const annotation = response.annotations[0];
51
+ response.displayName = annotation.displayName;
52
+ annotation.localizations.forEach((l) => {
53
+ response[`displayName ${l.languageTag}`] = l.displayName;
54
+ });
55
+ delete response.annotations;
56
+ }
57
+ await logger.log(response);
58
+ }
59
+ catch (err) {
60
+ this.handleRejectedODataJsonPromise(err);
61
+ }
62
+ }
63
+ getAnnotations(options) {
64
+ if (!options.displayName) {
65
+ return [];
66
+ }
67
+ return [
68
+ {
69
+ displayName: options.displayName,
70
+ localizations: this.getLocalizations(options)
71
+ }
72
+ ];
73
+ }
74
+ getLocalizations(options) {
75
+ const unknownOptions = Object.keys(options).filter(key => !this.excludeOptions.includes(key));
76
+ if (unknownOptions.length === 0) {
77
+ return [];
78
+ }
79
+ const localizations = [];
80
+ unknownOptions.forEach(key => {
81
+ localizations.push({
82
+ languageTag: key.replace('displayName-', ''),
83
+ displayName: options[key]
84
+ });
85
+ });
86
+ return localizations;
87
+ }
88
+ }
89
+ _TenantPeopleProfileCardPropertyAddCommand_instances = new WeakSet(), _TenantPeopleProfileCardPropertyAddCommand_initTelemetry = function _TenantPeopleProfileCardPropertyAddCommand_initTelemetry() {
90
+ this.telemetry.push((args) => {
91
+ Object.assign(this.telemetryProperties, {
92
+ displayName: typeof args.options.displayName !== 'undefined'
93
+ });
94
+ });
95
+ }, _TenantPeopleProfileCardPropertyAddCommand_initOptions = function _TenantPeopleProfileCardPropertyAddCommand_initOptions() {
96
+ this.options.unshift({
97
+ option: '-n, --name <name>',
98
+ autocomplete: profileCardPropertyNames
99
+ }, {
100
+ option: '-d, --displayName [displayName]'
101
+ });
102
+ }, _TenantPeopleProfileCardPropertyAddCommand_initValidators = function _TenantPeopleProfileCardPropertyAddCommand_initValidators() {
103
+ this.validators.push(async (args) => {
104
+ const propertyName = args.options.name.toLowerCase();
105
+ if (profileCardPropertyNames.every(n => n.toLowerCase() !== propertyName)) {
106
+ return `${args.options.name} is not a valid value for name. Allowed values are ${profileCardPropertyNames.join(', ')}`;
107
+ }
108
+ if (propertyName.startsWith("customattribute") && args.options.displayName === undefined) {
109
+ return `The option 'displayName' is required when adding customAttributes as profile card properties`;
110
+ }
111
+ if (!propertyName.startsWith("customattribute") && args.options.displayName !== undefined) {
112
+ return `The option 'displayName' can only be used when adding customAttributes as profile card properties`;
113
+ }
114
+ const unknownOptions = Object.keys(args.options).filter(key => !this.excludeOptions.includes(key));
115
+ if (!propertyName.startsWith('customattribute') && unknownOptions.length > 0) {
116
+ return `Unknown options like ${unknownOptions.join(', ')} are only supported with customAttributes`;
117
+ }
118
+ if (propertyName.startsWith('customattribute')) {
119
+ const wronglyFormattedOptions = unknownOptions.filter(key => !key.toLowerCase().startsWith('displayname-'));
120
+ if (wronglyFormattedOptions.length > 0) {
121
+ return `Wrong option format detected for the following option(s): ${wronglyFormattedOptions.join(', ')}'. When adding localizations for customAttributes, use the format displayName-<languageTag>.`;
122
+ }
123
+ }
124
+ return true;
125
+ });
126
+ };
127
+ export default new TenantPeopleProfileCardPropertyAddCommand();
128
+ //# sourceMappingURL=people-profilecardproperty-add.js.map
@@ -0,0 +1,73 @@
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 _TenantPeopleProfileCardPropertyGetCommand_instances, _TenantPeopleProfileCardPropertyGetCommand_initOptions, _TenantPeopleProfileCardPropertyGetCommand_initValidators;
7
+ import GraphCommand from '../../../base/GraphCommand.js';
8
+ import request from '../../../../request.js';
9
+ import { profileCardPropertyNames } from './profileCardProperties.js';
10
+ import commands from '../../commands.js';
11
+ class TenantPeopleProfileCardPropertyGetCommand extends GraphCommand {
12
+ get name() {
13
+ return commands.PEOPLE_PROFILECARDPROPERTY_GET;
14
+ }
15
+ get description() {
16
+ return 'Retrieves information about a specific profile card property';
17
+ }
18
+ constructor() {
19
+ super();
20
+ _TenantPeopleProfileCardPropertyGetCommand_instances.add(this);
21
+ __classPrivateFieldGet(this, _TenantPeopleProfileCardPropertyGetCommand_instances, "m", _TenantPeopleProfileCardPropertyGetCommand_initOptions).call(this);
22
+ __classPrivateFieldGet(this, _TenantPeopleProfileCardPropertyGetCommand_instances, "m", _TenantPeopleProfileCardPropertyGetCommand_initValidators).call(this);
23
+ }
24
+ async commandAction(logger, args) {
25
+ try {
26
+ if (this.verbose) {
27
+ await logger.logToStderr(`Retrieving information about profile card property '${args.options.name}'...`);
28
+ }
29
+ const requestOptions = {
30
+ url: `${this.resource}/v1.0/admin/people/profileCardProperties/${args.options.name}`,
31
+ headers: {
32
+ accept: 'application/json;odata.metadata=none'
33
+ },
34
+ responseType: 'json'
35
+ };
36
+ const result = await request.get(requestOptions);
37
+ let output = result;
38
+ // Transform the output to make it more readable
39
+ if (args.options.output && args.options.output !== 'json' && result.annotations.length > 0) {
40
+ output = result.annotations[0].localizations.reduce((acc, curr) => ({
41
+ ...acc,
42
+ ['displayName ' + curr.languageTag]: curr.displayName
43
+ }), {
44
+ ...result,
45
+ displayName: result.annotations[0].displayName
46
+ });
47
+ delete output.annotations;
48
+ }
49
+ await logger.log(output);
50
+ }
51
+ catch (err) {
52
+ if (err.response?.status === 404) {
53
+ this.handleError(`Profile card property '${args.options.name}' does not exist.`);
54
+ }
55
+ this.handleRejectedODataJsonPromise(err);
56
+ }
57
+ }
58
+ }
59
+ _TenantPeopleProfileCardPropertyGetCommand_instances = new WeakSet(), _TenantPeopleProfileCardPropertyGetCommand_initOptions = function _TenantPeopleProfileCardPropertyGetCommand_initOptions() {
60
+ this.options.unshift({
61
+ option: '-n, --name <name>',
62
+ autocomplete: profileCardPropertyNames
63
+ });
64
+ }, _TenantPeopleProfileCardPropertyGetCommand_initValidators = function _TenantPeopleProfileCardPropertyGetCommand_initValidators() {
65
+ this.validators.push(async (args) => {
66
+ if (!profileCardPropertyNames.some(p => p.toLowerCase() === args.options.name.toLowerCase())) {
67
+ return `'${args.options.name}' is not a valid value for option name. Allowed values are: ${profileCardPropertyNames.join(', ')}.`;
68
+ }
69
+ return true;
70
+ });
71
+ };
72
+ export default new TenantPeopleProfileCardPropertyGetCommand();
73
+ //# sourceMappingURL=people-profilecardproperty-get.js.map
@@ -0,0 +1,63 @@
1
+ import GraphCommand from '../../../base/GraphCommand.js';
2
+ import request from '../../../../request.js';
3
+ import commands from '../../commands.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
+ constructor() {
12
+ super();
13
+ }
14
+ async commandAction(logger, args) {
15
+ try {
16
+ if (this.verbose) {
17
+ await logger.logToStderr(`Lists all profile card properties...`);
18
+ }
19
+ const requestOptions = {
20
+ url: `${this.resource}/v1.0/admin/people/profileCardProperties`,
21
+ headers: {
22
+ accept: 'application/json;odata.metadata=none'
23
+ },
24
+ responseType: 'json'
25
+ };
26
+ const result = await request.get(requestOptions);
27
+ let output = result;
28
+ if (args.options.output && args.options.output !== 'json') {
29
+ output = output.value.sort((n1, n2) => {
30
+ const localizations1 = n1.annotations[0]?.localizations?.length ?? 0;
31
+ const localizations2 = n2.annotations[0]?.localizations?.length ?? 0;
32
+ if (localizations1 > localizations2) {
33
+ return -1;
34
+ }
35
+ if (localizations1 < localizations2) {
36
+ return 1;
37
+ }
38
+ return 0;
39
+ });
40
+ output = output.map((p) => {
41
+ const propertyAnnotations = p.annotations[0]?.localizations?.map((l) => {
42
+ return { ['displayName ' + l.languageTag]: l.displayName };
43
+ }) ?? [];
44
+ const propertyAnnotationsObject = Object.assign({}, ...propertyAnnotations);
45
+ const result = { directoryPropertyName: p.directoryPropertyName };
46
+ if (p.annotations[0]?.displayName) {
47
+ result.displayName = p.annotations[0]?.displayName;
48
+ }
49
+ return {
50
+ ...result,
51
+ ...propertyAnnotationsObject
52
+ };
53
+ });
54
+ }
55
+ await logger.log(output);
56
+ }
57
+ catch (err) {
58
+ this.handleRejectedODataJsonPromise(err);
59
+ }
60
+ }
61
+ }
62
+ export default new TenantPeopleProfileCardPropertyListCommand();
63
+ //# 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,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,10 @@ 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`,
5
9
  REPORT_ACTIVEUSERCOUNTS: `${prefix} report activeusercounts`,
6
10
  REPORT_ACTIVEUSERDETAIL: `${prefix} report activeuserdetail`,
7
11
  REPORT_OFFICE365ACTIVATIONCOUNTS: `${prefix} report office365activationcounts`,
@@ -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