Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

VMwareEngine

import { VMwareEngine } from "https://googleapis.deno.dev/v1/vmwareengine:v1.ts";

The Google VMware Engine API lets you programmatically manage VMware environments.

class VMwareEngine {
constructor(client?: CredentialsClient, baseUrl?: string);
async projectsLocationsDnsBindPermissionGrant(name: string, req: GrantDnsBindPermissionRequest): Promise<Operation>;
async projectsLocationsDnsBindPermissionRevoke(name: string, req: RevokeDnsBindPermissionRequest): Promise<Operation>;
async projectsLocationsGet(name: string): Promise<Location>;
async projectsLocationsGetDnsBindPermission(name: string): Promise<DnsBindPermission>;
async projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>;
async projectsLocationsNetworkPeeringsCreate(
parent: string,
req: NetworkPeering,
opts?: ProjectsLocationsNetworkPeeringsCreateOptions,
): Promise<Operation>;
async projectsLocationsNetworkPeeringsDelete(name: string, opts?: ProjectsLocationsNetworkPeeringsDeleteOptions): Promise<Operation>;
async projectsLocationsNetworkPeeringsGet(name: string): Promise<NetworkPeering>;
async projectsLocationsNetworkPeeringsList(parent: string, opts?: ProjectsLocationsNetworkPeeringsListOptions): Promise<ListNetworkPeeringsResponse>;
async projectsLocationsNetworkPeeringsPatch(
name: string,
req: NetworkPeering,
opts?: ProjectsLocationsNetworkPeeringsPatchOptions,
): Promise<Operation>;
async projectsLocationsNetworkPeeringsPeeringRoutesList(parent: string, opts?: ProjectsLocationsNetworkPeeringsPeeringRoutesListOptions): Promise<ListPeeringRoutesResponse>;
async projectsLocationsNetworkPoliciesCreate(
parent: string,
req: NetworkPolicy,
opts?: ProjectsLocationsNetworkPoliciesCreateOptions,
): Promise<Operation>;
async projectsLocationsNetworkPoliciesDelete(name: string, opts?: ProjectsLocationsNetworkPoliciesDeleteOptions): Promise<Operation>;
async projectsLocationsNetworkPoliciesExternalAccessRulesCreate(
parent: string,
req: ExternalAccessRule,
opts?: ProjectsLocationsNetworkPoliciesExternalAccessRulesCreateOptions,
): Promise<Operation>;
async projectsLocationsNetworkPoliciesExternalAccessRulesDelete(name: string, opts?: ProjectsLocationsNetworkPoliciesExternalAccessRulesDeleteOptions): Promise<Operation>;
async projectsLocationsNetworkPoliciesExternalAccessRulesGet(name: string): Promise<ExternalAccessRule>;
async projectsLocationsNetworkPoliciesExternalAccessRulesList(parent: string, opts?: ProjectsLocationsNetworkPoliciesExternalAccessRulesListOptions): Promise<ListExternalAccessRulesResponse>;
async projectsLocationsNetworkPoliciesExternalAccessRulesPatch(
name: string,
req: ExternalAccessRule,
opts?: ProjectsLocationsNetworkPoliciesExternalAccessRulesPatchOptions,
): Promise<Operation>;
async projectsLocationsNetworkPoliciesFetchExternalAddresses(networkPolicy: string, opts?: ProjectsLocationsNetworkPoliciesFetchExternalAddressesOptions): Promise<FetchNetworkPolicyExternalAddressesResponse>;
async projectsLocationsNetworkPoliciesGet(name: string): Promise<NetworkPolicy>;
async projectsLocationsNetworkPoliciesList(parent: string, opts?: ProjectsLocationsNetworkPoliciesListOptions): Promise<ListNetworkPoliciesResponse>;
async projectsLocationsNetworkPoliciesPatch(
name: string,
req: NetworkPolicy,
opts?: ProjectsLocationsNetworkPoliciesPatchOptions,
): Promise<Operation>;
async projectsLocationsNodeTypesGet(name: string): Promise<NodeType>;
async projectsLocationsNodeTypesList(parent: string, opts?: ProjectsLocationsNodeTypesListOptions): Promise<ListNodeTypesResponse>;
async projectsLocationsOperationsDelete(name: string): Promise<Empty>;
async projectsLocationsOperationsGet(name: string): Promise<Operation>;
async projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>;
async projectsLocationsPrivateCloudsClustersCreate(
parent: string,
req: Cluster,
opts?: ProjectsLocationsPrivateCloudsClustersCreateOptions,
): Promise<Operation>;
async projectsLocationsPrivateCloudsClustersDelete(name: string, opts?: ProjectsLocationsPrivateCloudsClustersDeleteOptions): Promise<Operation>;
async projectsLocationsPrivateCloudsClustersGet(name: string): Promise<Cluster>;
async projectsLocationsPrivateCloudsClustersGetIamPolicy(resource: string, opts?: ProjectsLocationsPrivateCloudsClustersGetIamPolicyOptions): Promise<Policy>;
async projectsLocationsPrivateCloudsClustersList(parent: string, opts?: ProjectsLocationsPrivateCloudsClustersListOptions): Promise<ListClustersResponse>;
async projectsLocationsPrivateCloudsClustersNodesGet(name: string): Promise<Node>;
async projectsLocationsPrivateCloudsClustersNodesList(parent: string, opts?: ProjectsLocationsPrivateCloudsClustersNodesListOptions): Promise<ListNodesResponse>;
async projectsLocationsPrivateCloudsClustersPatch(
name: string,
req: Cluster,
opts?: ProjectsLocationsPrivateCloudsClustersPatchOptions,
): Promise<Operation>;
async projectsLocationsPrivateCloudsClustersSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;
async projectsLocationsPrivateCloudsClustersTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;
async projectsLocationsPrivateCloudsCreate(
parent: string,
req: PrivateCloud,
opts?: ProjectsLocationsPrivateCloudsCreateOptions,
): Promise<Operation>;
async projectsLocationsPrivateCloudsDelete(name: string, opts?: ProjectsLocationsPrivateCloudsDeleteOptions): Promise<Operation>;
async projectsLocationsPrivateCloudsExternalAddressesCreate(
parent: string,
req: ExternalAddress,
opts?: ProjectsLocationsPrivateCloudsExternalAddressesCreateOptions,
): Promise<Operation>;
async projectsLocationsPrivateCloudsExternalAddressesDelete(name: string, opts?: ProjectsLocationsPrivateCloudsExternalAddressesDeleteOptions): Promise<Operation>;
async projectsLocationsPrivateCloudsExternalAddressesGet(name: string): Promise<ExternalAddress>;
async projectsLocationsPrivateCloudsExternalAddressesList(parent: string, opts?: ProjectsLocationsPrivateCloudsExternalAddressesListOptions): Promise<ListExternalAddressesResponse>;
async projectsLocationsPrivateCloudsExternalAddressesPatch(
name: string,
req: ExternalAddress,
opts?: ProjectsLocationsPrivateCloudsExternalAddressesPatchOptions,
): Promise<Operation>;
async projectsLocationsPrivateCloudsGet(name: string): Promise<PrivateCloud>;
async projectsLocationsPrivateCloudsGetDnsForwarding(name: string): Promise<DnsForwarding>;
async projectsLocationsPrivateCloudsGetIamPolicy(resource: string, opts?: ProjectsLocationsPrivateCloudsGetIamPolicyOptions): Promise<Policy>;
async projectsLocationsPrivateCloudsHcxActivationKeysCreate(
parent: string,
req: HcxActivationKey,
opts?: ProjectsLocationsPrivateCloudsHcxActivationKeysCreateOptions,
): Promise<Operation>;
async projectsLocationsPrivateCloudsHcxActivationKeysGet(name: string): Promise<HcxActivationKey>;
async projectsLocationsPrivateCloudsHcxActivationKeysGetIamPolicy(resource: string, opts?: ProjectsLocationsPrivateCloudsHcxActivationKeysGetIamPolicyOptions): Promise<Policy>;
async projectsLocationsPrivateCloudsHcxActivationKeysList(parent: string, opts?: ProjectsLocationsPrivateCloudsHcxActivationKeysListOptions): Promise<ListHcxActivationKeysResponse>;
async projectsLocationsPrivateCloudsHcxActivationKeysSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;
async projectsLocationsPrivateCloudsHcxActivationKeysTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;
async projectsLocationsPrivateCloudsList(parent: string, opts?: ProjectsLocationsPrivateCloudsListOptions): Promise<ListPrivateCloudsResponse>;
async projectsLocationsPrivateCloudsLoggingServersCreate(
parent: string,
req: LoggingServer,
opts?: ProjectsLocationsPrivateCloudsLoggingServersCreateOptions,
): Promise<Operation>;
async projectsLocationsPrivateCloudsLoggingServersDelete(name: string, opts?: ProjectsLocationsPrivateCloudsLoggingServersDeleteOptions): Promise<Operation>;
async projectsLocationsPrivateCloudsLoggingServersGet(name: string): Promise<LoggingServer>;
async projectsLocationsPrivateCloudsLoggingServersList(parent: string, opts?: ProjectsLocationsPrivateCloudsLoggingServersListOptions): Promise<ListLoggingServersResponse>;
async projectsLocationsPrivateCloudsLoggingServersPatch(
name: string,
req: LoggingServer,
opts?: ProjectsLocationsPrivateCloudsLoggingServersPatchOptions,
): Promise<Operation>;
async projectsLocationsPrivateCloudsManagementDnsZoneBindingsCreate(
parent: string,
req: ManagementDnsZoneBinding,
opts?: ProjectsLocationsPrivateCloudsManagementDnsZoneBindingsCreateOptions,
): Promise<Operation>;
async projectsLocationsPrivateCloudsManagementDnsZoneBindingsDelete(name: string, opts?: ProjectsLocationsPrivateCloudsManagementDnsZoneBindingsDeleteOptions): Promise<Operation>;
async projectsLocationsPrivateCloudsManagementDnsZoneBindingsGet(name: string): Promise<ManagementDnsZoneBinding>;
async projectsLocationsPrivateCloudsManagementDnsZoneBindingsList(parent: string, opts?: ProjectsLocationsPrivateCloudsManagementDnsZoneBindingsListOptions): Promise<ListManagementDnsZoneBindingsResponse>;
async projectsLocationsPrivateCloudsManagementDnsZoneBindingsPatch(
name: string,
req: ManagementDnsZoneBinding,
opts?: ProjectsLocationsPrivateCloudsManagementDnsZoneBindingsPatchOptions,
): Promise<Operation>;
async projectsLocationsPrivateCloudsManagementDnsZoneBindingsRepair(name: string, req: RepairManagementDnsZoneBindingRequest): Promise<Operation>;
async projectsLocationsPrivateCloudsPatch(
name: string,
req: PrivateCloud,
opts?: ProjectsLocationsPrivateCloudsPatchOptions,
): Promise<Operation>;
async projectsLocationsPrivateCloudsResetNsxCredentials(privateCloud: string, req: ResetNsxCredentialsRequest): Promise<Operation>;
async projectsLocationsPrivateCloudsResetVcenterCredentials(privateCloud: string, req: ResetVcenterCredentialsRequest): Promise<Operation>;
async projectsLocationsPrivateCloudsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;
async projectsLocationsPrivateCloudsShowNsxCredentials(privateCloud: string): Promise<Credentials>;
async projectsLocationsPrivateCloudsShowVcenterCredentials(privateCloud: string, opts?: ProjectsLocationsPrivateCloudsShowVcenterCredentialsOptions): Promise<Credentials>;
async projectsLocationsPrivateCloudsSubnetsGet(name: string): Promise<Subnet>;
async projectsLocationsPrivateCloudsSubnetsList(parent: string, opts?: ProjectsLocationsPrivateCloudsSubnetsListOptions): Promise<ListSubnetsResponse>;
async projectsLocationsPrivateCloudsSubnetsPatch(
name: string,
req: Subnet,
opts?: ProjectsLocationsPrivateCloudsSubnetsPatchOptions,
): Promise<Operation>;
async projectsLocationsPrivateCloudsTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;
async projectsLocationsPrivateCloudsUndelete(name: string, req: UndeletePrivateCloudRequest): Promise<Operation>;
async projectsLocationsPrivateCloudsUpdateDnsForwarding(
name: string,
req: DnsForwarding,
opts?: ProjectsLocationsPrivateCloudsUpdateDnsForwardingOptions,
): Promise<Operation>;
async projectsLocationsPrivateConnectionsCreate(
parent: string,
req: PrivateConnection,
opts?: ProjectsLocationsPrivateConnectionsCreateOptions,
): Promise<Operation>;
async projectsLocationsPrivateConnectionsDelete(name: string, opts?: ProjectsLocationsPrivateConnectionsDeleteOptions): Promise<Operation>;
async projectsLocationsPrivateConnectionsGet(name: string): Promise<PrivateConnection>;
async projectsLocationsPrivateConnectionsList(parent: string, opts?: ProjectsLocationsPrivateConnectionsListOptions): Promise<ListPrivateConnectionsResponse>;
async projectsLocationsPrivateConnectionsPatch(
name: string,
req: PrivateConnection,
opts?: ProjectsLocationsPrivateConnectionsPatchOptions,
): Promise<Operation>;
async projectsLocationsPrivateConnectionsPeeringRoutesList(parent: string, opts?: ProjectsLocationsPrivateConnectionsPeeringRoutesListOptions): Promise<ListPrivateConnectionPeeringRoutesResponse>;
async projectsLocationsVmwareEngineNetworksCreate(
parent: string,
req: VmwareEngineNetwork,
opts?: ProjectsLocationsVmwareEngineNetworksCreateOptions,
): Promise<Operation>;
async projectsLocationsVmwareEngineNetworksDelete(name: string, opts?: ProjectsLocationsVmwareEngineNetworksDeleteOptions): Promise<Operation>;
async projectsLocationsVmwareEngineNetworksGet(name: string): Promise<VmwareEngineNetwork>;
async projectsLocationsVmwareEngineNetworksList(parent: string, opts?: ProjectsLocationsVmwareEngineNetworksListOptions): Promise<ListVmwareEngineNetworksResponse>;
async projectsLocationsVmwareEngineNetworksPatch(
name: string,
req: VmwareEngineNetwork,
opts?: ProjectsLocationsVmwareEngineNetworksPatchOptions,
): Promise<Operation>;
}

§Constructors

§
new VMwareEngine(client?: CredentialsClient, baseUrl?: string)
[src]

§Methods

§
projectsLocationsDnsBindPermissionGrant(name: string, req: GrantDnsBindPermissionRequest): Promise<Operation>
[src]

Grants the bind permission to the customer provided principal(user / service account) to bind their DNS zone with the intranet VPC associated with the project. DnsBindPermission is a global resource and location can only be global.

@param name

Required. The name of the resource which stores the users/service accounts having the permission to bind to the corresponding intranet VPC of the consumer project. DnsBindPermission is a global resource. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/global/dnsBindPermission

§
projectsLocationsDnsBindPermissionRevoke(name: string, req: RevokeDnsBindPermissionRequest): Promise<Operation>
[src]

Revokes the bind permission from the customer provided principal(user / service account) on the intranet VPC associated with the consumer project. DnsBindPermission is a global resource and location can only be global.

@param name

Required. The name of the resource which stores the users/service accounts having the permission to bind to the corresponding intranet VPC of the consumer project. DnsBindPermission is a global resource. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/global/dnsBindPermission

§
projectsLocationsGet(name: string): Promise<Location>
[src]

Gets information about a location.

@param name

Resource name for the location.

§
projectsLocationsGetDnsBindPermission(name: string): Promise<DnsBindPermission>
[src]

Gets all the principals having bind permission on the intranet VPC associated with the consumer project granted by the Grant API. DnsBindPermission is a global resource and location can only be global.

@param name

Required. The name of the resource which stores the users/service accounts having the permission to bind to the corresponding intranet VPC of the consumer project. DnsBindPermission is a global resource. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/global/dnsBindPermission

§
projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>
[src]

Lists information about the supported locations for this service.

@param name

The resource that owns the locations collection, if applicable.

§
projectsLocationsNetworkPeeringsCreate(parent: string, req: NetworkPeering, opts?: ProjectsLocationsNetworkPeeringsCreateOptions): Promise<Operation>
[src]

Creates a new network peering between the peer network and VMware Engine network provided in a NetworkPeering resource. NetworkPeering is a global resource and location can only be global.

@param parent

Required. The resource name of the location to create the new network peering in. This value is always global, because NetworkPeering is a global resource. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/global

§
projectsLocationsNetworkPeeringsDelete(name: string, opts?: ProjectsLocationsNetworkPeeringsDeleteOptions): Promise<Operation>
[src]

Deletes a NetworkPeering resource. When a network peering is deleted for a VMware Engine network, the peer network becomes inaccessible to that VMware Engine network. NetworkPeering is a global resource and location can only be global.

@param name

Required. The resource name of the network peering to be deleted. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/global/networkPeerings/my-peering

§
projectsLocationsNetworkPeeringsGet(name: string): Promise<NetworkPeering>
[src]

Retrieves a NetworkPeering resource by its resource name. The resource contains details of the network peering, such as peered networks, import and export custom route configurations, and peering state. NetworkPeering is a global resource and location can only be global.

@param name

Required. The resource name of the network peering to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/global/networkPeerings/my-peering

§
projectsLocationsNetworkPeeringsList(parent: string, opts?: ProjectsLocationsNetworkPeeringsListOptions): Promise<ListNetworkPeeringsResponse>
[src]

Lists NetworkPeering resources in a given project. NetworkPeering is a global resource and location can only be global.

@param parent

Required. The resource name of the location (global) to query for network peerings. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/global

§
projectsLocationsNetworkPeeringsPatch(name: string, req: NetworkPeering, opts?: ProjectsLocationsNetworkPeeringsPatchOptions): Promise<Operation>
[src]

Modifies a NetworkPeering resource. Only the description field can be updated. Only fields specified in updateMask are applied. NetworkPeering is a global resource and location can only be global.

@param name

Output only. The resource name of the network peering. NetworkPeering is a global resource and location can only be global. Resource names are scheme-less URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/global/networkPeerings/my-peering

§
projectsLocationsNetworkPeeringsPeeringRoutesList(parent: string, opts?: ProjectsLocationsNetworkPeeringsPeeringRoutesListOptions): Promise<ListPeeringRoutesResponse>
[src]

Lists the network peering routes exchanged over a peering connection. NetworkPeering is a global resource and location can only be global.

@param parent

Required. The resource name of the network peering to retrieve peering routes from. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/global/networkPeerings/my-peering

§
projectsLocationsNetworkPoliciesCreate(parent: string, req: NetworkPolicy, opts?: ProjectsLocationsNetworkPoliciesCreateOptions): Promise<Operation>
[src]

Creates a new network policy in a given VMware Engine network of a project and location (region). A new network policy cannot be created if another network policy already exists in the same scope.

@param parent

Required. The resource name of the location (region) to create the new network policy in. 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

§
projectsLocationsNetworkPoliciesDelete(name: string, opts?: ProjectsLocationsNetworkPoliciesDeleteOptions): Promise<Operation>
[src]

Deletes a NetworkPolicy resource. A network policy cannot be deleted when NetworkService.state is set to RECONCILING for either its external IP or internet access service.

@param name

Required. The resource name of the network policy to delete. 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/networkPolicies/my-network-policy

§
projectsLocationsNetworkPoliciesExternalAccessRulesCreate(parent: string, req: ExternalAccessRule, opts?: ProjectsLocationsNetworkPoliciesExternalAccessRulesCreateOptions): Promise<Operation>
[src]

Creates a new external access rule in a given network policy.

@param parent

Required. The resource name of the network policy to create a new external access firewall rule in. 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/networkPolicies/my-policy

§
projectsLocationsNetworkPoliciesExternalAccessRulesDelete(name: string, opts?: ProjectsLocationsNetworkPoliciesExternalAccessRulesDeleteOptions): Promise<Operation>
[src]

Deletes a single external access rule.

@param name

Required. The resource name of the external access firewall rule to delete. 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/networkPolicies/my-policy/externalAccessRules/my-rule

§
projectsLocationsNetworkPoliciesExternalAccessRulesGet(name: string): Promise<ExternalAccessRule>
[src]

Gets details of a single external access rule.

@param name

Required. The resource name of the external access firewall rule to retrieve. 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/networkPolicies/my-policy/externalAccessRules/my-rule

§
projectsLocationsNetworkPoliciesExternalAccessRulesList(parent: string, opts?: ProjectsLocationsNetworkPoliciesExternalAccessRulesListOptions): Promise<ListExternalAccessRulesResponse>
[src]

Lists ExternalAccessRule resources in the specified network policy.

@param parent

Required. The resource name of the network policy to query for external access firewall rules. 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/networkPolicies/my-policy

§
projectsLocationsNetworkPoliciesExternalAccessRulesPatch(name: string, req: ExternalAccessRule, opts?: ProjectsLocationsNetworkPoliciesExternalAccessRulesPatchOptions): Promise<Operation>
[src]

Updates the parameters of a single external access rule. Only fields specified in update_mask are applied.

@param name

Output only. The resource name of this external access rule. 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/networkPolicies/my-policy/externalAccessRules/my-rule

§
projectsLocationsNetworkPoliciesFetchExternalAddresses(networkPolicy: string, opts?: ProjectsLocationsNetworkPoliciesFetchExternalAddressesOptions): Promise<FetchNetworkPolicyExternalAddressesResponse>
[src]

Lists external IP addresses assigned to VMware workload VMs within the scope of the given network policy.

@param networkPolicy

Required. The resource name of the network policy to query for assigned external IP addresses. 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/networkPolicies/my-policy

§
projectsLocationsNetworkPoliciesGet(name: string): Promise<NetworkPolicy>
[src]

Retrieves a NetworkPolicy resource by its resource name.

@param name

Required. The resource name of the network policy to retrieve. 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/networkPolicies/my-network-policy

§
projectsLocationsNetworkPoliciesList(parent: string, opts?: ProjectsLocationsNetworkPoliciesListOptions): Promise<ListNetworkPoliciesResponse>
[src]

Lists NetworkPolicy resources in a specified project and location.

@param parent

Required. The resource name of the location (region) to query for network policies. 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

§
projectsLocationsNetworkPoliciesPatch(name: string, req: NetworkPolicy, opts?: ProjectsLocationsNetworkPoliciesPatchOptions): Promise<Operation>
[src]

Modifies a NetworkPolicy resource. Only the following fields can be updated: internet_access, external_ip, edge_services_cidr. Only fields specified in updateMask are applied. When updating a network policy, the external IP network service can only be disabled if there are no external IP addresses present in the scope of the policy. Also, a NetworkService cannot be updated when NetworkService.state is set to RECONCILING. During operation processing, the resource is temporarily in the ACTIVE state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.

@param name

Output only. The resource name of this network policy. 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/networkPolicies/my-network-policy

§
projectsLocationsNodeTypesGet(name: string): Promise<NodeType>
[src]

Gets details of a single NodeType.

@param name

Required. The resource name of the node type to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-proj/locations/us-central1-a/nodeTypes/standard-72

§
projectsLocationsNodeTypesList(parent: string, opts?: ProjectsLocationsNodeTypesListOptions): Promise<ListNodeTypesResponse>
[src]

Lists node types

@param parent

Required. The resource name of the location to be queried for node types. 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

§
projectsLocationsOperationsDelete(name: string): Promise<Empty>
[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

§
projectsLocationsOperationsGet(name: string): Promise<Operation>
[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

§
projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>
[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

§
projectsLocationsPrivateCloudsClustersCreate(parent: string, req: Cluster, opts?: ProjectsLocationsPrivateCloudsClustersCreateOptions): Promise<Operation>
[src]

Creates a new cluster in a given private cloud. Creating a new cluster provides additional nodes for use in the parent private cloud and requires sufficient node quota.

@param parent

Required. The resource name of the private cloud to create a new cluster in. 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

§
projectsLocationsPrivateCloudsClustersDelete(name: string, opts?: ProjectsLocationsPrivateCloudsClustersDeleteOptions): Promise<Operation>
[src]

Deletes a Cluster resource. To avoid unintended data loss, migrate or gracefully shut down any workloads running on the cluster before deletion. You cannot delete the management cluster of a private cloud using this method.

@param name

Required. The resource name of the cluster to delete. 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/clusters/my-cluster

§
projectsLocationsPrivateCloudsClustersGet(name: string): Promise<Cluster>
[src]

Retrieves a Cluster resource by its resource name.

@param name

Required. The cluster resource name to retrieve. 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/clusters/my-cluster

§
projectsLocationsPrivateCloudsClustersGetIamPolicy(resource: string, opts?: ProjectsLocationsPrivateCloudsClustersGetIamPolicyOptions): Promise<Policy>
[src]

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

@param resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

§
projectsLocationsPrivateCloudsClustersList(parent: string, opts?: ProjectsLocationsPrivateCloudsClustersListOptions): Promise<ListClustersResponse>
[src]

Lists Cluster resources in a given private cloud.

@param parent

Required. The resource name of the private cloud to query for clusters. 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

§
projectsLocationsPrivateCloudsClustersNodesGet(name: string): Promise<Node>
[src]

Gets details of a single node.

@param name

Required. The resource name of the node to retrieve. For example: projects/{project}/locations/{location}/privateClouds/{private_cloud}/clusters/{cluster}/nodes/{node}

§
projectsLocationsPrivateCloudsClustersNodesList(parent: string, opts?: ProjectsLocationsPrivateCloudsClustersNodesListOptions): Promise<ListNodesResponse>
[src]

Lists nodes in a given cluster.

@param parent

Required. The resource name of the cluster to be queried for nodes. 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/clusters/my-cluster

§
projectsLocationsPrivateCloudsClustersPatch(name: string, req: Cluster, opts?: ProjectsLocationsPrivateCloudsClustersPatchOptions): Promise<Operation>
[src]

Modifies a Cluster resource. Only fields specified in updateMask are applied. During operation processing, the resource is temporarily in the ACTIVE state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.

@param name

Output only. The resource name of this cluster. 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/clusters/my-cluster

§
projectsLocationsPrivateCloudsClustersSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>
[src]

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

@param resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

§
projectsLocationsPrivateCloudsClustersTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>
[src]

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

@param resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

§
projectsLocationsPrivateCloudsCreate(parent: string, req: PrivateCloud, opts?: ProjectsLocationsPrivateCloudsCreateOptions): Promise<Operation>
[src]

Creates a new PrivateCloud resource in a given project and location. Private clouds of type STANDARD and TIME_LIMITED are zonal resources, STRETCHED private clouds are regional. Creating a private cloud also creates a management cluster for that private cloud.

@param parent

Required. The resource name of the location to create the new private cloud in. 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

§
projectsLocationsPrivateCloudsDelete(name: string, opts?: ProjectsLocationsPrivateCloudsDeleteOptions): Promise<Operation>
[src]

Schedules a PrivateCloud resource for deletion. A PrivateCloud resource scheduled for deletion has PrivateCloud.state set to DELETED and expireTime set to the time when deletion is final and can no longer be reversed. The delete operation is marked as done as soon as the PrivateCloud is successfully scheduled for deletion (this also applies when delayHours is set to zero), and the operation is not kept in pending state until PrivateCloud is purged. PrivateCloud can be restored using UndeletePrivateCloud method before the expireTime elapses. When expireTime is reached, deletion is final and all private cloud resources are irreversibly removed and billing stops. During the final removal process, PrivateCloud.state is set to PURGING. PrivateCloud can be polled using standard GET method for the whole period of deletion and purging. It will not be returned only when it is completely purged.

@param name

Required. The resource name of the private cloud to delete. 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

§
projectsLocationsPrivateCloudsExternalAddressesCreate(parent: string, req: ExternalAddress, opts?: ProjectsLocationsPrivateCloudsExternalAddressesCreateOptions): Promise<Operation>
[src]

Creates a new ExternalAddress resource in a given private cloud. The network policy that corresponds to the private cloud must have the external IP address network service enabled (NetworkPolicy.external_ip).

@param parent

Required. The resource name of the private cloud to create a new external IP address in. 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

§
projectsLocationsPrivateCloudsExternalAddressesDelete(name: string, opts?: ProjectsLocationsPrivateCloudsExternalAddressesDeleteOptions): Promise<Operation>
[src]

Deletes a single external IP address. When you delete an external IP address, connectivity between the external IP address and the corresponding internal IP address is lost.

@param name

Required. The resource name of the external IP address to delete. 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/externalAddresses/my-ip

§
projectsLocationsPrivateCloudsExternalAddressesGet(name: string): Promise<ExternalAddress>
[src]

Gets details of a single external IP address.

@param name

Required. The resource name of the external IP address to retrieve. 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/externalAddresses/my-ip

§
projectsLocationsPrivateCloudsExternalAddressesList(parent: string, opts?: ProjectsLocationsPrivateCloudsExternalAddressesListOptions): Promise<ListExternalAddressesResponse>
[src]

Lists external IP addresses assigned to VMware workload VMs in a given private cloud.

@param parent

Required. The resource name of the private cloud to be queried for external IP addresses. 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

§
projectsLocationsPrivateCloudsExternalAddressesPatch(name: string, req: ExternalAddress, opts?: ProjectsLocationsPrivateCloudsExternalAddressesPatchOptions): Promise<Operation>
[src]

Updates the parameters of a single external IP address. Only fields specified in update_mask are applied. During operation processing, the resource is temporarily in the ACTIVE state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.

@param name

Output only. The resource name of this external IP address. 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/externalAddresses/my-address

§
projectsLocationsPrivateCloudsGet(name: string): Promise<PrivateCloud>
[src]

Retrieves a PrivateCloud resource by its resource name.

@param name

Required. The resource name of the private cloud to retrieve. 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

§
projectsLocationsPrivateCloudsGetDnsForwarding(name: string): Promise<DnsForwarding>
[src]

Gets details of the DnsForwarding config.

@param name

Required. The resource name of a DnsForwarding to retrieve. 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/dnsForwarding

§
projectsLocationsPrivateCloudsGetIamPolicy(resource: string, opts?: ProjectsLocationsPrivateCloudsGetIamPolicyOptions): Promise<Policy>
[src]

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

@param resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

§
projectsLocationsPrivateCloudsHcxActivationKeysCreate(parent: string, req: HcxActivationKey, opts?: ProjectsLocationsPrivateCloudsHcxActivationKeysCreateOptions): Promise<Operation>
[src]

Creates a new HCX activation key in a given private cloud.

@param parent

Required. The resource name of the private cloud to create the key for. 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/privateClouds/my-cloud

§
projectsLocationsPrivateCloudsHcxActivationKeysGet(name: string): Promise<HcxActivationKey>
[src]

Retrieves a HcxActivationKey resource by its resource name.

@param name

Required. The resource name of the HCX activation key to retrieve. 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/privateClouds/my-cloud/hcxActivationKeys/my-key

§
projectsLocationsPrivateCloudsHcxActivationKeysGetIamPolicy(resource: string, opts?: ProjectsLocationsPrivateCloudsHcxActivationKeysGetIamPolicyOptions): Promise<Policy>
[src]

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

@param resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

§
projectsLocationsPrivateCloudsHcxActivationKeysList(parent: string, opts?: ProjectsLocationsPrivateCloudsHcxActivationKeysListOptions): Promise<ListHcxActivationKeysResponse>
[src]

Lists HcxActivationKey resources in a given private cloud.

@param parent

Required. The resource name of the private cloud to be queried for HCX activation keys. 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/privateClouds/my-cloud

§
projectsLocationsPrivateCloudsHcxActivationKeysSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>
[src]

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

@param resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

§
projectsLocationsPrivateCloudsHcxActivationKeysTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>
[src]

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

@param resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

§
projectsLocationsPrivateCloudsList(parent: string, opts?: ProjectsLocationsPrivateCloudsListOptions): Promise<ListPrivateCloudsResponse>
[src]

Lists PrivateCloud resources in a given project and location.

@param parent

Required. The resource name of the private cloud to be queried for clusters. 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

§
projectsLocationsPrivateCloudsLoggingServersCreate(parent: string, req: LoggingServer, opts?: ProjectsLocationsPrivateCloudsLoggingServersCreateOptions): Promise<Operation>
[src]

Create a new logging server for a given private cloud.

@param parent

Required. The resource name of the private cloud to create a new Logging Server in. 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

§
projectsLocationsPrivateCloudsLoggingServersDelete(name: string, opts?: ProjectsLocationsPrivateCloudsLoggingServersDeleteOptions): Promise<Operation>
[src]

Deletes a single logging server.

@param name

Required. The resource name of the logging server to delete. 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/loggingServers/my-logging-server

§
projectsLocationsPrivateCloudsLoggingServersGet(name: string): Promise<LoggingServer>
[src]

Gets details of a logging server.

@param name

Required. The resource name of the Logging Server to retrieve. 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/loggingServers/my-logging-server

§
projectsLocationsPrivateCloudsLoggingServersList(parent: string, opts?: ProjectsLocationsPrivateCloudsLoggingServersListOptions): Promise<ListLoggingServersResponse>
[src]

Lists logging servers configured for a given private cloud.

@param parent

Required. The resource name of the private cloud to be queried for logging servers. 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

§
projectsLocationsPrivateCloudsLoggingServersPatch(name: string, req: LoggingServer, opts?: ProjectsLocationsPrivateCloudsLoggingServersPatchOptions): Promise<Operation>
[src]

Updates the parameters of a single logging server. Only fields specified in update_mask are applied.

@param name

Output only. The resource name of this logging server. 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/loggingServers/my-logging-server

§
projectsLocationsPrivateCloudsManagementDnsZoneBindingsCreate(parent: string, req: ManagementDnsZoneBinding, opts?: ProjectsLocationsPrivateCloudsManagementDnsZoneBindingsCreateOptions): Promise<Operation>
[src]

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.

@param parent

Required. The resource name of the private cloud to create a new management DNS zone binding for. 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

§
projectsLocationsPrivateCloudsManagementDnsZoneBindingsDelete(name: string, opts?: ProjectsLocationsPrivateCloudsManagementDnsZoneBindingsDeleteOptions): Promise<Operation>
[src]

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.

@param name

Required. The resource name of the management DNS zone binding to delete. 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

§
projectsLocationsPrivateCloudsManagementDnsZoneBindingsGet(name: string): Promise<ManagementDnsZoneBinding>
[src]

Retrieves a 'ManagementDnsZoneBinding' resource by its resource name.

@param name

Required. The resource name of the management DNS zone binding to retrieve. 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

§
projectsLocationsPrivateCloudsManagementDnsZoneBindingsList(parent: string, opts?: ProjectsLocationsPrivateCloudsManagementDnsZoneBindingsListOptions): Promise<ListManagementDnsZoneBindingsResponse>
[src]

Lists Consumer VPCs bound to Management DNS Zone of a given private cloud.

@param parent

Required. The resource name of the private cloud to be queried for management DNS zone bindings. 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

§
projectsLocationsPrivateCloudsManagementDnsZoneBindingsPatch(name: string, req: ManagementDnsZoneBinding, opts?: ProjectsLocationsPrivateCloudsManagementDnsZoneBindingsPatchOptions): Promise<Operation>
[src]

Updates a ManagementDnsZoneBinding resource. Only fields specified in update_mask are applied.

@param name

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

§
projectsLocationsPrivateCloudsManagementDnsZoneBindingsRepair(name: string, req: RepairManagementDnsZoneBindingRequest): Promise<Operation>
[src]

Retries to create a ManagementDnsZoneBinding resource that is in failed state.

@param name

Required. The resource name of the management DNS zone binding to repair. 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

§
projectsLocationsPrivateCloudsPatch(name: string, req: PrivateCloud, opts?: ProjectsLocationsPrivateCloudsPatchOptions): Promise<Operation>
[src]

Modifies a PrivateCloud resource. Only the following fields can be updated: description. Only fields specified in updateMask are applied. During operation processing, the resource is temporarily in the ACTIVE state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.

@param name

Output only. The resource name of this private cloud. 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

§
projectsLocationsPrivateCloudsResetNsxCredentials(privateCloud: string, req: ResetNsxCredentialsRequest): Promise<Operation>
[src]

Resets credentials of the NSX appliance.

@param privateCloud

Required. The resource name of the private cloud to reset credentials for. 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

§
projectsLocationsPrivateCloudsResetVcenterCredentials(privateCloud: string, req: ResetVcenterCredentialsRequest): Promise<Operation>
[src]

Resets credentials of the Vcenter appliance.

@param privateCloud

Required. The resource name of the private cloud to reset credentials for. 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

§
projectsLocationsPrivateCloudsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>
[src]

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

@param resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

§
projectsLocationsPrivateCloudsShowNsxCredentials(privateCloud: string): Promise<Credentials>
[src]

Gets details of credentials for NSX appliance.

@param privateCloud

Required. The resource name of the private cloud to be queried for credentials. 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

§
projectsLocationsPrivateCloudsShowVcenterCredentials(privateCloud: string, opts?: ProjectsLocationsPrivateCloudsShowVcenterCredentialsOptions): Promise<Credentials>
[src]

Gets details of credentials for Vcenter appliance.

@param privateCloud

Required. The resource name of the private cloud to be queried for credentials. 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

§
projectsLocationsPrivateCloudsSubnetsGet(name: string): Promise<Subnet>
[src]

Gets details of a single subnet.

@param name

Required. The resource name of the subnet to retrieve. 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/subnets/my-subnet

§
projectsLocationsPrivateCloudsSubnetsList(parent: string, opts?: ProjectsLocationsPrivateCloudsSubnetsListOptions): Promise<ListSubnetsResponse>
[src]

Lists subnets in a given private cloud.

@param parent

Required. The resource name of the private cloud to be queried for subnets. 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

§
projectsLocationsPrivateCloudsSubnetsPatch(name: string, req: Subnet, opts?: ProjectsLocationsPrivateCloudsSubnetsPatchOptions): Promise<Operation>
[src]

Updates the parameters of a single subnet. Only fields specified in update_mask are applied. Note: This API is synchronous and always returns a successful google.longrunning.Operation (LRO). The returned LRO will only have done and response fields.

@param name

Output only. The resource name of this subnet. 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/subnets/my-subnet

§
projectsLocationsPrivateCloudsTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>
[src]

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

@param resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

§
projectsLocationsPrivateCloudsUndelete(name: string, req: UndeletePrivateCloudRequest): Promise<Operation>
[src]

Restores a private cloud that was previously scheduled for deletion by DeletePrivateCloud. A PrivateCloud resource scheduled for deletion has PrivateCloud.state set to DELETED and PrivateCloud.expireTime set to the time when deletion can no longer be reversed.

@param name

Required. The resource name of the private cloud scheduled for deletion. 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

§
projectsLocationsPrivateCloudsUpdateDnsForwarding(name: string, req: DnsForwarding, opts?: ProjectsLocationsPrivateCloudsUpdateDnsForwardingOptions): Promise<Operation>
[src]

Updates the parameters of the DnsForwarding config, like associated domains. Only fields specified in update_mask are applied.

@param name

Output only. The resource name of this DNS profile. 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/dnsForwarding

§
projectsLocationsPrivateConnectionsCreate(parent: string, req: PrivateConnection, opts?: ProjectsLocationsPrivateConnectionsCreateOptions): Promise<Operation>
[src]

Creates a new private connection that can be used for accessing private Clouds.

@param parent

Required. The resource name of the location to create the new private connection in. Private connection is a regional resource. 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

§
projectsLocationsPrivateConnectionsDelete(name: string, opts?: ProjectsLocationsPrivateConnectionsDeleteOptions): Promise<Operation>
[src]

Deletes a PrivateConnection resource. When a private connection is deleted for a VMware Engine network, the connected network becomes inaccessible to that VMware Engine network.

@param name

Required. The resource name of the private connection to be deleted. 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/privateConnections/my-connection

§
projectsLocationsPrivateConnectionsGet(name: string): Promise<PrivateConnection>
[src]

Retrieves a PrivateConnection resource by its resource name. The resource contains details of the private connection, such as connected network, routing mode and state.

@param name

Required. The resource name of the private connection to retrieve. 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/privateConnections/my-connection

§
projectsLocationsPrivateConnectionsList(parent: string, opts?: ProjectsLocationsPrivateConnectionsListOptions): Promise<ListPrivateConnectionsResponse>
[src]

Lists PrivateConnection resources in a given project and location.

@param parent

Required. The resource name of the location to query for private connections. 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

§
projectsLocationsPrivateConnectionsPatch(name: string, req: PrivateConnection, opts?: ProjectsLocationsPrivateConnectionsPatchOptions): Promise<Operation>
[src]

Modifies a PrivateConnection resource. Only description and routing_mode fields can be updated. Only fields specified in updateMask are applied.

@param name

Output only. The resource name of the private connection. 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/privateConnections/my-connection

§
projectsLocationsPrivateConnectionsPeeringRoutesList(parent: string, opts?: ProjectsLocationsPrivateConnectionsPeeringRoutesListOptions): Promise<ListPrivateConnectionPeeringRoutesResponse>
[src]

Lists the private connection routes exchanged over a peering connection.

@param parent

Required. The resource name of the private connection to retrieve peering routes from. 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-west1/privateConnections/my-connection

§
projectsLocationsVmwareEngineNetworksCreate(parent: string, req: VmwareEngineNetwork, opts?: ProjectsLocationsVmwareEngineNetworksCreateOptions): Promise<Operation>
[src]

Creates a new VMware Engine network that can be used by a private cloud.

@param parent

Required. The resource name of the location to create the new VMware Engine network in. A VMware Engine network of type LEGACY is a regional resource, and a VMware Engine network of type STANDARD is a global resource. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/global

§
projectsLocationsVmwareEngineNetworksDelete(name: string, opts?: ProjectsLocationsVmwareEngineNetworksDeleteOptions): Promise<Operation>
[src]

Deletes a VmwareEngineNetwork resource. You can only delete a VMware Engine network after all resources that refer to it are deleted. For example, a private cloud, a network peering, and a network policy can all refer to the same VMware Engine network.

@param name

Required. The resource name of the VMware Engine network to be deleted. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/global/vmwareEngineNetworks/my-network

§
projectsLocationsVmwareEngineNetworksGet(name: string): Promise<VmwareEngineNetwork>
[src]

Retrieves a VmwareEngineNetwork resource by its resource name. The resource contains details of the VMware Engine network, such as its VMware Engine network type, peered networks in a service project, and state (for example, CREATING, ACTIVE, DELETING).

@param name

Required. The resource name of the VMware Engine network to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/global/vmwareEngineNetworks/my-network

§
projectsLocationsVmwareEngineNetworksList(parent: string, opts?: ProjectsLocationsVmwareEngineNetworksListOptions): Promise<ListVmwareEngineNetworksResponse>
[src]

Lists VmwareEngineNetwork resources in a given project and location.

@param parent

Required. The resource name of the location to query for VMware Engine networks. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/global

§
projectsLocationsVmwareEngineNetworksPatch(name: string, req: VmwareEngineNetwork, opts?: ProjectsLocationsVmwareEngineNetworksPatchOptions): Promise<Operation>
[src]

Modifies a VMware Engine network resource. Only the following fields can be updated: description. Only fields specified in updateMask are applied.

@param name

Output only. The resource name of the VMware Engine network. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/global/vmwareEngineNetworks/my-network