OrgPolicyAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.orgpolicy_v2.services.org_policy.transports.base.OrgPolicyTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
An interface for managing organization policies.
The Cloud Org Policy service provides a simple mechanism for organizations to restrict the allowed configurations across their entire Cloud Resource hierarchy.
You can use a policy
to configure restrictions in Cloud
resources. For example, you can enforce a policy
that restricts
which Google Cloud Platform APIs can be activated in a certain part
of your resource hierarchy, or prevents serial port access to VM
instances in a particular folder.
Policies
are inherited down through the resource hierarchy. A
policy
applied to a parent resource automatically applies to all
its child resources unless overridden with a policy
lower in the
hierarchy.
A constraint
defines an aspect of a resource's configuration
that can be controlled by an organization's policy administrator.
Policies
are a collection of constraints
that defines their
allowable configuration on a particular resource and its child
resources.
Properties
transport
Returns the transport used by the client instance.
Returns | |
---|---|
Type | Description |
OrgPolicyTransport | The transport used by the client instance. |
Methods
OrgPolicyAsyncClient
OrgPolicyAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.orgpolicy_v2.services.org_policy.transports.base.OrgPolicyTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Instantiates the org policy client.
Parameters | |
---|---|
Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Union[str,
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
ClientOptions
Custom options for the client. It won't take effect if a |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTlsChannelError | If mutual TLS transport creation failed for any reason. |
common_billing_account_path
common_billing_account_path(billing_account: str)
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)
Returns a fully-qualified project string.
constraint_path
constraint_path(project: str, constraint: str)
Returns a fully-qualified constraint string.
create_policy
create_policy(request: Optional[Union[google.cloud.orgpolicy_v2.types.orgpolicy.CreatePolicyRequest, dict]] = None, *, parent: Optional[str] = None, policy: Optional[google.cloud.orgpolicy_v2.types.orgpolicy.Policy] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates a Policy.
Returns a google.rpc.Status
with
google.rpc.Code.NOT_FOUND
if the constraint does not exist.
Returns a google.rpc.Status
with
google.rpc.Code.ALREADY_EXISTS
if the policy already exists
on the given Cloud resource.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.orgpolicy_v2.types.CreatePolicyRequest, dict]
The request object. The request sent to the [CreatePolicyRequest] [google.cloud.orgpolicy.v2.OrgPolicy.CreatePolicy] method. |
parent |
Required. The Cloud resource that will parent the new Policy. Must be in one of the following forms: - |
policy |
Policy
Required. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.orgpolicy_v2.types.Policy | Defines a Cloud Organization Policy which is used to specify Constraints for configurations of Cloud Platform resources. |
delete_policy
delete_policy(request: Optional[Union[google.cloud.orgpolicy_v2.types.orgpolicy.DeletePolicyRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Deletes a Policy.
Returns a google.rpc.Status
with
google.rpc.Code.NOT_FOUND
if the constraint or Org Policy
does not exist.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.orgpolicy_v2.types.DeletePolicyRequest, dict]
The request object. The request sent to the [DeletePolicy] [google.cloud.orgpolicy.v2.OrgPolicy.DeletePolicy] method. |
name |
Required. Name of the policy to delete. See |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
OrgPolicyAsyncClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
Parameter | |
---|---|
Name | Description |
info |
dict
The service account private key info. |
Returns | |
---|---|
Type | Description |
OrgPolicyAsyncClient | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
OrgPolicyAsyncClient | The constructed client. |
get_effective_policy
get_effective_policy(request: Optional[Union[google.cloud.orgpolicy_v2.types.orgpolicy.GetEffectivePolicyRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Gets the effective Policy
on a resource. This is the result
of merging Policies
in the resource hierarchy and evaluating
conditions. The returned Policy
will not have an etag
or
condition
set because it is a computed Policy
across
multiple resources. Subtrees of Resource Manager resource
hierarchy with 'under:' prefix will not be expanded.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.orgpolicy_v2.types.GetEffectivePolicyRequest, dict]
The request object. The request sent to the [GetEffectivePolicy] [google.cloud.orgpolicy.v2.OrgPolicy.GetEffectivePolicy] method. |
name |
Required. The effective policy to compute. See |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.orgpolicy_v2.types.Policy | Defines a Cloud Organization Policy which is used to specify Constraints for configurations of Cloud Platform resources. |
get_policy
get_policy(request: Optional[Union[google.cloud.orgpolicy_v2.types.orgpolicy.GetPolicyRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Gets a Policy
on a resource.
If no Policy
is set on the resource, NOT_FOUND is returned.
The etag
value can be used with UpdatePolicy()
to update
a Policy
during read-modify-write.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.orgpolicy_v2.types.GetPolicyRequest, dict]
The request object. The request sent to the [GetPolicy] [google.cloud.orgpolicy.v2.OrgPolicy.GetPolicy] method. |
name |
Required. Resource name of the policy. See |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.orgpolicy_v2.types.Policy | Defines a Cloud Organization Policy which is used to specify Constraints for configurations of Cloud Platform resources. |
get_transport_class
get_transport_class()
Returns an appropriate transport class.
list_constraints
list_constraints(request: Optional[Union[google.cloud.orgpolicy_v2.types.orgpolicy.ListConstraintsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists Constraints
that could be applied on the specified
resource.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.orgpolicy_v2.types.ListConstraintsRequest, dict]
The request object. The request sent to the [ListConstraints] [google.cloud.orgpolicy.v2.OrgPolicy.ListConstraints] method. |
parent |
Required. The Cloud resource that parents the constraint. Must be in one of the following forms: - |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.orgpolicy_v2.services.org_policy.pagers.ListConstraintsAsyncPager | The response returned from the [ListConstraints] [google.cloud.orgpolicy.v2.OrgPolicy.ListConstraints] method. Iterating over this object will yield results and resolve additional pages automatically. |
list_policies
list_policies(request: Optional[Union[google.cloud.orgpolicy_v2.types.orgpolicy.ListPoliciesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Retrieves all of the Policies
that exist on a particular
resource.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.orgpolicy_v2.types.ListPoliciesRequest, dict]
The request object. The request sent to the [ListPolicies] [google.cloud.orgpolicy.v2.OrgPolicy.ListPolicies] method. |
parent |
Required. The target Cloud resource that parents the set of constraints and policies that will be returned from this call. Must be in one of the following forms: - |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.orgpolicy_v2.services.org_policy.pagers.ListPoliciesAsyncPager | The response returned from the [ListPolicies] [google.cloud.orgpolicy.v2.OrgPolicy.ListPolicies] method. It will be empty if no Policies are set on the resource. Iterating over this object will yield results and resolve additional pages automatically. |
parse_common_billing_account_path
parse_common_billing_account_path(path: str)
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)
Parse a project path into its component segments.
parse_constraint_path
parse_constraint_path(path: str)
Parses a constraint path into its component segments.
parse_policy_path
parse_policy_path(path: str)
Parses a policy path into its component segments.
policy_path
policy_path(project: str, policy: str)
Returns a fully-qualified policy string.
update_policy
update_policy(request: Optional[Union[google.cloud.orgpolicy_v2.types.orgpolicy.UpdatePolicyRequest, dict]] = None, *, policy: Optional[google.cloud.orgpolicy_v2.types.orgpolicy.Policy] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Updates a Policy.
Returns a google.rpc.Status
with
google.rpc.Code.NOT_FOUND
if the constraint or the policy do
not exist. Returns a google.rpc.Status
with
google.rpc.Code.ABORTED
if the etag supplied in the request
does not match the persisted etag of the policy
Note: the supplied policy will perform a full overwrite of all fields.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.orgpolicy_v2.types.UpdatePolicyRequest, dict]
The request object. The request sent to the [UpdatePolicyRequest] [google.cloud.orgpolicy.v2.OrgPolicy.UpdatePolicy] method. |
policy |
Policy
Required. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.orgpolicy_v2.types.Policy | Defines a Cloud Organization Policy which is used to specify Constraints for configurations of Cloud Platform resources. |