Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The elasticSans/volumegroups resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ElasticSan/elasticSans/volumegroups resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.ElasticSan/elasticSans/volumegroups@2024-07-01-preview' = {
parent: resourceSymbolicName
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
name: 'string'
properties: {
deleteRetentionPolicy: {
policyState: 'string'
retentionPeriodDays: int
}
encryption: 'string'
encryptionProperties: {
identity: {
userAssignedIdentity: 'string'
}
keyVaultProperties: {
keyName: 'string'
keyVaultUri: 'string'
keyVersion: 'string'
}
}
enforceDataIntegrityCheckForIscsi: bool
networkAcls: {
virtualNetworkRules: [
{
action: 'string'
id: 'string'
}
]
}
protocolType: 'string'
}
}
Property Values
Microsoft.ElasticSan/elasticSans/volumegroups
| Name | Description | Value |
|---|---|---|
| identity | The identity of the resource. | Identity |
| name | The resource name | string Constraints: Min length = 3 Max length = 63 Pattern = ^[A-Za-z0-9]+((-|_)[a-z0-9A-Z]+)*$ (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: elasticSans |
| properties | Properties of VolumeGroup. | VolumeGroupProperties |
DeleteRetentionPolicy
| Name | Description | Value |
|---|---|---|
| policyState | 'Disabled' 'Enabled' |
|
| retentionPeriodDays | The number of days to retain the resources after deletion. | int Constraints: Min value = 0 |
EncryptionIdentity
| Name | Description | Value |
|---|---|---|
| userAssignedIdentity | Resource identifier of the UserAssigned identity to be associated with server-side encryption on the volume group. | string |
EncryptionProperties
| Name | Description | Value |
|---|---|---|
| identity | The identity to be used with service-side encryption at rest. | EncryptionIdentity |
| keyVaultProperties | Properties provided by key vault. | KeyVaultProperties |
Identity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'None' 'SystemAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | Gets or sets a list of key value pairs that describe the set of User Assigned identities that will be used with this volume group. The key is the ARM resource identifier of the identity. | IdentityUserAssignedIdentities |
IdentityUserAssignedIdentities
| Name | Description | Value |
|---|
KeyVaultProperties
| Name | Description | Value |
|---|---|---|
| keyName | The name of KeyVault key. | string |
| keyVaultUri | The Uri of KeyVault. | string |
| keyVersion | The version of KeyVault key. | string |
NetworkRuleSet
| Name | Description | Value |
|---|---|---|
| virtualNetworkRules | The list of virtual network rules. | VirtualNetworkRule[] |
UserAssignedIdentity
| Name | Description | Value |
|---|
VirtualNetworkRule
| Name | Description | Value |
|---|---|---|
| action | The action of virtual network rule. | 'Allow' |
| id | Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. | string (required) |
VolumeGroupProperties
| Name | Description | Value |
|---|---|---|
| deleteRetentionPolicy | The retention policy for the soft deleted volume group and its associated resources. | DeleteRetentionPolicy |
| encryption | Type of encryption | 'EncryptionAtRestWithCustomerManagedKey' 'EncryptionAtRestWithPlatformKey' |
| encryptionProperties | Encryption Properties describing Key Vault and Identity information | EncryptionProperties |
| enforceDataIntegrityCheckForIscsi | A boolean indicating whether or not Data Integrity Check is enabled | bool |
| networkAcls | A collection of rules governing the accessibility from specific network locations. | NetworkRuleSet |
| protocolType | Type of storage target | 'Iscsi' 'None' |
ARM template resource definition
The elasticSans/volumegroups resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ElasticSan/elasticSans/volumegroups resource, add the following JSON to your template.
{
"type": "Microsoft.ElasticSan/elasticSans/volumegroups",
"apiVersion": "2024-07-01-preview",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"properties": {
"deleteRetentionPolicy": {
"policyState": "string",
"retentionPeriodDays": "int"
},
"encryption": "string",
"encryptionProperties": {
"identity": {
"userAssignedIdentity": "string"
},
"keyVaultProperties": {
"keyName": "string",
"keyVaultUri": "string",
"keyVersion": "string"
}
},
"enforceDataIntegrityCheckForIscsi": "bool",
"networkAcls": {
"virtualNetworkRules": [
{
"action": "string",
"id": "string"
}
]
},
"protocolType": "string"
}
}
Property Values
Microsoft.ElasticSan/elasticSans/volumegroups
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-07-01-preview' |
| identity | The identity of the resource. | Identity |
| name | The resource name | string Constraints: Min length = 3 Max length = 63 Pattern = ^[A-Za-z0-9]+((-|_)[a-z0-9A-Z]+)*$ (required) |
| properties | Properties of VolumeGroup. | VolumeGroupProperties |
| type | The resource type | 'Microsoft.ElasticSan/elasticSans/volumegroups' |
DeleteRetentionPolicy
| Name | Description | Value |
|---|---|---|
| policyState | 'Disabled' 'Enabled' |
|
| retentionPeriodDays | The number of days to retain the resources after deletion. | int Constraints: Min value = 0 |
EncryptionIdentity
| Name | Description | Value |
|---|---|---|
| userAssignedIdentity | Resource identifier of the UserAssigned identity to be associated with server-side encryption on the volume group. | string |
EncryptionProperties
| Name | Description | Value |
|---|---|---|
| identity | The identity to be used with service-side encryption at rest. | EncryptionIdentity |
| keyVaultProperties | Properties provided by key vault. | KeyVaultProperties |
Identity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'None' 'SystemAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | Gets or sets a list of key value pairs that describe the set of User Assigned identities that will be used with this volume group. The key is the ARM resource identifier of the identity. | IdentityUserAssignedIdentities |
IdentityUserAssignedIdentities
| Name | Description | Value |
|---|
KeyVaultProperties
| Name | Description | Value |
|---|---|---|
| keyName | The name of KeyVault key. | string |
| keyVaultUri | The Uri of KeyVault. | string |
| keyVersion | The version of KeyVault key. | string |
NetworkRuleSet
| Name | Description | Value |
|---|---|---|
| virtualNetworkRules | The list of virtual network rules. | VirtualNetworkRule[] |
UserAssignedIdentity
| Name | Description | Value |
|---|
VirtualNetworkRule
| Name | Description | Value |
|---|---|---|
| action | The action of virtual network rule. | 'Allow' |
| id | Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. | string (required) |
VolumeGroupProperties
| Name | Description | Value |
|---|---|---|
| deleteRetentionPolicy | The retention policy for the soft deleted volume group and its associated resources. | DeleteRetentionPolicy |
| encryption | Type of encryption | 'EncryptionAtRestWithCustomerManagedKey' 'EncryptionAtRestWithPlatformKey' |
| encryptionProperties | Encryption Properties describing Key Vault and Identity information | EncryptionProperties |
| enforceDataIntegrityCheckForIscsi | A boolean indicating whether or not Data Integrity Check is enabled | bool |
| networkAcls | A collection of rules governing the accessibility from specific network locations. | NetworkRuleSet |
| protocolType | Type of storage target | 'Iscsi' 'None' |
Usage Examples
Terraform (AzAPI provider) resource definition
The elasticSans/volumegroups resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ElasticSan/elasticSans/volumegroups resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ElasticSan/elasticSans/volumegroups@2024-07-01-preview"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
body = {
properties = {
deleteRetentionPolicy = {
policyState = "string"
retentionPeriodDays = int
}
encryption = "string"
encryptionProperties = {
identity = {
userAssignedIdentity = "string"
}
keyVaultProperties = {
keyName = "string"
keyVaultUri = "string"
keyVersion = "string"
}
}
enforceDataIntegrityCheckForIscsi = bool
networkAcls = {
virtualNetworkRules = [
{
action = "string"
id = "string"
}
]
}
protocolType = "string"
}
}
}
Property Values
Microsoft.ElasticSan/elasticSans/volumegroups
| Name | Description | Value |
|---|---|---|
| identity | The identity of the resource. | Identity |
| name | The resource name | string Constraints: Min length = 3 Max length = 63 Pattern = ^[A-Za-z0-9]+((-|_)[a-z0-9A-Z]+)*$ (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: elasticSans |
| properties | Properties of VolumeGroup. | VolumeGroupProperties |
| type | The resource type | "Microsoft.ElasticSan/elasticSans/volumegroups@2024-07-01-preview" |
DeleteRetentionPolicy
| Name | Description | Value |
|---|---|---|
| policyState | 'Disabled' 'Enabled' |
|
| retentionPeriodDays | The number of days to retain the resources after deletion. | int Constraints: Min value = 0 |
EncryptionIdentity
| Name | Description | Value |
|---|---|---|
| userAssignedIdentity | Resource identifier of the UserAssigned identity to be associated with server-side encryption on the volume group. | string |
EncryptionProperties
| Name | Description | Value |
|---|---|---|
| identity | The identity to be used with service-side encryption at rest. | EncryptionIdentity |
| keyVaultProperties | Properties provided by key vault. | KeyVaultProperties |
Identity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'None' 'SystemAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | Gets or sets a list of key value pairs that describe the set of User Assigned identities that will be used with this volume group. The key is the ARM resource identifier of the identity. | IdentityUserAssignedIdentities |
IdentityUserAssignedIdentities
| Name | Description | Value |
|---|
KeyVaultProperties
| Name | Description | Value |
|---|---|---|
| keyName | The name of KeyVault key. | string |
| keyVaultUri | The Uri of KeyVault. | string |
| keyVersion | The version of KeyVault key. | string |
NetworkRuleSet
| Name | Description | Value |
|---|---|---|
| virtualNetworkRules | The list of virtual network rules. | VirtualNetworkRule[] |
UserAssignedIdentity
| Name | Description | Value |
|---|
VirtualNetworkRule
| Name | Description | Value |
|---|---|---|
| action | The action of virtual network rule. | 'Allow' |
| id | Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. | string (required) |
VolumeGroupProperties
| Name | Description | Value |
|---|---|---|
| deleteRetentionPolicy | The retention policy for the soft deleted volume group and its associated resources. | DeleteRetentionPolicy |
| encryption | Type of encryption | 'EncryptionAtRestWithCustomerManagedKey' 'EncryptionAtRestWithPlatformKey' |
| encryptionProperties | Encryption Properties describing Key Vault and Identity information | EncryptionProperties |
| enforceDataIntegrityCheckForIscsi | A boolean indicating whether or not Data Integrity Check is enabled | bool |
| networkAcls | A collection of rules governing the accessibility from specific network locations. | NetworkRuleSet |
| protocolType | Type of storage target | 'Iscsi' 'None' |