Get-TSTMGMTAccessKey

Get a single Access Key's details from the Management Platform

Written by Ines

Last published at: December 9th, 2022

Get a single Access Key's details from the Management Platform

 

SYNTAX

Get-TSTMGMTAccessKey

-KeyName <string> [-AccessKeyId <guid>] [-Force] [-Interface <guid>] [-Timeout <int>]

 

 

 

DESCRIPTION

Get details on a single AccessKey. Must have a KeyName string specified, or AcccessKeyId.

If all AccessKeys' details are required, please use the Get-TSTMGMTAccessKeys command instead.

 

EXAMPLES

1. Retrieve details of a single Access Key using its fully qualified name (KeyName)

Get-TSTMGMTAccessKey -KeyName ‘\Access Keys\Admin_srw’

 

 

 

2. Retrieve details of a single Access Key using its object id (AccessKeyId)

 

Get-TSTMGMTAccessKey -AccessKeyId 7b422431-51fd-4c70-bfac-90b5f306ef98

 

PARAMETERS

 

-KeyName

A fully qualified name of the Access Key

Type: ThinScale.Management.DataObjects.AccessKey
Required: Yes
Accept Pipeline Input: No

 

-AccessKeyId

The GUID of the Access Key (not required if the KeyName is supplied)

Type: String
Required: No
Accept Pipeline Input: No

 

-Force

If multiple objects are found with the same name, the first retrieved will be used otherwise the call will fail

Type: SwitchParameter
Required: No
Accept Pipeline Input: No

 

-Interface

The interface ID returned by a previously successful call to Connect-TSTMGMTServer. This parameter is only required if you are connected to 2 or more Management Platform instances at the same time. If this parameter is not specified the connection to the last successful call to Connect-TSTMgmtServer will be used.

Type: Guid
 
Required: No
Accept Pipeline Input: No

 

-Timeout

The time allowed in milliseconds for the call to complete before it is deemed to have timed out and is aborted

Type: Int32
Required: No
Accept Pipeline Input: No

 

INPUTS

ThinScale.Management.DataObjects.AccessKey

 

OUTPUTS

ThinScale.Management.DataObjects.AccessKey