Edit

Share via

New-AzBotService

Module:
Az.BotService Module

Returns a BotService specified by the parameters.

Syntax

Registration (Default) 

New-AzBotService
    -ResourceGroupName <String>
    -ApplicationId <String>
    -Sku <String>
    [-Name <String>]
    [-DisplayName <String>]
    [-Endpoint <String>]
    [-Description <String>]
    [-Registration]
    [-Location <String>]
    [-ServerFarmLocation <String>]
    [-Language <String>]
    [-BotTemplateType <String>]
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

WebApp 

New-AzBotService
    -ResourceGroupName <String>
    -ApplicationId <String>
    -ApplicationSecret <SecureString>
    -Sku <String>
    [-Name <String>]
    [-Description <String>]
    [-Location <String>]
    [-ServerFarmLocation <String>]
    [-Language <String>]
    [-BotTemplateType <String>]
    [-SubscriptionId <String[]>]
    [-Webapp]
    [-ExistingServerFarmId <String>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Description

Returns a BotService specified by the parameters.

Examples

Example 1: Create a new bot

New-AzBotService -resourcegroupname BotTest-rg -name BotTest1 -ApplicationId "af5fce4d-ee68-4b25-be09-f3222582e133" -Location global -Sku F0 -Description "123134" -Registration

Etag                                   Kind Location Name     SkuName SkuTier Zone
----                                   ---- -------- ----     ------- ------- ----
"060085fb-0000-1800-0000-5fd71d7c0000" bot  global   BotTest1 F0              {}

Create a new Bot by ResourceGroupName and ApplicationId

Example 2: Create a new Web App

New-AzBotService -resourcegroupname BotTest-rg -name BotTest2 -ApplicationId "b1ab1727-0465-4255-a1bb-976210af972c" -Location global -Sku F0 -Description "123134" -Webapp

Etag                                   Kind Location Name     SkuName SkuTier Zone
----                                   ---- -------- ----     ------- ------- ----
"06008351-0000-0200-0000-5fd732870000" sdk  global   BotTest2 F0              {}

Create a new Web App by ResourceGroupName and ApplicationId

Parameters

-ApplicationId

Microsoft App Id for the bot

Parameter properties

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

Parameter sets

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

-ApplicationSecret

Microsoft App secret generated by the corresponding Add Id

Parameter properties

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

Parameter sets

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

-BotTemplateType

Returns a BotService specified by the parameters.

Parameter properties

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

Parameter sets

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

-DefaultProfile

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

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

-Description

The description of the bot

Parameter properties

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

Parameter sets

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

-DisplayName

DisplayName can be different from the bot Name.

Parameter properties

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

Parameter sets

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

-Endpoint

The bot's endpoint

Parameter properties

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

Parameter sets

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

-ExistingServerFarmId

Provide this if required ServerFarm has been created.

Parameter properties

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

Parameter sets

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

-Language

Returns a BotService specified by the parameters.

Parameter properties

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

Parameter sets

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

-Location

Specifies the location of the resource.

Parameter properties

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

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
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

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

-Registration

Default kind of a bot.

Parameter properties

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

Parameter sets

Registration
Position:Named
Mandatory:False
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

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

-ServerFarmLocation

Specifies the location of the server farm.

Parameter properties

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

Parameter sets

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

-Sku

The sku name

Parameter properties

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

Parameter sets

(All)
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

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

-Webapp

Returns a BotService specified by the parameters.

Parameter properties

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

Parameter sets

WebApp
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.

Outputs

IBot