Variables interface
Interface representing a Variables.
Methods
| create |
This operation creates or updates a variable with the given subscription and name. Policy variables can only be used by a policy definition at the scope they are created or below. |
| create |
This operation creates or updates a variable with the given management group and name. Policy variables can only be used by a policy definition at the scope they are created or below. |
| delete(string, Variables |
This operation deletes a variable, given its name and the subscription it was created in. The scope of a variable is the part of its ID preceding '/providers/Microsoft.Authorization/variables/{variableName}'. |
| delete |
This operation deletes a variable, given its name and the management group it was created in. The scope of a variable is the part of its ID preceding '/providers/Microsoft.Authorization/variables/{variableName}'. |
| get(string, Variables |
This operation retrieves a single variable, given its name and the subscription it was created at. |
| get |
This operation retrieves a single variable, given its name and the management group it was created at. |
| list(Variables |
This operation retrieves the list of all variables associated with the given subscription. |
| list |
This operation retrieves the list of all variables applicable to the management group. |
Method Details
createOrUpdate(string, Variable, VariablesCreateOrUpdateOptionalParams)
This operation creates or updates a variable with the given subscription and name. Policy variables can only be used by a policy definition at the scope they are created or below.
function createOrUpdate(variableName: string, parameters: Variable, options?: VariablesCreateOrUpdateOptionalParams): Promise<Variable>Parameters
- variableName
-
string
The name of the variable to operate on.
- parameters
- Variable
Parameters for the variable.
The options parameters.
Returns
Promise<Variable>
createOrUpdateAtManagementGroup(string, string, Variable, VariablesCreateOrUpdateAtManagementGroupOptionalParams)
This operation creates or updates a variable with the given management group and name. Policy variables can only be used by a policy definition at the scope they are created or below.
function createOrUpdateAtManagementGroup(managementGroupId: string, variableName: string, parameters: Variable, options?: VariablesCreateOrUpdateAtManagementGroupOptionalParams): Promise<Variable>Parameters
- managementGroupId
-
string
The ID of the management group.
- variableName
-
string
The name of the variable to operate on.
- parameters
- Variable
Parameters for the variable.
The options parameters.
Returns
Promise<Variable>
delete(string, VariablesDeleteOptionalParams)
This operation deletes a variable, given its name and the subscription it was created in. The scope of a variable is the part of its ID preceding '/providers/Microsoft.Authorization/variables/{variableName}'.
function delete(variableName: string, options?: VariablesDeleteOptionalParams): Promise<void>Parameters
- variableName
-
string
The name of the variable to operate on.
- options
- VariablesDeleteOptionalParams
The options parameters.
Returns
Promise<void>
deleteAtManagementGroup(string, string, VariablesDeleteAtManagementGroupOptionalParams)
This operation deletes a variable, given its name and the management group it was created in. The scope of a variable is the part of its ID preceding '/providers/Microsoft.Authorization/variables/{variableName}'.
function deleteAtManagementGroup(managementGroupId: string, variableName: string, options?: VariablesDeleteAtManagementGroupOptionalParams): Promise<void>Parameters
- managementGroupId
-
string
The ID of the management group.
- variableName
-
string
The name of the variable to operate on.
The options parameters.
Returns
Promise<void>
get(string, VariablesGetOptionalParams)
This operation retrieves a single variable, given its name and the subscription it was created at.
function get(variableName: string, options?: VariablesGetOptionalParams): Promise<Variable>Parameters
- variableName
-
string
The name of the variable to operate on.
- options
- VariablesGetOptionalParams
The options parameters.
Returns
Promise<Variable>
getAtManagementGroup(string, string, VariablesGetAtManagementGroupOptionalParams)
This operation retrieves a single variable, given its name and the management group it was created at.
function getAtManagementGroup(managementGroupId: string, variableName: string, options?: VariablesGetAtManagementGroupOptionalParams): Promise<Variable>Parameters
- managementGroupId
-
string
The ID of the management group.
- variableName
-
string
The name of the variable to operate on.
The options parameters.
Returns
Promise<Variable>
list(VariablesListOptionalParams)
This operation retrieves the list of all variables associated with the given subscription.
function list(options?: VariablesListOptionalParams): PagedAsyncIterableIterator<Variable, Variable[], PageSettings>Parameters
- options
- VariablesListOptionalParams
The options parameters.
Returns
listForManagementGroup(string, VariablesListForManagementGroupOptionalParams)
This operation retrieves the list of all variables applicable to the management group.
function listForManagementGroup(managementGroupId: string, options?: VariablesListForManagementGroupOptionalParams): PagedAsyncIterableIterator<Variable, Variable[], PageSettings>Parameters
- managementGroupId
-
string
The ID of the management group.
The options parameters.
