management_dns_zone_bindings
Creates, updates, deletes, gets or lists a management_dns_zone_bindings
resource.
Overview
Name | management_dns_zone_bindings |
Type | Resource |
Id | google.vmwareengine.management_dns_zone_bindings |
Fields
The following fields are returned by SELECT
queries:
- get
- list
Successful response
Name | Datatype | Description |
---|---|---|
name | string | Output only. The resource name of this binding. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud/managementDnsZoneBindings/my-management-dns-zone-binding |
createTime | string (google-datetime) | Output only. Creation time of this resource. |
description | string | User-provided description for this resource. |
state | string | Output only. The state of the resource. |
uid | string | Output only. System-generated unique identifier for the resource. |
updateTime | string (google-datetime) | Output only. Last update time of this resource. |
vmwareEngineNetwork | string | Network to bind is a VMware Engine network. Specify the name in the following form for VMware engine network: projects/{project}/locations/global/vmwareEngineNetworks/{vmware_engine_network_id} . {project} can either be a project number or a project ID. |
vpcNetwork | string | Network to bind is a standard consumer VPC. Specify the name in the following form for consumer VPC network: projects/{project}/global/networks/{network_id} . {project} can either be a project number or a project ID. |
Successful response
Name | Datatype | Description |
---|---|---|
name | string | Output only. The resource name of this binding. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud/managementDnsZoneBindings/my-management-dns-zone-binding |
createTime | string (google-datetime) | Output only. Creation time of this resource. |
description | string | User-provided description for this resource. |
state | string | Output only. The state of the resource. |
uid | string | Output only. System-generated unique identifier for the resource. |
updateTime | string (google-datetime) | Output only. Last update time of this resource. |
vmwareEngineNetwork | string | Network to bind is a VMware Engine network. Specify the name in the following form for VMware engine network: projects/{project}/locations/global/vmwareEngineNetworks/{vmware_engine_network_id} . {project} can either be a project number or a project ID. |
vpcNetwork | string | Network to bind is a standard consumer VPC. Specify the name in the following form for consumer VPC network: projects/{project}/global/networks/{network_id} . {project} can either be a project number or a project ID. |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get | select | projectsId , locationsId , privateCloudsId , managementDnsZoneBindingsId | Retrieves a 'ManagementDnsZoneBinding' resource by its resource name. | |
list | select | projectsId , locationsId , privateCloudsId | pageSize , pageToken , filter , orderBy | Lists Consumer VPCs bound to Management DNS Zone of a given private cloud. |
create | insert | projectsId , locationsId , privateCloudsId | managementDnsZoneBindingId , requestId | Creates a new ManagementDnsZoneBinding resource in a private cloud. This RPC creates the DNS binding and the resource that represents the DNS binding of the consumer VPC network to the management DNS zone. A management DNS zone is the Cloud DNS cross-project binding zone that VMware Engine creates for each private cloud. It contains FQDNs and corresponding IP addresses for the private cloud's ESXi hosts and management VM appliances like vCenter and NSX Manager. |
patch | update | projectsId , locationsId , privateCloudsId , managementDnsZoneBindingsId | updateMask , requestId | Updates a ManagementDnsZoneBinding resource. Only fields specified in update_mask are applied. |
delete | delete | projectsId , locationsId , privateCloudsId , managementDnsZoneBindingsId | requestId | Deletes a ManagementDnsZoneBinding resource. When a management DNS zone binding is deleted, the corresponding consumer VPC network is no longer bound to the management DNS zone. |
repair | exec | projectsId , locationsId , privateCloudsId , managementDnsZoneBindingsId | Retries to create a ManagementDnsZoneBinding resource that is in failed state. |
Parameters
Parameters can be passed in the WHERE
clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
Name | Datatype | Description |
---|---|---|
locationsId | string | |
managementDnsZoneBindingsId | string | |
privateCloudsId | string | |
projectsId | string | |
filter | string | |
managementDnsZoneBindingId | string | |
orderBy | string | |
pageSize | integer (int32) | |
pageToken | string | |
requestId | string | |
updateMask | string (google-fieldmask) |
SELECT
examples
- get
- list
Retrieves a 'ManagementDnsZoneBinding' resource by its resource name.
SELECT
name,
createTime,
description,
state,
uid,
updateTime,
vmwareEngineNetwork,
vpcNetwork
FROM google.vmwareengine.management_dns_zone_bindings
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND privateCloudsId = '{{ privateCloudsId }}' -- required
AND managementDnsZoneBindingsId = '{{ managementDnsZoneBindingsId }}' -- required;
Lists Consumer VPCs bound to Management DNS Zone of a given private cloud.
SELECT
name,
createTime,
description,
state,
uid,
updateTime,
vmwareEngineNetwork,
vpcNetwork
FROM google.vmwareengine.management_dns_zone_bindings
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND privateCloudsId = '{{ privateCloudsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';
INSERT
examples
- create
- Manifest
Creates a new ManagementDnsZoneBinding
resource in a private cloud. This RPC creates the DNS binding and the resource that represents the DNS binding of the consumer VPC network to the management DNS zone. A management DNS zone is the Cloud DNS cross-project binding zone that VMware Engine creates for each private cloud. It contains FQDNs and corresponding IP addresses for the private cloud's ESXi hosts and management VM appliances like vCenter and NSX Manager.
INSERT INTO google.vmwareengine.management_dns_zone_bindings (
data__description,
data__vpcNetwork,
data__vmwareEngineNetwork,
projectsId,
locationsId,
privateCloudsId,
managementDnsZoneBindingId,
requestId
)
SELECT
'{{ description }}',
'{{ vpcNetwork }}',
'{{ vmwareEngineNetwork }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ privateCloudsId }}',
'{{ managementDnsZoneBindingId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;
# Description fields are for documentation purposes
- name: management_dns_zone_bindings
props:
- name: projectsId
value: string
description: Required parameter for the management_dns_zone_bindings resource.
- name: locationsId
value: string
description: Required parameter for the management_dns_zone_bindings resource.
- name: privateCloudsId
value: string
description: Required parameter for the management_dns_zone_bindings resource.
- name: description
value: string
description: >
User-provided description for this resource.
- name: vpcNetwork
value: string
description: >
Network to bind is a standard consumer VPC. Specify the name in the following form for consumer VPC network: `projects/{project}/global/networks/{network_id}`. `{project}` can either be a project number or a project ID.
- name: vmwareEngineNetwork
value: string
description: >
Network to bind is a VMware Engine network. Specify the name in the following form for VMware engine network: `projects/{project}/locations/global/vmwareEngineNetworks/{vmware_engine_network_id}`. `{project}` can either be a project number or a project ID.
- name: managementDnsZoneBindingId
value: string
- name: requestId
value: string
UPDATE
examples
- patch
Updates a ManagementDnsZoneBinding
resource. Only fields specified in update_mask
are applied.
UPDATE google.vmwareengine.management_dns_zone_bindings
SET
data__description = '{{ description }}',
data__vpcNetwork = '{{ vpcNetwork }}',
data__vmwareEngineNetwork = '{{ vmwareEngineNetwork }}'
WHERE
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND privateCloudsId = '{{ privateCloudsId }}' --required
AND managementDnsZoneBindingsId = '{{ managementDnsZoneBindingsId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
RETURNING
name,
done,
error,
metadata,
response;
DELETE
examples
- delete
Deletes a ManagementDnsZoneBinding
resource. When a management DNS zone binding is deleted, the corresponding consumer VPC network is no longer bound to the management DNS zone.
DELETE FROM google.vmwareengine.management_dns_zone_bindings
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND privateCloudsId = '{{ privateCloudsId }}' --required
AND managementDnsZoneBindingsId = '{{ managementDnsZoneBindingsId }}' --required
AND requestId = '{{ requestId }}';
Lifecycle Methods
- repair
Retries to create a ManagementDnsZoneBinding
resource that is in failed state.
EXEC google.vmwareengine.management_dns_zone_bindings.repair
@projectsId='{{ projectsId }}' --required,
@locationsId='{{ locationsId }}' --required,
@privateCloudsId='{{ privateCloudsId }}' --required,
@managementDnsZoneBindingsId='{{ managementDnsZoneBindingsId }}' --required
@@json=
'{
"requestId": "{{ requestId }}"
}';