Method: googleapis.compute.v1.instanceGroupManagers.patch

Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listManagedInstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG.

This method waits—the workflow execution is paused—until the operation is complete, fails, or times out. The default timeout value is 1800 seconds (30 minutes) and can be changed to a maximum value of 31536000 seconds (one year) for long-running operations using the connector_params field. See the Connectors reference.

The connector uses polling to monitor the long-running operation, which might generate additional billable steps. For more information about retries and long-running operations, refer to Understand connectors.

The polling policy for the long-running operation can be configured. To set the connector-specific parameters (connector_params), refer to Invoke a connector call.

Arguments

Parameters
`instanceGroupManager`	`string` Required. The name of the instance group manager.
`project`	`string` Required. Project ID for this request.
`zone`	`string` Required. The name of the zone where you want to create the managed instance group.
`requestId`	`string` An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
`body`	`object (InstanceGroupManager)` Required.

Raised exceptions

Exceptions
`ConnectionError`	In case of a network problem (such as DNS failure or refused connection).
`HttpError`	If the response status is >= 400 (excluding 429 and 503).
`TimeoutError`	If a long-running operation takes longer to finish than the specified timeout limit.
`TypeError`	If an operation or function receives an argument of the wrong type.
`ValueError`	If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.
`OperationError`	If the long-running operation finished unsuccessfully.
`ResponseTypeError`	If the long-running operation returned a response of the wrong type.

Response

If successful, the response contains an instance of Operation.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- patch:
    call: googleapis.compute.v1.instanceGroupManagers.patch
    args:
        instanceGroupManager: ...
        project: ...
        zone: ...
        requestId: ...
        body:
            autoHealingPolicies: ...
            baseInstanceName: ...
            description: ...
            distributionPolicy:
                targetShape: ...
                zones: ...
            fingerprint: ...
            instanceLifecyclePolicy:
                forceUpdateOnRepair: ...
            instanceTemplate: ...
            listManagedInstancesResults: ...
            name: ...
            namedPorts: ...
            statefulPolicy:
                preservedState:
                    disks: ...
            targetPools: ...
            targetSize: ...
            updatePolicy:
                instanceRedistributionType: ...
                maxSurge:
                    fixed: ...
                    percent: ...
                maxUnavailable: ...
                minimalAction: ...
                mostDisruptiveAllowedAction: ...
                replacementMethod: ...
                type: ...
            versions: ...
    result: patchResult

JSON

[
  {
    "patch": {
      "call": "googleapis.compute.v1.instanceGroupManagers.patch",
      "args": {
        "instanceGroupManager": "...",
        "project": "...",
        "zone": "...",
        "requestId": "...",
        "body": {
          "autoHealingPolicies": "...",
          "baseInstanceName": "...",
          "description": "...",
          "distributionPolicy": {
            "targetShape": "...",
            "zones": "..."
          },
          "fingerprint": "...",
          "instanceLifecyclePolicy": {
            "forceUpdateOnRepair": "..."
          },
          "instanceTemplate": "...",
          "listManagedInstancesResults": "...",
          "name": "...",
          "namedPorts": "...",
          "statefulPolicy": {
            "preservedState": {
              "disks": "..."
            }
          },
          "targetPools": "...",
          "targetSize": "...",
          "updatePolicy": {
            "instanceRedistributionType": "...",
            "maxSurge": {
              "fixed": "...",
              "percent": "..."
            },
            "maxUnavailable": "...",
            "minimalAction": "...",
            "mostDisruptiveAllowedAction": "...",
            "replacementMethod": "...",
            "type": "..."
          },
          "versions": "..."
        }
      },
      "result": "patchResult"
    }
  }
]