machinelearningservices.azure.com/v1api20210701

---

APIVersion

Value	Description
“2021-07-01”

Workspace

Generator information: - Generated from: /machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/machineLearningServices.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.MachineLearningServices/workspaces/{workspaceName}

Used by: WorkspaceList.

Property	Description	Type
metav1.TypeMeta
metav1.ObjectMeta
spec		Workspace_Spec Optional
status		Workspace_STATUS Optional

Workspace_Spec

Property	Description	Type
allowPublicAccessWhenBehindVnet	The flag to indicate whether to allow public access when behind VNet.	bool Optional
applicationInsightsReference	ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created	genruntime.ResourceReference Optional
azureName	The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.	string Optional
containerRegistryReference	ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created	genruntime.ResourceReference Optional
description	The description of this workspace.	string Optional
discoveryUrl	Url for the discovery service to identify regional endpoints for machine learning experimentation services	string Optional
encryption	The encryption settings of Azure ML workspace.	EncryptionProperty Optional
friendlyName	The friendly name for this workspace. This name in mutable	string Optional
hbiWorkspace	The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service	bool Optional
identity	The identity of the resource.	Identity Optional
imageBuildCompute	The compute name for image build	string Optional
keyVaultReference	ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created	genruntime.ResourceReference Optional
location	Specifies the location of the resource.	string Optional
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	WorkspaceOperatorSpec Optional
owner	The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource	genruntime.KnownResourceReference Required
primaryUserAssignedIdentityReference	The user assigned identity resource id that represents the workspace identity.	genruntime.ResourceReference Optional
publicNetworkAccess	Whether requests from Public Network are allowed.	WorkspaceProperties_PublicNetworkAccess Optional
serviceManagedResourcesSettings	The service managed resource settings.	ServiceManagedResourcesSettings Optional
sharedPrivateLinkResources	The list of shared private link resources in this workspace.	SharedPrivateLinkResource[] Optional
sku	The sku of the workspace.	Sku Optional
storageAccountReference	ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created	genruntime.ResourceReference Optional
systemData	System data	SystemData Optional
tags	Contains resource tags defined as key/value pairs.	map[string]string Optional

Workspace_STATUS

Property	Description	Type
allowPublicAccessWhenBehindVnet	The flag to indicate whether to allow public access when behind VNet.	bool Optional
applicationInsights	ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created	string Optional
conditions	The observed state of the resource	conditions.Condition[] Optional
containerRegistry	ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created	string Optional
description	The description of this workspace.	string Optional
discoveryUrl	Url for the discovery service to identify regional endpoints for machine learning experimentation services	string Optional
encryption	The encryption settings of Azure ML workspace.	EncryptionProperty_STATUS Optional
friendlyName	The friendly name for this workspace. This name in mutable	string Optional
hbiWorkspace	The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service	bool Optional
id	Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}	string Optional
identity	The identity of the resource.	Identity_STATUS Optional
imageBuildCompute	The compute name for image build	string Optional
keyVault	ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created	string Optional
location	Specifies the location of the resource.	string Optional
mlFlowTrackingUri	The URI associated with this workspace that machine learning flow must point at to set up tracking.	string Optional
name	The name of the resource	string Optional
notebookInfo	The notebook info of Azure ML workspace.	NotebookResourceInfo_STATUS Optional
primaryUserAssignedIdentity	The user assigned identity resource id that represents the workspace identity.	string Optional
privateEndpointConnections	The list of private endpoint connections in the workspace.	PrivateEndpointConnection_STATUS[] Optional
privateLinkCount	Count of private connections in the workspace	int Optional
provisioningState	The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning.	WorkspaceProperties_ProvisioningState_STATUS Optional
publicNetworkAccess	Whether requests from Public Network are allowed.	WorkspaceProperties_PublicNetworkAccess_STATUS Optional
serviceManagedResourcesSettings	The service managed resource settings.	ServiceManagedResourcesSettings_STATUS Optional
serviceProvisionedResourceGroup	The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace	string Optional
sharedPrivateLinkResources	The list of shared private link resources in this workspace.	SharedPrivateLinkResource_STATUS[] Optional
sku	The sku of the workspace.	Sku_STATUS Optional
storageAccount	ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created	string Optional
storageHnsEnabled	If the storage associated with the workspace has hierarchical namespace(HNS) enabled.	bool Optional
systemData	System data	SystemData_STATUS Optional
tags	Contains resource tags defined as key/value pairs.	map[string]string Optional
tenantId	The tenant id associated with this workspace.	string Optional
type	The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”	string Optional
workspaceId	The immutable id associated with this workspace.	string Optional

WorkspaceList

Generator information: - Generated from: /machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/machineLearningServices.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.MachineLearningServices/workspaces/{workspaceName}

Property	Description	Type
metav1.TypeMeta
metav1.ListMeta
items		Workspace[] Optional

WorkspacesCompute

Generator information: - Generated from: /machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/machineLearningServices.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}

Used by: WorkspacesComputeList.

Property	Description	Type
metav1.TypeMeta
metav1.ObjectMeta
spec		WorkspacesCompute_Spec Optional
status		WorkspacesCompute_STATUS Optional

WorkspacesCompute_Spec

Property	Description	Type
azureName	The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.	string Optional
identity	The identity of the resource.	Identity Optional
location	Specifies the location of the resource.	string Optional
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	WorkspacesComputeOperatorSpec Optional
owner	The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a machinelearningservices.azure.com/Workspace resource	genruntime.KnownResourceReference Required
properties	Compute properties	Compute Optional
sku	The sku of the workspace.	Sku Optional
systemData	System data	SystemData Optional
tags	Contains resource tags defined as key/value pairs.	map[string]string Optional

WorkspacesCompute_STATUS

Property	Description	Type
conditions	The observed state of the resource	conditions.Condition[] Optional
id	Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}	string Optional
identity	The identity of the resource.	Identity_STATUS Optional
location	Specifies the location of the resource.	string Optional
name	The name of the resource	string Optional
properties	Compute properties	Compute_STATUS Optional
sku	The sku of the workspace.	Sku_STATUS Optional
systemData	System data	SystemData_STATUS Optional
tags	Contains resource tags defined as key/value pairs.	map[string]string Optional
type	The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”	string Optional

WorkspacesComputeList

Generator information: - Generated from: /machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/machineLearningServices.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}

Property	Description	Type
metav1.TypeMeta
metav1.ListMeta
items		WorkspacesCompute[] Optional

WorkspacesConnection

Generator information: - Generated from: /machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/machineLearningServices.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}

Used by: WorkspacesConnectionList.

Property	Description	Type
metav1.TypeMeta
metav1.ObjectMeta
spec		WorkspacesConnection_Spec Optional
status		WorkspacesConnection_STATUS Optional

WorkspacesConnection_Spec

Property	Description	Type
authType	Authorization type of the workspace connection.	string Optional
azureName	The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.	string Optional
category	Category of the workspace connection.	string Optional
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	WorkspacesConnectionOperatorSpec Optional
owner	The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a machinelearningservices.azure.com/Workspace resource	genruntime.KnownResourceReference Required
target	Target of the workspace connection.	string Optional
value	Value details of the workspace connection.	string Optional
valueFormat	format for the workspace connection value	WorkspaceConnectionProps_ValueFormat Optional

WorkspacesConnection_STATUS

Property	Description	Type
authType	Authorization type of the workspace connection.	string Optional
category	Category of the workspace connection.	string Optional
conditions	The observed state of the resource	conditions.Condition[] Optional
id	ResourceId of the workspace connection.	string Optional
name	Friendly name of the workspace connection.	string Optional
target	Target of the workspace connection.	string Optional
type	Resource type of workspace connection.	string Optional
value	Value details of the workspace connection.	string Optional
valueFormat	format for the workspace connection value	WorkspaceConnectionProps_ValueFormat_STATUS Optional

WorkspacesConnectionList

Generator information: - Generated from: /machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/machineLearningServices.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}

Property	Description	Type
metav1.TypeMeta
metav1.ListMeta
items		WorkspacesConnection[] Optional

Workspace_Spec

Used by: Workspace.

Property	Description	Type
allowPublicAccessWhenBehindVnet	The flag to indicate whether to allow public access when behind VNet.	bool Optional
applicationInsightsReference	ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created	genruntime.ResourceReference Optional
azureName	The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.	string Optional
containerRegistryReference	ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created	genruntime.ResourceReference Optional
description	The description of this workspace.	string Optional
discoveryUrl	Url for the discovery service to identify regional endpoints for machine learning experimentation services	string Optional
encryption	The encryption settings of Azure ML workspace.	EncryptionProperty Optional
friendlyName	The friendly name for this workspace. This name in mutable	string Optional
hbiWorkspace	The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service	bool Optional
identity	The identity of the resource.	Identity Optional
imageBuildCompute	The compute name for image build	string Optional
keyVaultReference	ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created	genruntime.ResourceReference Optional
location	Specifies the location of the resource.	string Optional
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	WorkspaceOperatorSpec Optional
owner	The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource	genruntime.KnownResourceReference Required
primaryUserAssignedIdentityReference	The user assigned identity resource id that represents the workspace identity.	genruntime.ResourceReference Optional
publicNetworkAccess	Whether requests from Public Network are allowed.	WorkspaceProperties_PublicNetworkAccess Optional
serviceManagedResourcesSettings	The service managed resource settings.	ServiceManagedResourcesSettings Optional
sharedPrivateLinkResources	The list of shared private link resources in this workspace.	SharedPrivateLinkResource[] Optional
sku	The sku of the workspace.	Sku Optional
storageAccountReference	ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created	genruntime.ResourceReference Optional
systemData	System data	SystemData Optional
tags	Contains resource tags defined as key/value pairs.	map[string]string Optional

Workspace_STATUS

An object that represents a machine learning workspace.

Used by: Workspace.

Property	Description	Type
allowPublicAccessWhenBehindVnet	The flag to indicate whether to allow public access when behind VNet.	bool Optional
applicationInsights	ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created	string Optional
conditions	The observed state of the resource	conditions.Condition[] Optional
containerRegistry	ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created	string Optional
description	The description of this workspace.	string Optional
discoveryUrl	Url for the discovery service to identify regional endpoints for machine learning experimentation services	string Optional
encryption	The encryption settings of Azure ML workspace.	EncryptionProperty_STATUS Optional
friendlyName	The friendly name for this workspace. This name in mutable	string Optional
hbiWorkspace	The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service	bool Optional
id	Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}	string Optional
identity	The identity of the resource.	Identity_STATUS Optional
imageBuildCompute	The compute name for image build	string Optional
keyVault	ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created	string Optional
location	Specifies the location of the resource.	string Optional
mlFlowTrackingUri	The URI associated with this workspace that machine learning flow must point at to set up tracking.	string Optional
name	The name of the resource	string Optional
notebookInfo	The notebook info of Azure ML workspace.	NotebookResourceInfo_STATUS Optional
primaryUserAssignedIdentity	The user assigned identity resource id that represents the workspace identity.	string Optional
privateEndpointConnections	The list of private endpoint connections in the workspace.	PrivateEndpointConnection_STATUS[] Optional
privateLinkCount	Count of private connections in the workspace	int Optional
provisioningState	The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning.	WorkspaceProperties_ProvisioningState_STATUS Optional
publicNetworkAccess	Whether requests from Public Network are allowed.	WorkspaceProperties_PublicNetworkAccess_STATUS Optional
serviceManagedResourcesSettings	The service managed resource settings.	ServiceManagedResourcesSettings_STATUS Optional
serviceProvisionedResourceGroup	The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace	string Optional
sharedPrivateLinkResources	The list of shared private link resources in this workspace.	SharedPrivateLinkResource_STATUS[] Optional
sku	The sku of the workspace.	Sku_STATUS Optional
storageAccount	ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created	string Optional
storageHnsEnabled	If the storage associated with the workspace has hierarchical namespace(HNS) enabled.	bool Optional
systemData	System data	SystemData_STATUS Optional
tags	Contains resource tags defined as key/value pairs.	map[string]string Optional
tenantId	The tenant id associated with this workspace.	string Optional
type	The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”	string Optional
workspaceId	The immutable id associated with this workspace.	string Optional

WorkspacesCompute_Spec

Used by: WorkspacesCompute.

Property	Description	Type
azureName	The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.	string Optional
identity	The identity of the resource.	Identity Optional
location	Specifies the location of the resource.	string Optional
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	WorkspacesComputeOperatorSpec Optional
owner	The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a machinelearningservices.azure.com/Workspace resource	genruntime.KnownResourceReference Required
properties	Compute properties	Compute Optional
sku	The sku of the workspace.	Sku Optional
systemData	System data	SystemData Optional
tags	Contains resource tags defined as key/value pairs.	map[string]string Optional

WorkspacesCompute_STATUS

Used by: WorkspacesCompute.

Property	Description	Type
conditions	The observed state of the resource	conditions.Condition[] Optional
id	Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}	string Optional
identity	The identity of the resource.	Identity_STATUS Optional
location	Specifies the location of the resource.	string Optional
name	The name of the resource	string Optional
properties	Compute properties	Compute_STATUS Optional
sku	The sku of the workspace.	Sku_STATUS Optional
systemData	System data	SystemData_STATUS Optional
tags	Contains resource tags defined as key/value pairs.	map[string]string Optional
type	The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”	string Optional

WorkspacesConnection_Spec

Used by: WorkspacesConnection.

Property	Description	Type
authType	Authorization type of the workspace connection.	string Optional
azureName	The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.	string Optional
category	Category of the workspace connection.	string Optional
operatorSpec	The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure	WorkspacesConnectionOperatorSpec Optional
owner	The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a machinelearningservices.azure.com/Workspace resource	genruntime.KnownResourceReference Required
target	Target of the workspace connection.	string Optional
value	Value details of the workspace connection.	string Optional
valueFormat	format for the workspace connection value	WorkspaceConnectionProps_ValueFormat Optional

WorkspacesConnection_STATUS

Used by: WorkspacesConnection.

Property	Description	Type
authType	Authorization type of the workspace connection.	string Optional
category	Category of the workspace connection.	string Optional
conditions	The observed state of the resource	conditions.Condition[] Optional
id	ResourceId of the workspace connection.	string Optional
name	Friendly name of the workspace connection.	string Optional
target	Target of the workspace connection.	string Optional
type	Resource type of workspace connection.	string Optional
value	Value details of the workspace connection.	string Optional
valueFormat	format for the workspace connection value	WorkspaceConnectionProps_ValueFormat_STATUS Optional

Compute

Used by: WorkspacesCompute_Spec.

Property	Description	Type
aks	Mutually exclusive with all other properties	AKS Optional
amlCompute	Mutually exclusive with all other properties	AmlCompute Optional
computeInstance	Mutually exclusive with all other properties	ComputeInstance Optional
databricks	Mutually exclusive with all other properties	Databricks Optional
dataFactory	Mutually exclusive with all other properties	DataFactory Optional
dataLakeAnalytics	Mutually exclusive with all other properties	DataLakeAnalytics Optional
hdInsight	Mutually exclusive with all other properties	HDInsight Optional
kubernetes	Mutually exclusive with all other properties	Kubernetes Optional
synapseSpark	Mutually exclusive with all other properties	SynapseSpark Optional
virtualMachine	Mutually exclusive with all other properties	VirtualMachine Optional

Compute_STATUS

Used by: WorkspacesCompute_STATUS.

Property	Description	Type
aks	Mutually exclusive with all other properties	AKS_STATUS Optional
amlCompute	Mutually exclusive with all other properties	AmlCompute_STATUS Optional
computeInstance	Mutually exclusive with all other properties	ComputeInstance_STATUS Optional
databricks	Mutually exclusive with all other properties	Databricks_STATUS Optional
dataFactory	Mutually exclusive with all other properties	DataFactory_STATUS Optional
dataLakeAnalytics	Mutually exclusive with all other properties	DataLakeAnalytics_STATUS Optional
hdInsight	Mutually exclusive with all other properties	HDInsight_STATUS Optional
kubernetes	Mutually exclusive with all other properties	Kubernetes_STATUS Optional
synapseSpark	Mutually exclusive with all other properties	SynapseSpark_STATUS Optional
virtualMachine	Mutually exclusive with all other properties	VirtualMachine_STATUS Optional

EncryptionProperty

Used by: Workspace_Spec.

Property	Description	Type
identity	The identity that will be used to access the key vault for encryption at rest.	IdentityForCmk Optional
keyVaultProperties	Customer Key vault properties.	KeyVaultProperties Required

EncryptionProperty_STATUS

Used by: Workspace_STATUS.

Property	Description	Type
identity	The identity that will be used to access the key vault for encryption at rest.	IdentityForCmk_STATUS Optional
keyVaultProperties	Customer Key vault properties.	KeyVaultProperties_STATUS Optional
status	Indicates whether or not the encryption is enabled for the workspace.	EncryptionProperty_Status_STATUS Optional

Identity

Identity for the resource.

Used by: Workspace_Spec, and WorkspacesCompute_Spec.

Property	Description	Type
type	The identity type.	Identity_Type Optional
userAssignedIdentities	The user assigned identities associated with the resource.	UserAssignedIdentityDetails[] Optional

Identity_STATUS

Identity for the resource.

Used by: Workspace_STATUS, and WorkspacesCompute_STATUS.

Property	Description	Type
principalId	The principal ID of resource identity.	string Optional
tenantId	The tenant ID of resource.	string Optional
type	The identity type.	Identity_Type_STATUS Optional
userAssignedIdentities	The user assigned identities associated with the resource.	map[string]UserAssignedIdentity_STATUS Optional

NotebookResourceInfo_STATUS

Used by: Workspace_STATUS.

Property	Description	Type
fqdn		string Optional
notebookPreparationError	The error that occurs when preparing notebook.	NotebookPreparationError_STATUS Optional
resourceId	the data plane resourceId that used to initialize notebook component	string Optional

PrivateEndpointConnection_STATUS

The Private Endpoint Connection resource.

Used by: Workspace_STATUS.

Property	Description	Type
id	Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}	string Optional

ServiceManagedResourcesSettings

Used by: Workspace_Spec.

Property	Description	Type
cosmosDb	The settings for the service managed cosmosdb account.	CosmosDbSettings Optional

ServiceManagedResourcesSettings_STATUS

Used by: Workspace_STATUS.

Property	Description	Type
cosmosDb	The settings for the service managed cosmosdb account.	CosmosDbSettings_STATUS Optional

SharedPrivateLinkResource

Used by: Workspace_Spec.

Property	Description	Type
groupId	The private link resource group id.	string Optional
name	Unique name of the private link.	string Optional
privateLinkResourceReference	The resource id that private link links to.	genruntime.ResourceReference Optional
requestMessage	Request message.	string Optional
status	Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.	PrivateEndpointServiceConnectionStatus Optional

SharedPrivateLinkResource_STATUS

Used by: Workspace_STATUS.

Property	Description	Type
groupId	The private link resource group id.	string Optional
name	Unique name of the private link.	string Optional
privateLinkResourceId	The resource id that private link links to.	string Optional
requestMessage	Request message.	string Optional
status	Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.	PrivateEndpointServiceConnectionStatus_STATUS Optional

Sku

Sku of the resource

Used by: Workspace_Spec, and WorkspacesCompute_Spec.

Property	Description	Type
name	Name of the sku	string Optional
tier	Tier of the sku like Basic or Enterprise	string Optional

Sku_STATUS

Sku of the resource

Used by: Workspace_STATUS, and WorkspacesCompute_STATUS.

Property	Description	Type
name	Name of the sku	string Optional
tier	Tier of the sku like Basic or Enterprise	string Optional

SystemData

Metadata pertaining to creation and last modification of the resource.

Used by: Workspace_Spec, and WorkspacesCompute_Spec.

Property	Description	Type
createdAt	The timestamp of resource creation (UTC).	string Optional
createdBy	The identity that created the resource.	string Optional
createdByType	The type of identity that created the resource.	SystemData_CreatedByType Optional
lastModifiedAt	The timestamp of resource last modification (UTC)	string Optional
lastModifiedBy	The identity that last modified the resource.	string Optional
lastModifiedByType	The type of identity that last modified the resource.	SystemData_LastModifiedByType Optional

SystemData_STATUS

Metadata pertaining to creation and last modification of the resource.

Used by: Workspace_STATUS, and WorkspacesCompute_STATUS.

Property	Description	Type
createdAt	The timestamp of resource creation (UTC).	string Optional
createdBy	The identity that created the resource.	string Optional
createdByType	The type of identity that created the resource.	SystemData_CreatedByType_STATUS Optional
lastModifiedAt	The timestamp of resource last modification (UTC)	string Optional
lastModifiedBy	The identity that last modified the resource.	string Optional
lastModifiedByType	The type of identity that last modified the resource.	SystemData_LastModifiedByType_STATUS Optional

WorkspaceConnectionProps_ValueFormat

Used by: WorkspacesConnection_Spec.

Value	Description
“JSON”

WorkspaceConnectionProps_ValueFormat_STATUS

Used by: WorkspacesConnection_STATUS.

Value	Description
“JSON”

WorkspaceOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: Workspace_Spec.

Property	Description	Type
configMapExpressions	configures where to place operator written dynamic ConfigMaps (created with CEL expressions).	core.DestinationExpression[] Optional
secretExpressions	configures where to place operator written dynamic secrets (created with CEL expressions).	core.DestinationExpression[] Optional
secrets	configures where to place Azure generated secrets.	WorkspaceOperatorSecrets Optional

WorkspaceProperties_ProvisioningState_STATUS

Used by: Workspace_STATUS.

Value	Description
“Canceled”
“Creating”
“Deleting”
“Failed”
“Succeeded”
“Unknown”
“Updating”

WorkspaceProperties_PublicNetworkAccess

Used by: Workspace_Spec.

Value	Description
“Disabled”
“Enabled”

WorkspaceProperties_PublicNetworkAccess_STATUS

Used by: Workspace_STATUS.

Value	Description
“Disabled”
“Enabled”

WorkspacesComputeOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: WorkspacesCompute_Spec.

Property	Description	Type
configMapExpressions	configures where to place operator written dynamic ConfigMaps (created with CEL expressions).	core.DestinationExpression[] Optional
secretExpressions	configures where to place operator written dynamic secrets (created with CEL expressions).	core.DestinationExpression[] Optional

WorkspacesConnectionOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: WorkspacesConnection_Spec.

Property	Description	Type
configMapExpressions	configures where to place operator written dynamic ConfigMaps (created with CEL expressions).	core.DestinationExpression[] Optional
secretExpressions	configures where to place operator written dynamic secrets (created with CEL expressions).	core.DestinationExpression[] Optional

AKS

Used by: Compute.

Property	Description	Type
computeLocation	Location for the underlying compute	string Optional
computeType	The type of compute	AKS_ComputeType Required
description	The description of the Machine Learning compute.	string Optional
disableLocalAuth	Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.	bool Optional
properties	AKS properties	AKS_Properties Optional
resourceReference	ARM resource id of the underlying compute	genruntime.ResourceReference Optional

AKS_STATUS

Used by: Compute_STATUS.

Property	Description	Type
computeLocation	Location for the underlying compute	string Optional
computeType	The type of compute	AKS_ComputeType_STATUS Optional
createdOn	The time at which the compute was created.	string Optional
description	The description of the Machine Learning compute.	string Optional
disableLocalAuth	Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.	bool Optional
isAttachedCompute	Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.	bool Optional
modifiedOn	The time at which the compute was last modified.	string Optional
properties	AKS properties	AKS_Properties_STATUS Optional
provisioningErrors	Errors during provisioning	ErrorResponse_STATUS[] Optional
provisioningState	The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.	AKS_ProvisioningState_STATUS Optional
resourceId	ARM resource id of the underlying compute	string Optional

AmlCompute

Used by: Compute.

Property	Description	Type
computeLocation	Location for the underlying compute	string Optional
computeType	The type of compute	AmlCompute_ComputeType Required
description	The description of the Machine Learning compute.	string Optional
disableLocalAuth	Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.	bool Optional
properties	Properties of AmlCompute	AmlComputeProperties Optional
resourceReference	ARM resource id of the underlying compute	genruntime.ResourceReference Optional

AmlCompute_STATUS

Used by: Compute_STATUS.

Property	Description	Type
computeLocation	Location for the underlying compute	string Optional
computeType	The type of compute	AmlCompute_ComputeType_STATUS Optional
createdOn	The time at which the compute was created.	string Optional
description	The description of the Machine Learning compute.	string Optional
disableLocalAuth	Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.	bool Optional
isAttachedCompute	Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.	bool Optional
modifiedOn	The time at which the compute was last modified.	string Optional
properties	Properties of AmlCompute	AmlComputeProperties_STATUS Optional
provisioningErrors	Errors during provisioning	ErrorResponse_STATUS[] Optional
provisioningState	The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.	AmlCompute_ProvisioningState_STATUS Optional
resourceId	ARM resource id of the underlying compute	string Optional

ComputeInstance

Used by: Compute.

Property	Description	Type
computeLocation	Location for the underlying compute	string Optional
computeType	The type of compute	ComputeInstance_ComputeType Required
description	The description of the Machine Learning compute.	string Optional
disableLocalAuth	Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.	bool Optional
properties	Properties of ComputeInstance	ComputeInstanceProperties Optional
resourceReference	ARM resource id of the underlying compute	genruntime.ResourceReference Optional

ComputeInstance_STATUS

Used by: Compute_STATUS.

Property	Description	Type
computeLocation	Location for the underlying compute	string Optional
computeType	The type of compute	ComputeInstance_ComputeType_STATUS Optional
createdOn	The time at which the compute was created.	string Optional
description	The description of the Machine Learning compute.	string Optional
disableLocalAuth	Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.	bool Optional
isAttachedCompute	Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.	bool Optional
modifiedOn	The time at which the compute was last modified.	string Optional
properties	Properties of ComputeInstance	ComputeInstanceProperties_STATUS Optional
provisioningErrors	Errors during provisioning	ErrorResponse_STATUS[] Optional
provisioningState	The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.	ComputeInstance_ProvisioningState_STATUS Optional
resourceId	ARM resource id of the underlying compute	string Optional

CosmosDbSettings

Used by: ServiceManagedResourcesSettings.

Property	Description	Type
collectionsThroughput	The throughput of the collections in cosmosdb database	int Optional

CosmosDbSettings_STATUS

Used by: ServiceManagedResourcesSettings_STATUS.

Property	Description	Type
collectionsThroughput	The throughput of the collections in cosmosdb database	int Optional

Databricks

Used by: Compute.

Property	Description	Type
computeLocation	Location for the underlying compute	string Optional
computeType	The type of compute	Databricks_ComputeType Required
description	The description of the Machine Learning compute.	string Optional
disableLocalAuth	Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.	bool Optional
properties	Properties of Databricks	DatabricksProperties Optional
resourceReference	ARM resource id of the underlying compute	genruntime.ResourceReference Optional

Databricks_STATUS

Used by: Compute_STATUS.

Property	Description	Type
computeLocation	Location for the underlying compute	string Optional
computeType	The type of compute	Databricks_ComputeType_STATUS Optional
createdOn	The time at which the compute was created.	string Optional
description	The description of the Machine Learning compute.	string Optional
disableLocalAuth	Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.	bool Optional
isAttachedCompute	Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.	bool Optional
modifiedOn	The time at which the compute was last modified.	string Optional
properties	Properties of Databricks	DatabricksProperties_STATUS Optional
provisioningErrors	Errors during provisioning	ErrorResponse_STATUS[] Optional
provisioningState	The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.	Databricks_ProvisioningState_STATUS Optional
resourceId	ARM resource id of the underlying compute	string Optional

DataFactory

Used by: Compute.

Property	Description	Type
computeLocation	Location for the underlying compute	string Optional
computeType	The type of compute	DataFactory_ComputeType Required
description	The description of the Machine Learning compute.	string Optional
disableLocalAuth	Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.	bool Optional
resourceReference	ARM resource id of the underlying compute	genruntime.ResourceReference Optional

DataFactory_STATUS

Used by: Compute_STATUS.

Property	Description	Type
computeLocation	Location for the underlying compute	string Optional
computeType	The type of compute	DataFactory_ComputeType_STATUS Optional
createdOn	The time at which the compute was created.	string Optional
description	The description of the Machine Learning compute.	string Optional
disableLocalAuth	Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.	bool Optional
isAttachedCompute	Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.	bool Optional
modifiedOn	The time at which the compute was last modified.	string Optional
provisioningErrors	Errors during provisioning	ErrorResponse_STATUS[] Optional
provisioningState	The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.	DataFactory_ProvisioningState_STATUS Optional
resourceId	ARM resource id of the underlying compute	string Optional

DataLakeAnalytics

Used by: Compute.

Property	Description	Type
computeLocation	Location for the underlying compute	string Optional
computeType	The type of compute	DataLakeAnalytics_ComputeType Required
description	The description of the Machine Learning compute.	string Optional
disableLocalAuth	Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.	bool Optional
properties		DataLakeAnalytics_Properties Optional
resourceReference	ARM resource id of the underlying compute	genruntime.ResourceReference Optional

DataLakeAnalytics_STATUS

Used by: Compute_STATUS.

Property	Description	Type
computeLocation	Location for the underlying compute	string Optional
computeType	The type of compute	DataLakeAnalytics_ComputeType_STATUS Optional
createdOn	The time at which the compute was created.	string Optional
description	The description of the Machine Learning compute.	string Optional
disableLocalAuth	Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.	bool Optional
isAttachedCompute	Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.	bool Optional
modifiedOn	The time at which the compute was last modified.	string Optional
properties		DataLakeAnalytics_Properties_STATUS Optional
provisioningErrors	Errors during provisioning	ErrorResponse_STATUS[] Optional
provisioningState	The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.	DataLakeAnalytics_ProvisioningState_STATUS Optional
resourceId	ARM resource id of the underlying compute	string Optional

EncryptionProperty_Status_STATUS

Used by: EncryptionProperty_STATUS.

Value	Description
“Disabled”
“Enabled”

HDInsight

Used by: Compute.

Property	Description	Type
computeLocation	Location for the underlying compute	string Optional
computeType	The type of compute	HDInsight_ComputeType Required
description	The description of the Machine Learning compute.	string Optional
disableLocalAuth	Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.	bool Optional
properties	HDInsight compute properties	HDInsightProperties Optional
resourceReference	ARM resource id of the underlying compute	genruntime.ResourceReference Optional

HDInsight_STATUS

Used by: Compute_STATUS.

Property	Description	Type
computeLocation	Location for the underlying compute	string Optional
computeType	The type of compute	HDInsight_ComputeType_STATUS Optional
createdOn	The time at which the compute was created.	string Optional
description	The description of the Machine Learning compute.	string Optional
disableLocalAuth	Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.	bool Optional
isAttachedCompute	Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.	bool Optional
modifiedOn	The time at which the compute was last modified.	string Optional
properties	HDInsight compute properties	HDInsightProperties_STATUS Optional
provisioningErrors	Errors during provisioning	ErrorResponse_STATUS[] Optional
provisioningState	The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.	HDInsight_ProvisioningState_STATUS Optional
resourceId	ARM resource id of the underlying compute	string Optional

Identity_Type

Used by: Identity.

Value	Description
“None”
“SystemAssigned”
“SystemAssigned,UserAssigned”
“UserAssigned”

Identity_Type_STATUS

Used by: Identity_STATUS.

Value	Description
“None”
“SystemAssigned”
“SystemAssigned,UserAssigned”
“UserAssigned”

IdentityForCmk

Identity that will be used to access key vault for encryption at rest

Used by: EncryptionProperty.

Property	Description	Type
userAssignedIdentity	The ArmId of the user assigned identity that will be used to access the customer managed key vault	string Optional

IdentityForCmk_STATUS

Identity that will be used to access key vault for encryption at rest

Used by: EncryptionProperty_STATUS.

Property	Description	Type
userAssignedIdentity	The ArmId of the user assigned identity that will be used to access the customer managed key vault	string Optional

KeyVaultProperties

Used by: EncryptionProperty.

Property	Description	Type
identityClientId	For future use - The client id of the identity which will be used to access key vault.	string Optional
keyIdentifier	Key vault uri to access the encryption key.	string Required
keyVaultArmId	The ArmId of the keyVault where the customer owned encryption key is present.	string Required

KeyVaultProperties_STATUS

Used by: EncryptionProperty_STATUS.

Property	Description	Type
identityClientId	For future use - The client id of the identity which will be used to access key vault.	string Optional
keyIdentifier	Key vault uri to access the encryption key.	string Optional
keyVaultArmId	The ArmId of the keyVault where the customer owned encryption key is present.	string Optional

Kubernetes

Used by: Compute.

Property	Description	Type
computeLocation	Location for the underlying compute	string Optional
computeType	The type of compute	Kubernetes_ComputeType Required
description	The description of the Machine Learning compute.	string Optional
disableLocalAuth	Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.	bool Optional
properties	Properties of Kubernetes	KubernetesProperties Optional
resourceReference	ARM resource id of the underlying compute	genruntime.ResourceReference Optional

Kubernetes_STATUS

Used by: Compute_STATUS.

Property	Description	Type
computeLocation	Location for the underlying compute	string Optional
computeType	The type of compute	Kubernetes_ComputeType_STATUS Optional
createdOn	The time at which the compute was created.	string Optional
description	The description of the Machine Learning compute.	string Optional
disableLocalAuth	Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.	bool Optional
isAttachedCompute	Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.	bool Optional
modifiedOn	The time at which the compute was last modified.	string Optional
properties	Properties of Kubernetes	KubernetesProperties_STATUS Optional
provisioningErrors	Errors during provisioning	ErrorResponse_STATUS[] Optional
provisioningState	The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.	Kubernetes_ProvisioningState_STATUS Optional
resourceId	ARM resource id of the underlying compute	string Optional

NotebookPreparationError_STATUS

Used by: NotebookResourceInfo_STATUS.

Property	Description	Type
errorMessage		string Optional
statusCode		int Optional

PrivateEndpointServiceConnectionStatus

The private endpoint connection status.

Used by: SharedPrivateLinkResource.

Value	Description
“Approved”
“Disconnected”
“Pending”
“Rejected”
“Timeout”

PrivateEndpointServiceConnectionStatus_STATUS

The private endpoint connection status.

Used by: SharedPrivateLinkResource_STATUS.

Value	Description
“Approved”
“Disconnected”
“Pending”
“Rejected”
“Timeout”

SynapseSpark

Used by: Compute.

Property	Description	Type
computeLocation	Location for the underlying compute	string Optional
computeType	The type of compute	SynapseSpark_ComputeType Required
description	The description of the Machine Learning compute.	string Optional
disableLocalAuth	Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.	bool Optional
properties		SynapseSpark_Properties Optional
resourceReference	ARM resource id of the underlying compute	genruntime.ResourceReference Optional

SynapseSpark_STATUS

Used by: Compute_STATUS.

Property	Description	Type
computeLocation	Location for the underlying compute	string Optional
computeType	The type of compute	SynapseSpark_ComputeType_STATUS Optional
createdOn	The time at which the compute was created.	string Optional
description	The description of the Machine Learning compute.	string Optional
disableLocalAuth	Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.	bool Optional
isAttachedCompute	Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.	bool Optional
modifiedOn	The time at which the compute was last modified.	string Optional
properties		SynapseSpark_Properties_STATUS Optional
provisioningErrors	Errors during provisioning	ErrorResponse_STATUS[] Optional
provisioningState	The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.	SynapseSpark_ProvisioningState_STATUS Optional
resourceId	ARM resource id of the underlying compute	string Optional

SystemData_CreatedByType

Used by: SystemData.

Value	Description
“Application”
“Key”
“ManagedIdentity”
“User”

SystemData_CreatedByType_STATUS

Used by: SystemData_STATUS.

Value	Description
“Application”
“Key”
“ManagedIdentity”
“User”

SystemData_LastModifiedByType

Used by: SystemData.

Value	Description
“Application”
“Key”
“ManagedIdentity”
“User”

SystemData_LastModifiedByType_STATUS

Used by: SystemData_STATUS.

Value	Description
“Application”
“Key”
“ManagedIdentity”
“User”

UserAssignedIdentity_STATUS

User Assigned Identity

Used by: Identity_STATUS.

Property	Description	Type
clientId	The clientId(aka appId) of the user assigned identity.	string Optional
principalId	The principal ID of the user assigned identity.	string Optional
tenantId	The tenant ID of the user assigned identity.	string Optional

UserAssignedIdentityDetails

Information about the user assigned identity for the resource

Used by: Identity.

Property	Description	Type
reference		genruntime.ResourceReference Optional

VirtualMachine

Used by: Compute.

Property	Description	Type
computeLocation	Location for the underlying compute	string Optional
computeType	The type of compute	VirtualMachine_ComputeType Required
description	The description of the Machine Learning compute.	string Optional
disableLocalAuth	Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.	bool Optional
properties		VirtualMachine_Properties Optional
resourceReference	ARM resource id of the underlying compute	genruntime.ResourceReference Optional

VirtualMachine_STATUS

Used by: Compute_STATUS.

Property	Description	Type
computeLocation	Location for the underlying compute	string Optional
computeType	The type of compute	VirtualMachine_ComputeType_STATUS Optional
createdOn	The time at which the compute was created.	string Optional
description	The description of the Machine Learning compute.	string Optional
disableLocalAuth	Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.	bool Optional
isAttachedCompute	Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.	bool Optional
modifiedOn	The time at which the compute was last modified.	string Optional
properties		VirtualMachine_Properties_STATUS Optional
provisioningErrors	Errors during provisioning	ErrorResponse_STATUS[] Optional
provisioningState	The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.	VirtualMachine_ProvisioningState_STATUS Optional
resourceId	ARM resource id of the underlying compute	string Optional

WorkspaceOperatorSecrets

Used by: WorkspaceOperatorSpec.

Property	Description	Type
appInsightsInstrumentationKey	indicates where the AppInsightsInstrumentationKey secret should be placed. If omitted, the secret will not be retrieved from Azure.	genruntime.SecretDestination Optional
containerRegistryPassword	indicates where the ContainerRegistryPassword secret should be placed. If omitted, the secret will not be retrieved from Azure.	genruntime.SecretDestination Optional
containerRegistryPassword2	indicates where the ContainerRegistryPassword2 secret should be placed. If omitted, the secret will not be retrieved from Azure.	genruntime.SecretDestination Optional
containerRegistryUserName	indicates where the ContainerRegistryUserName secret should be placed. If omitted, the secret will not be retrieved from Azure.	genruntime.SecretDestination Optional
primaryNotebookAccessKey	indicates where the PrimaryNotebookAccessKey secret should be placed. If omitted, the secret will not be retrieved from Azure.	genruntime.SecretDestination Optional
secondaryNotebookAccessKey	indicates where the SecondaryNotebookAccessKey secret should be placed. If omitted, the secret will not be retrieved from Azure.	genruntime.SecretDestination Optional
userStorageKey	indicates where the UserStorageKey secret should be placed. If omitted, the secret will not be retrieved from Azure.	genruntime.SecretDestination Optional

AKS_ComputeType

Used by: AKS.

Value	Description
“AKS”

AKS_ComputeType_STATUS

Used by: AKS_STATUS.

Value	Description
“AKS”

AKS_Properties

Used by: AKS.

Property	Description	Type
agentCount	Number of agents	int Optional
agentVmSize	Agent virtual machine size	string Optional
aksNetworkingConfiguration	AKS networking configuration for vnet	AksNetworkingConfiguration Optional
clusterFqdn	Cluster full qualified domain name	string Optional
clusterPurpose	Intended usage of the cluster	AKS_Properties_ClusterPurpose Optional
loadBalancerSubnet	Load Balancer Subnet	string Optional
loadBalancerType	Load Balancer Type	AKS_Properties_LoadBalancerType Optional
sslConfiguration	SSL configuration	SslConfiguration Optional

AKS_Properties_STATUS

Used by: AKS_STATUS.

Property	Description	Type
agentCount	Number of agents	int Optional
agentVmSize	Agent virtual machine size	string Optional
aksNetworkingConfiguration	AKS networking configuration for vnet	AksNetworkingConfiguration_STATUS Optional
clusterFqdn	Cluster full qualified domain name	string Optional
clusterPurpose	Intended usage of the cluster	AKS_Properties_ClusterPurpose_STATUS Optional
loadBalancerSubnet	Load Balancer Subnet	string Optional
loadBalancerType	Load Balancer Type	AKS_Properties_LoadBalancerType_STATUS Optional
sslConfiguration	SSL configuration	SslConfiguration_STATUS Optional
systemServices	System services	SystemService_STATUS[] Optional

AKS_ProvisioningState_STATUS

Used by: AKS_STATUS.

Value	Description
“Canceled”
“Creating”
“Deleting”
“Failed”
“Succeeded”
“Unknown”
“Updating”

AmlCompute_ComputeType

Used by: AmlCompute.

Value	Description
“AmlCompute”

AmlCompute_ComputeType_STATUS

Used by: AmlCompute_STATUS.

Value	Description
“AmlCompute”

AmlCompute_ProvisioningState_STATUS

Used by: AmlCompute_STATUS.

Value	Description
“Canceled”
“Creating”
“Deleting”
“Failed”
“Succeeded”
“Unknown”
“Updating”

AmlComputeProperties

AML Compute properties

Used by: AmlCompute.

Property	Description	Type
enableNodePublicIp	Enable or disable node public IP address provisioning. Possible values are: Possible values are: true - Indicates that the compute nodes will have public IPs provisioned. false - Indicates that the compute nodes will have a private endpoint and no public IPs.	bool Optional
isolatedNetwork	Network is isolated or not	bool Optional
osType	Compute OS Type	AmlComputeProperties_OsType Optional
remoteLoginPortPublicAccess	State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on all nodes of the cluster. Enabled - Indicates that the public ssh port is open on all nodes of the cluster. NotSpecified - Indicates that the public ssh port is closed on all nodes of the cluster if VNet is defined, else is open all public nodes. It can be default only during cluster creation time, after creation it will be either enabled or disabled.	AmlComputeProperties_RemoteLoginPortPublicAccess Optional
scaleSettings	Scale settings for AML Compute	ScaleSettings Optional
subnet	Virtual network subnet resource ID the compute nodes belong to.	ResourceId Optional
userAccountCredentials	Credentials for an administrator user account that will be created on each compute node.	UserAccountCredentials Optional
virtualMachineImage	Virtual Machine image for AML Compute - windows only	VirtualMachineImage Optional
vmPriority	Virtual Machine priority	AmlComputeProperties_VmPriority Optional
vmSize	Virtual Machine Size	string Optional

AmlComputeProperties_STATUS

AML Compute properties

Used by: AmlCompute_STATUS.

Property	Description	Type
allocationState	Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute.	AmlComputeProperties_AllocationState_STATUS Optional
allocationStateTransitionTime	The time at which the compute entered its current allocation state.	string Optional
currentNodeCount	The number of compute nodes currently assigned to the compute.	int Optional
enableNodePublicIp	Enable or disable node public IP address provisioning. Possible values are: Possible values are: true - Indicates that the compute nodes will have public IPs provisioned. false - Indicates that the compute nodes will have a private endpoint and no public IPs.	bool Optional
errors	Collection of errors encountered by various compute nodes during node setup.	ErrorResponse_STATUS[] Optional
isolatedNetwork	Network is isolated or not	bool Optional
nodeStateCounts	Counts of various node states on the compute.	NodeStateCounts_STATUS Optional
osType	Compute OS Type	AmlComputeProperties_OsType_STATUS Optional
remoteLoginPortPublicAccess	State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on all nodes of the cluster. Enabled - Indicates that the public ssh port is open on all nodes of the cluster. NotSpecified - Indicates that the public ssh port is closed on all nodes of the cluster if VNet is defined, else is open all public nodes. It can be default only during cluster creation time, after creation it will be either enabled or disabled.	AmlComputeProperties_RemoteLoginPortPublicAccess_STATUS Optional
scaleSettings	Scale settings for AML Compute	ScaleSettings_STATUS Optional
subnet	Virtual network subnet resource ID the compute nodes belong to.	ResourceId_STATUS Optional
targetNodeCount	The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation.	int Optional
userAccountCredentials	Credentials for an administrator user account that will be created on each compute node.	UserAccountCredentials_STATUS Optional
virtualMachineImage	Virtual Machine image for AML Compute - windows only	VirtualMachineImage_STATUS Optional
vmPriority	Virtual Machine priority	AmlComputeProperties_VmPriority_STATUS Optional
vmSize	Virtual Machine Size	string Optional

ComputeInstance_ComputeType

Used by: ComputeInstance.

Value	Description
“ComputeInstance”

ComputeInstance_ComputeType_STATUS

Used by: ComputeInstance_STATUS.

Value	Description
“ComputeInstance”

ComputeInstance_ProvisioningState_STATUS

Used by: ComputeInstance_STATUS.

Value	Description
“Canceled”
“Creating”
“Deleting”
“Failed”
“Succeeded”
“Unknown”
“Updating”

ComputeInstanceProperties

Compute Instance properties

Used by: ComputeInstance.

Property	Description	Type
applicationSharingPolicy	Policy for sharing applications on this compute instance among users of parent workspace. If Personal, only the creator can access applications on this compute instance. When Shared, any workspace user can access applications on this instance depending on his/her assigned role.	ComputeInstanceProperties_ApplicationSharingPolicy Optional
computeInstanceAuthorizationType	The Compute Instance Authorization type. Available values are personal (default).	ComputeInstanceProperties_ComputeInstanceAuthorizationType Optional
personalComputeInstanceSettings	Settings for a personal compute instance.	PersonalComputeInstanceSettings Optional
setupScripts	Details of customized scripts to execute for setting up the cluster.	SetupScripts Optional
sshSettings	Specifies policy and settings for SSH access.	ComputeInstanceSshSettings Optional
subnet	Virtual network subnet resource ID the compute nodes belong to.	ResourceId Optional
vmSize	Virtual Machine Size	string Optional

ComputeInstanceProperties_STATUS

Compute Instance properties

Used by: ComputeInstance_STATUS.

Property	Description	Type
applications	Describes available applications and their endpoints on this ComputeInstance.	ComputeInstanceApplication_STATUS[] Optional
applicationSharingPolicy	Policy for sharing applications on this compute instance among users of parent workspace. If Personal, only the creator can access applications on this compute instance. When Shared, any workspace user can access applications on this instance depending on his/her assigned role.	ComputeInstanceProperties_ApplicationSharingPolicy_STATUS Optional
computeInstanceAuthorizationType	The Compute Instance Authorization type. Available values are personal (default).	ComputeInstanceProperties_ComputeInstanceAuthorizationType_STATUS Optional
connectivityEndpoints	Describes all connectivity endpoints available for this ComputeInstance.	ComputeInstanceConnectivityEndpoints_STATUS Optional
createdBy	Describes information on user who created this ComputeInstance.	ComputeInstanceCreatedBy_STATUS Optional
errors	Collection of errors encountered on this ComputeInstance.	ErrorResponse_STATUS[] Optional
lastOperation	The last operation on ComputeInstance.	ComputeInstanceLastOperation_STATUS Optional
personalComputeInstanceSettings	Settings for a personal compute instance.	PersonalComputeInstanceSettings_STATUS Optional
setupScripts	Details of customized scripts to execute for setting up the cluster.	SetupScripts_STATUS Optional
sshSettings	Specifies policy and settings for SSH access.	ComputeInstanceSshSettings_STATUS Optional
state	The current state of this ComputeInstance.	ComputeInstanceState_STATUS Optional
subnet	Virtual network subnet resource ID the compute nodes belong to.	ResourceId_STATUS Optional
vmSize	Virtual Machine Size	string Optional

Databricks_ComputeType

Used by: Databricks.

Value	Description
“Databricks”

Databricks_ComputeType_STATUS

Used by: Databricks_STATUS.

Value	Description
“Databricks”

Databricks_ProvisioningState_STATUS

Used by: Databricks_STATUS.

Value	Description
“Canceled”
“Creating”
“Deleting”
“Failed”
“Succeeded”
“Unknown”
“Updating”

DatabricksProperties

Properties of Databricks

Used by: Databricks.

Property	Description	Type
databricksAccessToken	Databricks access token	genruntime.SecretReference Optional
workspaceUrl	Workspace Url	string Optional

DatabricksProperties_STATUS

Properties of Databricks

Used by: Databricks_STATUS.

Property	Description	Type
workspaceUrl	Workspace Url	string Optional

DataFactory_ComputeType

Used by: DataFactory.

Value	Description
“DataFactory”

DataFactory_ComputeType_STATUS

Used by: DataFactory_STATUS.

Value	Description
“DataFactory”

DataFactory_ProvisioningState_STATUS

Used by: DataFactory_STATUS.

Value	Description
“Canceled”
“Creating”
“Deleting”
“Failed”
“Succeeded”
“Unknown”
“Updating”

DataLakeAnalytics_ComputeType

Used by: DataLakeAnalytics.

Value	Description
“DataLakeAnalytics”

DataLakeAnalytics_ComputeType_STATUS

Used by: DataLakeAnalytics_STATUS.

Value	Description
“DataLakeAnalytics”

DataLakeAnalytics_Properties

Used by: DataLakeAnalytics.

Property	Description	Type
dataLakeStoreAccountName	DataLake Store Account Name	string Optional

DataLakeAnalytics_Properties_STATUS

Used by: DataLakeAnalytics_STATUS.

Property	Description	Type
dataLakeStoreAccountName	DataLake Store Account Name	string Optional

DataLakeAnalytics_ProvisioningState_STATUS

Used by: DataLakeAnalytics_STATUS.

Value	Description
“Canceled”
“Creating”
“Deleting”
“Failed”
“Succeeded”
“Unknown”
“Updating”

ErrorResponse_STATUS

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Used by: AKS_STATUS, AmlCompute_STATUS, AmlComputeProperties_STATUS, ComputeInstance_STATUS, ComputeInstanceProperties_STATUS, Databricks_STATUS, DataFactory_STATUS, DataLakeAnalytics_STATUS, HDInsight_STATUS, Kubernetes_STATUS, SynapseSpark_STATUS, and VirtualMachine_STATUS.

Property	Description	Type
error	The error object.	ErrorDetail_STATUS Optional

HDInsight_ComputeType

Used by: HDInsight.

Value	Description
“HDInsight”

HDInsight_ComputeType_STATUS

Used by: HDInsight_STATUS.

Value	Description
“HDInsight”

HDInsight_ProvisioningState_STATUS

Used by: HDInsight_STATUS.

Value	Description
“Canceled”
“Creating”
“Deleting”
“Failed”
“Succeeded”
“Unknown”
“Updating”

HDInsightProperties

HDInsight compute properties

Used by: HDInsight.

Property	Description	Type
address	Public IP address of the master node of the cluster.	string Optional
administratorAccount	Admin credentials for master node of the cluster	VirtualMachineSshCredentials Optional
sshPort	Port open for ssh connections on the master node of the cluster.	int Optional

HDInsightProperties_STATUS

HDInsight compute properties

Used by: HDInsight_STATUS.

Property	Description	Type
address	Public IP address of the master node of the cluster.	string Optional
administratorAccount	Admin credentials for master node of the cluster	VirtualMachineSshCredentials_STATUS Optional
sshPort	Port open for ssh connections on the master node of the cluster.	int Optional

Kubernetes_ComputeType

Used by: Kubernetes.

Value	Description
“Kubernetes”

Kubernetes_ComputeType_STATUS

Used by: Kubernetes_STATUS.

Value	Description
“Kubernetes”

Kubernetes_ProvisioningState_STATUS

Used by: Kubernetes_STATUS.

Value	Description
“Canceled”
“Creating”
“Deleting”
“Failed”
“Succeeded”
“Unknown”
“Updating”

KubernetesProperties

Kubernetes properties

Used by: Kubernetes.

Property	Description	Type
defaultInstanceType	Default instance type	string Optional
extensionInstanceReleaseTrain	Extension instance release train.	string Optional
extensionPrincipalId	Extension principal-id.	string Optional
instanceTypes	Instance Type Schema	map[string]InstanceTypeSchema Optional
namespace	Compute namespace	string Optional
relayConnectionString	Relay connection string.	genruntime.SecretReference Optional
serviceBusConnectionString	ServiceBus connection string.	genruntime.SecretReference Optional
vcName	VC name.	string Optional

KubernetesProperties_STATUS

Kubernetes properties

Used by: Kubernetes_STATUS.

Property	Description	Type
defaultInstanceType	Default instance type	string Optional
extensionInstanceReleaseTrain	Extension instance release train.	string Optional
extensionPrincipalId	Extension principal-id.	string Optional
instanceTypes	Instance Type Schema	map[string]InstanceTypeSchema_STATUS Optional
namespace	Compute namespace	string Optional
vcName	VC name.	string Optional

SynapseSpark_ComputeType

Used by: SynapseSpark.

Value	Description
“SynapseSpark”

SynapseSpark_ComputeType_STATUS

Used by: SynapseSpark_STATUS.

Value	Description
“SynapseSpark”

SynapseSpark_Properties

Used by: SynapseSpark.

Property	Description	Type
autoPauseProperties	Auto pause properties.	AutoPauseProperties Optional
autoScaleProperties	Auto scale properties.	AutoScaleProperties Optional
nodeCount	The number of compute nodes currently assigned to the compute.	int Optional
nodeSize	Node size.	string Optional
nodeSizeFamily	Node size family.	string Optional
poolName	Pool name.	string Optional
resourceGroup	Name of the resource group in which workspace is located.	string Optional
sparkVersion	Spark version.	string Optional
subscriptionId	Azure subscription identifier.	string Optional
workspaceName	Name of Azure Machine Learning workspace.	string Optional

SynapseSpark_Properties_STATUS

Used by: SynapseSpark_STATUS.

Property	Description	Type
autoPauseProperties	Auto pause properties.	AutoPauseProperties_STATUS Optional
autoScaleProperties	Auto scale properties.	AutoScaleProperties_STATUS Optional
nodeCount	The number of compute nodes currently assigned to the compute.	int Optional
nodeSize	Node size.	string Optional
nodeSizeFamily	Node size family.	string Optional
poolName	Pool name.	string Optional
resourceGroup	Name of the resource group in which workspace is located.	string Optional
sparkVersion	Spark version.	string Optional
subscriptionId	Azure subscription identifier.	string Optional
workspaceName	Name of Azure Machine Learning workspace.	string Optional

SynapseSpark_ProvisioningState_STATUS

Used by: SynapseSpark_STATUS.

Value	Description
“Canceled”
“Creating”
“Deleting”
“Failed”
“Succeeded”
“Unknown”
“Updating”

VirtualMachine_ComputeType

Used by: VirtualMachine.

Value	Description
“VirtualMachine”

VirtualMachine_ComputeType_STATUS

Used by: VirtualMachine_STATUS.

Value	Description
“VirtualMachine”

VirtualMachine_Properties

Used by: VirtualMachine.

Property	Description	Type
address	Public IP address of the virtual machine.	string Optional
administratorAccount	Admin credentials for virtual machine	VirtualMachineSshCredentials Optional
isNotebookInstanceCompute	Indicates whether this compute will be used for running notebooks.	bool Optional
sshPort	Port open for ssh connections.	int Optional
virtualMachineSize	Virtual Machine size	string Optional

VirtualMachine_Properties_STATUS

Used by: VirtualMachine_STATUS.

Property	Description	Type
address	Public IP address of the virtual machine.	string Optional
administratorAccount	Admin credentials for virtual machine	VirtualMachineSshCredentials_STATUS Optional
isNotebookInstanceCompute	Indicates whether this compute will be used for running notebooks.	bool Optional
sshPort	Port open for ssh connections.	int Optional
virtualMachineSize	Virtual Machine size	string Optional

VirtualMachine_ProvisioningState_STATUS

Used by: VirtualMachine_STATUS.

Value	Description
“Canceled”
“Creating”
“Deleting”
“Failed”
“Succeeded”
“Unknown”
“Updating”

AKS_Properties_ClusterPurpose

Used by: AKS_Properties.

Value	Description
“DenseProd”
“DevTest”
“FastProd”

AKS_Properties_ClusterPurpose_STATUS

Used by: AKS_Properties_STATUS.

Value	Description
“DenseProd”
“DevTest”
“FastProd”

AKS_Properties_LoadBalancerType

Used by: AKS_Properties.

Value	Description
“InternalLoadBalancer”
“PublicIp”

AKS_Properties_LoadBalancerType_STATUS

Used by: AKS_Properties_STATUS.

Value	Description
“InternalLoadBalancer”
“PublicIp”

AksNetworkingConfiguration

Advance configuration for AKS networking

Used by: AKS_Properties.

Property	Description	Type
dnsServiceIP	An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.	string Optional
dockerBridgeCidr	A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes service address range.	string Optional
serviceCidr	A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.	string Optional
subnetReference	Virtual network subnet resource ID the compute nodes belong to	genruntime.ResourceReference Optional

AksNetworkingConfiguration_STATUS

Advance configuration for AKS networking

Used by: AKS_Properties_STATUS.

Property	Description	Type
dnsServiceIP	An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.	string Optional
dockerBridgeCidr	A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes service address range.	string Optional
serviceCidr	A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.	string Optional
subnetId	Virtual network subnet resource ID the compute nodes belong to	string Optional

AmlComputeProperties_AllocationState_STATUS

Used by: AmlComputeProperties_STATUS.

Value	Description
“Resizing”
“Steady”

AmlComputeProperties_OsType

Used by: AmlComputeProperties.

Value	Description
“Linux”
“Windows”

AmlComputeProperties_OsType_STATUS

Used by: AmlComputeProperties_STATUS.

Value	Description
“Linux”
“Windows”

AmlComputeProperties_RemoteLoginPortPublicAccess

Used by: AmlComputeProperties.

Value	Description
“Disabled”
“Enabled”
“NotSpecified”

AmlComputeProperties_RemoteLoginPortPublicAccess_STATUS

Used by: AmlComputeProperties_STATUS.

Value	Description
“Disabled”
“Enabled”
“NotSpecified”

AmlComputeProperties_VmPriority

Used by: AmlComputeProperties.

Value	Description
“Dedicated”
“LowPriority”

AmlComputeProperties_VmPriority_STATUS

Used by: AmlComputeProperties_STATUS.

Value	Description
“Dedicated”
“LowPriority”

AutoPauseProperties

Auto pause properties

Used by: SynapseSpark_Properties.

Property	Description	Type
delayInMinutes		int Optional
enabled		bool Optional

AutoPauseProperties_STATUS

Auto pause properties

Used by: SynapseSpark_Properties_STATUS.

Property	Description	Type
delayInMinutes		int Optional
enabled		bool Optional

AutoScaleProperties

Auto scale properties

Used by: SynapseSpark_Properties.

Property	Description	Type
enabled		bool Optional
maxNodeCount		int Optional
minNodeCount		int Optional

AutoScaleProperties_STATUS

Auto scale properties

Used by: SynapseSpark_Properties_STATUS.

Property	Description	Type
enabled		bool Optional
maxNodeCount		int Optional
minNodeCount		int Optional

ComputeInstanceApplication_STATUS

Defines an Aml Instance application and its connectivity endpoint URI.

Used by: ComputeInstanceProperties_STATUS.

Property	Description	Type
displayName	Name of the ComputeInstance application.	string Optional
endpointUri	Application’ endpoint URI.	string Optional

ComputeInstanceConnectivityEndpoints_STATUS

Defines all connectivity endpoints and properties for an ComputeInstance.

Used by: ComputeInstanceProperties_STATUS.

Property	Description	Type
privateIpAddress	Private IP Address of this ComputeInstance (local to the VNET in which the compute instance is deployed).	string Optional
publicIpAddress	Public IP Address of this ComputeInstance.	string Optional

ComputeInstanceCreatedBy_STATUS

Describes information on user who created this ComputeInstance.

Used by: ComputeInstanceProperties_STATUS.

Property	Description	Type
userId	Uniquely identifies the user within his/her organization.	string Optional
userName	Name of the user.	string Optional
userOrgId	Uniquely identifies user’ Azure Active Directory organization.	string Optional

ComputeInstanceLastOperation_STATUS

The last operation on ComputeInstance.

Used by: ComputeInstanceProperties_STATUS.

Property	Description	Type
operationName	Name of the last operation.	ComputeInstanceLastOperation_OperationName_STATUS Optional
operationStatus	Operation status.	ComputeInstanceLastOperation_OperationStatus_STATUS Optional
operationTime	Time of the last operation.	string Optional

ComputeInstanceProperties_ApplicationSharingPolicy

Used by: ComputeInstanceProperties.

Value	Description
“Personal”
“Shared”

ComputeInstanceProperties_ApplicationSharingPolicy_STATUS

Used by: ComputeInstanceProperties_STATUS.

Value	Description
“Personal”
“Shared”

ComputeInstanceProperties_ComputeInstanceAuthorizationType

Used by: ComputeInstanceProperties.

Value	Description
“personal”

ComputeInstanceProperties_ComputeInstanceAuthorizationType_STATUS

Used by: ComputeInstanceProperties_STATUS.

Value	Description
“personal”

ComputeInstanceSshSettings

Specifies policy and settings for SSH access.

Used by: ComputeInstanceProperties.

Property	Description	Type
adminPublicKey	Specifies the SSH rsa public key file as a string. Use “ssh-keygen -t rsa -b 2048” to generate your SSH key pairs.	string Optional
sshPublicAccess	State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on this instance. Enabled - Indicates that the public ssh port is open and accessible according to the VNet/subnet policy if applicable.	ComputeInstanceSshSettings_SshPublicAccess Optional

ComputeInstanceSshSettings_STATUS

Specifies policy and settings for SSH access.

Used by: ComputeInstanceProperties_STATUS.

Property	Description	Type
adminPublicKey	Specifies the SSH rsa public key file as a string. Use “ssh-keygen -t rsa -b 2048” to generate your SSH key pairs.	string Optional
adminUserName	Describes the admin user name.	string Optional
sshPort	Describes the port for connecting through SSH.	int Optional
sshPublicAccess	State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on this instance. Enabled - Indicates that the public ssh port is open and accessible according to the VNet/subnet policy if applicable.	ComputeInstanceSshSettings_SshPublicAccess_STATUS Optional

ComputeInstanceState_STATUS

Current state of an ComputeInstance.

Used by: ComputeInstanceProperties_STATUS.

Value	Description
“CreateFailed”
“Creating”
“Deleting”
“JobRunning”
“Restarting”
“Running”
“SettingUp”
“SetupFailed”
“Starting”
“Stopped”
“Stopping”
“Unknown”
“Unusable”
“UserSettingUp”
“UserSetupFailed”

ErrorDetail_STATUS

The error detail.

Used by: ErrorResponse_STATUS.

Property	Description	Type
additionalInfo	The error additional info.	ErrorAdditionalInfo_STATUS[] Optional
code	The error code.	string Optional
details	The error details.	ErrorDetail_STATUS_Unrolled[] Optional
message	The error message.	string Optional
target	The error target.	string Optional

InstanceTypeSchema

Instance type schema.

Used by: KubernetesProperties.

Property	Description	Type
nodeSelector	Node Selector	map[string]string Optional
resources	Resource requests/limits for this instance type	InstanceTypeSchema_Resources Optional

InstanceTypeSchema_STATUS

Instance type schema.

Used by: KubernetesProperties_STATUS.

Property	Description	Type
nodeSelector	Node Selector	map[string]string Optional
resources	Resource requests/limits for this instance type	InstanceTypeSchema_Resources_STATUS Optional

NodeStateCounts_STATUS

Counts of various compute node states on the amlCompute.

Used by: AmlComputeProperties_STATUS.

Property	Description	Type
idleNodeCount	Number of compute nodes in idle state.	int Optional
leavingNodeCount	Number of compute nodes which are leaving the amlCompute.	int Optional
preemptedNodeCount	Number of compute nodes which are in preempted state.	int Optional
preparingNodeCount	Number of compute nodes which are being prepared.	int Optional
runningNodeCount	Number of compute nodes which are running jobs.	int Optional
unusableNodeCount	Number of compute nodes which are in unusable state.	int Optional

PersonalComputeInstanceSettings

Settings for a personal compute instance.

Used by: ComputeInstanceProperties.

Property	Description	Type
assignedUser	A user explicitly assigned to a personal compute instance.	AssignedUser Optional

PersonalComputeInstanceSettings_STATUS

Settings for a personal compute instance.

Used by: ComputeInstanceProperties_STATUS.

Property	Description	Type
assignedUser	A user explicitly assigned to a personal compute instance.	AssignedUser_STATUS Optional

ResourceId

Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.

Used by: AmlComputeProperties, and ComputeInstanceProperties.

Property	Description	Type
reference	The ID of the resource	genruntime.ResourceReference Required

ResourceId_STATUS

Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.

Used by: AmlComputeProperties_STATUS, and ComputeInstanceProperties_STATUS.

Property	Description	Type
id	The ID of the resource	string Optional

ScaleSettings

scale settings for AML Compute

Used by: AmlComputeProperties.

Property	Description	Type
maxNodeCount	Max number of nodes to use	int Required
minNodeCount	Min number of nodes to use	int Optional
nodeIdleTimeBeforeScaleDown	Node Idle Time before scaling down amlCompute. This string needs to be in the RFC Format.	string Optional

ScaleSettings_STATUS

scale settings for AML Compute

Used by: AmlComputeProperties_STATUS.

Property	Description	Type
maxNodeCount	Max number of nodes to use	int Optional
minNodeCount	Min number of nodes to use	int Optional
nodeIdleTimeBeforeScaleDown	Node Idle Time before scaling down amlCompute. This string needs to be in the RFC Format.	string Optional

SetupScripts

Details of customized scripts to execute for setting up the cluster.

Used by: ComputeInstanceProperties.

Property	Description	Type
scripts	Customized setup scripts	ScriptsToExecute Optional

SetupScripts_STATUS

Details of customized scripts to execute for setting up the cluster.

Used by: ComputeInstanceProperties_STATUS.

Property	Description	Type
scripts	Customized setup scripts	ScriptsToExecute_STATUS Optional

SslConfiguration

The ssl configuration for scoring

Used by: AKS_Properties.

Property	Description	Type
cert	Cert data	genruntime.SecretReference Optional
cname	CNAME of the cert	string Optional
key	Key data	genruntime.SecretReference Optional
leafDomainLabel	Leaf domain label of public endpoint	string Optional
overwriteExistingDomain	Indicates whether to overwrite existing domain label.	bool Optional
status	Enable or disable ssl for scoring	SslConfiguration_Status Optional

SslConfiguration_STATUS

The ssl configuration for scoring

Used by: AKS_Properties_STATUS.

Property	Description	Type
cname	CNAME of the cert	string Optional
leafDomainLabel	Leaf domain label of public endpoint	string Optional
overwriteExistingDomain	Indicates whether to overwrite existing domain label.	bool Optional
status	Enable or disable ssl for scoring	SslConfiguration_Status_STATUS Optional

SystemService_STATUS

A system service running on a compute.

Used by: AKS_Properties_STATUS.

Property	Description	Type
publicIpAddress	Public IP address	string Optional
systemServiceType	The type of this system service.	string Optional
version	The version for this type.	string Optional

UserAccountCredentials

Settings for user account that gets created on each on the nodes of a compute.

Used by: AmlComputeProperties.

Property	Description	Type
adminUserName	Name of the administrator user account which can be used to SSH to nodes.	string Required
adminUserPassword	Password of the administrator user account.	genruntime.SecretReference Optional
adminUserSshPublicKey	SSH public key of the administrator user account.	genruntime.SecretReference Optional

UserAccountCredentials_STATUS

Settings for user account that gets created on each on the nodes of a compute.

Used by: AmlComputeProperties_STATUS.

Property	Description	Type
adminUserName	Name of the administrator user account which can be used to SSH to nodes.	string Optional

VirtualMachineImage

Virtual Machine image for Windows AML Compute

Used by: AmlComputeProperties.

Property	Description	Type
reference	Virtual Machine image path	genruntime.ResourceReference Required

VirtualMachineImage_STATUS

Virtual Machine image for Windows AML Compute

Used by: AmlComputeProperties_STATUS.

Property	Description	Type
id	Virtual Machine image path	string Optional

VirtualMachineSshCredentials

Admin credentials for virtual machine

Used by: HDInsightProperties, and VirtualMachine_Properties.

Property	Description	Type
password	Password of admin account	genruntime.SecretReference Optional
privateKeyData	Private key data	genruntime.SecretReference Optional
publicKeyData	Public key data	genruntime.SecretReference Optional
username	Username of admin account	string Optional

VirtualMachineSshCredentials_STATUS

Admin credentials for virtual machine

Used by: HDInsightProperties_STATUS, and VirtualMachine_Properties_STATUS.

Property	Description	Type
username	Username of admin account	string Optional

AssignedUser

A user that can be assigned to a compute instance.

Used by: PersonalComputeInstanceSettings.

Property	Description	Type
objectId	User’s AAD Object Id.	string Required
tenantId	User’s AAD Tenant Id.	string Required

AssignedUser_STATUS

A user that can be assigned to a compute instance.

Used by: PersonalComputeInstanceSettings_STATUS.

Property	Description	Type
objectId	User’s AAD Object Id.	string Optional
tenantId	User’s AAD Tenant Id.	string Optional

ComputeInstanceLastOperation_OperationName_STATUS

Used by: ComputeInstanceLastOperation_STATUS.

Value	Description
“Create”
“Delete”
“Reimage”
“Restart”
“Start”
“Stop”

ComputeInstanceLastOperation_OperationStatus_STATUS

Used by: ComputeInstanceLastOperation_STATUS.

Value	Description
“CreateFailed”
“DeleteFailed”
“InProgress”
“ReimageFailed”
“RestartFailed”
“StartFailed”
“StopFailed”
“Succeeded”

ComputeInstanceSshSettings_SshPublicAccess

Used by: ComputeInstanceSshSettings.

Value	Description
“Disabled”
“Enabled”

ComputeInstanceSshSettings_SshPublicAccess_STATUS

Used by: ComputeInstanceSshSettings_STATUS.

Value	Description
“Disabled”
“Enabled”

ErrorAdditionalInfo_STATUS

The resource management error additional info.

Used by: ErrorDetail_STATUS, and ErrorDetail_STATUS_Unrolled.

Property	Description	Type
info	The additional info.	map[string]v1.JSON Optional
type	The additional info type.	string Optional

ErrorDetail_STATUS_Unrolled

Used by: ErrorDetail_STATUS.

Property	Description	Type
additionalInfo	The error additional info.	ErrorAdditionalInfo_STATUS[] Optional
code	The error code.	string Optional
message	The error message.	string Optional
target	The error target.	string Optional

InstanceTypeSchema_Resources

Used by: InstanceTypeSchema.

Property	Description	Type
limits	Resource limits for this instance type	map[string]string Optional
requests	Resource requests for this instance type	map[string]string Optional

InstanceTypeSchema_Resources_STATUS

Used by: InstanceTypeSchema_STATUS.

Property	Description	Type
limits	Resource limits for this instance type	map[string]string Optional
requests	Resource requests for this instance type	map[string]string Optional

ScriptsToExecute

Customized setup scripts

Used by: SetupScripts.

Property	Description	Type
creationScript	Script that’s run only once during provision of the compute.	ScriptReference Optional
startupScript	Script that’s run every time the machine starts.	ScriptReference Optional

ScriptsToExecute_STATUS

Customized setup scripts

Used by: SetupScripts_STATUS.

Property	Description	Type
creationScript	Script that’s run only once during provision of the compute.	ScriptReference_STATUS Optional
startupScript	Script that’s run every time the machine starts.	ScriptReference_STATUS Optional

SslConfiguration_Status

Used by: SslConfiguration.

Value	Description
“Auto”
“Disabled”
“Enabled”

SslConfiguration_Status_STATUS

Used by: SslConfiguration_STATUS.

Value	Description
“Auto”
“Disabled”
“Enabled”

ScriptReference

Script reference

Used by: ScriptsToExecute, and ScriptsToExecute.

Property	Description	Type
scriptArguments	Optional command line arguments passed to the script to run.	string Optional
scriptData	The location of scripts in the mounted volume.	string Optional
scriptSource	The storage source of the script: inline, workspace.	string Optional
timeout	Optional time period passed to timeout command.	string Optional

ScriptReference_STATUS

Script reference

Used by: ScriptsToExecute_STATUS, and ScriptsToExecute_STATUS.

Property	Description	Type
scriptArguments	Optional command line arguments passed to the script to run.	string Optional
scriptData	The location of scripts in the mounted volume.	string Optional
scriptSource	The storage source of the script: inline, workspace.	string Optional
timeout	Optional time period passed to timeout command.	string Optional