Get-AzApiManagementSsoToken

  • Reference
Module:
Az.ApiManagement

Gets a link with an SSO token to a deployed management portal of an API Management service.

Syntax

Get-AzApiManagementSsoToken
   -ResourceGroupName <String>
   -Name <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzApiManagementSsoToken
   -InputObject <PsApiManagement>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzApiManagementSsoToken cmdlet returns a link (URL) containing a single sign-on (SSO) token to a deployed management portal of an API Management service.

Examples

Example 1: Get the SSO token of an API Management service

Get-AzApiManagementSsoToken -ResourceGroupName "Contoso" -Name "ContosoApi"

This command gets the SSO token of an API Management service.

Parameters

-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Instance of PsApiManagement. This parameter is required.

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

-Name

Specifies the name of the API Management instance.

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

-ResourceGroupName

Specifies the name of resource group under which API Management exists.

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

Inputs

String

Outputs

String