Workspaces - Diagnose

Service:

Machine Learning

API Version:

2023-10-01

Diagnose workspace setup issue.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/diagnose?api-version=2023-10-01

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string	The ID of the target subscription.
workspaceName	path	True	string	Name of Azure Machine Learning workspace. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$
api-version	query	True	string	The API version to use for this operation.

Request Body

Name	Type	Description
value	DiagnoseRequestProperties	Value of Parameters

Responses

Name	Type	Description
200 OK	DiagnoseResponseResult	Success
202 Accepted		Success Headers Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Error

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Diagnose Workspace

Sample request

HTTP

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/diagnose?api-version=2023-10-01

{
  "value": {
    "udr": {},
    "nsg": {},
    "resourceLock": {},
    "dnsResolution": {},
    "storageAccount": {},
    "keyVault": {},
    "containerRegistry": {},
    "applicationInsights": {},
    "others": {}
  }
}

Sample response

Status code:

200

{
  "value": {
    "userDefinedRouteResults": [],
    "networkSecurityRuleResults": [],
    "resourceLockResults": [],
    "dnsResolutionResults": [
      {
        "code": "CustomDNSInUse",
        "level": "Warning",
        "message": "We have detected an on-premise dns server is configured. Please make sure conditional forwarding is configured correctly according to doc https://foo"
      }
    ],
    "storageAccountResults": [],
    "keyVaultResults": [],
    "containerRegistryResults": [],
    "applicationInsightsResults": [],
    "otherResults": []
  }
}

Status code:

202

Location: example_location

Definitions

Name	Description
DiagnoseRequestProperties
DiagnoseResponseResult
DiagnoseResult	Result of Diagnose
DiagnoseResultLevel	Level of workspace setup error
DiagnoseWorkspaceParameters	Parameters to diagnose a workspace
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
Value

DiagnoseRequestProperties

Name	Type	Description
applicationInsights	object	Setting for diagnosing dependent application insights
containerRegistry	object	Setting for diagnosing dependent container registry
dnsResolution	object	Setting for diagnosing dns resolution
keyVault	object	Setting for diagnosing dependent key vault
nsg	object	Setting for diagnosing network security group
others	object	Setting for diagnosing unclassified category of problems
resourceLock	object	Setting for diagnosing resource lock
storageAccount	object	Setting for diagnosing dependent storage account
udr	object	Setting for diagnosing user defined routing

DiagnoseResponseResult

Name	Type	Description
value	Value

DiagnoseResult

Result of Diagnose

Name	Type	Description
code	string	Code for workspace setup error
level	DiagnoseResultLevel	Level of workspace setup error
message	string	Message of workspace setup error

DiagnoseResultLevel

Level of workspace setup error

Name	Type	Description
Error	string
Information	string
Warning	string

DiagnoseWorkspaceParameters

Parameters to diagnose a workspace

Name	Type	Description
value	DiagnoseRequestProperties	Value of Parameters

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

Value

Name	Type	Description
applicationInsightsResults	DiagnoseResult[]	Result of Diagnose
containerRegistryResults	DiagnoseResult[]	Result of Diagnose
dnsResolutionResults	DiagnoseResult[]	Result of Diagnose
keyVaultResults	DiagnoseResult[]	Result of Diagnose
networkSecurityRuleResults	DiagnoseResult[]	Result of Diagnose
otherResults	DiagnoseResult[]	Result of Diagnose
resourceLockResults	DiagnoseResult[]	Result of Diagnose
storageAccountResults	DiagnoseResult[]	Result of Diagnose
userDefinedRouteResults	DiagnoseResult[]	Result of Diagnose