Get-CsOnlineDirectoryTenant

Use the Get-CsOnlineDirectoryTenant cmdlet to retrieve a tenant and associated parameters from the Business Voice Directory.

Syntax

Get-CsOnlineDirectoryTenant
   [[-Tenant] <Guid>]
   [-DomainController <Fqdn>]
   [-Force]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The following is an example of the Get-CsOnlineDirectoryTenant cmdlet's console output.

Get-CsOnlineDirectoryTenant

RunspaceId : 8fa40044-7bcf-465b-b7c8-76e54f124c8d

Id : 7a205197-8e59-487d-b9fa-3fc1b108f1e5

DefaultBridge : 00000000-0000-0000-0000-000000000000

Numbers : {13479167372, 13479167375, 13479167377, 13479167386...}

Bridges : {Id = [5bc815ae-d9e9-4fb6-af74-cf4fa73ceaa6], Name = [Conference Bridge], DefaultServiceNumber = [],

IsDefaultBridge = [False]}

Examples

-------------------------- Example 1 --------------------------

Get-CsOnlineDirectoryTenant -Tenant 7a205197-8e59-487d-b9fa-3fc1b108f1e5

This example returns the tenant specified by GUID.

Parameters

-AsJob

Indicates that this cmdlet runs as a background job.

When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet.

For more information about Windows PowerShell background jobs, see about_Jobs and about_Remote_Jobs.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-Confirm

The Confirm switch causes the command to pause processing, and requires confirmation to proceed.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-DomainController

Specifies the domain controller that's used by the cmdlet to read or write the specified data. Valid inputs for this parameter are either the fully qualified domain name (FQDN) or the computer name.

Type:Fqdn
Aliases:DC
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-Force

The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-Tenant

Specifies the globally unique identifier (GUID) of your Skype for Business Online tenant account. For example:

-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"

You can find your tenant ID by running this command:

Get-CsTenant | Select-Object DisplayName, TenantID

Type:Guid
Position:1
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-WhatIf

The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online

Inputs

None

Outputs

Deserialized.Microsoft.Rtc.Management.Hosted.Bvd.Types.LacTenant