compute.azure.com/v1api20220702

Package v1api20220702 contains API Schema definitions for the compute v1api20220702 API group

Resource Types:

APIVersion (`string` alias)

Value	Description
"2022-07-02"

ApiErrorBase_STATUS

(Appears on:ApiError_STATUS)

Api error base.

Field	Description
`code` string	Code: The error code.
`message` string	Message: The error message.
`target` string	Target: The target of the particular error.

ApiErrorBase_STATUS_ARM

(Appears on:ApiError_STATUS_ARM)

Api error base.

Field	Description
`code` string	Code: The error code.
`message` string	Message: The error message.
`target` string	Target: The target of the particular error.

ApiError_STATUS

(Appears on:DiskEncryptionSet_STATUS)

Api error.

Field	Description
`code` string	Code: The error code.
`details` []ApiErrorBase_STATUS	Details: The Api error details
`innererror` InnerError_STATUS	Innererror: The Api inner error
`message` string	Message: The error message.
`target` string	Target: The target of the particular error.

ApiError_STATUS_ARM

(Appears on:EncryptionSetProperties_STATUS_ARM)

Api error.

Field	Description
`code` string	Code: The error code.
`details` []ApiErrorBase_STATUS_ARM	Details: The Api error details
`innererror` InnerError_STATUS_ARM	Innererror: The Api inner error
`message` string	Message: The error message.
`target` string	Target: The target of the particular error.

DiskEncryptionSet

Generator information: - Generated from: /compute/resource-manager/Microsoft.Compute/DiskRP/stable/2022-07-02/diskEncryptionSet.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}

Field Description

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
DiskEncryptionSet_Spec

`activeKey` KeyForDiskEncryptionSet	ActiveKey: The key vault key which is currently used by this disk encryption set.
`azureName` string	AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.
`encryptionType` DiskEncryptionSetType	EncryptionType: The type of key used to encrypt the data of the disk.
`federatedClientId` string	FederatedClientId: Multi-tenant application client id to access key vault in a different tenant. Setting the value to ‘None’ will clear the property.
`federatedClientIdFromConfig` genruntime.ConfigMapReference	FederatedClientIdFromConfig: Multi-tenant application client id to access key vault in a different tenant. Setting the value to ‘None’ will clear the property.
`identity` EncryptionSetIdentity	Identity: The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks.
`location` string	Location: Resource location
`owner` genruntime.KnownResourceReference	Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource
`rotationToLatestKeyVersionEnabled` bool	RotationToLatestKeyVersionEnabled: Set this flag to true to enable auto-updating of this disk encryption set to the latest key version.
`tags` map[string]string	Tags: Resource tags

status
DiskEncryptionSet_STATUS

DiskEncryptionSetType (`string` alias)

(Appears on:DiskEncryptionSet_Spec, EncryptionSetProperties_ARM)

The type of key used to encrypt the data of the disk.

Value	Description
"ConfidentialVmEncryptedWithCustomerKey"
"EncryptionAtRestWithCustomerKey"
"EncryptionAtRestWithPlatformAndCustomerKeys"

DiskEncryptionSetType_STATUS (`string` alias)

(Appears on:DiskEncryptionSet_STATUS, EncryptionSetProperties_STATUS_ARM)

The type of key used to encrypt the data of the disk.

Value	Description
"ConfidentialVmEncryptedWithCustomerKey"
"EncryptionAtRestWithCustomerKey"
"EncryptionAtRestWithPlatformAndCustomerKeys"

DiskEncryptionSet_STATUS

(Appears on:DiskEncryptionSet)

disk encryption set resource.

Field	Description
`activeKey` KeyForDiskEncryptionSet_STATUS	ActiveKey: The key vault key which is currently used by this disk encryption set.
`autoKeyRotationError` ApiError_STATUS	AutoKeyRotationError: The error that was encountered during auto-key rotation. If an error is present, then auto-key rotation will not be attempted until the error on this disk encryption set is fixed.
`conditions` []genruntime/conditions.Condition	Conditions: The observed state of the resource
`encryptionType` DiskEncryptionSetType_STATUS	EncryptionType: The type of key used to encrypt the data of the disk.
`federatedClientId` string	FederatedClientId: Multi-tenant application client id to access key vault in a different tenant. Setting the value to ‘None’ will clear the property.
`id` string	Id: Resource Id
`identity` EncryptionSetIdentity_STATUS	Identity: The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks.
`lastKeyRotationTimestamp` string	LastKeyRotationTimestamp: The time when the active key of this disk encryption set was updated.
`location` string	Location: Resource location
`name` string	Name: Resource name
`previousKeys` []KeyForDiskEncryptionSet_STATUS	PreviousKeys: A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation.
`provisioningState` string	ProvisioningState: The disk encryption set provisioning state.
`rotationToLatestKeyVersionEnabled` bool	RotationToLatestKeyVersionEnabled: Set this flag to true to enable auto-updating of this disk encryption set to the latest key version.
`tags` map[string]string	Tags: Resource tags
`type` string	Type: Resource type

DiskEncryptionSet_STATUS_ARM

disk encryption set resource.

Field	Description
`id` string	Id: Resource Id
`identity` EncryptionSetIdentity_STATUS_ARM	Identity: The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks.
`location` string	Location: Resource location
`name` string	Name: Resource name
`properties` EncryptionSetProperties_STATUS_ARM
`tags` map[string]string	Tags: Resource tags
`type` string	Type: Resource type

DiskEncryptionSet_Spec

(Appears on:DiskEncryptionSet)

Field	Description
`activeKey` KeyForDiskEncryptionSet	ActiveKey: The key vault key which is currently used by this disk encryption set.
`azureName` string	AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.
`encryptionType` DiskEncryptionSetType	EncryptionType: The type of key used to encrypt the data of the disk.
`federatedClientId` string	FederatedClientId: Multi-tenant application client id to access key vault in a different tenant. Setting the value to ‘None’ will clear the property.
`federatedClientIdFromConfig` genruntime.ConfigMapReference	FederatedClientIdFromConfig: Multi-tenant application client id to access key vault in a different tenant. Setting the value to ‘None’ will clear the property.
`identity` EncryptionSetIdentity	Identity: The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks.
`location` string	Location: Resource location
`owner` genruntime.KnownResourceReference	Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource
`rotationToLatestKeyVersionEnabled` bool	RotationToLatestKeyVersionEnabled: Set this flag to true to enable auto-updating of this disk encryption set to the latest key version.
`tags` map[string]string	Tags: Resource tags

DiskEncryptionSet_Spec_ARM

Field	Description
`identity` EncryptionSetIdentity_ARM	Identity: The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks.
`location` string	Location: Resource location
`name` string
`properties` EncryptionSetProperties_ARM
`tags` map[string]string	Tags: Resource tags

EncryptionSetIdentity

(Appears on:DiskEncryptionSet_Spec)

The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks.

Field	Description
`type` EncryptionSetIdentity_Type	Type: The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys.
`userAssignedIdentities` []UserAssignedIdentityDetails	UserAssignedIdentities: The list of user identities associated with the disk encryption set. The user identity dictionary key references will be ARM resource ids in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’.

EncryptionSetIdentity_ARM

(Appears on:DiskEncryptionSet_Spec_ARM)

The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks.

Field	Description
`type` EncryptionSetIdentity_Type	Type: The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys.
`userAssignedIdentities` map[string]./api/compute/v1api20220702.UserAssignedIdentityDetails_ARM

EncryptionSetIdentity_STATUS

(Appears on:DiskEncryptionSet_STATUS)

The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks.

Field	Description
`principalId` string	PrincipalId: The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity
`tenantId` string	TenantId: The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity
`type` EncryptionSetIdentity_Type_STATUS	Type: The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys.
`userAssignedIdentities` map[string]./api/compute/v1api20220702.EncryptionSetIdentity_UserAssignedIdentities_STATUS	UserAssignedIdentities: The list of user identities associated with the disk encryption set. The user identity dictionary key references will be ARM resource ids in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’.

EncryptionSetIdentity_STATUS_ARM

(Appears on:DiskEncryptionSet_STATUS_ARM)

The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks.

Field	Description
`principalId` string	PrincipalId: The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity
`tenantId` string	TenantId: The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity
`type` EncryptionSetIdentity_Type_STATUS	Type: The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys.
`userAssignedIdentities` map[string]./api/compute/v1api20220702.EncryptionSetIdentity_UserAssignedIdentities_STATUS_ARM	UserAssignedIdentities: The list of user identities associated with the disk encryption set. The user identity dictionary key references will be ARM resource ids in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’.

EncryptionSetIdentity_Type (`string` alias)

(Appears on:EncryptionSetIdentity, EncryptionSetIdentity_ARM)

Value	Description
"None"
"SystemAssigned"
"SystemAssigned, UserAssigned"
"UserAssigned"

EncryptionSetIdentity_Type_STATUS (`string` alias)

(Appears on:EncryptionSetIdentity_STATUS, EncryptionSetIdentity_STATUS_ARM)

Value	Description
"None"
"SystemAssigned"
"SystemAssigned, UserAssigned"
"UserAssigned"

EncryptionSetIdentity_UserAssignedIdentities_STATUS

(Appears on:EncryptionSetIdentity_STATUS)

Field	Description
`clientId` string	ClientId: The client id of user assigned identity.
`principalId` string	PrincipalId: The principal id of user assigned identity.

EncryptionSetIdentity_UserAssignedIdentities_STATUS_ARM

(Appears on:EncryptionSetIdentity_STATUS_ARM)

Field	Description
`clientId` string	ClientId: The client id of user assigned identity.
`principalId` string	PrincipalId: The principal id of user assigned identity.

EncryptionSetProperties_ARM

(Appears on:DiskEncryptionSet_Spec_ARM)

Field	Description
`activeKey` KeyForDiskEncryptionSet_ARM	ActiveKey: The key vault key which is currently used by this disk encryption set.
`encryptionType` DiskEncryptionSetType	EncryptionType: The type of key used to encrypt the data of the disk.
`federatedClientId` string	FederatedClientId: Multi-tenant application client id to access key vault in a different tenant. Setting the value to ‘None’ will clear the property.
`rotationToLatestKeyVersionEnabled` bool	RotationToLatestKeyVersionEnabled: Set this flag to true to enable auto-updating of this disk encryption set to the latest key version.

EncryptionSetProperties_STATUS_ARM

(Appears on:DiskEncryptionSet_STATUS_ARM)

Field	Description
`activeKey` KeyForDiskEncryptionSet_STATUS_ARM	ActiveKey: The key vault key which is currently used by this disk encryption set.
`autoKeyRotationError` ApiError_STATUS_ARM	AutoKeyRotationError: The error that was encountered during auto-key rotation. If an error is present, then auto-key rotation will not be attempted until the error on this disk encryption set is fixed.
`encryptionType` DiskEncryptionSetType_STATUS	EncryptionType: The type of key used to encrypt the data of the disk.
`federatedClientId` string	FederatedClientId: Multi-tenant application client id to access key vault in a different tenant. Setting the value to ‘None’ will clear the property.
`lastKeyRotationTimestamp` string	LastKeyRotationTimestamp: The time when the active key of this disk encryption set was updated.
`previousKeys` []KeyForDiskEncryptionSet_STATUS_ARM	PreviousKeys: A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation.
`provisioningState` string	ProvisioningState: The disk encryption set provisioning state.
`rotationToLatestKeyVersionEnabled` bool	RotationToLatestKeyVersionEnabled: Set this flag to true to enable auto-updating of this disk encryption set to the latest key version.

InnerError_STATUS

(Appears on:ApiError_STATUS)

Inner error details.

Field	Description
`errordetail` string	Errordetail: The internal error message or exception dump.
`exceptiontype` string	Exceptiontype: The exception type.

InnerError_STATUS_ARM

(Appears on:ApiError_STATUS_ARM)

Inner error details.

Field	Description
`errordetail` string	Errordetail: The internal error message or exception dump.
`exceptiontype` string	Exceptiontype: The exception type.

KeyForDiskEncryptionSet

(Appears on:DiskEncryptionSet_Spec)

Key Vault Key Url to be used for server side encryption of Managed Disks and Snapshots

Field	Description
`keyUrl` string	KeyUrl: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value.
`keyUrlFromConfig` genruntime.ConfigMapReference	KeyUrlFromConfig: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value.
`sourceVault` SourceVault	SourceVault: Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription.

KeyForDiskEncryptionSet_ARM

(Appears on:EncryptionSetProperties_ARM)

Key Vault Key Url to be used for server side encryption of Managed Disks and Snapshots

Field	Description
`keyUrl` string	KeyUrl: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value.
`sourceVault` SourceVault_ARM	SourceVault: Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription.

KeyForDiskEncryptionSet_STATUS

(Appears on:DiskEncryptionSet_STATUS)

Key Vault Key Url to be used for server side encryption of Managed Disks and Snapshots

Field	Description
`keyUrl` string	KeyUrl: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value.
`sourceVault` SourceVault_STATUS	SourceVault: Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription.

KeyForDiskEncryptionSet_STATUS_ARM

(Appears on:EncryptionSetProperties_STATUS_ARM)

Key Vault Key Url to be used for server side encryption of Managed Disks and Snapshots

Field	Description
`keyUrl` string	KeyUrl: Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value.
`sourceVault` SourceVault_STATUS_ARM	SourceVault: Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription.

SourceVault

(Appears on:KeyForDiskEncryptionSet)

The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}

Field	Description
`reference` genruntime.ResourceReference	Reference: Resource Id

SourceVault_ARM

(Appears on:KeyForDiskEncryptionSet_ARM)

The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}

Field	Description
`id` string

SourceVault_STATUS

(Appears on:KeyForDiskEncryptionSet_STATUS)

The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}

Field	Description
`id` string	Id: Resource Id

SourceVault_STATUS_ARM

(Appears on:KeyForDiskEncryptionSet_STATUS_ARM)

The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}

Field	Description
`id` string	Id: Resource Id

UserAssignedIdentityDetails

(Appears on:EncryptionSetIdentity)

Information about the user assigned identity for the resource

Field	Description
`reference` genruntime.ResourceReference

UserAssignedIdentityDetails_ARM

(Appears on:EncryptionSetIdentity_ARM)

Information about the user assigned identity for the resource

compute.azure.com/v1api20220702