Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PolicyDefinitions

Package version

Class representing a PolicyDefinitions.

Hierarchy

  • PolicyDefinitions

Index

Constructors

Methods

Constructors

constructor

Methods

createOrUpdate

  • createOrUpdate(policyDefinitionName: string, parameters: PolicyDefinition, options?: msRest.RequestOptionsBase): Promise<Models.PolicyDefinitionsCreateOrUpdateResponse>
  • createOrUpdate(policyDefinitionName: string, parameters: PolicyDefinition, callback: msRest.ServiceCallback<PolicyDefinition>): void
  • createOrUpdate(policyDefinitionName: string, parameters: PolicyDefinition, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<PolicyDefinition>): void

  • Creates or updates a policy definition.

    Parameters

    • policyDefinitionName: string

      The name of the policy definition to create.

    • parameters: PolicyDefinition

      The policy definition properties.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.PolicyDefinitionsCreateOrUpdateResponse>

    Promise<Models.PolicyDefinitionsCreateOrUpdateResponse>

  • Parameters

    • policyDefinitionName: string

      The name of the policy definition to create.

    • parameters: PolicyDefinition

      The policy definition properties.

    • callback: msRest.ServiceCallback<PolicyDefinition>

      The callback

    Returns void

  • Parameters

    • policyDefinitionName: string

      The name of the policy definition to create.

    • parameters: PolicyDefinition

      The policy definition properties.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<PolicyDefinition>

      The callback

    Returns void

createOrUpdateAtManagementGroup

  • createOrUpdateAtManagementGroup(policyDefinitionName: string, parameters: PolicyDefinition, managementGroupId: string, options?: msRest.RequestOptionsBase): Promise<Models.PolicyDefinitionsCreateOrUpdateAtManagementGroupResponse>
  • createOrUpdateAtManagementGroup(policyDefinitionName: string, parameters: PolicyDefinition, managementGroupId: string, callback: msRest.ServiceCallback<PolicyDefinition>): void
  • createOrUpdateAtManagementGroup(policyDefinitionName: string, parameters: PolicyDefinition, managementGroupId: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<PolicyDefinition>): void

  • Creates or updates a policy definition at management group level.

    Parameters

    • policyDefinitionName: string

      The name of the policy definition to create.

    • parameters: PolicyDefinition

      The policy definition properties.

    • managementGroupId: string

      The ID of the management group.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.PolicyDefinitionsCreateOrUpdateAtManagementGroupResponse>

    Promise<Models.PolicyDefinitionsCreateOrUpdateAtManagementGroupResponse>

  • Parameters

    • policyDefinitionName: string

      The name of the policy definition to create.

    • parameters: PolicyDefinition

      The policy definition properties.

    • managementGroupId: string

      The ID of the management group.

    • callback: msRest.ServiceCallback<PolicyDefinition>

      The callback

    Returns void

  • Parameters

    • policyDefinitionName: string

      The name of the policy definition to create.

    • parameters: PolicyDefinition

      The policy definition properties.

    • managementGroupId: string

      The ID of the management group.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<PolicyDefinition>

      The callback

    Returns void

deleteAtManagementGroup

  • deleteAtManagementGroup(policyDefinitionName: string, managementGroupId: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>
  • deleteAtManagementGroup(policyDefinitionName: string, managementGroupId: string, callback: msRest.ServiceCallback<void>): void
  • deleteAtManagementGroup(policyDefinitionName: string, managementGroupId: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<void>): void

  • Deletes a policy definition at management group level.

    Parameters

    • policyDefinitionName: string

      The name of the policy definition to delete.

    • managementGroupId: string

      The ID of the management group.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

  • Parameters

    • policyDefinitionName: string

      The name of the policy definition to delete.

    • managementGroupId: string

      The ID of the management group.

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

  • Parameters

    • policyDefinitionName: string

      The name of the policy definition to delete.

    • managementGroupId: string

      The ID of the management group.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

deleteMethod

  • deleteMethod(policyDefinitionName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>
  • deleteMethod(policyDefinitionName: string, callback: msRest.ServiceCallback<void>): void
  • deleteMethod(policyDefinitionName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<void>): void

  • Deletes a policy definition.

    Parameters

    • policyDefinitionName: string

      The name of the policy definition to delete.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

  • Parameters

    • policyDefinitionName: string

      The name of the policy definition to delete.

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

  • Parameters

    • policyDefinitionName: string

      The name of the policy definition to delete.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

get

  • get(policyDefinitionName: string, options?: msRest.RequestOptionsBase): Promise<Models.PolicyDefinitionsGetResponse>
  • get(policyDefinitionName: string, callback: msRest.ServiceCallback<PolicyDefinition>): void
  • get(policyDefinitionName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<PolicyDefinition>): void

  • Gets the policy definition.

    Parameters

    • policyDefinitionName: string

      The name of the policy definition to get.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.PolicyDefinitionsGetResponse>

    Promise<Models.PolicyDefinitionsGetResponse>

  • Parameters

    • policyDefinitionName: string

      The name of the policy definition to get.

    • callback: msRest.ServiceCallback<PolicyDefinition>

      The callback

    Returns void

  • Parameters

    • policyDefinitionName: string

      The name of the policy definition to get.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<PolicyDefinition>

      The callback

    Returns void

getAtManagementGroup

  • getAtManagementGroup(policyDefinitionName: string, managementGroupId: string, options?: msRest.RequestOptionsBase): Promise<Models.PolicyDefinitionsGetAtManagementGroupResponse>
  • getAtManagementGroup(policyDefinitionName: string, managementGroupId: string, callback: msRest.ServiceCallback<PolicyDefinition>): void
  • getAtManagementGroup(policyDefinitionName: string, managementGroupId: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<PolicyDefinition>): void

  • Gets the policy definition at management group level.

    Parameters

    • policyDefinitionName: string

      The name of the policy definition to get.

    • managementGroupId: string

      The ID of the management group.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.PolicyDefinitionsGetAtManagementGroupResponse>

    Promise<Models.PolicyDefinitionsGetAtManagementGroupResponse>

  • Parameters

    • policyDefinitionName: string

      The name of the policy definition to get.

    • managementGroupId: string

      The ID of the management group.

    • callback: msRest.ServiceCallback<PolicyDefinition>

      The callback

    Returns void

  • Parameters

    • policyDefinitionName: string

      The name of the policy definition to get.

    • managementGroupId: string

      The ID of the management group.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<PolicyDefinition>

      The callback

    Returns void

getBuiltIn

  • getBuiltIn(policyDefinitionName: string, options?: msRest.RequestOptionsBase): Promise<Models.PolicyDefinitionsGetBuiltInResponse>
  • getBuiltIn(policyDefinitionName: string, callback: msRest.ServiceCallback<PolicyDefinition>): void
  • getBuiltIn(policyDefinitionName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<PolicyDefinition>): void

  • Gets the built in policy definition.

    Parameters

    • policyDefinitionName: string

      The name of the built in policy definition to get.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.PolicyDefinitionsGetBuiltInResponse>

    Promise<Models.PolicyDefinitionsGetBuiltInResponse>

  • Parameters

    • policyDefinitionName: string

      The name of the built in policy definition to get.

    • callback: msRest.ServiceCallback<PolicyDefinition>

      The callback

    Returns void

  • Parameters

    • policyDefinitionName: string

      The name of the built in policy definition to get.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<PolicyDefinition>

      The callback

    Returns void

list

  • list(options?: msRest.RequestOptionsBase): Promise<Models.PolicyDefinitionsListResponse>
  • list(callback: msRest.ServiceCallback<PolicyDefinitionListResult>): void
  • list(options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<PolicyDefinitionListResult>): void

listBuiltIn

  • listBuiltIn(options?: msRest.RequestOptionsBase): Promise<Models.PolicyDefinitionsListBuiltInResponse>
  • listBuiltIn(callback: msRest.ServiceCallback<PolicyDefinitionListResult>): void
  • listBuiltIn(options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<PolicyDefinitionListResult>): void

listBuiltInNext

  • listBuiltInNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.PolicyDefinitionsListBuiltInNextResponse>
  • listBuiltInNext(nextPageLink: string, callback: msRest.ServiceCallback<PolicyDefinitionListResult>): void
  • listBuiltInNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<PolicyDefinitionListResult>): void

  • Gets all the built in policy definitions.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.PolicyDefinitionsListBuiltInNextResponse>

    Promise<Models.PolicyDefinitionsListBuiltInNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<PolicyDefinitionListResult>

      The callback

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<PolicyDefinitionListResult>

      The callback

    Returns void

listByManagementGroup

  • listByManagementGroup(managementGroupId: string, options?: msRest.RequestOptionsBase): Promise<Models.PolicyDefinitionsListByManagementGroupResponse>
  • listByManagementGroup(managementGroupId: string, callback: msRest.ServiceCallback<PolicyDefinitionListResult>): void
  • listByManagementGroup(managementGroupId: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<PolicyDefinitionListResult>): void

  • Gets all the policy definitions for a subscription at management group level.

    Parameters

    • managementGroupId: string

      The ID of the management group.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.PolicyDefinitionsListByManagementGroupResponse>

    Promise<Models.PolicyDefinitionsListByManagementGroupResponse>

  • Parameters

    • managementGroupId: string

      The ID of the management group.

    • callback: msRest.ServiceCallback<PolicyDefinitionListResult>

      The callback

    Returns void

  • Parameters

    • managementGroupId: string

      The ID of the management group.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<PolicyDefinitionListResult>

      The callback

    Returns void

listByManagementGroupNext

  • listByManagementGroupNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.PolicyDefinitionsListByManagementGroupNextResponse>
  • listByManagementGroupNext(nextPageLink: string, callback: msRest.ServiceCallback<PolicyDefinitionListResult>): void
  • listByManagementGroupNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<PolicyDefinitionListResult>): void

  • Gets all the policy definitions for a subscription at management group level.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.PolicyDefinitionsListByManagementGroupNextResponse>

    Promise<Models.PolicyDefinitionsListByManagementGroupNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<PolicyDefinitionListResult>

      The callback

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<PolicyDefinitionListResult>

      The callback

    Returns void

listNext

  • listNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.PolicyDefinitionsListNextResponse>
  • listNext(nextPageLink: string, callback: msRest.ServiceCallback<PolicyDefinitionListResult>): void
  • listNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<PolicyDefinitionListResult>): void

  • Gets all the policy definitions for a subscription.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.PolicyDefinitionsListNextResponse>

    Promise<Models.PolicyDefinitionsListNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<PolicyDefinitionListResult>

      The callback

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<PolicyDefinitionListResult>

      The callback

    Returns void

Generated using TypeDoc