Lists global VM extension policies.
GET https://compute.googleapis.com/compute/beta/projects/{project}/global/vmExtensionPolicies
The URL uses gRPC Transcoding syntax. To know more about valid error responses that can be thrown by this HTTP request, please refer to the service error catalog
| Parameters | |
|---|---|
project |
Project ID for this request. |
| Parameters | |
|---|---|
maxResults |
The maximum number of results per page that should be returned. If the number of available results is larger than |
pageToken |
Specifies a page token to use. Set |
filter |
A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either For example, if you are filtering Compute Engine instances, you can exclude instances named The You can also filter nested fields. For example, you could specify To filter on multiple expressions, provide each separate expression within parentheses. For example: By default, each expression is an If you want to use a regular expression, use the
The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use You cannot combine constraints on multiple fields using regular expressions. |
orderBy |
Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using Currently, only sorting by |
returnPartialSuccess |
Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. |
The request body must be empty.
Response to list global VM extension policy resources.
If successful, the response body contains data with the following structure:
| JSON representation |
|---|
{ "kind": string, "id": string, "items": [ { "kind": string, "id": string, "creationTimestamp": string, "updateTimestamp": string, "name": string, "description": string, "selfLink": string, "selfLinkWithId": string, "extensionPolicies": { string: { "stringConfig": string, "pinnedVersion": string }, ... }, "instanceSelectors": [ { // Union field |
kindstring
Output only. Type of resource.
idstring
Output only. Unique identifier for the resource; defined by the server.
items[]object
A list of GlobalVmExtensionPolicy resources.
items[].kindstring
Output only. Type of the resource. Always compute#globalVmExtensionPolicy for globalVmExtensionPolicies.
items[].idstring (uint64 format)
Output only. The unique identifier for the resource. This identifier is defined by the server.
items[].creationTimestampstring
Output only. Creation timestamp in RFC3339 text format.
items[].updateTimestampstring
Output only. globalVmExtensionPolicies.update timestamp in RFC3339 text format.
items[].namestring
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
items[].descriptionstring
An optional description of this resource. Provide this property when you create the resource.
items[].selfLinkstring
Output only. Server-defined fully-qualified URL for this resource.
items[].selfLinkWithIdstring
Output only. Server-defined URL for this resource's resource id.
items[].extensionPolicies[]map (key: string, value: object)
Required. Map from extension (eg: "cloudops") to its policy configuration. The key is the name of the extension.
items[].extensionPolicies[].stringConfigstring
Optional. String configuration. Any string payload that the extension understands.
items[].extensionPolicies[].pinnedVersionstring
Optional. The version pinning for the extension. If empty, the extension will be installed with the latest version released by the extension producer.
items[].instanceSelectors[]object
Optional. Selector to target VMs for a policy. There is a logical "AND" between instanceSelectors.
items[].instanceSelectors[].labelSelectorobject
Optional. Labels within the LabelSelector are OR'd.
items[].instanceSelectors[].labelSelector.inclusionLabelsmap (key: string, value: string)
Optional. Labels as key value pairs. A VM should contain all the pairs specified in this map to be selected; Labels within the LabelSelector are OR'ed.
items[].priorityinteger
Optional. Used to resolve conflicts when multiple policies are active for the same extension. Defaults to 0.
Larger the number, higher the priority. When the priority is the same, the policy with the newer create time has higher priority.
items[].scopedResourceStatusenum
Output only. The scoped resource status. It's only for tracking the purging status of the policy.
items[].rolloutOperationobject
Required. The rollout strategy and status.
items[].rolloutOperation.rolloutInputobject
Required. The rollout input which defines the rollout plan.
items[].rolloutOperation.rolloutInput.namestring
items[].rolloutOperation.rolloutInput.predefinedRolloutPlanenum
Optional. Specifies the predefined rollout plan for the policy. Valid values are SLOW_ROLLOUT and FAST_ROLLOUT. The recommended value is SLOW_ROLLOUT for progressive rollout. For more information, see Rollout plans for global policies.
items[].rolloutOperation.rolloutInput.retryUuidstring
Optional. The UUID that identifies a policy rollout retry attempt for update and delete operations. Set this field only when retrying a rollout for an existing extension policy.
update method: Lets you retry policy rollout without changes. An error occurs if you set retryUuid but the policy is modified.delete method: Lets you retry policy deletion rollout if the previous deletion rollout is not finished and the policy is in the DELETING state. If you set this field when the policy is not in the DELETING state, an error occurs.items[].rolloutOperation.rolloutInput.conflictBehaviorstring
Optional. Specifies the behavior of the rollout if a conflict is detected in a project during a rollout. This only applies to insert and update methods.
A conflict occurs in the following cases:
insert method: If the zonal policy already exists when the insert happens.update method: If the zonal policy was modified by a zonal API call outside of this rollout.Possible values are the following:
"" (empty string): If a conflict occurs, the local value is not overwritten. This is the default behavior."overwrite": If a conflict occurs, the local value is overwritten with the rollout value.items[].rolloutOperation.rolloutStatusobject
Output only. The rollout status of the policy.
items[].rolloutOperation.rolloutStatus.currentRollouts[]object
Output only. The current rollouts for the latest version of the resource. There should be only one current rollout, but for scalability, we make it repeated.
items[].rolloutOperation.rolloutStatus.currentRollouts[].rolloutstring
items[].rolloutOperation.rolloutStatus.currentRollouts[].rolloutPlanstring
items[].rolloutOperation.rolloutStatus.currentRollouts[].stateenum
Output only. The overall state of the rollout.
items[].rolloutOperation.rolloutStatus.currentRollouts[].locationRolloutStatus[]map (key: string, value: object)
Output only. The rollout status for each location. The list of the locations is the same as the list of locations in the rollout plan.
items[].rolloutOperation.rolloutStatus.currentRollouts[].locationRolloutStatus[].stateenum
Output only. The state of the location rollout.
items[].rolloutOperation.rolloutStatus.previousRolloutobject
Output only. The last completed rollout resource. This field will not be populated until the first rollout is completed.
items[].rolloutOperation.rolloutStatus.previousRollout.rolloutstring
items[].rolloutOperation.rolloutStatus.previousRollout.rolloutPlanstring
items[].rolloutOperation.rolloutStatus.previousRollout.stateenum
Output only. The overall state of the rollout.
items[].rolloutOperation.rolloutStatus.previousRollout.locationRolloutStatus[]map (key: string, value: object)
Output only. The rollout status for each location. The list of the locations is the same as the list of locations in the rollout plan.
items[].rolloutOperation.rolloutStatus.previousRollout.locationRolloutStatus[].stateenum
Output only. The state of the location rollout.
nextPageTokenstring
Output only. This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLinkstring
Output only. Server-defined URL for this resource.
warningobject
Output only. Informational warning message.
warning.codeenum
Output only. A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
warning.messagestring
Output only. A human-readable description of the warning code.
warning.data[]object
Output only. Metadata about this warning in key: value format. For example:
"data": [ { "key": "scope", "value": "zones/us-east1-d" }warning.data[].keystring
Output only. A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
warning.data[].valuestring
Output only. A warning data value corresponding to the key.
etagstring
unreachables[]string
Output only. Unreachable resources.
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/compute.readonly
https://www.googleapis.com/auth/compute
https://www.googleapis.com/auth/cloud-platformFor more information, see the Authentication Overview.
In addition to any permissions specified on the fields above, authorization requires one or more of the following IAM permissions:
compute.vmExtensionPolicies.listTo find predefined roles that contain those permissions, see Compute Engine IAM Roles.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-05-13 UTC.