The display name of Azure Policy assignment is optional or not

[racchen]

According to the document: https://learn.microsoft.com/en-us/cli/azure/policy/assignment?view=azure-cli-latest#az-policy-assignment-create-optional-parameters & https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/subscription_policy_assignment, --display-name is an optional parameter for Azure Policy Assignment.

However, the assignment name is required in Azure Portal. Yes, we can deploy the policy without display-name successfully. It is pretty confused for users since they see different behaviours in Azure Portal. Any ideas?

---

Document Details

⚠ Do not edit this section. It is required for learn.microsoft.com ➟ GitHub issue linking.

• ID: 1c6760bb-c278-da56-a95c-4e82e221f1e8
• Version Independent ID: e25cbd2a-b415-214f-7d50-c403992c9361
• Content: az policy assignment
• Content Source: latest/docs-ref-autogen/policy/assignment.yml
• Service: azure-resource-manager
• GitHub Login: @rloutlaw
• Microsoft Alias: routlaw

[yonzhan]

@zhoxing-ms for awareness

[zhoxing-ms]

Actually, --display-name parameter is optional in the REST service policy-assignments/create, so the design of our client side is consistent with the design of REST service.

However, I personally do not recommend that CLI also mark the --display-name parameter as required, because this will cause a breaking change to users, and it is inconsistent with the design of REST service and other client tools.

@racchen In fact, I'm not sure whether the inconsistency between Portal and REST service is reasonable. Please contact the Portal team to see if they can improve their UI design, especially when they describe the assignment display name as assignment name (please note that they are completely different things. Only assignment name is required for server side, and assignment display name should be optional) in the UI which is really confusing, thanks~

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @josephkwchan, @jennyhunter-msft.

Issue Details

---

According to the document: https://learn.microsoft.com/en-us/cli/azure/policy/assignment?view=azure-cli-latest#az-policy-assignment-create-optional-parameters & https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/subscription_policy_assignment, --display-name is an optional parameter for Azure Policy Assignment.

However, the assignment name is required in Azure Portal. Yes, we can deploy the policy without display-name successfully. It is pretty confused for users since they see different behaviours in Azure Portal. Any ideas?

---

Document Details

⚠ Do not edit this section. It is required for learn.microsoft.com ➟ GitHub issue linking.

• ID: 1c6760bb-c278-da56-a95c-4e82e221f1e8
• Version Independent ID: e25cbd2a-b415-214f-7d50-c403992c9361
• Content: az policy assignment
• Content Source: latest/docs-ref-autogen/policy/assignment.yml
• Service: azure-resource-manager
• GitHub Login: @rloutlaw
• Microsoft Alias: routlaw

Author:	racchen
Assignees:	zhoxing-ms
Labels:	Service Attention, question, ARM, customer-reported, Portal, Auto-Assign, Azure CLI Team
Milestone:	Backlog

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @aperezcloud, @kenieva.

Issue Details

---

According to the document: https://learn.microsoft.com/en-us/cli/azure/policy/assignment?view=azure-cli-latest#az-policy-assignment-create-optional-parameters & https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/subscription_policy_assignment, --display-name is an optional parameter for Azure Policy Assignment.

However, the assignment name is required in Azure Portal. Yes, we can deploy the policy without display-name successfully. It is pretty confused for users since they see different behaviours in Azure Portal. Any ideas?

---

Document Details

⚠ Do not edit this section. It is required for learn.microsoft.com ➟ GitHub issue linking.

• ID: 1c6760bb-c278-da56-a95c-4e82e221f1e8
• Version Independent ID: e25cbd2a-b415-214f-7d50-c403992c9361
• Content: az policy assignment
• Content Source: latest/docs-ref-autogen/policy/assignment.yml
• Service: azure-resource-manager
• GitHub Login: @rloutlaw
• Microsoft Alias: routlaw

Author:	racchen
Assignees:	zhoxing-ms
Labels:	Service Attention, question, customer-reported, Policy, Portal, Auto-Assign, Azure CLI Team
Milestone:	Backlog