Get-AzBotService

Reference

Module:: Az.BotService

Returns a BotService specified by the parameters.

Syntax

Get-AzBotService
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzBotService
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzBotService
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzBotService
   -InputObject <IBotServiceIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Returns a BotService specified by the parameters.

Examples

Example 1: List by subscription

Get-AzBotService

Etag                                   Kind Location Name      SkuName SkuTier Zone
----                                   ---- -------- ----      ------- ------- ----
"4f003041-0000-1800-0000-6281fec80000" bot  global   botTest1  F0              {}
"0d0018e1-0000-1800-0000-6371e9540000" bot  global   botTest2  F0              {}
"05000ef7-0000-0200-0000-5fd7065a0000" sdk  global   botTest3  S1              {}
"0600ef2b-0000-0200-0000-5fd727a70000" sdk  global   botTest4  S1              {}

Returns BotService resources belonging to current subscription.

Example 2: Get by Name and ResourceGroupName

Get-AzBotService -Name botTest1 -ResourceGroupName botTest-rg

Etag                                   Kind Location Name      SkuName SkuTier Zone
----                                   ---- -------- ----      ------- ------- ----
"4f003041-0000-1800-0000-6281fec80000" bot  global   botTest1  F0              {}

Returns a BotService specified by Name and ResourceGroupName.

Example 3: GetViaIdentity

Get-AzBotService -InputObject $botTest1

Etag                                   Kind Location Name      SkuName SkuTier Zone
----                                   ---- -------- ----      ------- ------- ----
"4f003041-0000-1800-0000-6281fec80000" bot  global   botTest1  F0              {}

Returns a BotService specified by the input IBotServiceIdentity.

Example 4: List by resource group

Get-AzBotService -ResourceGroupName botTest-rg

Etag                                   Kind Location Name      SkuName SkuTier Zone
----                                   ---- -------- ----      ------- ------- ----
"4f003041-0000-1800-0000-6281fec80000" bot  global   botTest1  F0              {}
"05000ef7-0000-0200-0000-5fd7065a0000" sdk  global   botTest3  S1              {}

Returns all the resources of a particular type belonging to a resource group.

Parameters

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:	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:	IBotServiceIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

The name of the Bot resource.

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

-ResourceGroupName

The name of the Bot resource group in the user subscription.

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

-SubscriptionId

Azure Subscription ID.

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

Inputs

IBotServiceIdentity

Outputs

IBot