Skip to content

Improve --actions documentation for Az sql db audit-policy update #22729

@luticm

Description

@luticm

"Az sql db audit-policy update" documentation doesn't state how to proper use parameter "--actions" with multiple entries, and example only shows one action group.

Trying to use command with comma separated list will fail with generic error "(InvalidBlobAuditActionsAndGroups) Invalid audit actions or action groups." (ex.: --actions SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP)

The proper way to use the parameter is to provide a space separated list, which is not intuitive at differs from PowerShell module (--actions SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP FAILED_DATABASE_AUTHENTICATION_GROUP).

Suggestions:

  • Update parameter definition on "command_modules/sql/_params.py" informing this is NOT a comma separated list.
  • Provide one additional example on command_modules/sql/_help.py for actions, including a list of actions.

Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Metadata

Metadata

Labels

Auto-AssignAuto assign by botCXP AttentionThis issue is handled by CXP team.SQLaz sqlquestionThe issue doesn't require a change to the product in order to be resolved. Most issues start as that

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions