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 workspaces/serverlessEndpoints 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.MachineLearningServices/workspaces/serverlessEndpoints resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.MachineLearningServices/workspaces/serverlessEndpoints@2024-04-01-preview' = {
parent: resourceSymbolicName
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
kind: 'string'
location: 'string'
name: 'string'
properties: {
authMode: 'string'
capacityReservation: {
capacityReservationGroupId: 'string'
endpointReservedCapacity: int
}
modelSettings: {
modelId: 'string'
}
offer: {
offerName: 'string'
publisher: 'string'
}
}
sku: {
capacity: int
family: 'string'
name: 'string'
size: 'string'
tier: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
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 |
Microsoft.MachineLearningServices/workspaces/serverlessEndpoints
| Name | Description | Value |
|---|---|---|
| identity | Managed service identity (system assigned and/or user assigned identities) | ManagedServiceIdentity |
| kind | Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. | string |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z][a-zA-Z0-9-]{0,51}$ (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: workspaces |
| properties | [Required] Additional attributes of the entity. | ServerlessEndpointProperties (required) |
| sku | Sku details required for ARM contract for Autoscaling. | Sku |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
ModelSettings
| Name | Description | Value |
|---|---|---|
| modelId | [Required] | string Constraints: Min length = 1 Pattern = [a-zA-Z0-9_] (required) |
ServerlessEndpointCapacityReservation
| Name | Description | Value |
|---|---|---|
| capacityReservationGroupId | [Required] Specifies a capacity reservation group ID to allocate capacity from. | string Constraints: Min length = 1 Pattern = [a-zA-Z0-9_] (required) |
| endpointReservedCapacity | Specifies a capacity amount to reserve for this endpoint within the parent capacity reservation group. | int |
ServerlessEndpointProperties
| Name | Description | Value |
|---|---|---|
| authMode | Specifies the authentication mode for the Serverless endpoint. | 'AAD' 'Key' |
| capacityReservation | Optional capacity reservation information for the endpoint. When specified, the Serverless Endpoint will be allocated capacity from the specified capacity reservation group. |
ServerlessEndpointCapacityReservation |
| modelSettings | The model settings (model id) for the model being serviced on the ServerlessEndpoint. | ModelSettings |
| offer | The publisher-defined Serverless Offer to provision the endpoint with. | ServerlessOffer |
ServerlessOffer
| Name | Description | Value |
|---|---|---|
| offerName | [Required] The name of the Serverless Offer | string Constraints: Min length = 1 Pattern = [a-zA-Z0-9_] (required) |
| publisher | [Required] Publisher name of the Serverless Offer | string Constraints: Min length = 1 Pattern = [a-zA-Z0-9_] (required) |
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' |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
ARM template resource definition
The workspaces/serverlessEndpoints 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.MachineLearningServices/workspaces/serverlessEndpoints resource, add the following JSON to your template.
{
"type": "Microsoft.MachineLearningServices/workspaces/serverlessEndpoints",
"apiVersion": "2024-04-01-preview",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"kind": "string",
"location": "string",
"properties": {
"authMode": "string",
"capacityReservation": {
"capacityReservationGroupId": "string",
"endpointReservedCapacity": "int"
},
"modelSettings": {
"modelId": "string"
},
"offer": {
"offerName": "string",
"publisher": "string"
}
},
"sku": {
"capacity": "int",
"family": "string",
"name": "string",
"size": "string",
"tier": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
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 |
Microsoft.MachineLearningServices/workspaces/serverlessEndpoints
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-04-01-preview' |
| identity | Managed service identity (system assigned and/or user assigned identities) | ManagedServiceIdentity |
| kind | Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. | string |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z][a-zA-Z0-9-]{0,51}$ (required) |
| properties | [Required] Additional attributes of the entity. | ServerlessEndpointProperties (required) |
| sku | Sku details required for ARM contract for Autoscaling. | Sku |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.MachineLearningServices/workspaces/serverlessEndpoints' |
ModelSettings
| Name | Description | Value |
|---|---|---|
| modelId | [Required] | string Constraints: Min length = 1 Pattern = [a-zA-Z0-9_] (required) |
ServerlessEndpointCapacityReservation
| Name | Description | Value |
|---|---|---|
| capacityReservationGroupId | [Required] Specifies a capacity reservation group ID to allocate capacity from. | string Constraints: Min length = 1 Pattern = [a-zA-Z0-9_] (required) |
| endpointReservedCapacity | Specifies a capacity amount to reserve for this endpoint within the parent capacity reservation group. | int |
ServerlessEndpointProperties
| Name | Description | Value |
|---|---|---|
| authMode | Specifies the authentication mode for the Serverless endpoint. | 'AAD' 'Key' |
| capacityReservation | Optional capacity reservation information for the endpoint. When specified, the Serverless Endpoint will be allocated capacity from the specified capacity reservation group. |
ServerlessEndpointCapacityReservation |
| modelSettings | The model settings (model id) for the model being serviced on the ServerlessEndpoint. | ModelSettings |
| offer | The publisher-defined Serverless Offer to provision the endpoint with. | ServerlessOffer |
ServerlessOffer
| Name | Description | Value |
|---|---|---|
| offerName | [Required] The name of the Serverless Offer | string Constraints: Min length = 1 Pattern = [a-zA-Z0-9_] (required) |
| publisher | [Required] Publisher name of the Serverless Offer | string Constraints: Min length = 1 Pattern = [a-zA-Z0-9_] (required) |
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' |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
Usage Examples
Terraform (AzAPI provider) resource definition
The workspaces/serverlessEndpoints 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/workspaces/serverlessEndpoints resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.MachineLearningServices/workspaces/serverlessEndpoints@2024-04-01-preview"
name = "string"
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
kind = "string"
properties = {
authMode = "string"
capacityReservation = {
capacityReservationGroupId = "string"
endpointReservedCapacity = int
}
modelSettings = {
modelId = "string"
}
offer = {
offerName = "string"
publisher = "string"
}
}
sku = {
capacity = int
family = "string"
name = "string"
size = "string"
tier = "string"
}
}
}
Property Values
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 |
Microsoft.MachineLearningServices/workspaces/serverlessEndpoints
| Name | Description | Value |
|---|---|---|
| identity | Managed service identity (system assigned and/or user assigned identities) | ManagedServiceIdentity |
| kind | Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. | string |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z][a-zA-Z0-9-]{0,51}$ (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: workspaces |
| properties | [Required] Additional attributes of the entity. | ServerlessEndpointProperties (required) |
| sku | Sku details required for ARM contract for Autoscaling. | Sku |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.MachineLearningServices/workspaces/serverlessEndpoints@2024-04-01-preview" |
ModelSettings
| Name | Description | Value |
|---|---|---|
| modelId | [Required] | string Constraints: Min length = 1 Pattern = [a-zA-Z0-9_] (required) |
ServerlessEndpointCapacityReservation
| Name | Description | Value |
|---|---|---|
| capacityReservationGroupId | [Required] Specifies a capacity reservation group ID to allocate capacity from. | string Constraints: Min length = 1 Pattern = [a-zA-Z0-9_] (required) |
| endpointReservedCapacity | Specifies a capacity amount to reserve for this endpoint within the parent capacity reservation group. | int |
ServerlessEndpointProperties
| Name | Description | Value |
|---|---|---|
| authMode | Specifies the authentication mode for the Serverless endpoint. | 'AAD' 'Key' |
| capacityReservation | Optional capacity reservation information for the endpoint. When specified, the Serverless Endpoint will be allocated capacity from the specified capacity reservation group. |
ServerlessEndpointCapacityReservation |
| modelSettings | The model settings (model id) for the model being serviced on the ServerlessEndpoint. | ModelSettings |
| offer | The publisher-defined Serverless Offer to provision the endpoint with. | ServerlessOffer |
ServerlessOffer
| Name | Description | Value |
|---|---|---|
| offerName | [Required] The name of the Serverless Offer | string Constraints: Min length = 1 Pattern = [a-zA-Z0-9_] (required) |
| publisher | [Required] Publisher name of the Serverless Offer | string Constraints: Min length = 1 Pattern = [a-zA-Z0-9_] (required) |
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' |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|