Microsoft.MachineLearningServices workspaces/endpoints 2024-10-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-10-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    associatedResourceId: 'string'
    deployments: [
      {
        properties: {
          failureReason: 'string'
          provisioningState: 'string'
          type: 'string'
          // For remaining properties, see EndpointDeploymentResourcePropertiesAutoGenerated objects
        }
      }
    ]
    endpointUri: 'string'
    failureReason: 'string'
    location: 'string'
    name: 'string'
    provisioningState: 'string'
    shouldCreateAiServicesEndpoint: bool
    endpointType: 'string'
    // For remaining properties, see EndpointResourcePropertiesAutoGenerated objects
  }
}

EndpointDeploymentResourcePropertiesAutoGenerated objects

Set the type property to specify the type of object.

For Azure.ContentSafety, use:

{
  model: {
    format: 'string'
    name: 'string'
    source: 'string'
    version: 'string'
  }
  raiPolicyName: 'string'
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  type: 'Azure.ContentSafety'
  versionUpgradeOption: 'string'
}

For Azure.OpenAI, use:

{
  model: {
    format: 'string'
    name: 'string'
    source: 'string'
    version: 'string'
  }
  raiPolicyName: 'string'
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  type: 'Azure.OpenAI'
  versionUpgradeOption: 'string'
}

For Azure.Speech, use:

{
  model: {
    format: 'string'
    name: 'string'
    source: 'string'
    version: 'string'
  }
  raiPolicyName: 'string'
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  type: 'Azure.Speech'
  versionUpgradeOption: 'string'
}

For managedOnlineEndpoint, use:

{
  endpointComputeType: 'string'
  model: 'string'
  type: 'managedOnlineEndpoint'
}

EndpointResourcePropertiesAutoGenerated 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:

{
  authMode: 'string'
  compute: 'string'
  description: 'string'
  endpointType: 'managedOnlineEndpoint'
  mirrorTraffic: {
    {customized property}: int
  }
  scoringUri: 'string'
  traffic: {
    {customized property}: int
  }
}

For serverlessEndpoint, use:

{
  authMode: 'string'
  capacityReservation: {
    capacityReservationGroupId: 'string'
    endpointReservedCapacity: int
  }
  contentSafety: {
    contentSafetyStatus: 'string'
  }
  endpointState: 'string'
  endpointType: 'serverlessEndpoint'
  inferenceEndpoint: {}
  marketplaceSubscriptionId: 'string'
  metadata: any(...)
  modelSettings: {
    modelId: 'string'
  }
  offer: {
    offerName: 'string'
    publisher: 'string'
  }
}

Property Values