Skip to content

Commit f229918

Browse files
t-bzhanBo Zhang
andauthored
[Azure CDN] Fixed mandatory parameters issue in Get-AzCdnEndpointResourceUsage cmdlet (Azure#15709)
* [Azure CDN] Fixed mandatory parameters issue in `Get-AzCdnEndpointResourceUsage` cmdlet * Suppress analysis error regarding to the deemed breaking change * Fix breaking changes in ByObjectParameterSet * Add back BreakingChangeIssues.csv Co-authored-by: Bo Zhang <[email protected]>
1 parent 7af211f commit f229918

File tree

5 files changed

+43
-11
lines changed

5 files changed

+43
-11
lines changed

src/Cdn/Cdn/ChangeLog.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
-->
2020

2121
## Upcoming Release
22+
* Fixed mandatory parameters issue in `Get-AzCdnEndpointResourceUsage` cmdlet
2223

2324
## Version 1.7.1
2425
* Fixed profile missing issue in `Remove-AzCdnProfile` cmdlet

src/Cdn/Cdn/Endpoint/GetAzureRmCdnEndpointResourceUsage.cs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,16 @@
2121
using Microsoft.Azure.Commands.Cdn.Models;
2222
using Microsoft.Azure.Commands.Cdn.Models.Endpoint;
2323
using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
24+
using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
2425

2526
namespace Microsoft.Azure.Commands.Cdn.Endpoint
2627
{
2728
[Cmdlet("Get", ResourceManager.Common.AzureRMConstants.AzureRMPrefix + "CdnEndpointResourceUsage", DefaultParameterSetName = FieldsParameterSet), OutputType(typeof(PSResourceUsage))]
2829
public class GetAzureRmCdnEndpointResourceUsage : AzureCdnCmdletBase
2930
{
30-
[Parameter(Mandatory = false, HelpMessage = "Azure CDN endpoint name.")]
31+
[Parameter(Mandatory = true, HelpMessage = "Azure CDN endpoint name.", ParameterSetName = FieldsParameterSet)]
32+
[Parameter(Mandatory = false, HelpMessage = "Azure CDN endpoint name.", ParameterSetName = ObjectParameterSet)]
33+
[CmdletParameterBreakingChange("EndpointName", ChangeDescription = "Parameter is being deprecated in ByObjectParameterSet without being replaced")]
3134
[ValidateNotNullOrEmpty]
3235
public string EndpointName { get; set; }
3336

src/Cdn/Cdn/help/Get-AzCdnEndpointResourceUsage.md

Lines changed: 28 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Gets the resource usage of a CDN endpoint.
1414

1515
### ByFieldsParameterSet (Default)
1616
```
17-
Get-AzCdnEndpointResourceUsage [-EndpointName <String>] -ProfileName <String> -ResourceGroupName <String>
17+
Get-AzCdnEndpointResourceUsage -EndpointName <String> -ProfileName <String> -ResourceGroupName <String>
1818
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
1919
```
2020

@@ -25,16 +25,26 @@ Get-AzCdnEndpointResourceUsage [-EndpointName <String>] -CdnEndpoint <PSEndpoint
2525
```
2626

2727
## DESCRIPTION
28-
{{Fill in the Description}}
28+
The **Get-AzCdnEndpointResourceUsage** cmdlet gets resource limits and current usage for a CDN endpoint.
2929

3030
## EXAMPLES
3131

3232
### Example 1
33-
```
34-
PS C:\> {{ Add example code here }}
33+
```powershell
34+
PS C:\> Get-AzCdnEndpointResourceUsage -ProfileName profile1 -ResourceGroupName rg -EndpointName endpoint1
35+
ResourceType Unit CurrentValue Limit
36+
------------ ---- ------------ -----
37+
customdomain count 2 20
38+
geofilter count 1 25
39+
deliveryrule count 2 25
40+
deliveryrulecondition count 2 10
41+
deliveryruleaction count 1 5
42+
origin count 2 10
43+
origingroup count 2 10
44+
originsPerOriginGroup count 2 10
3545
```
3646

37-
{{ Add example description here }}
47+
This example shows the resource limits and current usage of the endpoint with name 'endpoint1' under profile 'profile1'.
3848

3949
## PARAMETERS
4050

@@ -73,7 +83,19 @@ Azure CDN endpoint name.
7383
7484
```yaml
7585
Type: System.String
76-
Parameter Sets: (All)
86+
Parameter Sets: ByFieldsParameterSet
87+
Aliases:
88+
89+
Required: True
90+
Position: Named
91+
Default value: None
92+
Accept pipeline input: False
93+
Accept wildcard characters: False
94+
```
95+
96+
```yaml
97+
Type: System.String
98+
Parameter Sets: ByObjectParameterSet
7799
Aliases:
78100

79101
Required: False

src/Cdn/Cdn/help/Get-AzCdnProfileResourceUsage.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,16 +25,19 @@ Get-AzCdnProfileResourceUsage -CdnProfile <PSProfile> [-DefaultProfile <IAzureCo
2525
```
2626

2727
## DESCRIPTION
28-
{{Fill in the Description}}
28+
The **Get-AzCdnProfileResourceUsage** cmdlet gets resource limits and current usage for a CDN profile.
2929

3030
## EXAMPLES
3131

3232
### Example 1
33-
```
34-
PS C:\> {{ Add example code here }}
33+
```powershell
34+
PS C:\> Get-AzCdnProfileResourceUsage -ProfileName profile1 -ResourceGroupName rg
35+
ResourceType Unit CurrentValue Limit
36+
------------ ---- ------------ -----
37+
endpoint count 2 25
3538
```
3639

37-
{{ Add example description here }}
40+
This example shows the resource limits and current usage of the profile with name 'profile1'.
3841

3942
## PARAMETERS
4043

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
"AssemblyFileName","ClassName","Target","Severity","ProblemId","Description","Remediation"
2+
"Az.Cdn","Microsoft.Azure.Commands.Cdn.Endpoint.GetAzureRmCdnEndpointResourceUsage","Get-AzCdnEndpointResourceUsage","0","1050","The parameter set '__AllParameterSets' for cmdlet 'Get-AzCdnEndpointResourceUsage' has been removed.","Add parameter set '__AllParameterSets' back to cmdlet 'Get-AzCdnEndpointResourceUsage'."
3+
"Az.Cdn","Microsoft.Azure.Commands.Cdn.Endpoint.GetAzureRmCdnEndpointResourceUsage","Get-AzCdnEndpointResourceUsage","0","1050","The parameter set 'ByFieldsParameterSet' for cmdlet 'Get-AzCdnEndpointResourceUsage' has been removed.","Add parameter set 'ByFieldsParameterSet' back to cmdlet 'Get-AzCdnEndpointResourceUsage'."

0 commit comments

Comments
 (0)