Edit

Share via


Get-AzBotService

Returns a BotService specified by the parameters.

Syntax

List1 (Default)

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

Get

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

List

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

GetViaIdentity

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.

Parameter properties

Type:PSObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzureRMContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Identity Parameter

Parameter properties

Type:IBotServiceIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GetViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

The name of the Bot resource.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:BotName

Parameter sets

Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceGroupName

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
List
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SubscriptionId

Azure Subscription ID.

Parameter properties

Type:

String[]

Default value:(Get-AzContext).Subscription.Id
Supports wildcards:False
DontShow:False

Parameter sets

List1
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Get
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
List
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

IBotServiceIdentity

Outputs

IBot