Skip to content

Latest commit

 

History

History
208 lines (160 loc) · 5.63 KB

Get-AzMLWorkspaceOnlineEndpointToken.md

File metadata and controls

208 lines (160 loc) · 5.63 KB
external help file Module Name online version schema content_git_url original_content_git_url
Az.MachineLearningServices
2.0.0

Get-AzMLWorkspaceOnlineEndpointToken

SYNOPSIS

Retrieve a valid AAD token for an Endpoint using AMLToken-based authentication.

SYNTAX

Get (Default)

Get-AzMLWorkspaceOnlineEndpointToken -Name <String> -ResourceGroupName <String> -WorkspaceName <String>
 [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>]

GetViaIdentity

Get-AzMLWorkspaceOnlineEndpointToken -InputObject <IMachineLearningServicesIdentity>
 [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>]

DESCRIPTION

Retrieve a valid AAD token for an Endpoint using AMLToken-based authentication.

EXAMPLES

Example 1: Retrieve a valid AAD token for an Endpoint using AMLToken-based authentication

Get-AzMLWorkspaceOnlineEndpointToken -ResourceGroupName ml-rg-test -WorkspaceName mlworkspace-cli01 -Name online-portal91
AccessToken
-----------
xxxxxxxxxxxxxxxxxxxxxxxxxxx

Retrieve a valid AAD token for an Endpoint using AMLToken-based authentication

PARAMETERS

-DefaultProfile

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

Type: System.Management.Automation.PSObject
Parameter Sets: (All)
Aliases: AzureRMContext, AzureCredential

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

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity
Parameter Sets: GetViaIdentity
Aliases:

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

-Name

Online Endpoint name.

Type: System.String
Parameter Sets: Get
Aliases:

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

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Type: System.String
Parameter Sets: Get
Aliases:

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

-SubscriptionId

The ID of the target subscription.

Type: System.String[]
Parameter Sets: Get
Aliases:

Required: False
Position: Named
Default value: (Get-AzContext).Subscription.Id
Accept pipeline input: False
Accept wildcard characters: False

-WorkspaceName

Name of Azure Machine Learning workspace.

Type: System.String
Parameter Sets: Get
Aliases:

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
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.

INPUTS

Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.IMachineLearningServicesIdentity

OUTPUTS

Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20220501.IEndpointAuthToken

NOTES

ALIASES

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT <IMachineLearningServicesIdentity>: Identity Parameter

  • [ComputeName <String>]: Name of the Azure Machine Learning compute.
  • [ConnectionName <String>]: Friendly name of the workspace connection
  • [DeploymentName <String>]: Inference deployment identifier.
  • [EndpointName <String>]: Inference Endpoint name.
  • [Id <String>]: The name and identifier for the Job. This is case-sensitive.
  • [Id1 <String>]: Resource identity path
  • [Location <String>]: The location for which resource usage is queried.
  • [Name <String>]: Container name. This is case-sensitive.
  • [PrivateEndpointConnectionName <String>]: The name of the private endpoint connection associated with the workspace
  • [ResourceGroupName <String>]: The name of the resource group. The name is case insensitive.
  • [SubscriptionId <String>]: The ID of the target subscription.
  • [Version <String>]: Version identifier. This is case-sensitive.
  • [WorkspaceName <String>]: Name of Azure Machine Learning workspace.

RELATED LINKS