Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Set-AzSqlElasticJobAgent
- Module:
- Az.Sql Module
Updates an elastic job agent
Syntax
DefaultSet (Default)
Set-AzSqlElasticJobAgent
[-ResourceGroupName] <String>
[-ServerName] <String>
[-Name] <String>
[-Tag <Hashtable>]
[-UserAssignedIdentityId <String[]>]
[-IdentityType <String>]
[-WorkerCount <Int32>]
[-SkuName <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ObjectSet
Set-AzSqlElasticJobAgent
[-InputObject] <AzureSqlElasticJobAgentModel>
[-Tag <Hashtable>]
[-UserAssignedIdentityId <String[]>]
[-IdentityType <String>]
[-WorkerCount <Int32>]
[-SkuName <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ResourceIdSet
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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
-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
-IdentityType
Type of Identity to be used. Possible values are UserAssigned and None.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-InputObject
The agent input object
Parameter properties
| Type: | AzureSqlElasticJobAgentModel |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Name
The agent name
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AgentName |
Parameter sets
-ResourceGroupName
The resource group name
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ResourceId
The agent resource id
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ServerName
The server name
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-SkuName
The name of the service objective to assign to the Azure SQL Job Agent.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | RequestedServiceObjectiveName |
Parameter sets
-Tag
The tags to associate with the Azure SQL Database Agent
Parameter properties
| Type: | Hashtable |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Tags |
Parameter sets
-UserAssignedIdentityId
List of user assigned identities
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
-WorkerCount
WorkerCount is the capacity of the Azure SQL Job Agent which controls the number of concurrent targets that can be executed.
Parameter properties
| Type: | |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Capacity |
Parameter sets
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
AzureSqlElasticJobAgentModel
Outputs
AzureSqlElasticJobAgentModel
Azure PowerShell
Feedback
Was this page helpful?