Microsoft.MachineLearningServices capacityReserverationGroups 2023-08-01-preview

  • Article

Bicep resource definition

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

resource symbolicname 'Microsoft.MachineLearningServices/capacityReserverationGroups@2023-08-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  kind: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    offer: {
      offerName: 'string'
      publisher: 'string'
    }
    reservedCapacity: int
  }
}

Property values

capacityReserverationGroups

Name Description Value
name The resource name string (required)
location The geo-location where the resource lives string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
sku Sku details required for ARM contract for Autoscaling. Sku
kind Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. string
identity Managed service identity (system assigned and/or user assigned identities) ManagedServiceIdentity
properties [Required] Additional attributes of the entity. CapacityReservationGroupProperties (required)

ManagedServiceIdentity

Name Description Value
type Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned' (required)
userAssignedIdentities The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. UserAssignedIdentities

UserAssignedIdentities

Name Description Value
{customized property} UserAssignedIdentity

UserAssignedIdentity

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

CapacityReservationGroupProperties

Name Description Value
offer Offer used by this capacity reservation group. ServerlessOffer
reservedCapacity [Required] Specifies the amount of capacity to reserve. int (required)

ServerlessOffer

Name Description Value
offerName [Required] The name of the Serverless Offer string (required)

Constraints:
Min length = 1
Pattern = [a-zA-Z0-9_]
publisher [Required] Publisher name of the Serverless Offer string (required)

Constraints:
Min length = 1
Pattern = [a-zA-Z0-9_]

Sku

Name Description Value
capacity If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. int
family If the service has different generations of hardware, for the same SKU, then that can be captured here. string
name The name of the SKU. Ex - P3. It is typically a letter+number code string (required)
size The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. string
tier This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. 'Basic'
'Free'
'Premium'
'Standard'

ARM template resource definition

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

{
  "type": "Microsoft.MachineLearningServices/capacityReserverationGroups",
  "apiVersion": "2023-08-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  },
  "kind": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "offer": {
      "offerName": "string",
      "publisher": "string"
    },
    "reservedCapacity": "int"
  }
}

Property values

capacityReserverationGroups

Name Description Value
type The resource type 'Microsoft.MachineLearningServices/capacityReserverationGroups'
apiVersion The resource api version '2023-08-01-preview'
name The resource name string (required)
location The geo-location where the resource lives string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
sku Sku details required for ARM contract for Autoscaling. Sku
kind Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. string
identity Managed service identity (system assigned and/or user assigned identities) ManagedServiceIdentity
properties [Required] Additional attributes of the entity. CapacityReservationGroupProperties (required)

ManagedServiceIdentity

Name Description Value
type Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned' (required)
userAssignedIdentities The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. UserAssignedIdentities

UserAssignedIdentities

Name Description Value
{customized property} UserAssignedIdentity

UserAssignedIdentity

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

CapacityReservationGroupProperties

Name Description Value
offer Offer used by this capacity reservation group. ServerlessOffer
reservedCapacity [Required] Specifies the amount of capacity to reserve. int (required)

ServerlessOffer

Name Description Value
offerName [Required] The name of the Serverless Offer string (required)

Constraints:
Min length = 1
Pattern = [a-zA-Z0-9_]
publisher [Required] Publisher name of the Serverless Offer string (required)

Constraints:
Min length = 1
Pattern = [a-zA-Z0-9_]

Sku

Name Description Value
capacity If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. int
family If the service has different generations of hardware, for the same SKU, then that can be captured here. string
name The name of the SKU. Ex - P3. It is typically a letter+number code string (required)
size The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. string
tier This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. 'Basic'
'Free'
'Premium'
'Standard'

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.MachineLearningServices/capacityReserverationGroups@2023-08-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      offer = {
        offerName = "string"
        publisher = "string"
      }
      reservedCapacity = int
    }
    sku = {
      capacity = int
      family = "string"
      name = "string"
      size = "string"
      tier = "string"
    }
    kind = "string"
  })
}

Property values

capacityReserverationGroups

Name Description Value
type The resource type "Microsoft.MachineLearningServices/capacityReserverationGroups@2023-08-01-preview"
name The resource name string (required)
location The geo-location where the resource lives string (required)
parent_id To deploy to a resource group, use the ID of that resource group. string (required)
tags Resource tags. Dictionary of tag names and values.
sku Sku details required for ARM contract for Autoscaling. Sku
kind Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. string
identity Managed service identity (system assigned and/or user assigned identities) ManagedServiceIdentity
properties [Required] Additional attributes of the entity. CapacityReservationGroupProperties (required)

ManagedServiceIdentity

Name Description Value
type Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). "SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned" (required)
identity_ids The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. Array of user identity IDs.

UserAssignedIdentities

Name Description Value
{customized property} UserAssignedIdentity

UserAssignedIdentity

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

CapacityReservationGroupProperties

Name Description Value
offer Offer used by this capacity reservation group. ServerlessOffer
reservedCapacity [Required] Specifies the amount of capacity to reserve. int (required)

ServerlessOffer

Name Description Value
offerName [Required] The name of the Serverless Offer string (required)

Constraints:
Min length = 1
Pattern = [a-zA-Z0-9_]
publisher [Required] Publisher name of the Serverless Offer string (required)

Constraints:
Min length = 1
Pattern = [a-zA-Z0-9_]

Sku

Name Description Value
capacity If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. int
family If the service has different generations of hardware, for the same SKU, then that can be captured here. string
name The name of the SKU. Ex - P3. It is typically a letter+number code string (required)
size The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. string
tier This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. "Basic"
"Free"
"Premium"
"Standard"