VariableValues interface
Interface representing a VariableValues.
Methods
| create |
This operation creates or updates a variable value with the given subscription and name for a given variable. Variable values are scoped to the variable for which they are created for. |
| create |
This operation creates or updates a variable value with the given management group and name for a given variable. Variable values are scoped to the variable for which they are created for. |
| delete(string, string, Variable |
This operation deletes a variable value, given its name, the subscription it was created in, and the variable it belongs to. The scope of a variable value is the part of its ID preceding '/providers/Microsoft.Authorization/variables/{variableName}'. |
| delete |
This operation deletes a variable value, given its name, the management group it was created in, and the variable it belongs to. The scope of a variable value is the part of its ID preceding '/providers/Microsoft.Authorization/variables/{variableName}'. |
| get(string, string, Variable |
This operation retrieves a single variable value; given its name, subscription it was created at and the variable it's created for. |
| get |
This operation retrieves a single variable value; given its name, management group it was created at and the variable it's created for. |
| list(string, Variable |
This operation retrieves the list of all variable values associated with the given variable that is at a subscription level. |
| list |
This operation retrieves the list of all variable values applicable the variable indicated at the management group scope. |
Method Details
createOrUpdate(string, string, VariableValue, VariableValuesCreateOrUpdateOptionalParams)
This operation creates or updates a variable value with the given subscription and name for a given variable. Variable values are scoped to the variable for which they are created for.
function createOrUpdate(variableName: string, variableValueName: string, parameters: VariableValue, options?: VariableValuesCreateOrUpdateOptionalParams): Promise<VariableValue>Parameters
- variableName
-
string
The name of the variable to operate on.
- variableValueName
-
string
The name of the variable value to operate on.
- parameters
- VariableValue
Parameters for the variable value.
The options parameters.
Returns
Promise<VariableValue>
createOrUpdateAtManagementGroup(string, string, string, VariableValue, VariableValuesCreateOrUpdateAtManagementGroupOptionalParams)
This operation creates or updates a variable value with the given management group and name for a given variable. Variable values are scoped to the variable for which they are created for.
function createOrUpdateAtManagementGroup(managementGroupId: string, variableName: string, variableValueName: string, parameters: VariableValue, options?: VariableValuesCreateOrUpdateAtManagementGroupOptionalParams): Promise<VariableValue>Parameters
- managementGroupId
-
string
The ID of the management group.
- variableName
-
string
The name of the variable to operate on.
- variableValueName
-
string
The name of the variable value to operate on.
- parameters
- VariableValue
Parameters for the variable value.
The options parameters.
Returns
Promise<VariableValue>
delete(string, string, VariableValuesDeleteOptionalParams)
This operation deletes a variable value, given its name, the subscription it was created in, and the variable it belongs to. The scope of a variable value is the part of its ID preceding '/providers/Microsoft.Authorization/variables/{variableName}'.
function delete(variableName: string, variableValueName: string, options?: VariableValuesDeleteOptionalParams): Promise<void>Parameters
- variableName
-
string
The name of the variable to operate on.
- variableValueName
-
string
The name of the variable value to operate on.
The options parameters.
Returns
Promise<void>
deleteAtManagementGroup(string, string, string, VariableValuesDeleteAtManagementGroupOptionalParams)
This operation deletes a variable value, given its name, the management group it was created in, and the variable it belongs to. The scope of a variable value is the part of its ID preceding '/providers/Microsoft.Authorization/variables/{variableName}'.
function deleteAtManagementGroup(managementGroupId: string, variableName: string, variableValueName: string, options?: VariableValuesDeleteAtManagementGroupOptionalParams): Promise<void>Parameters
- managementGroupId
-
string
The ID of the management group.
- variableName
-
string
The name of the variable to operate on.
- variableValueName
-
string
The name of the variable value to operate on.
The options parameters.
Returns
Promise<void>
get(string, string, VariableValuesGetOptionalParams)
This operation retrieves a single variable value; given its name, subscription it was created at and the variable it's created for.
function get(variableName: string, variableValueName: string, options?: VariableValuesGetOptionalParams): Promise<VariableValue>Parameters
- variableName
-
string
The name of the variable to operate on.
- variableValueName
-
string
The name of the variable value to operate on.
- options
- VariableValuesGetOptionalParams
The options parameters.
Returns
Promise<VariableValue>
getAtManagementGroup(string, string, string, VariableValuesGetAtManagementGroupOptionalParams)
This operation retrieves a single variable value; given its name, management group it was created at and the variable it's created for.
function getAtManagementGroup(managementGroupId: string, variableName: string, variableValueName: string, options?: VariableValuesGetAtManagementGroupOptionalParams): Promise<VariableValue>Parameters
- managementGroupId
-
string
The ID of the management group.
- variableName
-
string
The name of the variable to operate on.
- variableValueName
-
string
The name of the variable value to operate on.
The options parameters.
Returns
Promise<VariableValue>
list(string, VariableValuesListOptionalParams)
This operation retrieves the list of all variable values associated with the given variable that is at a subscription level.
function list(variableName: string, options?: VariableValuesListOptionalParams): PagedAsyncIterableIterator<VariableValue, VariableValue[], PageSettings>Parameters
- variableName
-
string
The name of the variable to operate on.
- options
- VariableValuesListOptionalParams
The options parameters.
Returns
listForManagementGroup(string, string, VariableValuesListForManagementGroupOptionalParams)
This operation retrieves the list of all variable values applicable the variable indicated at the management group scope.
function listForManagementGroup(managementGroupId: string, variableName: string, options?: VariableValuesListForManagementGroupOptionalParams): PagedAsyncIterableIterator<VariableValue, VariableValue[], PageSettings>Parameters
- managementGroupId
-
string
The ID of the management group.
- variableName
-
string
The name of the variable to operate on.
The options parameters.
