< Back

Get-ProvAzureTenant

Sun Jan 19, 2020 5:38 pm

NAME Get-ProvAzureTenant



SYNOPSIS

Read details of an Azure Active Directory tenant.





SYNTAX

Get-ProvAzureTenant -AuthContext <object> [-ApiVersion <string>] [<CommonParameters>]





DESCRIPTION

This cmdlet connects to the Azure REST API and reads the tenant details for further processing with REST API

requests. The tenant details are always retrieved for the tenantid stored in the OAuthToken.





PARAMETERS

-AuthContext <object>

A valid authentication token, as provided by "ProvAzureAuthContext"



Required? true

Position? named

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-ApiVersion <string>

The REST API Version used to read the data from Azure. Default is "2016-01-01", but may be changed due to

updates in the REST API



See https://docs.microsoft.com/en-us/rest/a ... es/tenants for updates.



Required? false

Position? named

Default value 2016-01-01

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

System.Object

A valid authentication token, as provided by "ProvAzureAuthContext"





OUTPUTS

Provance.Azure.Common.Model.Tenant





---------- EXAMPLE 1 ----------



Retrieving tenant details





$mytenant = Get-ProvAzureTenant -AuthContext $token



The $token object shall be generated with "Get-ProvAzureAuthContext" first





RELATED LINKS

Provance Technologies Inc. (http://provance.com)

Help (http://help.provance.com)