PolicyDefinitionVersions interface
Interface representing a PolicyDefinitionVersions.
Methods
| create |
This operation creates or updates a policy definition in the given subscription with the given name. |
| create |
This operation creates or updates a policy definition version in the given management group with the given name. |
| delete(string, string, Policy |
This operation deletes the policy definition version in the given subscription with the given name. |
| delete |
This operation deletes the policy definition in the given management group with the given name. |
| get(string, string, Policy |
This operation retrieves the policy definition version in the given subscription with the given name. |
| get |
This operation retrieves the policy definition version in the given management group with the given name. |
| get |
This operation retrieves the built-in policy definition version with the given name. |
| list(string, Policy |
This operation retrieves a list of all the policy definition versions for the given policy definition. |
| list |
This operation lists all the policy definition versions for all policy definitions within a subscription. |
| list |
This operation lists all the policy definition versions for all policy definitions at the management group scope. |
| list |
This operation lists all the built-in policy definition versions for all built-in policy definitions. |
| list |
This operation retrieves a list of all the built-in policy definition versions for the given policy definition. |
| list |
This operation retrieves a list of all the policy definition versions for the given policy definition in the given management group. |
Method Details
createOrUpdate(string, string, PolicyDefinitionVersion, PolicyDefinitionVersionsCreateOrUpdateOptionalParams)
This operation creates or updates a policy definition in the given subscription with the given name.
function createOrUpdate(policyDefinitionName: string, policyDefinitionVersion: string, parameters: PolicyDefinitionVersion, options?: PolicyDefinitionVersionsCreateOrUpdateOptionalParams): Promise<PolicyDefinitionVersion>Parameters
- policyDefinitionName
-
string
The name of the policy definition.
- policyDefinitionVersion
-
string
The policy 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
- PolicyDefinitionVersion
The policy definition properties.
The options parameters.
Returns
Promise<PolicyDefinitionVersion>
createOrUpdateAtManagementGroup(string, string, string, PolicyDefinitionVersion, PolicyDefinitionVersionsCreateOrUpdateAtManagementGroupOptionalParams)
This operation creates or updates a policy definition version in the given management group with the given name.
function createOrUpdateAtManagementGroup(managementGroupName: string, policyDefinitionName: string, policyDefinitionVersion: string, parameters: PolicyDefinitionVersion, options?: PolicyDefinitionVersionsCreateOrUpdateAtManagementGroupOptionalParams): Promise<PolicyDefinitionVersion>Parameters
- managementGroupName
-
string
The name of the management group. The name is case insensitive.
- policyDefinitionName
-
string
The name of the policy definition.
- policyDefinitionVersion
-
string
The policy 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
- PolicyDefinitionVersion
The policy definition properties.
The options parameters.
Returns
Promise<PolicyDefinitionVersion>
delete(string, string, PolicyDefinitionVersionsDeleteOptionalParams)
This operation deletes the policy definition version in the given subscription with the given name.
function delete(policyDefinitionName: string, policyDefinitionVersion: string, options?: PolicyDefinitionVersionsDeleteOptionalParams): Promise<void>Parameters
- policyDefinitionName
-
string
The name of the policy definition.
- policyDefinitionVersion
-
string
The policy 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, PolicyDefinitionVersionsDeleteAtManagementGroupOptionalParams)
This operation deletes the policy definition in the given management group with the given name.
function deleteAtManagementGroup(managementGroupName: string, policyDefinitionName: string, policyDefinitionVersion: string, options?: PolicyDefinitionVersionsDeleteAtManagementGroupOptionalParams): Promise<void>Parameters
- managementGroupName
-
string
The name of the management group. The name is case insensitive.
- policyDefinitionName
-
string
The name of the policy definition.
- policyDefinitionVersion
-
string
The policy 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, PolicyDefinitionVersionsGetOptionalParams)
This operation retrieves the policy definition version in the given subscription with the given name.
function get(policyDefinitionName: string, policyDefinitionVersion: string, options?: PolicyDefinitionVersionsGetOptionalParams): Promise<PolicyDefinitionVersion>Parameters
- policyDefinitionName
-
string
The name of the policy definition.
- policyDefinitionVersion
-
string
The policy 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<PolicyDefinitionVersion>
getAtManagementGroup(string, string, string, PolicyDefinitionVersionsGetAtManagementGroupOptionalParams)
This operation retrieves the policy definition version in the given management group with the given name.
function getAtManagementGroup(managementGroupName: string, policyDefinitionName: string, policyDefinitionVersion: string, options?: PolicyDefinitionVersionsGetAtManagementGroupOptionalParams): Promise<PolicyDefinitionVersion>Parameters
- managementGroupName
-
string
The name of the management group. The name is case insensitive.
- policyDefinitionName
-
string
The name of the policy definition.
- policyDefinitionVersion
-
string
The policy 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<PolicyDefinitionVersion>
getBuiltIn(string, string, PolicyDefinitionVersionsGetBuiltInOptionalParams)
This operation retrieves the built-in policy definition version with the given name.
function getBuiltIn(policyDefinitionName: string, policyDefinitionVersion: string, options?: PolicyDefinitionVersionsGetBuiltInOptionalParams): Promise<PolicyDefinitionVersion>Parameters
- policyDefinitionName
-
string
The name of the policy definition.
- policyDefinitionVersion
-
string
The policy 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<PolicyDefinitionVersion>
list(string, PolicyDefinitionVersionsListOptionalParams)
This operation retrieves a list of all the policy definition versions for the given policy definition.
function list(policyDefinitionName: string, options?: PolicyDefinitionVersionsListOptionalParams): PagedAsyncIterableIterator<PolicyDefinitionVersion, PolicyDefinitionVersion[], PageSettings>Parameters
- policyDefinitionName
-
string
The name of the policy definition.
The options parameters.
Returns
listAll(PolicyDefinitionVersionsListAllOptionalParams)
This operation lists all the policy definition versions for all policy definitions within a subscription.
function listAll(options?: PolicyDefinitionVersionsListAllOptionalParams): Promise<PolicyDefinitionVersionListResult>Parameters
The options parameters.
Returns
Promise<PolicyDefinitionVersionListResult>
listAllAtManagementGroup(string, PolicyDefinitionVersionsListAllAtManagementGroupOptionalParams)
This operation lists all the policy definition versions for all policy definitions at the management group scope.
function listAllAtManagementGroup(managementGroupName: string, options?: PolicyDefinitionVersionsListAllAtManagementGroupOptionalParams): Promise<PolicyDefinitionVersionListResult>Parameters
- managementGroupName
-
string
The name of the management group. The name is case insensitive.
The options parameters.
Returns
Promise<PolicyDefinitionVersionListResult>
listAllBuiltins(PolicyDefinitionVersionsListAllBuiltinsOptionalParams)
This operation lists all the built-in policy definition versions for all built-in policy definitions.
function listAllBuiltins(options?: PolicyDefinitionVersionsListAllBuiltinsOptionalParams): Promise<PolicyDefinitionVersionListResult>Parameters
The options parameters.
Returns
Promise<PolicyDefinitionVersionListResult>
listBuiltIn(string, PolicyDefinitionVersionsListBuiltInOptionalParams)
This operation retrieves a list of all the built-in policy definition versions for the given policy definition.
function listBuiltIn(policyDefinitionName: string, options?: PolicyDefinitionVersionsListBuiltInOptionalParams): PagedAsyncIterableIterator<PolicyDefinitionVersion, PolicyDefinitionVersion[], PageSettings>Parameters
- policyDefinitionName
-
string
The name of the policy definition.
The options parameters.
Returns
listByManagementGroup(string, string, PolicyDefinitionVersionsListByManagementGroupOptionalParams)
This operation retrieves a list of all the policy definition versions for the given policy definition in the given management group.
function listByManagementGroup(managementGroupName: string, policyDefinitionName: string, options?: PolicyDefinitionVersionsListByManagementGroupOptionalParams): PagedAsyncIterableIterator<PolicyDefinitionVersion, PolicyDefinitionVersion[], PageSettings>Parameters
- managementGroupName
-
string
The name of the management group. The name is case insensitive.
- policyDefinitionName
-
string
The name of the policy definition.
The options parameters.