Azure Monitor cli commands for Managemnt & Data plane #1953

vishrutshah · 2017-02-01T01:48:11Z

This enables support for #1954

Here is the complete set of available commands exposed from azure-mgmt-monitor and azure-monitor python sdk.

Here is the state of each Management command:

	Command	Tested [Manual]	Status	Issue	Category
log-profiles
	create			Issue 973	Swagger
	delete	✅	✅
	show	✅	✅
	list	✅	✅
	update			Issue 973	Swagger
---	---	---	---	---
alert-rule-incidents
	show	✅	✅
	list	✅	✅
---	---	---	---	---
alert-rules
	create			Issue 971 Issue 11	AutoRest Python-Runtime
	delete	✅	✅
	show			Issue 971	AutoRest
	list			Issue 970	AutoRest
	update			Issue 971 Issue 11	AutoRest Python-Runtime
---	---	---	---	---
service-diagnostic-settings
	create			Issue 972	Swagger
	show	✅	✅
	update			Issue 972	Swagger
---	---	---	---	---
autoscale-settings				Known Issue in Service	Monitor Service
	create	No
	delete	No
	show	No
	list	No
	update	No

Here is the state of each Data Plane command:

	Command	Tested [Manual]	Status	Issue	Category
usage-metrics
	list	✅	✅
event-categories
	list	✅	✅
events
	list			Issue 969	Swagger
tenant-events
	list			Issue 899	Permission
metric-definitions
	list	✅	✅
metrics
	list	✅	✅

Note: azure-mgmt-monitor is not released as python package yet, once released we'll take our dependency on locally checked-in sdk before merge.

@troydai @derekbekoe & @tjprescott when you get a chance, please have a first quick look. Thanks

vishrutshah · 2017-02-01T05:46:13Z

src/command_modules/azure-cli-monitor/azure/cli/command_modules/monitor/_util.py

I think this would be a good time to move this utility class into azure.cli.core

I disagree. If done, it should be a separate PR to not make this review more difficult.

Makes sense. Then I'd prefer it to refactor once this PR gets in.

tjprescott · 2017-02-01T15:55:56Z

You need to fix the linter issuer (add "# pylint: skip-file" to any auto-genned SDK) and also add a comment to the PR with the -h output for the most important commands.

tjprescott

Need to see help output for the new commands before approving. Otherwise just some minor things.

tjprescott · 2017-02-01T16:43:15Z

src/command_modules/azure-cli-monitor/azure/cli/command_modules/monitor/_util.py

These should go in a _client_factory.py file to be consistent with other packages.

Still think the client factories should be in _client_factory.py file.

tjprescott · 2017-02-01T16:46:02Z

src/command_modules/azure-cli-monitor/azure/cli/command_modules/monitor/_util.py

I disagree. If done, it should be a separate PR to not make this review more difficult.

tjprescott · 2017-02-01T16:49:05Z

src/command_modules/azure-cli-monitor/azure/cli/command_modules/monitor/help.py

No other command mentions a "REST API" in the CLI that I know of.

Ya that's true..that came from swagger comment...I'll remove it 👍

Updated: Update a log profile assigned to Azure subscription

tjprescott · 2017-02-01T16:49:34Z

src/command_modules/azure-cli-monitor/azure/cli/command_modules/monitor/help.py

typo: metrics.

tjprescott · 2017-02-01T16:51:01Z

src/command_modules/azure-cli-monitor/azure/cli/command_modules/monitor/help.py

It might make sense to clarify "manage Monitor alert rules" etc. for these commands since the terms are pretty generic and could be confused for other things.

Updated: Commands to manage alerts assigned to Azure resources

tjprescott · 2017-02-01T16:52:30Z

src/command_modules/azure-cli-monitor/azure/cli/command_modules/monitor/params.py

The --name parameters here need a values completer within their scope (except for create commands).

tjprescott · 2017-02-01T16:55:07Z

src/command_modules/azure-cli-monitor/azure/cli/command_modules/monitor/params.py

--azure-resource-name is pretty verbose. Also, will this accept a name or id? Should it? If so, I would recommend --resource with help text that says "Name or ID of the resource to query." or something to that effect.

I haven't done tests on autoscale, so i am not sure on whether it can accept ids. So I'll keep this pending until then :)

tjprescott · 2017-02-01T16:58:18Z

src/command_modules/azure-cli-monitor/azure/cli/command_modules/monitor/params.py

I recommend you spell out the kwargs like we do in the traditional model. (i.e. type=json.loads, help='blahblah')

src/command_modules/azure-cli-monitor/azure/cli/command_modules/monitor/validators.py

derekbekoe · 2017-02-01T18:10:39Z

src/command_modules/azure-cli-monitor/azure/cli/command_modules/monitor/__init__.py

What's this line used for?
It shouldn't be needed.

It's just a formality though it is not technically needed.

derekbekoe · 2017-02-01T18:18:55Z

src/command_modules/azure-cli-monitor/azure/cli/command_modules/monitor/commands.py

This is another way of just doing modpath.format(a, b, c) like in the VM module (https://github.com/Azure/azure-cli/blob/master/src/command_modules/azure-cli-vm/azure/cli/command_modules/vm/commands.py#L19).

I don't really see this implementation as simpler than what's in the VM module as I now have to follow create_service_adapter to see what that does.

I see but as I am following the flow/structure from azure-cli-sql (as I have understood that flow as of now :)), I'd prefer to keep it same. What's your thought on that?

src/command_modules/azure-cli-monitor/azure/cli/command_modules/monitor/validators.py

derekbekoe · 2017-02-01T18:22:29Z

src/command_modules/azure-cli-monitor/setup.py

Please remove if it's not used.

@derekbekoe I was thinking that we'll not merge the PR in as it has sdk checked-in. So I was planning to wait until azure-mgmt-monitor releases and then removing sdks and the merging PR.

Let me know if there is way where we still allow merging PRs if sdks are checked-in? If so i'll definitely remove it.

No. We should NOT. No matter If azure-mgmt-monitor is released we should not include their source code in our code base.

Okay didn't know you weren't planning on merging this right now.
I've created and added a Do Not Merge label to this PR then.

We have allowed services (KeyVault, IoT, etc.) to merge PRs with embedded clients. DocumentDB was about to earlier this week but the SDK was released so he went ahead and did the import changes.

If something holds up this PR from being merged, it really doesn't need to be the desire to avoid (temporarily) having the SDK code in the module.

vishrutshah · 2017-02-01T19:59:18Z

(env) vishrut@mac azure-cli-monitor (monitor-cli) $ az monitor -h

Group
    az monitor: Commands to manage Azure Monitor service.

Subgroups:
    alert-rule-incidents       : Commands to manage alert rule incidents.
    alert-rules                : Commands to manage alert rules.
    autoscale-settings         : Commands to manage autoscale settings.
    event-categories           : Commands to manage event categories.
    events                     : Commands to manage events.
    log-profiles               : Commands to manage log profiles.
    metric-definitions         : Commands to manage metric definitions.
    metrics                    : Commands to manage metrics.
    service-diagnostic-settings: Commands to manage service diagnostic settings.
    tenant-events              : Commands to manage tenant events.
    usage-metrics              : Commands to manage usage matrics.

vishrutshah · 2017-02-01T19:59:51Z

(env) vishrut@mac azure-cli-monitor (monitor-cli) $ az monitor alert-rule-incidents -h

Group
    az monitor alert-rule-incidents: Commands to manage alert rule incidents.

Commands:
    list: Gets a list of incidents associated to an alert rule.
    show: Gets an incident associated to an alert rule.

vishrutshah · 2017-02-01T20:00:20Z

(env) vishrut@mac azure-cli-monitor (monitor-cli) $ az monitor alert-rules -h

Group
    az monitor alert-rules: Commands to manage alert rules.

Commands:
    create: Creates or updates an alert rule.
    delete: Deletes an alert rule.
    list  : List the alert rules within a resource group.
    show  : Gets an alert rule.
    update: Updates an alert rule.

env) vishrut@mac azure-cli-monitor (monitor-cli) $ az monitor alert-rules create -h

Command
    az monitor alert-rules create: Creates or updates an alert rule.
        Request method: PUT             Request URI:
        https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/{resource-group-
        name}/providers/microsoft.insights/alertRules/{alert-rule-name}?api-version={api-version}.

Arguments
    --alert-rule-resource-name [Required]: The name of the alert rule.
    --is-enabled               [Required]: The flag that indicates whether the alert rule is
                                           enabled.
    --location -l              [Required]: Location.
    --name -n                  [Required]: The name of the rule.
    --resource-group -g        [Required]: Name of resource group.
    --actions                            : The array of actions that are performed when the alert
                                           rule becomes active, and when an alert condition is
                                           resolved.
    --azure-resource-name                : Azure resource name.
    --condition                          : JSON encoded condition configuration. Use @{file} to load
                                           from a file.
    --description                        : The description of the alert rule that will be included
                                           in the alert email.
    --tags                               : Resource tags.

Global Arguments
    --debug                              : Increase logging verbosity to show all debug logs.
    --help -h                            : Show this help message and exit.
    --output -o                          : Output format.  Allowed values: json, jsonc, list, table,
                                           tsv.  Default: json.
    --query                              : JMESPath query string. See http://jmespath.org/ for more
                                           information and examples.
    --verbose                            : Increase logging verbosity. Use --debug for full debug
                                           logs.

vishrutshah · 2017-02-01T20:00:53Z

(env) vishrut@mac azure-cli-monitor (monitor-cli) $ az monitor autoscale-settings -h

Group
    az monitor autoscale-settings: Commands to manage autoscale settings.

Commands:
    create: Creates or updates an autoscale setting.
    delete: Deletes and autoscale setting.
    list  : Lists the autoscale settings for a resource group.
    show  : Gets an autoscale setting.
    update: Updates an autoscale setting.

(env) vishrut@mac azure-cli-monitor (monitor-cli) $ az monitor autoscale-settings create -h

Command
    az monitor autoscale-settings create: Creates or updates an autoscale setting.

Arguments
    --autoscale-setting-resource-name [Required]: The name of the autoscale setting.
    --location -l                     [Required]: Location.
    --name -n                         [Required]: The autoscale setting name.
    --profiles                        [Required]: The collection of automatic scaling profiles that
                                                  specify different scaling parameters for different
                                                  time periods. A maximum of 20 profiles can be
                                                  specified.
    --resource-group -g               [Required]: Name of resource group.
    --azure-resource-name                       : Azure resource name.
    --enabled                                   : The enabled flag. Specifies whether automatic
                                                  scaling is enabled for the resource. The default
                                                  value is 'true'. Default value: True .  Default:
                                                  True.
    --notifications                             : The collection of notifications.
    --tags                                      : Resource tags.
    --target-resource-uri                       : The resource identifier of the resource that the
                                                  autoscale setting should be added to.

Global Arguments
    --debug                                     : Increase logging verbosity to show all debug logs.
    --help -h                                   : Show this help message and exit.
    --output -o                                 : Output format.  Allowed values: json, jsonc, list,
                                                  table, tsv.  Default: json.
    --query                                     : JMESPath query string. See http://jmespath.org/
                                                  for more information and examples.
    --verbose                                   : Increase logging verbosity. Use --debug for full
                                                  debug logs.

(env) vishrut@mac azure-cli-monitor (monitor-cli) $ az monitor autoscale-settings list -h

Command
    az monitor autoscale-settings list: Lists the autoscale settings for a resource group.

Arguments
    --resource-group -g [Required]: Name of resource group.
    --filter                      : The filter to apply on the operation. For more information
                                    please see https://msdn.microsoft.com/en-
                                    us/library/azure/dn931934.aspx.

Global Arguments
    --debug                       : Increase logging verbosity to show all debug logs.
    --help -h                     : Show this help message and exit.
    --output -o                   : Output format.  Allowed values: json, jsonc, list, table, tsv.
                                    Default: json.
    --query                       : JMESPath query string. See http://jmespath.org/ for more
                                    information and examples.
    --verbose                     : Increase logging verbosity. Use --debug for full debug logs.

vishrutshah · 2017-02-01T20:01:41Z

(env) vishrut@mac azure-cli-monitor (monitor-cli) $ az monitor event-categories -h

Group
    az monitor event-categories: Commands to manage event categories.

Commands:
    list: Get the list of available event categories supported in the Activity Log Service.

(env) vishrut@mac azure-cli-monitor (monitor-cli) $ az monitor event-categories list -h

Command
    az monitor event-categories list: Get the list of available event categories supported in the
    Activity Log Service.
        The current list includes the following: Aministrative, Security, ServiceHealth, Alert,
        Recommendation, Policy.

Arguments

Global Arguments
    --debug    : Increase logging verbosity to show all debug logs.
    --help -h  : Show this help message and exit.
    --output -o: Output format.  Allowed values: json, jsonc, list, table, tsv.  Default: json.
    --query    : JMESPath query string. See http://jmespath.org/ for more information and examples.
    --verbose  : Increase logging verbosity. Use --debug for full debug logs.

vishrutshah · 2017-02-01T20:02:06Z

(env) vishrut@mac azure-cli-monitor (monitor-cli) $ az monitor events -h

Group
    az monitor events: Commands to manage events.

Commands:
    list: Provides the list of events.

(env) vishrut@mac azure-cli-monitor (monitor-cli) $ az monitor events list -h

Command
    az monitor events list: Provides the list of events.
        The **$filter** is very restricted and allows only the following patterns. - List events for
        a resource group: $filter=eventTimestamp ge '<Start Time>' and eventTimestamp le '<End
        Time>' and eventChannels eq 'Admin, Operation' and resourceGroupName eq
        '<ResourceGroupName>'. - List events for resource: $filter=eventTimestamp ge '<Start Time>'
        and eventTimestamp le '<End Time>' and eventChannels eq 'Admin, Operation' and resourceUri
        eq '<ResourceURI>'. - List events for a subscription: $filter=eventTimestamp ge '<Start
        Time>' and eventTimestamp le '<End Time>' and eventChannels eq 'Admin, Operation'. -List
        events for a resource provider: $filter=eventTimestamp ge '<Start Time>' and eventTimestamp
        le '<End Time>' and eventChannels eq 'Admin, Operation' and resourceProvider eq
        '<ResourceProviderName>'. - List events for a correlation Id: api-
        version=2014-04-01&$filter=eventTimestamp ge '2014-07-16T04:36:37.6407898Z' and
        eventTimestamp le '2014-07-20T04:36:37.6407898Z' and eventChannels eq 'Admin, Operation' and
        correlationId eq '<CorrelationID>'. No other syntax is allowed.

Arguments
    --filter   : Reduces the set of data collected. The syntax allowed depends on the operation. See
                 the operation's description for details.
    --select   : Used to fetch events with only the given properties. The filter is a comma
                 separated list of property names to be returned. Possible values are:
                 authorization, channels, claims, correlationId, description, eventDataId,
                 eventName, eventTimestamp, httpRequest, level, operationId, operationName,
                 properties, resourceGroupName, resourceProviderName, resourceId, status,
                 submissionTimestamp, subStatus, subscriptionId.

Global Arguments
    --debug    : Increase logging verbosity to show all debug logs.
    --help -h  : Show this help message and exit.
    --output -o: Output format.  Allowed values: json, jsonc, list, table, tsv.  Default: json.
    --query    : JMESPath query string. See http://jmespath.org/ for more information and examples.
    --verbose  : Increase logging verbosity. Use --debug for full debug logs.

vishrutshah · 2017-02-01T20:02:42Z

(env) vishrut@mac azure-cli-monitor (monitor-cli) $ az monitor log-profiles -h

Group
    az monitor log-profiles: Commands to manage log profiles.

Commands:
    create: Create or update a log profile in Azure Monitoring REST API.
    delete: Deletes the log profile.
    list  : List the log profiles.
    show  : Gets the log profile.
    update: Update a log profile in Azure Monitoring REST API.

(env) vishrut@mac azure-cli-monitor (monitor-cli) $ az monitor log-profiles create -h

Command
    az monitor log-profiles create: Create or update a log profile in Azure Monitoring REST API.

Arguments
    --locations          [Required]: List of regions for which Activity Log events should be stored
                                     or streamed. It is a comma separated list of valid ARM
                                     locations including the 'global' location.
    --name -n            [Required]: The name of the log profile.
    --storage-account-id [Required]: The resource id of the storage account to which you would like
                                     to send the Activity Log.
    --categories                   : The categories of the logs. These categories are created as is
                                     convenient to the user. Some values are: 'Write', 'Delete',
                                     and/or 'Action.'.
    --retention-policy             : The retention policy for the events in the log.
    --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}'.

Global Arguments
    --debug                        : Increase logging verbosity to show all debug logs.
    --help -h                      : Show this help message and exit.
    --output -o                    : Output format.  Allowed values: json, jsonc, list, table, tsv.
                                     Default: json.
    --query                        : JMESPath query string. See http://jmespath.org/ for more
                                     information and examples.
    --verbose                      : Increase logging verbosity. Use --debug for full debug logs.

(env) vishrut@mac azure-cli-monitor (monitor-cli) $ az monitor log-profiles show -h

Command
    az monitor log-profiles show: Gets the log profile.

Arguments
    --name -n [Required]: The name of the log profile.

Global Arguments
    --debug             : Increase logging verbosity to show all debug logs.
    --help -h           : Show this help message and exit.
    --output -o         : Output format.  Allowed values: json, jsonc, list, table, tsv.  Default:
                          json.
    --query             : JMESPath query string. See http://jmespath.org/ for more information and
                          examples.
    --verbose           : Increase logging verbosity. Use --debug for full debug logs.

vishrutshah · 2017-02-01T20:03:29Z

(env) vishrut@mac azure-cli-monitor (monitor-cli) $ az monitor metric-definitions -h

Group
    az monitor metric-definitions: Commands to manage metric definitions.

Commands:
    list: Lists the metric definitions for the resource.

(env) vishrut@mac azure-cli-monitor (monitor-cli) $ az monitor metric-definitions list -h

Command
    az monitor metric-definitions list: Lists the metric definitions for the resource.
        The **$filter** parameter is optional, and can be used to only retrieve certain metric
        definitions. For example, get just the definition for the CPU percentage counter:
        $filter=name.value eq '\Processor(_Total)\% Processor Time'. This $filter is very restricted
        and allows only these 'name eq <value>' clauses separated by or operators. No other syntax
        is allowed.

Arguments
    --resource-uri [Required]: The identifier of the resource.
    --filter                 : Reduces the set of data collected. The syntax allowed depends on the
                               operation. See the operation's description for details.

Global Arguments
    --debug                  : Increase logging verbosity to show all debug logs.
    --help -h                : Show this help message and exit.
    --output -o              : Output format.  Allowed values: json, jsonc, list, table, tsv.
                               Default: json.
    --query                  : JMESPath query string. See http://jmespath.org/ for more information
                               and examples.
    --verbose                : Increase logging verbosity. Use --debug for full debug logs.

vishrutshah · 2017-02-01T20:03:53Z

(env) vishrut@mac azure-cli-monitor (monitor-cli) $ az monitor metrics -h

Group
    az monitor metrics: Commands to manage metrics.

Commands:
    list: Lists the metric values for a resource.

(env) vishrut@mac azure-cli-monitor (monitor-cli) $ az monitor metrics list -h

Command
    az monitor metrics list: Lists the metric values for a resource.
        The $filter is used to reduce the set of metric data returned. Some common properties for
        this expression will be: name.value, aggregationType, startTime, endTime, timeGrain. The
        filter expression uses these properties with comparison operators (eg. eq, gt, lt) and
        multiple expressions can be combined with parentheses and 'and/or' operators. Some example
        filter expressions are: - $filter=(name.value eq 'RunsSucceeded') and aggregationType eq
        'Total' and startTime eq 2016-02-20 and endTime eq 2016-02-21 and timeGrain eq
        duration'PT1M', - $filter=(name.value eq 'RunsSucceeded') and (aggregationType eq 'Total' or
        aggregationType eq 'Average') and startTime eq 2016-02-20 and endTime eq 2016-02-21 and
        timeGrain eq duration'PT1H', - $filter=(name.value eq 'ActionsCompleted' or name.value eq
        'RunsSucceeded') and (aggregationType eq 'Total' or aggregationType eq 'Average') and
        startTime eq 2016-02-20 and endTime eq 2016-02-21 and timeGrain eq duration'PT1M'.

Arguments
    --resource-uri [Required]: The identifier of the resource.
    --filter                 : Reduces the set of data collected. The syntax allowed depends on the
                               operation. See the operation's description for details.

Global Arguments
    --debug                  : Increase logging verbosity to show all debug logs.
    --help -h                : Show this help message and exit.
    --output -o              : Output format.  Allowed values: json, jsonc, list, table, tsv.
                               Default: json.
    --query                  : JMESPath query string. See http://jmespath.org/ for more information
                               and examples.
    --verbose                : Increase logging verbosity. Use --debug for full debug logs.

vishrutshah · 2017-02-01T20:04:49Z

(env) vishrut@mac azure-cli-monitor (monitor-cli) $ az monitor service-diagnostic-settings -h

Group
    az monitor service-diagnostic-settings: Commands to manage service diagnostic settings.

Commands:
    create: Create or update new diagnostic settings for the specified resource.
    show  : Gets the active diagnostic settings for the specified resource.
    update: Update diagnostic settings for the specified resource.

(env) vishrut@mac azure-cli-monitor (monitor-cli) $ az monitor service-diagnostic-settings create -h

Command
    az monitor service-diagnostic-settings create: Create or update new diagnostic settings for the
    specified resource.

Arguments
    --resource-uri [Required]: The identifier of the resource.
    --logs                   : The list of logs settings.
    --metrics                : The list of metric settings.
    --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 Diagnostic Logs.
                               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 Diagnostic Logs.
    --workspace-id           : The workspace ID (resource ID of a Log Analytics workspace) for a Log
                               Analytics workspace to which you would like to send Diagnostic Logs.
                               Example: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resource
                               Groups/insights-integration/providers/Microsoft.OperationalInsights/w
                               orkspaces/viruela2.

Global Arguments
    --debug                  : Increase logging verbosity to show all debug logs.
    --help -h                : Show this help message and exit.
    --output -o              : Output format.  Allowed values: json, jsonc, list, table, tsv.
                               Default: json.
    --query                  : JMESPath query string. See http://jmespath.org/ for more information
                               and examples.
    --verbose                : Increase logging verbosity. Use --debug for full debug logs.

vishrutshah · 2017-02-01T20:05:24Z

(env) vishrut@mac azure-cli-monitor (monitor-cli) $ az monitor tenant-events -h

Group
    az monitor tenant-events: Commands to manage tenant events.

Commands:
    list: Get the Activity Logs for the Tenant.

(env) vishrut@mac azure-cli-monitor (monitor-cli) $ az monitor tenant-events list -h

Command
    az monitor tenant-events list: Get the Activity Logs for the Tenant.
        Everything that is applicable to the API to get the Activity Log for the subscription is
        applicable to this API (the parameters, $filter, etc.). One thing to point out here is that
        this API does *not* retrieve the logs at the individual subscription of the tenant but only
        surfaces the logs that were generated at the tenant level. The **$filter** is very
        restricted and allows only the following patterns. - List events for a resource group:
        $filter=eventTimestamp ge '<Start Time>' and eventTimestamp le '<End Time>' and
        eventChannels eq 'Admin, Operation' and resourceGroupName eq '<ResourceGroupName>'. - List
        events for resource: $filter=eventTimestamp ge '<Start Time>' and eventTimestamp le '<End
        Time>' and eventChannels eq 'Admin, Operation' and resourceUri eq '<ResourceURI>'. - List
        events for a subscription: $filter=eventTimestamp ge '<Start Time>' and eventTimestamp le
        '<End Time>' and eventChannels eq 'Admin, Operation'. - List evetns for a resource provider:
        $filter=eventTimestamp ge '<Start Time>' and eventTimestamp le '<End Time>' and
        eventChannels eq 'Admin, Operation' and resourceProvider eq '<ResourceProviderName>'. - List
        events for a correlation Id: api-version=2014-04-01&$filter=eventTimestamp ge
        '2014-07-16T04:36:37.6407898Z' and eventTimestamp le '2014-07-20T04:36:37.6407898Z' and
        eventChannels eq 'Admin, Operation' and correlationId eq '<CorrelationID>'. No other syntax
        is allowed.

Arguments
    --filter   : Reduces the set of data collected. The syntax allowed depends on the operation. See
                 the operation's description for details.
    --select   : Used to fetch events with only the given properties. The filter is a comma
                 separated list of property names to be returned. Possible values are:
                 authorization, channels, claims, correlationId, description, eventDataId,
                 eventName, eventTimestamp, httpRequest, level, operationId, operationName,
                 properties, resourceGroupName, resourceProviderName, resourceId, status,
                 submissionTimestamp, subStatus, subscriptionId.

Global Arguments
    --debug    : Increase logging verbosity to show all debug logs.
    --help -h  : Show this help message and exit.
    --output -o: Output format.  Allowed values: json, jsonc, list, table, tsv.  Default: json.
    --query    : JMESPath query string. See http://jmespath.org/ for more information and examples.
    --verbose  : Increase logging verbosity. Use --debug for full debug logs.

vishrutshah · 2017-02-01T20:05:52Z

(env) vishrut@mac azure-cli-monitor (monitor-cli) $ az monitor usage-metrics -h

Group
    az monitor usage-metrics: Commands to manage usage matrics.

Commands:
    list: The List operation lists the usage metrics for the resource.

(env) vishrut@mac azure-cli-monitor (monitor-cli) $ az monitor usage-metrics list -h

Command
    az monitor usage-metrics list: The List operation lists the usage metrics for the resource.

Arguments
    --resource-uri [Required]: The identifier of the resource.
    --filter                 : The filter to apply on the operation.

Global Arguments
    --debug                  : Increase logging verbosity to show all debug logs.
    --help -h                : Show this help message and exit.
    --output -o              : Output format.  Allowed values: json, jsonc, list, table, tsv.
                               Default: json.
    --query                  : JMESPath query string. See http://jmespath.org/ for more information
                               and examples.
    --verbose                : Increase logging verbosity. Use --debug for full debug logs.

vishrutshah · 2017-02-01T20:16:05Z

@tjprescott & @derekbekoe I have just put some more comments on showing the documentation around commands for the reference. I haven't gone through all your comments but as I go I'll keep fixing them. This is just in case you want to see the commands itself 💯

I'll ping you guys once i fix all the review comments :)

tjprescott · 2017-02-01T20:30:28Z

The help text for several of the list commands illustrates a major problem.

First, the text from the SDK is crazily verbose, and we should replace it, but second, we should look at the equivalent Xplat CLI commands to see what convenience arguments they use to build up a filter. We should not simply expose the --filter parameter and tell people to go learn OData. Even if we do expose --filter, we should allow the building of a filter with argument. See the az resource list command for examples of this.

troydai · 2017-02-01T20:52:10Z

src/command_modules/azure-cli-monitor/azure/cli/command_modules/monitor/__init__.py

It's just a formality though it is not technically needed.

troydai · 2017-02-01T20:54:38Z

src/command_modules/azure-cli-monitor/azure/cli/command_modules/monitor/_util.py

This is duplicate with the sql command module. Consider move it up to the azure-cli-core for reuse.

Yes, we should. I'd prefer it to do that refactoring once this PR completes so I don't confuse you guys more on actual PR. Does that seem good?

troydai · 2017-02-01T20:55:26Z

src/command_modules/azure-cli-monitor/azure/cli/command_modules/monitor/_util.py

Prefer absolute path

Updated to azure.cli.command_modules.monitor.validators

troydai · 2017-02-01T21:00:24Z

src/command_modules/azure-cli-monitor/azure/cli/command_modules/monitor/sdk/__init__.py

are these coming from SDK? shall we commit this?

Nope. I will not merge in until azure-mgmt-monitor is released. PR Azure/azure-sdk-for-python#974

troydai · 2017-02-01T21:01:51Z

src/command_modules/azure-cli-monitor/setup.py

No. We should NOT. No matter If azure-mgmt-monitor is released we should not include their source code in our code base.

Adding help docs for az monitor data plane commands Adding commands for management place of Azure monitor service Addressing code review comments

vishrutshah · 2017-02-17T16:12:59Z

@troydai @tjprescott @derekbekoe

I've removed SDK code from the cli and took dependencies on azure-mgmt-monitor version 0.1.0 & azure-monitor version 0.2.0 sdks.

I've also addressed general code review comments except:

As I am following design of azure-cli-sql, we have some design that do not match with the other modules. Example: I do not have _client_factory.py, I follow ParametersContext to register commands, expand arguments and aliasing etc
I did duplicate common code between azure-cli-sql & azure-monitor-cli that will be moved and shared as separate PR
I did not provide very convenience methods around --filter parameters yet. I'd like to provide those convenience as separate PR
I've tested commands manually and currently writing automation tests around it. I can add them here or I can do that separate to make it easier for me and reviewer :)

Let me know what you guys think about new changes and how do we want to proceed.

Thanks!

…tions Implement filter for metrics-definitions list command

vishrutshah · 2017-02-23T16:51:27Z

Implement filter for metrics list command PR: vishrutshah#2. Please take a look when you get a chance. Thanks!

troydai

I'm good.

tjprescott · 2017-02-27T18:41:03Z

@vishrutshah which commands remain that have filter building arguments in Xplat but not in this PR?

Implement filter metrics list command

vishrutshah · 2017-02-28T01:49:13Z

Implement filter for activity-logs list & tenant-activity-logs list command PR: vishrutshah#3. Please take a look when you get a chance. Thanks!

@tjprescott With this PR merged in, we have following 2 commands from management plane left to be simplified for filter:

az monitor alert-rules list

az monitor autoscale-settings list

Implement filter & select in activity-logs and tenant-activity-logs

* Adding scaffold command in autoscale-settings * Addressing review feedback

codecov-io · 2017-03-03T23:24:37Z

Codecov Report

❗ No coverage uploaded for pull request base (master@7140ca4). Click here to learn what that means.
The diff coverage is 83.2%.

@@           Coverage Diff            @@
##             master   #1953   +/-   ##
========================================
  Coverage          ?   72.3%           
========================================
  Files             ?     373           
  Lines             ?   20139           
  Branches          ?    2942           
========================================
  Hits              ?   14561           
  Misses            ?    4652           
  Partials          ?     926

Impacted Files	Coverage Δ
...-monitor/azure/cli/command_modules/monitor/help.py	`100% <100%> (ø)`
...nd_modules/azure-cli-monitor/azure/cli/__init__.py	`100% <100%> (ø)`
...itor/azure/cli/command_modules/monitor/__init__.py	`100% <100%> (ø)`
...ommand_modules/azure-cli-monitor/azure/__init__.py	`100% <100%> (ø)`
...onitor/azure/cli/command_modules/monitor/params.py	`100% <100%> (ø)`
...itor/azure/cli/command_modules/monitor/commands.py	`100% <100%> (ø)`
...-cli-monitor/azure/cli/command_modules/__init__.py	`100% <100%> (ø)`
...ure/cli/command_modules/monitor/_client_factory.py	`42.85% <42.85%> (ø)`
...or/azure/cli/command_modules/monitor/validators.py	`50% <50%> (ø)`
...onitor/azure/cli/command_modules/monitor/custom.py	`68.86% <68.86%> (ø)`
... and 1 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7140ca4...2d48c8e. Read the comment docs.

* Adding unittests for custom monitor commands * Better assertions

troydai

mostly questions

troydai · 2017-03-08T22:07:39Z

src/command_modules/azure-cli-monitor/azure/cli/command_modules/monitor/custom.py

+                         timezone: 1970-01-01T00:00:00Z, 1970-01-01T00:00:00-0500
+    :param str caller: The caller to look for when querying
+    :param str status: The status value to query (ex: Failed)
+    :param str max_events: The maximum number of records to be returned by the command


why is it str not int?

troydai · 2017-03-08T22:08:28Z

src/command_modules/azure-cli-monitor/azure/cli/command_modules/monitor/custom.py

+                                                      caller, status)
+
+    if max_events:
+        max_events = int(max_events)


can't argparser or validator guarantee it's integer?

troydai · 2017-03-08T22:11:06Z

src/command_modules/azure-cli-monitor/azure/cli/command_modules/monitor/custom.py

+    '''
+    formatter = "eventTimestamp ge {} and eventTimestamp le {}"
+    odata_filters = _validate_time_range_and_add_defaults(start_time, end_time,
+                                                          formatter=formatter)


should time validating be done in validator?

troydai · 2017-03-08T22:11:35Z

src/command_modules/azure-cli-monitor/azure/cli/command_modules/monitor/custom.py

+
+
+def _activity_logs_select_filter_builder(events=None):
+    '''Build up select filter string from events


use triple double quote for docstring.

* Fix expand parameters bug in util to support any parameters * Adding --filters into activity-logs & tenant-activity-logs * Adding --ids support into alert-rules & autoscale-settings' show and delete commands * ignoring filter for alert-rules and autoscale-settings list

tjprescott · 2017-03-13T22:16:32Z

As we discussed Friday, we should close this PR until it is ready to be merged and then either reopen it or open a new one.

vishrutshah · 2017-03-16T21:35:48Z

Closing this PR and sending, new one for the review for partner team.

vishrutshah · 2017-03-18T22:51:43Z

New PR @ #2534

azurecla added the cla-not-required label Feb 1, 2017

vishrutshah commented Feb 1, 2017

View reviewed changes

tjprescott added the Monitor az monitor label Feb 1, 2017

tjprescott added the New Command(s) label Feb 1, 2017

tjprescott suggested changes Feb 1, 2017

View reviewed changes

derekbekoe suggested changes Feb 1, 2017

View reviewed changes

troydai suggested changes Feb 1, 2017

View reviewed changes

derekbekoe added the do-not-merge label Feb 1, 2017

vishrutshah added 5 commits February 16, 2017 20:15

Adding basic structure for monitor service

d4b6ea5

Adding azure-mgmt-monitor sdk as it's not yet released

fa0f2af

Adding list command for all azure monitor data plane

78b2793

Adding help docs for az monitor data plane commands Adding commands for management place of Azure monitor service Addressing code review comments

Removing management sdk code from azure-cli-monitor

4331c70

Updating azure-monitor-cli to azure-mgmt-monitor and azure-monitor sdk

4d8551e

vishrutshah force-pushed the monitor-cli branch from 76e49eb to 4d8551e Compare February 17, 2017 15:49

vishrutshah added 2 commits February 23, 2017 08:39

Merge pull request #1 from vishrutshah/implement-filter-metric-defini…

72ba403

…tions Implement filter for metrics-definitions list command

Implement filter for metrics list command

53a4aa7

addressing code review comments

3fd8cc4

troydai approved these changes Feb 27, 2017

View reviewed changes

vishrutshah added 4 commits February 27, 2017 17:20

Merge pull request #2 from vishrutshah/implement-filter-metrics

60972c4

Implement filter metrics list command

Implement filter and select in activity-logs command

eb75d64

Implement filter and select for tenant-activity-logs command

65b103e

Resolving merge conflicts

59751d9

vishrutshah added 4 commits February 28, 2017 20:51

CR comments

3e6fa58

Addressing review comments

1ec0016

Merge pull request #3 from vishrutshah/implement-activity-logs-filter

1c655cc

Implement filter & select in activity-logs and tenant-activity-logs

Adding scaffold command in autoscale-settings (#4)

875e53f

* Adding scaffold command in autoscale-settings * Addressing review feedback

Adding unittests for custom monitor commands (#5)

72ac3d8

* Adding unittests for custom monitor commands * Better assertions

troydai reviewed Mar 8, 2017

View reviewed changes

vishrutshah added 2 commits March 8, 2017 14:24

Rename expanded params and resolve bugs

45fe44a

vishrutshah added 2 commits March 15, 2017 15:39

Fix pylint error on line too long

6ada6e9

resolving merge conflicts

2d48c8e

vishrutshah closed this Mar 16, 2017

haroldrandom added cla-not-required do-not-merge Monitor az monitor New Command (PR) labels Oct 25, 2019



		def _activity_logs_select_filter_builder(events=None):
		'''Build up select filter string from events

Azure Monitor cli commands for Managemnt & Data plane #1953

Azure Monitor cli commands for Managemnt & Data plane #1953

Uh oh!

Conversation

vishrutshah commented Feb 1, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tjprescott commented Feb 1, 2017

Uh oh!

tjprescott left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vishrutshah commented Feb 1, 2017

Uh oh!

vishrutshah commented Feb 1, 2017

Uh oh!

vishrutshah commented Feb 1, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vishrutshah commented Feb 1, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vishrutshah commented Feb 1, 2017 •

edited

Loading

vishrutshah commented Feb 1, 2017 •

edited

Loading

vishrutshah commented Feb 1, 2017 •

edited

Loading

vishrutshah commented Feb 1, 2017 •

edited

Loading

vishrutshah commented Feb 1, 2017 •

edited

Loading

vishrutshah commented Feb 1, 2017 •

edited

Loading

vishrutshah commented Feb 1, 2017 •

edited

Loading

vishrutshah commented Feb 1, 2017 •

edited

Loading

vishrutshah commented Feb 1, 2017 •

edited

Loading

vishrutshah commented Feb 1, 2017 •

edited

Loading

vishrutshah commented Feb 1, 2017 •

edited

Loading