Blame - docs/dyn/compute_alpha.instanceTemplates.html - platform/external/python/google-api-python-client

2016-10-21 13:59:49 -0700

[diff] [blame]

83

84

<code><a href="#get">get(project, instanceTemplate)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

85

<p class="firstline">Returns the specified instance template. Gets a list of available instance templates by making a list() request.</p>

86

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

87

<code><a href="#getIamPolicy">getIamPolicy(project, resource, optionsRequestedPolicyVersion=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

88

<p class="firstline">Gets the access control policy for a resource. May be empty if no such policy or resource exists.</p>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

89

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

90

<code><a href="#insert">insert(project, body=None, requestId=None)</a></code></p>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

91

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

92

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

93

<code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

94

<p class="firstline">Retrieves a list of instance templates that are contained within the specified project.</p>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

95

96

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

97

<p class="firstline">Retrieves the next page of results.</p>

98

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

99

<code><a href="#setIamPolicy">setIamPolicy(project, resource, body=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

100

<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p>

101

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

102

<code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None)</a></code></p>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

103

<p class="firstline">Returns permissions that a caller has on the specified resource.</p>

104

<h3>Method Details</h3>

105

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

106

<code class="details" id="close">close()</code>

107

<pre>Close httplib2 connections.</pre>

</div>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

111

<code class="details" id="delete">delete(project, instanceTemplate, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

112

<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.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

113

114

Args:

115

project: string, Project ID for this request. (required)

116

instanceTemplate: string, The name of the instance template to delete. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

117

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.

118

119

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.

120

121

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

122

123

Returns:

124

An object of the form:

125

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

126

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

127

#

128

# Google Compute Engine has three Operation resources:

129

#

130

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

131

#

132

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

133

#

134

# Operations can be global, regional or zonal.

135

# - For global operations, use the `globalOperations` resource.

136

# - For regional operations, use the `regionOperations` resource.

137

# - For zonal operations, use the `zonalOperations` resource.

138

#

139

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

140

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

141

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

142

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

143

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

144

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

145

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

146

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

147

"code": "A String", # [Output Only] The error type identifier for this error.

148

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

149

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

150

},

151

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

152

},

153

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

154

"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.

155

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

156

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

157

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

158

"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.

159

#

160

# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

161

#

162

# Example 1: Pack and unpack a message in C++.

163

#

164

# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

165

#

166

# Example 2: Pack and unpack a message in Java.

167

#

168

# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }

169

#

170

# Example 3: Pack and unpack a message in Python.

171

#

172

# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

173

#

174

# Example 4: Pack and unpack a message in Go

175

#

176

# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

177

#

178

# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

#

#

#

# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:

183

#

184

# package google.profile; message Person { string first_name = 1; string last_name = 2; }

185

#

186

# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

187

#

188

# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):

189

#

190

# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

191

"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).

192

#

193

# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

194

#

195

# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

196

#

197

# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

198

#

199

# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

200

"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.

201

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

202

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

203

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

204

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

205

"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.

206

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

207

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

208

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

209

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

210

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

211

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

212

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

213

"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.

214

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

215

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

216

{

217

"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.

218

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

219

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

220

{

221

"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).

222

"value": "A String", # [Output Only] A warning data value corresponding to the key.

223

},

224

],

225

"message": "A String", # [Output Only] A human-readable description of the warning code.

226

},

227

],

228

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

229

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

<code class="details" id="get">get(project, instanceTemplate)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

234

<pre>Returns the specified instance template. Gets a list of available instance templates by making a list() request.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

235

236

Args:

237

project: string, Project ID for this request. (required)

238

instanceTemplate: string, The name of the instance template. (required)

239

240

Returns:

241

An object of the form:

242

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

243

{ # Represents an Instance Template resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

244

#

245

# You can use instance templates to create VM instances and managed instance groups. For more information, read Instance Templates. (== resource_for {$api_version}.instanceTemplates ==)

246

"creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance template in RFC3339 text format.

247

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

248

"id": "A String", # [Output Only] A unique identifier for this instance template. The server defines this identifier.

249

"kind": "compute#instanceTemplate", # [Output Only] The resource type, which is always compute#instanceTemplate for instance templates.

250

"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.

251

"properties": { # The instance properties for this instance template.

252

"advancedMachineFeatures": { # Specifies options for controlling advanced machine features. Options that would traditionally be configured in a BIOS belong here. Features that require operating system support may have corresponding entries in the GuestOsFeatures of an Image (e.g., whether or not the OS in the Image supports nested virtualization being enabled or disabled). # Controls for advanced machine-related behavior features.

253

"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).

254

"threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame^]

255

"visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

256

},

257

"canIpForward": True or False, # Enables instances created based on these properties 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.

258

"confidentialInstanceConfig": { # A set of Confidential Instance options. # Specifies the Confidential Instance options.

259

"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.

260

},

261

"description": "A String", # An optional text description for the instances that are created from these properties.

262

"disks": [ # An array of disks that are associated with the instances that are created from these properties.

263

{ # An instance-attached disk resource.

264

"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).

265

"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.

266

"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.

267

#

268

# 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.

269

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key.

270

#

271

# 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.

272

#

273

# 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.

274

#

275

# 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.

276

#

277

# Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.

278

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

279

"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.

280

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

281

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

282

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

283

# The key must meet the following requirements before you can provide it to Compute Engine:

284

# - The key is wrapped using a RSA public key certificate provided by Google.

285

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

286

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

287

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

288

},

289

"diskSizeGb": "A String", # The size of the disk in GB.

290

"forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error.

291

"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.

292

{ # Guest OS features.

293

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

294

},

295

],

296

"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.

297

"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.

298

#

299

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

300

#

301

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

302

"description": "A String", # An optional description. Provide this property when creating the disk.

303

"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.

304

"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.

305

"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:

306

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

307

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

308

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

309

# 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:

310

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType

311

# - projects/project/zones/zone/diskTypes/diskType

312

# - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.

313

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

314

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

315

# Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

316

{ # Guest OS features.

317

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

318

},

319

],

320

"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.

321

"a_key": "A String",

322

},

323

"multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.

324

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

325

"provisionedIops": "A String", # Indicates how many IOPS must be provisioned for the disk.

326

"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

327

"A String",

328

],

329

"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.

330

"A String",

331

],

332

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

333

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

334

# 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:

335

# projects/debian-cloud/global/images/family/debian-9

336

#

337

#

338

# Alternatively, use a specific version of a public operating system image:

339

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

340

#

341

#

342

# To create a disk with a custom image that you created, specify the image name in the following format:

343

# global/images/my-custom-image

344

#

345

#

346

# 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:

347

# global/images/family/my-image-family

348

#

349

#

350

# If the source image is deleted later, this field will not be set.

351

"sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

352

#

353

# 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

354

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

355

"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.

356

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

357

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

358

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

359

# The key must meet the following requirements before you can provide it to Compute Engine:

360

# - The key is wrapped using a RSA public key certificate provided by Google.

361

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

362

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

363

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

364

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

365

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

366

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

367

# To create a disk with a snapshot that you created, specify the snapshot name in the following format:

368

# global/snapshots/my-backup

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

369

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

370

#

371

# If the source snapshot is deleted later, this field will not be set.

372

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

373

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

374

"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.

375

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

376

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

377

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

378

# The key must meet the following requirements before you can provide it to Compute Engine:

379

# - The key is wrapped using a RSA public key certificate provided by Google.

380

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

381

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

382

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

383

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

384

},

385

"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.

386

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

387

"licenses": [ # [Output Only] Any valid publicly visible licenses.

388

"A String",

389

],

390

"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.

391

"savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to PRESERVED if the LocalSSD data has been saved to a persistent location by customer request. (see the discard_local_ssd option on Stop/Suspend). Read-only in the api.

392

"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

393

"dbs": [ # The Key Database (db).

394

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

395

"content": "A String", # The raw content in the secure keys file.

396

"fileType": "A String", # The file type of source file.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

397

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

398

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

399

"dbxs": [ # The forbidden key database (dbx).

400

{

401

"content": "A String", # The raw content in the secure keys file.

402

"fileType": "A String", # The file type of source file.

403

},

404

],

405

"keks": [ # The Key Exchange Key (KEK).

406

{

407

"content": "A String", # The raw content in the secure keys file.

408

"fileType": "A String", # The file type of source file.

409

},

410

],

411

"pk": { # The Platform Key (PK).

412

"content": "A String", # The raw content in the secure keys file.

413

"fileType": "A String", # The file type of source file.

414

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

415

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

416

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

417

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

418

# If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

419

#

420

# Note that for InstanceTemplate, specify the disk name, not the URL for the disk.

421

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

422

"userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of URLs to the license resource. Unlike regular licenses, user provided licenses can be modified after the disk is created.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

423

"A String",

424

],

425

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

426

],

427

"displayDevice": { # A set of Display Device options # Display Device properties to enable support for remote display products like: Teradici, VNC and TeamViewer

428

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

429

},

430

"guestAccelerators": [ # A list of guest accelerator cards' type and count to use for instances created from these properties.

431

{ # A specification of the type and number of accelerator cards attached to the instance.

432

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

433

"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.

434

},

435

],

436

"labels": { # Labels to apply to instances that are created from these properties.

437

"a_key": "A String",

438

},

439

"machineType": "A String", # The machine type to use for instances that are created from these properties.

440

"metadata": { # A metadata key/value entry. # The metadata key/value pairs to assign to instances that are created from these properties. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information.

441

"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.

442

#

443

# To see the latest fingerprint, make a get() request to retrieve the resource.

444

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

445

{

446

"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.

447

"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).

448

},

449

],

450

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

451

},

452

"minCpuPlatform": "A String", # Minimum cpu/platform to be used by instances. 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.

453

"networkInterfaces": [ # An array of network access configurations for this interface.

454

{ # A network interface resource attached to an instance.

455

"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.

456

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

457

"externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.

458

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

459

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

460

"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.

461

"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.

462

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

463

#

464

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

465

#

466

# 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.

467

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

468

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

469

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

470

"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.

471

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

472

},

473

],

474

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

475

{ # An alias IP range attached to an instance's network interface.

476

"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).

477

"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.

478

},

479

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame^]

480

"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. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

481

"internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range.

482

"ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.

483

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

484

"externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.

485

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

486

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

487

"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.

488

"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.

489

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

490

#

491

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

492

#

493

# 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.

494

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

495

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

496

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

497

"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.

498

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

499

},

500

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

501

"ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork.

502

#

503

# Valid only if stackType is IPV4_IPV6.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

504

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

505

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

506

"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.

507

"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.

508

#

509

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

510

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

511

# - projects/project/global/networks/network

512

# - global/networks/default

513

"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.

514

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

515

"queueCount": 42, # The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users.

516

"stackType": "A String", # The stack type for this network interface to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used.

517

#

518

# This field can be both set at instance creation and update network interface operations.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

519

"subinterfaces": [ # SubInterfaces help enable L2 communication for the instance over subnetworks that support L2. Every network interface will get a default untagged (vlan not specified) subinterface. Users can specify additional tagged subinterfaces which are sub-fields to the Network Interface.

520

{

521

"ipAddress": "A String", # An IPv4 internal IP address to assign to the instance for this subinterface.

522

"subnetwork": "A String", # If specified, this subnetwork must belong to the same network as that of the network interface. If not specified the subnet of network interface will be used. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:

523

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

524

# - regions/region/subnetworks/subnetwork

525

"vlan": 42, # VLAN tag. Should match the VLAN(s) supported by the subnetwork to which this subinterface is connecting.

526

},

527

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

528

"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:

529

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

530

# - regions/region/subnetworks/subnetwork

531

},

532

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

533

"networkPerformanceConfig": {

534

"externalIpEgressBandwidthTier": "A String",

535

"totalEgressBandwidthTier": "A String",

536

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

537

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.

538

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for VMs. If not specified, use INHERIT_FROM_SUBNETWORK as default.

539

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that instances can consume from.

540

"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.

541

"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.

542

"values": [ # Corresponds to the label values of a reservation resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

543

"A String",

544

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

545

},

546

"resourcePolicies": [ # Resource policies (names, not ULRs) applied to instances created from these properties.

547

"A String",

548

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame^]

549

"scheduling": { # Sets the scheduling options for an Instance. NextID: 20 # Specifies the scheduling options for the instances that are created from these properties.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

550

"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.

551

#

552

# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

553

"availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

554

"latencyTolerant": True or False, # Defines whether the instance is tolerant of higher cpu latency. This can only be set during instance creation, or when the instance is not currently running. It must not be set if the preemptible option is also set.

555

"locationHint": "A String", # An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.

556

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after instance creation where the instance won't be scheduled for maintenance.

557

"maintenanceInterval": "A String", # Specifies whether this VM may be a stable fleet VM. Setting this to "Periodic" designates this VM as a Stable Fleet VM.

558

#

559

# See go/stable-fleet-ug for more details.

560

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

561

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

562

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

563

"key": "A String", # Corresponds to the label key of Node resource.

564

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

565

"values": [ # Corresponds to the label values of Node resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"A String",

],

},

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

570

"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.

571

"preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.

572

},

573

"serviceAccounts": [ # A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from these properties. Use metadata queries to obtain the access tokens for these instances.

574

{ # A service account.

575

"email": "A String", # Email address of the service account.

576

"scopes": [ # The list of scopes to be made available for this service account.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

577

"A String",

578

],

579

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

580

],

581

"shieldedInstanceConfig": { # A set of Shielded Instance options.

582

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

583

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

584

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

585

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

586

"shieldedVmConfig": { # A set of Shielded VM options. # Specifies the Shielded VM options for the instances that are created from these properties.

587

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

588

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

589

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

590

},

591

"tags": { # A set of instance tags. # A list of tags to apply to the instances that are created from these properties. 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.

592

"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.

593

#

594

# To see the latest fingerprint, make get() request to the instance.

595

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

596

"A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

597

],

598

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

599

},

600

"selfLink": "A String", # [Output Only] The URL for this instance template. The server defines this URL.

601

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

602

"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:

603

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance

604

# - projects/project/zones/zone/instances/instance

605

"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.

606

"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.

607

{ # A specification of the desired way to instantiate a disk in the instance template when its created from a source instance.

608

"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).

609

"customImage": "A String", # The custom source image to be used to restore this disk when instantiating this instance template.

610

"deviceName": "A String", # Specifies the device name of the disk to which the configurations apply to.

611

"instantiateFrom": "A String", # Specifies whether to include the disk and what image to use. Possible values are:

612

# - 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.

613

# - 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.

614

# - custom-image: to use a user-provided image url for disk creation. Applicable to the boot disk and additional read-write disks.

615

# - attach-read-only: to attach a read-only disk. Applicable to read-only disks.

616

# - do-not-include: to exclude a disk from the template. Applicable to additional read-write disks, local SSDs, and read-only disks.

},

],

},

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

624

<code class="details" id="getIamPolicy">getIamPolicy(project, resource, optionsRequestedPolicyVersion=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

625

<pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists.

626

627

Args:

628

project: string, Project ID for this request. (required)

629

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

630

optionsRequestedPolicyVersion: integer, Requested IAM Policy version.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

631

632

Returns:

633

An object of the form:

634

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

635

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

#

#

#

# 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.

640

#

641

# 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).

#

# **JSON example:**

#

# { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }

#

# **YAML example:**

#

# bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3

650

#

651

# For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

652

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

653

{ # 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.

654

#

655

# 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.

656

#

657

# Example Policy with multiple AuditConfigs:

658

#

659

# { "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" ] } ] } ] }

660

#

661

# 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.

662

"auditLogConfigs": [ # The configuration for logging of each type of permission.

663

{ # Provides the configuration for logging a type of permissions. Example:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

664

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

665

# { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] }

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

666

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

667

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

668

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

669

"A String",

670

],

671

"ignoreChildExemptions": True or False,

672

"logType": "A String", # The log type that this config enables.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

673

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

],

"exemptedMembers": [

"A String",

],

"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.

679

},

680

],

681

"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.

682

{ # Associates `members` with a `role`.

683

"bindingId": "A String",

684

"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.

685

#

686

# If the condition evaluates to `true`, then this binding applies to the current request.

687

#

688

# 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.

689

#

690

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

691

#

692

# Example (Comparison):

693

#

694

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

695

#

696

# Example (Equality):

697

#

698

# title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'"

703

#

704

# Example (Data Manipulation):

705

#

706

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

707

#

708

# 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.

709

"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.

710

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

711

"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.

712

"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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

713

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

714

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

715

#

716

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

717

#

718

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

719

#

720

# * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .

#

#

#

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

725

#

726

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

727

#

728

# * `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.

729

#

730

# * `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.

731

#

732

# * `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.

#

#

#

# * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

737

"A String",

738

],

739

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

740

},

741

],

742

"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.

743

#

744

# **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.

745

"iamOwned": True or False,

746

"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.

747

{ # A rule to be applied in a Policy.

748

"action": "A String", # Required

749

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

750

{ # A condition to be met.

751

"iam": "A String", # Trusted attributes supplied by the IAM system.

752

"op": "A String", # An operator to apply the subject with.

753

"svc": "A String", # Trusted attributes discharged by the service.

754

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

755

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

761

"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.

762

"A String",

763

],

764

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

765

{ # Specifies what kind of log the caller must write

766

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

767

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

768

"permissionType": "A String", # The type of the permission that was checked.

769

},

770

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

771

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

772

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

773

#

774

# 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.

775

#

776

# Field names correspond to IAM request parameters and field values are their respective values.

777

#

778

# 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.

779

#

780

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

781

"customFields": [ # Custom fields.

782

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

783

"name": "A String", # Name is the field name.

784

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

785

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

786

],

787

"field": "A String", # The field value to attribute.

788

"metric": "A String", # The metric to update.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

789

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

790

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

791

"logMode": "A String",

},

},

],

"notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.

796

"A String",

797

],

798

"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.

"A String",

],

},

],

"version": 42, # Specifies the format of the policy.

804

#

805

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

806

#

807

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

808

#

809

# * 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

810

#

811

# **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.

812

#

813

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

814

#

815

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

816

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

820

<code class="details" id="insert">insert(project, body=None, requestId=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

821

<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.

822

823

Args:

824

project: string, Project ID for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

825

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

826

The object takes the form of:

827

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

828

{ # Represents an Instance Template resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

829

#

830

# You can use instance templates to create VM instances and managed instance groups. For more information, read Instance Templates. (== resource_for {$api_version}.instanceTemplates ==)

831

"creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance template in RFC3339 text format.

832

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

833

"id": "A String", # [Output Only] A unique identifier for this instance template. The server defines this identifier.

834

"kind": "compute#instanceTemplate", # [Output Only] The resource type, which is always compute#instanceTemplate for instance templates.

835

"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.

836

"properties": { # The instance properties for this instance template.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

837

"advancedMachineFeatures": { # Specifies options for controlling advanced machine features. Options that would traditionally be configured in a BIOS belong here. Features that require operating system support may have corresponding entries in the GuestOsFeatures of an Image (e.g., whether or not the OS in the Image supports nested virtualization being enabled or disabled). # Controls for advanced machine-related behavior features.

838

"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).

839

"threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame^]

840

"visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

841

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

842

"canIpForward": True or False, # Enables instances created based on these properties 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

843

"confidentialInstanceConfig": { # A set of Confidential Instance options. # Specifies the Confidential Instance options.

844

"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

845

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

846

"description": "A String", # An optional text description for the instances that are created from these properties.

847

"disks": [ # An array of disks that are associated with the instances that are created from these properties.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

848

{ # An instance-attached disk resource.

849

"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).

850

"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.

851

"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.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

852

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

853

# 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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

854

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

855

#

856

# 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.

857

#

858

# 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.

859

#

860

# 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.

861

#

862

# Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.

863

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

864

"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.

865

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

866

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

867

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

868

# The key must meet the following requirements before you can provide it to Compute Engine:

869

# - The key is wrapped using a RSA public key certificate provided by Google.

870

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

871

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

872

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

873

},

874

"diskSizeGb": "A String", # The size of the disk in GB.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

875

"forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

876

"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.

877

{ # Guest OS features.

878

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

879

},

880

],

881

"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.

882

"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.

883

#

884

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

885

#

886

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

887

"description": "A String", # An optional description. Provide this property when creating the disk.

888

"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.

889

"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.

890

"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:

891

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

892

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

893

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

894

# 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:

895

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType

896

# - projects/project/zones/zone/diskTypes/diskType

897

# - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.

898

"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.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

899

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

900

# Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

901

{ # Guest OS features.

902

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

903

},

904

],

905

"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.

906

"a_key": "A String",

907

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

908

"multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

909

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

910

"provisionedIops": "A String", # Indicates how many IOPS must be provisioned for the disk.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

911

"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

912

"A String",

913

],

914

"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.

915

"A String",

916

],

917

"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.

918

#

919

# 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:

920

# projects/debian-cloud/global/images/family/debian-9

921

#

922

#

923

# Alternatively, use a specific version of a public operating system image:

924

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

925

#

926

#

927

# To create a disk with a custom image that you created, specify the image name in the following format:

928

# global/images/my-custom-image

929

#

930

#

931

# 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:

932

# global/images/family/my-image-family

933

#

934

#

935

# If the source image is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

936

"sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

937

#

938

# 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.

939

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

940

"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.

941

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

942

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

943

#

944

# The key must meet the following requirements before you can provide it to Compute Engine:

945

# - The key is wrapped using a RSA public key certificate provided by Google.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

946

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

947

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

948

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

949

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

950

"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.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

951

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

952

# To create a disk with a snapshot that you created, specify the snapshot name in the following format:

953

# global/snapshots/my-backup

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

954

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

955

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

956

# If the source snapshot is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

957

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

958

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

959

"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.

960

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

961

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

962

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

963

# The key must meet the following requirements before you can provide it to Compute Engine:

964

# - The key is wrapped using a RSA public key certificate provided by Google.

965

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

966

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

967

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

968

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

969

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

970

"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.

971

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

972

"licenses": [ # [Output Only] Any valid publicly visible licenses.

973

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

974

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

975

"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.

976

"savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to PRESERVED if the LocalSSD data has been saved to a persistent location by customer request. (see the discard_local_ssd option on Stop/Suspend). Read-only in the api.

977

"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

978

"dbs": [ # The Key Database (db).

979

{

980

"content": "A String", # The raw content in the secure keys file.

981

"fileType": "A String", # The file type of source file.

982

},

Sai Cheemalapati

4ba8c23

2017-06-06 18:46:08 -0400

[diff] [blame]

983

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

984

"dbxs": [ # The forbidden key database (dbx).

985

{

986

"content": "A String", # The raw content in the secure keys file.

987

"fileType": "A String", # The file type of source file.

988

},

989

],

990

"keks": [ # The Key Exchange Key (KEK).

991

{

992

"content": "A String", # The raw content in the secure keys file.

993

"fileType": "A String", # The file type of source file.

994

},

995

],

996

"pk": { # The Platform Key (PK).

997

"content": "A String", # The raw content in the secure keys file.

998

"fileType": "A String", # The file type of source file.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

999

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1000

},

1001

"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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1002

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1003

# If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

1004

#

1005

# Note that for InstanceTemplate, specify the disk name, not the URL for the disk.

1006

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1007

"userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of URLs to the license resource. Unlike regular licenses, user provided licenses can be modified after the disk is created.

1008

"A String",

1009

],

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1010

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1011

],

1012

"displayDevice": { # A set of Display Device options # Display Device properties to enable support for remote display products like: Teradici, VNC and TeamViewer

1013

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1014

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1015

"guestAccelerators": [ # A list of guest accelerator cards' type and count to use for instances created from these properties.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1016

{ # A specification of the type and number of accelerator cards attached to the instance.

1017

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

1018

"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.

1019

},

1020

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1021

"labels": { # Labels to apply to instances that are created from these properties.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1022

"a_key": "A String",

1023

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1024

"machineType": "A String", # The machine type to use for instances that are created from these properties.

1025

"metadata": { # A metadata key/value entry. # The metadata key/value pairs to assign to instances that are created from these properties. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1026

"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.

1027

#

1028

# To see the latest fingerprint, make a get() request to retrieve the resource.

1029

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

1030

{

1031

"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.

1032

"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).

1033

},

1034

],

1035

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

1036

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1037

"minCpuPlatform": "A String", # Minimum cpu/platform to be used by instances. 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1038

"networkInterfaces": [ # An array of network access configurations for this interface.

1039

{ # A network interface resource attached to an instance.

1040

"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.

1041

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1042

"externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.

1043

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1044

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

1045

"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.

1046

"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.

1047

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

1048

#

1049

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

1050

#

1051

# 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.

1052

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

1053

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

1054

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

1055

"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.

1056

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

1057

},

1058

],

1059

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

1060

{ # An alias IP range attached to an instance's network interface.

1061

"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).

1062

"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.

1063

},

1064

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame^]

1065

"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. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1066

"internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range.

1067

"ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.

1068

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

1069

"externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.

1070

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

1071

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

1072

"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.

1073

"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.

1074

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

1075

#

1076

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

1077

#

1078

# 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.

1079

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

1080

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

1081

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

1082

"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.

1083

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

1084

},

1085

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1086

"ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork.

1087

#

1088

# Valid only if stackType is IPV4_IPV6.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1089

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

1090

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

1091

"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.

1092

"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.

1093

#

1094

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

1095

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

1096

# - projects/project/global/networks/network

1097

# - global/networks/default

1098

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1099

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

1100

"queueCount": 42, # The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users.

1101

"stackType": "A String", # The stack type for this network interface to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used.

1102

#

1103

# This field can be both set at instance creation and update network interface operations.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1104

"subinterfaces": [ # SubInterfaces help enable L2 communication for the instance over subnetworks that support L2. Every network interface will get a default untagged (vlan not specified) subinterface. Users can specify additional tagged subinterfaces which are sub-fields to the Network Interface.

1105

{

1106

"ipAddress": "A String", # An IPv4 internal IP address to assign to the instance for this subinterface.

1107

"subnetwork": "A String", # If specified, this subnetwork must belong to the same network as that of the network interface. If not specified the subnet of network interface will be used. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:

1108

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

1109

# - regions/region/subnetworks/subnetwork

1110

"vlan": 42, # VLAN tag. Should match the VLAN(s) supported by the subnetwork to which this subinterface is connecting.

1111

},

1112

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1113

"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:

1114

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

1115

# - regions/region/subnetworks/subnetwork

1116

},

1117

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1118

"networkPerformanceConfig": {

1119

"externalIpEgressBandwidthTier": "A String",

1120

"totalEgressBandwidthTier": "A String",

1121

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1122

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1123

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for VMs. If not specified, use INHERIT_FROM_SUBNETWORK as default.

1124

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that instances can consume from.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1125

"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.

1126

"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.

1127

"values": [ # Corresponds to the label values of a reservation resource.

1128

"A String",

1129

],

1130

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1131

"resourcePolicies": [ # Resource policies (names, not ULRs) applied to instances created from these properties.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1132

"A String",

1133

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame^]

1134

"scheduling": { # Sets the scheduling options for an Instance. NextID: 20 # Specifies the scheduling options for the instances that are created from these properties.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1135

"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.

1136

#

1137

# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1138

"availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1139

"latencyTolerant": True or False, # Defines whether the instance is tolerant of higher cpu latency. This can only be set during instance creation, or when the instance is not currently running. It must not be set if the preemptible option is also set.

1140

"locationHint": "A String", # An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1141

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after instance creation where the instance won't be scheduled for maintenance.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1142

"maintenanceInterval": "A String", # Specifies whether this VM may be a stable fleet VM. Setting this to "Periodic" designates this VM as a Stable Fleet VM.

1143

#

1144

# See go/stable-fleet-ug for more details.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1145

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

1146

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

1147

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

1148

"key": "A String", # Corresponds to the label key of Node resource.

1149

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

1150

"values": [ # Corresponds to the label values of Node resource.

"A String",

],

},

],

"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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1156

"preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1157

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1158

"serviceAccounts": [ # A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from these properties. Use metadata queries to obtain the access tokens for these instances.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1159

{ # A service account.

1160

"email": "A String", # Email address of the service account.

1161

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

1167

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

1168

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

1169

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

1170

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1171

"shieldedVmConfig": { # A set of Shielded VM options. # Specifies the Shielded VM options for the instances that are created from these properties.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1172

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

1173

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

1174

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

1175

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1176

"tags": { # A set of instance tags. # A list of tags to apply to the instances that are created from these properties. 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1177

"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.

1178

#

1179

# To see the latest fingerprint, make get() request to the instance.

1180

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

"A String",

],

},

},

"selfLink": "A String", # [Output Only] The URL for this instance template. The server defines this URL.

1186

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1187

"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:

1188

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance

1189

# - projects/project/zones/zone/instances/instance

1190

"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.

1191

"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.

1192

{ # A specification of the desired way to instantiate a disk in the instance template when its created from a source instance.

1193

"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).

1194

"customImage": "A String", # The custom source image to be used to restore this disk when instantiating this instance template.

1195

"deviceName": "A String", # Specifies the device name of the disk to which the configurations apply to.

1196

"instantiateFrom": "A String", # Specifies whether to include the disk and what image to use. Possible values are:

1197

# - 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.

1198

# - 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.

1199

# - custom-image: to use a user-provided image url for disk creation. Applicable to the boot disk and additional read-write disks.

1200

# - attach-read-only: to attach a read-only disk. Applicable to read-only disks.

1201

# - do-not-include: to exclude a disk from the template. Applicable to additional read-write disks, local SSDs, and read-only disks.

},

],

},

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1206

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1207

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.

1208

1209

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.

1210

1211

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1212

1213

Returns:

1214

An object of the form:

1215

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1216

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1217

#

1218

# Google Compute Engine has three Operation resources:

1219

#

1220

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

1221

#

1222

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

1223

#

1224

# Operations can be global, regional or zonal.

1225

# - For global operations, use the `globalOperations` resource.

1226

# - For regional operations, use the `regionOperations` resource.

1227

# - For zonal operations, use the `zonalOperations` resource.

1228

#

1229

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

1230

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1231

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1232

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1233

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1234

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1235

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1236

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1237

"code": "A String", # [Output Only] The error type identifier for this error.

1238

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1239

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1240

},

1241

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1242

},

1243

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1244

"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.

1245

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

1246

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1247

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1248

"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.

1249

#

1250

# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

1251

#

1252

# Example 1: Pack and unpack a message in C++.

1253

#

1254

# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

1255

#

1256

# Example 2: Pack and unpack a message in Java.

1257

#

1258

# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }

1259

#

1260

# Example 3: Pack and unpack a message in Python.

1261

#

1262

# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

1263

#

1264

# Example 4: Pack and unpack a message in Go

1265

#

1266

# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

1267

#

1268

# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

#

#

#

# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:

1273

#

1274

# package google.profile; message Person { string first_name = 1; string last_name = 2; }

1275

#

1276

# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

1277

#

1278

# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):

1279

#

1280

# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

1281

"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).

1282

#

1283

# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

1284

#

1285

# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

1286

#

1287

# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

1288

#

1289

# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

1290

"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.

1291

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1292

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1293

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1294

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1295

"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.

1296

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

1297

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1298

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1299

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1300

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

1301

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1302

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1303

"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.

1304

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1305

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1306

{

1307

"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.

1308

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1309

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

1310

{

1311

"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).

1312

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1313

},

1314

],

1315

"message": "A String", # [Output Only] A human-readable description of the warning code.

1316

},

1317

],

1318

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

1319

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1323

<code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1324

<pre>Retrieves a list of instance templates that are contained within the specified project.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1325

1326

Args:

1327

project: string, Project ID for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1328

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1329

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1330

For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1331

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1332

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.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1333

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1334

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

1335

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

1336

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

1337

1338

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.

1339

1340

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

1341

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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1342

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1343

1344

Returns:

1345

An object of the form:

1346

1347

{ # A list of instance templates.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1348

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

1349

"items": [ # A list of InstanceTemplate resources.

1350

{ # Represents an Instance Template resource.

1351

#

1352

# You can use instance templates to create VM instances and managed instance groups. For more information, read Instance Templates. (== resource_for {$api_version}.instanceTemplates ==)

1353

"creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance template in RFC3339 text format.

1354

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

1355

"id": "A String", # [Output Only] A unique identifier for this instance template. The server defines this identifier.

1356

"kind": "compute#instanceTemplate", # [Output Only] The resource type, which is always compute#instanceTemplate for instance templates.

1357

"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.

1358

"properties": { # The instance properties for this instance template.

1359

"advancedMachineFeatures": { # Specifies options for controlling advanced machine features. Options that would traditionally be configured in a BIOS belong here. Features that require operating system support may have corresponding entries in the GuestOsFeatures of an Image (e.g., whether or not the OS in the Image supports nested virtualization being enabled or disabled). # Controls for advanced machine-related behavior features.

1360

"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).

1361

"threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame^]

1362

"visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1363

},

1364

"canIpForward": True or False, # Enables instances created based on these properties 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.

1365

"confidentialInstanceConfig": { # A set of Confidential Instance options. # Specifies the Confidential Instance options.

1366

"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.

1367

},

1368

"description": "A String", # An optional text description for the instances that are created from these properties.

1369

"disks": [ # An array of disks that are associated with the instances that are created from these properties.

1370

{ # An instance-attached disk resource.

1371

"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).

1372

"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.

1373

"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.

1374

#

1375

# 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.

1376

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key.

1377

#

1378

# 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.

1379

#

1380

# 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.

1381

#

1382

# 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.

1383

#

1384

# Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.

1385

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1386

"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.

1387

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1388

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1389

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1390

# The key must meet the following requirements before you can provide it to Compute Engine:

1391

# - The key is wrapped using a RSA public key certificate provided by Google.

1392

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1393

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1394

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

1395

},

1396

"diskSizeGb": "A String", # The size of the disk in GB.

1397

"forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error.

1398

"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.

1399

{ # Guest OS features.

1400

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

1401

},

1402

],

1403

"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.

1404

"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.

1405

#

1406

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

1407

#

1408

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

1409

"description": "A String", # An optional description. Provide this property when creating the disk.

1410

"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.

1411

"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.

1412

"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:

1413

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1414

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1415

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1416

# 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:

1417

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType

1418

# - projects/project/zones/zone/diskTypes/diskType

1419

# - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.

1420

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1421

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1422

# Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

1423

{ # Guest OS features.

1424

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

1425

},

1426

],

1427

"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.

1428

"a_key": "A String",

1429

},

1430

"multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.

1431

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

1432

"provisionedIops": "A String", # Indicates how many IOPS must be provisioned for the disk.

1433

"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

1434

"A String",

1435

],

1436

"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.

1437

"A String",

1438

],

1439

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1440

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1441

# 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:

1442

# projects/debian-cloud/global/images/family/debian-9

1443

#

1444

#

1445

# Alternatively, use a specific version of a public operating system image:

1446

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

1447

#

1448

#

1449

# To create a disk with a custom image that you created, specify the image name in the following format:

1450

# global/images/my-custom-image

1451

#

1452

#

1453

# 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:

1454

# global/images/family/my-image-family

1455

#

1456

#

1457

# If the source image is deleted later, this field will not be set.

1458

"sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

1459

#

1460

# 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1461

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1462

"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.

1463

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1464

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1465

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1466

# The key must meet the following requirements before you can provide it to Compute Engine:

1467

# - The key is wrapped using a RSA public key certificate provided by Google.

1468

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1469

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1470

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

1471

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1472

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1473

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1474

# To create a disk with a snapshot that you created, specify the snapshot name in the following format:

1475

# global/snapshots/my-backup

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1476

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1477

#

1478

# If the source snapshot is deleted later, this field will not be set.

1479

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

1480

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1481

"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.

1482

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1483

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1484

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1485

# The key must meet the following requirements before you can provide it to Compute Engine:

1486

# - The key is wrapped using a RSA public key certificate provided by Google.

1487

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1488

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1489

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1490

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1491

},

1492

"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.

1493

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

1494

"licenses": [ # [Output Only] Any valid publicly visible licenses.

1495

"A String",

1496

],

1497

"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.

1498

"savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to PRESERVED if the LocalSSD data has been saved to a persistent location by customer request. (see the discard_local_ssd option on Stop/Suspend). Read-only in the api.

1499

"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

1500

"dbs": [ # The Key Database (db).

1501

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1502

"content": "A String", # The raw content in the secure keys file.

1503

"fileType": "A String", # The file type of source file.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1504

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1505

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1506

"dbxs": [ # The forbidden key database (dbx).

1507

{

1508

"content": "A String", # The raw content in the secure keys file.

1509

"fileType": "A String", # The file type of source file.

1510

},

1511

],

1512

"keks": [ # The Key Exchange Key (KEK).

1513

{

1514

"content": "A String", # The raw content in the secure keys file.

1515

"fileType": "A String", # The file type of source file.

1516

},

1517

],

1518

"pk": { # The Platform Key (PK).

1519

"content": "A String", # The raw content in the secure keys file.

1520

"fileType": "A String", # The file type of source file.

1521

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1522

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1523

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1524

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1525

# If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

1526

#

1527

# Note that for InstanceTemplate, specify the disk name, not the URL for the disk.

1528

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

1529

"userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of URLs to the license resource. Unlike regular licenses, user provided licenses can be modified after the disk is created.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1530

"A String",

1531

],

1532

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1533

],

1534

"displayDevice": { # A set of Display Device options # Display Device properties to enable support for remote display products like: Teradici, VNC and TeamViewer

1535

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

1536

},

1537

"guestAccelerators": [ # A list of guest accelerator cards' type and count to use for instances created from these properties.

1538

{ # A specification of the type and number of accelerator cards attached to the instance.

1539

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

1540

"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.

1541

},

1542

],

1543

"labels": { # Labels to apply to instances that are created from these properties.

1544

"a_key": "A String",

1545

},

1546

"machineType": "A String", # The machine type to use for instances that are created from these properties.

1547

"metadata": { # A metadata key/value entry. # The metadata key/value pairs to assign to instances that are created from these properties. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information.

1548

"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.

1549

#

1550

# To see the latest fingerprint, make a get() request to retrieve the resource.

1551

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

1552

{

1553

"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.

1554

"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).

1555

},

1556

],

1557

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

1558

},

1559

"minCpuPlatform": "A String", # Minimum cpu/platform to be used by instances. 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.

1560

"networkInterfaces": [ # An array of network access configurations for this interface.

1561

{ # A network interface resource attached to an instance.

1562

"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.

1563

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

1564

"externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.

1565

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

1566

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

1567

"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.

1568

"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.

1569

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

1570

#

1571

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

1572

#

1573

# 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.

1574

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

1575

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

1576

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

1577

"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.

1578

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

1579

},

1580

],

1581

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

1582

{ # An alias IP range attached to an instance's network interface.

1583

"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).

1584

"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.

1585

},

1586

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame^]

1587

"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. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1588

"internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range.

1589

"ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.

1590

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

1591

"externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.

1592

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

1593

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

1594

"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.

1595

"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.

1596

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

1597

#

1598

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

1599

#

1600

# 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.

1601

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

1602

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

1603

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

1604

"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.

1605

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

1606

},

1607

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1608

"ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork.

1609

#

1610

# Valid only if stackType is IPV4_IPV6.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1611

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

1612

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

1613

"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.

1614

"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.

1615

#

1616

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

1617

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

1618

# - projects/project/global/networks/network

1619

# - global/networks/default

1620

"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.

1621

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

1622

"queueCount": 42, # The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users.

1623

"stackType": "A String", # The stack type for this network interface to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used.

1624

#

1625

# This field can be both set at instance creation and update network interface operations.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1626

"subinterfaces": [ # SubInterfaces help enable L2 communication for the instance over subnetworks that support L2. Every network interface will get a default untagged (vlan not specified) subinterface. Users can specify additional tagged subinterfaces which are sub-fields to the Network Interface.

1627

{

1628

"ipAddress": "A String", # An IPv4 internal IP address to assign to the instance for this subinterface.

1629

"subnetwork": "A String", # If specified, this subnetwork must belong to the same network as that of the network interface. If not specified the subnet of network interface will be used. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:

1630

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

1631

# - regions/region/subnetworks/subnetwork

1632

"vlan": 42, # VLAN tag. Should match the VLAN(s) supported by the subnetwork to which this subinterface is connecting.

1633

},

1634

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1635

"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:

1636

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

1637

# - regions/region/subnetworks/subnetwork

1638

},

1639

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1640

"networkPerformanceConfig": {

1641

"externalIpEgressBandwidthTier": "A String",

1642

"totalEgressBandwidthTier": "A String",

1643

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1644

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.

1645

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for VMs. If not specified, use INHERIT_FROM_SUBNETWORK as default.

1646

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that instances can consume from.

1647

"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.

1648

"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.

1649

"values": [ # Corresponds to the label values of a reservation resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1650

"A String",

1651

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1652

},

1653

"resourcePolicies": [ # Resource policies (names, not ULRs) applied to instances created from these properties.

1654

"A String",

1655

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame^]

1656

"scheduling": { # Sets the scheduling options for an Instance. NextID: 20 # Specifies the scheduling options for the instances that are created from these properties.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1657

"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.

1658

#

1659

# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1660

"availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1661

"latencyTolerant": True or False, # Defines whether the instance is tolerant of higher cpu latency. This can only be set during instance creation, or when the instance is not currently running. It must not be set if the preemptible option is also set.

1662

"locationHint": "A String", # An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.

1663

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after instance creation where the instance won't be scheduled for maintenance.

1664

"maintenanceInterval": "A String", # Specifies whether this VM may be a stable fleet VM. Setting this to "Periodic" designates this VM as a Stable Fleet VM.

1665

#

1666

# See go/stable-fleet-ug for more details.

1667

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

1668

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

1669

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

1670

"key": "A String", # Corresponds to the label key of Node resource.

1671

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

1672

"values": [ # Corresponds to the label values of Node resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"A String",

],

},

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1677

"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.

1678

"preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.

1679

},

1680

"serviceAccounts": [ # A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from these properties. Use metadata queries to obtain the access tokens for these instances.

1681

{ # A service account.

1682

"email": "A String", # Email address of the service account.

1683

"scopes": [ # The list of scopes to be made available for this service account.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1684

"A String",

1685

],

1686

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1687

],

1688

"shieldedInstanceConfig": { # A set of Shielded Instance options.

1689

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

1690

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

1691

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1692

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1693

"shieldedVmConfig": { # A set of Shielded VM options. # Specifies the Shielded VM options for the instances that are created from these properties.

1694

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

1695

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

1696

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

1697

},

1698

"tags": { # A set of instance tags. # A list of tags to apply to the instances that are created from these properties. 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.

1699

"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.

1700

#

1701

# To see the latest fingerprint, make get() request to the instance.

1702

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

1703

"A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1704

],

1705

},

1706

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1707

"selfLink": "A String", # [Output Only] The URL for this instance template. The server defines this URL.

1708

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1709

"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:

1710

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance

1711

# - projects/project/zones/zone/instances/instance

1712

"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.

1713

"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.

1714

{ # A specification of the desired way to instantiate a disk in the instance template when its created from a source instance.

1715

"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).

1716

"customImage": "A String", # The custom source image to be used to restore this disk when instantiating this instance template.

1717

"deviceName": "A String", # Specifies the device name of the disk to which the configurations apply to.

1718

"instantiateFrom": "A String", # Specifies whether to include the disk and what image to use. Possible values are:

1719

# - 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.

1720

# - 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.

1721

# - custom-image: to use a user-provided image url for disk creation. Applicable to the boot disk and additional read-write disks.

1722

# - attach-read-only: to attach a read-only disk. Applicable to read-only disks.

1723

# - do-not-include: to exclude a disk from the template. Applicable to additional read-write disks, local SSDs, and read-only disks.

1724

},

1725

],

1726

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1727

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1728

],

1729

"kind": "compute#instanceTemplateList", # [Output Only] The resource type, which is always compute#instanceTemplatesListResponse for instance template lists.

1730

"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.

1731

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

1732

"warning": { # [Output Only] Informational warning message.

1733

"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.

1734

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1735

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

1736

{

1737

"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).

1738

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1739

},

1740

],

1741

"message": "A String", # [Output Only] A human-readable description of the warning code.

1742

},

1743

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

1748

<pre>Retrieves the next page of results.

1749

1750

Args:

1751

previous_request: The request for the previous page. (required)

1752

previous_response: The response from the request for the previous page. (required)

1753

1754

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1755

A request object that you can call 'execute()' on to request the next

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1756

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1761

<code class="details" id="setIamPolicy">setIamPolicy(project, resource, body=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1762

<pre>Sets the access control policy on the specified resource. Replaces any existing policy.

1763

1764

Args:

1765

project: string, Project ID for this request. (required)

1766

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1767

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1768

The object takes the form of:

1769

1770

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1771

"bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings.

1772

{ # Associates `members` with a `role`.

1773

"bindingId": "A String",

1774

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1775

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1776

# If the condition evaluates to `true`, then this binding applies to the current request.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1777

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1778

# 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1779

#

1780

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1781

#

1782

# Example (Comparison):

1783

#

1784

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

1785

#

1786

# Example (Equality):

1787

#

1788

# title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'"

1793

#

1794

# Example (Data Manipulation):

1795

#

1796

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

1797

#

1798

# 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.

1799

"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.

1800

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

1801

"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.

1802

"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.

1803

},

1804

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

1805

#

1806

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

1807

#

1808

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

1809

#

1810

# * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .

#

#

#

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

1815

#

1816

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

1817

#

1818

# * `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.

1819

#

1820

# * `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.

1821

#

1822

# * `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.

#

#

#

# * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

1827

"A String",

1828

],

1829

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1830

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1831

],

1832

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.

1833

"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

2019-06-14 16:50:42 -0700

[diff] [blame]

1834

#

1835

#

1836

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1837

# 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

2019-06-14 16:50:42 -0700

[diff] [blame]

1838

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1839

# 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

2019-06-14 16:50:42 -0700

[diff] [blame]

1840

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1841

# **JSON example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1842

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1843

# { "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

2019-06-14 16:50:42 -0700

[diff] [blame]

1844

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1845

# **YAML example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1846

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1847

# 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

2019-06-14 16:50:42 -0700

[diff] [blame]

1848

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1849

# For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1850

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1851

{ # 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.

1852

#

1853

# 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.

1854

#

1855

# Example Policy with multiple AuditConfigs:

1856

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1857

# { "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

2019-06-14 16:50:42 -0700

[diff] [blame]

1858

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1859

# 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

2020-05-20 12:08:20 -0700

[diff] [blame]

1860

"auditLogConfigs": [ # The configuration for logging of each type of permission.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1861

{ # Provides the configuration for logging a type of permissions. Example:

1862

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1863

# { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1864

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1865

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

1866

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

1867

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1868

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1869

"ignoreChildExemptions": True or False,

1870

"logType": "A String", # The log type that this config enables.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1871

},

1872

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"exemptedMembers": [

"A String",

],

"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

2019-06-14 16:50:42 -0700

[diff] [blame]

1877

},

1878

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1879

"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

2019-06-14 16:50:42 -0700

[diff] [blame]

1880

{ # Associates `members` with a `role`.

Yoshi Automation Bot

0d561ef

2020-11-25 07:50:41 -0800

[diff] [blame]

1881

"bindingId": "A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1882

"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.

1883

#

1884

# If the condition evaluates to `true`, then this binding applies to the current request.

1885

#

1886

# 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.

1887

#

1888

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1889

#

1890

# Example (Comparison):

1891

#

1892

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

1893

#

1894

# Example (Equality):

1895

#

1896

# title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'"

1901

#

1902

# Example (Data Manipulation):

1903

#

1904

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

1905

#

1906

# 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.

1907

"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.

1908

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

1909

"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.

1910

"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.

1911

},

1912

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1913

#

1914

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

1915

#

1916

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

1917

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1918

# * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

#

#

#

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

1923

#

1924

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

1925

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1926

# * `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.

1927

#

1928

# * `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.

1929

#

1930

# * `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.

1931

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1932

#

1933

#

1934

# * `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

2020-05-20 12:08:20 -0700

[diff] [blame]

1935

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1936

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1937

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1938

},

1939

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1940

"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.

1941

#

1942

# **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.

1943

"iamOwned": True or False,

1944

"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.

1945

{ # A rule to be applied in a Policy.

1946

"action": "A String", # Required

1947

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

1948

{ # A condition to be met.

1949

"iam": "A String", # Trusted attributes supplied by the IAM system.

1950

"op": "A String", # An operator to apply the subject with.

1951

"svc": "A String", # Trusted attributes discharged by the service.

1952

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

1953

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

1959

"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.

1960

"A String",

1961

],

1962

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

1963

{ # Specifies what kind of log the caller must write

1964

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

1965

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

1966

"permissionType": "A String", # The type of the permission that was checked.

1967

},

1968

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

1969

},

1970

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

1971

#

1972

# 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.

1973

#

1974

# Field names correspond to IAM request parameters and field values are their respective values.

1975

#

1976

# 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.

1977

#

1978

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

1979

"customFields": [ # Custom fields.

1980

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

1981

"name": "A String", # Name is the field name.

1982

"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.

1983

},

1984

],

1985

"field": "A String", # The field value to attribute.

1986

"metric": "A String", # The metric to update.

1987

},

1988

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

1989

"logMode": "A String",

},

},

],

"notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.

1994

"A String",

1995

],

1996

"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.

"A String",

],

},

],

"version": 42, # Specifies the format of the policy.

2002

#

2003

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

2004

#

2005

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

2006

#

2007

# * 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

2008

#

2009

# **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.

2010

#

2011

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

2012

#

2013

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

},

}

Returns:

An object of the form:

2020

2021

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.

#

#

#

# A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` 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.

2026

#

2027

# 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).

#

# **JSON example:**

#

# { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }

#

# **YAML example:**

#

# bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3

2036

#

2037

# For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

2038

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

2039

{ # 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.

2040

#

2041

# 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.

2042

#

2043

# Example Policy with multiple AuditConfigs:

2044

#

2045

# { "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" ] } ] } ] }

2046

#

2047

# 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.

2048

"auditLogConfigs": [ # The configuration for logging of each type of permission.

2049

{ # Provides the configuration for logging a type of permissions. Example:

2050

#

2051

# { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] }

2052

#

2053

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

2054

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

2055

"A String",

2056

],

2057

"ignoreChildExemptions": True or False,

2058

"logType": "A String", # The log type that this config enables.

},

],

"exemptedMembers": [

"A String",

],

"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.

2065

},

2066

],

2067

"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.

2068

{ # Associates `members` with a `role`.

2069

"bindingId": "A String",

2070

"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.

2071

#

2072

# If the condition evaluates to `true`, then this binding applies to the current request.

2073

#

2074

# 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.

2075

#

2076

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

2077

#

2078

# Example (Comparison):

2079

#

2080

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

2081

#

2082

# Example (Equality):

2083

#

2084

# title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'"

2089

#

2090

# Example (Data Manipulation):

2091

#

2092

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

2093

#

2094

# 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.

2095

"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.

2096

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

2097

"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.

2098

"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.

2099

},

2100

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

2101

#

2102

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

2103

#

2104

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

2105

#

2106

# * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .

#

#

#

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

2111

#

2112

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

2113

#

2114

# * `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.

2115

#

2116

# * `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.

2117

#

2118

# * `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.

#

#

#

# * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

2123

"A String",

2124

],

2125

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

2126

},

2127

],

2128

"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.

2129

#

2130

# **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.

2131

"iamOwned": True or False,

2132

"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.

2133

{ # A rule to be applied in a Policy.

2134

"action": "A String", # Required

2135

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

2136

{ # A condition to be met.

2137

"iam": "A String", # Trusted attributes supplied by the IAM system.

2138

"op": "A String", # An operator to apply the subject with.

2139

"svc": "A String", # Trusted attributes discharged by the service.

2140

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

2141

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

2147

"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.

2148

"A String",

2149

],

2150

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

2151

{ # Specifies what kind of log the caller must write

2152

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

2153

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

2154

"permissionType": "A String", # The type of the permission that was checked.

2155

},

2156

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

2157

},

2158

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

2159

#

2160

# 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.

2161

#

2162

# Field names correspond to IAM request parameters and field values are their respective values.

2163

#

2164

# 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.

2165

#

2166

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

2167

"customFields": [ # Custom fields.

2168

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

2169

"name": "A String", # Name is the field name.

2170

"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.

2171

},

2172

],

2173

"field": "A String", # The field value to attribute.

2174

"metric": "A String", # The metric to update.

2175

},

2176

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

2177

"logMode": "A String",

},

},

],

"notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.

2182

"A String",

2183

],

2184

"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.

"A String",

],

},

],

"version": 42, # Specifies the format of the policy.

2190

#

2191

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

2192

#

2193

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

2194

#

2195

# * 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

2196

#

2197

# **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.

2198

#

2199

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

2200

#

2201

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

2202

}</pre>

Bu Sun Kim