| Craig Citro | 0e5b9bf | 2014-10-15 10:26:14 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.instanceTemplates.html">instanceTemplates</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 78 | <code><a href="#delete">delete(project, instanceTemplate, requestId=None)</a></code></p> |
| 79 | <p class="firstline">Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone. It is not possible to delete templates that are already in use by a managed instance group.</p> |
| Craig Citro | 0e5b9bf | 2014-10-15 10:26:14 -0700 | [diff] [blame] | 80 | <p class="toc_element"> |
| 81 | <code><a href="#get">get(project, instanceTemplate)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 82 | <p class="firstline">Returns the specified instance template. Gets a list of available instance templates by making a list() request.</p> |
| Craig Citro | 0e5b9bf | 2014-10-15 10:26:14 -0700 | [diff] [blame] | 83 | <p class="toc_element"> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 84 | <code><a href="#getIamPolicy">getIamPolicy(project, resource)</a></code></p> |
| 85 | <p class="firstline">Gets the access control policy for a resource. May be empty if no such policy or resource exists.</p> |
| 86 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 87 | <code><a href="#insert">insert(project, body=None, requestId=None)</a></code></p> |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 88 | <p class="firstline">Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template.</p> |
| Craig Citro | 0e5b9bf | 2014-10-15 10:26:14 -0700 | [diff] [blame] | 89 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 90 | <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 91 | <p class="firstline">Retrieves a list of instance templates that are contained within the specified project.</p> |
| Craig Citro | 0e5b9bf | 2014-10-15 10:26:14 -0700 | [diff] [blame] | 92 | <p class="toc_element"> |
| 93 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 94 | <p class="firstline">Retrieves the next page of results.</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 95 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 96 | <code><a href="#setIamPolicy">setIamPolicy(project, resource, body=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 97 | <p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p> |
| 98 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 99 | <code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 100 | <p class="firstline">Returns permissions that a caller has on the specified resource.</p> |
| Craig Citro | 0e5b9bf | 2014-10-15 10:26:14 -0700 | [diff] [blame] | 101 | <h3>Method Details</h3> |
| 102 | <div class="method"> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 103 | <code class="details" id="delete">delete(project, instanceTemplate, requestId=None)</code> |
| 104 | <pre>Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone. It is not possible to delete templates that are already in use by a managed instance group. |
| Craig Citro | 0e5b9bf | 2014-10-15 10:26:14 -0700 | [diff] [blame] | 105 | |
| 106 | Args: |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 107 | project: string, Project ID for this request. (required) |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 108 | instanceTemplate: string, The name of the instance template to delete. (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 109 | 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. |
| 110 | |
| 111 | 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. |
| 112 | |
| 113 | The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
| Craig Citro | 0e5b9bf | 2014-10-15 10:26:14 -0700 | [diff] [blame] | 114 | |
| 115 | Returns: |
| 116 | An object of the form: |
| 117 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 118 | { # Represents an Operation resource. |
| 119 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 120 | # Google Compute Engine has three Operation resources: |
| 121 | # |
| 122 | # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) |
| 123 | # |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 124 | # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. |
| 125 | # |
| 126 | # Operations can be global, regional or zonal. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 127 | # - For global operations, use the `globalOperations` resource. |
| 128 | # - For regional operations, use the `regionOperations` resource. |
| 129 | # - For zonal operations, use the `zonalOperations` resource. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 130 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 131 | # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 132 | "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| 133 | "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| 134 | "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| 135 | "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| 136 | "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| 137 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| Craig Citro | 0e5b9bf | 2014-10-15 10:26:14 -0700 | [diff] [blame] | 138 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 139 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 140 | "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| 141 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| Craig Citro | 0e5b9bf | 2014-10-15 10:26:14 -0700 | [diff] [blame] | 142 | }, |
| 143 | ], |
| 144 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 145 | "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. |
| 146 | "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. |
| 147 | "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. |
| 148 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| 149 | "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. |
| 150 | "name": "A String", # [Output Only] Name of the operation. |
| 151 | "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. |
| 152 | "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. |
| 153 | "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
| 154 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 155 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| 156 | "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. |
| 157 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 158 | "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| 159 | "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. |
| 160 | "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. |
| 161 | "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| 162 | { |
| 163 | "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. |
| 164 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| 165 | # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| 166 | { |
| 167 | "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). |
| 168 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 169 | }, |
| 170 | ], |
| 171 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 172 | }, |
| 173 | ], |
| 174 | "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
| Craig Citro | 0e5b9bf | 2014-10-15 10:26:14 -0700 | [diff] [blame] | 175 | }</pre> |
| 176 | </div> |
| 177 | |
| 178 | <div class="method"> |
| 179 | <code class="details" id="get">get(project, instanceTemplate)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 180 | <pre>Returns the specified instance template. Gets a list of available instance templates by making a list() request. |
| Craig Citro | 0e5b9bf | 2014-10-15 10:26:14 -0700 | [diff] [blame] | 181 | |
| 182 | Args: |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 183 | project: string, Project ID for this request. (required) |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 184 | instanceTemplate: string, The name of the instance template. (required) |
| Craig Citro | 0e5b9bf | 2014-10-15 10:26:14 -0700 | [diff] [blame] | 185 | |
| 186 | Returns: |
| 187 | An object of the form: |
| 188 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 189 | { # Represents an Instance Template resource. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 190 | # |
| 191 | # You can use instance templates to create VM instances and managed instance groups. For more information, read Instance Templates. (== resource_for {$api_version}.instanceTemplates ==) |
| 192 | "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance template in RFC3339 text format. |
| 193 | "description": "A String", # An optional description of this resource. Provide this property when you create the resource. |
| 194 | "id": "A String", # [Output Only] A unique identifier for this instance template. The server defines this identifier. |
| 195 | "kind": "compute#instanceTemplate", # [Output Only] The resource type, which is always compute#instanceTemplate for instance templates. |
| 196 | "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. |
| 197 | "properties": { # The instance properties for this instance template. |
| 198 | "canIpForward": True or False, # Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information. |
| 199 | "description": "A String", # An optional text description for the instances that are created from this instance template. |
| 200 | "disks": [ # An array of disks that are associated with the instances that are created from this template. |
| 201 | { # An instance-attached disk resource. |
| 202 | "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance). |
| 203 | "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem. |
| 204 | "deviceName": "A 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. |
| 205 | # |
| 206 | # 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. |
| 207 | "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key. |
| 208 | # |
| 209 | # 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. |
| 210 | # |
| 211 | # 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. |
| 212 | # |
| 213 | # 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. |
| 214 | # |
| 215 | # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group. |
| 216 | "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. |
| 217 | "kmsKeyServiceAccount": "A 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. |
| 218 | "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. |
| 219 | "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 220 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 221 | "diskSizeGb": "A String", # The size of the disk in GB. |
| 222 | "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. |
| 223 | { # Guest OS features. |
| 224 | "type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. |
| 225 | }, |
| 226 | ], |
| 227 | "index": 42, # [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. |
| 228 | "initializeParams": { # [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. # [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. |
| 229 | # |
| 230 | # This property is mutually exclusive with the source property; you can only define one or the other, but not both. |
| 231 | # |
| 232 | # This property is mutually exclusive with the source property; you can only define one or the other, but not both. |
| 233 | "description": "A String", # An optional description. Provide this property when creating the disk. |
| 234 | "diskName": "A 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. |
| 235 | "diskSizeGb": "A String", # 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. |
| 236 | "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: |
| 237 | # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard |
| 238 | # |
| 239 | # |
| 240 | # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: |
| 241 | # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType |
| 242 | # - projects/project/zones/zone/diskTypes/diskType |
| 243 | # - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL. |
| 244 | "labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. |
| 245 | "a_key": "A String", |
| 246 | }, |
| 247 | "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. |
| 248 | "resourcePolicies": [ # 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. |
| 249 | "A String", |
| 250 | ], |
| 251 | "sourceImage": "A String", # The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD. |
| 252 | # |
| 253 | # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: |
| 254 | # projects/debian-cloud/global/images/family/debian-9 |
| 255 | # |
| 256 | # |
| 257 | # Alternatively, use a specific version of a public operating system image: |
| 258 | # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD |
| 259 | # |
| 260 | # |
| 261 | # To create a disk with a custom image that you created, specify the image name in the following format: |
| 262 | # global/images/my-custom-image |
| 263 | # |
| 264 | # |
| 265 | # 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: |
| 266 | # global/images/family/my-image-family |
| 267 | # |
| 268 | # |
| 269 | # If the source image is deleted later, this field will not be set. |
| 270 | "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. |
| 271 | # |
| 272 | # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys. |
| 273 | "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. |
| 274 | "kmsKeyServiceAccount": "A 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. |
| 275 | "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. |
| 276 | "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
| 277 | }, |
| 278 | "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD. |
| 279 | # |
| 280 | # To create a disk with a snapshot that you created, specify the snapshot name in the following format: |
| 281 | # global/snapshots/my-backup |
| 282 | # |
| 283 | # |
| 284 | # If the source snapshot is deleted later, this field will not be set. |
| 285 | "sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot. |
| 286 | "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. |
| 287 | "kmsKeyServiceAccount": "A 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. |
| 288 | "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. |
| 289 | "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
| 290 | }, |
| 291 | }, |
| 292 | "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. |
| 293 | "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks. |
| 294 | "licenses": [ # [Output Only] Any valid publicly visible licenses. |
| 295 | "A String", |
| 296 | ], |
| 297 | "mode": "A String", # 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. |
| 298 | "shieldedInstanceInitialState": { # Initial State for shielded instance, these are public keys which are safe to store in public # [Output Only] shielded vm initial state stored on disk |
| 299 | "dbs": [ # The Key Database (db). |
| 300 | { |
| 301 | "content": "A String", # The raw content in the secure keys file. |
| 302 | "fileType": "A String", # The file type of source file. |
| 303 | }, |
| 304 | ], |
| 305 | "dbxs": [ # The forbidden key database (dbx). |
| 306 | { |
| 307 | "content": "A String", # The raw content in the secure keys file. |
| 308 | "fileType": "A String", # The file type of source file. |
| 309 | }, |
| 310 | ], |
| 311 | "keks": [ # The Key Exchange Key (KEK). |
| 312 | { |
| 313 | "content": "A String", # The raw content in the secure keys file. |
| 314 | "fileType": "A String", # The file type of source file. |
| 315 | }, |
| 316 | ], |
| 317 | "pk": { # The Platform Key (PK). |
| 318 | "content": "A String", # The raw content in the secure keys file. |
| 319 | "fileType": "A String", # The file type of source file. |
| 320 | }, |
| 321 | }, |
| 322 | "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD. |
| 323 | # |
| 324 | # If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. |
| 325 | # |
| 326 | # Note that for InstanceTemplate, specify the disk name, not the URL for the disk. |
| 327 | "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. |
| 328 | }, |
| 329 | ], |
| 330 | "guestAccelerators": [ # A list of guest accelerator cards' type and count to use for instances created from the instance template. |
| 331 | { # A specification of the type and number of accelerator cards attached to the instance. |
| 332 | "acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance. |
| 333 | "acceleratorType": "A String", # Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types. |
| 334 | }, |
| 335 | ], |
| 336 | "labels": { # Labels to apply to instances that are created from this template. |
| 337 | "a_key": "A String", |
| 338 | }, |
| 339 | "machineType": "A String", # The machine type to use for instances that are created from this template. |
| 340 | "metadata": { # A metadata key/value entry. # The metadata key/value pairs to assign to instances that are created from this template. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information. |
| 341 | "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. |
| 342 | # |
| 343 | # To see the latest fingerprint, make a get() request to retrieve the resource. |
| 344 | "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB. |
| 345 | { |
| 346 | "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project. |
| 347 | "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB). |
| 348 | }, |
| 349 | ], |
| 350 | "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata. |
| 351 | }, |
| 352 | "minCpuPlatform": "A String", # Minimum cpu/platform to be used by this instance. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". For more information, read Specifying a Minimum CPU Platform. |
| 353 | "networkInterfaces": [ # An array of network access configurations for this interface. |
| 354 | { # A network interface resource attached to an instance. |
| 355 | "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. |
| 356 | { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. |
| 357 | "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. |
| 358 | "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. |
| 359 | "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. |
| 360 | "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. |
| 361 | # |
| 362 | # If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. |
| 363 | # |
| 364 | # If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP. |
| 365 | "publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled. |
| 366 | "setPublicPtr": True or False, # Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. |
| 367 | "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. |
| 368 | }, |
| 369 | ], |
| 370 | "aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks. |
| 371 | { # An alias IP range attached to an instance's network interface. |
| 372 | "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (such as 10.2.3.4), a netmask (such as /24) or a CIDR-formatted string (such as 10.1.2.0/24). |
| 373 | "subnetworkRangeName": "A String", # The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used. |
| 374 | }, |
| 375 | ], |
| 376 | "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface, otherwise the request will fail with error 412 conditionNotMet. |
| 377 | "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. |
| 378 | "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. |
| 379 | "network": "A String", # URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred. |
| 380 | # |
| 381 | # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: |
| 382 | # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network |
| 383 | # - projects/project/global/networks/network |
| 384 | # - global/networks/default |
| 385 | "networkIP": "A String", # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system. |
| 386 | "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: |
| 387 | # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork |
| 388 | # - regions/region/subnetworks/subnetwork |
| 389 | }, |
| 390 | ], |
| 391 | "reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from. |
| 392 | "consumeReservationType": "A String", # Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples. |
| 393 | "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the key and specify the name of your reservation as its value. |
| 394 | "values": [ # Corresponds to the label values of a reservation resource. |
| 395 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 396 | ], |
| 397 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 398 | "resourcePolicies": [ # Resource policies (names, not ULRs) applied to instances created from this template. |
| 399 | "A String", |
| 400 | ], |
| 401 | "scheduling": { # Sets the scheduling options for an Instance. NextID: 11 # Specifies the scheduling options for the instances that are created from this template. |
| 402 | "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. |
| 403 | # |
| 404 | # By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. |
| 405 | "nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity. |
| 406 | { # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled. |
| 407 | "key": "A String", # Corresponds to the label key of Node resource. |
| 408 | "operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity. |
| 409 | "values": [ # Corresponds to the label values of Node resource. |
| 410 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 411 | ], |
| Craig Citro | 0e5b9bf | 2014-10-15 10:26:14 -0700 | [diff] [blame] | 412 | }, |
| 413 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 414 | "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options. |
| 415 | "preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation, it cannot be set or changed after the instance has been created. |
| 416 | }, |
| 417 | "serviceAccounts": [ # A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this template. Use metadata queries to obtain the access tokens for these instances. |
| 418 | { # A service account. |
| 419 | "email": "A String", # Email address of the service account. |
| 420 | "scopes": [ # The list of scopes to be made available for this service account. |
| 421 | "A String", |
| Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 422 | ], |
| Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 423 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 424 | ], |
| 425 | "shieldedInstanceConfig": { # A set of Shielded Instance options. |
| 426 | "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default. |
| 427 | "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default. |
| 428 | "enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default. |
| 429 | }, |
| 430 | "tags": { # A set of instance tags. # A list of tags to apply to the instances that are created from this template. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035. |
| 431 | "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the tags' contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags. |
| 432 | # |
| 433 | # To see the latest fingerprint, make get() request to the instance. |
| 434 | "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. |
| 435 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 436 | ], |
| Craig Citro | 0e5b9bf | 2014-10-15 10:26:14 -0700 | [diff] [blame] | 437 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 438 | }, |
| 439 | "selfLink": "A String", # [Output Only] The URL for this instance template. The server defines this URL. |
| 440 | "sourceInstance": "A String", # The source instance used to create the template. You can provide this as a partial or full URL to the resource. For example, the following are valid values: |
| 441 | # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance |
| 442 | # - projects/project/zones/zone/instances/instance |
| 443 | "sourceInstanceParams": { # A specification of the parameters to use when creating the instance template from a source instance. # The source instance params to use to create this instance template. |
| 444 | "diskConfigs": [ # Attached disks configuration. If not provided, defaults are applied: For boot disk and any other R/W disks, new custom images will be created from each disk. For read-only disks, they will be attached in read-only mode. Local SSD disks will be created as blank volumes. |
| 445 | { # A specification of the desired way to instantiate a disk in the instance template when its created from a source instance. |
| 446 | "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance). |
| 447 | "customImage": "A String", # The custom source image to be used to restore this disk when instantiating this instance template. |
| 448 | "deviceName": "A String", # Specifies the device name of the disk to which the configurations apply to. |
| 449 | "instantiateFrom": "A String", # Specifies whether to include the disk and what image to use. Possible values are: |
| 450 | # - source-image: to use the same image that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks. |
| 451 | # - source-image-family: to use the same image family that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks. |
| 452 | # - custom-image: to use a user-provided image url for disk creation. Applicable to the boot disk and additional read-write disks. |
| 453 | # - attach-read-only: to attach a read-only disk. Applicable to read-only disks. |
| 454 | # - do-not-include: to exclude a disk from the template. Applicable to additional read-write disks, local SSDs, and read-only disks. |
| 455 | }, |
| 456 | ], |
| 457 | }, |
| 458 | }</pre> |
| Craig Citro | 0e5b9bf | 2014-10-15 10:26:14 -0700 | [diff] [blame] | 459 | </div> |
| 460 | |
| 461 | <div class="method"> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 462 | <code class="details" id="getIamPolicy">getIamPolicy(project, resource)</code> |
| 463 | <pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists. |
| 464 | |
| 465 | Args: |
| 466 | project: string, Project ID for this request. (required) |
| 467 | resource: string, Name or id of the resource for this request. (required) |
| 468 | |
| 469 | Returns: |
| 470 | An object of the form: |
| 471 | |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 472 | { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 473 | # |
| 474 | # |
| 475 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 476 | # A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 477 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 478 | # For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 479 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 480 | # **JSON example:** |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 481 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 482 | # { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 483 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 484 | # **YAML example:** |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 485 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 486 | # bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 487 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 488 | # For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 489 | "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 490 | { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. |
| 491 | # |
| 492 | # If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. |
| 493 | # |
| 494 | # Example Policy with multiple AuditConfigs: |
| 495 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 496 | # { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 497 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 498 | # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 499 | "auditLogConfigs": [ # The configuration for logging of each type of permission. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 500 | { # Provides the configuration for logging a type of permissions. Example: |
| 501 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 502 | # { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 503 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 504 | # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. |
| 505 | "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. |
| 506 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 507 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 508 | "ignoreChildExemptions": True or False, |
| 509 | "logType": "A String", # The log type that this config enables. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 510 | }, |
| 511 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 512 | "exemptedMembers": [ |
| 513 | "A String", |
| 514 | ], |
| 515 | "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 516 | }, |
| 517 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 518 | "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 519 | { # Associates `members` with a `role`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 520 | "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding. |
| 521 | # |
| 522 | # If the condition evaluates to `true`, then this binding applies to the current request. |
| 523 | # |
| 524 | # If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. |
| 525 | # |
| 526 | # To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| 527 | # |
| 528 | # Example (Comparison): |
| 529 | # |
| 530 | # title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" |
| 531 | # |
| 532 | # Example (Equality): |
| 533 | # |
| 534 | # title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" |
| 535 | # |
| 536 | # Example (Logic): |
| 537 | # |
| 538 | # title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" |
| 539 | # |
| 540 | # Example (Data Manipulation): |
| 541 | # |
| 542 | # title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" |
| 543 | # |
| 544 | # The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. |
| 545 | "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. |
| 546 | "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. |
| 547 | "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. |
| 548 | "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. |
| 549 | }, |
| 550 | "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 551 | # |
| 552 | # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. |
| 553 | # |
| 554 | # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. |
| 555 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 556 | # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 557 | # |
| 558 | # |
| 559 | # |
| 560 | # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. |
| 561 | # |
| 562 | # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. |
| 563 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 564 | # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. |
| 565 | # |
| 566 | # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. |
| 567 | # |
| 568 | # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. |
| 569 | # |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 570 | # |
| 571 | # |
| 572 | # * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 573 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 574 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 575 | "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 576 | }, |
| 577 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 578 | "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. |
| 579 | # |
| 580 | # **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. |
| 581 | "iamOwned": True or False, |
| 582 | "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. |
| 583 | { # A rule to be applied in a Policy. |
| 584 | "action": "A String", # Required |
| 585 | "conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match. |
| 586 | { # A condition to be met. |
| 587 | "iam": "A String", # Trusted attributes supplied by the IAM system. |
| 588 | "op": "A String", # An operator to apply the subject with. |
| 589 | "svc": "A String", # Trusted attributes discharged by the service. |
| 590 | "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. |
| 591 | "values": [ # The objects of the condition. |
| 592 | "A String", |
| 593 | ], |
| 594 | }, |
| 595 | ], |
| 596 | "description": "A String", # Human-readable description of the rule. |
| 597 | "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. |
| 598 | "A String", |
| 599 | ], |
| 600 | "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. |
| 601 | { # Specifies what kind of log the caller must write |
| 602 | "cloudAudit": { # Write a Cloud Audit log # Cloud audit options. |
| 603 | "authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline. |
| 604 | "permissionType": "A String", # The type of the permission that was checked. |
| 605 | }, |
| 606 | "logName": "A String", # The log_name to populate in the Cloud Audit Record. |
| 607 | }, |
| 608 | "counter": { # Increment a streamz counter with the specified metric and field names. # Counter options. |
| 609 | # |
| 610 | # Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. |
| 611 | # |
| 612 | # Field names correspond to IAM request parameters and field values are their respective values. |
| 613 | # |
| 614 | # Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields. |
| 615 | # |
| 616 | # Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]} |
| 617 | "customFields": [ # Custom fields. |
| 618 | { # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields. |
| 619 | "name": "A String", # Name is the field name. |
| 620 | "value": "A String", # Value is the field value. It is important that in contrast to the CounterOptions.field, the value here is a constant that is not derived from the IAMContext. |
| 621 | }, |
| 622 | ], |
| 623 | "field": "A String", # The field value to attribute. |
| 624 | "metric": "A String", # The metric to update. |
| 625 | }, |
| 626 | "dataAccess": { # Write a Data Access (Gin) log # Data access options. |
| 627 | "logMode": "A String", |
| 628 | }, |
| 629 | }, |
| 630 | ], |
| 631 | "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. |
| 632 | "A String", |
| 633 | ], |
| 634 | "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. |
| 635 | "A String", |
| 636 | ], |
| 637 | }, |
| 638 | ], |
| 639 | "version": 42, # Specifies the format of the policy. |
| 640 | # |
| 641 | # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. |
| 642 | # |
| 643 | # Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: |
| 644 | # |
| 645 | # * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions |
| 646 | # |
| 647 | # **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. |
| 648 | # |
| 649 | # If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. |
| 650 | # |
| 651 | # To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 652 | }</pre> |
| 653 | </div> |
| 654 | |
| 655 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 656 | <code class="details" id="insert">insert(project, body=None, requestId=None)</code> |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 657 | <pre>Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template. |
| Craig Citro | 0e5b9bf | 2014-10-15 10:26:14 -0700 | [diff] [blame] | 658 | |
| 659 | Args: |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 660 | project: string, Project ID for this request. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 661 | body: object, The request body. |
| Craig Citro | 0e5b9bf | 2014-10-15 10:26:14 -0700 | [diff] [blame] | 662 | The object takes the form of: |
| 663 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 664 | { # Represents an Instance Template resource. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 665 | # |
| 666 | # You can use instance templates to create VM instances and managed instance groups. For more information, read Instance Templates. (== resource_for {$api_version}.instanceTemplates ==) |
| 667 | "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance template in RFC3339 text format. |
| 668 | "description": "A String", # An optional description of this resource. Provide this property when you create the resource. |
| 669 | "id": "A String", # [Output Only] A unique identifier for this instance template. The server defines this identifier. |
| 670 | "kind": "compute#instanceTemplate", # [Output Only] The resource type, which is always compute#instanceTemplate for instance templates. |
| 671 | "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. |
| 672 | "properties": { # The instance properties for this instance template. |
| 673 | "canIpForward": True or False, # Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information. |
| 674 | "description": "A String", # An optional text description for the instances that are created from this instance template. |
| 675 | "disks": [ # An array of disks that are associated with the instances that are created from this template. |
| 676 | { # An instance-attached disk resource. |
| 677 | "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance). |
| 678 | "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem. |
| 679 | "deviceName": "A 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. |
| 680 | # |
| 681 | # 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. |
| 682 | "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key. |
| 683 | # |
| 684 | # 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. |
| 685 | # |
| 686 | # 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. |
| 687 | # |
| 688 | # 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. |
| 689 | # |
| 690 | # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group. |
| 691 | "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. |
| 692 | "kmsKeyServiceAccount": "A 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. |
| 693 | "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. |
| 694 | "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 695 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 696 | "diskSizeGb": "A String", # The size of the disk in GB. |
| 697 | "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. |
| 698 | { # Guest OS features. |
| 699 | "type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. |
| 700 | }, |
| 701 | ], |
| 702 | "index": 42, # [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. |
| 703 | "initializeParams": { # [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. # [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. |
| 704 | # |
| 705 | # This property is mutually exclusive with the source property; you can only define one or the other, but not both. |
| 706 | # |
| 707 | # This property is mutually exclusive with the source property; you can only define one or the other, but not both. |
| 708 | "description": "A String", # An optional description. Provide this property when creating the disk. |
| 709 | "diskName": "A 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. |
| 710 | "diskSizeGb": "A String", # 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. |
| 711 | "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: |
| 712 | # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard |
| 713 | # |
| 714 | # |
| 715 | # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: |
| 716 | # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType |
| 717 | # - projects/project/zones/zone/diskTypes/diskType |
| 718 | # - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL. |
| 719 | "labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. |
| 720 | "a_key": "A String", |
| 721 | }, |
| 722 | "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. |
| 723 | "resourcePolicies": [ # 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. |
| 724 | "A String", |
| 725 | ], |
| 726 | "sourceImage": "A String", # The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD. |
| 727 | # |
| 728 | # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: |
| 729 | # projects/debian-cloud/global/images/family/debian-9 |
| 730 | # |
| 731 | # |
| 732 | # Alternatively, use a specific version of a public operating system image: |
| 733 | # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD |
| 734 | # |
| 735 | # |
| 736 | # To create a disk with a custom image that you created, specify the image name in the following format: |
| 737 | # global/images/my-custom-image |
| 738 | # |
| 739 | # |
| 740 | # 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: |
| 741 | # global/images/family/my-image-family |
| 742 | # |
| 743 | # |
| 744 | # If the source image is deleted later, this field will not be set. |
| 745 | "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. |
| 746 | # |
| 747 | # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys. |
| 748 | "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. |
| 749 | "kmsKeyServiceAccount": "A 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. |
| 750 | "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. |
| 751 | "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
| 752 | }, |
| 753 | "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD. |
| 754 | # |
| 755 | # To create a disk with a snapshot that you created, specify the snapshot name in the following format: |
| 756 | # global/snapshots/my-backup |
| 757 | # |
| 758 | # |
| 759 | # If the source snapshot is deleted later, this field will not be set. |
| 760 | "sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot. |
| 761 | "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. |
| 762 | "kmsKeyServiceAccount": "A 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. |
| 763 | "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. |
| 764 | "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
| 765 | }, |
| 766 | }, |
| 767 | "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. |
| 768 | "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks. |
| 769 | "licenses": [ # [Output Only] Any valid publicly visible licenses. |
| 770 | "A String", |
| 771 | ], |
| 772 | "mode": "A String", # 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. |
| 773 | "shieldedInstanceInitialState": { # Initial State for shielded instance, these are public keys which are safe to store in public # [Output Only] shielded vm initial state stored on disk |
| 774 | "dbs": [ # The Key Database (db). |
| 775 | { |
| 776 | "content": "A String", # The raw content in the secure keys file. |
| 777 | "fileType": "A String", # The file type of source file. |
| 778 | }, |
| 779 | ], |
| 780 | "dbxs": [ # The forbidden key database (dbx). |
| 781 | { |
| 782 | "content": "A String", # The raw content in the secure keys file. |
| 783 | "fileType": "A String", # The file type of source file. |
| 784 | }, |
| 785 | ], |
| 786 | "keks": [ # The Key Exchange Key (KEK). |
| 787 | { |
| 788 | "content": "A String", # The raw content in the secure keys file. |
| 789 | "fileType": "A String", # The file type of source file. |
| 790 | }, |
| 791 | ], |
| 792 | "pk": { # The Platform Key (PK). |
| 793 | "content": "A String", # The raw content in the secure keys file. |
| 794 | "fileType": "A String", # The file type of source file. |
| 795 | }, |
| 796 | }, |
| 797 | "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD. |
| 798 | # |
| 799 | # If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. |
| 800 | # |
| 801 | # Note that for InstanceTemplate, specify the disk name, not the URL for the disk. |
| 802 | "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. |
| 803 | }, |
| 804 | ], |
| 805 | "guestAccelerators": [ # A list of guest accelerator cards' type and count to use for instances created from the instance template. |
| 806 | { # A specification of the type and number of accelerator cards attached to the instance. |
| 807 | "acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance. |
| 808 | "acceleratorType": "A String", # Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types. |
| 809 | }, |
| 810 | ], |
| 811 | "labels": { # Labels to apply to instances that are created from this template. |
| 812 | "a_key": "A String", |
| 813 | }, |
| 814 | "machineType": "A String", # The machine type to use for instances that are created from this template. |
| 815 | "metadata": { # A metadata key/value entry. # The metadata key/value pairs to assign to instances that are created from this template. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information. |
| 816 | "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. |
| 817 | # |
| 818 | # To see the latest fingerprint, make a get() request to retrieve the resource. |
| 819 | "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB. |
| 820 | { |
| 821 | "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project. |
| 822 | "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB). |
| 823 | }, |
| 824 | ], |
| 825 | "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata. |
| 826 | }, |
| 827 | "minCpuPlatform": "A String", # Minimum cpu/platform to be used by this instance. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". For more information, read Specifying a Minimum CPU Platform. |
| 828 | "networkInterfaces": [ # An array of network access configurations for this interface. |
| 829 | { # A network interface resource attached to an instance. |
| 830 | "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. |
| 831 | { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. |
| 832 | "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. |
| 833 | "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. |
| 834 | "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. |
| 835 | "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. |
| 836 | # |
| 837 | # If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. |
| 838 | # |
| 839 | # If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP. |
| 840 | "publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled. |
| 841 | "setPublicPtr": True or False, # Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. |
| 842 | "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. |
| 843 | }, |
| 844 | ], |
| 845 | "aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks. |
| 846 | { # An alias IP range attached to an instance's network interface. |
| 847 | "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (such as 10.2.3.4), a netmask (such as /24) or a CIDR-formatted string (such as 10.1.2.0/24). |
| 848 | "subnetworkRangeName": "A String", # The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used. |
| 849 | }, |
| 850 | ], |
| 851 | "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface, otherwise the request will fail with error 412 conditionNotMet. |
| 852 | "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. |
| 853 | "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. |
| 854 | "network": "A String", # URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred. |
| 855 | # |
| 856 | # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: |
| 857 | # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network |
| 858 | # - projects/project/global/networks/network |
| 859 | # - global/networks/default |
| 860 | "networkIP": "A String", # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system. |
| 861 | "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: |
| 862 | # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork |
| 863 | # - regions/region/subnetworks/subnetwork |
| 864 | }, |
| 865 | ], |
| 866 | "reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from. |
| 867 | "consumeReservationType": "A String", # Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples. |
| 868 | "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the key and specify the name of your reservation as its value. |
| 869 | "values": [ # Corresponds to the label values of a reservation resource. |
| 870 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 871 | ], |
| 872 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 873 | "resourcePolicies": [ # Resource policies (names, not ULRs) applied to instances created from this template. |
| 874 | "A String", |
| 875 | ], |
| 876 | "scheduling": { # Sets the scheduling options for an Instance. NextID: 11 # Specifies the scheduling options for the instances that are created from this template. |
| 877 | "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. |
| 878 | # |
| 879 | # By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. |
| 880 | "nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity. |
| 881 | { # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled. |
| 882 | "key": "A String", # Corresponds to the label key of Node resource. |
| 883 | "operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity. |
| 884 | "values": [ # Corresponds to the label values of Node resource. |
| 885 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 886 | ], |
| Craig Citro | 0e5b9bf | 2014-10-15 10:26:14 -0700 | [diff] [blame] | 887 | }, |
| 888 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 889 | "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options. |
| 890 | "preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation, it cannot be set or changed after the instance has been created. |
| 891 | }, |
| 892 | "serviceAccounts": [ # A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this template. Use metadata queries to obtain the access tokens for these instances. |
| 893 | { # A service account. |
| 894 | "email": "A String", # Email address of the service account. |
| 895 | "scopes": [ # The list of scopes to be made available for this service account. |
| 896 | "A String", |
| Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 897 | ], |
| Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 898 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 899 | ], |
| 900 | "shieldedInstanceConfig": { # A set of Shielded Instance options. |
| 901 | "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default. |
| 902 | "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default. |
| 903 | "enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default. |
| 904 | }, |
| 905 | "tags": { # A set of instance tags. # A list of tags to apply to the instances that are created from this template. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035. |
| 906 | "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the tags' contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags. |
| 907 | # |
| 908 | # To see the latest fingerprint, make get() request to the instance. |
| 909 | "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. |
| 910 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 911 | ], |
| Craig Citro | 0e5b9bf | 2014-10-15 10:26:14 -0700 | [diff] [blame] | 912 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 913 | }, |
| 914 | "selfLink": "A String", # [Output Only] The URL for this instance template. The server defines this URL. |
| 915 | "sourceInstance": "A String", # The source instance used to create the template. You can provide this as a partial or full URL to the resource. For example, the following are valid values: |
| 916 | # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance |
| 917 | # - projects/project/zones/zone/instances/instance |
| 918 | "sourceInstanceParams": { # A specification of the parameters to use when creating the instance template from a source instance. # The source instance params to use to create this instance template. |
| 919 | "diskConfigs": [ # Attached disks configuration. If not provided, defaults are applied: For boot disk and any other R/W disks, new custom images will be created from each disk. For read-only disks, they will be attached in read-only mode. Local SSD disks will be created as blank volumes. |
| 920 | { # A specification of the desired way to instantiate a disk in the instance template when its created from a source instance. |
| 921 | "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance). |
| 922 | "customImage": "A String", # The custom source image to be used to restore this disk when instantiating this instance template. |
| 923 | "deviceName": "A String", # Specifies the device name of the disk to which the configurations apply to. |
| 924 | "instantiateFrom": "A String", # Specifies whether to include the disk and what image to use. Possible values are: |
| 925 | # - source-image: to use the same image that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks. |
| 926 | # - source-image-family: to use the same image family that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks. |
| 927 | # - custom-image: to use a user-provided image url for disk creation. Applicable to the boot disk and additional read-write disks. |
| 928 | # - attach-read-only: to attach a read-only disk. Applicable to read-only disks. |
| 929 | # - do-not-include: to exclude a disk from the template. Applicable to additional read-write disks, local SSDs, and read-only disks. |
| 930 | }, |
| 931 | ], |
| 932 | }, |
| 933 | } |
| Craig Citro | 0e5b9bf | 2014-10-15 10:26:14 -0700 | [diff] [blame] | 934 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 935 | 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. |
| 936 | |
| 937 | 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. |
| 938 | |
| 939 | The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
| Craig Citro | 0e5b9bf | 2014-10-15 10:26:14 -0700 | [diff] [blame] | 940 | |
| 941 | Returns: |
| 942 | An object of the form: |
| 943 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 944 | { # Represents an Operation resource. |
| 945 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 946 | # Google Compute Engine has three Operation resources: |
| 947 | # |
| 948 | # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) |
| 949 | # |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 950 | # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. |
| 951 | # |
| 952 | # Operations can be global, regional or zonal. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 953 | # - For global operations, use the `globalOperations` resource. |
| 954 | # - For regional operations, use the `regionOperations` resource. |
| 955 | # - For zonal operations, use the `zonalOperations` resource. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 956 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 957 | # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 958 | "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| 959 | "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| 960 | "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| 961 | "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| 962 | "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| 963 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| Craig Citro | 0e5b9bf | 2014-10-15 10:26:14 -0700 | [diff] [blame] | 964 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 965 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 966 | "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| 967 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| Craig Citro | 0e5b9bf | 2014-10-15 10:26:14 -0700 | [diff] [blame] | 968 | }, |
| 969 | ], |
| 970 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 971 | "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. |
| 972 | "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. |
| 973 | "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. |
| 974 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| 975 | "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. |
| 976 | "name": "A String", # [Output Only] Name of the operation. |
| 977 | "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. |
| 978 | "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. |
| 979 | "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
| 980 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 981 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| 982 | "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. |
| 983 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 984 | "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| 985 | "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. |
| 986 | "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. |
| 987 | "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| 988 | { |
| 989 | "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. |
| 990 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| 991 | # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| 992 | { |
| 993 | "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). |
| 994 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 995 | }, |
| 996 | ], |
| 997 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 998 | }, |
| 999 | ], |
| 1000 | "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
| Craig Citro | 0e5b9bf | 2014-10-15 10:26:14 -0700 | [diff] [blame] | 1001 | }</pre> |
| 1002 | </div> |
| 1003 | |
| 1004 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1005 | <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1006 | <pre>Retrieves a list of instance templates that are contained within the specified project. |
| Craig Citro | 0e5b9bf | 2014-10-15 10:26:14 -0700 | [diff] [blame] | 1007 | |
| 1008 | Args: |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 1009 | project: string, Project ID for this request. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1010 | filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 1011 | |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1012 | For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 1013 | |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1014 | You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 1015 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1016 | To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` |
| 1017 | maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) |
| 1018 | orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. |
| 1019 | |
| 1020 | You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. |
| 1021 | |
| 1022 | Currently, only sorting by `name` or `creationTimestamp desc` is supported. |
| 1023 | pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. |
| Craig Citro | 0e5b9bf | 2014-10-15 10:26:14 -0700 | [diff] [blame] | 1024 | |
| 1025 | Returns: |
| 1026 | An object of the form: |
| 1027 | |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 1028 | { # A list of instance templates. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1029 | "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. |
| 1030 | "items": [ # A list of InstanceTemplate resources. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1031 | { # Represents an Instance Template resource. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1032 | # |
| 1033 | # You can use instance templates to create VM instances and managed instance groups. For more information, read Instance Templates. (== resource_for {$api_version}.instanceTemplates ==) |
| 1034 | "creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance template in RFC3339 text format. |
| 1035 | "description": "A String", # An optional description of this resource. Provide this property when you create the resource. |
| 1036 | "id": "A String", # [Output Only] A unique identifier for this instance template. The server defines this identifier. |
| 1037 | "kind": "compute#instanceTemplate", # [Output Only] The resource type, which is always compute#instanceTemplate for instance templates. |
| 1038 | "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. |
| 1039 | "properties": { # The instance properties for this instance template. |
| 1040 | "canIpForward": True or False, # Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information. |
| 1041 | "description": "A String", # An optional text description for the instances that are created from this instance template. |
| 1042 | "disks": [ # An array of disks that are associated with the instances that are created from this template. |
| 1043 | { # An instance-attached disk resource. |
| 1044 | "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance). |
| 1045 | "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem. |
| 1046 | "deviceName": "A 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. |
| 1047 | # |
| 1048 | # 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. |
| 1049 | "diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts or decrypts a disk using a customer-supplied encryption key. |
| 1050 | # |
| 1051 | # 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. |
| 1052 | # |
| 1053 | # 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. |
| 1054 | # |
| 1055 | # 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. |
| 1056 | # |
| 1057 | # Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group. |
| 1058 | "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. |
| 1059 | "kmsKeyServiceAccount": "A 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. |
| 1060 | "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. |
| 1061 | "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1062 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1063 | "diskSizeGb": "A String", # The size of the disk in GB. |
| 1064 | "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. |
| 1065 | { # Guest OS features. |
| 1066 | "type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. |
| 1067 | }, |
| 1068 | ], |
| 1069 | "index": 42, # [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. |
| 1070 | "initializeParams": { # [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. # [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. |
| 1071 | # |
| 1072 | # This property is mutually exclusive with the source property; you can only define one or the other, but not both. |
| 1073 | # |
| 1074 | # This property is mutually exclusive with the source property; you can only define one or the other, but not both. |
| 1075 | "description": "A String", # An optional description. Provide this property when creating the disk. |
| 1076 | "diskName": "A 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. |
| 1077 | "diskSizeGb": "A String", # 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. |
| 1078 | "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: |
| 1079 | # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard |
| 1080 | # |
| 1081 | # |
| 1082 | # Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: |
| 1083 | # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType |
| 1084 | # - projects/project/zones/zone/diskTypes/diskType |
| 1085 | # - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL. |
| 1086 | "labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. |
| 1087 | "a_key": "A String", |
| 1088 | }, |
| 1089 | "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk. |
| 1090 | "resourcePolicies": [ # 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. |
| 1091 | "A String", |
| 1092 | ], |
| 1093 | "sourceImage": "A String", # The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD. |
| 1094 | # |
| 1095 | # To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: |
| 1096 | # projects/debian-cloud/global/images/family/debian-9 |
| 1097 | # |
| 1098 | # |
| 1099 | # Alternatively, use a specific version of a public operating system image: |
| 1100 | # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD |
| 1101 | # |
| 1102 | # |
| 1103 | # To create a disk with a custom image that you created, specify the image name in the following format: |
| 1104 | # global/images/my-custom-image |
| 1105 | # |
| 1106 | # |
| 1107 | # 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: |
| 1108 | # global/images/family/my-image-family |
| 1109 | # |
| 1110 | # |
| 1111 | # If the source image is deleted later, this field will not be set. |
| 1112 | "sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. |
| 1113 | # |
| 1114 | # Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys. |
| 1115 | "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. |
| 1116 | "kmsKeyServiceAccount": "A 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. |
| 1117 | "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. |
| 1118 | "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
| 1119 | }, |
| 1120 | "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD. |
| 1121 | # |
| 1122 | # To create a disk with a snapshot that you created, specify the snapshot name in the following format: |
| 1123 | # global/snapshots/my-backup |
| 1124 | # |
| 1125 | # |
| 1126 | # If the source snapshot is deleted later, this field will not be set. |
| 1127 | "sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot. |
| 1128 | "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. |
| 1129 | "kmsKeyServiceAccount": "A 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. |
| 1130 | "rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. |
| 1131 | "sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
| 1132 | }, |
| 1133 | }, |
| 1134 | "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. |
| 1135 | "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks. |
| 1136 | "licenses": [ # [Output Only] Any valid publicly visible licenses. |
| 1137 | "A String", |
| 1138 | ], |
| 1139 | "mode": "A String", # 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. |
| 1140 | "shieldedInstanceInitialState": { # Initial State for shielded instance, these are public keys which are safe to store in public # [Output Only] shielded vm initial state stored on disk |
| 1141 | "dbs": [ # The Key Database (db). |
| 1142 | { |
| 1143 | "content": "A String", # The raw content in the secure keys file. |
| 1144 | "fileType": "A String", # The file type of source file. |
| 1145 | }, |
| 1146 | ], |
| 1147 | "dbxs": [ # The forbidden key database (dbx). |
| 1148 | { |
| 1149 | "content": "A String", # The raw content in the secure keys file. |
| 1150 | "fileType": "A String", # The file type of source file. |
| 1151 | }, |
| 1152 | ], |
| 1153 | "keks": [ # The Key Exchange Key (KEK). |
| 1154 | { |
| 1155 | "content": "A String", # The raw content in the secure keys file. |
| 1156 | "fileType": "A String", # The file type of source file. |
| 1157 | }, |
| 1158 | ], |
| 1159 | "pk": { # The Platform Key (PK). |
| 1160 | "content": "A String", # The raw content in the secure keys file. |
| 1161 | "fileType": "A String", # The file type of source file. |
| 1162 | }, |
| 1163 | }, |
| 1164 | "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD. |
| 1165 | # |
| 1166 | # If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. |
| 1167 | # |
| 1168 | # Note that for InstanceTemplate, specify the disk name, not the URL for the disk. |
| 1169 | "type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. |
| 1170 | }, |
| 1171 | ], |
| 1172 | "guestAccelerators": [ # A list of guest accelerator cards' type and count to use for instances created from the instance template. |
| 1173 | { # A specification of the type and number of accelerator cards attached to the instance. |
| 1174 | "acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance. |
| 1175 | "acceleratorType": "A String", # Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types. |
| 1176 | }, |
| 1177 | ], |
| 1178 | "labels": { # Labels to apply to instances that are created from this template. |
| 1179 | "a_key": "A String", |
| 1180 | }, |
| 1181 | "machineType": "A String", # The machine type to use for instances that are created from this template. |
| 1182 | "metadata": { # A metadata key/value entry. # The metadata key/value pairs to assign to instances that are created from this template. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information. |
| 1183 | "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. |
| 1184 | # |
| 1185 | # To see the latest fingerprint, make a get() request to retrieve the resource. |
| 1186 | "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB. |
| 1187 | { |
| 1188 | "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project. |
| 1189 | "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB). |
| 1190 | }, |
| 1191 | ], |
| 1192 | "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata. |
| 1193 | }, |
| 1194 | "minCpuPlatform": "A String", # Minimum cpu/platform to be used by this instance. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". For more information, read Specifying a Minimum CPU Platform. |
| 1195 | "networkInterfaces": [ # An array of network access configurations for this interface. |
| 1196 | { # A network interface resource attached to an instance. |
| 1197 | "accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. |
| 1198 | { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. |
| 1199 | "kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs. |
| 1200 | "name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. |
| 1201 | "natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. |
| 1202 | "networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. |
| 1203 | # |
| 1204 | # If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. |
| 1205 | # |
| 1206 | # If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP. |
| 1207 | "publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled. |
| 1208 | "setPublicPtr": True or False, # Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. |
| 1209 | "type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT. |
| 1210 | }, |
| 1211 | ], |
| 1212 | "aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks. |
| 1213 | { # An alias IP range attached to an instance's network interface. |
| 1214 | "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (such as 10.2.3.4), a netmask (such as /24) or a CIDR-formatted string (such as 10.1.2.0/24). |
| 1215 | "subnetworkRangeName": "A String", # The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used. |
| 1216 | }, |
| 1217 | ], |
| 1218 | "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface, otherwise the request will fail with error 412 conditionNotMet. |
| 1219 | "kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces. |
| 1220 | "name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc. |
| 1221 | "network": "A String", # URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred. |
| 1222 | # |
| 1223 | # If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: |
| 1224 | # - https://www.googleapis.com/compute/v1/projects/project/global/networks/network |
| 1225 | # - projects/project/global/networks/network |
| 1226 | # - global/networks/default |
| 1227 | "networkIP": "A String", # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system. |
| 1228 | "subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: |
| 1229 | # - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork |
| 1230 | # - regions/region/subnetworks/subnetwork |
| 1231 | }, |
| 1232 | ], |
| 1233 | "reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from. |
| 1234 | "consumeReservationType": "A String", # Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples. |
| 1235 | "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the key and specify the name of your reservation as its value. |
| 1236 | "values": [ # Corresponds to the label values of a reservation resource. |
| 1237 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1238 | ], |
| 1239 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1240 | "resourcePolicies": [ # Resource policies (names, not ULRs) applied to instances created from this template. |
| 1241 | "A String", |
| 1242 | ], |
| 1243 | "scheduling": { # Sets the scheduling options for an Instance. NextID: 11 # Specifies the scheduling options for the instances that are created from this template. |
| 1244 | "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. |
| 1245 | # |
| 1246 | # By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. |
| 1247 | "nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity. |
| 1248 | { # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled. |
| 1249 | "key": "A String", # Corresponds to the label key of Node resource. |
| 1250 | "operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity. |
| 1251 | "values": [ # Corresponds to the label values of Node resource. |
| 1252 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1253 | ], |
| Craig Citro | 0e5b9bf | 2014-10-15 10:26:14 -0700 | [diff] [blame] | 1254 | }, |
| 1255 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1256 | "onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options. |
| 1257 | "preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation, it cannot be set or changed after the instance has been created. |
| 1258 | }, |
| 1259 | "serviceAccounts": [ # A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this template. Use metadata queries to obtain the access tokens for these instances. |
| 1260 | { # A service account. |
| 1261 | "email": "A String", # Email address of the service account. |
| 1262 | "scopes": [ # The list of scopes to be made available for this service account. |
| 1263 | "A String", |
| Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 1264 | ], |
| Sai Cheemalapati | 4ba8c23 | 2017-06-06 18:46:08 -0400 | [diff] [blame] | 1265 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1266 | ], |
| 1267 | "shieldedInstanceConfig": { # A set of Shielded Instance options. |
| 1268 | "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default. |
| 1269 | "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default. |
| 1270 | "enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default. |
| 1271 | }, |
| 1272 | "tags": { # A set of instance tags. # A list of tags to apply to the instances that are created from this template. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035. |
| 1273 | "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the tags' contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags. |
| 1274 | # |
| 1275 | # To see the latest fingerprint, make get() request to the instance. |
| 1276 | "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. |
| 1277 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1278 | ], |
| Craig Citro | 0e5b9bf | 2014-10-15 10:26:14 -0700 | [diff] [blame] | 1279 | }, |
| Craig Citro | 0e5b9bf | 2014-10-15 10:26:14 -0700 | [diff] [blame] | 1280 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1281 | "selfLink": "A String", # [Output Only] The URL for this instance template. The server defines this URL. |
| 1282 | "sourceInstance": "A String", # The source instance used to create the template. You can provide this as a partial or full URL to the resource. For example, the following are valid values: |
| 1283 | # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance |
| 1284 | # - projects/project/zones/zone/instances/instance |
| 1285 | "sourceInstanceParams": { # A specification of the parameters to use when creating the instance template from a source instance. # The source instance params to use to create this instance template. |
| 1286 | "diskConfigs": [ # Attached disks configuration. If not provided, defaults are applied: For boot disk and any other R/W disks, new custom images will be created from each disk. For read-only disks, they will be attached in read-only mode. Local SSD disks will be created as blank volumes. |
| 1287 | { # A specification of the desired way to instantiate a disk in the instance template when its created from a source instance. |
| 1288 | "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance). |
| 1289 | "customImage": "A String", # The custom source image to be used to restore this disk when instantiating this instance template. |
| 1290 | "deviceName": "A String", # Specifies the device name of the disk to which the configurations apply to. |
| 1291 | "instantiateFrom": "A String", # Specifies whether to include the disk and what image to use. Possible values are: |
| 1292 | # - source-image: to use the same image that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks. |
| 1293 | # - source-image-family: to use the same image family that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks. |
| 1294 | # - custom-image: to use a user-provided image url for disk creation. Applicable to the boot disk and additional read-write disks. |
| 1295 | # - attach-read-only: to attach a read-only disk. Applicable to read-only disks. |
| 1296 | # - do-not-include: to exclude a disk from the template. Applicable to additional read-write disks, local SSDs, and read-only disks. |
| 1297 | }, |
| 1298 | ], |
| 1299 | }, |
| 1300 | }, |
| Craig Citro | 0e5b9bf | 2014-10-15 10:26:14 -0700 | [diff] [blame] | 1301 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1302 | "kind": "compute#instanceTemplateList", # [Output Only] The resource type, which is always compute#instanceTemplatesListResponse for instance template lists. |
| 1303 | "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. |
| 1304 | "selfLink": "A String", # [Output Only] Server-defined URL for this resource. |
| 1305 | "warning": { # [Output Only] Informational warning message. |
| 1306 | "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. |
| 1307 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| 1308 | # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1309 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1310 | "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). |
| 1311 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1312 | }, |
| 1313 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1314 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1315 | }, |
| Craig Citro | 0e5b9bf | 2014-10-15 10:26:14 -0700 | [diff] [blame] | 1316 | }</pre> |
| 1317 | </div> |
| 1318 | |
| 1319 | <div class="method"> |
| 1320 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 1321 | <pre>Retrieves the next page of results. |
| 1322 | |
| 1323 | Args: |
| 1324 | previous_request: The request for the previous page. (required) |
| 1325 | previous_response: The response from the request for the previous page. (required) |
| 1326 | |
| 1327 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1328 | A request object that you can call 'execute()' on to request the next |
| Craig Citro | 0e5b9bf | 2014-10-15 10:26:14 -0700 | [diff] [blame] | 1329 | page. Returns None if there are no more items in the collection. |
| 1330 | </pre> |
| 1331 | </div> |
| 1332 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1333 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1334 | <code class="details" id="setIamPolicy">setIamPolicy(project, resource, body=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1335 | <pre>Sets the access control policy on the specified resource. Replaces any existing policy. |
| 1336 | |
| 1337 | Args: |
| 1338 | project: string, Project ID for this request. (required) |
| 1339 | resource: string, Name or id of the resource for this request. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1340 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1341 | The object takes the form of: |
| 1342 | |
| 1343 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1344 | "bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. |
| 1345 | { # Associates `members` with a `role`. |
| 1346 | "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding. |
| 1347 | # |
| 1348 | # If the condition evaluates to `true`, then this binding applies to the current request. |
| 1349 | # |
| 1350 | # If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. |
| 1351 | # |
| 1352 | # To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| 1353 | # |
| 1354 | # Example (Comparison): |
| 1355 | # |
| 1356 | # title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" |
| 1357 | # |
| 1358 | # Example (Equality): |
| 1359 | # |
| 1360 | # title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" |
| 1361 | # |
| 1362 | # Example (Logic): |
| 1363 | # |
| 1364 | # title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" |
| 1365 | # |
| 1366 | # Example (Data Manipulation): |
| 1367 | # |
| 1368 | # title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" |
| 1369 | # |
| 1370 | # The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. |
| 1371 | "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. |
| 1372 | "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. |
| 1373 | "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. |
| 1374 | "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. |
| 1375 | }, |
| 1376 | "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: |
| 1377 | # |
| 1378 | # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. |
| 1379 | # |
| 1380 | # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. |
| 1381 | # |
| 1382 | # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . |
| 1383 | # |
| 1384 | # |
| 1385 | # |
| 1386 | # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. |
| 1387 | # |
| 1388 | # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. |
| 1389 | # |
| 1390 | # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. |
| 1391 | # |
| 1392 | # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. |
| 1393 | # |
| 1394 | # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. |
| 1395 | # |
| 1396 | # |
| 1397 | # |
| 1398 | # * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. |
| 1399 | "A String", |
| 1400 | ], |
| 1401 | "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| 1402 | }, |
| 1403 | ], |
| 1404 | "etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. |
| 1405 | "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1406 | # |
| 1407 | # |
| 1408 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1409 | # A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1410 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1411 | # For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1412 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1413 | # **JSON example:** |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1414 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1415 | # { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1416 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1417 | # **YAML example:** |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1418 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1419 | # bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1420 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1421 | # For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1422 | "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1423 | { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. |
| 1424 | # |
| 1425 | # If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. |
| 1426 | # |
| 1427 | # Example Policy with multiple AuditConfigs: |
| 1428 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1429 | # { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1430 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1431 | # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1432 | "auditLogConfigs": [ # The configuration for logging of each type of permission. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1433 | { # Provides the configuration for logging a type of permissions. Example: |
| 1434 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1435 | # { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1436 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1437 | # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. |
| 1438 | "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. |
| 1439 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1440 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1441 | "ignoreChildExemptions": True or False, |
| 1442 | "logType": "A String", # The log type that this config enables. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1443 | }, |
| 1444 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1445 | "exemptedMembers": [ |
| 1446 | "A String", |
| 1447 | ], |
| 1448 | "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1449 | }, |
| 1450 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1451 | "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1452 | { # Associates `members` with a `role`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1453 | "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding. |
| 1454 | # |
| 1455 | # If the condition evaluates to `true`, then this binding applies to the current request. |
| 1456 | # |
| 1457 | # If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. |
| 1458 | # |
| 1459 | # To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| 1460 | # |
| 1461 | # Example (Comparison): |
| 1462 | # |
| 1463 | # title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" |
| 1464 | # |
| 1465 | # Example (Equality): |
| 1466 | # |
| 1467 | # title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" |
| 1468 | # |
| 1469 | # Example (Logic): |
| 1470 | # |
| 1471 | # title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" |
| 1472 | # |
| 1473 | # Example (Data Manipulation): |
| 1474 | # |
| 1475 | # title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" |
| 1476 | # |
| 1477 | # The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. |
| 1478 | "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. |
| 1479 | "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. |
| 1480 | "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. |
| 1481 | "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. |
| 1482 | }, |
| 1483 | "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1484 | # |
| 1485 | # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. |
| 1486 | # |
| 1487 | # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. |
| 1488 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1489 | # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1490 | # |
| 1491 | # |
| 1492 | # |
| 1493 | # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. |
| 1494 | # |
| 1495 | # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. |
| 1496 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1497 | # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. |
| 1498 | # |
| 1499 | # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. |
| 1500 | # |
| 1501 | # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. |
| 1502 | # |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1503 | # |
| 1504 | # |
| 1505 | # * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1506 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1507 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1508 | "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1509 | }, |
| 1510 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1511 | "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. |
| 1512 | # |
| 1513 | # **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. |
| 1514 | "iamOwned": True or False, |
| 1515 | "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. |
| 1516 | { # A rule to be applied in a Policy. |
| 1517 | "action": "A String", # Required |
| 1518 | "conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match. |
| 1519 | { # A condition to be met. |
| 1520 | "iam": "A String", # Trusted attributes supplied by the IAM system. |
| 1521 | "op": "A String", # An operator to apply the subject with. |
| 1522 | "svc": "A String", # Trusted attributes discharged by the service. |
| 1523 | "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. |
| 1524 | "values": [ # The objects of the condition. |
| 1525 | "A String", |
| 1526 | ], |
| 1527 | }, |
| 1528 | ], |
| 1529 | "description": "A String", # Human-readable description of the rule. |
| 1530 | "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. |
| 1531 | "A String", |
| 1532 | ], |
| 1533 | "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. |
| 1534 | { # Specifies what kind of log the caller must write |
| 1535 | "cloudAudit": { # Write a Cloud Audit log # Cloud audit options. |
| 1536 | "authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline. |
| 1537 | "permissionType": "A String", # The type of the permission that was checked. |
| 1538 | }, |
| 1539 | "logName": "A String", # The log_name to populate in the Cloud Audit Record. |
| 1540 | }, |
| 1541 | "counter": { # Increment a streamz counter with the specified metric and field names. # Counter options. |
| 1542 | # |
| 1543 | # Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. |
| 1544 | # |
| 1545 | # Field names correspond to IAM request parameters and field values are their respective values. |
| 1546 | # |
| 1547 | # Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields. |
| 1548 | # |
| 1549 | # Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]} |
| 1550 | "customFields": [ # Custom fields. |
| 1551 | { # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields. |
| 1552 | "name": "A String", # Name is the field name. |
| 1553 | "value": "A String", # Value is the field value. It is important that in contrast to the CounterOptions.field, the value here is a constant that is not derived from the IAMContext. |
| 1554 | }, |
| 1555 | ], |
| 1556 | "field": "A String", # The field value to attribute. |
| 1557 | "metric": "A String", # The metric to update. |
| 1558 | }, |
| 1559 | "dataAccess": { # Write a Data Access (Gin) log # Data access options. |
| 1560 | "logMode": "A String", |
| 1561 | }, |
| 1562 | }, |
| 1563 | ], |
| 1564 | "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. |
| 1565 | "A String", |
| 1566 | ], |
| 1567 | "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. |
| 1568 | "A String", |
| 1569 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1570 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1571 | ], |
| 1572 | "version": 42, # Specifies the format of the policy. |
| 1573 | # |
| 1574 | # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. |
| 1575 | # |
| 1576 | # Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: |
| 1577 | # |
| 1578 | # * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions |
| 1579 | # |
| 1580 | # **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. |
| 1581 | # |
| 1582 | # If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. |
| 1583 | # |
| 1584 | # To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| 1585 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1586 | } |
| 1587 | |
| 1588 | |
| 1589 | Returns: |
| 1590 | An object of the form: |
| 1591 | |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1592 | { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1593 | # |
| 1594 | # |
| 1595 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1596 | # A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1597 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1598 | # For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1599 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1600 | # **JSON example:** |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1601 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1602 | # { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1603 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1604 | # **YAML example:** |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1605 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1606 | # bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1607 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1608 | # For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1609 | "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1610 | { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. |
| 1611 | # |
| 1612 | # If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. |
| 1613 | # |
| 1614 | # Example Policy with multiple AuditConfigs: |
| 1615 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1616 | # { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1617 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1618 | # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1619 | "auditLogConfigs": [ # The configuration for logging of each type of permission. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1620 | { # Provides the configuration for logging a type of permissions. Example: |
| 1621 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1622 | # { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1623 | # |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1624 | # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. |
| 1625 | "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. |
| 1626 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1627 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1628 | "ignoreChildExemptions": True or False, |
| 1629 | "logType": "A String", # The log type that this config enables. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1630 | }, |
| 1631 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1632 | "exemptedMembers": [ |
| 1633 | "A String", |
| 1634 | ], |
| 1635 | "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1636 | }, |
| 1637 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1638 | "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1639 | { # Associates `members` with a `role`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1640 | "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding. |
| 1641 | # |
| 1642 | # If the condition evaluates to `true`, then this binding applies to the current request. |
| 1643 | # |
| 1644 | # If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. |
| 1645 | # |
| 1646 | # To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| 1647 | # |
| 1648 | # Example (Comparison): |
| 1649 | # |
| 1650 | # title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" |
| 1651 | # |
| 1652 | # Example (Equality): |
| 1653 | # |
| 1654 | # title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" |
| 1655 | # |
| 1656 | # Example (Logic): |
| 1657 | # |
| 1658 | # title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" |
| 1659 | # |
| 1660 | # Example (Data Manipulation): |
| 1661 | # |
| 1662 | # title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" |
| 1663 | # |
| 1664 | # The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. |
| 1665 | "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. |
| 1666 | "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. |
| 1667 | "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. |
| 1668 | "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. |
| 1669 | }, |
| 1670 | "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1671 | # |
| 1672 | # * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. |
| 1673 | # |
| 1674 | # * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. |
| 1675 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1676 | # * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1677 | # |
| 1678 | # |
| 1679 | # |
| 1680 | # * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. |
| 1681 | # |
| 1682 | # * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. |
| 1683 | # |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1684 | # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. |
| 1685 | # |
| 1686 | # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. |
| 1687 | # |
| 1688 | # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. |
| 1689 | # |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1690 | # |
| 1691 | # |
| 1692 | # * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1693 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1694 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1695 | "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1696 | }, |
| 1697 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1698 | "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. |
| 1699 | # |
| 1700 | # **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. |
| 1701 | "iamOwned": True or False, |
| 1702 | "rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. |
| 1703 | { # A rule to be applied in a Policy. |
| 1704 | "action": "A String", # Required |
| 1705 | "conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match. |
| 1706 | { # A condition to be met. |
| 1707 | "iam": "A String", # Trusted attributes supplied by the IAM system. |
| 1708 | "op": "A String", # An operator to apply the subject with. |
| 1709 | "svc": "A String", # Trusted attributes discharged by the service. |
| 1710 | "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. |
| 1711 | "values": [ # The objects of the condition. |
| 1712 | "A String", |
| 1713 | ], |
| 1714 | }, |
| 1715 | ], |
| 1716 | "description": "A String", # Human-readable description of the rule. |
| 1717 | "ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. |
| 1718 | "A String", |
| 1719 | ], |
| 1720 | "logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. |
| 1721 | { # Specifies what kind of log the caller must write |
| 1722 | "cloudAudit": { # Write a Cloud Audit log # Cloud audit options. |
| 1723 | "authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline. |
| 1724 | "permissionType": "A String", # The type of the permission that was checked. |
| 1725 | }, |
| 1726 | "logName": "A String", # The log_name to populate in the Cloud Audit Record. |
| 1727 | }, |
| 1728 | "counter": { # Increment a streamz counter with the specified metric and field names. # Counter options. |
| 1729 | # |
| 1730 | # Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. |
| 1731 | # |
| 1732 | # Field names correspond to IAM request parameters and field values are their respective values. |
| 1733 | # |
| 1734 | # Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields. |
| 1735 | # |
| 1736 | # Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]} |
| 1737 | "customFields": [ # Custom fields. |
| 1738 | { # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields. |
| 1739 | "name": "A String", # Name is the field name. |
| 1740 | "value": "A String", # Value is the field value. It is important that in contrast to the CounterOptions.field, the value here is a constant that is not derived from the IAMContext. |
| 1741 | }, |
| 1742 | ], |
| 1743 | "field": "A String", # The field value to attribute. |
| 1744 | "metric": "A String", # The metric to update. |
| 1745 | }, |
| 1746 | "dataAccess": { # Write a Data Access (Gin) log # Data access options. |
| 1747 | "logMode": "A String", |
| 1748 | }, |
| 1749 | }, |
| 1750 | ], |
| 1751 | "notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. |
| 1752 | "A String", |
| 1753 | ], |
| 1754 | "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. |
| 1755 | "A String", |
| 1756 | ], |
| 1757 | }, |
| 1758 | ], |
| 1759 | "version": 42, # Specifies the format of the policy. |
| 1760 | # |
| 1761 | # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. |
| 1762 | # |
| 1763 | # Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: |
| 1764 | # |
| 1765 | # * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions |
| 1766 | # |
| 1767 | # **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. |
| 1768 | # |
| 1769 | # If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. |
| 1770 | # |
| 1771 | # To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1772 | }</pre> |
| 1773 | </div> |
| 1774 | |
| 1775 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1776 | <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1777 | <pre>Returns permissions that a caller has on the specified resource. |
| 1778 | |
| 1779 | Args: |
| 1780 | project: string, Project ID for this request. (required) |
| 1781 | resource: string, Name or id of the resource for this request. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1782 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1783 | The object takes the form of: |
| 1784 | |
| 1785 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1786 | "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. |
| 1787 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1788 | ], |
| 1789 | } |
| 1790 | |
| 1791 | |
| 1792 | Returns: |
| 1793 | An object of the form: |
| 1794 | |
| 1795 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1796 | "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. |
| 1797 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1798 | ], |
| 1799 | }</pre> |
| 1800 | </div> |
| 1801 | |
| Craig Citro | 0e5b9bf | 2014-10-15 10:26:14 -0700 | [diff] [blame] | 1802 | </body></html> |