Skip to content

Commit 121e47b

Browse files
committed
updated help files with the correct naming and order.
1 parent 51e3322 commit 121e47b

22 files changed

+308
-310
lines changed

src/Peering/Peering/Peering/GetAzurePeeringLocationCommand.cs

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -105,11 +105,8 @@ public override void Execute()
105105
try
106106
{
107107
base.Execute();
108-
if (this.ShouldProcess(string.Format(Resources.ShouldProcessMessage, "a list of peering locations.")))
109-
{
110-
var peeringLocation = this.GetPeeringLocation();
111-
this.WriteObject(this.FilterPeeringLocations(peeringLocation));
112-
}
108+
var peeringLocation = this.GetPeeringLocation();
109+
this.WriteObject(this.FilterPeeringLocations(peeringLocation));
113110
}
114111
catch (InvalidOperationException mapException)
115112
{
@@ -141,7 +138,7 @@ private List<PSPeeringLocationObject> FilterPeeringLocations(List<PSPeeringLocat
141138
peeringLocationFiltered = (peeringLocationFiltered ?? peeringLocation).Where(x => x.PeeringDBFacilityId.Equals(this.PeeringDbFacilityId));
142139
}
143140

144-
if(this.PeeringLocation == null && this.PeeringDbFacilityId == null)
141+
if (this.PeeringLocation == null && this.PeeringDbFacilityId == null)
145142
{
146143
return peeringLocation;
147144
}

src/Peering/Peering/PeeringService/GetAzurePeeringServiceCommand.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ public class GetAzurePeeringServiceCommand : PeeringBaseCmdlet
6666
Position = 0,
6767
Mandatory = true,
6868
HelpMessage = Constants.ResourceIdHelp,
69+
ValueFromPipelineByPropertyName = true,
6970
ParameterSetName = Constants.ParameterSetNameByResourceId)]
7071
[ValidateNotNullOrEmpty]
7172
public string ResourceId { get; set; }
@@ -152,7 +153,7 @@ public List<PSPeeringService> GetPeeringByResource()
152153
/// Gets the InputObject Resource by ResourceGroupName and InputObject Name
153154
/// </summary>
154155
/// <returns>InputObject Resource</returns>
155-
public object GetPeeringByResourceAndName()
156+
public PSPeeringService GetPeeringByResourceAndName()
156157
{
157158
var ic = this.PeeringServicesClient.Get(this.ResourceGroupName, this.Name);
158159
var peer = this.ToPeeringServicePS(ic);

src/Peering/Peering/help/Get-AzLegacyPeering.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Gets the legacy peering for Seattle
5858
The credentials, account, tenant, and subscription used for communication with Azure.
5959

6060
```yaml
61-
Type: IAzureContextContainer
61+
Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
6262
Parameter Sets: (All)
6363
Aliases: AzContext, AzureRmContext, AzureCredential
6464

@@ -73,7 +73,7 @@ Accept wildcard characters: False
7373
Shows all Peering resource by Kind.
7474
7575
```yaml
76-
Type: String
76+
Type: System.String
7777
Parameter Sets: (All)
7878
Aliases:
7979

@@ -88,7 +88,7 @@ Accept wildcard characters: False
8888
Shows all Peering resource by Kind.
8989
9090
```yaml
91-
Type: String
91+
Type: System.String
9292
Parameter Sets: (All)
9393
Aliases:
9494

src/Peering/Peering/help/Get-AzPeerAsn.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Gets the PeerAsn
4242
The credentials, account, tenant, and subscription used for communication with Azure.
4343

4444
```yaml
45-
Type: IAzureContextContainer
45+
Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
4646
Parameter Sets: (All)
4747
Aliases: AzContext, AzureRmContext, AzureCredential
4848

@@ -57,7 +57,7 @@ Accept wildcard characters: False
5757
The unique name of the PSPeering.
5858
5959
```yaml
60-
Type: String
60+
Type: System.String
6161
Parameter Sets: (All)
6262
Aliases:
6363

src/Peering/Peering/help/Get-AzPeering.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ Gets the Exchange peering named `myExchangePeering1` based on the resource id.
109109
The credentials, account, tenant, and subscription used for communication with Azure.
110110

111111
```yaml
112-
Type: IAzureContextContainer
112+
Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
113113
Parameter Sets: (All)
114114
Aliases: AzContext, AzureRmContext, AzureCredential
115115

@@ -124,7 +124,7 @@ Accept wildcard characters: False
124124
Shows all Peering resource by Kind.
125125
126126
```yaml
127-
Type: String
127+
Type: System.String
128128
Parameter Sets: BySubscription
129129
Aliases:
130130

@@ -139,7 +139,7 @@ Accept wildcard characters: False
139139
The unique name of the PSPeering.
140140
141141
```yaml
142-
Type: String
142+
Type: System.String
143143
Parameter Sets: ByResourceGroupAndName
144144
Aliases:
145145

@@ -154,7 +154,7 @@ Accept wildcard characters: False
154154
The resource group name.
155155
156156
```yaml
157-
Type: String
157+
Type: System.String
158158
Parameter Sets: ByResourceGroupAndName
159159
Aliases:
160160

@@ -169,7 +169,7 @@ Accept wildcard characters: False
169169
The resource id string name.
170170
171171
```yaml
172-
Type: String
172+
Type: System.String
173173
Parameter Sets: ByResourceId
174174
Aliases:
175175

src/Peering/Peering/help/Get-AzPeeringLocation.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ Gets the exchange peering location for peering facility id 71.
9898
The credentials, account, tenant, and subscription used for communication with Azure.
9999

100100
```yaml
101-
Type: IAzureContextContainer
101+
Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
102102
Parameter Sets: (All)
103103
Aliases: AzContext, AzureRmContext, AzureCredential
104104

@@ -113,7 +113,7 @@ Accept wildcard characters: False
113113
Select 'Edge', 'CDN', and 'Transit'.
114114
115115
```yaml
116-
Type: String
116+
Type: System.String
117117
Parameter Sets: LocationByDirectType
118118
Aliases:
119119

@@ -128,7 +128,7 @@ Accept wildcard characters: False
128128
Shows all Peering resource by Kind.
129129
130130
```yaml
131-
Type: String
131+
Type: System.String
132132
Parameter Sets: (All)
133133
Aliases:
134134

@@ -143,7 +143,7 @@ Accept wildcard characters: False
143143
The PeeringDB.com Facility ID
144144
145145
```yaml
146-
Type: Int32
146+
Type: System.Nullable`1[System.Int32]
147147
Parameter Sets: LocationByFacilityId, LocationByDirectType
148148
Aliases:
149149

@@ -158,7 +158,7 @@ Accept wildcard characters: False
158158
The location of the resource.
159159
160160
```yaml
161-
Type: String
161+
Type: System.String
162162
Parameter Sets: Default, LocationByDirectType
163163
Aliases:
164164

src/Peering/Peering/help/Get-AzPeeringService.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ Gets a peering service by resource id
9797
The credentials, account, tenant, and subscription used for communication with Azure.
9898

9999
```yaml
100-
Type: IAzureContextContainer
100+
Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
101101
Parameter Sets: (All)
102102
Aliases: AzContext, AzureRmContext, AzureCredential
103103

@@ -112,7 +112,7 @@ Accept wildcard characters: False
112112
The unique name of the PSPeering.
113113
114114
```yaml
115-
Type: String
115+
Type: System.String
116116
Parameter Sets: ByResourceGroupAndName
117117
Aliases:
118118

@@ -127,7 +127,7 @@ Accept wildcard characters: False
127127
The create or use an existing resource group name.
128128
129129
```yaml
130-
Type: String
130+
Type: System.String
131131
Parameter Sets: ByResourceGroupName
132132
Aliases:
133133

@@ -139,7 +139,7 @@ Accept wildcard characters: False
139139
```
140140
141141
```yaml
142-
Type: String
142+
Type: System.String
143143
Parameter Sets: ByResourceGroupAndName
144144
Aliases:
145145

@@ -154,14 +154,14 @@ Accept wildcard characters: False
154154
The resource id string name.
155155
156156
```yaml
157-
Type: String
157+
Type: System.String
158158
Parameter Sets: ByResourceId
159159
Aliases:
160160

161161
Required: True
162162
Position: 0
163163
Default value: None
164-
Accept pipeline input: False
164+
Accept pipeline input: True (ByPropertyName)
165165
Accept wildcard characters: False
166166
```
167167
@@ -170,7 +170,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
170170
171171
## INPUTS
172172
173-
### None
173+
### System.String
174174
175175
## OUTPUTS
176176

src/Peering/Peering/help/Get-AzPeeringServiceLocation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Retrieves the peering locations for washington.
6565
The country filter
6666

6767
```yaml
68-
Type: String
68+
Type: System.String
6969
Parameter Sets: (All)
7070
Aliases:
7171

@@ -80,7 +80,7 @@ Accept wildcard characters: False
8080
The credentials, account, tenant, and subscription used for communication with Azure.
8181
8282
```yaml
83-
Type: IAzureContextContainer
83+
Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
8484
Parameter Sets: (All)
8585
Aliases: AzContext, AzureRmContext, AzureCredential
8686

src/Peering/Peering/help/Get-AzPeeringServicePrefix.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ Gets a specific prefix for a peering service by resource id.
9898
The credentials, account, tenant, and subscription used for communication with Azure.
9999

100100
```yaml
101-
Type: IAzureContextContainer
101+
Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
102102
Parameter Sets: (All)
103103
Aliases: AzContext, AzureRmContext, AzureCredential
104104

@@ -113,7 +113,7 @@ Accept wildcard characters: False
113113
The unique name of the PSPeering.
114114
115115
```yaml
116-
Type: String
116+
Type: System.String
117117
Parameter Sets: ByResourceGroupAndName, Default
118118
Aliases:
119119

@@ -128,7 +128,7 @@ Accept wildcard characters: False
128128
The peering service name. Use New-AzPeeringService cmdlet for a new peering service or Get-AzPeeringService for a list.
129129
130130
```yaml
131-
Type: String
131+
Type: System.String
132132
Parameter Sets: ByResourceGroupAndName
133133
Aliases:
134134

@@ -143,7 +143,7 @@ Accept wildcard characters: False
143143
Use a Get-AzPeeringService
144144
145145
```yaml
146-
Type: PSPeeringService
146+
Type: Microsoft.Azure.PowerShell.Cmdlets.Peering.Models.PSPeeringService
147147
Parameter Sets: Default
148148
Aliases:
149149

@@ -158,7 +158,7 @@ Accept wildcard characters: False
158158
The create or use an existing resource group name.
159159
160160
```yaml
161-
Type: String
161+
Type: System.String
162162
Parameter Sets: ByResourceGroupAndName
163163
Aliases:
164164

@@ -173,7 +173,7 @@ Accept wildcard characters: False
173173
The resource id string name.
174174
175175
```yaml
176-
Type: String
176+
Type: System.String
177177
Parameter Sets: ByResourceId
178178
Aliases:
179179

src/Peering/Peering/help/Get-AzPeeringServiceProvider.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Gets available peering service providers
3838
The credentials, account, tenant, and subscription used for communication with Azure.
3939

4040
```yaml
41-
Type: IAzureContextContainer
41+
Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
4242
Parameter Sets: (All)
4343
Aliases: AzContext, AzureRmContext, AzureCredential
4444

0 commit comments

Comments
 (0)