Microsoft.HybridContainerService storageSpaces

• Latest
• 2022-09-01-preview
• 2022-05-01-preview

Bicep resource definition

The storageSpaces 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.HybridContainerService/storageSpaces resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.HybridContainerService/storageSpaces@2022-09-01-preview' = {
  extendedLocation: {
    name: 'string'
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    hciStorageProfile: {
      mocGroup: 'string'
      mocLocation: 'string'
      mocStorageContainer: 'string'
    }
    status: {
      provisioningStatus: {
        error: {
          code: 'string'
          message: 'string'
        }
        operationId: 'string'
        phase: 'string'
        status: 'string'
      }
    }
    vmwareStorageProfile: {
      datacenter: 'string'
      datastore: 'string'
      folder: 'string'
      resourcePool: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.HybridContainerService/storageSpaces

Name	Description	Value
extendedLocation		StorageSpacesExtendedLocation
location	The geo-location where the resource lives	string (required)
name	The resource name	string Constraints: Min length = 3 Max length = 64 (required)
properties	HybridAKSStorageSpec defines the desired state of HybridAKSStorage	StorageSpacesProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

StorageSpacesExtendedLocation

Name	Description	Value
name	The extended location name.	string
type	The extended location type.	string

StorageSpacesProperties

Name	Description	Value
hciStorageProfile		StorageSpacesPropertiesHciStorageProfile
status	HybridAKSStorageStatus defines the observed state of HybridAKSStorage	StorageSpacesPropertiesStatus
vmwareStorageProfile		StorageSpacesPropertiesVmwareStorageProfile

StorageSpacesPropertiesHciStorageProfile

Name	Description	Value
mocGroup	Resource group in MOC(Microsoft On-premises Cloud)	string
mocLocation	Location in MOC(Microsoft On-premises Cloud)	string
mocStorageContainer	Name of the storage container in MOC(Microsoft On-premises Cloud)	string

StorageSpacesPropertiesStatus

Name	Description	Value
provisioningStatus	Contains Provisioning errors	StorageSpacesPropertiesStatusProvisioningStatus

StorageSpacesPropertiesStatusProvisioningStatus

Name	Description	Value
error		StorageSpacesPropertiesStatusProvisioningStatusError
operationId		string
phase	Phase represents the current phase of cluster actuation. E.g. Pending, Running, Terminating, Failed etc.	string
status		string

StorageSpacesPropertiesStatusProvisioningStatusError

Name	Description	Value
code		string
message		string

StorageSpacesPropertiesVmwareStorageProfile

Name	Description	Value
datacenter	Name of the datacenter in VSphere	string
datastore	Name of the datastore in VSphere	string
folder	Name of the folder in VSphere	string
resourcePool	Name of the resource pool in VSphere	string

TrackedResourceTags

Name	Description	Value

ARM template resource definition

The storageSpaces 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.HybridContainerService/storageSpaces resource, add the following JSON to your template.

{
  "type": "Microsoft.HybridContainerService/storageSpaces",
  "apiVersion": "2022-09-01-preview",
  "name": "string",
  "extendedLocation": {
    "name": "string",
    "type": "string"
  },
  "location": "string",
  "properties": {
    "hciStorageProfile": {
      "mocGroup": "string",
      "mocLocation": "string",
      "mocStorageContainer": "string"
    },
    "status": {
      "provisioningStatus": {
        "error": {
          "code": "string",
          "message": "string"
        },
        "operationId": "string",
        "phase": "string",
        "status": "string"
      }
    },
    "vmwareStorageProfile": {
      "datacenter": "string",
      "datastore": "string",
      "folder": "string",
      "resourcePool": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.HybridContainerService/storageSpaces

Name	Description	Value
apiVersion	The api version	'2022-09-01-preview'
extendedLocation		StorageSpacesExtendedLocation
location	The geo-location where the resource lives	string (required)
name	The resource name	string Constraints: Min length = 3 Max length = 64 (required)
properties	HybridAKSStorageSpec defines the desired state of HybridAKSStorage	StorageSpacesProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.HybridContainerService/storageSpaces'

StorageSpacesExtendedLocation

Name	Description	Value
name	The extended location name.	string
type	The extended location type.	string

StorageSpacesProperties

Name	Description	Value
hciStorageProfile		StorageSpacesPropertiesHciStorageProfile
status	HybridAKSStorageStatus defines the observed state of HybridAKSStorage	StorageSpacesPropertiesStatus
vmwareStorageProfile		StorageSpacesPropertiesVmwareStorageProfile

StorageSpacesPropertiesHciStorageProfile

Name	Description	Value
mocGroup	Resource group in MOC(Microsoft On-premises Cloud)	string
mocLocation	Location in MOC(Microsoft On-premises Cloud)	string
mocStorageContainer	Name of the storage container in MOC(Microsoft On-premises Cloud)	string

StorageSpacesPropertiesStatus

Name	Description	Value
provisioningStatus	Contains Provisioning errors	StorageSpacesPropertiesStatusProvisioningStatus

StorageSpacesPropertiesStatusProvisioningStatus

Name	Description	Value
error		StorageSpacesPropertiesStatusProvisioningStatusError
operationId		string
phase	Phase represents the current phase of cluster actuation. E.g. Pending, Running, Terminating, Failed etc.	string
status		string

StorageSpacesPropertiesStatusProvisioningStatusError

Name	Description	Value
code		string
message		string

StorageSpacesPropertiesVmwareStorageProfile

Name	Description	Value
datacenter	Name of the datacenter in VSphere	string
datastore	Name of the datastore in VSphere	string
folder	Name of the folder in VSphere	string
resourcePool	Name of the resource pool in VSphere	string

TrackedResourceTags

Name	Description	Value

Usage Examples

Terraform (AzAPI provider) resource definition

The storageSpaces 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.HybridContainerService/storageSpaces resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.HybridContainerService/storageSpaces@2022-09-01-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    extendedLocation = {
      name = "string"
      type = "string"
    }
    properties = {
      hciStorageProfile = {
        mocGroup = "string"
        mocLocation = "string"
        mocStorageContainer = "string"
      }
      status = {
        provisioningStatus = {
          error = {
            code = "string"
            message = "string"
          }
          operationId = "string"
          phase = "string"
          status = "string"
        }
      }
      vmwareStorageProfile = {
        datacenter = "string"
        datastore = "string"
        folder = "string"
        resourcePool = "string"
      }
    }
  }
}

Property Values

Microsoft.HybridContainerService/storageSpaces

Name	Description	Value
extendedLocation		StorageSpacesExtendedLocation
location	The geo-location where the resource lives	string (required)
name	The resource name	string Constraints: Min length = 3 Max length = 64 (required)
properties	HybridAKSStorageSpec defines the desired state of HybridAKSStorage	StorageSpacesProperties
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.HybridContainerService/storageSpaces@2022-09-01-preview"

StorageSpacesExtendedLocation

Name	Description	Value
name	The extended location name.	string
type	The extended location type.	string

StorageSpacesProperties

Name	Description	Value
hciStorageProfile		StorageSpacesPropertiesHciStorageProfile
status	HybridAKSStorageStatus defines the observed state of HybridAKSStorage	StorageSpacesPropertiesStatus
vmwareStorageProfile		StorageSpacesPropertiesVmwareStorageProfile

StorageSpacesPropertiesHciStorageProfile

Name	Description	Value
mocGroup	Resource group in MOC(Microsoft On-premises Cloud)	string
mocLocation	Location in MOC(Microsoft On-premises Cloud)	string
mocStorageContainer	Name of the storage container in MOC(Microsoft On-premises Cloud)	string

StorageSpacesPropertiesStatus

Name	Description	Value
provisioningStatus	Contains Provisioning errors	StorageSpacesPropertiesStatusProvisioningStatus

StorageSpacesPropertiesStatusProvisioningStatus

Name	Description	Value
error		StorageSpacesPropertiesStatusProvisioningStatusError
operationId		string
phase	Phase represents the current phase of cluster actuation. E.g. Pending, Running, Terminating, Failed etc.	string
status		string

StorageSpacesPropertiesStatusProvisioningStatusError

Name	Description	Value
code		string
message		string

StorageSpacesPropertiesVmwareStorageProfile

Name	Description	Value
datacenter	Name of the datacenter in VSphere	string
datastore	Name of the datastore in VSphere	string
folder	Name of the folder in VSphere	string
resourcePool	Name of the resource pool in VSphere	string

TrackedResourceTags

Name	Description	Value