Class ManagedIdentitiesServiceClient (0.2.1)

ManagedIdentitiesServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.managedidentities_v1.services.managed_identities_service.transports.base.ManagedIdentitiesServiceTransport]] = None, 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>)

API Overview

The managedidentites.googleapis.com service implements the Google Cloud Managed Identites API for identity services (e.g. Microsoft Active Directory).

The Managed Identities service provides methods to manage (create/read/update/delete) domains, reset managed identities admin password, add/remove domain controllers in GCP regions and add/remove VPC peering.

Data Model

The Managed Identities service exposes the following resources:

Locations as global, named as follows: projects/{project_id}/locations/global.
Domains, named as follows: /projects/{project_id}/locations/global/domain/{domain_name}.

The {domain_name} refers to fully qualified domain name in the customer project e.g. mydomain.myorganization.com, with the following restrictions:

Must contain only lowercase letters, numbers, periods and hyphens.
Must start with a letter.
Must contain between 2-64 characters.
Must end with a number or a letter.
Must not start with period.
First segement length (mydomain form example above) shouldn't exceed 15 chars.
The last segment cannot be fully numeric.
Must be unique within the customer project.

Inheritance

builtins.object > ManagedIdentitiesServiceClient

Properties

transport

Returns the transport used by the client instance.

Returns

Type	Description
ManagedIdentitiesServiceTransport	The transport used by the client instance.

Methods

ManagedIdentitiesServiceClient

ManagedIdentitiesServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.managedidentities_v1.services.managed_identities_service.transports.base.ManagedIdentitiesServiceTransport]] = None, 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 managed identities service 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, ManagedIdentitiesServiceTransport]` The transport to use. If set to None, a transport is chosen automatically.
client_options	`google.api_core.client_options.ClientOptions` Custom options for the client. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.
client_info	`google.api_core.gapic_v1.client_info.ClientInfo` The client info used to send a user-agent string along with API requests. If `None`, then default info will be used. Generally, you only need to set this if you're developing your own client library.

Exceptions

Type	Description
google.auth.exceptions.MutualTLSChannelError	If mutual TLS transport creation failed for any reason.

attach_trust

attach_trust(request: Optional[google.cloud.managedidentities_v1.types.managed_identities_service.AttachTrustRequest] = None, *, name: Optional[str] = None, trust: Optional[google.cloud.managedidentities_v1.types.resource.Trust] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Adds an AD trust to a domain.

Parameters

Name	Description
request	`google.cloud.managedidentities_v1.types.AttachTrustRequest` The request object. Request message for AttachTrust
name	`str` Required. The resource domain name, project name and location using the form: `projects/{project_id}/locations/global/domains/{domain_name}` This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
trust	`google.cloud.managedidentities_v1.types.Trust` Required. The domain trust resource. This corresponds to the `trust` field on the `request` instance; if `request` is provided, this should not be set.
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.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be Domain Represents a managed Microsoft Active Directory domain.

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.

create_microsoft_ad_domain

create_microsoft_ad_domain(request: Optional[google.cloud.managedidentities_v1.types.managed_identities_service.CreateMicrosoftAdDomainRequest] = None, *, parent: Optional[str] = None, domain_name: Optional[str] = None, domain: Optional[google.cloud.managedidentities_v1.types.resource.Domain] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a Microsoft AD domain.

Parameters

Name	Description
request	`google.cloud.managedidentities_v1.types.CreateMicrosoftAdDomainRequest` The request object. Request message for CreateMicrosoftAdDomain
parent	`str` Required. The resource project name and location using the form: `projects/{project_id}/locations/global` This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
domain_name	`str` Required. The fully qualified domain name. e.g. mydomain.myorganization.com, with the following restrictions: - Must contain only lowercase letters, numbers, periods and hyphens. - Must start with a letter. - Must contain between 2-64 characters. - Must end with a number or a letter. - Must not start with period. - First segement length (mydomain form example above) shouldn't exceed 15 chars. - The last segment cannot be fully numeric. - Must be unique within the customer project. This corresponds to the `domain_name` field on the `request` instance; if `request` is provided, this should not be set.
domain	`google.cloud.managedidentities_v1.types.Domain` Required. A Managed Identity domain resource. This corresponds to the `domain` field on the `request` instance; if `request` is provided, this should not be set.
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.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be Domain Represents a managed Microsoft Active Directory domain.

delete_domain

delete_domain(request: Optional[google.cloud.managedidentities_v1.types.managed_identities_service.DeleteDomainRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a domain.

Parameters

Name	Description
request	`google.cloud.managedidentities_v1.types.DeleteDomainRequest` The request object. Request message for DeleteDomain
name	`str` Required. The domain resource name using the form: `projects/{project_id}/locations/global/domains/{domain_name}` This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
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.api_core.operation.Operation

An object representing a long-running operation. The result type for the operation will be `google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.

detach_trust

detach_trust(request: Optional[google.cloud.managedidentities_v1.types.managed_identities_service.DetachTrustRequest] = None, *, name: Optional[str] = None, trust: Optional[google.cloud.managedidentities_v1.types.resource.Trust] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Removes an AD trust.

Parameters

Name	Description
request	`google.cloud.managedidentities_v1.types.DetachTrustRequest` The request object. Request message for DetachTrust
name	`str` Required. The resource domain name, project name, and location using the form: `projects/{project_id}/locations/global/domains/{domain_name}` This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
trust	`google.cloud.managedidentities_v1.types.Trust` Required. The domain trust resource to removed. This corresponds to the `trust` field on the `request` instance; if `request` is provided, this should not be set.
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.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be Domain Represents a managed Microsoft Active Directory domain.

domain_path

domain_path(project: str, location: str, domain: str)

Returns a fully-qualified domain string.

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
ManagedIdentitiesServiceClient	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
ManagedIdentitiesServiceClient	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
ManagedIdentitiesServiceClient	The constructed client.

get_domain

get_domain(request: Optional[google.cloud.managedidentities_v1.types.managed_identities_service.GetDomainRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets information about a domain.

Parameters

Name	Description
request	`google.cloud.managedidentities_v1.types.GetDomainRequest` The request object. Request message for GetDomain
name	`str` Required. The domain resource name using the form: `projects/{project_id}/locations/global/domains/{domain_name}` This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
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.managedidentities_v1.types.Domain	Represents a managed Microsoft Active Directory domain.

list_domains

list_domains(request: Optional[google.cloud.managedidentities_v1.types.managed_identities_service.ListDomainsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists domains in a project.

Parameters

Name	Description
request	`google.cloud.managedidentities_v1.types.ListDomainsRequest` The request object. Request message for ListDomains
parent	`str` Required. The resource name of the domain location using the form: `projects/{project_id}/locations/global` This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
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.managedidentities_v1.services.managed_identities_service.pagers.ListDomainsPager	Response message for ListDomains 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_domain_path

parse_domain_path(path: str)

Parses a domain path into its component segments.

reconfigure_trust

reconfigure_trust(request: Optional[google.cloud.managedidentities_v1.types.managed_identities_service.ReconfigureTrustRequest] = None, *, name: Optional[str] = None, target_domain_name: Optional[str] = None, target_dns_ip_addresses: Optional[Sequence[str]] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates the DNS conditional forwarder.

Parameters

Name	Description
request	`google.cloud.managedidentities_v1.types.ReconfigureTrustRequest` The request object. Request message for ReconfigureTrust
name	`str` Required. The resource domain name, project name and location using the form: `projects/{project_id}/locations/global/domains/{domain_name}` This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
target_domain_name	`str` Required. The fully-qualified target domain name which will be in trust with current domain. This corresponds to the `target_domain_name` field on the `request` instance; if `request` is provided, this should not be set.
target_dns_ip_addresses	`Sequence[str]` Required. The target DNS server IP addresses to resolve the remote domain involved in the trust. This corresponds to the `target_dns_ip_addresses` field on the `request` instance; if `request` is provided, this should not be set.
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.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be Domain Represents a managed Microsoft Active Directory domain.

reset_admin_password

reset_admin_password(request: Optional[google.cloud.managedidentities_v1.types.managed_identities_service.ResetAdminPasswordRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Resets a domain's administrator password.

Parameters

Name	Description
request	`google.cloud.managedidentities_v1.types.ResetAdminPasswordRequest` The request object. Request message for ResetAdminPassword
name	`str` Required. The domain resource name using the form: `projects/{project_id}/locations/global/domains/{domain_name}` This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
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.managedidentities_v1.types.ResetAdminPasswordResponse	Response message for ResetAdminPassword

update_domain

update_domain(request: Optional[google.cloud.managedidentities_v1.types.managed_identities_service.UpdateDomainRequest] = None, *, domain: Optional[google.cloud.managedidentities_v1.types.resource.Domain] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates the metadata and configuration of a domain.

Parameters

Name	Description
request	`google.cloud.managedidentities_v1.types.UpdateDomainRequest` The request object. Request message for UpdateDomain
domain	`google.cloud.managedidentities_v1.types.Domain` Required. Domain message with updated fields. Only supported fields specified in update_mask are updated. This corresponds to the `domain` field on the `request` instance; if `request` is provided, this should not be set.
update_mask	`google.protobuf.field_mask_pb2.FieldMask` Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include fields from Domain: - `labels` - `locations` - `authorized_networks` This corresponds to the `update_mask` field on the `request` instance; if `request` is provided, this should not be set.
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.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be Domain Represents a managed Microsoft Active Directory domain.

validate_trust

validate_trust(request: Optional[google.cloud.managedidentities_v1.types.managed_identities_service.ValidateTrustRequest] = None, *, name: Optional[str] = None, trust: Optional[google.cloud.managedidentities_v1.types.resource.Trust] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Validates a trust state, that the target domain is reachable, and that the target domain is able to accept incoming trust requests.

Parameters

Name	Description
request	`google.cloud.managedidentities_v1.types.ValidateTrustRequest` The request object. Request message for ValidateTrust
name	`str` Required. The resource domain name, project name, and location using the form: `projects/{project_id}/locations/global/domains/{domain_name}` This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
trust	`google.cloud.managedidentities_v1.types.Trust` Required. The domain trust to validate trust state for. This corresponds to the `trust` field on the `request` instance; if `request` is provided, this should not be set.
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.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be Domain Represents a managed Microsoft Active Directory domain.