Edit

Share via

Set-AzSLegalNotice

  • Article

Synopsis

Sets the legal notice caption and text.

Syntax

Set-AzSLegalNotice [-Caption <String>] [-Text <String>]

Description

Sets the legal notice caption and text that is presented:

  • After sign-in using the Enter-PSSession cmdlet.

or

  • When opening a new instance of the Azure Stack Hub portal.

Examples

Example 1

Set-AzSLegalNotice -Caption "New caption" -Text "First line\nSecond line\n"

Parameters

-Caption

The legal notice caption.

Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Text

The legal notice text, which shows below the caption.

Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Next steps

For information on how to access and use the privileged endpoint, see Use the privileged endpoint in Azure Stack Hub.