Update-AzBotService
Updates a Bot Service
Syntax
Update-AzBotService
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-AllSetting <Hashtable>]
[-AppPasswordHint <String>]
[-CmekKeyVaultUrl <String>]
[-Description <String>]
[-DeveloperAppInsightKey <String>]
[-DeveloperAppInsightsApiKey <String>]
[-DeveloperAppInsightsApplicationId <String>]
[-DisableLocalAuth]
[-DisplayName <String>]
[-Endpoint <String>]
[-Etag <String>]
[-IconUrl <String>]
[-IsCmekEnabled]
[-IsStreamingSupported]
[-Kind <Kind>]
[-Location <String>]
[-LuisAppId <String[]>]
[-LuisKey <String>]
[-ManifestUrl <String>]
[-MsaAppId <String>]
[-MsaAppMsiResourceId <String>]
[-MsaAppTenantId <String>]
[-MsaAppType <MsaAppType>]
[-OpenWithHint <String>]
[-Parameter <Hashtable>]
[-PublicNetworkAccess <PublicNetworkAccess>]
[-PublishingCredentials <String>]
[-SchemaTransformationVersion <String>]
[-SkuName <SkuName>]
[-StorageResourceId <String>]
[-Tag <Hashtable>]
[-TenantId <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-AzBotService
-InputObject <IBotServiceIdentity>
[-AllSetting <Hashtable>]
[-AppPasswordHint <String>]
[-CmekKeyVaultUrl <String>]
[-Description <String>]
[-DeveloperAppInsightKey <String>]
[-DeveloperAppInsightsApiKey <String>]
[-DeveloperAppInsightsApplicationId <String>]
[-DisableLocalAuth]
[-DisplayName <String>]
[-Endpoint <String>]
[-Etag <String>]
[-IconUrl <String>]
[-IsCmekEnabled]
[-IsStreamingSupported]
[-Kind <Kind>]
[-Location <String>]
[-LuisAppId <String[]>]
[-LuisKey <String>]
[-ManifestUrl <String>]
[-MsaAppId <String>]
[-MsaAppMsiResourceId <String>]
[-MsaAppTenantId <String>]
[-MsaAppType <MsaAppType>]
[-OpenWithHint <String>]
[-Parameter <Hashtable>]
[-PublicNetworkAccess <PublicNetworkAccess>]
[-PublishingCredentials <String>]
[-SchemaTransformationVersion <String>]
[-SkuName <SkuName>]
[-StorageResourceId <String>]
[-Tag <Hashtable>]
[-TenantId <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Updates a Bot Service
Examples
Example 1: Update the Bot by Name and ResourceGroupName
Update-AzBotService -Name 'youri-apptest' -ResourceGroupName 'youriBotTest' -kind Bot
Etag Kind Location Name SkuName SkuTier Zone
---- ---- -------- ---- ------- ------- ----
"0700e71b-0000-1800-0000-5fd73ed80000" Bot global youri-apptest F0 {}
Update the Bot by Name and ResourceGroupName
Example 2: Update the Bot by InputObject
$getAzbot = Get-AzBotService -Name 'youri-apptest' -ResourceGroupName 'youriBotTest'
Update-AzBotService -InputObject $getAzbot -kind sdk
Etag Kind Location Name SkuName SkuTier Zone
---- ---- -------- ---- ------- ------- ----
"07008b1c-0000-1800-0000-5fd73f9e0000" sdk global youri-apptest F0 {}
Update the Bot by InputObject
Parameters
-AllSetting
Contains resource all settings defined as key/value pairs.
Type: | Hashtable |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-AppPasswordHint
The hint (e.g. keyVault secret resourceId) on how to fetch the app secret
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-CmekKeyVaultUrl
The CMK Url
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-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 |
-Description
The description of the bot
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DeveloperAppInsightKey
The Application Insights key
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DeveloperAppInsightsApiKey
The Application Insights Api Key
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DeveloperAppInsightsApplicationId
The Application Insights App Id
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DisableLocalAuth
Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DisplayName
The Name of the bot
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Endpoint
The bot's endpoint
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Etag
Entity Tag
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-IconUrl
The Icon Url of the bot
Type: | String |
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 |
-IsCmekEnabled
Whether Cmek is enabled
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-IsStreamingSupported
Whether the bot is streaming supported
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Kind
Required. Gets or sets the Kind of the resource.
Type: | Kind |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Location
Specifies the location of the resource.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-LuisAppId
Collection of LUIS App Ids
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-LuisKey
The LUIS Key
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ManifestUrl
The bot's manifest url
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-MsaAppId
Microsoft App Id for the bot
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-MsaAppMsiResourceId
Microsoft App Managed Identity Resource Id for the bot
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-MsaAppTenantId
Microsoft App Tenant Id for the bot
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-MsaAppType
Microsoft App Type for the bot
Type: | MsaAppType |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
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 |
-OpenWithHint
The hint to browser (e.g. protocol handler) on how to open the bot for authoring
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Parameter
Contains resource parameters defined as key/value pairs.
Type: | Hashtable |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PublicNetworkAccess
Whether the bot is in an isolated network
Type: | PublicNetworkAccess |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PublishingCredentials
Publishing credentials of the resource
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
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 |
-SchemaTransformationVersion
The channel schema transformation version for the bot
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SkuName
The sku name
Type: | SkuName |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-StorageResourceId
The storage resourceId for the bot
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
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 |
-Tag
Contains resource tags defined as key/value pairs.
Type: | Hashtable |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-TenantId
The Tenant Id for the bot
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |