- [HTTP request](https://docs.cloud.google.com/compute/docs/reference/rest/beta/instanceGroupManagers/get#body.HTTP_TEMPLATE)
- [Path parameters](https://docs.cloud.google.com/compute/docs/reference/rest/beta/instanceGroupManagers/get#body.PATH_PARAMETERS)
- [Request body](https://docs.cloud.google.com/compute/docs/reference/rest/beta/instanceGroupManagers/get#body.request_body)
- [Response body](https://docs.cloud.google.com/compute/docs/reference/rest/beta/instanceGroupManagers/get#body.response_body)
  - [JSON representation](https://docs.cloud.google.com/compute/docs/reference/rest/beta/instanceGroupManagers/get#body.InstanceGroupManager.SCHEMA_REPRESENTATION)
    - [JSON representation](https://docs.cloud.google.com/compute/docs/reference/rest/beta/instanceGroupManagers/get#body.InstanceGroupManager.SCHEMA_REPRESENTATION.distribution_policy.SCHEMA_REPRESENTATION)
    - [JSON representation](https://docs.cloud.google.com/compute/docs/reference/rest/beta/instanceGroupManagers/get#body.InstanceGroupManager.SCHEMA_REPRESENTATION.version.SCHEMA_REPRESENTATION)
    - [JSON representation](https://docs.cloud.google.com/compute/docs/reference/rest/beta/instanceGroupManagers/get#body.InstanceGroupManager.SCHEMA_REPRESENTATION.all_instances_config.SCHEMA_REPRESENTATION)
    - [JSON representation](https://docs.cloud.google.com/compute/docs/reference/rest/beta/instanceGroupManagers/get#body.InstanceGroupManager.SCHEMA_REPRESENTATION.status.SCHEMA_REPRESENTATION)
    - [JSON representation](https://docs.cloud.google.com/compute/docs/reference/rest/beta/instanceGroupManagers/get#body.InstanceGroupManager.SCHEMA_REPRESENTATION.status.SCHEMA_REPRESENTATION_1)
    - [JSON representation](https://docs.cloud.google.com/compute/docs/reference/rest/beta/instanceGroupManagers/get#body.InstanceGroupManager.SCHEMA_REPRESENTATION.status.SCHEMA_REPRESENTATION_2)
    - [JSON representation](https://docs.cloud.google.com/compute/docs/reference/rest/beta/instanceGroupManagers/get#body.InstanceGroupManager.SCHEMA_REPRESENTATION.status.SCHEMA_REPRESENTATION_3)
      - [JSON representation](https://docs.cloud.google.com/compute/docs/reference/rest/beta/instanceGroupManagers/get#body.InstanceGroupManager.SCHEMA_REPRESENTATION.status.SCHEMA_REPRESENTATION_3.last_progress_check.SCHEMA_REPRESENTATION)
        - [JSON representation](https://docs.cloud.google.com/compute/docs/reference/rest/beta/instanceGroupManagers/get#body.InstanceGroupManager.SCHEMA_REPRESENTATION.status.SCHEMA_REPRESENTATION_3.last_progress_check.SCHEMA_REPRESENTATION.error.SCHEMA_REPRESENTATION)
          - [JSON representation](https://docs.cloud.google.com/compute/docs/reference/rest/beta/instanceGroupManagers/get#body.InstanceGroupManager.SCHEMA_REPRESENTATION.status.SCHEMA_REPRESENTATION_3.last_progress_check.SCHEMA_REPRESENTATION.error.SCHEMA_REPRESENTATION.help.SCHEMA_REPRESENTATION)
    - [JSON representation](https://docs.cloud.google.com/compute/docs/reference/rest/beta/instanceGroupManagers/get#body.InstanceGroupManager.SCHEMA_REPRESENTATION.status.SCHEMA_REPRESENTATION_4)
      - [JSON representation](https://docs.cloud.google.com/compute/docs/reference/rest/beta/instanceGroupManagers/get#body.InstanceGroupManager.SCHEMA_REPRESENTATION.status.SCHEMA_REPRESENTATION_4.state_details.SCHEMA_REPRESENTATION)
        - [JSON representation](https://docs.cloud.google.com/compute/docs/reference/rest/beta/instanceGroupManagers/get#body.InstanceGroupManager.SCHEMA_REPRESENTATION.status.SCHEMA_REPRESENTATION_4.state_details.SCHEMA_REPRESENTATION.error.SCHEMA_REPRESENTATION)
          - [JSON representation](https://docs.cloud.google.com/compute/docs/reference/rest/beta/instanceGroupManagers/get#body.InstanceGroupManager.SCHEMA_REPRESENTATION.status.SCHEMA_REPRESENTATION_4.state_details.SCHEMA_REPRESENTATION.error.SCHEMA_REPRESENTATION.help.SCHEMA_REPRESENTATION)
    - [JSON representation](https://docs.cloud.google.com/compute/docs/reference/rest/beta/instanceGroupManagers/get#body.InstanceGroupManager.SCHEMA_REPRESENTATION.status.SCHEMA_REPRESENTATION_5)
    - [JSON representation](https://docs.cloud.google.com/compute/docs/reference/rest/beta/instanceGroupManagers/get#body.InstanceGroupManager.SCHEMA_REPRESENTATION.instance_flexibility_policy.inlinedField.map_entry1.value.SCHEMA_REPRESENTATION)
      - [JSON representation](https://docs.cloud.google.com/compute/docs/reference/rest/beta/instanceGroupManagers/get#body.InstanceGroupManager.SCHEMA_REPRESENTATION.instance_flexibility_policy.inlinedField.map_entry1.value.SCHEMA_REPRESENTATION.initialize_params.SCHEMA_REPRESENTATION)
      - [JSON representation](https://docs.cloud.google.com/compute/docs/reference/rest/beta/instanceGroupManagers/get#body.InstanceGroupManager.SCHEMA_REPRESENTATION.instance_flexibility_policy.inlinedField.map_entry1.value.SCHEMA_REPRESENTATION.initialize_params.SCHEMA_REPRESENTATION_1)
      - [JSON representation](https://docs.cloud.google.com/compute/docs/reference/rest/beta/instanceGroupManagers/get#body.InstanceGroupManager.SCHEMA_REPRESENTATION.instance_flexibility_policy.inlinedField.map_entry1.value.SCHEMA_REPRESENTATION.initialize_params.SCHEMA_REPRESENTATION_2)
      - [JSON representation](https://docs.cloud.google.com/compute/docs/reference/rest/beta/instanceGroupManagers/get#body.InstanceGroupManager.SCHEMA_REPRESENTATION.instance_flexibility_policy.inlinedField.map_entry1.value.SCHEMA_REPRESENTATION.shielded_instance_initial_state.SCHEMA_REPRESENTATION)
      - [JSON representation](https://docs.cloud.google.com/compute/docs/reference/rest/beta/instanceGroupManagers/get#body.InstanceGroupManager.SCHEMA_REPRESENTATION.instance_flexibility_policy.inlinedField.map_entry1.value.SCHEMA_REPRESENTATION.shielded_instance_initial_state.SCHEMA_REPRESENTATION_1)
      - [JSON representation](https://docs.cloud.google.com/compute/docs/reference/rest/beta/instanceGroupManagers/get#body.InstanceGroupManager.SCHEMA_REPRESENTATION.instance_flexibility_policy.inlinedField.map_entry1.value.SCHEMA_REPRESENTATION.shielded_instance_initial_state.SCHEMA_REPRESENTATION_2)
      - [JSON representation](https://docs.cloud.google.com/compute/docs/reference/rest/beta/instanceGroupManagers/get#body.InstanceGroupManager.SCHEMA_REPRESENTATION.instance_flexibility_policy.inlinedField.map_entry1.value.SCHEMA_REPRESENTATION.shielded_instance_initial_state.SCHEMA_REPRESENTATION_3)
    - [JSON representation](https://docs.cloud.google.com/compute/docs/reference/rest/beta/instanceGroupManagers/get#body.InstanceGroupManager.SCHEMA_REPRESENTATION.instance_flexibility_policy.SCHEMA_REPRESENTATION)
    - [JSON representation](https://docs.cloud.google.com/compute/docs/reference/rest/beta/instanceGroupManagers/get#body.InstanceGroupManager.SCHEMA_REPRESENTATION.instance_flexibility_policy.SCHEMA_REPRESENTATION_1)
    - [JSON representation](https://docs.cloud.google.com/compute/docs/reference/rest/beta/instanceGroupManagers/get#body.InstanceGroupManager.SCHEMA_REPRESENTATION.update_policy.SCHEMA_REPRESENTATION)
    - [JSON representation](https://docs.cloud.google.com/compute/docs/reference/rest/beta/instanceGroupManagers/get#body.InstanceGroupManager.SCHEMA_REPRESENTATION.update_policy.SCHEMA_REPRESENTATION_1)
    - [JSON representation](https://docs.cloud.google.com/compute/docs/reference/rest/beta/instanceGroupManagers/get#body.InstanceGroupManager.SCHEMA_REPRESENTATION.stateful_policy.SCHEMA_REPRESENTATION)
    - [JSON representation](https://docs.cloud.google.com/compute/docs/reference/rest/beta/instanceGroupManagers/get#body.InstanceGroupManager.SCHEMA_REPRESENTATION.instance_lifecycle_policy.SCHEMA_REPRESENTATION)
- [Authorization scopes](https://docs.cloud.google.com/compute/docs/reference/rest/beta/instanceGroupManagers/get#body.aspect)
- [Try it!](https://docs.cloud.google.com/compute/docs/reference/rest/beta/instanceGroupManagers/get#try-it)

Returns all of the details about the specified managed instance group.

### HTTP request

Choose an endpoint:
global africa-south1 asia-east1 asia-east2 asia-northeast1 asia-northeast2 asia-northeast3 asia-south1 asia-south2 asia-southeast1 asia-southeast2 asia-southeast3 australia-southeast1 australia-southeast2 europe-central2 europe-north1 europe-north2 europe-southwest1 europe-west1 europe-west10 europe-west12 europe-west2 europe-west3 europe-west4 europe-west6 europe-west8 europe-west9 me-central1 me-central2 me-west1 northamerica-northeast1 northamerica-northeast2 northamerica-south1 southamerica-east1 southamerica-west1 us-central1 us-east1 us-east4 us-east5 us-south1 us-west1 us-west2 us-west3 us-west4   
`GET https://compute.googleapis.com/compute/beta/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}`

<br />

The URLs use [gRPC Transcoding](https://google.aip.dev/127) syntax.

### Path parameters

| Parameters ||
|---|---|
| `project` | `string` Project ID for this request. |
| `zone` | `string` The name of the [zone](https://docs.cloud.google.com/compute/docs/regions-zones#available) where the managed instance group is located. |
| `instanceGroupManager` | `string` The name of the managed instance group. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `instanceGroupManager`: - `compute.instanceGroupManagers.get` |

### Request body

The request body must be empty.

### Response body

Represents a Managed Instance Group resource.

An instance group is a collection of VM instances that you can manage as a single entity. For more information, read [Instance groups](https://docs.cloud.google.com/compute/docs/instance-groups).

For zonal Managed Instance Group, use the `instanceGroupManagers` resource.

For regional Managed Instance Group, use the `regionInstanceGroupManagers` resource.

If successful, the response body contains data with the following structure:

| JSON representation |
|---|
| ``` { "kind": string, "id": string, "creationTimestamp": string, "name": string, "description": string, "zone": string, "region": string, "distributionPolicy": { "zones": [ { "zone": string, "maxSize": { "fixed": integer, "percent": integer, "calculated": integer } } ], "targetShape": enum }, "instanceTemplate": string, "versions": [ { "name": string, "instanceTemplate": string, "targetSize": { "fixed": integer, "percent": integer, "calculated": integer } } ], "allInstancesConfig": { "properties": { "metadata": { string: string, ... }, "labels": { string: string, ... }, "exposeHostTopology": boolean } }, "instanceGroup": string, "targetPools": [ string ], "baseInstanceName": string, "fingerprint": string, "currentActions": { "none": integer, "creating": integer, "creatingWithoutRetries": integer, "verifying": integer, "recreating": integer, "deleting": integer, "abandoning": integer, "restarting": integer, "restartingInPlace": integer, "refreshing": integer, "suspending": integer, "resuming": integer, "stopping": integer, "starting": integer, "adopting": integer }, "status": { "isStable": boolean, "allInstancesConfig": { "effective": boolean, "currentRevision": string }, "versionTarget": { "isReached": boolean }, "stateful": { "isStateful": boolean, "hasStatefulConfig": boolean, "perInstanceConfigs": { "allEffective": boolean } }, "autoscaler": string, "bulkInstanceOperation": { "inProgress": boolean, "lastProgressCheck": { "timestamp": string, "error": { "errors": [ { "code": string, "location": string, "message": string, "errorDetails": [ { // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "errorInfo": { "reason": string, "domain": string, "metadatas": { string: string, ... } }, "quotaInfo": { "metricName": string, "limitName": string, "dimensions": { string: string, ... }, "limit": number, "futureLimit": number, "rolloutStatus": enum }, "help": { "links": [ { "description": string, "url": string } ] }, "localizedMessage": { "locale": string, "message": string } // End of mutually exclusive fields. } ] } ] } } }, "appliedAcceleratorTopologies": [ { "acceleratorTopology": string, "state": enum, "stateDetails": { "timestamp": string, "error": { "errors": [ { "code": string, "location": string, "message": string, "errorDetails": [ { // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "errorInfo": { "reason": string, "domain": string, "metadatas": { string: string, ... } }, "quotaInfo": { "metricName": string, "limitName": string, "dimensions": { string: string, ... }, "limit": number, "futureLimit": number, "rolloutStatus": enum }, "help": { "links": [ { "description": string, "url": string } ] }, "localizedMessage": { "locale": string, "message": string } // End of mutually exclusive fields. } ] } ] } } } ], "currentInstanceStatuses": { "nonExistent": integer, "provisioning": integer, "staging": integer, "running": integer, "stopping": integer, "stopped": integer, "terminated": integer, "suspending": integer, "suspended": integer, "repairing": integer, "deprovisioning": integer, "pendingStop": integer, "pending": integer } }, "targetSize": integer, "targetSizePolicy": { "mode": enum }, "instanceFlexibilityPolicy": { "instanceSelections": { string: { "machineTypes": [ string ], "rank": integer, "minCpuPlatform": string, "disks": [ { "kind": string, "type": enum, "mode": enum, "savedState": enum, "source": string, "deviceName": string, "index": integer, "boot": boolean, "initializeParams": { "diskName": string, "sourceImage": string, "diskSizeGb": string, "diskType": string, "sourceImageEncryptionKey": { "sha256": string, "kmsKeyServiceAccount": string, // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "rawKey": string, "rsaEncryptedKey": string, "kmsKeyName": string // End of mutually exclusive fields. }, "labels": { string: string, ... }, "sourceSnapshot": string, "sourceInstantSnapshot": string, "sourceSnapshotEncryptionKey": { "sha256": string, "kmsKeyServiceAccount": string, // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "rawKey": string, "rsaEncryptedKey": string, "kmsKeyName": string // End of mutually exclusive fields. }, "description": string, "replicaZones": [ string ], "guestOsFeatures": [ { "type": enum } ], "resourcePolicies": [ string ], "onUpdateAction": enum, "provisionedIops": string, "multiWriter": boolean, "licenses": [ string ], "architecture": enum, "resourceManagerTags": { string: string, ... }, "provisionedThroughput": string, "enableConfidentialCompute": boolean, "storagePool": string }, "autoDelete": boolean, "licenses": [ string ], "interface": enum, "guestOsFeatures": [ { "type": enum } ], "diskEncryptionKey": { "rawKey": string, "rsaEncryptedKey": string, "kmsKeyName": string, "sha256": string, "kmsKeyServiceAccount": string }, "diskSizeGb": string, "shieldedInstanceInitialState": { "pk": { "content": string, "fileType": enum }, "keks": [ { "content": string, "fileType": enum } ], "dbs": [ { "content": string, "fileType": enum } ], "dbxs": [ { "content": string, "fileType": enum } ] }, "forceAttach": boolean, "locked": boolean, "architecture": enum } ] }, ... }, "provisioningModelMix": { "standardCapacityBase": integer, "standardCapacityPercentAboveBase": integer }, "constraints": { "singleMachineType": boolean } }, "targetStoppedSize": integer, "targetSuspendedSize": integer, "listManagedInstancesResults": enum, "standbyPolicy": { "initialDelaySec": integer, "mode": enum }, "selfLink": string, "autoHealingPolicies": [ { "healthCheck": string, "initialDelaySec": integer } ], "updatePolicy": { "type": enum, "instanceRedistributionType": enum, "minimalAction": enum, "mostDisruptiveAllowedAction": enum, "maxSurge": { "fixed": integer, "percent": integer, "calculated": integer }, "maxUnavailable": { "fixed": integer, "percent": integer, "calculated": integer }, "minReadySec": integer, "replacementMethod": enum, "allowedActions": [ enum ] }, "namedPorts": [ { "name": string, "port": integer } ], "serviceAccount": string, "failoverAction": enum, "statefulPolicy": { "preservedState": { "disks": { string: { "autoDelete": enum }, ... }, "internalIPs": { string: { "autoDelete": enum }, ... }, "externalIPs": { string: { "autoDelete": enum }, ... } } }, "instanceLifecyclePolicy": { "forceUpdateOnRepair": enum, "defaultActionOnFailure": enum, "onFailedHealthCheck": enum, "onRepair": { "allowChangingZone": enum } }, "params": { "resourceManagerTags": { string: string, ... } }, "satisfiesPzi": boolean, "satisfiesPzs": boolean, "resourcePolicies": { "workloadPolicy": string }, "multiMig": string } ``` |

| Fields ||
|---|---|
| `kind` | `string` Output only. The resource type, which is always `compute#instanceGroupManager` for managed instance groups. |
| `id` | `string (https://developers.google.com/discovery/v1/type-format format)` Output only. A unique identifier for this resource type. The server generates this identifier. |
| `creationTimestamp` | `string` Output only. The creation timestamp for this managed instance group in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| `name` | `string` The name of the managed instance group. The name must be 1-63 characters long, and comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). |
| `description` | `string` An optional description of this resource. |
| `zone` | `string` Output only. The URL of a [zone](https://docs.cloud.google.com/compute/docs/regions-zones#available) where the managed instance group is located (for zonal resources). |
| `region` | `string` Output only. The URL of the [region](https://docs.cloud.google.com/compute/docs/regions-zones#available) where the managed instance group resides (for regional resources). |
| `distributionPolicy` | `object` Policy specifying the intended distribution of managed instances across zones in a regional managed instance group. |
| `distributionPolicy.zones[]` | `object` Zones where the regional managed instance group will create and manage its instances. By default, a regional MIG doesn't automatically select an [AI zone](https://docs.cloud.google.com/compute/docs/regions-zones/ai-zones) to create instances, even if an AI zone is available in the specified region. To create instances in an AI zone in the selected region, you must explicitly specify it in the distribution policy together with the other preferred zones. |
| `distributionPolicy.zones[].zone` | `string` The URL of the [zone](https://docs.cloud.google.com/compute/docs/regions-zones#available). The zone must exist in the region where the managed instance group is located. |
| `distributionPolicy.zones[].maxSize` | `object` Optional. The maximum size of the group in this zone. This value can be either a fixed number or, a percentage. If you set a percentage, the number of instances is rounded up if necessary. If unset, it is interpreted as unbounded. |
| `distributionPolicy.zones[].maxSize.fixed` | `integer` Specifies a fixed number of VM instances. This must be a positive integer. |
| `distributionPolicy.zones[].maxSize.percent` | `integer` Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify `80` for 80%. |
| `distributionPolicy.zones[].maxSize.calculated` | `integer` Output only. Absolute value of VM instances calculated based on the specific mode. - If the value is `fixed`, then the `calculated` value is equal to the `fixed` value. - If the value is a `percent`, then the `calculated` value is `percent`/100 \* `targetSize`. For example, the `calculated` value of a 80% of a managed instance group with 150 instances would be (80/100 \* 150) = 120 VM instances. If there is a remainder, the number is rounded. |
| `distributionPolicy.targetShape` | `enum` The distribution shape to which the group converges either proactively or on resize events (depending on the value set in `updatePolicy.instanceRedistributionType`). |
| `instanceTemplate` | `string` The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run `recreateInstances`, run `applyUpdatesToInstances`, or set the group's `updatePolicy.type` to `PROACTIVE`. |
| `versions[]` | `object` Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an `instanceTemplate` and a `name`. Every version can appear at most once per instance group. This field overrides the top-level `instanceTemplate` field. Read more about the [relationships between these fields](https://docs.cloud.google.com/compute/docs/instance-groups/rolling-out-updates-to-managed-instance-groups#relationship_between_versions_and_instancetemplate_properties_for_a_managed_instance_group). Exactly one `version` must leave the `targetSize` field unset. That version will be applied to all remaining instances. For more information, read about [canary updates](https://docs.cloud.google.com/compute/docs/instance-groups/rolling-out-updates-to-managed-instance-groups#starting_a_canary_update). |
| `versions[].name` | `string` Name of the version. Unique among all versions in the scope of this managed instance group. |
| `versions[].instanceTemplate` | `string` The URL of the instance template that is specified for this managed instance group. The group uses this template to create new instances in the managed instance group until the `targetSize` for this version is reached. The templates for existing instances in the group do not change unless you run `recreateInstances`, run `applyUpdatesToInstances`, or set the group's `updatePolicy.type` to `PROACTIVE`; in those cases, existing instances are updated until the `targetSize` for this version is reached. |
| `versions[].targetSize` | `object` Specifies the intended number of instances to be created from the `instanceTemplate`. The final number of instances created from the template will be equal to: - If expressed as a fixed number, the minimum of either `targetSize.fixed` or `instanceGroupManager.targetSize` is used. - if expressed as a `percent`, the `targetSize` would be `(targetSize.percent/100 * InstanceGroupManager.targetSize)` If there is a remainder, the number is rounded. If unset, this version will update any remaining instances not updated by another `version`. Read [Starting a canary update](https://docs.cloud.google.com/compute/docs/instance-groups/rolling-out-updates-to-managed-instance-groups#starting_a_canary_update) for more information. <br /> |
| `versions[].targetSize.fixed` | `integer` Specifies a fixed number of VM instances. This must be a positive integer. |
| `versions[].targetSize.percent` | `integer` Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify `80` for 80%. |
| `versions[].targetSize.calculated` | `integer` Output only. Absolute value of VM instances calculated based on the specific mode. - If the value is `fixed`, then the `calculated` value is equal to the `fixed` value. - If the value is a `percent`, then the `calculated` value is `percent`/100 \* `targetSize`. For example, the `calculated` value of a 80% of a managed instance group with 150 instances would be (80/100 \* 150) = 120 VM instances. If there is a remainder, the number is rounded. |
| `allInstancesConfig` | `object` Specifies configuration that overrides the instance template configuration for the group. |
| `allInstancesConfig.properties` | `object` Properties to set on all instances in the group. You can add or modify properties using the `instanceGroupManagers.patch` or `regionInstanceGroupManagers.patch`. After setting `allInstancesConfig` on the group, you must update the group's instances to apply the configuration. To apply the configuration, set the group's `updatePolicy.type` field to use proactive updates or use the `applyUpdatesToInstances` method. |
| `allInstancesConfig.properties.metadata` | `map (key: string, value: string)` The metadata key-value pairs that you want to patch onto the instance. For more information, see [Project and instance metadata](https://docs.cloud.google.com/compute/docs/metadata#project_and_instance_metadata). |
| `allInstancesConfig.properties.labels` | `map (key: string, value: string)` The label key-value pairs that you want to patch onto the instance. |
| `allInstancesConfig.properties.exposeHostTopology` | `boolean` This optional flag exposes the hashed physical host ID. |
| `instanceGroup` | `string` Output only. The URL of the Instance Group resource. |
| `targetPools[]` | `string` The URLs for all TargetPool resources to which instances in the `instanceGroup` field are added. The target pools automatically apply to all of the instances in the managed instance group. |
| `baseInstanceName` | `string` The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt) format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern \[a-z\]((\[-a-z0-9\]{0,57})\|(\[-a-z0-9\]{0,51}-#{1,10}(\\\[\[0-9\]{1,10}\\\])?)) |
| `fingerprint` | `string (https://developers.google.com/discovery/v1/type-format format)` Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error `412 conditionNotMet`. To see the latest fingerprint, make a `get()` request to retrieve an InstanceGroupManager. A base64-encoded string. |
| `currentActions` | `object` Output only. The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. |
| `currentActions.none` | `integer` Output only. The number of instances in the managed instance group that are running and have no scheduled actions. |
| `currentActions.creating` | `integer` Output only. The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully. If you have disabled creation retries, this field will not be populated; instead, the `creatingWithoutRetries` field will be populated. |
| `currentActions.creatingWithoutRetries` | `integer` Output only. The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's `targetSize` value accordingly. |
| `currentActions.verifying` | `integer` Output only. The number of instances in the managed instance group that are being verified. See the `managedInstances[].currentAction` property in the `listManagedInstances` method documentation. |
| `currentActions.recreating` | `integer` Output only. The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template. |
| `currentActions.deleting` | `integer` Output only. The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted. |
| `currentActions.abandoning` | `integer` Output only. The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. |
| `currentActions.restarting` | `integer` Output only. The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted. |
| `currentActions.restartingInPlace` | `integer` Output only. The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted. |
| `currentActions.refreshing` | `integer` Output only. The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance. |
| `currentActions.suspending` | `integer` Output only. The number of instances in the managed instance group that are scheduled to be suspended or are currently being suspended. |
| `currentActions.resuming` | `integer` Output only. The number of instances in the managed instance group that are scheduled to be resumed or are currently being resumed. |
| `currentActions.stopping` | `integer` Output only. The number of instances in the managed instance group that are scheduled to be stopped or are currently being stopped. |
| `currentActions.starting` | `integer` Output only. The number of instances in the managed instance group that are scheduled to be started or are currently being started. |
| `currentActions.adopting` | `integer` Output only. The number of instances in the managed instance group that are scheduled to be adopted or are currently being adopted. |
| `status` | `object` Output only. The status of this managed instance group. |
| `status.isStable` | `boolean` Output only. A bit indicating whether the managed instance group is in a stable state. A stable state means that: none of the instances in the managed instance group is currently undergoing any type of change (for example, creation, restart, or deletion); no future changes are scheduled for instances in the managed instance group; and the managed instance group itself is not being modified. |
| `status.allInstancesConfig` | `object` Output only. Status of all-instances configuration on the group. |
| `status.allInstancesConfig.effective` | `boolean` Output only. A bit indicating whether this configuration has been applied to all managed instances in the group. |
| `status.allInstancesConfig.currentRevision` | `string` Output only. Current all-instances configuration revision. This value is in RFC3339 text format. |
| `status.versionTarget` | `object` Output only. A status of consistency of Instances' versions with their target version specified by `version` field on Instance Group Manager. |
| `status.versionTarget.isReached` | `boolean` Output only. A bit indicating whether version target has been reached in this managed instance group, i.e. all instances are in their target version. Instances' target version are specified by `version` field on Instance Group Manager. |
| `status.stateful` | `object` Output only. Stateful status of the given Instance Group Manager. |
| `status.stateful.isStateful (deprecated)` | `boolean` Output only. A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful configuration even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions. This field is deprecated in favor of hasStatefulConfig. |
| `status.stateful.hasStatefulConfig` | `boolean` Output only. A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful configuration even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions. |
| `status.stateful.perInstanceConfigs` | `object` Output only. Status of per-instance configurations on the instances. |
| `status.stateful.perInstanceConfigs.allEffective` | `boolean` Output only. A bit indicating if all of the group's per-instance configurations (listed in the output of a listPerInstanceConfigs API call) have status `EFFECTIVE` or there are no per-instance-configs. |
| `status.autoscaler` | `string` Output only. The URL of the [Autoscaler](https://docs.cloud.google.com/compute/docs/autoscaler) that targets this instance group manager. |
| `status.bulkInstanceOperation` | `object` Output only. The status of bulk instance operation. |
| `status.bulkInstanceOperation.inProgress` | `boolean` Output only. Informs whether bulk instance operation is in progress. |
| `status.bulkInstanceOperation.lastProgressCheck` | `object` Output only. Information from the last progress check of bulk instance operation. |
| `status.bulkInstanceOperation.lastProgressCheck.timestamp` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. Timestamp of the last progress check of bulk instance operation. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |
| `status.bulkInstanceOperation.lastProgressCheck.error` | `object` Output only. Errors encountered during bulk instance operation. |
| `status.bulkInstanceOperation.lastProgressCheck.error.errors[]` | `object` Output only. The array of errors encountered while processing this operation. |
| `status.bulkInstanceOperation.lastProgressCheck.error.errors[].code` | `string` Output only. The error type identifier for this error. |
| `status.bulkInstanceOperation.lastProgressCheck.error.errors[].location` | `string` Output only. Indicates the field in the request that caused the error. This property is optional. |
| `status.bulkInstanceOperation.lastProgressCheck.error.errors[].message` | `string` Output only. An optional, human-readable error message. |
| `status.bulkInstanceOperation.lastProgressCheck.error.errors[].errorDetails[]` | `object` Output only. An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. |
| `status.bulkInstanceOperation.lastProgressCheck.error.errors[].errorDetails[].errorInfo` | `object` Error information containing structured domain, reason, and metadata. |
| `status.bulkInstanceOperation.lastProgressCheck.error.errors[].errorDetails[].errorInfo.reason` | `string` The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `[A-Z][A-Z0-9_]+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. |
| `status.bulkInstanceOperation.lastProgressCheck.error.errors[].errorDetails[].errorInfo.domain` | `string` The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". |
| `status.bulkInstanceOperation.lastProgressCheck.error.errors[].errorDetails[].errorInfo.metadatas` | `map (key: string, value: string)` Additional structured details about this error. Keys must match a regular expression of `[a-z][a-zA-Z0-9-_]+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. |
| `status.bulkInstanceOperation.lastProgressCheck.error.errors[].errorDetails[].quotaInfo` | `object` Details about quota limits and metrics when a quota is exceeded. |
| `status.bulkInstanceOperation.lastProgressCheck.error.errors[].errorDetails[].quotaInfo.metricName` | `string` The Compute Engine quota metric name. |
| `status.bulkInstanceOperation.lastProgressCheck.error.errors[].errorDetails[].quotaInfo.limitName` | `string` The name of the quota limit. |
| `status.bulkInstanceOperation.lastProgressCheck.error.errors[].errorDetails[].quotaInfo.dimensions` | `map (key: string, value: string)` The map holding related quota dimensions. |
| `status.bulkInstanceOperation.lastProgressCheck.error.errors[].errorDetails[].quotaInfo.limit` | `number` Current effective quota limit. The limit's unit depends on the quota type or metric. |
| `status.bulkInstanceOperation.lastProgressCheck.error.errors[].errorDetails[].quotaInfo.futureLimit` | `number` Future quota limit being rolled out. The limit's unit depends on the quota type or metric. |
| `status.bulkInstanceOperation.lastProgressCheck.error.errors[].errorDetails[].quotaInfo.rolloutStatus` | `enum` Rollout status of the future quota limit. |
| `status.bulkInstanceOperation.lastProgressCheck.error.errors[].errorDetails[].help` | `object` Links and information to help the user resolve the error. |
| `status.bulkInstanceOperation.lastProgressCheck.error.errors[].errorDetails[].help.links[]` | `object` URL(s) pointing to additional information on handling the current error. |
| `status.bulkInstanceOperation.lastProgressCheck.error.errors[].errorDetails[].help.links[].description` | `string` Describes what the link offers. |
| `status.bulkInstanceOperation.lastProgressCheck.error.errors[].errorDetails[].help.links[].url` | `string` The URL of the link. |
| `status.bulkInstanceOperation.lastProgressCheck.error.errors[].errorDetails[].localizedMessage` | `object` A localized human-readable error message intended for end users. |
| `status.bulkInstanceOperation.lastProgressCheck.error.errors[].errorDetails[].localizedMessage.locale` | `string` The locale used following the specification defined at <https://www.rfc-editor.org/rfc/bcp/bcp47.txt>. Examples are: "en-US", "fr-CH", "es-MX" |
| `status.bulkInstanceOperation.lastProgressCheck.error.errors[].errorDetails[].localizedMessage.message` | `string` The localized error message in the above locale. |
| `status.appliedAcceleratorTopologies[]` | `object` Output only. The accelerator topology applied to this MIG. Currently only one accelerator topology is supported. |
| `status.appliedAcceleratorTopologies[].acceleratorTopology` | `string` Output only. Topology in the format of: "16x16", "4x4x4", etc. The value is the same as configured in the WorkloadPolicy. |
| `status.appliedAcceleratorTopologies[].state` | `enum` Output only. The state of the accelerator topology. |
| `status.appliedAcceleratorTopologies[].stateDetails` | `object` Output only. The result of the latest accelerator topology state check. |
| `status.appliedAcceleratorTopologies[].stateDetails.timestamp` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. Timestamp is shown only if there is an error. The field has // [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) // text format. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |
| `status.appliedAcceleratorTopologies[].stateDetails.error` | `object` Output only. Encountered errors. |
| `status.appliedAcceleratorTopologies[].stateDetails.error.errors[]` | `object` Output only. The array of errors encountered while processing this operation. |
| `status.appliedAcceleratorTopologies[].stateDetails.error.errors[].code` | `string` Output only. The error type identifier for this error. |
| `status.appliedAcceleratorTopologies[].stateDetails.error.errors[].location` | `string` Output only. Indicates the field in the request that caused the error. This property is optional. |
| `status.appliedAcceleratorTopologies[].stateDetails.error.errors[].message` | `string` Output only. An optional, human-readable error message. |
| `status.appliedAcceleratorTopologies[].stateDetails.error.errors[].errorDetails[]` | `object` Output only. An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. |
| `status.appliedAcceleratorTopologies[].stateDetails.error.errors[].errorDetails[].errorInfo` | `object` Error information containing structured domain, reason, and metadata. |
| `status.appliedAcceleratorTopologies[].stateDetails.error.errors[].errorDetails[].errorInfo.reason` | `string` The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `[A-Z][A-Z0-9_]+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. |
| `status.appliedAcceleratorTopologies[].stateDetails.error.errors[].errorDetails[].errorInfo.domain` | `string` The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". |
| `status.appliedAcceleratorTopologies[].stateDetails.error.errors[].errorDetails[].errorInfo.metadatas` | `map (key: string, value: string)` Additional structured details about this error. Keys must match a regular expression of `[a-z][a-zA-Z0-9-_]+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. |
| `status.appliedAcceleratorTopologies[].stateDetails.error.errors[].errorDetails[].quotaInfo` | `object` Details about quota limits and metrics when a quota is exceeded. |
| `status.appliedAcceleratorTopologies[].stateDetails.error.errors[].errorDetails[].quotaInfo.metricName` | `string` The Compute Engine quota metric name. |
| `status.appliedAcceleratorTopologies[].stateDetails.error.errors[].errorDetails[].quotaInfo.limitName` | `string` The name of the quota limit. |
| `status.appliedAcceleratorTopologies[].stateDetails.error.errors[].errorDetails[].quotaInfo.dimensions` | `map (key: string, value: string)` The map holding related quota dimensions. |
| `status.appliedAcceleratorTopologies[].stateDetails.error.errors[].errorDetails[].quotaInfo.limit` | `number` Current effective quota limit. The limit's unit depends on the quota type or metric. |
| `status.appliedAcceleratorTopologies[].stateDetails.error.errors[].errorDetails[].quotaInfo.futureLimit` | `number` Future quota limit being rolled out. The limit's unit depends on the quota type or metric. |
| `status.appliedAcceleratorTopologies[].stateDetails.error.errors[].errorDetails[].quotaInfo.rolloutStatus` | `enum` Rollout status of the future quota limit. |
| `status.appliedAcceleratorTopologies[].stateDetails.error.errors[].errorDetails[].help` | `object` Links and information to help the user resolve the error. |
| `status.appliedAcceleratorTopologies[].stateDetails.error.errors[].errorDetails[].help.links[]` | `object` URL(s) pointing to additional information on handling the current error. |
| `status.appliedAcceleratorTopologies[].stateDetails.error.errors[].errorDetails[].help.links[].description` | `string` Describes what the link offers. |
| `status.appliedAcceleratorTopologies[].stateDetails.error.errors[].errorDetails[].help.links[].url` | `string` The URL of the link. |
| `status.appliedAcceleratorTopologies[].stateDetails.error.errors[].errorDetails[].localizedMessage` | `object` A localized human-readable error message intended for end users. |
| `status.appliedAcceleratorTopologies[].stateDetails.error.errors[].errorDetails[].localizedMessage.locale` | `string` The locale used following the specification defined at <https://www.rfc-editor.org/rfc/bcp/bcp47.txt>. Examples are: "en-US", "fr-CH", "es-MX" |
| `status.appliedAcceleratorTopologies[].stateDetails.error.errors[].errorDetails[].localizedMessage.message` | `string` The localized error message in the above locale. |
| `status.currentInstanceStatuses` | `object` Output only. The list of instance statuses and the number of instances in this managed instance group that have the status. Currently only shown for TPU MIGs |
| `status.currentInstanceStatuses.nonExistent` | `integer` Output only. The number of instances that have not been created yet or have been deleted. Includes only instances that would be shown in the listManagedInstances method and not all instances that have been deleted in the lifetime of the MIG. Does not include FlexStart instances that are waiting for the resources availability, they are considered as 'pending'. |
| `status.currentInstanceStatuses.provisioning` | `integer` Output only. The number of instances in the managed instance group that have PROVISIONING status. |
| `status.currentInstanceStatuses.staging` | `integer` Output only. The number of instances in the managed instance group that have STAGING status. |
| `status.currentInstanceStatuses.running` | `integer` Output only. The number of instances in the managed instance group that have RUNNING status. |
| `status.currentInstanceStatuses.stopping` | `integer` Output only. The number of instances in the managed instance group that have STOPPING status. |
| `status.currentInstanceStatuses.stopped` | `integer` Output only. The number of instances in the managed instance group that have STOPPED status. |
| `status.currentInstanceStatuses.terminated` | `integer` Output only. The number of instances in the managed instance group that have TERMINATED status. |
| `status.currentInstanceStatuses.suspending` | `integer` Output only. The number of instances in the managed instance group that have SUSPENDING status. |
| `status.currentInstanceStatuses.suspended` | `integer` Output only. The number of instances in the managed instance group that have SUSPENDED status. |
| `status.currentInstanceStatuses.repairing` | `integer` Output only. The number of instances in the managed instance group that have REPAIRING status. |
| `status.currentInstanceStatuses.deprovisioning` | `integer` Output only. The number of instances in the managed instance group that have DEPROVISIONING status. |
| `status.currentInstanceStatuses.pendingStop` | `integer` Output only. The number of instances in the managed instance group that have PENDING_STOP status. |
| `status.currentInstanceStatuses.pending` | `integer` Output only. The number of instances in the managed instance group that have PENDING status, that is FlexStart instances that are waiting for resources. Instances that do not exist because of the other reasons are counted as 'nonExistent'. |
| `targetSize` | `integer` The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number. |
| `targetSizePolicy` | `object` The policy that specifies how the MIG creates its VMs to achieve the target size. |
| `targetSizePolicy.mode` | `enum` The mode of target size policy based on which the MIG creates its VMs individually or all at once. |
| `instanceFlexibilityPolicy` | `object` Instance flexibility allowing MIG to create VMs from multiple types of machines. Instance flexibility configuration on MIG overrides instance template configuration. |
| `instanceFlexibilityPolicy.instanceSelections[]` | `map (key: string, value: object)` Named instance selections configuring properties that the group will use when creating new VMs. |
| `instanceFlexibilityPolicy.instanceSelections[].machineTypes[]` | `string` Full machine-type names, e.g. "n1-standard-16". |
| `instanceFlexibilityPolicy.instanceSelections[].rank` | `integer` Preference of this instance selection. Lower number means higher preference. MIG will first try to create a VM based on the machine-type with lowest rank and fallback to next rank based on availability. Machine types and instance selections with the same rank have the same preference. |
| `instanceFlexibilityPolicy.instanceSelections[].minCpuPlatform` | `string` Name of the minimum CPU platform to be used by this instance selection. e.g. 'Intel Ice Lake'. |
| `instanceFlexibilityPolicy.instanceSelections[].disks[]` | `object` instanceGroupManagers.list of disks to be attached to the instances created from this selection. |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].kind` | `string` Output only. Type of the resource. Always `compute#attachedDisk` for attached disks. |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].type` | `enum` Specifies the type of the disk, either `SCRATCH` or `PERSISTENT`. If not specified, the default is `PERSISTENT`. |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].mode` | `enum` The mode in which to attach this disk, either `READ_WRITE` or `READ_ONLY`. If not specified, the default is to attach the disk in `READ_WRITE` mode. |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].savedState` | `enum` Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to `PRESERVED` if the LocalSSD data has been saved to a persistent location by customer request. (see the discardLocalSsd option on Stop/Suspend). Read-only in the api. |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].source` | `string` Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance boot disk, one of `initializeParams.sourceImage` or `initializeParams.sourceSnapshot` or `disks.source` is required. If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. Note that for InstanceTemplate, specify the disk name for zonal disk, and the URL for regional disk. |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].deviceName` | `string` Specifies a unique device name of your choice that is reflected into the `/dev/disk/by-id/google-*` tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form `persistent-disk-x`, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks. |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].index` | `integer` Output only. A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number. |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].boot` | `boolean` Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem. |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams` | `object` \[Input Only\] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. This property is mutually exclusive with the `source` property; you can only define one or the other, but not both. |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.diskName` | `string` Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created. |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.sourceImage` | `string` The source image to create this disk. When creating a new instance boot disk, one of `initializeParams.sourceImage` or `initializeParams.sourceSnapshot` or `disks.source` is required. To create a disk with one of the [public operating system images](https://docs.cloud.google.com/compute/docs/images/os-details), specify the image by its family name. For example, specify `family/debian-9` to use the latest Debian 9 image: `projects/debian-cloud/global/images/family/debian-9` <br /> Alternatively, use a specific version of a public operating system image: `projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD` <br /> To create a disk with a custom image that you created, specify the image name in the following format: `global/images/my-custom-image` <br /> You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with `family/family-name`: `global/images/family/my-image-family` <br /> If the source image is deleted later, this field will not be set. |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.diskSizeGb` | `string (https://developers.google.com/discovery/v1/type-format format)` Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a `sourceImage`, which is required for boot disks, the default size is the size of the `sourceImage`. If you do not specify a `sourceImage`, the default disk size is 500 GB. |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.diskType` | `string` Specifies the disk type used for the boot disk or an additional data disk. For valid disk type values, see [Supported types for Hyperdisk volumes](https://docs.cloud.google.com/compute/docs/disks/add-hyperdisk#hd_disk_types) and [Persistent Disk type variables](https://docs.cloud.google.com/compute/docs/disks/add-persistent-disk#hd_disk_types). When creating a single instance, you must provide either the full or partial URL of the disk type. For example, the following values are valid: - `https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType` - `projects/project/zones/zone/diskTypes/diskType` - `zones/zone/diskTypes/diskType` <br /> When creating an instance template, instance flexibility policy, or when creating or updating an all-instances configuration, you specify the disk type without a URL, for example, `hyperdisk-balanced`. If you omit this field for a disk, the default disk type depends on the instance's machine series, as follows. - For first- and second-generation machine series like N1, N2, T2, and M1, the default disk type is Standard Persistent Disk (`pd-standard`). - For C3, C3D, and M3 the default is Balanced Persistent Disk (`pd-balanced`). - For other third-generation machine series like A3, H3, Z3, all fourth-generation types like C4, N4, M4, and newer machine series, the default is Hyperdisk Balanced (`hyperdisk-balanced`). <br /> The disk type you specify must be compatible with the instance's machine series. For a list of machine series that support Persistent Disk, see [Machine series support for Persistent Disk](https://docs.cloud.google.com/compute/docs/disks/persistent-disks#pd-machine-series). For a list of machine series that support Hyperdisk, see [Machine series support for Hyperdisk](https://docs.cloud.google.com/compute/docs/disks/hyperdisks#machine-type-support). |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.sourceImageEncryptionKey` | `object` The [customer-supplied encryption key](https://docs.cloud.google.com/compute/docs/disks/customer-supplied-encryption) of the source image. Required if the source image is protected by a customer-supplied encryption key. InstanceTemplate and InstancePropertiesPatch do not store [customer-supplied encryption keys](https://docs.cloud.google.com/compute/docs/disks/customer-supplied-encryption), so you cannot create disks for instances in a [managed instance group](https://docs.cloud.google.com/compute/docs/instance-groups) if the source images are encrypted with your own keys. |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.sourceImageEncryptionKey.rawKey (deprecated)` | `string` \[DEPRECATED\] CSEK is no longer supported. Use CMEK instead. Specifies a 256-bit [customer-supplied encryption key](https://docs.cloud.google.com/compute/docs/disks/customer-supplied-encryption), encoded in [RFC 4648 base64](https://tools.ietf.org/html/rfc4648#section-4) to either encrypt or decrypt this resource. You can provide either the `rawKey` or the `rsaEncryptedKey`. For example: ```html "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" ``` <br /> |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.sourceImageEncryptionKey.rsaEncryptedKey (deprecated)` | `string` \[DEPRECATED\] CSEK is no longer supported. Use CMEK instead. Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit [customer-supplied encryption key](https://docs.cloud.google.com/compute/docs/disks/customer-supplied-encryption#rsa-encryption) to either encrypt or decrypt this resource. You can provide either the `rawKey` or the `rsaEncryptedKey`. For example: ```html "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" ``` The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in [RFC 4648 base64](https://tools.ietf.org/html/rfc4648#section-4) encoding. Gets the RSA public key certificate provided by Google at: ```html https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem ``` <br /> |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.sourceImageEncryptionKey.kmsKeyName` | `string` The name of the encryption key that is stored in Google Cloud KMS. For example: ```html "kmsKeyName": "projects/ kms_project_id/locations/ region/keyRings/ key_region/cryptoKeys/key ``` The fully-qualifed key name may be returned for resource GET requests. For example: ```html "kmsKeyName": "projects/ kms_project_id/locations/ region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1 ``` <br /> |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.sourceImageEncryptionKey.sha256 (deprecated)` | `string` \[DEPRECATED\] CSEK is no longer supported. Use CMEK instead. Output only. The [RFC 4648 base64](https://tools.ietf.org/html/rfc4648#section-4) encoded SHA-256 hash of the [customer-supplied encryption key](https://docs.cloud.google.com/compute/docs/disks/customer-supplied-encryption) that protects this resource. |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.sourceImageEncryptionKey.kmsKeyServiceAccount` | `string` The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: ```html "kmsKeyServiceAccount": "name@ projectId.iam.gserviceaccount.com/ ``` <br /> |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.labels` | `map (key: string, value: string)` Labels to apply to this disk. These can be later modified by the `disks.setLabels` method. This field is only applicable for persistent disks. |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.sourceSnapshot` | `string` The source snapshot to create this disk. When creating a new instance boot disk, one of `initializeParams.sourceSnapshot` or `initializeParams.sourceImage` or `disks.source` is required. To create a disk with a snapshot that you created, specify the snapshot name in the following format: `global/snapshots/my-backup` <br /> If the source snapshot is deleted later, this field will not be set. Note: You cannot create VMs in bulk using a snapshot as the source. Use an image instead when you create VMs using the [bulk insert method](https://docs.cloud.google.com/compute/docs/reference/rest/v1/instances/bulkInsert). |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.sourceInstantSnapshot` | `string` The source instant-snapshot to create this disk. When creating a new instance boot disk, one of `initializeParams.sourceSnapshot` or `initializeParams.sourceInstantSnapshot` `initializeParams.sourceImage` or `disks.source` is required. To create a disk with a snapshot that you created, specify the snapshot name in the following format: `us-central1-a/instantSnapshots/my-backup` <br /> If the source instant-snapshot is deleted later, this field will not be set. |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.sourceSnapshotEncryptionKey` | `object` The [customer-supplied encryption key](https://docs.cloud.google.com/compute/docs/disks/customer-supplied-encryption) of the source snapshot. |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.sourceSnapshotEncryptionKey.rawKey (deprecated)` | `string` \[DEPRECATED\] CSEK is no longer supported. Use CMEK instead. Specifies a 256-bit [customer-supplied encryption key](https://docs.cloud.google.com/compute/docs/disks/customer-supplied-encryption), encoded in [RFC 4648 base64](https://tools.ietf.org/html/rfc4648#section-4) to either encrypt or decrypt this resource. You can provide either the `rawKey` or the `rsaEncryptedKey`. For example: ```html "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" ``` <br /> |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.sourceSnapshotEncryptionKey.rsaEncryptedKey (deprecated)` | `string` \[DEPRECATED\] CSEK is no longer supported. Use CMEK instead. Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit [customer-supplied encryption key](https://docs.cloud.google.com/compute/docs/disks/customer-supplied-encryption#rsa-encryption) to either encrypt or decrypt this resource. You can provide either the `rawKey` or the `rsaEncryptedKey`. For example: ```html "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" ``` The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in [RFC 4648 base64](https://tools.ietf.org/html/rfc4648#section-4) encoding. Gets the RSA public key certificate provided by Google at: ```html https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem ``` <br /> |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.sourceSnapshotEncryptionKey.kmsKeyName` | `string` The name of the encryption key that is stored in Google Cloud KMS. For example: ```html "kmsKeyName": "projects/ kms_project_id/locations/ region/keyRings/ key_region/cryptoKeys/key ``` The fully-qualifed key name may be returned for resource GET requests. For example: ```html "kmsKeyName": "projects/ kms_project_id/locations/ region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1 ``` <br /> |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.sourceSnapshotEncryptionKey.sha256 (deprecated)` | `string` \[DEPRECATED\] CSEK is no longer supported. Use CMEK instead. Output only. The [RFC 4648 base64](https://tools.ietf.org/html/rfc4648#section-4) encoded SHA-256 hash of the [customer-supplied encryption key](https://docs.cloud.google.com/compute/docs/disks/customer-supplied-encryption) that protects this resource. |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.sourceSnapshotEncryptionKey.kmsKeyServiceAccount` | `string` The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: ```html "kmsKeyServiceAccount": "name@ projectId.iam.gserviceaccount.com/ ``` <br /> |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.description` | `string` An optional description. Provide this property when creating the disk. |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.replicaZones[]` | `string` Required for each regional disk associated with the instance. Specify the URLs of the zones where the disk should be replicated to. You must provide exactly two replica zones, and one zone must be the same as the instance zone. |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.guestOsFeatures[]` | `object` A list of features to enable on the guest operating system. Applicable only for bootable images. Read [Enabling guest operating system features](https://docs.cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features) to see a list of available options. Guest OS features are applied by merging `initializeParams.guestOsFeatures` and `disks.guestOsFeatures` |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.guestOsFeatures[].type` | `enum` The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - `VIRTIO_SCSI_MULTIQUEUE` - `WINDOWS` - `MULTI_IP_SUBNET` - `UEFI_COMPATIBLE` - `GVNIC` - `SEV_CAPABLE` - `SUSPEND_RESUME_COMPATIBLE` - `SEV_LIVE_MIGRATABLE_V2` - `SEV_SNP_CAPABLE` - `TDX_CAPABLE` - `IDPF` - `SNP_SVSM_CAPABLE` - `CCA_CAPABLE` - `SUSPEND_SAFE_FPR` For more information, see [Enabling guest operating system features](https://docs.cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features). <br /> |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.resourcePolicies[]` | `string` Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name. |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.onUpdateAction` | `enum` Specifies which action to take on instance update with this disk. Default is to use the existing disk. |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.provisionedIops` | `string (https://developers.google.com/discovery/v1/type-format format)` Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the [Extreme persistent disk documentation](https://docs.cloud.google.com/compute/docs/disks/extreme-persistent-disk). |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.multiWriter` | `boolean` Indicates whether or not the disk can be read/write attached to more than one instance. |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.licenses[]` | `string` A list of publicly visible licenses. Reserved for Google's use. |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.architecture` | `enum` The architecture of the attached disk. Valid values are arm64 or x86_64. |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.resourceManagerTags` | `map (key: string, value: string)` Input only. Resource manager tags to be bound to the disk. Tag keys and values have the same definition as [resource manager tags](https://cloud.google.com/resource-manager/docs/tags/tags-overview). Keys and values can be either in numeric format, such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in namespaced format such as `{org_id|projectId}/{tag_key_short_name}` and `{tag_value_short_name}`. The field is ignored (both PUT \& PATCH) when empty. |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.provisionedThroughput` | `string (https://developers.google.com/discovery/v1/type-format format)` Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must greater than or equal to 1. |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.enableConfidentialCompute` | `boolean` Whether this disk is using confidential compute mode. |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].initializeParams.storagePool` | `string` The storage pool in which the new disk is created. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - `https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool` - `projects/project/zones/zone/storagePools/storagePool` - `zones/zone/storagePools/storagePool` <br /> |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].autoDelete` | `boolean` Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance). |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].licenses[]` | `string` Output only. Any valid publicly visible licenses. |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].interface` | `enum` Specifies the disk interface to use for attaching this disk, which is either `SCSI` or `NVME`. For most machine types, the default is `SCSI`. Local SSDs can use either NVME or SCSI. In certain configurations, persistent disks can use NVMe. For more information, see [About persistent disks](https://cloud.google.com/compute/docs/disks/persistent-disks). |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].guestOsFeatures[]` | `object` A list of features to enable on the guest operating system. Applicable only for bootable images. Read [Enabling guest operating system features](https://docs.cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features) to see a list of available options. |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].guestOsFeatures[].type` | `enum` The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - `VIRTIO_SCSI_MULTIQUEUE` - `WINDOWS` - `MULTI_IP_SUBNET` - `UEFI_COMPATIBLE` - `GVNIC` - `SEV_CAPABLE` - `SUSPEND_RESUME_COMPATIBLE` - `SEV_LIVE_MIGRATABLE_V2` - `SEV_SNP_CAPABLE` - `TDX_CAPABLE` - `IDPF` - `SNP_SVSM_CAPABLE` - `CCA_CAPABLE` - `SUSPEND_SAFE_FPR` For more information, see [Enabling guest operating system features](https://docs.cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features). <br /> |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].diskEncryptionKey` | `object` Encrypts or decrypts a disk using a [customer-supplied encryption key](https://docs.cloud.google.com/compute/docs/disks/customer-supplied-encryption). If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key. If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance. If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. Note: Instance templates do not store [customer-supplied encryption keys](https://docs.cloud.google.com/compute/docs/disks/customer-supplied-encryption), so you cannot use your own keys to encrypt disks in a [managed instance group](https://docs.cloud.google.com/compute/docs/instance-groups). You cannot create VMs that have disks with customer-supplied keys using the [bulk insert method](https://docs.cloud.google.com/compute/docs/reference/rest/v1/instances/bulkInsert). |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].diskEncryptionKey.rawKey (deprecated)` | `string` \[DEPRECATED\] CSEK is no longer supported. Use CMEK instead. Specifies a 256-bit [customer-supplied encryption key](https://docs.cloud.google.com/compute/docs/disks/customer-supplied-encryption), encoded in [RFC 4648 base64](https://tools.ietf.org/html/rfc4648#section-4) to either encrypt or decrypt this resource. You can provide either the `rawKey` or the `rsaEncryptedKey`. For example: ```html "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=" ``` <br /> |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].diskEncryptionKey.rsaEncryptedKey (deprecated)` | `string` \[DEPRECATED\] CSEK is no longer supported. Use CMEK instead. Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit [customer-supplied encryption key](https://docs.cloud.google.com/compute/docs/disks/customer-supplied-encryption#rsa-encryption) to either encrypt or decrypt this resource. You can provide either the `rawKey` or the `rsaEncryptedKey`. For example: ```html "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" ``` The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in [RFC 4648 base64](https://tools.ietf.org/html/rfc4648#section-4) encoding. Gets the RSA public key certificate provided by Google at: ```html https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem ``` <br /> |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].diskEncryptionKey.kmsKeyName` | `string` The name of the encryption key that is stored in Google Cloud KMS. For example: ```html "kmsKeyName": "projects/ kms_project_id/locations/ region/keyRings/ key_region/cryptoKeys/key ``` The fully-qualifed key name may be returned for resource GET requests. For example: ```html "kmsKeyName": "projects/ kms_project_id/locations/ region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1 ``` <br /> |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].diskEncryptionKey.sha256 (deprecated)` | `string` \[DEPRECATED\] CSEK is no longer supported. Use CMEK instead. Output only. The [RFC 4648 base64](https://tools.ietf.org/html/rfc4648#section-4) encoded SHA-256 hash of the [customer-supplied encryption key](https://docs.cloud.google.com/compute/docs/disks/customer-supplied-encryption) that protects this resource. |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].diskEncryptionKey.kmsKeyServiceAccount` | `string` The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: ```html "kmsKeyServiceAccount": "name@ projectId.iam.gserviceaccount.com/ ``` <br /> |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].diskSizeGb` | `string (https://developers.google.com/discovery/v1/type-format format)` The size of the disk in GB. |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].shieldedInstanceInitialState` | `object` Output only. shielded vm initial state stored on disk |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].shieldedInstanceInitialState.pk` | `object` The Platform Key (PK). |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].shieldedInstanceInitialState.pk.content` | `string (https://developers.google.com/discovery/v1/type-format format)` The raw content in the secure keys file. A base64-encoded string. |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].shieldedInstanceInitialState.pk.fileType` | `enum` The file type of source file. |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].shieldedInstanceInitialState.keks[]` | `object` The Key Exchange Key (KEK). |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].shieldedInstanceInitialState.keks[].content` | `string (https://developers.google.com/discovery/v1/type-format format)` The raw content in the secure keys file. A base64-encoded string. |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].shieldedInstanceInitialState.keks[].fileType` | `enum` The file type of source file. |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].shieldedInstanceInitialState.dbs[]` | `object` The Key Database (db). |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].shieldedInstanceInitialState.dbs[].content` | `string (https://developers.google.com/discovery/v1/type-format format)` The raw content in the secure keys file. A base64-encoded string. |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].shieldedInstanceInitialState.dbs[].fileType` | `enum` The file type of source file. |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].shieldedInstanceInitialState.dbxs[]` | `object` The forbidden key database (dbx). |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].shieldedInstanceInitialState.dbxs[].content` | `string (https://developers.google.com/discovery/v1/type-format format)` The raw content in the secure keys file. A base64-encoded string. |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].shieldedInstanceInitialState.dbxs[].fileType` | `enum` The file type of source file. |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].forceAttach` | `boolean` \[Input Only\] Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error. |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].locked` | `boolean` Output only. Whether to indicate the attached disk is locked. The locked disk is not allowed to be detached from the instance, or to be used as the source of the snapshot creation, and the image creation. The instance with at least one locked attached disk is not allow to be used as source of machine image creation, instant snapshot creation, and not allowed to be deleted with --keep-disk parameter set to true for locked disks. |
| `instanceFlexibilityPolicy.instanceSelections[].disks[].architecture` | `enum` Output only. The architecture of the attached disk. Valid values are ARM64 or X86_64. |
| `instanceFlexibilityPolicy.provisioningModelMix` | `object` Provisioning model configuration used by this managed instance group to create instances. |
| `instanceFlexibilityPolicy.provisioningModelMix.standardCapacityBase` | `integer` The base capacity that will always use Standard VMs to avoid risk of more preemption than the minimum capacity user needs. MIG will create only Standard VMs until it reaches standardCapacityBase and only then will start using standardCapacityPercentAboveBase to mix Spot with Standard VMs. |
| `instanceFlexibilityPolicy.provisioningModelMix.standardCapacityPercentAboveBase` | `integer` The percentage of target capacity that should use Standard VM. The remaining percentage will use Spot VMs. The percentage applies only to the capacity above standardCapacityBase. |
| `instanceFlexibilityPolicy.constraints` | `object` Constraints applied to instance flexibility spreading and selection. |
| `instanceFlexibilityPolicy.constraints.singleMachineType` | `boolean` When set to true, all instances in the group will be provisioned with the exact same machine type, ensuring cluster homogeneity across zones. Defaults to false. |
| `targetStoppedSize` | `integer` The target number of stopped instances for this managed instance group. This number changes when you: - Stop instance using the [stopInstances](https://docs.cloud.google.com/compute/docs/reference/beta/instanceGroupManagers/stopInstances) method or start instances using the [startInstances](https://docs.cloud.google.com/compute/docs/reference/beta/instanceGroupManagers/startInstances) method. - Manually change the `targetStoppedSize` using the [update](https://docs.cloud.google.com/compute/docs/reference/rest/beta/instanceGroupManagers/update) method. <br /> |
| `targetSuspendedSize` | `integer` The target number of suspended instances for this managed instance group. This number changes when you: - Suspend instance using the [suspendInstances](https://docs.cloud.google.com/compute/docs/reference/beta/instanceGroupManagers/suspendInstances) method or resume instances using the [resumeInstances](https://docs.cloud.google.com/compute/docs/reference/beta/instanceGroupManagers/resumeInstances) method. - Manually change the `targetSuspendedSize` using the [update](https://docs.cloud.google.com/compute/docs/reference/rest/beta/instanceGroupManagers/update) method. <br /> |
| `listManagedInstancesResults` | `enum` Pagination behavior of the `listManagedInstances` API method for this managed instance group. |
| `standbyPolicy` | `object` Standby policy for stopped and suspended instances. |
| `standbyPolicy.initialDelaySec` | `integer` Specifies the number of seconds that the MIG should wait to suspend or stop a VM after that VM was created. The initial delay gives the initialization script the time to prepare your VM for a quick scale out. The value of initial delay must be between 0 and 3600 seconds. The default value is 0. |
| `standbyPolicy.mode` | `enum` Defines how a MIG resumes or starts VMs from a standby pool when the group scales out. The default mode is `MANUAL`. |
| `selfLink` | `string` Output only. The URL for this managed instance group. The server defines this URL. |
| `autoHealingPolicies[]` | `object` The autohealing policy for this managed instance group. You can specify only one value. |
| `autoHealingPolicies[].healthCheck` | `string` The URL for the health check that signals autohealing. |
| `autoHealingPolicies[].initialDelaySec` | `integer` The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0. |
| `updatePolicy` | `object` The update policy for this managed instance group. |
| `updatePolicy.type` | `enum` The [type of update process](https://docs.cloud.google.com/compute/docs/instance-groups/updating-migs#choosing_between_automated_and_selective_updates). You can specify either `PROACTIVE` so that the MIG automatically updates VMs to the latest configurations or `OPPORTUNISTIC` so that you can select the VMs that you want to update. |
| `updatePolicy.instanceRedistributionType` | `enum` The [instance redistribution policy](https://docs.cloud.google.com/compute/docs/instance-groups/regional-migs#proactive_instance_redistribution) for regional managed instance groups. Valid values are: - `PROACTIVE` (default): The group attempts to maintain an even distribution of VM instances across zones in the region. - `NONE`: For non-autoscaled groups, proactive redistribution is disabled. <br /> |
| `updatePolicy.minimalAction` | `enum` Minimal action to be taken on an instance. Use this option to minimize disruption as much as possible or to apply a more disruptive action than is necessary. - To limit disruption as much as possible, set the minimal action to `REFRESH`. If your update requires a more disruptive action, Compute Engine performs the necessary action to execute the update. - To apply a more disruptive action than is strictly necessary, set the minimal action to `RESTART` or `REPLACE`. For example, Compute Engine does not need to restart a VM to change its metadata. But if your application reads instance metadata only when a VM is restarted, you can set the minimal action to `RESTART` in order to pick up metadata changes. <br /> |
| `updatePolicy.mostDisruptiveAllowedAction` | `enum` Most disruptive action that is allowed to be taken on an instance. You can specify either `NONE` to forbid any actions, `REFRESH` to avoid restarting the VM and to limit disruption as much as possible. `RESTART` to allow actions that can be applied without instance replacing or `REPLACE` to allow all possible actions. If the Updater determines that the minimal update action needed is more disruptive than most disruptive allowed action you specify it will not perform the update at all. |
| `updatePolicy.maxSurge` | `object` The maximum number of instances that can be created above the specified `targetSize` during the update process. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for `maxSurge` is a fixed value equal to the number of zones in which the managed instance group operates. At least one of either `maxSurge` or `maxUnavailable` must be greater than 0. Learn more about [`maxSurge`](https://docs.cloud.google.com/compute/docs/instance-groups/rolling-out-updates-to-managed-instance-groups#maxSurge). |
| `updatePolicy.maxSurge.fixed` | `integer` Specifies a fixed number of VM instances. This must be a positive integer. |
| `updatePolicy.maxSurge.percent` | `integer` Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify `80` for 80%. |
| `updatePolicy.maxSurge.calculated` | `integer` Output only. Absolute value of VM instances calculated based on the specific mode. - If the value is `fixed`, then the `calculated` value is equal to the `fixed` value. - If the value is a `percent`, then the `calculated` value is `percent`/100 \* `targetSize`. For example, the `calculated` value of a 80% of a managed instance group with 150 instances would be (80/100 \* 150) = 120 VM instances. If there is a remainder, the number is rounded. |
| `updatePolicy.maxUnavailable` | `object` The maximum number of instances that can be unavailable during the update process. An instance is considered available if all of the following conditions are satisfied: - The instance's [status](https://docs.cloud.google.com/compute/docs/instances/checking-instance-status) is `RUNNING`. - If there is a [health check](https://docs.cloud.google.com/compute/docs/instance-groups/autohealing-instances-in-migs) on the instance group, the instance's health check status must be `HEALTHY` at least once. If there is no health check on the group, then the instance only needs to have a status of `RUNNING` to be considered available. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for `maxUnavailable` is a fixed value equal to the number of zones in which the managed instance group operates. At least one of either `maxSurge` or `maxUnavailable` must be greater than 0. Learn more about [`maxUnavailable`](https://docs.cloud.google.com/compute/docs/instance-groups/rolling-out-updates-to-managed-instance-groups#maxUnavailable). |
| `updatePolicy.maxUnavailable.fixed` | `integer` Specifies a fixed number of VM instances. This must be a positive integer. |
| `updatePolicy.maxUnavailable.percent` | `integer` Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify `80` for 80%. |
| `updatePolicy.maxUnavailable.calculated` | `integer` Output only. Absolute value of VM instances calculated based on the specific mode. - If the value is `fixed`, then the `calculated` value is equal to the `fixed` value. - If the value is a `percent`, then the `calculated` value is `percent`/100 \* `targetSize`. For example, the `calculated` value of a 80% of a managed instance group with 150 instances would be (80/100 \* 150) = 120 VM instances. If there is a remainder, the number is rounded. |
| `updatePolicy.minReadySec` | `integer` Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range \[0, 3600\]. |
| `updatePolicy.replacementMethod` | `enum` What action should be used to replace instances. See minimalAction.REPLACE |
| `updatePolicy.allowedActions[]` | `enum` Actions that are allowed to update instances within MIG. |
| `namedPorts[]` | `object` Output only. Named ports configured on the Instance Groups complementary to this Instance Group Manager. |
| `namedPorts[].name` | `string` The name for this named port. The name must be 1-63 characters long, and comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). |
| `namedPorts[].port` | `integer` The port number, which can be a value between 1 and 65535. |
| `serviceAccount` | `string` The service account to be used as credentials for all operations performed by the managed instance group on instances. The service accounts needs all permissions required to create and delete instances. By default, the service account {projectNumber}@cloudservices.gserviceaccount.com is used. |
| `failoverAction` | `enum` The action to perform in case of zone failure. Only one value is supported, `NO_FAILOVER`. The default is `NO_FAILOVER`. |
| `statefulPolicy` | `object` Stateful configuration for this Instanced Group Manager |
| `statefulPolicy.preservedState` | `object` |
| `statefulPolicy.preservedState.disks[]` | `map (key: string, value: object)` Disks created on the instances that will be preserved on instance delete, update, etc. This map is keyed with the device names of the disks. |
| `statefulPolicy.preservedState.disks[].autoDelete` | `enum` These stateful disks will never be deleted during autohealing, update or VM instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. Note: disks attached in `READ_ONLY` mode cannot be auto-deleted. |
| `statefulPolicy.preservedState.internalIPs[]` | `map (key: string, value: object)` Internal network IPs assigned to the instances that will be preserved on instance delete, update, etc. This map is keyed with the network interface name. |
| `statefulPolicy.preservedState.internalIPs[].autoDelete` | `enum` These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. |
| `statefulPolicy.preservedState.externalIPs[]` | `map (key: string, value: object)` External network IPs assigned to the instances that will be preserved on instance delete, update, etc. This map is keyed with the network interface name. |
| `statefulPolicy.preservedState.externalIPs[].autoDelete` | `enum` These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. |
| `instanceLifecyclePolicy` | `object` The repair policy for this managed instance group. |
| `instanceLifecyclePolicy.forceUpdateOnRepair` | `enum` A bit indicating whether to forcefully apply the group's latest configuration when repairing a VM. Valid options are: - NO (default): If configuration updates are available, they are not forcefully applied during repair. Instead, configuration updates are applied according to the group's update policy. - YES: If configuration updates are available, they are applied during repair. |
| `instanceLifecyclePolicy.defaultActionOnFailure` | `enum` The action that a MIG performs on a failed VM. If the value of the onFailedHealthCheck field is `DEFAULT_ACTION`, then the same action also applies to the VMs on which your application fails a health check. Valid values are - `REPAIR` (default): MIG automatically repairs a failed VM by recreating it. For more information, see [About repairing VMs in a MIG](https://cloud.google.com/compute/docs/instance-groups/about-repair). - `DO_NOTHING`: MIG does not repair a failed VM. <br /> |
| `instanceLifecyclePolicy.onFailedHealthCheck` | `enum` The action that a MIG performs on an unhealthy VM. A VM is marked as unhealthy when the application running on that VM fails a health check. Valid values are: - `DEFAULT_ACTION (default)`: MIG uses the same action configured for instanceLifecyclePolicy.defaultActionOnFailure field. - `REPAIR`: MIG automatically repairs an unhealthy VM by recreating it. - `DO_NOTHING`: MIG doesn't repair an unhealthy VM. For more information, see [About repairing VMs in a MIG](https://cloud.google.com/compute/docs/instance-groups/about-repair). <br /> |
| `instanceLifecyclePolicy.onRepair` | `object` Configuration for VM repairs in the MIG. |
| `instanceLifecyclePolicy.onRepair.allowChangingZone` | `enum` Specifies whether the MIG can change a VM's zone during a repair. Valid values are: - `NO (default)`: MIG cannot change a VM's zone during a repair. - `YES`: MIG can select a different zone for the VM during a repair. |
| `params` | `object` Input only. Additional params passed with the request, but not persisted as part of resource payload. |
| `params.resourceManagerTags` | `map (key: string, value: string)` Input only. Resource manager tags to bind to the managed instance group. The tags are key-value pairs. Keys and values can be either in numeric format, such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced format such as `{org_id|projectId}/{tag_key_short_name}` and `{tag_value_short_name}`. For more information, see [Manage tags for resources](https://cloud.google.com/compute/docs/tag-resources). |
| `satisfiesPzi` | `boolean` Output only. Reserved for future use. |
| `satisfiesPzs` | `boolean` Output only. Reserved for future use. |
| `resourcePolicies` | `object` Resource policies for this managed instance group. |
| `resourcePolicies.workloadPolicy` | `string` The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - `https://www.googleapis.com/compute/v1/projects/project/regions/region/resourcePolicies/resourcePolicy` - `projects/project/regions/region/resourcePolicies/resourcePolicy` - `regions/region/resourcePolicies/resourcePolicy` <br /> |
| `multiMig` | `string` URL to the multi-MIG that this Managed Instance Group belongs to. |

### Authorization scopes

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-platform`

For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp).