|
| 1 | +--- |
| 2 | +external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml |
| 3 | +Module Name: AzureRM.Sql |
| 4 | +online version: |
| 5 | +schema: 2.0.0 |
| 6 | +--- |
| 7 | + |
| 8 | +# New-AzureRmSqlJobAgent |
| 9 | + |
| 10 | +## SYNOPSIS |
| 11 | +{{Fill in the Synopsis}} |
| 12 | + |
| 13 | +## SYNTAX |
| 14 | + |
| 15 | +``` |
| 16 | +New-AzureRmSqlJobAgent -ServerName <String> -JobAgentName <String> -DatabaseName <String> |
| 17 | + [-Tags <System.Collections.Generic.Dictionary`2[System.String,System.String]>] [-ResourceGroupName] <String> |
| 18 | + [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>] |
| 19 | +``` |
| 20 | + |
| 21 | +## DESCRIPTION |
| 22 | +{{Fill in the Description}} |
| 23 | + |
| 24 | +## EXAMPLES |
| 25 | + |
| 26 | +### Example 1 |
| 27 | +```powershell |
| 28 | +PS C:\> {{ Add example code here }} |
| 29 | +``` |
| 30 | + |
| 31 | +{{ Add example description here }} |
| 32 | + |
| 33 | +## PARAMETERS |
| 34 | + |
| 35 | +### -DatabaseName |
| 36 | +SQL Database database name. |
| 37 | + |
| 38 | +```yaml |
| 39 | +Type: String |
| 40 | +Parameter Sets: (All) |
| 41 | +Aliases: |
| 42 | + |
| 43 | +Required: True |
| 44 | +Position: Named |
| 45 | +Default value: None |
| 46 | +Accept pipeline input: True (ByPropertyName) |
| 47 | +Accept wildcard characters: False |
| 48 | +``` |
| 49 | +
|
| 50 | +### -DefaultProfile |
| 51 | +The credentials, account, tenant, and subscription used for communication with Azure. |
| 52 | +
|
| 53 | +```yaml |
| 54 | +Type: IAzureContextContainer |
| 55 | +Parameter Sets: (All) |
| 56 | +Aliases: AzureRmContext, AzureCredential |
| 57 | + |
| 58 | +Required: False |
| 59 | +Position: Named |
| 60 | +Default value: None |
| 61 | +Accept pipeline input: False |
| 62 | +Accept wildcard characters: False |
| 63 | +``` |
| 64 | +
|
| 65 | +### -JobAgentName |
| 66 | +SQL Database job account name. |
| 67 | +
|
| 68 | +```yaml |
| 69 | +Type: String |
| 70 | +Parameter Sets: (All) |
| 71 | +Aliases: |
| 72 | + |
| 73 | +Required: True |
| 74 | +Position: Named |
| 75 | +Default value: None |
| 76 | +Accept pipeline input: True (ByPropertyName) |
| 77 | +Accept wildcard characters: False |
| 78 | +``` |
| 79 | +
|
| 80 | +### -ResourceGroupName |
| 81 | +The name of the resource group. |
| 82 | +
|
| 83 | +```yaml |
| 84 | +Type: String |
| 85 | +Parameter Sets: (All) |
| 86 | +Aliases: |
| 87 | + |
| 88 | +Required: True |
| 89 | +Position: 0 |
| 90 | +Default value: None |
| 91 | +Accept pipeline input: True (ByPropertyName) |
| 92 | +Accept wildcard characters: False |
| 93 | +``` |
| 94 | +
|
| 95 | +### -ServerName |
| 96 | +SQL Database server name. |
| 97 | +
|
| 98 | +```yaml |
| 99 | +Type: String |
| 100 | +Parameter Sets: (All) |
| 101 | +Aliases: |
| 102 | + |
| 103 | +Required: True |
| 104 | +Position: Named |
| 105 | +Default value: None |
| 106 | +Accept pipeline input: True (ByPropertyName) |
| 107 | +Accept wildcard characters: False |
| 108 | +``` |
| 109 | +
|
| 110 | +### -Tags |
| 111 | +The tags to associate with the Azure Sql Job Account |
| 112 | +
|
| 113 | +```yaml |
| 114 | +Type: System.Collections.Generic.Dictionary`2[System.String,System.String] |
| 115 | +Parameter Sets: (All) |
| 116 | +Aliases: |
| 117 | + |
| 118 | +Required: False |
| 119 | +Position: Named |
| 120 | +Default value: None |
| 121 | +Accept pipeline input: False |
| 122 | +Accept wildcard characters: False |
| 123 | +``` |
| 124 | +
|
| 125 | +### -Confirm |
| 126 | +Prompts you for confirmation before running the cmdlet. |
| 127 | +
|
| 128 | +```yaml |
| 129 | +Type: SwitchParameter |
| 130 | +Parameter Sets: (All) |
| 131 | +Aliases: cf |
| 132 | + |
| 133 | +Required: False |
| 134 | +Position: Named |
| 135 | +Default value: None |
| 136 | +Accept pipeline input: False |
| 137 | +Accept wildcard characters: False |
| 138 | +``` |
| 139 | +
|
| 140 | +### -WhatIf |
| 141 | +Shows what would happen if the cmdlet runs. |
| 142 | +The cmdlet is not run. |
| 143 | +
|
| 144 | +```yaml |
| 145 | +Type: SwitchParameter |
| 146 | +Parameter Sets: (All) |
| 147 | +Aliases: wi |
| 148 | + |
| 149 | +Required: False |
| 150 | +Position: Named |
| 151 | +Default value: None |
| 152 | +Accept pipeline input: False |
| 153 | +Accept wildcard characters: False |
| 154 | +``` |
| 155 | +
|
| 156 | +### CommonParameters |
| 157 | +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. |
| 158 | +For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). |
| 159 | +
|
| 160 | +## INPUTS |
| 161 | +
|
| 162 | +### System.String |
| 163 | +
|
| 164 | +
|
| 165 | +## OUTPUTS |
| 166 | +
|
| 167 | +### System.Object |
| 168 | +
|
| 169 | +## NOTES |
| 170 | +
|
| 171 | +## RELATED LINKS |
0 commit comments