Microsoft.MachineLearningServices workspaces/onlineEndpoints 2021-03-01-preview
Bicep resource definition
The workspaces/onlineEndpoints 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/onlineEndpoints resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.MachineLearningServices/workspaces/onlineEndpoints@2021-03-01-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
kind: 'string'
parent: resourceSymbolicName
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {
clientId: 'string'
principalId: 'string'
}
}
}
properties: {
authMode: 'string'
description: 'string'
keys: {
primaryKey: 'string'
secondaryKey: 'string'
primaryKey: 'string'
secondaryKey: 'string'
primaryKey: 'string'
secondaryKey: 'string'
}
properties: {
{customized property}: 'string'
}
target: 'string'
traffic: {
{customized property}: int
}
}
}
Property values
workspaces/onlineEndpoints
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
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 |
| kind | Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. | string |
| 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 |
| identity | Service identity associated with a resource. | ResourceIdentity |
| properties | [Required] Additional attributes of the entity. | OnlineEndpoint (required) |
ResourceIdentity
| Name | Description | Value |
|---|---|---|
| type | Defines values for a ResourceIdentity's type. | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' |
| userAssignedIdentities | Dictionary of the user assigned identities, key is ARM resource ID of the UAI. | ResourceIdentityUserAssignedIdentities |
ResourceIdentityUserAssignedIdentities
| Name | Description | Value |
|---|---|---|
| {customized property} | UserAssignedIdentityMeta |
UserAssignedIdentityMeta
| Name | Description | Value |
|---|---|---|
| clientId | Aka application ID, a unique identifier generated by Azure AD that is tied to an application and service principal during its initial provisioning. | string |
| principalId | The object ID of the service principal object for your managed identity that is used to grant role-based access to an Azure resource. | string |
OnlineEndpoint
| Name | Description | Value |
|---|---|---|
| authMode | [Required] Inference endpoint authentication mode type | 'AADToken' 'AMLToken' 'Key' (required) |
| description | Description of the inference endpoint. | string |
| keys | EndpointAuthKeys to set initially on an Endpoint. This property will always be returned as null. AuthKey values must be retrieved using the ListKeys API. |
EndpointAuthKeys |
| properties | Property dictionary. Properties can be added, but not removed or altered. | OnlineEndpointProperties |
| target | ARM resource ID of the compute if it exists. optional |
string |
| traffic | Traffic rules on how the traffic will be routed across deployments. | OnlineEndpointTraffic |
EndpointAuthKeys
| Name | Description | Value |
|---|---|---|
| primaryKey | The primary key. | string |
| secondaryKey | The secondary key. | string |
| primaryKey | The primary key. | string |
| secondaryKey | The secondary key. | string |
| primaryKey | The primary key. | string |
| secondaryKey | The secondary key. | string |
OnlineEndpointProperties
| Name | Description | Value |
|---|---|---|
| {customized property} | string |
OnlineEndpointTraffic
| Name | Description | Value |
|---|---|---|
| {customized property} | int |
ARM template resource definition
The workspaces/onlineEndpoints 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/onlineEndpoints resource, add the following JSON to your template.
{
"type": "Microsoft.MachineLearningServices/workspaces/onlineEndpoints",
"apiVersion": "2021-03-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"kind": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
"clientId": "string",
"principalId": "string"
}
}
},
"properties": {
"authMode": "string",
"description": "string",
"keys": {
"primaryKey": "string",
"secondaryKey": "string",
"primaryKey": "string",
"secondaryKey": "string",
"primaryKey": "string",
"secondaryKey": "string"
},
"properties": {
"{customized property}": "string"
},
"target": "string",
"traffic": {
"{customized property}": "int"
}
}
}
Property values
workspaces/onlineEndpoints
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.MachineLearningServices/workspaces/onlineEndpoints' |
| apiVersion | The resource api version | '2021-03-01-preview' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
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 |
| kind | Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. | string |
| identity | Service identity associated with a resource. | ResourceIdentity |
| properties | [Required] Additional attributes of the entity. | OnlineEndpoint (required) |
ResourceIdentity
| Name | Description | Value |
|---|---|---|
| type | Defines values for a ResourceIdentity's type. | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' |
| userAssignedIdentities | Dictionary of the user assigned identities, key is ARM resource ID of the UAI. | ResourceIdentityUserAssignedIdentities |
ResourceIdentityUserAssignedIdentities
| Name | Description | Value |
|---|---|---|
| {customized property} | UserAssignedIdentityMeta |
UserAssignedIdentityMeta
| Name | Description | Value |
|---|---|---|
| clientId | Aka application ID, a unique identifier generated by Azure AD that is tied to an application and service principal during its initial provisioning. | string |
| principalId | The object ID of the service principal object for your managed identity that is used to grant role-based access to an Azure resource. | string |
OnlineEndpoint
| Name | Description | Value |
|---|---|---|
| authMode | [Required] Inference endpoint authentication mode type | 'AADToken' 'AMLToken' 'Key' (required) |
| description | Description of the inference endpoint. | string |
| keys | EndpointAuthKeys to set initially on an Endpoint. This property will always be returned as null. AuthKey values must be retrieved using the ListKeys API. |
EndpointAuthKeys |
| properties | Property dictionary. Properties can be added, but not removed or altered. | OnlineEndpointProperties |
| target | ARM resource ID of the compute if it exists. optional |
string |
| traffic | Traffic rules on how the traffic will be routed across deployments. | OnlineEndpointTraffic |
EndpointAuthKeys
| Name | Description | Value |
|---|---|---|
| primaryKey | The primary key. | string |
| secondaryKey | The secondary key. | string |
| primaryKey | The primary key. | string |
| secondaryKey | The secondary key. | string |
| primaryKey | The primary key. | string |
| secondaryKey | The secondary key. | string |
OnlineEndpointProperties
| Name | Description | Value |
|---|---|---|
| {customized property} | string |
OnlineEndpointTraffic
| Name | Description | Value |
|---|---|---|
| {customized property} | int |
Terraform (AzAPI provider) resource definition
The workspaces/onlineEndpoints 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/onlineEndpoints resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.MachineLearningServices/workspaces/onlineEndpoints@2021-03-01-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
authMode = "string"
description = "string"
keys = {
primaryKey = "string"
secondaryKey = "string"
primaryKey = "string"
secondaryKey = "string"
primaryKey = "string"
secondaryKey = "string"
}
properties = {
{customized property} = "string"
}
target = "string"
traffic = {
{customized property} = int
}
}
kind = "string"
})
}
Property values
workspaces/onlineEndpoints
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.MachineLearningServices/workspaces/onlineEndpoints@2021-03-01-preview" |
| name | The resource name | string (required) |
| location | The geo-location where the resource lives | string (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: workspaces |
| tags | Resource tags. | Dictionary of tag names and values. |
| kind | Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. | string |
| identity | Service identity associated with a resource. | ResourceIdentity |
| properties | [Required] Additional attributes of the entity. | OnlineEndpoint (required) |
ResourceIdentity
| Name | Description | Value |
|---|---|---|
| type | Defines values for a ResourceIdentity's type. | "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" |
| identity_ids | Dictionary of the user assigned identities, key is ARM resource ID of the UAI. | Array of user identity IDs. |
ResourceIdentityUserAssignedIdentities
| Name | Description | Value |
|---|---|---|
| {customized property} | UserAssignedIdentityMeta |
UserAssignedIdentityMeta
| Name | Description | Value |
|---|---|---|
| clientId | Aka application ID, a unique identifier generated by Azure AD that is tied to an application and service principal during its initial provisioning. | string |
| principalId | The object ID of the service principal object for your managed identity that is used to grant role-based access to an Azure resource. | string |
OnlineEndpoint
| Name | Description | Value |
|---|---|---|
| authMode | [Required] Inference endpoint authentication mode type | "AADToken" "AMLToken" "Key" (required) |
| description | Description of the inference endpoint. | string |
| keys | EndpointAuthKeys to set initially on an Endpoint. This property will always be returned as null. AuthKey values must be retrieved using the ListKeys API. |
EndpointAuthKeys |
| properties | Property dictionary. Properties can be added, but not removed or altered. | OnlineEndpointProperties |
| target | ARM resource ID of the compute if it exists. optional |
string |
| traffic | Traffic rules on how the traffic will be routed across deployments. | OnlineEndpointTraffic |
EndpointAuthKeys
| Name | Description | Value |
|---|---|---|
| primaryKey | The primary key. | string |
| secondaryKey | The secondary key. | string |
| primaryKey | The primary key. | string |
| secondaryKey | The secondary key. | string |
| primaryKey | The primary key. | string |
| secondaryKey | The secondary key. | string |
OnlineEndpointProperties
| Name | Description | Value |
|---|---|---|
| {customized property} | string |
OnlineEndpointTraffic
| Name | Description | Value |
|---|---|---|
| {customized property} | int |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for