Skip to content

Commit 5fe4c09

Browse files
Added example and fixed verbatim
1) Added proper Synopsis with detailed verbatim about the storage account. 2) The current cmd help has an empty example so added a working example. 3) Updated the -Location parameter verbatim 4) Updated the -RetentionInDays verbatim 5) Updated the -StorageAccountId with an example and updated verbatim.
1 parent 3c56e78 commit 5fe4c09

File tree

1 file changed

+15
-8
lines changed

1 file changed

+15
-8
lines changed

src/ResourceManager/Insights/Commands.Insights/help/Add-AzureRmLogProfile.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# Add-AzureRmLogProfile
99

1010
## SYNOPSIS
11-
Creates a log profile.
11+
Creates a log profile. This profile will be used to either archive the activity log to a storage account or stream them to an Azure event hub. Only a single standard storage account (premium storage account is not supported) persubscription is support. It could of type ARM or Classic. If it's logged to storage account the cost of storing this activity log is billed at normal storage rates.
1212

1313
## SYNTAX
1414

@@ -22,10 +22,9 @@ Add-AzureRmLogProfile -Name <String> [-StorageAccountId <String>] [-ServiceBusRu
2222
The **Add-AzureRmLogProfile** cmdlet creates a log profile.
2323

2424
## EXAMPLES
25-
26-
### 1:
27-
```
28-
25+
### Example 1 : Add a new log profile to export activity logs to a storage account
26+
```yaml
27+
Add-AzureRmLogProfile -Locations "West US" -Name ExportLogProfile -StorageAccountId /subscriptions/40gpe80s-9sb7-4f07-9042-b1b6a92ja9fk/resourceGroups/activitylogRG/providers/Microsoft.Storage/storageAccounts/activitylogstorageaccount
2928
```
3029

3130
## PARAMETERS
@@ -46,7 +45,11 @@ Accept wildcard characters: False
4645
```
4746
4847
### -Locations
49-
Specifies the list of locations.
48+
Specifies the location of the log profile.
49+
Valid values: Run below cmdlet to get the latest list of locations.
50+
```yaml
51+
Get-AzureLocation | Select DisplayName
52+
```
5053

5154
```yaml
5255
Type: System.Collections.Generic.List`1[System.String]
@@ -76,7 +79,7 @@ Accept wildcard characters: False
7679
```
7780
7881
### -RetentionInDays
79-
Specifies the retention policy, in days.
82+
Specifies the retention policy, in days. This is the number of days the logs are preserved in the storage account specified. To retain the data forever set this 0. If it's not specified, then it defaults to 0 which is retain for ever.
8083
8184
```yaml
8285
Type: Int32
@@ -106,7 +109,11 @@ Accept wildcard characters: False
106109
```
107110
108111
### -StorageAccountId
109-
Specifies the ID of the Storage account.
112+
Specifies the ID of the Storage account. ID is the fully qualified Resource ID of the storage account for example
113+
```yaml
114+
/subscriptions/40gpe80s-9sb7-4f07-9042-b1b6a92ja9fk/resourceGroups/activitylogRG/providers/Microsoft.Storage/storageAccounts/activitylogstorageaccount
115+
```
116+
110117

111118
```yaml
112119
Type: String

0 commit comments

Comments
 (0)