Idem.GCP.COMPUTE.DISK

Idem.GCP.COMPUTE.DISK
Idem.GCP.COMPUTE.DISK
JSON Example
{
    "account": "string",
    "architecture": "string",
    "count": 0,
    "description": "string",
    "disk_encryption_key": {
        "kms_key_name": "string",
        "kms_key_service_account": "string",
        "raw_key": "string",
        "rsa_encrypted_key": "string"
    },
    "guest_os_features": [
        {
            "type_": "string"
        }
    ],
    "id_": "string",
    "label_fingerprint": "string",
    "license_codes": [
        "string"
    ],
    "licenses": [
        "string"
    ],
    "location_hint": "string",
    "name": "string",
    "options": "string",
    "params": {},
    "physical_block_size_bytes": "string",
    "project": "string",
    "provisioned_iops": "string",
    "region": "string",
    "replica_zones": [
        "string"
    ],
    "request_id": "string",
    "resource_id": "string",
    "resource_policies": [
        "string"
    ],
    "size_gb": "string",
    "source_disk": "string",
    "source_image": "string",
    "source_image_encryption_key": {
        "kms_key_name": "string",
        "kms_key_service_account": "string",
        "raw_key": "string",
        "rsa_encrypted_key": "string"
    },
    "source_snapshot": "string",
    "source_snapshot_encryption_key": {
        "kms_key_name": "string",
        "kms_key_service_account": "string",
        "raw_key": "string",
        "rsa_encrypted_key": "string"
    },
    "source_storage_object": "string",
    "type_": "string",
    "zone": "string"
}
string
account
Required

The name of the vRA cloud account to use during provisioning

string
architecture
Optional

The architecture of the disk. Valid values are ARM64 or X86_64. Defaults to None.

integer
count
Optional

The number of resource instances to be created.

string
description
Optional

An optional description of this resource. Defaults to None.

object
disk_encryption_key
Optional

Encrypts the disk using a customer-supplied encryption key or a customer-managed encryption key. Encryption keys do not protect access to metadata of the disk. After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later. For example, to create a disk snapshot, to create a disk image, to create a machine image, or to attach the disk to a virtual machine. After you encrypt a disk with a customer-managed key, the diskEncryptionKey.kmsKeyName is set to a key version name once the disk is created. The disk is encrypted with this version of the key. In the response, diskEncryptionKey.kmsKeyName appears in the following format:

"diskEncryptionKey.kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key /cryptoKeysVersions/version"

If you do not provide an encryption key when creating the disk, then the disk is encrypted using an automatically generated key and you don't need to provide a key to use the disk later. Defaults to None.

array of object
guest_os_features
Optional

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. Defaults to None.

string
id_
Optional

The unique identifier for the resource. This identifier is defined by the server. Read-only property

string
label_fingerprint
Optional

A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a disk. Defaults to None.

object
labels
Optional

Labels to apply to this disk. These can be later modified by the setLabels method. Defaults to None.

array of string
license_codes
Optional

Integer license codes indicating which licenses are attached to this disk. Defaults to None.

array of string
licenses
Optional

A list of publicly visible licenses. Reserved for Google's use. Defaults to None.

string
location_hint
Optional

An opaque location hint used to place the disk close to other resources. This field is for use by internal tools that use the public API. Defaults to None.

string
name
Optional

An Idem name of the resource.

string
options
Optional

Internal use only. Defaults to None.

object
params
Optional

Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. Defaults to None.

string
physical_block_size_bytes
Optional

Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. The currently supported size is 4096, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project. Defaults to None.

string
project
Optional

Project ID for this request.

string
provisioned_iops
Optional

Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. Defaults to None.

string
region
Optional

The name of the region for this request.

array of string
replica_zones
Optional

URLs of the zones where the disk should be replicated to. Only applicable for regional resources. Defaults to None.

string
request_id
Optional

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). Defaults to None.

string
resource_id
Optional

An identifier of the resource in the provider. Defaults to None.

array of string
resource_policies
Optional

Resource policies applied to this disk for automatic snapshot creations. To remove a policy set resource_policies to be an empty array e.g. [] Defaults to None.

string
size_gb
Optional

Size, in GB, of the persistent disk. You can specify this field when creating a persistent disk using the sourceImage, sourceSnapshot, or sourceDisk parameter, or specify it alone to create an empty persistent disk. If you specify this field along with a source, the value of sizeGb must not be less than the size of the source. Acceptable values are 1 to 65536, inclusive. Defaults to None.

string
source_disk
Optional

The source disk used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:

Defaults to None.

string
source_image
Optional

The source image used to create this disk. If the source image is deleted, this field will not be set. 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: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family . Defaults to None.

object
source_image_encryption_key
Optional

The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. Defaults to None.

  • raw_key(str, Optional)
  • rsa_encrypted_key(str, Optional)
  • kms_key_name(str, Optional)
  • kms_key_service_account(str, Optional)
string
source_snapshot
Optional

The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:

Defaults to None.

object
source_snapshot_encryption_key
Optional

The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. Defaults to None.

  • raw_key(str, Optional)
  • rsa_encrypted_key(str, Optional)
  • kms_key_name(str, Optional)
  • kms_key_service_account(str, Optional)
string
source_storage_object
Optional

The full Google Cloud Storage URI where the disk image is stored. This file must be a gzip-compressed tarball whose name ends in .tar.gz or virtual machine disk whose name ends in vmdk. Valid URIs may start with gs:// or https://storage.googleapis.com/. This flag is not optimized for creating multiple disks from a source storage object. To create many disks from a source storage object, use gcloud compute images import instead. Defaults to None.

string
type_
Optional

URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project /zones/zone/diskTypes/pd-ssd. See Persistent disk types. Defaults to None.

string
zone
Optional

The name of the zone for this request.