Reference documentation and code samples for the Google Cloud Managed Identities V1 Client class Domain.
Represents a managed Microsoft Active Directory ___domain.
Generated from protobuf message google.cloud.managedidentities.v1.Domain
Namespace
Google \ Cloud \ ManagedIdentities \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. The unique name of the ___domain using the form: |
↳ labels |
array|Google\Protobuf\Internal\MapField
Optional. Resource labels that can contain user-provided metadata. |
↳ authorized_networks |
array
Optional. The full names of the Google Compute Engine networks the ___domain instance is connected to. Networks can be added using UpdateDomain. The ___domain is only available on networks listed in |
↳ reserved_ip_range |
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].[authorized_networks]. |
↳ locations |
array
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, |
↳ 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. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The time the instance was created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. The last update time. |
↳ state |
int
Output only. The current state of this ___domain. |
↳ status_message |
string
Output only. Additional information about the current status of this ___domain, if available. |
↳ trusts |
array<Trust>
Output only. The current trusts associated with the ___domain. |
getName
Required. The unique name of the ___domain using the form:
projects/{project_id}/locations/global/domains/{domain_name}.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Required. The unique name of the ___domain using the form:
projects/{project_id}/locations/global/domains/{domain_name}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLabels
Optional. Resource labels that can contain user-provided metadata.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setLabels
Optional. Resource labels that can contain user-provided metadata.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAuthorizedNetworks
Optional. The full names of the Google Compute Engine networks the ___domain instance is connected to. Networks can be added using UpdateDomain.
The ___domain is only available on networks listed in authorized_networks.
If CIDR subnets overlap between networks, ___domain creation will fail.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setAuthorizedNetworks
Optional. The full names of the Google Compute Engine networks the ___domain instance is connected to. Networks can be added using UpdateDomain.
The ___domain is only available on networks listed in authorized_networks.
If CIDR subnets overlap between networks, ___domain creation will fail.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReservedIpRange
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].[authorized_networks].
| Returns | |
|---|---|
| Type | Description |
string |
|
setReservedIpRange
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].[authorized_networks].
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLocations
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setLocations
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAdmin
Optional. The name of delegated administrator account used to perform
Active Directory operations. If not specified, setupadmin will be used.
| Returns | |
|---|---|
| Type | Description |
string |
|
setAdmin
Optional. The name of delegated administrator account used to perform
Active Directory operations. If not specified, setupadmin will be used.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFqdn
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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setFqdn
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. The time the instance was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time the instance was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. The last update time.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The last update time.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. The current state of this ___domain.
| Returns | |
|---|---|
| Type | Description |
int |
|
setState
Output only. The current state of this ___domain.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStatusMessage
Output only. Additional information about the current status of this ___domain, if available.
| Returns | |
|---|---|
| Type | Description |
string |
|
setStatusMessage
Output only. Additional information about the current status of this ___domain, if available.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTrusts
Output only. The current trusts associated with the ___domain.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setTrusts
Output only. The current trusts associated with the ___domain.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Trust>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|