PolicySetDefinitionVersions interface
Interface representing a PolicySetDefinitionVersions.
Methods
| create |
This operation creates or updates a policy set definition version in the given subscription with the given name and version. |
| create |
This operation creates or updates a policy set definition version in the given management group with the given name and version. |
| delete(string, string, Policy |
This operation deletes the policy set definition version in the given subscription with the given name and version. |
| delete |
This operation deletes the policy set definition version in the given management group with the given name and version. |
| get(string, string, Policy |
This operation retrieves the policy set definition version in the given subscription with the given name and version. |
| get |
This operation retrieves the policy set definition version in the given management group with the given name and version. |
| get |
This operation retrieves the built-in policy set definition version with the given name and version. |
| list(string, Policy |
This operation retrieves a list of all the policy set definition versions for the given policy set definition. |
| list |
This operation lists all the policy set definition versions for all policy set definitions within a subscription. |
| list |
This operation lists all the policy set definition versions for all policy set definitions at the management group scope. |
| list |
This operation lists all the built-in policy set definition versions for all built-in policy set definitions. |
| list |
This operation retrieves a list of all the built-in policy set definition versions for the given built-in policy set definition. |
| list |
This operation retrieves a list of all the policy set definition versions for the given policy set definition in a given management group. |
Method Details
createOrUpdate(string, string, PolicySetDefinitionVersion, PolicySetDefinitionVersionsCreateOrUpdateOptionalParams)
This operation creates or updates a policy set definition version in the given subscription with the given name and version.
function createOrUpdate(policySetDefinitionName: string, policyDefinitionVersion: string, parameters: PolicySetDefinitionVersion, options?: PolicySetDefinitionVersionsCreateOrUpdateOptionalParams): Promise<PolicySetDefinitionVersion>Parameters
- policySetDefinitionName
-
string
The name of the policy set definition.
- policyDefinitionVersion
-
string
The policy set definition version. The format is x.y.z where x is the major version number, y is the minor version number, and z is the patch number
- parameters
- PolicySetDefinitionVersion
The policy set definition properties.
The options parameters.
Returns
Promise<PolicySetDefinitionVersion>
createOrUpdateAtManagementGroup(string, string, string, PolicySetDefinitionVersion, PolicySetDefinitionVersionsCreateOrUpdateAtManagementGroupOptionalParams)
This operation creates or updates a policy set definition version in the given management group with the given name and version.
function createOrUpdateAtManagementGroup(managementGroupName: string, policySetDefinitionName: string, policyDefinitionVersion: string, parameters: PolicySetDefinitionVersion, options?: PolicySetDefinitionVersionsCreateOrUpdateAtManagementGroupOptionalParams): Promise<PolicySetDefinitionVersion>Parameters
- managementGroupName
-
string
The name of the management group. The name is case insensitive.
- policySetDefinitionName
-
string
The name of the policy set definition.
- policyDefinitionVersion
-
string
The policy set definition version. The format is x.y.z where x is the major version number, y is the minor version number, and z is the patch number
- parameters
- PolicySetDefinitionVersion
The policy set definition version properties.
The options parameters.
Returns
Promise<PolicySetDefinitionVersion>
delete(string, string, PolicySetDefinitionVersionsDeleteOptionalParams)
This operation deletes the policy set definition version in the given subscription with the given name and version.
function delete(policySetDefinitionName: string, policyDefinitionVersion: string, options?: PolicySetDefinitionVersionsDeleteOptionalParams): Promise<void>Parameters
- policySetDefinitionName
-
string
The name of the policy set definition.
- policyDefinitionVersion
-
string
The policy set definition version. The format is x.y.z where x is the major version number, y is the minor version number, and z is the patch number
The options parameters.
Returns
Promise<void>
deleteAtManagementGroup(string, string, string, PolicySetDefinitionVersionsDeleteAtManagementGroupOptionalParams)
This operation deletes the policy set definition version in the given management group with the given name and version.
function deleteAtManagementGroup(managementGroupName: string, policySetDefinitionName: string, policyDefinitionVersion: string, options?: PolicySetDefinitionVersionsDeleteAtManagementGroupOptionalParams): Promise<void>Parameters
- managementGroupName
-
string
The name of the management group. The name is case insensitive.
- policySetDefinitionName
-
string
The name of the policy set definition.
- policyDefinitionVersion
-
string
The policy set definition version. The format is x.y.z where x is the major version number, y is the minor version number, and z is the patch number
The options parameters.
Returns
Promise<void>
get(string, string, PolicySetDefinitionVersionsGetOptionalParams)
This operation retrieves the policy set definition version in the given subscription with the given name and version.
function get(policySetDefinitionName: string, policyDefinitionVersion: string, options?: PolicySetDefinitionVersionsGetOptionalParams): Promise<PolicySetDefinitionVersion>Parameters
- policySetDefinitionName
-
string
The name of the policy set definition.
- policyDefinitionVersion
-
string
The policy set definition version. The format is x.y.z where x is the major version number, y is the minor version number, and z is the patch number
The options parameters.
Returns
Promise<PolicySetDefinitionVersion>
getAtManagementGroup(string, string, string, PolicySetDefinitionVersionsGetAtManagementGroupOptionalParams)
This operation retrieves the policy set definition version in the given management group with the given name and version.
function getAtManagementGroup(managementGroupName: string, policySetDefinitionName: string, policyDefinitionVersion: string, options?: PolicySetDefinitionVersionsGetAtManagementGroupOptionalParams): Promise<PolicySetDefinitionVersion>Parameters
- managementGroupName
-
string
The name of the management group. The name is case insensitive.
- policySetDefinitionName
-
string
The name of the policy set definition.
- policyDefinitionVersion
-
string
The policy set definition version. The format is x.y.z where x is the major version number, y is the minor version number, and z is the patch number
The options parameters.
Returns
Promise<PolicySetDefinitionVersion>
getBuiltIn(string, string, PolicySetDefinitionVersionsGetBuiltInOptionalParams)
This operation retrieves the built-in policy set definition version with the given name and version.
function getBuiltIn(policySetDefinitionName: string, policyDefinitionVersion: string, options?: PolicySetDefinitionVersionsGetBuiltInOptionalParams): Promise<PolicySetDefinitionVersion>Parameters
- policySetDefinitionName
-
string
The name of the policy set definition.
- policyDefinitionVersion
-
string
The policy set definition version. The format is x.y.z where x is the major version number, y is the minor version number, and z is the patch number
The options parameters.
Returns
Promise<PolicySetDefinitionVersion>
list(string, PolicySetDefinitionVersionsListOptionalParams)
This operation retrieves a list of all the policy set definition versions for the given policy set definition.
function list(policySetDefinitionName: string, options?: PolicySetDefinitionVersionsListOptionalParams): PagedAsyncIterableIterator<PolicySetDefinitionVersion, PolicySetDefinitionVersion[], PageSettings>Parameters
- policySetDefinitionName
-
string
The name of the policy set definition.
The options parameters.
Returns
listAll(PolicySetDefinitionVersionsListAllOptionalParams)
This operation lists all the policy set definition versions for all policy set definitions within a subscription.
function listAll(options?: PolicySetDefinitionVersionsListAllOptionalParams): Promise<PolicySetDefinitionVersionListResult>Parameters
The options parameters.
Returns
Promise<PolicySetDefinitionVersionListResult>
listAllAtManagementGroup(string, PolicySetDefinitionVersionsListAllAtManagementGroupOptionalParams)
This operation lists all the policy set definition versions for all policy set definitions at the management group scope.
function listAllAtManagementGroup(managementGroupName: string, options?: PolicySetDefinitionVersionsListAllAtManagementGroupOptionalParams): Promise<PolicySetDefinitionVersionListResult>Parameters
- managementGroupName
-
string
The name of the management group. The name is case insensitive.
The options parameters.
Returns
Promise<PolicySetDefinitionVersionListResult>
listAllBuiltins(PolicySetDefinitionVersionsListAllBuiltinsOptionalParams)
This operation lists all the built-in policy set definition versions for all built-in policy set definitions.
function listAllBuiltins(options?: PolicySetDefinitionVersionsListAllBuiltinsOptionalParams): Promise<PolicySetDefinitionVersionListResult>Parameters
The options parameters.
Returns
Promise<PolicySetDefinitionVersionListResult>
listBuiltIn(string, PolicySetDefinitionVersionsListBuiltInOptionalParams)
This operation retrieves a list of all the built-in policy set definition versions for the given built-in policy set definition.
function listBuiltIn(policySetDefinitionName: string, options?: PolicySetDefinitionVersionsListBuiltInOptionalParams): PagedAsyncIterableIterator<PolicySetDefinitionVersion, PolicySetDefinitionVersion[], PageSettings>Parameters
- policySetDefinitionName
-
string
The name of the policy set definition.
The options parameters.
Returns
listByManagementGroup(string, string, PolicySetDefinitionVersionsListByManagementGroupOptionalParams)
This operation retrieves a list of all the policy set definition versions for the given policy set definition in a given management group.
function listByManagementGroup(managementGroupName: string, policySetDefinitionName: string, options?: PolicySetDefinitionVersionsListByManagementGroupOptionalParams): PagedAsyncIterableIterator<PolicySetDefinitionVersion, PolicySetDefinitionVersion[], PageSettings>Parameters
- managementGroupName
-
string
The name of the management group. The name is case insensitive.
- policySetDefinitionName
-
string
The name of the policy set definition.
The options parameters.