Reference documentation and code samples for the Google Cloud Sql Admin V1 Client class SqlActiveDirectoryConfig.
Active Directory configuration, relevant only for Cloud SQL for SQL Server.
Generated from protobuf message google.cloud.sql.v1.SqlActiveDirectoryConfig
Namespace
Google \ Cloud \ Sql \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ kind |
string
This is always sql#activeDirectoryConfig. |
↳ domain |
string
The name of the domain (e.g., mydomain.com). |
↳ mode |
int
Optional. The mode of the Active Directory configuration. |
↳ dns_servers |
array
Optional. Domain controller IPv4 addresses used to bootstrap Active Directory. |
↳ admin_credential_secret_name |
string
Optional. The secret manager key storing the administrator credential. (e.g., projects/{project}/secrets/{secret}). |
↳ organizational_unit |
string
Optional. The organizational unit distinguished name. This is the full hierarchical path to the organizational unit. |
getKind
This is always sql#activeDirectoryConfig.
| Returns | |
|---|---|
| Type | Description |
string |
|
setKind
This is always sql#activeDirectoryConfig.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDomain
The name of the domain (e.g., mydomain.com).
| Returns | |
|---|---|
| Type | Description |
string |
|
setDomain
The name of the domain (e.g., mydomain.com).
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMode
Optional. The mode of the Active Directory configuration.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type ActiveDirectoryMode. |
setMode
Optional. The mode of the Active Directory configuration.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type ActiveDirectoryMode. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDnsServers
Optional. Domain controller IPv4 addresses used to bootstrap Active Directory.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setDnsServers
Optional. Domain controller IPv4 addresses used to bootstrap Active Directory.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAdminCredentialSecretName
Optional. The secret manager key storing the administrator credential.
(e.g., projects/{project}/secrets/{secret}).
| Returns | |
|---|---|
| Type | Description |
string |
|
setAdminCredentialSecretName
Optional. The secret manager key storing the administrator credential.
(e.g., projects/{project}/secrets/{secret}).
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOrganizationalUnit
Optional. The organizational unit distinguished name. This is the full hierarchical path to the organizational unit.
| Returns | |
|---|---|
| Type | Description |
string |
|
setOrganizationalUnit
Optional. The organizational unit distinguished name. This is the full hierarchical path to the organizational unit.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|