az monitor log-profiles

Manage log profiles.

Commands

az monitor log-profiles create Create a log profile.
az monitor log-profiles delete Deletes the log profile.
az monitor log-profiles list List the log profiles.
az monitor log-profiles show Gets the log profile.
az monitor log-profiles update Update a log profile.

az monitor log-profiles create

Create a log profile.

az monitor log-profiles create --categories
--days
--enabled {false, true}
--location
--locations
--name
[--service-bus-rule-id]
[--storage-account-id]
[--subscription]
[--tags]

Examples

Create a log profile. (autogenerated)

az monitor log-profiles create --categories "Delete" --days 0 --enabled true --location westus2 --locations westus --name MyLogProfile --service-bus-rule-id "/subscriptions/{YOUR SUBSCRIPTION ID}/resourceGroups/{RESOURCE GROUP NAME}/providers/Microsoft.EventHub/namespaces/{EVENT HUB NAME SPACE}/authorizationrules/RootManageSharedAccessKey"

Required Parameters

--categories

Space-separated categories of the logs. These categories are created as is convenient to the user. Some values are Write, Delete, and/or Action.

--days

The number of days for the retention in days. A value of 0 will retain the events indefinitely.

--enabled

Whether the retention policy is enabled.

accepted values: false, true
--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--locations

Space-separated list of regions for which Activity Log events should be stored.

--name -n

The name of the log profile.

Optional Parameters

--service-bus-rule-id

The service bus rule ID of the service bus namespace in which you would like to have Event Hubs created for streaming the Activity Log. The rule ID is of the format '{service bus resource ID}/authorizationrules/{key name}'.

--storage-account-id

The resource id of the storage account to which you would like to send the Activity Log.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--tags

Space-separated tags in 'key[=value]' format. Use "" to clear existing tags.

az monitor log-profiles delete

Deletes the log profile.

az monitor log-profiles delete --name
[--subscription]

Required Parameters

--name -n

The name of the log profile.

Optional Parameters

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az monitor log-profiles list

List the log profiles.

az monitor log-profiles list [--subscription]

Optional Parameters

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az monitor log-profiles show

Gets the log profile.

az monitor log-profiles show --name
[--subscription]

Required Parameters

--name -n

The name of the log profile.

Optional Parameters

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az monitor log-profiles update

Update a log profile.

az monitor log-profiles update --name
[--add]
[--force-string]
[--remove]
[--set]
[--subscription]

Examples

Update a log profile. (autogenerated)

az monitor log-profiles update --name MyLogProfile --set retentionPolicy.days=365

Required Parameters

--name -n

The name of the log profile.

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

--remove

Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.