Adding Customer Usage Attribution to ESLZ/ALZ ARM and Portal template (…

…Azure#938) * code complete for telemetry * changed URL for cuasettings and corrected case for boolean * moved customer usage, enabled false as default, changed cua info box link * fixing json * correcting default cua value * adding eslz template pieces separately to diagnose json linting issue * adding eslz template pieces separately to diagnose json linting issue * adding eslz template pieces separately to diagnose json linting issue * adding eslz template pieces separately to diagnose json linting issue * adding eslz template pieces separately to diagnose json linting issue * fixed linting issue, added more detail to the cuaSettingsInfo portal resource * fixing type mismatch issue * changed portal output parameter * added parens * trying to fix parsing * added mandatory location parameter * fixing parameter nesting in cuaid resource * removing properties.parameters * adding deployment location to pid * shorter description * Update docs/wiki/Deploying-Enterprise-Scale-CustomerUsage.md adding appropriate syntax for markdown Co-authored-by: Jack Tracey <[email protected]> * Update docs/wiki/Deploying-Enterprise-Scale-CustomerUsage.md Adding appropriate markdown syntax Co-authored-by: Jack Tracey <[email protected]> * Update docs/wiki/Deploying-Enterprise-Scale-CustomerUsage.md Adding appropriate syntax for markdown Co-authored-by: Jack Tracey <[email protected]> * Update docs/wiki/Deploying-Enterprise-Scale-CustomerUsage.md Adding appropriate syntax for markdown Co-authored-by: Jack Tracey <[email protected]> * Update docs/wiki/Deploying-Enterprise-Scale-CustomerUsage.md removing markdownlint-restore Co-authored-by: Jack Tracey <[email protected]> * Update docs/wiki/Deploying-Enterprise-Scale-CustomerUsage.md removing markdown lint disable Co-authored-by: Jack Tracey <[email protected]> * Update docs/wiki/Deploying-Enterprise-Scale-CustomerUsage.md Co-authored-by: Jack Tracey <[email protected]> * adding new document to wiki docs, fixed resource links to wiki, fixed parameter format * remove blank line and fix indents * fix indent and remove whitespaces * convert to unique string for PID deployment name * add section for cua and update output * Update docs/wiki/Deploying-Enterprise-Scale-CustomerUsage.md Co-authored-by: Jack Tracey <[email protected]> * added screenshot for disabling in the portal * added better screenshots for portal experience * rearranged Wiki * rearranged CUA wiki * rearranged CUA wiki * changed casing to reflect parameter values * added more descriptive naming to wiki articles * edited pictures from true/false to yes/no * edited documentation to reflect actual values for cua parameter * corrected image name * removed excesive use of customer usage * added clear paths for portal experience and ARM template * added space in wiki * updated pic in wiki * updated picture formats * updated picture formats * updated picture formats * updated picture formats * update default to new value * move pid deployment to var Co-authored-by: Jack Tracey <[email protected]>
jtracey93 · Mar 29, 2022 · 83f7e55 · 83f7e55
1 parent 246d839
commit 83f7e55
Show file tree

Hide file tree

Showing 11 changed files with 276 additions and 176 deletions.
diff --git a/README.md b/README.md
@@ -6,6 +6,7 @@
 * [Community Calls](https://github.com/Azure/Enterprise-Scale/wiki/Community-Calls)
 * [Enterprise-Scale Landing Zones - User Guide](https://github.com/Azure/Enterprise-Scale/wiki#enterprise-scale-landing-zones-user-guide)
 * [Enterprise-Scale Architecture](./docs/EnterpriseScale-Architecture.md)
+* [Telemetry Tracking Using Customer Usage Attribution (PID)](https://github.com/Azure/Enterprise-Scale/wiki/Deploying-Enterprise-Scale-CustomerUsage)
 * [Configure Azure permission for ARM Template deployments](./docs/EnterpriseScale-Setup-azure.md)
 * [Deploy Reference Implementation](./docs/EnterpriseScale-Deploy-reference-implentations.md)
   * [Contoso Reference - Scope and Design](./docs/reference/contoso/Readme.md)

diff --git a/docs/wiki/Deploying-Enterprise-Scale-CustomerUsage.md b/docs/wiki/Deploying-Enterprise-Scale-CustomerUsage.md
@@ -0,0 +1,30 @@
+## Telemetry Tracking Using Customer Usage Attribution (PID)
+
+Microsoft can identify the deployments of the Azure Resource Manager templates with the deployed Azure resources. Microsoft can correlate these resources used to support the deployments. Microsoft collects this information to provide the best experiences with their products and to operate their business. The telemetry is collected through [customer usage attribution](https://docs.microsoft.com/azure/marketplace/azure-partner-customer-usage-attribution). The data is collected and governed by Microsoft's privacy policies, located at the [trust center](https://www.microsoft.com/trustcenter).
+
+To enable or disable the telemetry via the portal experience (recommended), use the radio toggle to specify your preference.
+
+Customer Usage Attribution Disabled:
+![ESLZ ARM Template Telemetry Opt Out Toggle Control Disabled](./media/cua-portal-experience-disabled.jpg)
+Customer Usage Attribution Enabled:
+![ESLZ ARM Template Telemetry Opt Out Toggle Control Enabled](./media/cua-portal-experience-enabled.jpg)
+
+
+Alternatively, to enable or disable this tracking via the ARM template experience, we have included a parameter called `telemetryOptOut` in order to opt out of telemetry tracking to the ESLZ ARM Template in this repo with a simple boolean flag. The default value `false` which **enables** the telemetry. If you would like to disable this tracking, then simply set this value to `true` and this module will not be included in deployments and **therefore disables** the telemetry tracking.
+
+In the `eslzARM.json` file, you will see the following:
+
+![ESLZ ARM Template parameter example](./media/cua-parameter.png)
+![ESLZ ARM Template variable example](./media/cua-variable.png)
+![ESLZ ARM Template resource example](./media/cua-resource.png)
+
+
+
+If you are happy with leaving telemetry tracking enabled, no changes are required. Please do not edit the module name or value of the variable `cuaID` in any module.
+
+## Module PID Value Mapping
+The following are the unique ID's (also known as PIDs) used in each of the modules.
+
+| Module Name                 | PID                                  |
+| --------------------------- | ------------------------------------ |
+| ALZ Accelerator/ESLZ ARM Deployment         | 35c42e79-00b3-42eb-a9ac-e542953efb3c |
diff --git a/docs/wiki/Home.md b/docs/wiki/Home.md
@@ -17,6 +17,7 @@ The Enterprise-Scale Landing Zones User Guide aims to provide comprehensive end-
   * [What happens when you deploy Enterprise-Scale?](https://github.com/Azure/Enterprise-Scale/wiki/How-Enterprise-Scale-Works#what-happens-when-you-deploy-enterprise-scale)
 * Deploying Enterprise-Scale
   * [Pre-requisites](https://github.com/Azure/Enterprise-Scale/wiki/Deploying-Enterprise-Scale-Pre-requisites)
+  * [Telemetry Tracking Using Customer Usage Attribution (PID)](https://github.com/Azure/Enterprise-Scale/wiki/Deploying-Enterprise-Scale-CustomerUsage)
   * [Deploy Enterprise-Scale without hybrid connectivity to on-premises](https://github.com/Azure/Enterprise-Scale/wiki/Deploying-Enterprise-Scale-Foundation)
   * [Deploy Enterprise-Scale with a hub and spoke based network topology](https://github.com/Azure/Enterprise-Scale/wiki/Deploying-Enterprise-Scale-HubAndSpoke)
   * [Deploy Enterprise-Scale with an Azure Virtual WAN based network topology](https://github.com/Azure/Enterprise-Scale/wiki/Deploying-Enterprise-Scale-VWAN)

diff --git a/docs/wiki/_Sidebar.md b/docs/wiki/_Sidebar.md
@@ -14,6 +14,7 @@
   * [What happens when you deploy Enterprise-Scale?](https://github.com/Azure/Enterprise-Scale/wiki/How-Enterprise-Scale-Works#what-happens-when-you-deploy-enterprise-scale)
 * Deploying Enterprise-Scale
   * [Pre-requisites](https://github.com/Azure/Enterprise-Scale/wiki/Deploying-Enterprise-Scale-Pre-requisites)
+  * [Telemetry Tracking Using Customer Usage Attribution (PID)](https://github.com/Azure/Enterprise-Scale/wiki/Deploying-Enterprise-Scale-CustomerUsage)
   * [Deploy Enterprise-Scale without hybrid connectivity to on-premises](https://github.com/Azure/Enterprise-Scale/wiki/Deploying-Enterprise-Scale-Foundation)
   * [Deploy Enterprise-Scale with a hub and spoke based network topology](https://github.com/Azure/Enterprise-Scale/wiki/Deploying-Enterprise-Scale-HubAndSpoke)
   * [Deploy Enterprise-Scale with an Azure Virtual WAN based network topology](https://github.com/Azure/Enterprise-Scale/wiki/Deploying-Enterprise-Scale-VWAN)

diff --git a/docs/wiki/media/cua-parameter.png b/docs/wiki/media/cua-parameter.png
diff --git a/docs/wiki/media/cua-portal-experience-disabled.jpg b/docs/wiki/media/cua-portal-experience-disabled.jpg
diff --git a/docs/wiki/media/cua-portal-experience-enabled.jpg b/docs/wiki/media/cua-portal-experience-enabled.jpg
diff --git a/docs/wiki/media/cua-resource.png b/docs/wiki/media/cua-resource.png
diff --git a/docs/wiki/media/cua-variable.png b/docs/wiki/media/cua-variable.png