Skip to content

Commit 62a7111

Browse files
Update Add-AzureRmLogProfile.md
Added and modified comments as per feedback.
1 parent 185c623 commit 62a7111

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

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

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

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

13-
In the activity log, events can pertain to a region or could be "Global". Global essentially means these events are region agnostics and are independent of region, in fact majority of events fall into this category. If the activity log profile is set from the portal, it implicitly adds "Global" along with any other region selected in the user interface. When using the cmdlet, the location as "Global" must be explicitly mentioned apart from any other region.
13+
- **Storage Account** - Only standard storage account (premium storage account is not supported) is supported. It could either be of type ARM or Classic. If it's logged to a storage account, the cost of storing the activity log is billed at normal standard storage rates. There could be only one log profile per subscription consequentially only one storage account per subscription can be used to export activity log.
14+
15+
- **Event Hub** - There could be only one log profile per subscription consequentially only one event hub per subscription can be used to export activity log. If activity log is streamed to an event hub, standard event hub pricing will apply.
16+
17+
In the activity log, events can pertain to a region or could be "Global". Global essentially means these events are region agnostics and are independent of region, in fact majority of events fall into this category. If the activity log profile is set from the portal, it implicitly adds "Global" along with any other region selected in the user interface. When using the cmdlet, the location as "Global" must be explicitly mentioned apart from any other region.
18+
19+
**Note** :- **Failing to set "Global" in the locations will result in a majority of activity log not getting exported.**
1420

1521
## SYNTAX
1622

@@ -81,7 +87,7 @@ Accept wildcard characters: False
8187
```
8288
8389
### -RetentionInDays
84-
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 means retain forever.
90+
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 to **0**. If it's not specified, then it defaults to **0**. Normal standard storage or event hub billing rates will apply for data retention.
8591
8692
```yaml
8793
Type: Int32

0 commit comments

Comments
 (0)