Edit

Share via

Update-AzMlWebService

Module:
Az.MachineLearning Module

Updates properties of an existing web service resource.

Syntax

UpdateFromParameters 

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>]

UpdateFromObject 

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.

Parameter properties

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

Parameter sets

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

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

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:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, 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 new value for the web service's description. This is visible in the service's Swagger API schema.

Parameter properties

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

Parameter sets

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

-Diagnostics

The settings that control the diagnostics traces collection for the web service.

Parameter properties

Type:Microsoft.Azure.Management.MachineLearning.WebServices.Models.DiagnosticsConfiguration
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

-Force

Do not ask for confirmation.

Parameter properties

Type:SwitchParameter
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

-Input

The definition for the web service's input(s), provided as a Swagger schema construct.

Parameter properties

Type:Microsoft.Azure.Management.MachineLearning.WebServices.Models.ServiceInputOutputSpecification
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateFromParameters
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

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

Parameter sets

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

-Keys

Updates one or both of the access keys used to authenticate calls to the service's runtime APIs.

Parameter properties

Type:Microsoft.Azure.Management.MachineLearning.WebServices.Models.WebServiceKeys
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateFromParameters
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 web service resource to be updated.

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

-Output

The definition for the web service's output(s), provided as a Swagger schema construct.

Parameter properties

Type:Microsoft.Azure.Management.MachineLearning.WebServices.Models.ServiceInputOutputSpecification
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

-Package

The definition of the graph package that defines this web service.

Parameter properties

Type:Microsoft.Azure.Management.MachineLearning.WebServices.Models.GraphPackage
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UpdateFromParameters
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

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

Parameter sets

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

-RealtimeConfiguration

Updates for the configuration of the service's realtime endpoint.

Parameter properties

Type:Microsoft.Azure.Management.MachineLearning.WebServices.Models.RealtimeConfiguration
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

-ResourceGroupName

The resource group that contains the web service to be updated.

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

-ServiceUpdates

A set of updates to apply to the web service provided as a web service definition instance. Only non-static fields are modified.

Parameter properties

Type:Microsoft.Azure.Management.MachineLearning.WebServices.Models.WebService
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

-StorageAccountKey

Rotates the access key for the storage account associated with the web service.

Parameter properties

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

Parameter sets

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

-Title

The new value for the web service's title. This is visible in the service's Swagger API schema.

Parameter properties

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

Parameter sets

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

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

Parameter sets

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

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