Share via


Microsoft.StorSimple managers/devices/fileservers/shares

Bicep resource definition

The managers/devices/fileservers/shares resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.StorSimple/managers/devices/fileservers/shares resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.StorSimple/managers/devices/fileservers/shares@2016-10-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    adminUser: 'string'
    dataPolicy: 'string'
    description: 'string'
    monitoringStatus: 'string'
    provisionedCapacityInBytes: int
    shareStatus: 'string'
  }
}

Property Values

Microsoft.StorSimple/managers/devices/fileservers/shares

Name Description Value
name The resource name string (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: managers/devices/fileservers
properties The properties. FileShareProperties (required)

FileShareProperties

Name Description Value
adminUser The user/group who will have full permission in this share. Active directory email address. Example: xyz@contoso.com or Contoso\xyz. string (required)
dataPolicy The data policy 'Cloud'
'Invalid'
'Local'
'Tiered' (required)
description Description for file share string
monitoringStatus The monitoring status 'Disabled'
'Enabled' (required)
provisionedCapacityInBytes The total provisioned capacity in Bytes int (required)
shareStatus The Share Status 'Offline'
'Online' (required)

ARM template resource definition

The managers/devices/fileservers/shares resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.StorSimple/managers/devices/fileservers/shares resource, add the following JSON to your template.

{
  "type": "Microsoft.StorSimple/managers/devices/fileservers/shares",
  "apiVersion": "2016-10-01",
  "name": "string",
  "properties": {
    "adminUser": "string",
    "dataPolicy": "string",
    "description": "string",
    "monitoringStatus": "string",
    "provisionedCapacityInBytes": "int",
    "shareStatus": "string"
  }
}

Property Values

Microsoft.StorSimple/managers/devices/fileservers/shares

Name Description Value
apiVersion The api version '2016-10-01'
name The resource name string (required)
properties The properties. FileShareProperties (required)
type The resource type 'Microsoft.StorSimple/managers/devices/fileservers/shares'

FileShareProperties

Name Description Value
adminUser The user/group who will have full permission in this share. Active directory email address. Example: xyz@contoso.com or Contoso\xyz. string (required)
dataPolicy The data policy 'Cloud'
'Invalid'
'Local'
'Tiered' (required)
description Description for file share string
monitoringStatus The monitoring status 'Disabled'
'Enabled' (required)
provisionedCapacityInBytes The total provisioned capacity in Bytes int (required)
shareStatus The Share Status 'Offline'
'Online' (required)

Usage Examples

Terraform (AzAPI provider) resource definition

The managers/devices/fileservers/shares 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.StorSimple/managers/devices/fileservers/shares resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.StorSimple/managers/devices/fileservers/shares@2016-10-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      adminUser = "string"
      dataPolicy = "string"
      description = "string"
      monitoringStatus = "string"
      provisionedCapacityInBytes = int
      shareStatus = "string"
    }
  }
}

Property Values

Microsoft.StorSimple/managers/devices/fileservers/shares

Name Description Value
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: managers/devices/fileservers
properties The properties. FileShareProperties (required)
type The resource type "Microsoft.StorSimple/managers/devices/fileservers/shares@2016-10-01"

FileShareProperties

Name Description Value
adminUser The user/group who will have full permission in this share. Active directory email address. Example: xyz@contoso.com or Contoso\xyz. string (required)
dataPolicy The data policy 'Cloud'
'Invalid'
'Local'
'Tiered' (required)
description Description for file share string
monitoringStatus The monitoring status 'Disabled'
'Enabled' (required)
provisionedCapacityInBytes The total provisioned capacity in Bytes int (required)
shareStatus The Share Status 'Offline'
'Online' (required)