Skip to content

Latest commit

 

History

History
102 lines (73 loc) · 2.53 KB

Get-AzureRmApiManagementUserSsoUrl.md

File metadata and controls

102 lines (73 loc) · 2.53 KB
external help file Module Name ms.assetid online version schema
Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml
AzureRM.ApiManagement
27FF1B7D-E103-4504-AD09-8D3A8BCA8B75
2.0.0

Get-AzureRmApiManagementUserSsoUrl

SYNOPSIS

Generates an SSO URL for a user.

SYNTAX

Get-AzureRmApiManagementUserSsoUrl -Context <PsApiManagementContext> -UserId <String>
 [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]

DESCRIPTION

The Get-AzureRmApiManagementUserSsoUrl cmdlet generates a single sign-on (SSO) URL for a user.

EXAMPLES

Example 1: Get a user's SSO URL

PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\>Get-AzureRmApiManagementUserSsoUrl -Context $apimContext -UserId "0123456789"

This command gets a user's SSO URL.

PARAMETERS

-Context

Specifies a PsApiManagementContext object. This parameter is required.

Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzureRmContext, AzureCredential

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-UserId

Specifies a user ID. This parameter is required.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext

System.String

OUTPUTS

System.String

NOTES

RELATED LINKS

Get-AzureRmApiManagementUser