az devops admin banner
Note
This reference is part of the azure-devops extension for the Azure CLI (version 2.30.0 or higher). The extension will automatically install the first time you run an az devops admin banner command. Learn more about extensions.
Manage organization banner.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az devops admin banner add |
Add a new banner and immediately show it. |
Extension | GA |
| az devops admin banner list |
List banners. |
Extension | GA |
| az devops admin banner remove |
Remove a banner. |
Extension | GA |
| az devops admin banner show |
Show details for a banner. |
Extension | GA |
| az devops admin banner update |
Update the message, level, or expiration date for a banner. |
Extension | GA |
az devops admin banner add
Add a new banner and immediately show it.
az devops admin banner add --message
[--detect {false, true}]
[--expiration]
[--id]
[--org --organization]
[--type {error, info, warning}]Required Parameters
Message (string) to show in the banner.
Optional Parameters
Automatically detect organization.
Date/time when the banner should no longer be presented to users. If not set, the banner does not automatically expire and must be removed with the remove command. Example : "2019-06-10 17:21:00 UTC", "2019-06-10".
Identifier for the new banner. This identifier is needed to change or remove the message later. A unique identifier is automatically created if one is not specified.
Azure DevOps organization URL. You can configure the default organization using az devops configure -d organization=ORG_URL. Required if not configured as default or picked up via git config. Example: https://dev.azure.com/MyOrganizationName/.
Type of banner to present. Defaults is "info".
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az devops admin banner list
List banners.
az devops admin banner list [--detect {false, true}]
[--org --organization]Optional Parameters
Automatically detect organization.
Azure DevOps organization URL. You can configure the default organization using az devops configure -d organization=ORG_URL. Required if not configured as default or picked up via git config. Example: https://dev.azure.com/MyOrganizationName/.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az devops admin banner remove
Remove a banner.
az devops admin banner remove --id
[--detect {false, true}]
[--org --organization]Required Parameters
ID of the banner to remove.
Optional Parameters
Automatically detect organization.
Azure DevOps organization URL. You can configure the default organization using az devops configure -d organization=ORG_URL. Required if not configured as default or picked up via git config. Example: https://dev.azure.com/MyOrganizationName/.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az devops admin banner show
Show details for a banner.
az devops admin banner show --id
[--detect {false, true}]
[--org --organization]Required Parameters
Identifier for the banner.
Optional Parameters
Automatically detect organization.
Azure DevOps organization URL. You can configure the default organization using az devops configure -d organization=ORG_URL. Required if not configured as default or picked up via git config. Example: https://dev.azure.com/MyOrganizationName/.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az devops admin banner update
Update the message, level, or expiration date for a banner.
az devops admin banner update --id
[--detect {false, true}]
[--expiration]
[--message]
[--org --organization]
[--type {error, info, warning}]Required Parameters
ID of the banner to update.
Optional Parameters
Automatically detect organization.
Date/time when the banner should no longer be presented to users. To unset the expiration for the banner, supply an empty value to this argument. Example : "2019-06-10 17:21:00 UTC", "2019-06-10".
Message (string) to show in the banner.
Azure DevOps organization URL. You can configure the default organization using az devops configure -d organization=ORG_URL. Required if not configured as default or picked up via git config. Example: https://dev.azure.com/MyOrganizationName/.
Type of banner to present. Defaults is "info".
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
