Microsoft.MachineLearningServices workspaces/endpoints/deployments 2024-07-01-preview
Bicep resource definition
The workspaces/endpoints/deployments 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/deployments resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.MachineLearningServices/workspaces/endpoints/deployments@2024-07-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
failureReason: 'string'
type: 'string'
// For remaining properties, see EndpointDeploymentResourceProperties objects
}
}
EndpointDeploymentResourceProperties objects
Set the type property to specify the type of object.
For Azure.ContentSafety, use:
type: 'Azure.ContentSafety'
model: {
format: 'string'
name: 'string'
source: 'string'
version: 'string'
}
raiPolicyName: 'string'
versionUpgradeOption: 'string'
For Azure.OpenAI, use:
type: 'Azure.OpenAI'
model: {
format: 'string'
name: 'string'
source: 'string'
version: 'string'
}
raiPolicyName: 'string'
versionUpgradeOption: 'string'
For Azure.Speech, use:
type: 'Azure.Speech'
model: {
format: 'string'
name: 'string'
source: 'string'
version: 'string'
}
raiPolicyName: 'string'
versionUpgradeOption: 'string'
For managedOnlineEndpoint, use:
type: 'managedOnlineEndpoint'
endpointComputeType: 'string'
model: 'string'
Property values
workspaces/endpoints/deployments
Name | Description | Value |
---|---|---|
name | The resource name See how to set names and types for child resources in Bicep. |
string (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: endpoints |
properties | EndpointDeploymentResourceProperties (required) |
EndpointDeploymentResourceProperties
Name | Description | Value |
---|---|---|
failureReason | The failure reason if the creation failed. | string |
type | Set the object type | Azure.ContentSafety Azure.OpenAI Azure.Speech managedOnlineEndpoint (required) |
ContentSafetyEndpointDeploymentResourceProperties
Name | Description | Value |
---|---|---|
type | Kind of the deployment. | 'Azure.ContentSafety' (required) |
model | Model used for the endpoint deployment. | EndpointDeploymentModel (required) |
raiPolicyName | The name of RAI policy. | string |
versionUpgradeOption | Deployment model version upgrade option. | 'NoAutoUpgrade' 'OnceCurrentVersionExpired' 'OnceNewDefaultVersionAvailable' |
EndpointDeploymentModel
Name | Description | Value |
---|---|---|
format | Model format | string |
name | Model name. | string |
source | Optional. Deployment model source ARM resource ID. | string |
version | Model version. | string |
OpenAIEndpointDeploymentResourceProperties
Name | Description | Value |
---|---|---|
type | Kind of the deployment. | 'Azure.OpenAI' (required) |
model | Model used for the endpoint deployment. | EndpointDeploymentModel (required) |
raiPolicyName | The name of RAI policy. | string |
versionUpgradeOption | Deployment model version upgrade option. | 'NoAutoUpgrade' 'OnceCurrentVersionExpired' 'OnceNewDefaultVersionAvailable' |
SpeechEndpointDeploymentResourceProperties
Name | Description | Value |
---|---|---|
type | Kind of the deployment. | 'Azure.Speech' (required) |
model | Model used for the endpoint deployment. | EndpointDeploymentModel (required) |
raiPolicyName | The name of RAI policy. | string |
versionUpgradeOption | Deployment model version upgrade option. | 'NoAutoUpgrade' 'OnceCurrentVersionExpired' 'OnceNewDefaultVersionAvailable' |
ManagedOnlineEndpointDeploymentResourceProperties
Name | Description | Value |
---|---|---|
type | Kind of the deployment. | 'managedOnlineEndpoint' (required) |
endpointComputeType | Enum to determine endpoint compute type. | 'AzureMLCompute' 'Kubernetes' 'Managed' |
model | string |
ARM template resource definition
The workspaces/endpoints/deployments 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/deployments resource, add the following JSON to your template.
{
"type": "Microsoft.MachineLearningServices/workspaces/endpoints/deployments",
"apiVersion": "2024-07-01-preview",
"name": "string",
"properties": {
"failureReason": "string",
"type": "string"
// For remaining properties, see EndpointDeploymentResourceProperties objects
}
}
EndpointDeploymentResourceProperties objects
Set the type property to specify the type of object.
For Azure.ContentSafety, use:
"type": "Azure.ContentSafety",
"model": {
"format": "string",
"name": "string",
"source": "string",
"version": "string"
},
"raiPolicyName": "string",
"versionUpgradeOption": "string"
For Azure.OpenAI, use:
"type": "Azure.OpenAI",
"model": {
"format": "string",
"name": "string",
"source": "string",
"version": "string"
},
"raiPolicyName": "string",
"versionUpgradeOption": "string"
For Azure.Speech, use:
"type": "Azure.Speech",
"model": {
"format": "string",
"name": "string",
"source": "string",
"version": "string"
},
"raiPolicyName": "string",
"versionUpgradeOption": "string"
For managedOnlineEndpoint, use:
"type": "managedOnlineEndpoint",
"endpointComputeType": "string",
"model": "string"
Property values
workspaces/endpoints/deployments
Name | Description | Value |
---|---|---|
type | The resource type | 'Microsoft.MachineLearningServices/workspaces/endpoints/deployments' |
apiVersion | The resource api version | '2024-07-01-preview' |
name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) |
properties | EndpointDeploymentResourceProperties (required) |
EndpointDeploymentResourceProperties
Name | Description | Value |
---|---|---|
failureReason | The failure reason if the creation failed. | string |
type | Set the object type | Azure.ContentSafety Azure.OpenAI Azure.Speech managedOnlineEndpoint (required) |
ContentSafetyEndpointDeploymentResourceProperties
Name | Description | Value |
---|---|---|
type | Kind of the deployment. | 'Azure.ContentSafety' (required) |
model | Model used for the endpoint deployment. | EndpointDeploymentModel (required) |
raiPolicyName | The name of RAI policy. | string |
versionUpgradeOption | Deployment model version upgrade option. | 'NoAutoUpgrade' 'OnceCurrentVersionExpired' 'OnceNewDefaultVersionAvailable' |
EndpointDeploymentModel
Name | Description | Value |
---|---|---|
format | Model format | string |
name | Model name. | string |
source | Optional. Deployment model source ARM resource ID. | string |
version | Model version. | string |
OpenAIEndpointDeploymentResourceProperties
Name | Description | Value |
---|---|---|
type | Kind of the deployment. | 'Azure.OpenAI' (required) |
model | Model used for the endpoint deployment. | EndpointDeploymentModel (required) |
raiPolicyName | The name of RAI policy. | string |
versionUpgradeOption | Deployment model version upgrade option. | 'NoAutoUpgrade' 'OnceCurrentVersionExpired' 'OnceNewDefaultVersionAvailable' |
SpeechEndpointDeploymentResourceProperties
Name | Description | Value |
---|---|---|
type | Kind of the deployment. | 'Azure.Speech' (required) |
model | Model used for the endpoint deployment. | EndpointDeploymentModel (required) |
raiPolicyName | The name of RAI policy. | string |
versionUpgradeOption | Deployment model version upgrade option. | 'NoAutoUpgrade' 'OnceCurrentVersionExpired' 'OnceNewDefaultVersionAvailable' |
ManagedOnlineEndpointDeploymentResourceProperties
Name | Description | Value |
---|---|---|
type | Kind of the deployment. | 'managedOnlineEndpoint' (required) |
endpointComputeType | Enum to determine endpoint compute type. | 'AzureMLCompute' 'Kubernetes' 'Managed' |
model | string |
Terraform (AzAPI provider) resource definition
The workspaces/endpoints/deployments 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/deployments resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.MachineLearningServices/workspaces/endpoints/deployments@2024-07-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
failureReason = "string"
type = "string"
// For remaining properties, see EndpointDeploymentResourceProperties objects
}
})
}
EndpointDeploymentResourceProperties objects
Set the type property to specify the type of object.
For Azure.ContentSafety, use:
type = "Azure.ContentSafety"
model = {
format = "string"
name = "string"
source = "string"
version = "string"
}
raiPolicyName = "string"
versionUpgradeOption = "string"
For Azure.OpenAI, use:
type = "Azure.OpenAI"
model = {
format = "string"
name = "string"
source = "string"
version = "string"
}
raiPolicyName = "string"
versionUpgradeOption = "string"
For Azure.Speech, use:
type = "Azure.Speech"
model = {
format = "string"
name = "string"
source = "string"
version = "string"
}
raiPolicyName = "string"
versionUpgradeOption = "string"
For managedOnlineEndpoint, use:
type = "managedOnlineEndpoint"
endpointComputeType = "string"
model = "string"
Property values
workspaces/endpoints/deployments
Name | Description | Value |
---|---|---|
type | The resource type | "Microsoft.MachineLearningServices/workspaces/endpoints/deployments@2024-07-01-preview" |
name | The resource name | string (required) |
parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: endpoints |
properties | EndpointDeploymentResourceProperties (required) |
EndpointDeploymentResourceProperties
Name | Description | Value |
---|---|---|
failureReason | The failure reason if the creation failed. | string |
type | Set the object type | Azure.ContentSafety Azure.OpenAI Azure.Speech managedOnlineEndpoint (required) |
ContentSafetyEndpointDeploymentResourceProperties
Name | Description | Value |
---|---|---|
type | Kind of the deployment. | "Azure.ContentSafety" (required) |
model | Model used for the endpoint deployment. | EndpointDeploymentModel (required) |
raiPolicyName | The name of RAI policy. | string |
versionUpgradeOption | Deployment model version upgrade option. | "NoAutoUpgrade" "OnceCurrentVersionExpired" "OnceNewDefaultVersionAvailable" |
EndpointDeploymentModel
Name | Description | Value |
---|---|---|
format | Model format | string |
name | Model name. | string |
source | Optional. Deployment model source ARM resource ID. | string |
version | Model version. | string |
OpenAIEndpointDeploymentResourceProperties
Name | Description | Value |
---|---|---|
type | Kind of the deployment. | "Azure.OpenAI" (required) |
model | Model used for the endpoint deployment. | EndpointDeploymentModel (required) |
raiPolicyName | The name of RAI policy. | string |
versionUpgradeOption | Deployment model version upgrade option. | "NoAutoUpgrade" "OnceCurrentVersionExpired" "OnceNewDefaultVersionAvailable" |
SpeechEndpointDeploymentResourceProperties
Name | Description | Value |
---|---|---|
type | Kind of the deployment. | "Azure.Speech" (required) |
model | Model used for the endpoint deployment. | EndpointDeploymentModel (required) |
raiPolicyName | The name of RAI policy. | string |
versionUpgradeOption | Deployment model version upgrade option. | "NoAutoUpgrade" "OnceCurrentVersionExpired" "OnceNewDefaultVersionAvailable" |
ManagedOnlineEndpointDeploymentResourceProperties
Name | Description | Value |
---|---|---|
type | Kind of the deployment. | "managedOnlineEndpoint" (required) |
endpointComputeType | Enum to determine endpoint compute type. | "AzureMLCompute" "Kubernetes" "Managed" |
model | string |