Merge pull request #291751 from mumian/1210-function-deployer

document deployer()

Author: prmerger-automator[bot]

articles/azure-resource-manager/bicep/bicep-functions-deployment.md

@@ -3,13 +3,49 @@ title: Bicep functions - deployment
 description: Describes the functions to use in a Bicep file to retrieve deployment information.
 ms.topic: reference
 ms.custom: devx-track-bicep
-ms.date: 06/26/2024
+ms.date: 12/10/2024
 ---
 
 # Deployment functions for Bicep
 
 This article describes the Bicep functions for getting values related to the current deployment.
 
+## deployer
+
+`deployer()`
+
+Returns the information about the current deployment principal.
+
+Namespace: [az](bicep-functions.md#namespaces-for-functions).
+
+### Return value
+
+This function returns the information about the current deployment principal, including tenant ID and object ID.
+
+```json
+{
+  "objectId": "",
+  "tenantId": ""
+}
+```
+
+### Example
+
+The following example Bicep file returns the deployer object.
+
+```bicep
+output deployer object = deployer()
+```
+
+The preceding example returns the following object:
+
+```json
+{
+  "objectId":"aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
+  "tenantId":"aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e"
+}
+```
+
 ## deployment
 
 `deployment()`

articles/azure-resource-manager/bicep/bicep-functions.md

@@ -3,7 +3,7 @@ title: Bicep functions
 description: Describes the functions to use in a Bicep file to retrieve values, work with strings and numerics, and retrieve deployment information.
 ms.topic: reference
 ms.custom: devx-track-bicep
-ms.date: 12/06/2024
+ms.date: 12/10/2024
 ---
 
 # Bicep functions
@@ -74,6 +74,7 @@ The following functions are available for working with dates. All of these funct
 
 The following functions are available for getting values related to the deployment. All of these functions are in the `az` namespace.
 
+* [deployer](./bicep-functions-deployment.md#deployer)
 * [deployment](./bicep-functions-deployment.md#deployment)
 * [environment](./bicep-functions-deployment.md#environment)
 

articles/azure-resource-manager/templates/template-functions-deployment.md

@@ -3,13 +3,14 @@ title: Template functions - deployment
 description: Describes the functions to use in an Azure Resource Manager template (ARM template) to retrieve deployment information.
 ms.topic: reference
 ms.custom: devx-track-arm-template
-ms.date: 06/26/2024
+ms.date: 12/10/2024
 ---
 
 # Deployment functions for ARM templates
 
 Resource Manager provides the following functions for getting values related to the current deployment of your Azure Resource Manager template (ARM template):
 
+* [developer](#deployer)
 * [deployment](#deployment)
 * [environment](#environment)
 * [parameters](#parameters)
@@ -20,6 +21,52 @@ To get values from resources, resource groups, or subscriptions, see [Resource f
 > [!TIP]
 > We recommend [Bicep](../bicep/overview.md) because it offers the same capabilities as ARM templates and the syntax is easier to use. To learn more, see [deployment](../bicep/bicep-functions-deployment.md) functions.
 
+## deployer
+
+`deployer()`
+
+Returns the information about the current deployment principal.
+
+In Bicep, use the [deployer](../bicep/bicep-functions-deployment.md#deployer) function.
+
+### Return value
+
+This function returns the information about the current deployment principal, including tenant ID and object ID.
+
+```json
+{
+  "objectId": "",
+  "tenantId": ""
+}
+```
+
+### Example
+
+The following example returns the deployer object.
+
+```json
+{
+  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
+  "contentVersion": "1.0.0.0",
+  "resources": [],
+  "outputs": {
+    "developerOutput": {
+      "type": "object",
+      "value": "[developer()]"
+    }
+  }
+}
+```
+
+The preceding example returns the following object:
+
+```json
+{
+  "objectId":"aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
+  "tenantId":"aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e"
+}
+```
+
 ## deployment
 
 `deployment()`

articles/azure-resource-manager/templates/template-functions.md

@@ -3,7 +3,7 @@ title: Template functions
 description: Describes the functions to use in an Azure Resource Manager template (ARM template) to retrieve values, work with strings and numerics, and retrieve deployment information.
 ms.topic: reference
 ms.custom: devx-track-arm-template
-ms.date: 05/10/2024
+ms.date: 12/10/2024
 ---
 
 # ARM template functions
@@ -122,6 +122,7 @@ For Bicep files, use the [date](../bicep/bicep-functions-date.md) functions.
 
 Resource Manager provides the following functions for getting values from sections of the template and values related to the deployment:
 
+* [deployer](template-functions-deployment.md#deployer)
 * [deployment](template-functions-deployment.md#deployment)
 * [environment](template-functions-deployment.md#environment)
 * [parameters](template-functions-deployment.md#parameters)