Azure / Azure/azure-powershell

Insufficient Documentation to use the Cmdlet

Open
#25,395 4 comments 1 reaction 0 assignees View on GitHub
customer-reported Maintenance Service Attention
Dominant language
C#
Stars
4.8k
Forks
4.3k
Avg merge
2d 17h
Merged PRs (30d)
51

Description

### Type of issue

Missing information

### Feedback

The documentation and examples for the `Remove-AzConfigurationAssignment` cmdlet are completely insufficient to actually use the cmdlet in automation. Please provide better examples so that your customers can use this cmdlet. Examples of what we need are below.

`-ResourceType`: We have tried every combination we can think of for this parameter. What are valid values for this?

`-ProviderName`: Is this `Microsoft.Compute` or `Microsoft.Maintenance`?

`-ConfigurationAssignmentName`: Where is this found? based on a Az Graph Query, there is a name populated with some random characters. We assume this is the name, but not clear.

`-ResourceName`: Where to find this and how does it differ from `-ConfigurationAssignmentName`?

`-ResourceParentType`: What is this and what are the possible values?

`-ResourceParentName`: Where to find this?

We have tried many combinations over and over again, but are frequently hit with errors like this that are too vague to know how to fix it:

```Body:
{
"Error": {
"Code": "InvalidResource",
"Message": "Invalid configurationAssignment"
}
}
```

### Page URL

https://learn.microsoft.com/en-us/powershell/module/az.maintenance/remove-azconfigurationassignment?view=azps-12.0.0

### Content source URL

https://github.com/Azure/azure-powershell/blob/main/src/Maintenance/Maintenance/help/Remove-AzConfigurationAssignment.md

### Author

@mikefrobbins

### Document Id

cab3efa2-562c-4e4c-1883-515770785b70

Contributor guide

Open the contributing guide

Research direction

Start with src/Maintenance/Maintenance/help/Remove-AzConfigurationAssignment.md and compare it with the published cmdlet page. Investigate the six questioned parameters and the InvalidResource example, then update the documentation with valid values, how to locate each name, and automation examples that make successful usage and error resolution clear.

Written by the indexing model from the issue text.

Assessment

Tech stack
azure, powershell
Domain
cloud, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.