Microsoft.MachineLearningServices (preview:2025-01-01)

2025/02/21 • 4 updated methods

ServerlessEndpoints_List (updated)
Description :  List Serverless Endpoints.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ServerlessEndpoints_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "contentSafety": [
                  {
                    "#name": "contentSafetyLevel",
                    "Required": {
                      "new": true,
                      "old": false
                    }
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/serverlessEndpoints
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of Azure Machine Learning workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$skip:
{
Description: Continuation token for pagination. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link to the next page of ServerlessEndpoint objects. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: An array of objects of type ServerlessEndpoint. ,
Required: False ,
}
[
{
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
kind:
{
Description: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. ,
Required: False ,
}
string ,
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
authMode:
{
Description: [Required] Specifies the authentication mode for the Serverless endpoint. ,
Enum:
{
Key: No description available. ,
AAD: No description available. ,
KeyAndAAD: No description available. ,
}
,
Required: True ,
}
enum ,
contentSafety:
{
Description: Specifies the content safety options. If omitted, the default content safety settings will be configured ,
Required: False ,
}
{
contentSafetyLevel:
{
Description: [Required] Specifies the current safety level for content safety. ,
Enum:
{
Blocking: No description available. ,
Deferred: No description available. ,
}
,
Required: True ,
}
enum ,
contentSafetyStatus:
{
Description: [Required] Specifies the status of content safety. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
endpointState:
{
Description: The current state of the ServerlessEndpoint. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Suspending: No description available. ,
Reinstating: No description available. ,
Online: No description available. ,
Suspended: No description available. ,
CreationFailed: No description available. ,
DeletionFailed: No description available. ,
}
,
Required: False ,
}
enum ,
inferenceEndpoint:
{
Description: The inference uri to target when making requests against the serverless endpoint ,
Required: False ,
}
{
headers:
{
Description: Specifies any required headers to target this serverless endpoint. ,
Required: False ,
}
object ,
uri:
{
Description: [Required] The inference uri to target when making requests against the Serverless Endpoint. ,
Format: uri ,
Required: True ,
}
string ,
}
,
marketplaceSubscriptionId:
{
Description: The MarketplaceSubscription Azure ID associated to this ServerlessEndpoint. ,
Required: False ,
}
string ,
modelSettings:
{
Description: The model settings (model id) for the model being serviced on the ServerlessEndpoint. ,
Required: False ,
}
{
modelId:
{
Description: The unique model identifier that this ServerlessEndpoint should provision. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state for the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Sku details required for ARM contract for Autoscaling. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: 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. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerlessEndpoints_Get (updated)
Description :  Get Serverless Endpoint.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ServerlessEndpoints_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "contentSafety": [
              {
                "#name": "contentSafetyLevel",
                "Required": {
                  "new": true,
                  "old": false
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/serverlessEndpoints/{name}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of Azure Machine Learning workspace. ,
Required: True ,
}
string ,
name:
{
Description: Serverless Endpoint name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
kind:
{
Description: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. ,
Required: False ,
}
string ,
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
authMode:
{
Description: [Required] Specifies the authentication mode for the Serverless endpoint. ,
Enum:
{
Key: No description available. ,
AAD: No description available. ,
KeyAndAAD: No description available. ,
}
,
Required: True ,
}
enum ,
contentSafety:
{
Description: Specifies the content safety options. If omitted, the default content safety settings will be configured ,
Required: False ,
}
{
contentSafetyLevel:
{
Description: [Required] Specifies the current safety level for content safety. ,
Enum:
{
Blocking: No description available. ,
Deferred: No description available. ,
}
,
Required: True ,
}
enum ,
contentSafetyStatus:
{
Description: [Required] Specifies the status of content safety. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
endpointState:
{
Description: The current state of the ServerlessEndpoint. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Suspending: No description available. ,
Reinstating: No description available. ,
Online: No description available. ,
Suspended: No description available. ,
CreationFailed: No description available. ,
DeletionFailed: No description available. ,
}
,
Required: False ,
}
enum ,
inferenceEndpoint:
{
Description: The inference uri to target when making requests against the serverless endpoint ,
Required: False ,
}
{
headers:
{
Description: Specifies any required headers to target this serverless endpoint. ,
Required: False ,
}
object ,
uri:
{
Description: [Required] The inference uri to target when making requests against the Serverless Endpoint. ,
Format: uri ,
Required: True ,
}
string ,
}
,
marketplaceSubscriptionId:
{
Description: The MarketplaceSubscription Azure ID associated to this ServerlessEndpoint. ,
Required: False ,
}
string ,
modelSettings:
{
Description: The model settings (model id) for the model being serviced on the ServerlessEndpoint. ,
Required: False ,
}
{
modelId:
{
Description: The unique model identifier that this ServerlessEndpoint should provision. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state for the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Sku details required for ARM contract for Autoscaling. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: 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. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerlessEndpoints_Update (updated)
Description :  Update Serverless Endpoint (asynchronous).
Reference :  Link ¶

⚶ Changes

{
  "#id": "ServerlessEndpoints_Update",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "contentSafety": [
              {
                "#name": "contentSafetyLevel",
                "Required": {
                  "new": true,
                  "old": false
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/serverlessEndpoints/{name}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of Azure Machine Learning workspace. ,
Required: True ,
}
string ,
name:
{
Description: Serverless Endpoint name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Serverless Endpoint entity to apply during operation. ,
Required: True ,
}
{
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
Required: False ,
}
{
type:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
sku:
{
Description: Sku details required for ARM contract for Autoscaling. ,
Required: False ,
}
{
capacity:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code. ,
Required: False ,
}
string ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
tier:
{
Description: 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. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
kind:
{
Description: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. ,
Required: False ,
}
string ,
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
authMode:
{
Description: [Required] Specifies the authentication mode for the Serverless endpoint. ,
Enum:
{
Key: No description available. ,
AAD: No description available. ,
KeyAndAAD: No description available. ,
}
,
Required: True ,
}
enum ,
contentSafety:
{
Description: Specifies the content safety options. If omitted, the default content safety settings will be configured ,
Required: False ,
}
{
contentSafetyLevel:
{
Description: [Required] Specifies the current safety level for content safety. ,
Enum:
{
Blocking: No description available. ,
Deferred: No description available. ,
}
,
Required: True ,
}
enum ,
contentSafetyStatus:
{
Description: [Required] Specifies the status of content safety. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
endpointState:
{
Description: The current state of the ServerlessEndpoint. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Suspending: No description available. ,
Reinstating: No description available. ,
Online: No description available. ,
Suspended: No description available. ,
CreationFailed: No description available. ,
DeletionFailed: No description available. ,
}
,
Required: False ,
}
enum ,
inferenceEndpoint:
{
Description: The inference uri to target when making requests against the serverless endpoint ,
Required: False ,
}
{
headers:
{
Description: Specifies any required headers to target this serverless endpoint. ,
Required: False ,
}
object ,
uri:
{
Description: [Required] The inference uri to target when making requests against the Serverless Endpoint. ,
Format: uri ,
Required: True ,
}
string ,
}
,
marketplaceSubscriptionId:
{
Description: The MarketplaceSubscription Azure ID associated to this ServerlessEndpoint. ,
Required: False ,
}
string ,
modelSettings:
{
Description: The model settings (model id) for the model being serviced on the ServerlessEndpoint. ,
Required: False ,
}
{
modelId:
{
Description: The unique model identifier that this ServerlessEndpoint should provision. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state for the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Sku details required for ARM contract for Autoscaling. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: 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. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (202)

{
x-ms-async-operation-timeout:
{
Description: Timeout for the client to use when polling the asynchronous operation. ,
}
string ,
location:
{
Description: URI to poll for asynchronous operation result. ,
}
string ,
retry-after:
{
Description: Duration the client should wait between requests, in seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServerlessEndpoints_CreateOrUpdate (updated)
Description :  Create or update Serverless Endpoint (asynchronous).
Reference :  Link ¶

⚶ Changes

{
  "#id": "ServerlessEndpoints_CreateOrUpdate",
  "$parameters": {
    "body": {
      "$properties": {
        "properties": [
          {
            "contentSafety": [
              {
                "#name": "contentSafetyLevel",
                "Required": {
                  "new": true,
                  "old": false
                }
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "contentSafety": [
              {
                "#name": "contentSafetyLevel",
                "Required": {
                  "new": true,
                  "old": false
                }
              }
            ]
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "contentSafety": [
              {
                "#name": "contentSafetyLevel",
                "Required": {
                  "new": true,
                  "old": false
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/serverlessEndpoints/{name}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of Azure Machine Learning workspace. ,
Required: True ,
}
string ,
name:
{
Description: Serverless Endpoint name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Serverless Endpoint entity to apply during operation. ,
Required: True ,
}
{
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
kind:
{
Description: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. ,
Required: False ,
}
string ,
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
authMode:
{
Description: [Required] Specifies the authentication mode for the Serverless endpoint. ,
Enum:
{
Key: No description available. ,
AAD: No description available. ,
KeyAndAAD: No description available. ,
}
,
Required: True ,
}
enum ,
contentSafety:
{
Description: Specifies the content safety options. If omitted, the default content safety settings will be configured ,
Required: False ,
}
{
contentSafetyLevel:
{
Description: [Required] Specifies the current safety level for content safety. ,
Enum:
{
Blocking: No description available. ,
Deferred: No description available. ,
}
,
Required: True ,
}
enum ,
contentSafetyStatus:
{
Description: [Required] Specifies the status of content safety. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
endpointState:
{
Description: The current state of the ServerlessEndpoint. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Suspending: No description available. ,
Reinstating: No description available. ,
Online: No description available. ,
Suspended: No description available. ,
CreationFailed: No description available. ,
DeletionFailed: No description available. ,
}
,
Required: False ,
}
enum ,
inferenceEndpoint:
{
Description: The inference uri to target when making requests against the serverless endpoint ,
Required: False ,
}
{
headers:
{
Description: Specifies any required headers to target this serverless endpoint. ,
Required: False ,
}
object ,
uri:
{
Description: [Required] The inference uri to target when making requests against the Serverless Endpoint. ,
Format: uri ,
Required: True ,
}
string ,
}
,
marketplaceSubscriptionId:
{
Description: The MarketplaceSubscription Azure ID associated to this ServerlessEndpoint. ,
Required: False ,
}
string ,
modelSettings:
{
Description: The model settings (model id) for the model being serviced on the ServerlessEndpoint. ,
Required: False ,
}
{
modelId:
{
Description: The unique model identifier that this ServerlessEndpoint should provision. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state for the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Sku details required for ARM contract for Autoscaling. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: 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. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
kind:
{
Description: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. ,
Required: False ,
}
string ,
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
authMode:
{
Description: [Required] Specifies the authentication mode for the Serverless endpoint. ,
Enum:
{
Key: No description available. ,
AAD: No description available. ,
KeyAndAAD: No description available. ,
}
,
Required: True ,
}
enum ,
contentSafety:
{
Description: Specifies the content safety options. If omitted, the default content safety settings will be configured ,
Required: False ,
}
{
contentSafetyLevel:
{
Description: [Required] Specifies the current safety level for content safety. ,
Enum:
{
Blocking: No description available. ,
Deferred: No description available. ,
}
,
Required: True ,
}
enum ,
contentSafetyStatus:
{
Description: [Required] Specifies the status of content safety. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
endpointState:
{
Description: The current state of the ServerlessEndpoint. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Suspending: No description available. ,
Reinstating: No description available. ,
Online: No description available. ,
Suspended: No description available. ,
CreationFailed: No description available. ,
DeletionFailed: No description available. ,
}
,
Required: False ,
}
enum ,
inferenceEndpoint:
{
Description: The inference uri to target when making requests against the serverless endpoint ,
Required: False ,
}
{
headers:
{
Description: Specifies any required headers to target this serverless endpoint. ,
Required: False ,
}
object ,
uri:
{
Description: [Required] The inference uri to target when making requests against the Serverless Endpoint. ,
Format: uri ,
Required: True ,
}
string ,
}
,
marketplaceSubscriptionId:
{
Description: The MarketplaceSubscription Azure ID associated to this ServerlessEndpoint. ,
Required: False ,
}
string ,
modelSettings:
{
Description: The model settings (model id) for the model being serviced on the ServerlessEndpoint. ,
Required: False ,
}
{
modelId:
{
Description: The unique model identifier that this ServerlessEndpoint should provision. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state for the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Sku details required for ARM contract for Autoscaling. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: 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. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
$headers:
{
x-ms-async-operation-timeout:
{
Description: Timeout for the client to use when polling the asynchronous operation. ,
}
string ,
azure-asyncoperation:
{
Description: URI to poll for asynchronous operation status. ,
}
string ,
}
,
$schema:
{
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
kind:
{
Description: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. ,
Required: False ,
}
string ,
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
authMode:
{
Description: [Required] Specifies the authentication mode for the Serverless endpoint. ,
Enum:
{
Key: No description available. ,
AAD: No description available. ,
KeyAndAAD: No description available. ,
}
,
Required: True ,
}
enum ,
contentSafety:
{
Description: Specifies the content safety options. If omitted, the default content safety settings will be configured ,
Required: False ,
}
{
contentSafetyLevel:
{
Description: [Required] Specifies the current safety level for content safety. ,
Enum:
{
Blocking: No description available. ,
Deferred: No description available. ,
}
,
Required: True ,
}
enum ,
contentSafetyStatus:
{
Description: [Required] Specifies the status of content safety. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
endpointState:
{
Description: The current state of the ServerlessEndpoint. ,
Enum:
{
Unknown: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Suspending: No description available. ,
Reinstating: No description available. ,
Online: No description available. ,
Suspended: No description available. ,
CreationFailed: No description available. ,
DeletionFailed: No description available. ,
}
,
Required: False ,
}
enum ,
inferenceEndpoint:
{
Description: The inference uri to target when making requests against the serverless endpoint ,
Required: False ,
}
{
headers:
{
Description: Specifies any required headers to target this serverless endpoint. ,
Required: False ,
}
object ,
uri:
{
Description: [Required] The inference uri to target when making requests against the Serverless Endpoint. ,
Format: uri ,
Required: True ,
}
string ,
}
,
marketplaceSubscriptionId:
{
Description: The MarketplaceSubscription Azure ID associated to this ServerlessEndpoint. ,
Required: False ,
}
string ,
modelSettings:
{
Description: The model settings (model id) for the model being serviced on the ServerlessEndpoint. ,
Required: False ,
}
{
modelId:
{
Description: The unique model identifier that this ServerlessEndpoint should provision. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning state for the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: Sku details required for ARM contract for Autoscaling. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: 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. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}