Set-AzSqlElasticJobAgent

  • Reference
Module:
Az.Sql

Updates an elastic job agent

Syntax

Set-AzSqlElasticJobAgent
   [-ResourceGroupName] <String>
   [-ServerName] <String>
   [-Name] <String>
   [-Tag <Hashtable>]
   [-UserAssignedIdentityId <String[]>]
   [-IdentityType <String>]
   [-WorkerCount <Int32>]
   [-SkuName <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzSqlElasticJobAgent
   [-InputObject] <AzureSqlElasticJobAgentModel>
   [-Tag <Hashtable>]
   [-UserAssignedIdentityId <String[]>]
   [-IdentityType <String>]
   [-WorkerCount <Int32>]
   [-SkuName <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzSqlElasticJobAgent
   [-ResourceId] <String>
   [-Tag <Hashtable>]
   [-UserAssignedIdentityId <String[]>]
   [-IdentityType <String>]
   [-WorkerCount <Int32>]
   [-SkuName <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-AzSqlElasticJobAgent cmdlet updates an Elastic Job agents

Examples

Example 1

Set-AzSqlElasticJobAgent -ResourceGroupName rg -ServerName elasticjobserver -Name agent -Tag @{ Octopus = "Agent" }

ResourceGroupName ServerName       DatabaseName AgentName State Tags
----------------- ----------       ------------ --------- ----- ----
rg                elasticjobserver jobdb        agent     Ready {[Octopus, Agent]}

Updates an Elastic Job agent

Example 2

$umi = Get-AzUserAssignedIdentity -ResourceGroupName rg -Name pstestumi
New-AzSqlElasticJobAgent -ResourceGroupName rg -ServerName elasticjobserver -DatabaseName jobdb -Name agent -IdentityType "UserAssigned" -UserAssignedIdentityId $umi.Id -SkuName JA200 -WorkerCount 200

ResourceGroupName ServerName       DatabaseName AgentName State Tags
----------------- ----------       ------------ --------- ----- ----
rg                elasticjobserver jobdb        agent     Ready

Updates an Elastic Job agent with specific Sku and Identity

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
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

-IdentityType

Type of Identity to be used. Possible values are UserAssigned and None.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

The agent input object

Type:AzureSqlElasticJobAgentModel
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

The agent name

Type:String
Aliases:AgentName
Position:2
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

The resource group name

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ResourceId

The agent resource id

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ServerName

The server name

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-SkuName

The name of the service objective to assign to the Azure SQL Job Agent.

Type:String
Aliases:RequestedServiceObjectiveName
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Tag

The tags to associate with the Azure SQL Database Agent

Type:Hashtable
Aliases:Tags
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-UserAssignedIdentityId

List of user assigned identities

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:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WorkerCount

WorkerCount is the capacity of the Azure SQL Job Agent which controls the number of concurrent targets that can be executed.

Type:Nullable<T>[Int32]
Aliases:Capacity
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

AzureSqlElasticJobAgentModel

Outputs

AzureSqlElasticJobAgentModel