Skip to content

Commit a87632a

Browse files
frankguodongchenfrankguodongchen
committed
update help files
1 parent aa8d22e commit a87632a

18 files changed

+627
-270
lines changed

‎src/ResourceManager/ApplicationInsights/Commands.ApplicationInsights.Test/ScenarioTests/PricingAndDailyCapTests.ps1

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ function Test-GetApplicationInsightsPricingPlan
3333
$pricingPlan = Get-AzureRmApplicationInsights -ResourceGroupName $rgname -Name $appName -IncludePricingPlan;
3434

3535
Assert-NotNull $pricingPlan
36-
Assert-AreEqual "Basic" $pricingPlan.CurrentTier
36+
Assert-AreEqual "Basic" $pricingPlan.PricingPlan
3737

3838
Remove-AzureRmApplicationInsights -ResourceGroupName $rgname -Name $appName;
3939
}
@@ -66,7 +66,7 @@ function Test-SetApplicationInsightsPricingPlan
6666
$pricingPlan = Get-AzureRmApplicationInsights -ResourceGroupName $rgname -Name $appName -IncludePricingPlan;
6767

6868
Assert-NotNull $pricingPlan
69-
Assert-AreEqual "Basic" $pricingPlan.CurrentTier
69+
Assert-AreEqual "Basic" $pricingPlan.PricingPlan
7070

7171
$planName = "Application Insights Enterprise";
7272
$dailyCapGB = 300;
@@ -75,7 +75,7 @@ function Test-SetApplicationInsightsPricingPlan
7575

7676
$pricingPlan2 = Get-AzureRmApplicationInsights -ResourceGroupName $rgname -Name $appName -IncludePricingPlan;
7777
Assert-NotNull $pricingPlan2
78-
Assert-AreEqual $planName $pricingPlan2.CurrentTier
78+
Assert-AreEqual $planName $pricingPlan2.PricingPlan
7979
Assert-AreEqual $dailyCapGB $pricingPlan2.Cap
8080
Assert-AreEqual $stopSendEmail $pricingPlan2.StopSendNotificationWhenHitCap
8181

‎src/ResourceManager/ApplicationInsights/Commands.ApplicationInsights/ApplicationInsights/NewApplicationInsightsContinuousExport.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
using Microsoft.Azure.Commands.ApplicationInsights.Models;
1616
using Microsoft.Azure.Management.ApplicationInsights.Management.Models;
1717
using Microsoft.Azure.Management.Internal.Resources.Utilities.Models;
18-
using System;
18+
using System.Linq;
1919
using System.Management.Automation;
2020

2121
namespace Microsoft.Azure.Commands.ApplicationInsights
@@ -128,7 +128,7 @@ public override void ExecuteCmdlet()
128128
.GetAwaiter()
129129
.GetResult();
130130

131-
WriteComponentExportConfiguration(exportConfigurationsResponse.Body);
131+
WriteComponentExportConfiguration(exportConfigurationsResponse.Body.FirstOrDefault());
132132
}
133133
}
134134
}

‎src/ResourceManager/ApplicationInsights/Commands.ApplicationInsights/ApplicationInsights/SetApplicationInsightsContinuousExport.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ public class SetApplicationInsightsContinuousExportCommand : ApplicationInsights
8989
Mandatory = true,
9090
HelpMessage = "Destination Storage Location Id.")]
9191
[ValidateNotNullOrEmpty]
92-
public string StorageLocationId { get; set; }
92+
public string StorageLocation { get; set; }
9393

9494
[Parameter(
9595
Mandatory = true,
@@ -131,7 +131,7 @@ public override void ExecuteCmdlet()
131131
exportRequest.DestinationAccountId = this.StorageAccountId;
132132
exportRequest.DestinationStorageSubscriptionId = ParseSubscriptionFromId(this.StorageAccountId);
133133
exportRequest.DestinationAddress = this.StorageSASUri;
134-
exportRequest.DestinationStorageLocationId = this.StorageLocationId;
134+
exportRequest.DestinationStorageLocationId = this.StorageLocation;
135135
exportRequest.DestinationType = "Blob";
136136
exportRequest.RecordTypes = string.Join(",", ConvertToRecordType(this.DocumentType));
137137

‎src/ResourceManager/ApplicationInsights/Commands.ApplicationInsights/ApplicationInsights/SetApplicationInsightsPricingPlan.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ public override void ExecuteCmdlet()
108108
{
109109
features.CurrentBillingFeatures = new string[] { "Application Insights Enterprise" };
110110
}
111-
else if (this.PricingPlan.ToLowerInvariant().Contains("basic"))
111+
else if (this.PricingPlan.ToLowerInvariant().Contains("limited"))
112112
{
113113
features.CurrentBillingFeatures = new string[] { "Limited Basic" };
114114
}

‎src/ResourceManager/ApplicationInsights/Commands.ApplicationInsights/Models/PSApplicationInsightsComponent.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ public PSApplicationInsightsComponentTableView(ApplicationInsightsComponent comp
109109

110110
public class PSApplicationInsightsComponentWithPricingPlan : PSApplicationInsightsComponent
111111
{
112-
public string CurrentTier;
112+
public string PricingPlan;
113113

114114
public double? Cap { get; set; }
115115

@@ -128,11 +128,11 @@ public PSApplicationInsightsComponentWithPricingPlan(ApplicationInsightsComponen
128128
{
129129
if (billing.CurrentBillingFeatures.Any(f => f.Contains("Enterprise")))
130130
{
131-
this.CurrentTier = "Application Insights Enterprise";
131+
this.PricingPlan = "Application Insights Enterprise";
132132
}
133133
else
134134
{
135-
this.CurrentTier = billing.CurrentBillingFeatures.FirstOrDefault();
135+
this.PricingPlan = billing.CurrentBillingFeatures.FirstOrDefault();
136136
}
137137

138138
this.Cap = billing.DataVolumeCap.Cap;

‎src/ResourceManager/ApplicationInsights/Commands.ApplicationInsights/Models/PSPrcingPlan.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ namespace Microsoft.Azure.Commands.ApplicationInsights.Models
1919
{
2020
public class PSPricingPlan : PSDailyCap
2121
{
22-
public string CurrentTier;
22+
public string PricingPlan;
2323

2424

2525
public static PSPricingPlan Create(ApplicationInsightsComponentBillingFeatures billing)
@@ -34,11 +34,11 @@ public PSPricingPlan(ApplicationInsightsComponentBillingFeatures billing)
3434
{
3535
if (billing.CurrentBillingFeatures.Any(f => f.Contains("Enterprise")))
3636
{
37-
this.CurrentTier = "Application Insights Enterprise";
37+
this.PricingPlan = "Application Insights Enterprise";
3838
}
3939
else
4040
{
41-
this.CurrentTier = billing.CurrentBillingFeatures.FirstOrDefault();
41+
this.PricingPlan = billing.CurrentBillingFeatures.FirstOrDefault();
4242
}
4343
}
4444
}

‎src/ResourceManager/ApplicationInsights/Commands.ApplicationInsights/help/Get-AzureRmApplicationInsights.md

Lines changed: 62 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,21 +12,21 @@ Get application insights resources
1212

1313
## SYNTAX
1414

15-
### ResourceGroupParameterSet
15+
### ResourceGroupParameterSet (Default)
1616
```
1717
Get-AzureRmApplicationInsights [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>]
1818
[<CommonParameters>]
1919
```
2020

2121
### ComponentNameParameterSet
2222
```
23-
Get-AzureRmApplicationInsights [-ResourceGroupName] <String> [-Name] <String> [-IncludePricingPlan]
23+
Get-AzureRmApplicationInsights [-ResourceGroupName] <String> [-Name] <String> [-Full]
2424
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
2525
```
2626

2727
### ResourceIdParameterSet
2828
```
29-
Get-AzureRmApplicationInsights [-ResourceId] <ResourceIdentifier> [-IncludePricingPlan]
29+
Get-AzureRmApplicationInsights [-ResourceId] <ResourceIdentifier> [-Full]
3030
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
3131
```
3232

@@ -35,19 +35,64 @@ Get application insights resources in a resource group or specific resource
3535

3636
## EXAMPLES
3737

38-
### Example 1
38+
### Example 1 Get application insights resource
3939
```
4040
PS C:\> Get-AzureRmApplicationInsights -ResourceGroupName "testgroup" -Name "test"
41+
42+
Id : /subscriptions/{subid}/resourceGroups/testgroup/providers/microsoft.insights/components/test
43+
ResourceGroupName : testgroup
44+
Name : test
45+
Kind : web
46+
Location : eastus
47+
Type : microsoft.insights/components
48+
AppId : 7c8f0641-d307-41bc-b8f2-d30701adb4b3
49+
ApplicationType : web
50+
Tags : {}
51+
CreationDate : 7/5/2017 4:37:22 PM
52+
FlowType : Redfield
53+
HockeyAppId :
54+
HockeyAppToken :
55+
InstrumentationKey : 1e30d092-4b4b-47c6-ad39-7c10785d80f5
56+
ProvisioningState : Succeeded
57+
RequestSource : IbizaAIExtension
58+
SamplingPercentage :
59+
TenantId : b90b0dec-9b9a-4778-a84e-4ffb73bb17f7
4160
```
4261

4362
Get application insights resource named "test" in resoruce group "testgroup"
4463

45-
### Example 2
64+
### Example 2 Get application insights resource with pricing plan information
4665
```
4766
PS C:\> Get-AzureRmApplicationInsights -ResourceGroupName "testgroup" -Name "test" -IncludePricingPlan
67+
68+
Cap : 330
69+
ResetTime : 0
70+
StopSendNotificationWhenHitCap : True
71+
CapExpirationTime :
72+
IsCapped : False
73+
Id : /subscriptions/{subid}/resourceGroups/testgroup/providers/microsoft.insights/components/test
74+
ResourceGroupName : testgroup
75+
Name : test
76+
Kind : web
77+
Location : eastus
78+
Type : microsoft.insights/components
79+
AppId : 7c8f0641-d307-41bc-b8f2-d30701adb4b3
80+
ApplicationType : web
81+
Tags : {}
82+
CreationDate : 7/5/2017 4:37:22 PM
83+
FlowType : Redfield
84+
HockeyAppId :
85+
HockeyAppToken :
86+
InstrumentationKey : 1e30d092-4b4b-47c6-ad39-7c10785d80f5
87+
ProvisioningState : Succeeded
88+
RequestSource : IbizaAIExtension
89+
SamplingPercentage :
90+
TenantId : b90b0dec-9b9a-4778-a84e-4ffb73bb17f7
91+
PricingPlan : Basic
4892
```
4993

5094
Get application insights resource and include pricing plan information for resource named "test" in resoruce group "testgroup"
95+
5196
## PARAMETERS
5297

5398
### -DefaultProfile
@@ -66,16 +111,18 @@ Accept pipeline input: False
66111
Accept wildcard characters: False
67112
```
68113
69-
### -IncludePricingPlan
70-
If specified, it will get back pricing plan of the application insights component.```yaml
114+
### -Full
115+
If specified, it will get back pricing plan of the application insights component.
116+
117+
```yaml
71118
Type: SwitchParameter
72119
Parameter Sets: ComponentNameParameterSet, ResourceIdParameterSet
73-
Aliases: IncludeDailyCap, IncludeDailyCapStatus
120+
Aliases: IncludeDailyCap, IncludeDailyCapStatus, IncludePricingPlan
74121

75122
Required: False
76123
Position: Named
77124
Default value: None
78-
Accept pipeline input: True (ByPropertyName)
125+
Accept pipeline input: False
79126
Accept wildcard characters: False
80127
```
81128
@@ -90,7 +137,7 @@ Aliases: ApplicationInsightsComponentName, ComponentName
90137
Required: True
91138
Position: 1
92139
Default value: None
93-
Accept pipeline input: True (ByPropertyName)
140+
Accept pipeline input: False
94141
Accept wildcard characters: False
95142
```
96143
@@ -105,7 +152,7 @@ Aliases:
105152
Required: False
106153
Position: 0
107154
Default value: None
108-
Accept pipeline input: True (ByPropertyName)
155+
Accept pipeline input: False
109156
Accept wildcard characters: False
110157
```
111158
@@ -117,12 +164,14 @@ Aliases:
117164
Required: True
118165
Position: 0
119166
Default value: None
120-
Accept pipeline input: True (ByPropertyName)
167+
Accept pipeline input: False
121168
Accept wildcard characters: False
122169
```
123170
124171
### -ResourceId
125-
Application Insights Component Resource Id.```yaml
172+
Application Insights Component Resource Id.
173+
174+
```yaml
126175
Type: ResourceIdentifier
127176
Parameter Sets: ResourceIdParameterSet
128177
Aliases:

‎src/ResourceManager/ApplicationInsights/Commands.ApplicationInsights/help/Get-AzureRmApplicationInsightsApiKey.md

Lines changed: 30 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@ Get application insights api keys for an application insights resource
1212

1313
## SYNTAX
1414

15+
### ComponentNameParameterSet (Default)
16+
```
17+
Get-AzureRmApplicationInsightsApiKey [-ResourceGroupName] <String> [-Name] <String> [[-ApiKeyId] <String>]
18+
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
19+
```
20+
1521
### ComponentObjectParameterSet
1622
```
1723
Get-AzureRmApplicationInsightsApiKey [-ApplicationInsightsComponent] <PSApplicationInsightsComponent>
@@ -24,28 +30,33 @@ Get-AzureRmApplicationInsightsApiKey [-ResourceId] <ResourceIdentifier> [[-ApiKe
2430
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
2531
```
2632

27-
### ComponentNameParameterSet
28-
```
29-
Get-AzureRmApplicationInsightsApiKey [-ResourceGroupName] <String> [-Name] <String> [[-ApiKeyId] <String>]
30-
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
31-
```
32-
3333
## DESCRIPTION
3434
Get application insights api keys for an application insights resource
3535

3636
## EXAMPLES
3737

38-
### Example 1
38+
### Example 1 Get Api Keys for an application insights resource
3939
```
4040
PS C:\> Get-AzureRmApplicationInsightsApiKey -ResourceGroupName "testGroup" -Name "test"
41+
42+
Id Description Permissions CreatedDate ApiKey
43+
-- ----------- ----------- ----------- ------
44+
7c4c61dc-b392-4aa4-992f-ee92b84e5dee test1 ReadTelemetry Wed, 18 Oct 2017 23:36:40 GMT
45+
63657030-dea6-4c52-82f4-6f5128cb92cb test2 {ReadTelemetry, WriteAnnotations} Wed, 18 Oct 2017 21:46:41 GMT
46+
82549f39-f3ae-492e-8f94-f7aada75fa57 test3 ReadTelemetry Wed, 18 Oct 2017 22:30:23 GMT
4147
```
4248

4349
Get application insights api keys for resource "test" in resource group "testGroup".
4450

45-
### Example 2
51+
### Example 2 Get specific API key for an application insights resource
4652
```
47-
PS C:\> Get-AzureRmApplicationInsightsApiKey -ResourceGroupName "testGroup" -Name "test" -ApiKeyId dd173f38-4fd1-4c75-8af5-9
48-
9c29aa0f867
53+
PS C:\> Get-AzureRmApplicationInsightsApiKey -ResourceGroupName "testGroup" -Name "test" -ApiKeyId
54+
7c4c61dc-b392-4aa4-992f-ee92b84e5dee
55+
ApiKey :
56+
CreatedDate : Wed, 18 Oct 2017 23:36:40 GMT
57+
Id : 7c4c61dc-b392-4aa4-992f-ee92b84e5dee
58+
Permissions : {ReadTelemetry}
59+
Description : test1
4960
```
5061

5162
Get specific application insights api key that id is "dd173f38-4fd1-4c75-8af5-9
@@ -64,12 +75,14 @@ Aliases:
6475
Required: False
6576
Position: 2
6677
Default value: None
67-
Accept pipeline input: True (ByPropertyName)
78+
Accept pipeline input: False
6879
Accept wildcard characters: False
6980
```
7081
7182
### -ApplicationInsightsComponent
72-
Application Insights Component Object.```yaml
83+
Application Insights Component Object.
84+
85+
```yaml
7386
Type: PSApplicationInsightsComponent
7487
Parameter Sets: ComponentObjectParameterSet
7588
Aliases:
@@ -107,7 +120,7 @@ Aliases: ApplicationInsightsComponentName, ComponentName
107120
Required: True
108121
Position: 1
109122
Default value: None
110-
Accept pipeline input: True (ByPropertyName)
123+
Accept pipeline input: False
111124
Accept wildcard characters: False
112125
```
113126
@@ -122,12 +135,14 @@ Aliases:
122135
Required: True
123136
Position: 0
124137
Default value: None
125-
Accept pipeline input: True (ByPropertyName)
138+
Accept pipeline input: False
126139
Accept wildcard characters: False
127140
```
128141
129142
### -ResourceId
130-
Application Insights Component Resource Id.```yaml
143+
Application Insights Component Resource Id.
144+
145+
```yaml
131146
Type: ResourceIdentifier
132147
Parameter Sets: ResourceIdParameterSet
133148
Aliases:

0 commit comments

Comments
 (0)