New command: m365 graph directoryextension add

Author: MartinM85

docs/docs/cmd/graph/directoryextension/directoryextension-add.mdx

@@ -4,7 +4,7 @@ import TabItem from '@theme/TabItem';
 
 # graph directoryextension add
 
-Create a new directory extension
+Creates a new directory extension
 
 ## Usage
 
@@ -30,7 +30,7 @@ m365 graph directoryextension add [options]
 `--dataType <dataType>`
 : The data type of the value the extension property can hold. Possible values are: `Binary`, `Boolean`, `DateTime`, `Integer`, `LargeInteger` and `String`.
 
-`targetObjects <targetObjects>`
+`--targetObjects <targetObjects>`
 : Comma-separated list of Microsoft Graph resources that can use the extension. Possible values are: `User`, `Group`, `Application`, `AdministrativeUnit`, `Device` and `Organization`.
 
 `--isMultiValued`

src/m365/graph/commands/directoryextension/directoryextension-add.spec.ts

@@ -65,7 +65,7 @@ describe(commands.DIRECTORYEXTENSION_ADD, () => {
 
   before(() => {
     sinon.stub(auth, 'restoreAuth').resolves();
-    sinon.stub(telemetry, 'trackEvent').returns();
+    sinon.stub(telemetry, 'trackEvent').resolves();
     sinon.stub(pid, 'getProcessName').returns('');
     sinon.stub(session, 'getId').returns('');
     auth.connection.active = true;
@@ -248,7 +248,7 @@ describe(commands.DIRECTORYEXTENSION_ADD, () => {
   });
 
   it('correctly creates a directory extension defined on the application specified by appId', async () => {
-    sinon.stub(entraApp, 'getAppObjectIdFromAppId').resolves(appObjectId);
+    sinon.stub(entraApp, 'getAppRegistrationByAppId').resolves({ id: appObjectId });
     sinon.stub(request, 'post').callsFake(async (opts) => {
       if (opts.url === `https://graph.microsoft.com/v1.0/applications/${appObjectId}/extensionProperties`) {
         return responseForMultiValued;
@@ -269,7 +269,7 @@ describe(commands.DIRECTORYEXTENSION_ADD, () => {
   });
 
   it('correctly creates a directory extension defined on the application specified by appName', async () => {
-    sinon.stub(entraApp, 'getAppObjectIdFromAppName').resolves(appObjectId);
+    sinon.stub(entraApp, 'getAppRegistrationByAppName').resolves({ id: appObjectId });
     sinon.stub(request, 'post').callsFake(async (opts) => {
       if (opts.url === `https://graph.microsoft.com/v1.0/applications/${appObjectId}/extensionProperties`) {
         return responseWithMultipleTargets;

src/m365/graph/commands/directoryextension/directoryextension-add.ts

@@ -62,7 +62,7 @@ class GraphDirectoryExtensionAddCommand extends GraphCommand {
       const appObjectId = await this.getAppObjectId(args.options);
 
       if (args.options.verbose) {
-        await logger.logToStderr(`Adding directoroy extension to the app with id '${appObjectId}'...`);
+        await logger.logToStderr(`Adding directory extension to the app with id '${appObjectId}'...`);
       }
 
       const requestOptions: CliRequestOptions = {
@@ -94,10 +94,10 @@ class GraphDirectoryExtensionAddCommand extends GraphCommand {
     }
 
     if (options.appId) {
-      return await entraApp.getAppObjectIdFromAppId(options.appId);
+      return (await entraApp.getAppRegistrationByAppId(options.appId, ["id"])).id!;
     }
 
-    return await entraApp.getAppObjectIdFromAppName(options.appName!);
+    return (await entraApp.getAppRegistrationByAppName(options.appName!, ["id"])).id!;
   }
 }
 

src/utils/entraApp.spec.ts

@@ -12,6 +12,7 @@ describe('utils/entraApp', () => {
   const appId = '7f5df2f4-9ed6-4df7-86d7-eefbfc4ab091';
   const appName = 'ContosoApp';
   const secondAppObjectId = 'fc33aa61-cf0e-1234-9506-f633347202ac';
+
   afterEach(() => {
     sinonUtil.restore([
       request.get,
@@ -20,9 +21,9 @@ describe('utils/entraApp', () => {
     ]);
   });
 
-  it('correctly get single app object id by appId using getAppObjectIdFromAppId', async () => {
+  it('correctly get single app object id by appId using getAppRegistrationByAppId', async () => {
     sinon.stub(request, 'get').callsFake(async opts => {
-      if (opts.url === `https://graph.microsoft.com/v1.0/applications?$filter=appId eq '${appId}'&$select=id`) {
+      if (opts.url === `https://graph.microsoft.com/v1.0/applications?$filter=appId eq '${appId}'`) {
         return {
           value: [
             {
@@ -35,13 +36,13 @@ describe('utils/entraApp', () => {
       return 'Invalid Request';
     });
 
-    const actual = await entraApp.getAppObjectIdFromAppId(appId);
-    assert.deepStrictEqual(actual, appObjectId);
+    const actual = await entraApp.getAppRegistrationByAppId(appId);
+    assert.deepStrictEqual(actual.id, appObjectId);
   });
 
-  it('correctly get single app object id by appId using getAppObjectIdFromAppName', async () => {
+  it('correctly get single app object id by appId using getAppRegistrationByAppName', async () => {
     sinon.stub(request, 'get').callsFake(async opts => {
-      if (opts.url === `https://graph.microsoft.com/v1.0/applications?$filter=displayName eq '${formatting.encodeQueryParameter(appName)}'&$select=id`) {
+      if (opts.url === `https://graph.microsoft.com/v1.0/applications?$filter=displayName eq '${formatting.encodeQueryParameter(appName)}'`) {
         return {
           value: [
             {
@@ -54,11 +55,11 @@ describe('utils/entraApp', () => {
       return 'Invalid Request';
     });
 
-    const actual = await entraApp.getAppObjectIdFromAppName(appName);
-    assert.deepStrictEqual(actual, appObjectId);
+    const actual = await entraApp.getAppRegistrationByAppName(appName);
+    assert.deepStrictEqual(actual.id, appObjectId);
   });
 
-  it('handles selecting single application when multiple applications with the specified name found using getAppObjectIdFromAppName and cli is set to prompt', async () => {
+  it('handles selecting single application when multiple applications with the specified name found using getAppRegistrationByAppName and cli is set to prompt', async () => {
     sinon.stub(request, 'get').callsFake(async opts => {
       if (opts.url === `https://graph.microsoft.com/v1.0/applications?$filter=displayName eq '${formatting.encodeQueryParameter(appName)}'&$select=id`) {
         return {
@@ -74,23 +75,23 @@ describe('utils/entraApp', () => {
 
     sinon.stub(cli, 'handleMultipleResultsFound').resolves({ id: secondAppObjectId });
 
-    const actual = await entraApp.getAppObjectIdFromAppName(appName);
-    assert.deepStrictEqual(actual, secondAppObjectId);
+    const actual = await entraApp.getAppRegistrationByAppName(appName, ['id']);
+    assert.deepStrictEqual(actual.id, secondAppObjectId);
   });
 
-  it('throws error message when no application was found using getAppObjectIdFromAppId', async () => {
+  it('throws error message when no application was found using getAppRegistrationByAppId', async () => {
     sinon.stub(request, 'get').callsFake(async (opts) => {
-      if (opts.url === `https://graph.microsoft.com/v1.0/applications?$filter=appId eq '${appId}'&$select=id`) {
+      if (opts.url === `https://graph.microsoft.com/v1.0/applications?$filter=appId eq '${appId}'&$select=id,displayName`) {
         return { value: [] };
       }
 
       throw 'Invalid Request';
     });
 
-    await assert.rejects(entraApp.getAppObjectIdFromAppId(appId)), Error(`App with appId '${appId}' not found in Microsoft Entra ID`);
+    await assert.rejects(entraApp.getAppRegistrationByAppId(appId, ['id', 'displayName'])), Error(`App with appId '${appId}' not found in Microsoft Entra ID`);
   });
 
-  it('throws error message when no application was found using getAppObjectIdFromAppName', async () => {
+  it('throws error message when no application was found using getAppRegistrationByAppName', async () => {
     sinon.stub(request, 'get').callsFake(async (opts) => {
       if (opts.url === `https://graph.microsoft.com/v1.0/applications?$filter=displayName eq '${formatting.encodeQueryParameter(appName)}'&$select=id`) {
         return { value: [] };
@@ -99,10 +100,10 @@ describe('utils/entraApp', () => {
       throw 'Invalid Request';
     });
 
-    await assert.rejects(entraApp.getAppObjectIdFromAppName(appName)), Error(`App with name '${appName}' not found in Microsoft Entra ID`);
+    await assert.rejects(entraApp.getAppRegistrationByAppName(appName,['id'])), Error(`App with name '${appName}' not found in Microsoft Entra ID`);
   });
 
-  it('throws error message when multiple applications were found using getAppObjectIdFromAppName', async () => {
+  it('throws error message when multiple applications were found using getAppRegistrationByAppName', async () => {
     sinon.stub(cli, 'getSettingWithDefaultValue').callsFake((settingName, defaultValue) => {
       if (settingName === settingsNames.prompt) {
         return false;
@@ -112,18 +113,24 @@ describe('utils/entraApp', () => {
     });
 
     sinon.stub(request, 'get').callsFake(async opts => {
-      if (opts.url === `https://graph.microsoft.com/v1.0/applications?$filter=displayName eq '${formatting.encodeQueryParameter(appName)}'&$select=id`) {
+      if (opts.url === `https://graph.microsoft.com/v1.0/applications?$filter=displayName eq '${formatting.encodeQueryParameter(appName)}'&$select=id,displayName`) {
         return {
           value: [
-            { id: appObjectId },
-            { id: secondAppObjectId }
+            {
+              id: appObjectId,
+              displayName: appName
+            },
+            {
+              id: secondAppObjectId,
+              displayName: appName
+            }
           ]
         };
       }
 
       return 'Invalid Request';
     });
 
-    await assert.rejects(entraApp.getAppObjectIdFromAppName(appName), Error(`Multiple apps with name '${appName}' found in Microsoft Entra ID. Found: ${appObjectId}, ${secondAppObjectId}.`));
+    await assert.rejects(entraApp.getAppRegistrationByAppName(appName, ['id', 'displayName']), Error(`Multiple apps with name '${appName}' found in Microsoft Entra ID. Found: ${appObjectId}, ${secondAppObjectId}.`));
   });
 });

src/utils/entraApp.ts

@@ -413,27 +413,38 @@ export const entraApp = {
 
     return resolvedApis;
   },
-  async getAppObjectIdFromAppId(appId: string): Promise<string> {
-    const apps = await odata.getAllItems<Application>(`https://graph.microsoft.com/v1.0/applications?$filter=appId eq '${appId}'&$select=id`);
+  async getAppRegistrationByAppId(appId: string, properties?: string[]): Promise<Application> {
+    let url = `https://graph.microsoft.com/v1.0/applications?$filter=appId eq '${appId}'`;
+
+    if (properties) {
+      url += `&$select=${properties.join(',')}`;
+    }
+    const apps = await odata.getAllItems<Application>(url);
 
     if (apps.length === 0) {
       throw `App with appId '${appId}' not found in Microsoft Entra ID`;
     }
 
-    return apps[0].id!;
+    return apps[0];
   },
-  async getAppObjectIdFromAppName(appName: string): Promise<string> {
-    const apps = await odata.getAllItems<Application>(`https://graph.microsoft.com/v1.0/applications?$filter=displayName eq '${formatting.encodeQueryParameter(appName)}'&$select=id`);
+  async getAppRegistrationByAppName(appName: string, properties?: string[]): Promise<Application> {
+    let url = `https://graph.microsoft.com/v1.0/applications?$filter=displayName eq '${formatting.encodeQueryParameter(appName)}'`;
+
+    if (properties) {
+      url += `&$select=${properties.join(',')}`;
+    }
+
+    const apps = await odata.getAllItems<Application>(url);
 
     if (apps.length === 0) {
       throw `App with name '${appName}' not found in Microsoft Entra ID`;
     }
 
     if (apps.length > 1) {
       const resultAsKeyValuePair = formatting.convertArrayToHashTable('id', apps);
-      return (await cli.handleMultipleResultsFound<Application>(`Multiple apps with name '${appName}' found in Microsoft Entra ID.`, resultAsKeyValuePair)).id!;
+      return await cli.handleMultipleResultsFound<Application>(`Multiple apps with name '${appName}' found in Microsoft Entra ID.`, resultAsKeyValuePair);
     }
 
-    return apps[0].id!;
+    return apps[0];
   }
 };