REST Resource: projects.locations.global.domains

Resource: Domain

Represents a managed Microsoft Active Directory ___domain. If the ___domain is being changed, it will be placed into the UPDATING state, which indicates that the resource is being reconciled. At this point, Get will reflect an intermediate state.

JSON representation 
{
  "name": string,
  "labels": {
    string: string,
    ...
  },
  "authorizedNetworks": [
    string
  ],
  "reservedIpRange": string,
  "locations": [
    string
  ],
  "admin": string,
  "fqdn": string,
  "createTime": string,
  "updateTime": string,
  "state": enum (State),
  "statusMessage": string,
  "trusts": [
    {
      object (Trust)
    }
  ],
  "auditLogsEnabled": boolean
}
Fields
name

string

Output only. The unique name of the ___domain using the form: projects/{projectId}/locations/global/domains/{domainName}.
labels

map (key: string, value: string)

Optional. Resource labels that can contain user-provided metadata.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
authorizedNetworks[]

string

Optional. The full names of the Google Compute Engine networks the ___domain instance is connected to. Networks can be added using domains.patch. The ___domain is only available on networks listed in authorizedNetworks. If CIDR subnets overlap between networks, ___domain creation will fail.
reservedIpRange

string

Required. The CIDR range of internal addresses that are reserved for this ___domain. Reserved networks must be /24 or larger. Ranges must be unique and non-overlapping with existing subnets in [Domain].[authorizedNetworks].
locations[]

string

Required. Locations where ___domain needs to be provisioned. [regions][compute/docs/regions-zones/] e.g. us-west1 or us-east4 Service supports up to 4 locations at once. Each ___location will use a /26 block.
admin

string

Optional. The name of delegated administrator account used to perform Active Directory operations. If not specified, setupadmin will be used.
fqdn

string

Output only. The fully-qualified ___domain name of the exposed ___domain used by clients to connect to the service. Similar to what would be chosen for an Active Directory set up on an internal network.
createTime

string (Timestamp format)

Output only. The time the instance was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. The last update time.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
state

enum (State)

Output only. The current state of this ___domain.
statusMessage

string

Output only. Additional information about the current status of this ___domain, if available.
trusts[]

object (Trust)

Output only. The current trusts associated with the ___domain.
auditLogsEnabled

boolean

Optional. Configuration for audit logs. True if audit logs are enabled, else false. Default is audit logs disabled.

State

Represents the different states of a managed ___domain.

Enums
STATE_UNSPECIFIED Not set.
CREATING The ___domain is being created.
READY The ___domain has been created and is fully usable.
UPDATING The ___domain's configuration is being updated.
DELETING The ___domain is being deleted.
REPAIRING The ___domain is being repaired and may be unusable. Details can be found in the statusMessage field.
PERFORMING_MAINTENANCE The ___domain is undergoing maintenance.
UNAVAILABLE The ___domain is not serving requests.

Trust

Represents a relationship between two domains. This allows a controller in one ___domain to authenticate a user in another ___domain.

JSON representation 
{
  "targetDomainName": string,
  "trustType": enum (TrustType),
  "trustDirection": enum (TrustDirection),
  "selectiveAuthentication": boolean,
  "targetDnsIpAddresses": [
    string
  ],
  "trustHandshakeSecret": string,
  "createTime": string,
  "updateTime": string,
  "state": enum (State),
  "stateDescription": string,
  "lastTrustHeartbeatTime": string
}
Fields
targetDomainName

string

The fully qualified target ___domain name which will be in trust with the current ___domain.
trustType

enum (TrustType)

The type of trust represented by the trust resource.
trustDirection

enum (TrustDirection)

The trust direction, which decides if the current ___domain is trusted, trusting, or both.
selectiveAuthentication

boolean

The trust authentication type, which decides whether the trusted side has forest/___domain wide access or selective access to an approved set of resources.
targetDnsIpAddresses[]

string

The target DNS server IP addresses which can resolve the remote ___domain involved in the trust.
trustHandshakeSecret

string

Input only. The trust secret used for the handshake with the target ___domain. It will not be stored.
createTime

string (Timestamp format)

Output only. The time the instance was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. The last update time.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
state

enum (State)

Output only. The current state of the trust.
stateDescription

string

Output only. Additional information about the current state of the trust, if available.
lastTrustHeartbeatTime

string (Timestamp format)

Output only. The last heartbeat time when the trust was known to be connected.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

TrustType

Represents the different inter-forest trust types.

Enums
TRUST_TYPE_UNSPECIFIED Not set.
FOREST The forest trust.
EXTERNAL The external ___domain trust.

TrustDirection

Represents the direction of trust. See System.DirectoryServices.ActiveDirectory.TrustDirection for more information.

Enums
TRUST_DIRECTION_UNSPECIFIED Not set.
INBOUND The inbound direction represents the trusting side.
OUTBOUND The outboud direction represents the trusted side.
BIDIRECTIONAL The bidirectional direction represents the trusted / trusting side.

State

Represents the different states of a ___domain trust.

Enums
STATE_UNSPECIFIED Not set.
CREATING The ___domain trust is being created.
UPDATING The ___domain trust is being updated.
DELETING The ___domain trust is being deleted.
CONNECTED The ___domain trust is connected.
DISCONNECTED The ___domain trust is disconnected.

Methods

attachTrust

 Adds an AD trust to a ___domain.

checkMigrationPermission

 CheckMigrationPermission API gets the current state of DomainMigration

create

 Creates a Microsoft AD ___domain.

delete

 Deletes a ___domain.

detachTrust

 Removes an AD trust.

disableMigration

 Disable Domain Migration

domainJoinMachine

 DomainJoinMachine API joins a Compute Engine VM to the ___domain

enableMigration

 Enable Domain Migration

extendSchema

 Extend Schema for Domain

get

 Gets information about a ___domain.

getIamPolicy

 Gets the access control policy for a resource.

getLdapssettings

 Gets the ___domain ldaps settings.

list

 Lists domains in a project.

patch

 Updates the metadata and configuration of a ___domain.

reconfigureTrust

 Updates the DNS conditional forwarder.

resetAdminPassword

 Resets a ___domain's administrator password.

restore

 RestoreBackup restores ___domain mentioned in the RestoreBackupRequest

setIamPolicy

 Sets the access control policy on the specified resource.

testIamPermissions

 Returns permissions that a caller has on the specified resource.

updateLdapssettings

 Patches a single ldaps settings.

validateTrust

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