public sealed class ManagedIdentitiesServiceClientImpl : ManagedIdentitiesServiceClient
Reference documentation and code samples for the Managed Service for Microsoft Active Directory v1 API class ManagedIdentitiesServiceClientImpl.
ManagedIdentitiesService client wrapper implementation, for convenient use.
Namespace
Google.Cloud.ManagedIdentities.V1Assembly
Google.Cloud.ManagedIdentities.V1.dll
Remarks
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.
Constructors
ManagedIdentitiesServiceClientImpl(ManagedIdentitiesServiceClient, ManagedIdentitiesServiceSettings, ILogger)
public ManagedIdentitiesServiceClientImpl(ManagedIdentitiesService.ManagedIdentitiesServiceClient grpcClient, ManagedIdentitiesServiceSettings settings, ILogger logger)
Constructs a client wrapper for the ManagedIdentitiesService service, with the specified gRPC client and settings.
Parameters | |
---|---|
Name | Description |
grpcClient | ManagedIdentitiesServiceManagedIdentitiesServiceClient The underlying gRPC client. |
settings | ManagedIdentitiesServiceSettings The base ManagedIdentitiesServiceSettings used within this client. |
logger | ILogger Optional ILogger to use within this client. |
Properties
AttachTrustOperationsClient
public override OperationsClient AttachTrustOperationsClient { get; }
The long-running operations client for AttachTrust
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
CreateMicrosoftAdDomainOperationsClient
public override OperationsClient CreateMicrosoftAdDomainOperationsClient { get; }
The long-running operations client for CreateMicrosoftAdDomain
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
DeleteDomainOperationsClient
public override OperationsClient DeleteDomainOperationsClient { get; }
The long-running operations client for DeleteDomain
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
DetachTrustOperationsClient
public override OperationsClient DetachTrustOperationsClient { get; }
The long-running operations client for DetachTrust
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
GrpcClient
public override ManagedIdentitiesService.ManagedIdentitiesServiceClient GrpcClient { get; }
The underlying gRPC ManagedIdentitiesService client
Property Value | |
---|---|
Type | Description |
ManagedIdentitiesServiceManagedIdentitiesServiceClient |
ReconfigureTrustOperationsClient
public override OperationsClient ReconfigureTrustOperationsClient { get; }
The long-running operations client for ReconfigureTrust
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
UpdateDomainOperationsClient
public override OperationsClient UpdateDomainOperationsClient { get; }
The long-running operations client for UpdateDomain
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
ValidateTrustOperationsClient
public override OperationsClient ValidateTrustOperationsClient { get; }
The long-running operations client for ValidateTrust
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
Methods
AttachTrust(AttachTrustRequest, CallSettings)
public override Operation<Domain, OpMetadata> AttachTrust(AttachTrustRequest request, CallSettings callSettings = null)
Adds an AD trust to a domain.
Parameters | |
---|---|
Name | Description |
request | AttachTrustRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
OperationDomainOpMetadata | The RPC response. |
AttachTrustAsync(AttachTrustRequest, CallSettings)
public override Task<Operation<Domain, OpMetadata>> AttachTrustAsync(AttachTrustRequest request, CallSettings callSettings = null)
Adds an AD trust to a domain.
Parameters | |
---|---|
Name | Description |
request | AttachTrustRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskOperationDomainOpMetadata | A Task containing the RPC response. |
CreateMicrosoftAdDomain(CreateMicrosoftAdDomainRequest, CallSettings)
public override Operation<Domain, OpMetadata> CreateMicrosoftAdDomain(CreateMicrosoftAdDomainRequest request, CallSettings callSettings = null)
Creates a Microsoft AD domain.
Parameters | |
---|---|
Name | Description |
request | CreateMicrosoftAdDomainRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
OperationDomainOpMetadata | The RPC response. |
CreateMicrosoftAdDomainAsync(CreateMicrosoftAdDomainRequest, CallSettings)
public override Task<Operation<Domain, OpMetadata>> CreateMicrosoftAdDomainAsync(CreateMicrosoftAdDomainRequest request, CallSettings callSettings = null)
Creates a Microsoft AD domain.
Parameters | |
---|---|
Name | Description |
request | CreateMicrosoftAdDomainRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskOperationDomainOpMetadata | A Task containing the RPC response. |
DeleteDomain(DeleteDomainRequest, CallSettings)
public override Operation<Empty, OpMetadata> DeleteDomain(DeleteDomainRequest request, CallSettings callSettings = null)
Deletes a domain.
Parameters | |
---|---|
Name | Description |
request | DeleteDomainRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
OperationEmptyOpMetadata | The RPC response. |
DeleteDomainAsync(DeleteDomainRequest, CallSettings)
public override Task<Operation<Empty, OpMetadata>> DeleteDomainAsync(DeleteDomainRequest request, CallSettings callSettings = null)
Deletes a domain.
Parameters | |
---|---|
Name | Description |
request | DeleteDomainRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskOperationEmptyOpMetadata | A Task containing the RPC response. |
DetachTrust(DetachTrustRequest, CallSettings)
public override Operation<Domain, OpMetadata> DetachTrust(DetachTrustRequest request, CallSettings callSettings = null)
Removes an AD trust.
Parameters | |
---|---|
Name | Description |
request | DetachTrustRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
OperationDomainOpMetadata | The RPC response. |
DetachTrustAsync(DetachTrustRequest, CallSettings)
public override Task<Operation<Domain, OpMetadata>> DetachTrustAsync(DetachTrustRequest request, CallSettings callSettings = null)
Removes an AD trust.
Parameters | |
---|---|
Name | Description |
request | DetachTrustRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskOperationDomainOpMetadata | A Task containing the RPC response. |
GetDomain(GetDomainRequest, CallSettings)
public override Domain GetDomain(GetDomainRequest request, CallSettings callSettings = null)
Gets information about a domain.
Parameters | |
---|---|
Name | Description |
request | GetDomainRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Domain | The RPC response. |
GetDomainAsync(GetDomainRequest, CallSettings)
public override Task<Domain> GetDomainAsync(GetDomainRequest request, CallSettings callSettings = null)
Gets information about a domain.
Parameters | |
---|---|
Name | Description |
request | GetDomainRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskDomain | A Task containing the RPC response. |
ListDomains(ListDomainsRequest, CallSettings)
public override PagedEnumerable<ListDomainsResponse, Domain> ListDomains(ListDomainsRequest request, CallSettings callSettings = null)
Lists domains in a project.
Parameters | |
---|---|
Name | Description |
request | ListDomainsRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListDomainsResponseDomain | A pageable sequence of Domain resources. |
ListDomainsAsync(ListDomainsRequest, CallSettings)
public override PagedAsyncEnumerable<ListDomainsResponse, Domain> ListDomainsAsync(ListDomainsRequest request, CallSettings callSettings = null)
Lists domains in a project.
Parameters | |
---|---|
Name | Description |
request | ListDomainsRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListDomainsResponseDomain | A pageable asynchronous sequence of Domain resources. |
ReconfigureTrust(ReconfigureTrustRequest, CallSettings)
public override Operation<Domain, OpMetadata> ReconfigureTrust(ReconfigureTrustRequest request, CallSettings callSettings = null)
Updates the DNS conditional forwarder.
Parameters | |
---|---|
Name | Description |
request | ReconfigureTrustRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
OperationDomainOpMetadata | The RPC response. |
ReconfigureTrustAsync(ReconfigureTrustRequest, CallSettings)
public override Task<Operation<Domain, OpMetadata>> ReconfigureTrustAsync(ReconfigureTrustRequest request, CallSettings callSettings = null)
Updates the DNS conditional forwarder.
Parameters | |
---|---|
Name | Description |
request | ReconfigureTrustRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskOperationDomainOpMetadata | A Task containing the RPC response. |
ResetAdminPassword(ResetAdminPasswordRequest, CallSettings)
public override ResetAdminPasswordResponse ResetAdminPassword(ResetAdminPasswordRequest request, CallSettings callSettings = null)
Resets a domain's administrator password.
Parameters | |
---|---|
Name | Description |
request | ResetAdminPasswordRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
ResetAdminPasswordResponse | The RPC response. |
ResetAdminPasswordAsync(ResetAdminPasswordRequest, CallSettings)
public override Task<ResetAdminPasswordResponse> ResetAdminPasswordAsync(ResetAdminPasswordRequest request, CallSettings callSettings = null)
Resets a domain's administrator password.
Parameters | |
---|---|
Name | Description |
request | ResetAdminPasswordRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskResetAdminPasswordResponse | A Task containing the RPC response. |
UpdateDomain(UpdateDomainRequest, CallSettings)
public override Operation<Domain, OpMetadata> UpdateDomain(UpdateDomainRequest request, CallSettings callSettings = null)
Updates the metadata and configuration of a domain.
Parameters | |
---|---|
Name | Description |
request | UpdateDomainRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
OperationDomainOpMetadata | The RPC response. |
UpdateDomainAsync(UpdateDomainRequest, CallSettings)
public override Task<Operation<Domain, OpMetadata>> UpdateDomainAsync(UpdateDomainRequest request, CallSettings callSettings = null)
Updates the metadata and configuration of a domain.
Parameters | |
---|---|
Name | Description |
request | UpdateDomainRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskOperationDomainOpMetadata | A Task containing the RPC response. |
ValidateTrust(ValidateTrustRequest, CallSettings)
public override Operation<Domain, OpMetadata> ValidateTrust(ValidateTrustRequest request, CallSettings callSettings = null)
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 | ValidateTrustRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
OperationDomainOpMetadata | The RPC response. |
ValidateTrustAsync(ValidateTrustRequest, CallSettings)
public override Task<Operation<Domain, OpMetadata>> ValidateTrustAsync(ValidateTrustRequest request, CallSettings callSettings = null)
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 | ValidateTrustRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskOperationDomainOpMetadata | A Task containing the RPC response. |