Update-AzMlWebService
Updates properties of an existing web service resource.
Syntax
Update-AzMlWebService
-ResourceGroupName <String>
-Name <String>
[-Title <String>]
[-Description <String>]
[-IsReadOnly]
[-Keys <WebServiceKeys>]
[-StorageAccountKey <String>]
[-Diagnostics <DiagnosticsConfiguration>]
[-RealtimeConfiguration <RealtimeConfiguration>]
[-Assets <Hashtable>]
[-Input <ServiceInputOutputSpecification>]
[-Output <ServiceInputOutputSpecification>]
[-Parameters <Hashtable>]
[-Package <GraphPackage>]
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-AzMlWebService
-ResourceGroupName <String>
-Name <String>
-ServiceUpdates <WebService>
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Update-AzMlWebService cmdlet allows you to update the non-static properties of a web service. The cmdlet works as a patch operation. Pass only the properties that you want modified.
Examples
Example 1: Selective update arguments
Update-AzMlWebService -ResourceGroupName "myresourcegroup" -Name "mywebservicename" -Description "new update to description" -Keys @{Primary='changed primary key'} -Diagnostics @{Level='All'}
Here, we change the description, primary access key and enable the diagnostics collection for all traces during runtime for the web service.
Example 2: Update based on a web service instance
$updates = @{ Properties = @{ Title="New Title"; RealtimeConfiguration = @{ MaxConcurrentCalls=25 }}}
Update-AzMlWebService -ResourceGroupName "myresourcegroup" -Name "mywebservicename" -ServiceUpdates $updates
The example first creates a web service definition, that only contains the fields to be updated, and then calls the Update-AzMlWebService to apply them using the ServiceUpdates parameter.
Parameters
-Assets
The set of assets (e.g. modules, datasets) that make up the web service.
Type: | Hashtable |
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 credentials, account, tenant, and subscription used for communication with azure
Type: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Description
The new value for the web service's description. This is visible in the service's Swagger API schema.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Diagnostics
The settings that control the diagnostics traces collection for the web service.
Type: | Microsoft.Azure.Management.MachineLearning.WebServices.Models.DiagnosticsConfiguration |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Force
Do not ask for confirmation.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Input
The definition for the web service's input(s), provided as a Swagger schema construct.
Type: | Microsoft.Azure.Management.MachineLearning.WebServices.Models.ServiceInputOutputSpecification |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-IsReadOnly
Specifies that this web service is readonly. Once set, the web service can longer be updated, including changing the value of this property, and can only be deleted.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Keys
Updates one or both of the access keys used to authenticate calls to the service's runtime APIs.
Type: | Microsoft.Azure.Management.MachineLearning.WebServices.Models.WebServiceKeys |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
The name of the web service resource to be updated.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Output
The definition for the web service's output(s), provided as a Swagger schema construct.
Type: | Microsoft.Azure.Management.MachineLearning.WebServices.Models.ServiceInputOutputSpecification |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Package
The definition of the graph package that defines this web service.
Type: | Microsoft.Azure.Management.MachineLearning.WebServices.Models.GraphPackage |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Parameters
The set of global parameters values defined for the web service, given as a global parameter name -> default value collection. If no default value is specified, the parameter is considered to be required.
Type: | Hashtable |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RealtimeConfiguration
Updates for the configuration of the service's realtime endpoint.
Type: | Microsoft.Azure.Management.MachineLearning.WebServices.Models.RealtimeConfiguration |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResourceGroupName
The resource group that contains the web service to be updated.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ServiceUpdates
A set of updates to apply to the web service provided as a web service definition instance. Only non-static fields are modified.
Type: | Microsoft.Azure.Management.MachineLearning.WebServices.Models.WebService |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-StorageAccountKey
Rotates the access key for the storage account associated with the web service.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Title
The new value for the web service's title. This is visible in the service's Swagger API schema.
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 |
Inputs
Microsoft.Azure.Management.MachineLearning.WebServices.Models.WebService
Outputs
Microsoft.Azure.Management.MachineLearning.WebServices.Models.WebService
Notes
Keywords: azure, azurerm, arm, resource, management, manager, machine, machine learning, azureml
Azure PowerShell