API Reference google_api_v_mware_engine v0.5.0
View SourceModules
API client metadata for GoogleApi.VMwareEngine.V1.
API calls for all endpoints tagged Projects
.
Handle Tesla connections for GoogleApi.VMwareEngine.V1.
Announcement for the resources of Vmware Engine.
Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both allServices
and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com
from DATA_READ logging, and aliya@example.com
from DATA_WRITE logging.
Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
Autoscaling policy describes the behavior of the autoscaling with respect to the resource utilization. The scale-out operation is initiated if the utilization exceeds ANY of the respective thresholds. The scale-in operation is initiated if the utilization is below ALL of the respective thresholds.
Autoscaling settings define the rules used by VMware Engine to automatically scale-out and scale-in the clusters in a private cloud.
Associates members
, or principals, with a role
.
A cluster in a private cloud.
Constraints to be applied while editing a schedule. These constraints ensure that Upgrade
specific requirements are met.
Credentials for a private cloud.
DnsBindPermission resource that contains the accounts having the consumer DNS bind permission on the corresponding intranet VPC of the consumer project.
DNS forwarding config. This config defines a list of domain to name server mappings, and is attached to the private cloud for custom domain resolution.
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
External access firewall rules for filtering incoming traffic destined to ExternalAddress
resources.
Represents an allocated external IP address and its corresponding internal IP address in a private cloud.
Response message for VmwareEngine.FetchNetworkPolicyExternalAddresses
A forwarding rule is a mapping of a domain
to name_servers
. This mapping allows VMware Engine to resolve domains for attached private clouds by forwarding DNS requests for a given domain to the specified nameservers.
Request message for VmwareEngine.GrantDnsBindPermission
Details about a HCX Cloud Manager appliance.
HCX activation key. A default key is created during private cloud provisioning, but this behavior is subject to change and you should always verify active keys. Use VmwareEngine.ListHcxActivationKeys to retrieve existing keys and VmwareEngine.CreateHcxActivationKey to create new ones.
Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.
An IP range provided in any one of the supported formats.
Response message for VmwareEngine.ListAnnouncements
Response message for VmwareEngine.ListClusters
Response message for VmwareEngine.ListExternalAccessRules
Response message for VmwareEngine.ListExternalAddresses
Response message for VmwareEngine.ListHcxActivationKeys
The response message for Locations.ListLocations.
Response message for VmwareEngine.ListLoggingServers
Response message for VmwareEngine.ListManagementDnsZoneBindings
Response message for VmwareEngine.ListNetworkPeerings
Response message for VmwareEngine.ListNetworkPolicies
Response message for VmwareEngine.ListNodeTypes
Response message for VmwareEngine.ListNodes
The response message for Operations.ListOperations.
Response message for VmwareEngine.ListPeeringRoutes
Response message for VmwareEngine.ListPrivateClouds
Response message for VmwareEngine.ListPrivateConnectionPeeringRoutes
Response message for VmwareEngine.ListPrivateConnections
Response message for VmwareEngine.ListSubnets
Response message for VmwareEngine.ListUpgrades.
Response message for VmwareEngine.ListVmwareEngineNetworks
A resource that represents a Google Cloud location.
VmwareEngine specific metadata for the given google.cloud.location.Location. It is returned as a content of the google.cloud.location.Location.metadata
field.
Logging server to receive vCenter or ESXi logs.
Management cluster configuration.
Represents a binding between a network and 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.
Network configuration in the consumer project with which the peering has to be done.
Details of a network peering.
Represents a network policy resource. Network policies are regional resources. You can use a network policy to enable or disable internet access and external IP access. Network policies are associated with a VMware Engine network, which might span across regions. For a given region, a network policy applies to all private clouds in the VMware Engine network associated with the policy.
Represents a network service that is managed by a NetworkPolicy
resource. A network service provides a way to control an aspect of external access to VMware workloads. For example, whether the VMware workloads in the private clouds governed by a network policy can access or be accessed from the internet.
Node in a cluster.
Describes node type.
Information about the type and number of nodes associated with the cluster.
Details about a NSX Manager appliance.
This resource represents a long-running operation that is the result of a network API call.
Represents the metadata of the long-running operation.
Exchanged network peering route.
An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy
is a collection of bindings
. A binding
binds one or more members
, or principals, to a single role
. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role
is a named list of permissions; each role
can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding
can also specify a condition
, which is a logical expression that allows access to a resource only if the expression evaluates to true
. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation. JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }
YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3
For a description of IAM and its features, see the IAM documentation.
Users/Service accounts which have access for DNS binding on the intranet VPC corresponding to the consumer project.
Represents a private cloud resource. Private clouds of type STANDARD
and TIME_LIMITED
are zonal resources, STRETCHED
private clouds are regional.
Private connection resource that provides connectivity for VMware Engine private clouds.
Request message for VmwareEngine.RepairManagementDnsZoneBindings
Request message for VmwareEngine.ResetNsxCredentials
Request message for VmwareEngine.ResetVcenterCredentials
Request message for VmwareEngine.RevokeDnsBindPermission
Schedule for the upgrade.
Request message for SetIamPolicy
method.
The Status
type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status
message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.
Configuration of a stretched cluster.
Subnet in a private cloud. Either management
subnets (such as vMotion) that are read-only, or userDefined
, which can also be updated.
Request message for TestIamPermissions
method.
Response message for TestIamPermissions
method.
Thresholds define the utilization of resources triggering scale-out and scale-in operations.
Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp
.
Represents the time window to perform upgrade activities.
Request message for VmwareEngine.UndeletePrivateCloud
Describes Private cloud Upgrade.
Details about a vCenter Server management appliance.
VMware Engine network resource that provides connectivity for VMware Engine private clouds.
Per component upgrade resource
Represents a VMware Engine VPC network that is managed by a VMware Engine network resource.