Microsoft.MachineLearningServices workspaces/endpoints 2024-01-01-preview
Bicep resource definition
The workspaces/endpoints 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/endpoints resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.MachineLearningServices/workspaces/endpoints@2024-01-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
associatedResourceId: 'string'
endpointUri: 'string'
failureReason: 'string'
name: 'string'
endpointType: 'string'
// For remaining properties, see EndpointResourceProperties objects
}
}
EndpointResourceProperties objects
Set the endpointType property to specify the type of object.
For Azure.ContentSafety, use:
{
endpointType: 'Azure.ContentSafety'
}
For Azure.OpenAI, use:
{
endpointType: 'Azure.OpenAI'
}
For Azure.Speech, use:
{
endpointType: 'Azure.Speech'
}
For managedOnlineEndpoint, use:
{
endpointType: 'managedOnlineEndpoint'
}
Property values
ContentSafetyEndpointResourceProperties
| Name | Description | Value |
|---|---|---|
| endpointType | Type of the endpoint. | 'Azure.ContentSafety' (required) |
EndpointResourceProperties
| Name | Description | Value |
|---|---|---|
| associatedResourceId | Byo resource id for creating the built-in model service endpoints. | string |
| endpointType | Set to 'Azure.ContentSafety' for type ContentSafetyEndpointResourceProperties. Set to 'Azure.OpenAI' for type OpenAIEndpointResourceProperties. Set to 'Azure.Speech' for type SpeechEndpointResourceProperties. Set to 'managedOnlineEndpoint' for type ManagedOnlineEndpointResourceProperties. | 'Azure.ContentSafety' 'Azure.OpenAI' 'Azure.Speech' 'managedOnlineEndpoint' (required) |
| endpointUri | Uri of the endpoint. | string |
| failureReason | The failure reason if the creation failed. | string |
| name | Name of the endpoint. | string |
ManagedOnlineEndpointResourceProperties
| Name | Description | Value |
|---|---|---|
| endpointType | Type of the endpoint. | 'managedOnlineEndpoint' (required) |
Microsoft.MachineLearningServices/workspaces/endpoints
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_.-]{2,32}$ (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 | EndpointResourceProperties (required) |
OpenAIEndpointResourceProperties
| Name | Description | Value |
|---|---|---|
| endpointType | Type of the endpoint. | 'Azure.OpenAI' (required) |
SpeechEndpointResourceProperties
| Name | Description | Value |
|---|---|---|
| endpointType | Type of the endpoint. | 'Azure.Speech' (required) |
ARM template resource definition
The workspaces/endpoints 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/endpoints resource, add the following JSON to your template.
{
"type": "Microsoft.MachineLearningServices/workspaces/endpoints",
"apiVersion": "2024-01-01-preview",
"name": "string",
"properties": {
"associatedResourceId": "string",
"endpointUri": "string",
"failureReason": "string",
"name": "string",
"endpointType": "string"
// For remaining properties, see EndpointResourceProperties objects
}
}
EndpointResourceProperties objects
Set the endpointType property to specify the type of object.
For Azure.ContentSafety, use:
{
"endpointType": "Azure.ContentSafety"
}
For Azure.OpenAI, use:
{
"endpointType": "Azure.OpenAI"
}
For Azure.Speech, use:
{
"endpointType": "Azure.Speech"
}
For managedOnlineEndpoint, use:
{
"endpointType": "managedOnlineEndpoint"
}
Property values
ContentSafetyEndpointResourceProperties
| Name | Description | Value |
|---|---|---|
| endpointType | Type of the endpoint. | 'Azure.ContentSafety' (required) |
EndpointResourceProperties
| Name | Description | Value |
|---|---|---|
| associatedResourceId | Byo resource id for creating the built-in model service endpoints. | string |
| endpointType | Set to 'Azure.ContentSafety' for type ContentSafetyEndpointResourceProperties. Set to 'Azure.OpenAI' for type OpenAIEndpointResourceProperties. Set to 'Azure.Speech' for type SpeechEndpointResourceProperties. Set to 'managedOnlineEndpoint' for type ManagedOnlineEndpointResourceProperties. | 'Azure.ContentSafety' 'Azure.OpenAI' 'Azure.Speech' 'managedOnlineEndpoint' (required) |
| endpointUri | Uri of the endpoint. | string |
| failureReason | The failure reason if the creation failed. | string |
| name | Name of the endpoint. | string |
ManagedOnlineEndpointResourceProperties
| Name | Description | Value |
|---|---|---|
| endpointType | Type of the endpoint. | 'managedOnlineEndpoint' (required) |
Microsoft.MachineLearningServices/workspaces/endpoints
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-01-01-preview' |
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_.-]{2,32}$ (required) |
| properties | EndpointResourceProperties (required) | |
| type | The resource type | 'Microsoft.MachineLearningServices/workspaces/endpoints' |
OpenAIEndpointResourceProperties
| Name | Description | Value |
|---|---|---|
| endpointType | Type of the endpoint. | 'Azure.OpenAI' (required) |
SpeechEndpointResourceProperties
| Name | Description | Value |
|---|---|---|
| endpointType | Type of the endpoint. | 'Azure.Speech' (required) |
Terraform (AzAPI provider) resource definition
The workspaces/endpoints 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/endpoints resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.MachineLearningServices/workspaces/endpoints@2024-01-01-preview"
name = "string"
body = jsonencode({
properties = {
associatedResourceId = "string"
endpointUri = "string"
failureReason = "string"
name = "string"
endpointType = "string"
// For remaining properties, see EndpointResourceProperties objects
}
})
}
EndpointResourceProperties objects
Set the endpointType property to specify the type of object.
For Azure.ContentSafety, use:
{
endpointType = "Azure.ContentSafety"
}
For Azure.OpenAI, use:
{
endpointType = "Azure.OpenAI"
}
For Azure.Speech, use:
{
endpointType = "Azure.Speech"
}
For managedOnlineEndpoint, use:
{
endpointType = "managedOnlineEndpoint"
}
Property values
ContentSafetyEndpointResourceProperties
| Name | Description | Value |
|---|---|---|
| endpointType | Type of the endpoint. | 'Azure.ContentSafety' (required) |
EndpointResourceProperties
| Name | Description | Value |
|---|---|---|
| associatedResourceId | Byo resource id for creating the built-in model service endpoints. | string |
| endpointType | Set to 'Azure.ContentSafety' for type ContentSafetyEndpointResourceProperties. Set to 'Azure.OpenAI' for type OpenAIEndpointResourceProperties. Set to 'Azure.Speech' for type SpeechEndpointResourceProperties. Set to 'managedOnlineEndpoint' for type ManagedOnlineEndpointResourceProperties. | 'Azure.ContentSafety' 'Azure.OpenAI' 'Azure.Speech' 'managedOnlineEndpoint' (required) |
| endpointUri | Uri of the endpoint. | string |
| failureReason | The failure reason if the creation failed. | string |
| name | Name of the endpoint. | string |
ManagedOnlineEndpointResourceProperties
| Name | Description | Value |
|---|---|---|
| endpointType | Type of the endpoint. | 'managedOnlineEndpoint' (required) |
Microsoft.MachineLearningServices/workspaces/endpoints
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_.-]{2,32}$ (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: workspaces |
| properties | EndpointResourceProperties (required) | |
| type | The resource type | "Microsoft.MachineLearningServices/workspaces/endpoints@2024-01-01-preview" |
OpenAIEndpointResourceProperties
| Name | Description | Value |
|---|---|---|
| endpointType | Type of the endpoint. | 'Azure.OpenAI' (required) |
SpeechEndpointResourceProperties
| Name | Description | Value |
|---|---|---|
| endpointType | Type of the endpoint. | 'Azure.Speech' (required) |