Azure / Azure/azure-powershell
[Doc]: New-AzCommunicationServiceKey incorrect parameter description in Documentation
- Dominant language
- C#
- Stars
- 4.8k
- Forks
- 4.3k
- Avg merge
- 2d 17h
- Merged PRs (30d)
- 51
Description
### Type of issue
Other (describe below)
### Feedback
Hi
This information is incorrect:
https://learn.microsoft.com/en-us/powershell/module/az.communication/new-azcommunicationservicekey?view=azps-14.1.0#-keytype
-KeyType
The keyType to regenerate. Must be either 'primary' or 'secondary'(case-insensitive).
should be:
-KeyType
The keyType to regenerate. Must be either 'Primary' or 'Secondary'(case-sensitive).
When primary or secondary is used with KeyType parameter it will fail with error "HTTP request payload failed validation against API specification with one or more errors. Please see details for more information."
But correct information is in example ... https://learn.microsoft.com/en-us/powershell/module/az.communication/new-azcommunicationservicekey?view=azps-14.1.0#example-1-regenerates-the-secondary-key-using-a-keytype
Also older version supported -parameter parameter this was removed without any information, release noted or warning.
https://learn.microsoft.com/en-us/powershell/module/az.communication/new-azcommunicationservicekey?view=azps-12.5.0#-parameter
### Page URL
https://learn.microsoft.com/en-us/powershell/module/az.communication/new-azcommunicationservicekey?view=azps-14.1.0
### Content source URL
https://github.com/Azure/azure-powershell/blob/main/src/Communication/Communication/help/New-AzCommunicationServiceKey.md
### Author
@mikefrobbins
### Document Id
8055e333-1ac0-b501-daed-5313973eb59d
### Platform Id
4dc58bc6-f1af-5841-f713-e7ba889388a6
Contributor guide
Assessment
This issue has not been assessed yet.