Get-AzsDirectoryTenant

  • Reference
Module:
Azs.Subscriptions.Admin

Get a directory tenant by name.

Syntax

Get-AzsDirectoryTenant
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzsDirectoryTenant
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzsDirectoryTenant
   -InputObject <ISubscriptionsAdminIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Get a directory tenant by name.

Examples

Example 1

PS C:\> Get-AzsDirectoryTenant -ResourceGroupName 'system.redmond'

Location Name                           Type                                          
-------- ----                           ----                                          
redmond  azurestack01.onmicrosoft.com Microsoft.Subscriptions.Admin/directoryTenants
redmond  azurestack02.onmicrosoft.com Microsoft.Subscriptions.Admin/directoryTenants

Lists all the directory tenants under the current subscription and given resource group name.

Parameters

-DefaultProfile

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

Type:System.Management.Automation.PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Required:False
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.SubscriptionsAdmin.Models.ISubscriptionsAdminIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

Directory tenant name.

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

-ResourceGroupName

The resource group the resource is located under.

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

-SubscriptionId

Subscription credentials which uniquely identify Microsoft Azure subscription.The subscription ID forms part of the URI for every service call.

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

Inputs

Microsoft.Azure.PowerShell.Cmdlets.SubscriptionsAdmin.Models.ISubscriptionsAdminIdentity

Outputs

Microsoft.Azure.PowerShell.Cmdlets.SubscriptionsAdmin.Models.Api20151101.IDirectoryTenant

ALIASES

Notes

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 <ISubscriptionsAdminIdentity>: Identity Parameter

  • [DelegatedProvider <String>]: DelegatedProvider identifier.
  • [DelegatedProviderSubscriptionId <String>]: Delegated provider subscription identifier.
  • [Id <String>]: Resource identity path
  • [Location <String>]: The AzureStack location.
  • [ManifestName <String>]: The manifest name.
  • [Offer <String>]: Name of an offer.
  • [OfferDelegationName <String>]: Name of a offer delegation.
  • [OperationsStatusName <String>]: The operation status name.
  • [Plan <String>]: Name of the plan.
  • [PlanAcquisitionId <String>]: The plan acquisition Identifier
  • [Quota <String>]: Name of the quota.
  • [ResourceGroupName <String>]: The resource group the resource is located under.
  • [SubscriptionId <String>]: Subscription credentials which uniquely identify Microsoft Azure subscription.The subscription ID forms part of the URI for every service call.
  • [TargetSubscriptionId <String>]: The target subscription ID.
  • [Tenant <String>]: Directory tenant name.