PolicyClient Class

  • Reference

To manage and control access to your resources, you can define customized policies and assign them at a scope.

This ready contains multiple API versions, to help you deal with all of the Azure clouds (Azure Stack, Azure Government, Azure China, etc.). By default, it uses the latest API version available on public Azure. For production, you should stick to a particular api-version and/or profile. The profile sets a mapping between an operation group and its API version. The api-version parameter sets the default API version if the operation group is not described in the profile.

Inheritance
MultiApiClientMixin
PolicyClient
azure.mgmt.resource.policy._policy_client._SDKClient
PolicyClient

Constructor

PolicyClient(credential: TokenCredential, subscription_id: str, api_version: str | None = None, base_url: str = 'https://management.azure.com', profile: KnownProfiles = KnownProfiles.default, **kwargs: Any)

Parameters

Name Description
credential
Required
TokenCredential

Credential needed for the client to connect to Azure. Required.
subscription_id
Required
str

The ID of the target subscription. Required.
api_version
str

API version to use if no profile is provided, or if missing in profile.

default value: None
base_url
str

Service URL

default value: https://management.azure.com
profile
KnownProfiles

A profile definition, from KnownProfiles to dict.

default value: KnownProfiles.default

Methods

close
models

Module depends on the API version:

close 

close()

models

Module depends on the API version:

models(api_version='2022-06-01')

Parameters

Name Description
api_version
default value: 2022-06-01

Attributes

data_policy_manifests

Instance depends on the API version:

policy_assignments

Instance depends on the API version:

policy_definitions

Instance depends on the API version:

policy_exemptions

Instance depends on the API version:

policy_set_definitions

Instance depends on the API version:

variable_values

Instance depends on the API version:

variables

Instance depends on the API version:

DEFAULT_API_VERSION 

DEFAULT_API_VERSION = '2022-06-01'

LATEST_PROFILE 

LATEST_PROFILE = azure.mgmt.resource.policy.PolicyClient latest