az devops admin banner

Manage organization banner.

Commands

az devops admin banner add

Add a new banner and immediately show it.

az devops admin banner list

List banners.

az devops admin banner remove

Remove a banner.

az devops admin banner show

Show details for a banner.

az devops admin banner update

Update the message, level, or expiration date for a banner.

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]
                           [--subscription]
                           [--type {error, info, warning}]

Required Parameters

--message -m

Message (string) to show in the banner.

Optional Parameters

--detect

Automatically detect organization.

accepted values: false, true
--expiration

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".

--id

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.

--org --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/.

--subscription

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

--type -t

Type of banner to present. Defaults is "info".

accepted values: error, info, warning

az devops admin banner list

List banners.

az devops admin banner list [--detect {false, true}]
                            [--org]
                            [--query-examples]
                            [--subscription]

Optional Parameters

--detect

Automatically detect organization.

accepted values: false, true
--org --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/.

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

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

az devops admin banner remove

Remove a banner.

az devops admin banner remove --id
                              [--detect {false, true}]
                              [--org]
                              [--subscription]

Required Parameters

--id

ID of the banner to remove.

Optional Parameters

--detect

Automatically detect organization.

accepted values: false, true
--org --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/.

--subscription

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

az devops admin banner show

Show details for a banner.

az devops admin banner show --id
                            [--detect {false, true}]
                            [--org]
                            [--query-examples]
                            [--subscription]

Required Parameters

--id

Identifier for the banner.

Optional Parameters

--detect

Automatically detect organization.

accepted values: false, true
--org --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/.

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

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

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]
                              [--subscription]
                              [--type {error, info, warning}]

Required Parameters

--id

ID of the banner to update.

Optional Parameters

--detect

Automatically detect organization.

accepted values: false, true
--expiration

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 -m

Message (string) to show in the banner.

--org --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/.

--subscription

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

--type -t

Type of banner to present. Defaults is "info".

accepted values: error, info, warning