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 storageAppliances 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.NetworkCloud/storageAppliances resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.NetworkCloud/storageAppliances@2023-07-01' = {
extendedLocation: {
name: 'string'
type: 'string'
}
location: 'string'
name: 'string'
properties: {
administratorCredentials: {
password: 'string'
username: 'string'
}
rackId: 'string'
rackSlot: int
serialNumber: 'string'
storageApplianceSkuId: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.NetworkCloud/storageAppliances
| Name | Description | Value |
|---|---|---|
| extendedLocation | The extended location of the cluster associated with the resource. | ExtendedLocation (required) |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$ (required) |
| properties | The list of the resource properties. | StorageApplianceProperties (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
AdministrativeCredentials
| Name | Description | Value |
|---|---|---|
| password | The password of the administrator of the device used during initialization. | string Constraints: Min length = 1 Sensitive value. Pass in as a secure parameter. (required) |
| username | The username of the administrator of the device used during initialization. | string Constraints: Min length = 1 (required) |
ExtendedLocation
| Name | Description | Value |
|---|---|---|
| name | The resource ID of the extended location on which the resource will be created. | string (required) |
| type | The extended location type, for example, CustomLocation. | string (required) |
StorageApplianceProperties
| Name | Description | Value |
|---|---|---|
| administratorCredentials | The credentials of the administrative interface on this storage appliance. | AdministrativeCredentials (required) |
| rackId | The resource ID of the rack where this storage appliance resides. | string (required) |
| rackSlot | The slot the storage appliance is in the rack based on the BOM configuration. | int Constraints: Min value = 1 Max value = 256 (required) |
| serialNumber | The serial number for the storage appliance. | string (required) |
| storageApplianceSkuId | The SKU for the storage appliance. | string (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
ARM template resource definition
The storageAppliances 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.NetworkCloud/storageAppliances resource, add the following JSON to your template.
{
"type": "Microsoft.NetworkCloud/storageAppliances",
"apiVersion": "2023-07-01",
"name": "string",
"extendedLocation": {
"name": "string",
"type": "string"
},
"location": "string",
"properties": {
"administratorCredentials": {
"password": "string",
"username": "string"
},
"rackId": "string",
"rackSlot": "int",
"serialNumber": "string",
"storageApplianceSkuId": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.NetworkCloud/storageAppliances
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2023-07-01' |
| extendedLocation | The extended location of the cluster associated with the resource. | ExtendedLocation (required) |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$ (required) |
| properties | The list of the resource properties. | StorageApplianceProperties (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.NetworkCloud/storageAppliances' |
AdministrativeCredentials
| Name | Description | Value |
|---|---|---|
| password | The password of the administrator of the device used during initialization. | string Constraints: Min length = 1 Sensitive value. Pass in as a secure parameter. (required) |
| username | The username of the administrator of the device used during initialization. | string Constraints: Min length = 1 (required) |
ExtendedLocation
| Name | Description | Value |
|---|---|---|
| name | The resource ID of the extended location on which the resource will be created. | string (required) |
| type | The extended location type, for example, CustomLocation. | string (required) |
StorageApplianceProperties
| Name | Description | Value |
|---|---|---|
| administratorCredentials | The credentials of the administrative interface on this storage appliance. | AdministrativeCredentials (required) |
| rackId | The resource ID of the rack where this storage appliance resides. | string (required) |
| rackSlot | The slot the storage appliance is in the rack based on the BOM configuration. | int Constraints: Min value = 1 Max value = 256 (required) |
| serialNumber | The serial number for the storage appliance. | string (required) |
| storageApplianceSkuId | The SKU for the storage appliance. | string (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Terraform (AzAPI provider) resource definition
The storageAppliances 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.NetworkCloud/storageAppliances resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.NetworkCloud/storageAppliances@2023-07-01"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
extendedLocation = {
name = "string"
type = "string"
}
properties = {
administratorCredentials = {
password = "string"
username = "string"
}
rackId = "string"
rackSlot = int
serialNumber = "string"
storageApplianceSkuId = "string"
}
}
}
Property Values
Microsoft.NetworkCloud/storageAppliances
| Name | Description | Value |
|---|---|---|
| extendedLocation | The extended location of the cluster associated with the resource. | ExtendedLocation (required) |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$ (required) |
| properties | The list of the resource properties. | StorageApplianceProperties (required) |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.NetworkCloud/storageAppliances@2023-07-01" |
AdministrativeCredentials
| Name | Description | Value |
|---|---|---|
| password | The password of the administrator of the device used during initialization. | string Constraints: Min length = 1 Sensitive value. Pass in as a secure parameter. (required) |
| username | The username of the administrator of the device used during initialization. | string Constraints: Min length = 1 (required) |
ExtendedLocation
| Name | Description | Value |
|---|---|---|
| name | The resource ID of the extended location on which the resource will be created. | string (required) |
| type | The extended location type, for example, CustomLocation. | string (required) |
StorageApplianceProperties
| Name | Description | Value |
|---|---|---|
| administratorCredentials | The credentials of the administrative interface on this storage appliance. | AdministrativeCredentials (required) |
| rackId | The resource ID of the rack where this storage appliance resides. | string (required) |
| rackSlot | The slot the storage appliance is in the rack based on the BOM configuration. | int Constraints: Min value = 1 Max value = 256 (required) |
| serialNumber | The serial number for the storage appliance. | string (required) |
| storageApplianceSkuId | The SKU for the storage appliance. | string (required) |
TrackedResourceTags
| Name | Description | Value |
|---|