machinelearningservices.azure.com/v1api20240401
APIVersion
| Value | Description |
|---|---|
| “2024-04-01” |
Registry
Generator information: - Generated from: /machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-04-01/registries.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}
Used by: RegistryList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | Registry_Spec Optional |
|
| status | RegistryTrackedResource_STATUS Optional |
Registry_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 |
| discoveryUrl | Discovery URL for the Registry | string Optional |
| identity | Managed service identity (system assigned and/or user assigned identities) | ManagedServiceIdentity Optional |
| intellectualPropertyPublisher | IntellectualPropertyPublisher for the registry | string Optional |
| kind | Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. | string Optional |
| location | The geo-location where the resource lives | string Required |
| managedResourceGroup | ResourceId of the managed RG if the registry has system created resources | ArmResourceId Optional |
| mlFlowRegistryUri | MLFlow Registry URI for the Registry | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | RegistryOperatorSpec 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 |
| publicNetworkAccess | Is the Registry accessible from the internet? Possible values: “Enabled” or “Disabled” | string Optional |
| regionDetails | Details of each region the registry is in | RegistryRegionArmDetails[] Optional |
| registryPrivateEndpointConnections | Private endpoint connections info used for pending connections in private link portal | RegistryPrivateEndpointConnection[] Optional |
| sku | Sku details required for ARM contract for Autoscaling. | Sku Optional |
| tags | Resource tags. | map[string]string Optional |
RegistryTrackedResource_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| discoveryUrl | Discovery URL for the Registry | string Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| identity | Managed service identity (system assigned and/or user assigned identities) | ManagedServiceIdentity_STATUS Optional |
| intellectualPropertyPublisher | IntellectualPropertyPublisher for the registry | string Optional |
| kind | Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. | string Optional |
| location | The geo-location where the resource lives | string Optional |
| managedResourceGroup | ResourceId of the managed RG if the registry has system created resources | ArmResourceId_STATUS Optional |
| mlFlowRegistryUri | MLFlow Registry URI for the Registry | string Optional |
| name | The name of the resource | string Optional |
| publicNetworkAccess | Is the Registry accessible from the internet? Possible values: “Enabled” or “Disabled” | string Optional |
| regionDetails | Details of each region the registry is in | RegistryRegionArmDetails_STATUS[] Optional |
| registryPrivateEndpointConnections | Private endpoint connections info used for pending connections in private link portal | RegistryPrivateEndpointConnection_STATUS[] Optional |
| sku | Sku details required for ARM contract for Autoscaling. | Sku_STATUS Optional |
| systemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. | SystemData_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
RegistryList
Generator information: - Generated from: /machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-04-01/registries.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/registries/{registryName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | Registry[] Optional |
Workspace
Generator information: - Generated from: /machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-04-01/workspaceRP.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. | genruntime.ResourceReference Optional |
| associatedWorkspaces | 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 |
| containerRegistryReference | ARM id of the container registry associated with this workspace. | 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 |
| enableDataIsolation | bool Optional |
|
| encryption | The encryption settings of Azure ML workspace. | EncryptionProperty Optional |
| featureStoreSettings | Settings for feature store type workspace. | FeatureStoreSettings 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 |
| hubResourceReference | genruntime.ResourceReference Optional |
|
| identity | The identity of the resource. | ManagedServiceIdentity 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 |
| kind | string Optional |
|
| location | Specifies the location of the resource. | string Optional |
| managedNetwork | Managed Network settings for a machine learning workspace. | ManagedNetworkSettings 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 |
| serverlessComputeSettings | Settings for serverless compute created in the workspace | ServerlessComputeSettings 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 |
| tags | Contains resource tags defined as key/value pairs. | map[string]string Optional |
| v1LegacyMode | Enabling v1_legacy_mode may prevent you from using features provided by the v2 API. | bool Optional |
| workspaceHubConfig | WorkspaceHub’s configuration object. | WorkspaceHubConfig 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. | string Optional |
| associatedWorkspaces | string[] Optional |
|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| containerRegistry | ARM id of the container registry associated with this workspace. | 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 |
| enableDataIsolation | bool Optional |
|
| encryption | The encryption settings of Azure ML workspace. | EncryptionProperty_STATUS Optional |
| featureStoreSettings | Settings for feature store type workspace. | FeatureStoreSettings_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 |
| hubResourceId | string 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. | ManagedServiceIdentity_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 |
| kind | string Optional |
|
| location | Specifies the location of the resource. | string Optional |
| managedNetwork | Managed Network settings for a machine learning workspace. | ManagedNetworkSettings_STATUS 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 |
| serverlessComputeSettings | Settings for serverless compute created in the workspace | ServerlessComputeSettings_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 | Azure Resource Manager metadata containing createdBy and modifiedBy information. | 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 |
| v1LegacyMode | Enabling v1_legacy_mode may prevent you from using features provided by the v2 API. | bool Optional |
| workspaceHubConfig | WorkspaceHub’s configuration object. | WorkspaceHubConfig_STATUS Optional |
| workspaceId | The immutable id associated with this workspace. | string Optional |
WorkspaceList
Generator information: - Generated from: /machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-04-01/workspaceRP.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/2024-04-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. | ManagedServiceIdentity 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 |
| 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. | ManagedServiceIdentity_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 | Azure Resource Manager metadata containing createdBy and modifiedBy information. | 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/2024-04-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/2024-04-01/workspaceRP.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 |
|---|---|---|
| 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 |
| 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 |
| properties | WorkspaceConnectionPropertiesV2 Required |
WorkspacesConnection_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 |
| name | The name of the resource | string Optional |
| properties | WorkspaceConnectionPropertiesV2_STATUS Optional |
|
| systemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. | SystemData_STATUS Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
WorkspacesConnectionList
Generator information: - Generated from: /machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2024-04-01/workspaceRP.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | WorkspacesConnection[] Optional |
Registry_Spec
Used by: Registry.
| 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 |
| discoveryUrl | Discovery URL for the Registry | string Optional |
| identity | Managed service identity (system assigned and/or user assigned identities) | ManagedServiceIdentity Optional |
| intellectualPropertyPublisher | IntellectualPropertyPublisher for the registry | string Optional |
| kind | Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. | string Optional |
| location | The geo-location where the resource lives | string Required |
| managedResourceGroup | ResourceId of the managed RG if the registry has system created resources | ArmResourceId Optional |
| mlFlowRegistryUri | MLFlow Registry URI for the Registry | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | RegistryOperatorSpec 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 |
| publicNetworkAccess | Is the Registry accessible from the internet? Possible values: “Enabled” or “Disabled” | string Optional |
| regionDetails | Details of each region the registry is in | RegistryRegionArmDetails[] Optional |
| registryPrivateEndpointConnections | Private endpoint connections info used for pending connections in private link portal | RegistryPrivateEndpointConnection[] Optional |
| sku | Sku details required for ARM contract for Autoscaling. | Sku Optional |
| tags | Resource tags. | map[string]string Optional |
RegistryTrackedResource_STATUS
Used by: Registry.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| discoveryUrl | Discovery URL for the Registry | string Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| identity | Managed service identity (system assigned and/or user assigned identities) | ManagedServiceIdentity_STATUS Optional |
| intellectualPropertyPublisher | IntellectualPropertyPublisher for the registry | string Optional |
| kind | Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. | string Optional |
| location | The geo-location where the resource lives | string Optional |
| managedResourceGroup | ResourceId of the managed RG if the registry has system created resources | ArmResourceId_STATUS Optional |
| mlFlowRegistryUri | MLFlow Registry URI for the Registry | string Optional |
| name | The name of the resource | string Optional |
| publicNetworkAccess | Is the Registry accessible from the internet? Possible values: “Enabled” or “Disabled” | string Optional |
| regionDetails | Details of each region the registry is in | RegistryRegionArmDetails_STATUS[] Optional |
| registryPrivateEndpointConnections | Private endpoint connections info used for pending connections in private link portal | RegistryPrivateEndpointConnection_STATUS[] Optional |
| sku | Sku details required for ARM contract for Autoscaling. | Sku_STATUS Optional |
| systemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. | SystemData_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string 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. | genruntime.ResourceReference Optional |
| associatedWorkspaces | 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 |
| containerRegistryReference | ARM id of the container registry associated with this workspace. | 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 |
| enableDataIsolation | bool Optional |
|
| encryption | The encryption settings of Azure ML workspace. | EncryptionProperty Optional |
| featureStoreSettings | Settings for feature store type workspace. | FeatureStoreSettings 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 |
| hubResourceReference | genruntime.ResourceReference Optional |
|
| identity | The identity of the resource. | ManagedServiceIdentity 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 |
| kind | string Optional |
|
| location | Specifies the location of the resource. | string Optional |
| managedNetwork | Managed Network settings for a machine learning workspace. | ManagedNetworkSettings 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 |
| serverlessComputeSettings | Settings for serverless compute created in the workspace | ServerlessComputeSettings 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 |
| tags | Contains resource tags defined as key/value pairs. | map[string]string Optional |
| v1LegacyMode | Enabling v1_legacy_mode may prevent you from using features provided by the v2 API. | bool Optional |
| workspaceHubConfig | WorkspaceHub’s configuration object. | WorkspaceHubConfig 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. | string Optional |
| associatedWorkspaces | string[] Optional |
|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| containerRegistry | ARM id of the container registry associated with this workspace. | 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 |
| enableDataIsolation | bool Optional |
|
| encryption | The encryption settings of Azure ML workspace. | EncryptionProperty_STATUS Optional |
| featureStoreSettings | Settings for feature store type workspace. | FeatureStoreSettings_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 |
| hubResourceId | string 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. | ManagedServiceIdentity_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 |
| kind | string Optional |
|
| location | Specifies the location of the resource. | string Optional |
| managedNetwork | Managed Network settings for a machine learning workspace. | ManagedNetworkSettings_STATUS 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 |
| serverlessComputeSettings | Settings for serverless compute created in the workspace | ServerlessComputeSettings_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 | Azure Resource Manager metadata containing createdBy and modifiedBy information. | 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 |
| v1LegacyMode | Enabling v1_legacy_mode may prevent you from using features provided by the v2 API. | bool Optional |
| workspaceHubConfig | WorkspaceHub’s configuration object. | WorkspaceHubConfig_STATUS 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. | ManagedServiceIdentity 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 |
| 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. | ManagedServiceIdentity_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 | Azure Resource Manager metadata containing createdBy and modifiedBy information. | 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 |
|---|---|---|
| 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 |
| 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 |
| properties | WorkspaceConnectionPropertiesV2 Required |
WorkspacesConnection_STATUS
Used by: WorkspacesConnection.
| 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 |
| name | The name of the resource | string Optional |
| properties | WorkspaceConnectionPropertiesV2_STATUS Optional |
|
| systemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. | SystemData_STATUS Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
ArmResourceId
ARM ResourceId of a resource
Used by: Registry_Spec, UserCreatedAcrAccount, and UserCreatedStorageAccount.
| Property | Description | Type |
|---|---|---|
| resourceReference | Arm ResourceId is in the format “/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}” or “/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}” | genruntime.ResourceReference Optional |
ArmResourceId_STATUS
ARM ResourceId of a resource
Used by: RegistryTrackedResource_STATUS, SystemCreatedAcrAccount_STATUS, SystemCreatedStorageAccount_STATUS, UserCreatedAcrAccount_STATUS, and UserCreatedStorageAccount_STATUS.
| Property | Description | Type |
|---|---|---|
| resourceId | Arm ResourceId is in the format “/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}” or “/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}” | string 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. | EncryptionKeyVaultProperties 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. | EncryptionKeyVaultProperties_STATUS Optional |
| status | Indicates whether or not the encryption is enabled for the workspace. | EncryptionProperty_Status_STATUS Optional |
FeatureStoreSettings
Settings for feature store type workspace.
Used by: Workspace_Spec.
| Property | Description | Type |
|---|---|---|
| computeRuntime | Compute runtime config for feature store type workspace. | ComputeRuntimeDto Optional |
| offlineStoreConnectionName | string Optional |
|
| onlineStoreConnectionName | string Optional |
FeatureStoreSettings_STATUS
Settings for feature store type workspace.
Used by: Workspace_STATUS.
| Property | Description | Type |
|---|---|---|
| computeRuntime | Compute runtime config for feature store type workspace. | ComputeRuntimeDto_STATUS Optional |
| offlineStoreConnectionName | string Optional |
|
| onlineStoreConnectionName | string Optional |
ManagedNetworkSettings
Managed Network settings for a machine learning workspace.
Used by: Workspace_Spec.
| Property | Description | Type |
|---|---|---|
| isolationMode | Isolation mode for the managed network of a machine learning workspace. | IsolationMode Optional |
| outboundRules | map[string]OutboundRule Optional |
|
| status | Status of the Provisioning for the managed network of a machine learning workspace. | ManagedNetworkProvisionStatus Optional |
ManagedNetworkSettings_STATUS
Managed Network settings for a machine learning workspace.
Used by: Workspace_STATUS.
| Property | Description | Type |
|---|---|---|
| isolationMode | Isolation mode for the managed network of a machine learning workspace. | IsolationMode_STATUS Optional |
| networkId | string Optional |
|
| outboundRules | map[string]OutboundRule_STATUS Optional |
|
| status | Status of the Provisioning for the managed network of a machine learning workspace. | ManagedNetworkProvisionStatus_STATUS Optional |
ManagedServiceIdentity
Managed service identity (system assigned and/or user assigned identities)
Used by: Registry_Spec, Workspace_Spec, and WorkspacesCompute_Spec.
| Property | Description | Type |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | ManagedServiceIdentityType Required |
| userAssignedIdentities | UserAssignedIdentityDetails[] Optional |
ManagedServiceIdentity_STATUS
Managed service identity (system assigned and/or user assigned identities)
Used by: RegistryTrackedResource_STATUS, Workspace_STATUS, and WorkspacesCompute_STATUS.
| Property | Description | Type |
|---|---|---|
| principalId | The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. | string Optional |
| tenantId | The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. | string Optional |
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | ManagedServiceIdentityType_STATUS Optional |
| userAssignedIdentities | 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 |
RegistryOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: Registry_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| configMaps | configures where to place operator written ConfigMaps. | RegistryOperatorConfigMaps Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
RegistryPrivateEndpointConnection
Private endpoint connection definition.
Used by: Registry_Spec.
| Property | Description | Type |
|---|---|---|
| groupIds | The group ids | string[] Optional |
| location | Same as workspace location. | string Optional |
| privateEndpoint | The PE network resource that is linked to this PE connection. | PrivateEndpointResource Optional |
| provisioningState | One of null, “Succeeded”, “Provisioning”, “Failed”. While not approved, it’s null. | string Optional |
| reference | This is the private endpoint connection name created on SRP Full resource id: /subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.MachineLearningServices/{resourceType}/{resourceName}/registryPrivateEndpointConnections/{peConnectionName} | genruntime.ResourceReference Optional |
| registryPrivateLinkServiceConnectionState | The connection state. | RegistryPrivateLinkServiceConnectionState Optional |
RegistryPrivateEndpointConnection_STATUS
Private endpoint connection definition.
Used by: RegistryTrackedResource_STATUS.
| Property | Description | Type |
|---|---|---|
| groupIds | The group ids | string[] Optional |
| id | This is the private endpoint connection name created on SRP Full resource id: /subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.MachineLearningServices/{resourceType}/{resourceName}/registryPrivateEndpointConnections/{peConnectionName} | string Optional |
| location | Same as workspace location. | string Optional |
| privateEndpoint | The PE network resource that is linked to this PE connection. | PrivateEndpointResource_STATUS Optional |
| provisioningState | One of null, “Succeeded”, “Provisioning”, “Failed”. While not approved, it’s null. | string Optional |
| registryPrivateLinkServiceConnectionState | The connection state. | RegistryPrivateLinkServiceConnectionState_STATUS Optional |
RegistryRegionArmDetails
Details for each region the registry is in
Used by: Registry_Spec.
| Property | Description | Type |
|---|---|---|
| acrDetails | List of ACR accounts | AcrDetails[] Optional |
| location | The location where the registry exists | string Optional |
| storageAccountDetails | List of storage accounts | StorageAccountDetails[] Optional |
RegistryRegionArmDetails_STATUS
Details for each region the registry is in
Used by: RegistryTrackedResource_STATUS.
| Property | Description | Type |
|---|---|---|
| acrDetails | List of ACR accounts | AcrDetails_STATUS[] Optional |
| location | The location where the registry exists | string Optional |
| storageAccountDetails | List of storage accounts | StorageAccountDetails_STATUS[] Optional |
ServerlessComputeSettings
Used by: Workspace_Spec.
| Property | Description | Type |
|---|---|---|
| serverlessComputeCustomSubnetReference | The resource ID of an existing virtual network subnet in which serverless compute nodes should be deployed | genruntime.ResourceReference Optional |
| serverlessComputeNoPublicIP | The flag to signal if serverless compute nodes deployed in custom vNet would have no public IP addresses for a workspace with private endpoint | bool Optional |
ServerlessComputeSettings_STATUS
Used by: Workspace_STATUS.
| Property | Description | Type |
|---|---|---|
| serverlessComputeCustomSubnet | The resource ID of an existing virtual network subnet in which serverless compute nodes should be deployed | string Optional |
| serverlessComputeNoPublicIP | The flag to signal if serverless compute nodes deployed in custom vNet would have no public IP addresses for a workspace with private endpoint | bool 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
The resource model definition representing SKU
Used by: Registry_Spec, Workspace_Spec, and WorkspacesCompute_Spec.
| Property | Description | Type |
|---|---|---|
| capacity | If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. | int Optional |
| family | If the service has different generations of hardware, for the same SKU, then that can be captured here. | string Optional |
| name | The name of the SKU. Ex - P3. It is typically a letter+number code | string Required |
| size | The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. | string Optional |
| tier | This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. | SkuTier Optional |
Sku_STATUS
The resource model definition representing SKU
Used by: RegistryTrackedResource_STATUS, Workspace_STATUS, and WorkspacesCompute_STATUS.
| Property | Description | Type |
|---|---|---|
| capacity | If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. | int Optional |
| family | If the service has different generations of hardware, for the same SKU, then that can be captured here. | string Optional |
| name | The name of the SKU. Ex - P3. It is typically a letter+number code | string Optional |
| size | The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. | string Optional |
| tier | This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. | SkuTier_STATUS Optional |
SystemData_STATUS
Metadata pertaining to creation and last modification of the resource.
Used by: RegistryTrackedResource_STATUS, Workspace_STATUS, WorkspacesCompute_STATUS, and WorkspacesConnection_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 |
WorkspaceConnectionPropertiesV2
Used by: WorkspacesConnection_Spec.
| Property | Description | Type |
|---|---|---|
| aad | Mutually exclusive with all other properties | AADAuthTypeWorkspaceConnectionProperties Optional |
| accessKey | Mutually exclusive with all other properties | AccessKeyAuthTypeWorkspaceConnectionProperties Optional |
| accountKey | Mutually exclusive with all other properties | AccountKeyAuthTypeWorkspaceConnectionProperties Optional |
| apiKey | Mutually exclusive with all other properties | ApiKeyAuthWorkspaceConnectionProperties Optional |
| customKeys | Mutually exclusive with all other properties | CustomKeysWorkspaceConnectionProperties Optional |
| managedIdentity | Mutually exclusive with all other properties | ManagedIdentityAuthTypeWorkspaceConnectionProperties Optional |
| none | Mutually exclusive with all other properties | NoneAuthTypeWorkspaceConnectionProperties Optional |
| oAuth2 | Mutually exclusive with all other properties | OAuth2AuthTypeWorkspaceConnectionProperties Optional |
| pat | Mutually exclusive with all other properties | PATAuthTypeWorkspaceConnectionProperties Optional |
| sas | Mutually exclusive with all other properties | SASAuthTypeWorkspaceConnectionProperties Optional |
| servicePrincipal | Mutually exclusive with all other properties | ServicePrincipalAuthTypeWorkspaceConnectionProperties Optional |
| usernamePassword | Mutually exclusive with all other properties | UsernamePasswordAuthTypeWorkspaceConnectionProperties Optional |
WorkspaceConnectionPropertiesV2_STATUS
Used by: WorkspacesConnection_STATUS.
| Property | Description | Type |
|---|---|---|
| aad | Mutually exclusive with all other properties | AADAuthTypeWorkspaceConnectionProperties_STATUS Optional |
| accessKey | Mutually exclusive with all other properties | AccessKeyAuthTypeWorkspaceConnectionProperties_STATUS Optional |
| accountKey | Mutually exclusive with all other properties | AccountKeyAuthTypeWorkspaceConnectionProperties_STATUS Optional |
| apiKey | Mutually exclusive with all other properties | ApiKeyAuthWorkspaceConnectionProperties_STATUS Optional |
| customKeys | Mutually exclusive with all other properties | CustomKeysWorkspaceConnectionProperties_STATUS Optional |
| managedIdentity | Mutually exclusive with all other properties | ManagedIdentityAuthTypeWorkspaceConnectionProperties_STATUS Optional |
| none | Mutually exclusive with all other properties | NoneAuthTypeWorkspaceConnectionProperties_STATUS Optional |
| oAuth2 | Mutually exclusive with all other properties | OAuth2AuthTypeWorkspaceConnectionProperties_STATUS Optional |
| pat | Mutually exclusive with all other properties | PATAuthTypeWorkspaceConnectionProperties_STATUS Optional |
| sas | Mutually exclusive with all other properties | SASAuthTypeWorkspaceConnectionProperties_STATUS Optional |
| servicePrincipal | Mutually exclusive with all other properties | ServicePrincipalAuthTypeWorkspaceConnectionProperties_STATUS Optional |
| usernamePassword | Mutually exclusive with all other properties | UsernamePasswordAuthTypeWorkspaceConnectionProperties_STATUS Optional |
WorkspaceHubConfig
WorkspaceHub’s configuration object.
Used by: Workspace_Spec.
| Property | Description | Type |
|---|---|---|
| additionalWorkspaceStorageAccounts | string[] Optional |
|
| defaultWorkspaceResourceGroup | string Optional |
WorkspaceHubConfig_STATUS
WorkspaceHub’s configuration object.
Used by: Workspace_STATUS.
| Property | Description | Type |
|---|---|---|
| additionalWorkspaceStorageAccounts | string[] Optional |
|
| defaultWorkspaceResourceGroup | string Optional |
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 |
AADAuthTypeWorkspaceConnectionProperties
Used by: WorkspaceConnectionPropertiesV2.
| Property | Description | Type |
|---|---|---|
| authType | Authentication type of the connection target | AADAuthTypeWorkspaceConnectionProperties_AuthType Required |
| category | Category of the connection | ConnectionCategory Optional |
| expiryTime | string Optional |
|
| isSharedToAll | bool Optional |
|
| metadata | Store user metadata for this connection | map[string]string Optional |
| sharedUserList | string[] Optional |
|
| target | string Optional |
|
| value | Value details of the workspace connection. | string Optional |
| valueFormat | format for the workspace connection value | AADAuthTypeWorkspaceConnectionProperties_ValueFormat Optional |
AADAuthTypeWorkspaceConnectionProperties_STATUS
Used by: WorkspaceConnectionPropertiesV2_STATUS.
| Property | Description | Type |
|---|---|---|
| authType | Authentication type of the connection target | AADAuthTypeWorkspaceConnectionProperties_AuthType_STATUS Optional |
| category | Category of the connection | ConnectionCategory_STATUS Optional |
| createdByWorkspaceArmId | string Optional |
|
| expiryTime | string Optional |
|
| group | Group based on connection category | ConnectionGroup_STATUS Optional |
| isSharedToAll | bool Optional |
|
| metadata | Store user metadata for this connection | map[string]string Optional |
| sharedUserList | string[] Optional |
|
| target | string Optional |
|
| value | Value details of the workspace connection. | string Optional |
| valueFormat | format for the workspace connection value | AADAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS Optional |
AccessKeyAuthTypeWorkspaceConnectionProperties
Used by: WorkspaceConnectionPropertiesV2.
| Property | Description | Type |
|---|---|---|
| authType | Authentication type of the connection target | AccessKeyAuthTypeWorkspaceConnectionProperties_AuthType Required |
| category | Category of the connection | ConnectionCategory Optional |
| credentials | WorkspaceConnectionAccessKey Optional |
|
| expiryTime | string Optional |
|
| isSharedToAll | bool Optional |
|
| metadata | Store user metadata for this connection | map[string]string Optional |
| sharedUserList | string[] Optional |
|
| target | string Optional |
|
| value | Value details of the workspace connection. | string Optional |
| valueFormat | format for the workspace connection value | AccessKeyAuthTypeWorkspaceConnectionProperties_ValueFormat Optional |
AccessKeyAuthTypeWorkspaceConnectionProperties_STATUS
Used by: WorkspaceConnectionPropertiesV2_STATUS.
| Property | Description | Type |
|---|---|---|
| authType | Authentication type of the connection target | AccessKeyAuthTypeWorkspaceConnectionProperties_AuthType_STATUS Optional |
| category | Category of the connection | ConnectionCategory_STATUS Optional |
| createdByWorkspaceArmId | string Optional |
|
| credentials | WorkspaceConnectionAccessKey_STATUS Optional |
|
| expiryTime | string Optional |
|
| group | Group based on connection category | ConnectionGroup_STATUS Optional |
| isSharedToAll | bool Optional |
|
| metadata | Store user metadata for this connection | map[string]string Optional |
| sharedUserList | string[] Optional |
|
| target | string Optional |
|
| value | Value details of the workspace connection. | string Optional |
| valueFormat | format for the workspace connection value | AccessKeyAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS Optional |
AccountKeyAuthTypeWorkspaceConnectionProperties
Used by: WorkspaceConnectionPropertiesV2.
| Property | Description | Type |
|---|---|---|
| authType | Authentication type of the connection target | AccountKeyAuthTypeWorkspaceConnectionProperties_AuthType Required |
| category | Category of the connection | ConnectionCategory Optional |
| credentials | WorkspaceConnectionAccountKey Optional |
|
| expiryTime | string Optional |
|
| isSharedToAll | bool Optional |
|
| metadata | Store user metadata for this connection | map[string]string Optional |
| sharedUserList | string[] Optional |
|
| target | string Optional |
|
| value | Value details of the workspace connection. | string Optional |
| valueFormat | format for the workspace connection value | AccountKeyAuthTypeWorkspaceConnectionProperties_ValueFormat Optional |
AccountKeyAuthTypeWorkspaceConnectionProperties_STATUS
Used by: WorkspaceConnectionPropertiesV2_STATUS.
| Property | Description | Type |
|---|---|---|
| authType | Authentication type of the connection target | AccountKeyAuthTypeWorkspaceConnectionProperties_AuthType_STATUS Optional |
| category | Category of the connection | ConnectionCategory_STATUS Optional |
| createdByWorkspaceArmId | string Optional |
|
| credentials | WorkspaceConnectionAccountKey_STATUS Optional |
|
| expiryTime | string Optional |
|
| group | Group based on connection category | ConnectionGroup_STATUS Optional |
| isSharedToAll | bool Optional |
|
| metadata | Store user metadata for this connection | map[string]string Optional |
| sharedUserList | string[] Optional |
|
| target | string Optional |
|
| value | Value details of the workspace connection. | string Optional |
| valueFormat | format for the workspace connection value | AccountKeyAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS Optional |
AcrDetails
Details of ACR account to be used for the Registry
Used by: RegistryRegionArmDetails.
| Property | Description | Type |
|---|---|---|
| systemCreatedAcrAccount | Details of system created ACR account to be used for the Registry | SystemCreatedAcrAccount Optional |
| userCreatedAcrAccount | Details of user created ACR account to be used for the Registry | UserCreatedAcrAccount Optional |
AcrDetails_STATUS
Details of ACR account to be used for the Registry
Used by: RegistryRegionArmDetails_STATUS.
| Property | Description | Type |
|---|---|---|
| systemCreatedAcrAccount | Details of system created ACR account to be used for the Registry | SystemCreatedAcrAccount_STATUS Optional |
| userCreatedAcrAccount | Details of user created ACR account to be used for the Registry | UserCreatedAcrAccount_STATUS 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 |
ApiKeyAuthWorkspaceConnectionProperties
Used by: WorkspaceConnectionPropertiesV2.
| Property | Description | Type |
|---|---|---|
| authType | Authentication type of the connection target | ApiKeyAuthWorkspaceConnectionProperties_AuthType Required |
| category | Category of the connection | ConnectionCategory Optional |
| credentials | Api key object for workspace connection credential. | WorkspaceConnectionApiKey Optional |
| expiryTime | string Optional |
|
| isSharedToAll | bool Optional |
|
| metadata | Store user metadata for this connection | map[string]string Optional |
| sharedUserList | string[] Optional |
|
| target | string Optional |
|
| value | Value details of the workspace connection. | string Optional |
| valueFormat | format for the workspace connection value | ApiKeyAuthWorkspaceConnectionProperties_ValueFormat Optional |
ApiKeyAuthWorkspaceConnectionProperties_STATUS
Used by: WorkspaceConnectionPropertiesV2_STATUS.
| Property | Description | Type |
|---|---|---|
| authType | Authentication type of the connection target | ApiKeyAuthWorkspaceConnectionProperties_AuthType_STATUS Optional |
| category | Category of the connection | ConnectionCategory_STATUS Optional |
| createdByWorkspaceArmId | string Optional |
|
| credentials | Api key object for workspace connection credential. | WorkspaceConnectionApiKey_STATUS Optional |
| expiryTime | string Optional |
|
| group | Group based on connection category | ConnectionGroup_STATUS Optional |
| isSharedToAll | bool Optional |
|
| metadata | Store user metadata for this connection | map[string]string Optional |
| sharedUserList | string[] Optional |
|
| target | string Optional |
|
| value | Value details of the workspace connection. | string Optional |
| valueFormat | format for the workspace connection value | ApiKeyAuthWorkspaceConnectionProperties_ValueFormat_STATUS 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 |
ComputeRuntimeDto
Compute runtime config for feature store type workspace.
Used by: FeatureStoreSettings.
| Property | Description | Type |
|---|---|---|
| sparkRuntimeVersion | string Optional |
ComputeRuntimeDto_STATUS
Compute runtime config for feature store type workspace.
Used by: FeatureStoreSettings_STATUS.
| Property | Description | Type |
|---|---|---|
| sparkRuntimeVersion | 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 |
CustomKeysWorkspaceConnectionProperties
Used by: WorkspaceConnectionPropertiesV2.
| Property | Description | Type |
|---|---|---|
| authType | Authentication type of the connection target | CustomKeysWorkspaceConnectionProperties_AuthType Required |
| category | Category of the connection | ConnectionCategory Optional |
| credentials | Custom Keys credential object | CustomKeys Optional |
| expiryTime | string Optional |
|
| isSharedToAll | bool Optional |
|
| metadata | Store user metadata for this connection | map[string]string Optional |
| sharedUserList | string[] Optional |
|
| target | string Optional |
|
| value | Value details of the workspace connection. | string Optional |
| valueFormat | format for the workspace connection value | CustomKeysWorkspaceConnectionProperties_ValueFormat Optional |
CustomKeysWorkspaceConnectionProperties_STATUS
Used by: WorkspaceConnectionPropertiesV2_STATUS.
| Property | Description | Type |
|---|---|---|
| authType | Authentication type of the connection target | CustomKeysWorkspaceConnectionProperties_AuthType_STATUS Optional |
| category | Category of the connection | ConnectionCategory_STATUS Optional |
| createdByWorkspaceArmId | string Optional |
|
| credentials | Custom Keys credential object | CustomKeys_STATUS Optional |
| expiryTime | string Optional |
|
| group | Group based on connection category | ConnectionGroup_STATUS Optional |
| isSharedToAll | bool Optional |
|
| metadata | Store user metadata for this connection | map[string]string Optional |
| sharedUserList | string[] Optional |
|
| target | string Optional |
|
| value | Value details of the workspace connection. | string Optional |
| valueFormat | format for the workspace connection value | CustomKeysWorkspaceConnectionProperties_ValueFormat_STATUS 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 |
EncryptionKeyVaultProperties
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 |
| identityClientIdFromConfig | For future use - The client id of the identity which will be used to access key vault. | genruntime.ConfigMapReference Optional |
| keyIdentifier | Key vault uri to access the encryption key. | string Required |
| keyVaultArmReference | The ArmId of the keyVault where the customer owned encryption key is present. | genruntime.ResourceReference Required |
EncryptionKeyVaultProperties_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 |
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 |
IdentityForCmk
Identity that will be used to access key vault for encryption at rest
Used by: EncryptionProperty.
| Property | Description | Type |
|---|---|---|
| userAssignedIdentityReference | The ArmId of the user assigned identity that will be used to access the customer managed key vault | genruntime.ResourceReference 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 |
IsolationMode
Isolation mode for the managed network of a machine learning workspace.
Used by: ManagedNetworkSettings.
| Value | Description |
|---|---|
| “AllowInternetOutbound” | |
| “AllowOnlyApprovedOutbound” | |
| “Disabled” |
IsolationMode_STATUS
Isolation mode for the managed network of a machine learning workspace.
Used by: ManagedNetworkSettings_STATUS.
| Value | Description |
|---|---|
| “AllowInternetOutbound” | |
| “AllowOnlyApprovedOutbound” | |
| “Disabled” |
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 |
ManagedIdentityAuthTypeWorkspaceConnectionProperties
Used by: WorkspaceConnectionPropertiesV2.
| Property | Description | Type |
|---|---|---|
| authType | Authentication type of the connection target | ManagedIdentityAuthTypeWorkspaceConnectionProperties_AuthType Required |
| category | Category of the connection | ConnectionCategory Optional |
| credentials | WorkspaceConnectionManagedIdentity Optional |
|
| expiryTime | string Optional |
|
| isSharedToAll | bool Optional |
|
| metadata | Store user metadata for this connection | map[string]string Optional |
| sharedUserList | string[] Optional |
|
| target | string Optional |
|
| value | Value details of the workspace connection. | string Optional |
| valueFormat | format for the workspace connection value | ManagedIdentityAuthTypeWorkspaceConnectionProperties_ValueFormat Optional |
ManagedIdentityAuthTypeWorkspaceConnectionProperties_STATUS
Used by: WorkspaceConnectionPropertiesV2_STATUS.
| Property | Description | Type |
|---|---|---|
| authType | Authentication type of the connection target | ManagedIdentityAuthTypeWorkspaceConnectionProperties_AuthType_STATUS Optional |
| category | Category of the connection | ConnectionCategory_STATUS Optional |
| createdByWorkspaceArmId | string Optional |
|
| credentials | WorkspaceConnectionManagedIdentity_STATUS Optional |
|
| expiryTime | string Optional |
|
| group | Group based on connection category | ConnectionGroup_STATUS Optional |
| isSharedToAll | bool Optional |
|
| metadata | Store user metadata for this connection | map[string]string Optional |
| sharedUserList | string[] Optional |
|
| target | string Optional |
|
| value | Value details of the workspace connection. | string Optional |
| valueFormat | format for the workspace connection value | ManagedIdentityAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS Optional |
ManagedNetworkProvisionStatus
Status of the Provisioning for the managed network of a machine learning workspace.
Used by: ManagedNetworkSettings.
| Property | Description | Type |
|---|---|---|
| sparkReady | bool Optional |
|
| status | Status for the managed network of a machine learning workspace. | ManagedNetworkStatus Optional |
ManagedNetworkProvisionStatus_STATUS
Status of the Provisioning for the managed network of a machine learning workspace.
Used by: ManagedNetworkSettings_STATUS.
| Property | Description | Type |
|---|---|---|
| sparkReady | bool Optional |
|
| status | Status for the managed network of a machine learning workspace. | ManagedNetworkStatus_STATUS Optional |
ManagedServiceIdentityType
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
Used by: ManagedServiceIdentity.
| Value | Description |
|---|---|
| “None” | |
| “SystemAssigned” | |
| “SystemAssigned,UserAssigned” | |
| “UserAssigned” |
ManagedServiceIdentityType_STATUS
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
Used by: ManagedServiceIdentity_STATUS.
| Value | Description |
|---|---|
| “None” | |
| “SystemAssigned” | |
| “SystemAssigned,UserAssigned” | |
| “UserAssigned” |
NoneAuthTypeWorkspaceConnectionProperties
Used by: WorkspaceConnectionPropertiesV2.
| Property | Description | Type |
|---|---|---|
| authType | Authentication type of the connection target | NoneAuthTypeWorkspaceConnectionProperties_AuthType Required |
| category | Category of the connection | ConnectionCategory Optional |
| expiryTime | string Optional |
|
| isSharedToAll | bool Optional |
|
| metadata | Store user metadata for this connection | map[string]string Optional |
| sharedUserList | string[] Optional |
|
| target | string Optional |
|
| value | Value details of the workspace connection. | string Optional |
| valueFormat | format for the workspace connection value | NoneAuthTypeWorkspaceConnectionProperties_ValueFormat Optional |
NoneAuthTypeWorkspaceConnectionProperties_STATUS
Used by: WorkspaceConnectionPropertiesV2_STATUS.
| Property | Description | Type |
|---|---|---|
| authType | Authentication type of the connection target | NoneAuthTypeWorkspaceConnectionProperties_AuthType_STATUS Optional |
| category | Category of the connection | ConnectionCategory_STATUS Optional |
| createdByWorkspaceArmId | string Optional |
|
| expiryTime | string Optional |
|
| group | Group based on connection category | ConnectionGroup_STATUS Optional |
| isSharedToAll | bool Optional |
|
| metadata | Store user metadata for this connection | map[string]string Optional |
| sharedUserList | string[] Optional |
|
| target | string Optional |
|
| value | Value details of the workspace connection. | string Optional |
| valueFormat | format for the workspace connection value | NoneAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS Optional |
NotebookPreparationError_STATUS
Used by: NotebookResourceInfo_STATUS.
| Property | Description | Type |
|---|---|---|
| errorMessage | string Optional |
|
| statusCode | int Optional |
OAuth2AuthTypeWorkspaceConnectionProperties
Used by: WorkspaceConnectionPropertiesV2.
| Property | Description | Type |
|---|---|---|
| authType | Authentication type of the connection target | OAuth2AuthTypeWorkspaceConnectionProperties_AuthType Required |
| category | Category of the connection | ConnectionCategory Optional |
| credentials | ClientId and ClientSecret are required. Other properties are optional depending on each OAuth2 provider’s implementation. | WorkspaceConnectionOAuth2 Optional |
| expiryTime | string Optional |
|
| isSharedToAll | bool Optional |
|
| metadata | Store user metadata for this connection | map[string]string Optional |
| sharedUserList | string[] Optional |
|
| target | string Optional |
|
| value | Value details of the workspace connection. | string Optional |
| valueFormat | format for the workspace connection value | OAuth2AuthTypeWorkspaceConnectionProperties_ValueFormat Optional |
OAuth2AuthTypeWorkspaceConnectionProperties_STATUS
Used by: WorkspaceConnectionPropertiesV2_STATUS.
| Property | Description | Type |
|---|---|---|
| authType | Authentication type of the connection target | OAuth2AuthTypeWorkspaceConnectionProperties_AuthType_STATUS Optional |
| category | Category of the connection | ConnectionCategory_STATUS Optional |
| createdByWorkspaceArmId | string Optional |
|
| credentials | ClientId and ClientSecret are required. Other properties are optional depending on each OAuth2 provider’s implementation. | WorkspaceConnectionOAuth2_STATUS Optional |
| expiryTime | string Optional |
|
| group | Group based on connection category | ConnectionGroup_STATUS Optional |
| isSharedToAll | bool Optional |
|
| metadata | Store user metadata for this connection | map[string]string Optional |
| sharedUserList | string[] Optional |
|
| target | string Optional |
|
| value | Value details of the workspace connection. | string Optional |
| valueFormat | format for the workspace connection value | OAuth2AuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS Optional |
OutboundRule
Used by: ManagedNetworkSettings.
| Property | Description | Type |
|---|---|---|
| fqdn | Mutually exclusive with all other properties | FqdnOutboundRule Optional |
| privateEndpoint | Mutually exclusive with all other properties | PrivateEndpointOutboundRule Optional |
| serviceTag | Mutually exclusive with all other properties | ServiceTagOutboundRule Optional |
OutboundRule_STATUS
Used by: ManagedNetworkSettings_STATUS.
| Property | Description | Type |
|---|---|---|
| fqdn | Mutually exclusive with all other properties | FqdnOutboundRule_STATUS Optional |
| privateEndpoint | Mutually exclusive with all other properties | PrivateEndpointOutboundRule_STATUS Optional |
| serviceTag | Mutually exclusive with all other properties | ServiceTagOutboundRule_STATUS Optional |
PATAuthTypeWorkspaceConnectionProperties
Used by: WorkspaceConnectionPropertiesV2.
| Property | Description | Type |
|---|---|---|
| authType | Authentication type of the connection target | PATAuthTypeWorkspaceConnectionProperties_AuthType Required |
| category | Category of the connection | ConnectionCategory Optional |
| credentials | WorkspaceConnectionPersonalAccessToken Optional |
|
| expiryTime | string Optional |
|
| isSharedToAll | bool Optional |
|
| metadata | Store user metadata for this connection | map[string]string Optional |
| sharedUserList | string[] Optional |
|
| target | string Optional |
|
| value | Value details of the workspace connection. | string Optional |
| valueFormat | format for the workspace connection value | PATAuthTypeWorkspaceConnectionProperties_ValueFormat Optional |
PATAuthTypeWorkspaceConnectionProperties_STATUS
Used by: WorkspaceConnectionPropertiesV2_STATUS.
| Property | Description | Type |
|---|---|---|
| authType | Authentication type of the connection target | PATAuthTypeWorkspaceConnectionProperties_AuthType_STATUS Optional |
| category | Category of the connection | ConnectionCategory_STATUS Optional |
| createdByWorkspaceArmId | string Optional |
|
| credentials | WorkspaceConnectionPersonalAccessToken_STATUS Optional |
|
| expiryTime | string Optional |
|
| group | Group based on connection category | ConnectionGroup_STATUS Optional |
| isSharedToAll | bool Optional |
|
| metadata | Store user metadata for this connection | map[string]string Optional |
| sharedUserList | string[] Optional |
|
| target | string Optional |
|
| value | Value details of the workspace connection. | string Optional |
| valueFormat | format for the workspace connection value | PATAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS Optional |
PrivateEndpointResource
The PE network resource that is linked to this PE connection.
Used by: RegistryPrivateEndpointConnection.
| Property | Description | Type |
|---|---|---|
| subnetArmReference | The subnetId that the private endpoint is connected to. | genruntime.ResourceReference Optional |
PrivateEndpointResource_STATUS
The PE network resource that is linked to this PE connection.
Used by: RegistryPrivateEndpointConnection_STATUS.
| Property | Description | Type |
|---|---|---|
| id | The ARM identifier for Private Endpoint | string Optional |
| subnetArmId | The subnetId that the private endpoint is connected to. | string 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” |
RegistryOperatorConfigMaps
Used by: RegistryOperatorSpec.
| Property | Description | Type |
|---|---|---|
| discoveryUrl | indicates where the DiscoveryUrl config map should be placed. If omitted, no config map will be created. | genruntime.ConfigMapDestination Optional |
| mlFlowRegistryUri | indicates where the MlFlowRegistryUri config map should be placed. If omitted, no config map will be created. | genruntime.ConfigMapDestination Optional |
RegistryPrivateLinkServiceConnectionState
The connection state.
Used by: RegistryPrivateEndpointConnection.
| Property | Description | Type |
|---|---|---|
| actionsRequired | Some RP chose “None”. Other RPs use this for region expansion. | string Optional |
| description | User-defined message that, per NRP doc, may be used for approval-related message. | string Optional |
| status | Connection status of the service consumer with the service provider | EndpointServiceConnectionStatus Optional |
RegistryPrivateLinkServiceConnectionState_STATUS
The connection state.
Used by: RegistryPrivateEndpointConnection_STATUS.
| Property | Description | Type |
|---|---|---|
| actionsRequired | Some RP chose “None”. Other RPs use this for region expansion. | string Optional |
| description | User-defined message that, per NRP doc, may be used for approval-related message. | string Optional |
| status | Connection status of the service consumer with the service provider | EndpointServiceConnectionStatus_STATUS Optional |
SASAuthTypeWorkspaceConnectionProperties
Used by: WorkspaceConnectionPropertiesV2.
| Property | Description | Type |
|---|---|---|
| authType | Authentication type of the connection target | SASAuthTypeWorkspaceConnectionProperties_AuthType Required |
| category | Category of the connection | ConnectionCategory Optional |
| credentials | WorkspaceConnectionSharedAccessSignature Optional |
|
| expiryTime | string Optional |
|
| isSharedToAll | bool Optional |
|
| metadata | Store user metadata for this connection | map[string]string Optional |
| sharedUserList | string[] Optional |
|
| target | string Optional |
|
| value | Value details of the workspace connection. | string Optional |
| valueFormat | format for the workspace connection value | SASAuthTypeWorkspaceConnectionProperties_ValueFormat Optional |
SASAuthTypeWorkspaceConnectionProperties_STATUS
Used by: WorkspaceConnectionPropertiesV2_STATUS.
| Property | Description | Type |
|---|---|---|
| authType | Authentication type of the connection target | SASAuthTypeWorkspaceConnectionProperties_AuthType_STATUS Optional |
| category | Category of the connection | ConnectionCategory_STATUS Optional |
| createdByWorkspaceArmId | string Optional |
|
| credentials | WorkspaceConnectionSharedAccessSignature_STATUS Optional |
|
| expiryTime | string Optional |
|
| group | Group based on connection category | ConnectionGroup_STATUS Optional |
| isSharedToAll | bool Optional |
|
| metadata | Store user metadata for this connection | map[string]string Optional |
| sharedUserList | string[] Optional |
|
| target | string Optional |
|
| value | Value details of the workspace connection. | string Optional |
| valueFormat | format for the workspace connection value | SASAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS Optional |
ServicePrincipalAuthTypeWorkspaceConnectionProperties
Used by: WorkspaceConnectionPropertiesV2.
| Property | Description | Type |
|---|---|---|
| authType | Authentication type of the connection target | ServicePrincipalAuthTypeWorkspaceConnectionProperties_AuthType Required |
| category | Category of the connection | ConnectionCategory Optional |
| credentials | WorkspaceConnectionServicePrincipal Optional |
|
| expiryTime | string Optional |
|
| isSharedToAll | bool Optional |
|
| metadata | Store user metadata for this connection | map[string]string Optional |
| sharedUserList | string[] Optional |
|
| target | string Optional |
|
| value | Value details of the workspace connection. | string Optional |
| valueFormat | format for the workspace connection value | ServicePrincipalAuthTypeWorkspaceConnectionProperties_ValueFormat Optional |
ServicePrincipalAuthTypeWorkspaceConnectionProperties_STATUS
Used by: WorkspaceConnectionPropertiesV2_STATUS.
| Property | Description | Type |
|---|---|---|
| authType | Authentication type of the connection target | ServicePrincipalAuthTypeWorkspaceConnectionProperties_AuthType_STATUS Optional |
| category | Category of the connection | ConnectionCategory_STATUS Optional |
| createdByWorkspaceArmId | string Optional |
|
| credentials | WorkspaceConnectionServicePrincipal_STATUS Optional |
|
| expiryTime | string Optional |
|
| group | Group based on connection category | ConnectionGroup_STATUS Optional |
| isSharedToAll | bool Optional |
|
| metadata | Store user metadata for this connection | map[string]string Optional |
| sharedUserList | string[] Optional |
|
| target | string Optional |
|
| value | Value details of the workspace connection. | string Optional |
| valueFormat | format for the workspace connection value | ServicePrincipalAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS Optional |
SkuTier
This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
Used by: Sku.
| Value | Description |
|---|---|
| “Basic” | |
| “Free” | |
| “Premium” | |
| “Standard” |
SkuTier_STATUS
This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
Used by: Sku_STATUS.
| Value | Description |
|---|---|
| “Basic” | |
| “Free” | |
| “Premium” | |
| “Standard” |
StorageAccountDetails
Details of storage account to be used for the Registry
Used by: RegistryRegionArmDetails.
| Property | Description | Type |
|---|---|---|
| systemCreatedStorageAccount | Details of system created storage account to be used for the registry | SystemCreatedStorageAccount Optional |
| userCreatedStorageAccount | Details of user created storage account to be used for the registry | UserCreatedStorageAccount Optional |
StorageAccountDetails_STATUS
Details of storage account to be used for the Registry
Used by: RegistryRegionArmDetails_STATUS.
| Property | Description | Type |
|---|---|---|
| systemCreatedStorageAccount | Details of system created storage account to be used for the registry | SystemCreatedStorageAccount_STATUS Optional |
| userCreatedStorageAccount | Details of user created storage account to be used for the registry | UserCreatedStorageAccount_STATUS Optional |
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_STATUS
Used by: SystemData_STATUS.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |
SystemData_LastModifiedByType_STATUS
Used by: SystemData_STATUS.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |
UserAssignedIdentity_STATUS
User assigned identity properties
Used by: ManagedServiceIdentity_STATUS.
| Property | Description | Type |
|---|---|---|
| clientId | The client ID of the assigned identity. | string Optional |
| principalId | The principal ID of the assigned identity. | string Optional |
UserAssignedIdentityDetails
Information about the user assigned identity for the resource
Used by: ManagedServiceIdentity.
| Property | Description | Type |
|---|---|---|
| reference | genruntime.ResourceReference Optional |
UsernamePasswordAuthTypeWorkspaceConnectionProperties
Used by: WorkspaceConnectionPropertiesV2.
| Property | Description | Type |
|---|---|---|
| authType | Authentication type of the connection target | UsernamePasswordAuthTypeWorkspaceConnectionProperties_AuthType Required |
| category | Category of the connection | ConnectionCategory Optional |
| credentials | WorkspaceConnectionUsernamePassword Optional |
|
| expiryTime | string Optional |
|
| isSharedToAll | bool Optional |
|
| metadata | Store user metadata for this connection | map[string]string Optional |
| sharedUserList | string[] Optional |
|
| target | string Optional |
|
| value | Value details of the workspace connection. | string Optional |
| valueFormat | format for the workspace connection value | UsernamePasswordAuthTypeWorkspaceConnectionProperties_ValueFormat Optional |
UsernamePasswordAuthTypeWorkspaceConnectionProperties_STATUS
Used by: WorkspaceConnectionPropertiesV2_STATUS.
| Property | Description | Type |
|---|---|---|
| authType | Authentication type of the connection target | UsernamePasswordAuthTypeWorkspaceConnectionProperties_AuthType_STATUS Optional |
| category | Category of the connection | ConnectionCategory_STATUS Optional |
| createdByWorkspaceArmId | string Optional |
|
| credentials | WorkspaceConnectionUsernamePassword_STATUS Optional |
|
| expiryTime | string Optional |
|
| group | Group based on connection category | ConnectionGroup_STATUS Optional |
| isSharedToAll | bool Optional |
|
| metadata | Store user metadata for this connection | map[string]string Optional |
| sharedUserList | string[] Optional |
|
| target | string Optional |
|
| value | Value details of the workspace connection. | string Optional |
| valueFormat | format for the workspace connection value | UsernamePasswordAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS 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 |
AADAuthTypeWorkspaceConnectionProperties_AuthType
Used by: AADAuthTypeWorkspaceConnectionProperties.
| Value | Description |
|---|---|
| “AAD” |
AADAuthTypeWorkspaceConnectionProperties_AuthType_STATUS
Used by: AADAuthTypeWorkspaceConnectionProperties_STATUS.
| Value | Description |
|---|---|
| “AAD” |
AADAuthTypeWorkspaceConnectionProperties_ValueFormat
Used by: AADAuthTypeWorkspaceConnectionProperties.
| Value | Description |
|---|---|
| “JSON” |
AADAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS
Used by: AADAuthTypeWorkspaceConnectionProperties_STATUS.
| Value | Description |
|---|---|
| “JSON” |
AccessKeyAuthTypeWorkspaceConnectionProperties_AuthType
Used by: AccessKeyAuthTypeWorkspaceConnectionProperties.
| Value | Description |
|---|---|
| “AccessKey” |
AccessKeyAuthTypeWorkspaceConnectionProperties_AuthType_STATUS
Used by: AccessKeyAuthTypeWorkspaceConnectionProperties_STATUS.
| Value | Description |
|---|---|
| “AccessKey” |
AccessKeyAuthTypeWorkspaceConnectionProperties_ValueFormat
Used by: AccessKeyAuthTypeWorkspaceConnectionProperties.
| Value | Description |
|---|---|
| “JSON” |
AccessKeyAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS
Used by: AccessKeyAuthTypeWorkspaceConnectionProperties_STATUS.
| Value | Description |
|---|---|
| “JSON” |
AccountKeyAuthTypeWorkspaceConnectionProperties_AuthType
Used by: AccountKeyAuthTypeWorkspaceConnectionProperties.
| Value | Description |
|---|---|
| “AccountKey” |
AccountKeyAuthTypeWorkspaceConnectionProperties_AuthType_STATUS
Used by: AccountKeyAuthTypeWorkspaceConnectionProperties_STATUS.
| Value | Description |
|---|---|
| “AccountKey” |
AccountKeyAuthTypeWorkspaceConnectionProperties_ValueFormat
Used by: AccountKeyAuthTypeWorkspaceConnectionProperties.
| Value | Description |
|---|---|
| “JSON” |
AccountKeyAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS
Used by: AccountKeyAuthTypeWorkspaceConnectionProperties_STATUS.
| Value | Description |
|---|---|
| “JSON” |
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 |
| loadBalancerSubnetReference | Load Balancer Subnet | genruntime.ResourceReference 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 |
| propertyBag | A property bag containing additional properties. | map[string]v1.JSON 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 |
| propertyBag | A property bag containing additional properties. | map[string]v1.JSON 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 |
ApiKeyAuthWorkspaceConnectionProperties_AuthType
Used by: ApiKeyAuthWorkspaceConnectionProperties.
| Value | Description |
|---|---|
| “ApiKey” |
ApiKeyAuthWorkspaceConnectionProperties_AuthType_STATUS
Used by: ApiKeyAuthWorkspaceConnectionProperties_STATUS.
| Value | Description |
|---|---|
| “ApiKey” |
ApiKeyAuthWorkspaceConnectionProperties_ValueFormat
Used by: ApiKeyAuthWorkspaceConnectionProperties.
| Value | Description |
|---|---|
| “JSON” |
ApiKeyAuthWorkspaceConnectionProperties_ValueFormat_STATUS
Used by: ApiKeyAuthWorkspaceConnectionProperties_STATUS.
| Value | Description |
|---|---|
| “JSON” |
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 |
| customServices | List of Custom Services added to the compute. | CustomService[] 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 |
| personalComputeInstanceSettings | Settings for a personal compute instance. | PersonalComputeInstanceSettings Optional |
| schedules | The list of schedules to be applied on the computes. | ComputeSchedules 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 |
| containers | Describes informations of containers on this ComputeInstance. | ComputeInstanceContainer_STATUS[] Optional |
| createdBy | Describes information on user who created this ComputeInstance. | ComputeInstanceCreatedBy_STATUS Optional |
| customServices | List of Custom Services added to the compute. | CustomService_STATUS[] Optional |
| dataDisks | Describes informations of dataDisks on this ComputeInstance. | ComputeInstanceDataDisk_STATUS[] Optional |
| dataMounts | Describes informations of dataMounts on this ComputeInstance. | ComputeInstanceDataMount_STATUS[] 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 on this ComputeInstance. | ErrorResponse_STATUS[] Optional |
| lastOperation | The last operation on ComputeInstance. | ComputeInstanceLastOperation_STATUS Optional |
| osImageMetadata | Returns metadata about the operating system image for this compute instance. | ImageMetadata_STATUS Optional |
| personalComputeInstanceSettings | Settings for a personal compute instance. | PersonalComputeInstanceSettings_STATUS Optional |
| schedules | The list of schedules to be applied on the computes. | ComputeSchedules_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 |
| versions | ComputeInstance version. | ComputeInstanceVersion_STATUS Optional |
| vmSize | Virtual Machine Size | string Optional |
ConnectionCategory
Category of the connection
Used by: AADAuthTypeWorkspaceConnectionProperties, AccessKeyAuthTypeWorkspaceConnectionProperties, AccountKeyAuthTypeWorkspaceConnectionProperties, ApiKeyAuthWorkspaceConnectionProperties, CustomKeysWorkspaceConnectionProperties, ManagedIdentityAuthTypeWorkspaceConnectionProperties, NoneAuthTypeWorkspaceConnectionProperties, OAuth2AuthTypeWorkspaceConnectionProperties, PATAuthTypeWorkspaceConnectionProperties, SASAuthTypeWorkspaceConnectionProperties, ServicePrincipalAuthTypeWorkspaceConnectionProperties, and UsernamePasswordAuthTypeWorkspaceConnectionProperties.
| Value | Description |
|---|---|
| “ADLSGen2” | |
| “AIServices” | |
| “AmazonMws” | |
| “AmazonRdsForOracle” | |
| “AmazonRdsForSqlServer” | |
| “AmazonRedshift” | |
| “AmazonS3Compatible” | |
| “ApiKey” | |
| “AzureBlob” | |
| “AzureDataExplorer” | |
| “AzureDatabricksDeltaLake” | |
| “AzureMariaDb” | |
| “AzureMySqlDb” | |
| “AzureOneLake” | |
| “AzureOpenAI” | |
| “AzurePostgresDb” | |
| “AzureSqlDb” | |
| “AzureSqlMi” | |
| “AzureSynapseAnalytics” | |
| “AzureTableStorage” | |
| “BingLLMSearch” | |
| “Cassandra” | |
| “CognitiveSearch” | |
| “CognitiveService” | |
| “Concur” | |
| “ContainerRegistry” | |
| “CosmosDb” | |
| “CosmosDbMongoDbApi” | |
| “Couchbase” | |
| “CustomKeys” | |
| “Db2” | |
| “Drill” | |
| “Dynamics” | |
| “DynamicsAx” | |
| “DynamicsCrm” | |
| “Eloqua” | |
| “FileServer” | |
| “FtpServer” | |
| “GenericContainerRegistry” | |
| “GenericHttp” | |
| “GenericRest” | |
| “Git” | |
| “GoogleAdWords” | |
| “GoogleBigQuery” | |
| “GoogleCloudStorage” | |
| “Greenplum” | |
| “Hbase” | |
| “Hdfs” | |
| “Hive” | |
| “Hubspot” | |
| “Impala” | |
| “Informix” | |
| “Jira” | |
| “Magento” | |
| “MariaDb” | |
| “Marketo” | |
| “MicrosoftAccess” | |
| “MongoDbAtlas” | |
| “MongoDbV2” | |
| “MySql” | |
| “Netezza” | |
| “ODataRest” | |
| “Odbc” | |
| “Office365” | |
| “OpenAI” | |
| “Oracle” | |
| “OracleCloudStorage” | |
| “OracleServiceCloud” | |
| “PayPal” | |
| “Phoenix” | |
| “PostgreSql” | |
| “Presto” | |
| “PythonFeed” | |
| “QuickBooks” | |
| “Redis” | |
| “Responsys” | |
| “S3” | |
| “Salesforce” | |
| “SalesforceMarketingCloud” | |
| “SalesforceServiceCloud” | |
| “SapBw” | |
| “SapCloudForCustomer” | |
| “SapEcc” | |
| “SapHana” | |
| “SapOpenHub” | |
| “SapTable” | |
| “Serp” | |
| “Serverless” | |
| “ServiceNow” | |
| “Sftp” | |
| “SharePointOnlineList” | |
| “Shopify” | |
| “Snowflake” | |
| “Spark” | |
| “SqlServer” | |
| “Square” | |
| “Sybase” | |
| “Teradata” | |
| “Vertica” | |
| “WebTable” | |
| “Xero” | |
| “Zoho” |
ConnectionCategory_STATUS
Category of the connection
Used by: AADAuthTypeWorkspaceConnectionProperties_STATUS, AccessKeyAuthTypeWorkspaceConnectionProperties_STATUS, AccountKeyAuthTypeWorkspaceConnectionProperties_STATUS, ApiKeyAuthWorkspaceConnectionProperties_STATUS, CustomKeysWorkspaceConnectionProperties_STATUS, ManagedIdentityAuthTypeWorkspaceConnectionProperties_STATUS, NoneAuthTypeWorkspaceConnectionProperties_STATUS, OAuth2AuthTypeWorkspaceConnectionProperties_STATUS, PATAuthTypeWorkspaceConnectionProperties_STATUS, SASAuthTypeWorkspaceConnectionProperties_STATUS, ServicePrincipalAuthTypeWorkspaceConnectionProperties_STATUS, and UsernamePasswordAuthTypeWorkspaceConnectionProperties_STATUS.
| Value | Description |
|---|---|
| “ADLSGen2” | |
| “AIServices” | |
| “AmazonMws” | |
| “AmazonRdsForOracle” | |
| “AmazonRdsForSqlServer” | |
| “AmazonRedshift” | |
| “AmazonS3Compatible” | |
| “ApiKey” | |
| “AzureBlob” | |
| “AzureDataExplorer” | |
| “AzureDatabricksDeltaLake” | |
| “AzureMariaDb” | |
| “AzureMySqlDb” | |
| “AzureOneLake” | |
| “AzureOpenAI” | |
| “AzurePostgresDb” | |
| “AzureSqlDb” | |
| “AzureSqlMi” | |
| “AzureSynapseAnalytics” | |
| “AzureTableStorage” | |
| “BingLLMSearch” | |
| “Cassandra” | |
| “CognitiveSearch” | |
| “CognitiveService” | |
| “Concur” | |
| “ContainerRegistry” | |
| “CosmosDb” | |
| “CosmosDbMongoDbApi” | |
| “Couchbase” | |
| “CustomKeys” | |
| “Db2” | |
| “Drill” | |
| “Dynamics” | |
| “DynamicsAx” | |
| “DynamicsCrm” | |
| “Eloqua” | |
| “FileServer” | |
| “FtpServer” | |
| “GenericContainerRegistry” | |
| “GenericHttp” | |
| “GenericRest” | |
| “Git” | |
| “GoogleAdWords” | |
| “GoogleBigQuery” | |
| “GoogleCloudStorage” | |
| “Greenplum” | |
| “Hbase” | |
| “Hdfs” | |
| “Hive” | |
| “Hubspot” | |
| “Impala” | |
| “Informix” | |
| “Jira” | |
| “Magento” | |
| “MariaDb” | |
| “Marketo” | |
| “MicrosoftAccess” | |
| “MongoDbAtlas” | |
| “MongoDbV2” | |
| “MySql” | |
| “Netezza” | |
| “ODataRest” | |
| “Odbc” | |
| “Office365” | |
| “OpenAI” | |
| “Oracle” | |
| “OracleCloudStorage” | |
| “OracleServiceCloud” | |
| “PayPal” | |
| “Phoenix” | |
| “PostgreSql” | |
| “Presto” | |
| “PythonFeed” | |
| “QuickBooks” | |
| “Redis” | |
| “Responsys” | |
| “S3” | |
| “Salesforce” | |
| “SalesforceMarketingCloud” | |
| “SalesforceServiceCloud” | |
| “SapBw” | |
| “SapCloudForCustomer” | |
| “SapEcc” | |
| “SapHana” | |
| “SapOpenHub” | |
| “SapTable” | |
| “Serp” | |
| “Serverless” | |
| “ServiceNow” | |
| “Sftp” | |
| “SharePointOnlineList” | |
| “Shopify” | |
| “Snowflake” | |
| “Spark” | |
| “SqlServer” | |
| “Square” | |
| “Sybase” | |
| “Teradata” | |
| “Vertica” | |
| “WebTable” | |
| “Xero” | |
| “Zoho” |
ConnectionGroup_STATUS
Group based on connection category
Used by: AADAuthTypeWorkspaceConnectionProperties_STATUS, AccessKeyAuthTypeWorkspaceConnectionProperties_STATUS, AccountKeyAuthTypeWorkspaceConnectionProperties_STATUS, ApiKeyAuthWorkspaceConnectionProperties_STATUS, CustomKeysWorkspaceConnectionProperties_STATUS, ManagedIdentityAuthTypeWorkspaceConnectionProperties_STATUS, NoneAuthTypeWorkspaceConnectionProperties_STATUS, OAuth2AuthTypeWorkspaceConnectionProperties_STATUS, PATAuthTypeWorkspaceConnectionProperties_STATUS, SASAuthTypeWorkspaceConnectionProperties_STATUS, ServicePrincipalAuthTypeWorkspaceConnectionProperties_STATUS, and UsernamePasswordAuthTypeWorkspaceConnectionProperties_STATUS.
| Value | Description |
|---|---|
| “Azure” | |
| “AzureAI” | |
| “Database” | |
| “File” | |
| “GenericProtocol” | |
| “NoSQL” | |
| “ServicesAndApps” |
CustomKeys
Custom Keys credential object
Used by: CustomKeysWorkspaceConnectionProperties.
| Property | Description | Type |
|---|---|---|
| keys | genruntime.SecretMapReference Optional |
CustomKeys_STATUS
Custom Keys credential object
Used by: CustomKeysWorkspaceConnectionProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| keys | map[string]string Optional |
CustomKeysWorkspaceConnectionProperties_AuthType
Used by: CustomKeysWorkspaceConnectionProperties.
| Value | Description |
|---|---|
| “CustomKeys” |
CustomKeysWorkspaceConnectionProperties_AuthType_STATUS
Used by: CustomKeysWorkspaceConnectionProperties_STATUS.
| Value | Description |
|---|---|
| “CustomKeys” |
CustomKeysWorkspaceConnectionProperties_ValueFormat
Used by: CustomKeysWorkspaceConnectionProperties.
| Value | Description |
|---|---|
| “JSON” |
CustomKeysWorkspaceConnectionProperties_ValueFormat_STATUS
Used by: CustomKeysWorkspaceConnectionProperties_STATUS.
| Value | Description |
|---|---|
| “JSON” |
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” |
EndpointServiceConnectionStatus
Connection status of the service consumer with the service provider
Used by: RegistryPrivateLinkServiceConnectionState.
| Value | Description |
|---|---|
| “Approved” | |
| “Disconnected” | |
| “Pending” | |
| “Rejected” |
EndpointServiceConnectionStatus_STATUS
Connection status of the service consumer with the service provider
Used by: RegistryPrivateLinkServiceConnectionState_STATUS.
| Value | Description |
|---|---|
| “Approved” | |
| “Disconnected” | |
| “Pending” | |
| “Rejected” |
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 |
FqdnOutboundRule
Used by: OutboundRule.
| Property | Description | Type |
|---|---|---|
| category | Category of a managed network Outbound Rule of a machine learning workspace. | RuleCategory Optional |
| destination | string Optional |
|
| status | Type of a managed network Outbound Rule of a machine learning workspace. | RuleStatus Optional |
| type | FqdnOutboundRule_Type Required |
FqdnOutboundRule_STATUS
Used by: OutboundRule_STATUS.
| Property | Description | Type |
|---|---|---|
| category | Category of a managed network Outbound Rule of a machine learning workspace. | RuleCategory_STATUS Optional |
| destination | string Optional |
|
| status | Type of a managed network Outbound Rule of a machine learning workspace. | RuleStatus_STATUS Optional |
| type | FqdnOutboundRule_Type_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 |
| extensionPrincipalIdFromConfig | Extension principal-id. | genruntime.ConfigMapReference 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 |
ManagedIdentityAuthTypeWorkspaceConnectionProperties_AuthType
Used by: ManagedIdentityAuthTypeWorkspaceConnectionProperties.
| Value | Description |
|---|---|
| “ManagedIdentity” |
ManagedIdentityAuthTypeWorkspaceConnectionProperties_AuthType_STATUS
Used by: ManagedIdentityAuthTypeWorkspaceConnectionProperties_STATUS.
| Value | Description |
|---|---|
| “ManagedIdentity” |
ManagedIdentityAuthTypeWorkspaceConnectionProperties_ValueFormat
Used by: ManagedIdentityAuthTypeWorkspaceConnectionProperties.
| Value | Description |
|---|---|
| “JSON” |
ManagedIdentityAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS
Used by: ManagedIdentityAuthTypeWorkspaceConnectionProperties_STATUS.
| Value | Description |
|---|---|
| “JSON” |
ManagedNetworkStatus
Status for the managed network of a machine learning workspace.
Used by: ManagedNetworkProvisionStatus.
| Value | Description |
|---|---|
| “Active” | |
| “Inactive” |
ManagedNetworkStatus_STATUS
Status for the managed network of a machine learning workspace.
Used by: ManagedNetworkProvisionStatus_STATUS.
| Value | Description |
|---|---|
| “Active” | |
| “Inactive” |
NoneAuthTypeWorkspaceConnectionProperties_AuthType
Used by: NoneAuthTypeWorkspaceConnectionProperties.
| Value | Description |
|---|---|
| “None” |
NoneAuthTypeWorkspaceConnectionProperties_AuthType_STATUS
Used by: NoneAuthTypeWorkspaceConnectionProperties_STATUS.
| Value | Description |
|---|---|
| “None” |
NoneAuthTypeWorkspaceConnectionProperties_ValueFormat
Used by: NoneAuthTypeWorkspaceConnectionProperties.
| Value | Description |
|---|---|
| “JSON” |
NoneAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS
Used by: NoneAuthTypeWorkspaceConnectionProperties_STATUS.
| Value | Description |
|---|---|
| “JSON” |
OAuth2AuthTypeWorkspaceConnectionProperties_AuthType
Used by: OAuth2AuthTypeWorkspaceConnectionProperties.
| Value | Description |
|---|---|
| “OAuth2” |
OAuth2AuthTypeWorkspaceConnectionProperties_AuthType_STATUS
Used by: OAuth2AuthTypeWorkspaceConnectionProperties_STATUS.
| Value | Description |
|---|---|
| “OAuth2” |
OAuth2AuthTypeWorkspaceConnectionProperties_ValueFormat
Used by: OAuth2AuthTypeWorkspaceConnectionProperties.
| Value | Description |
|---|---|
| “JSON” |
OAuth2AuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS
Used by: OAuth2AuthTypeWorkspaceConnectionProperties_STATUS.
| Value | Description |
|---|---|
| “JSON” |
PATAuthTypeWorkspaceConnectionProperties_AuthType
Used by: PATAuthTypeWorkspaceConnectionProperties.
| Value | Description |
|---|---|
| “PAT” |
PATAuthTypeWorkspaceConnectionProperties_AuthType_STATUS
Used by: PATAuthTypeWorkspaceConnectionProperties_STATUS.
| Value | Description |
|---|---|
| “PAT” |
PATAuthTypeWorkspaceConnectionProperties_ValueFormat
Used by: PATAuthTypeWorkspaceConnectionProperties.
| Value | Description |
|---|---|
| “JSON” |
PATAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS
Used by: PATAuthTypeWorkspaceConnectionProperties_STATUS.
| Value | Description |
|---|---|
| “JSON” |
PrivateEndpointOutboundRule
Used by: OutboundRule.
| Property | Description | Type |
|---|---|---|
| category | Category of a managed network Outbound Rule of a machine learning workspace. | RuleCategory Optional |
| destination | Private Endpoint destination for a Private Endpoint Outbound Rule for the managed network of a machine learning workspace. | PrivateEndpointDestination Optional |
| status | Type of a managed network Outbound Rule of a machine learning workspace. | RuleStatus Optional |
| type | PrivateEndpointOutboundRule_Type Required |
PrivateEndpointOutboundRule_STATUS
Used by: OutboundRule_STATUS.
| Property | Description | Type |
|---|---|---|
| category | Category of a managed network Outbound Rule of a machine learning workspace. | RuleCategory_STATUS Optional |
| destination | Private Endpoint destination for a Private Endpoint Outbound Rule for the managed network of a machine learning workspace. | PrivateEndpointDestination_STATUS Optional |
| status | Type of a managed network Outbound Rule of a machine learning workspace. | RuleStatus_STATUS Optional |
| type | PrivateEndpointOutboundRule_Type_STATUS Optional |
SASAuthTypeWorkspaceConnectionProperties_AuthType
Used by: SASAuthTypeWorkspaceConnectionProperties.
| Value | Description |
|---|---|
| “SAS” |
SASAuthTypeWorkspaceConnectionProperties_AuthType_STATUS
Used by: SASAuthTypeWorkspaceConnectionProperties_STATUS.
| Value | Description |
|---|---|
| “SAS” |
SASAuthTypeWorkspaceConnectionProperties_ValueFormat
Used by: SASAuthTypeWorkspaceConnectionProperties.
| Value | Description |
|---|---|
| “JSON” |
SASAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS
Used by: SASAuthTypeWorkspaceConnectionProperties_STATUS.
| Value | Description |
|---|---|
| “JSON” |
ServicePrincipalAuthTypeWorkspaceConnectionProperties_AuthType
Used by: ServicePrincipalAuthTypeWorkspaceConnectionProperties.
| Value | Description |
|---|---|
| “ServicePrincipal” |
ServicePrincipalAuthTypeWorkspaceConnectionProperties_AuthType_STATUS
Used by: ServicePrincipalAuthTypeWorkspaceConnectionProperties_STATUS.
| Value | Description |
|---|---|
| “ServicePrincipal” |
ServicePrincipalAuthTypeWorkspaceConnectionProperties_ValueFormat
Used by: ServicePrincipalAuthTypeWorkspaceConnectionProperties.
| Value | Description |
|---|---|
| “JSON” |
ServicePrincipalAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS
Used by: ServicePrincipalAuthTypeWorkspaceConnectionProperties_STATUS.
| Value | Description |
|---|---|
| “JSON” |
ServiceTagOutboundRule
Used by: OutboundRule.
| Property | Description | Type |
|---|---|---|
| category | Category of a managed network Outbound Rule of a machine learning workspace. | RuleCategory Optional |
| destination | Service Tag destination for a Service Tag Outbound Rule for the managed network of a machine learning workspace. | ServiceTagDestination Optional |
| status | Type of a managed network Outbound Rule of a machine learning workspace. | RuleStatus Optional |
| type | ServiceTagOutboundRule_Type Required |
ServiceTagOutboundRule_STATUS
Used by: OutboundRule_STATUS.
| Property | Description | Type |
|---|---|---|
| category | Category of a managed network Outbound Rule of a machine learning workspace. | RuleCategory_STATUS Optional |
| destination | Service Tag destination for a Service Tag Outbound Rule for the managed network of a machine learning workspace. | ServiceTagDestination_STATUS Optional |
| status | Type of a managed network Outbound Rule of a machine learning workspace. | RuleStatus_STATUS Optional |
| type | ServiceTagOutboundRule_Type_STATUS 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” |
SystemCreatedAcrAccount
Used by: AcrDetails.
| Property | Description | Type |
|---|---|---|
| acrAccountName | Name of the ACR account | string Optional |
| acrAccountSku | SKU of the ACR account | string Optional |
SystemCreatedAcrAccount_STATUS
Used by: AcrDetails_STATUS.
| Property | Description | Type |
|---|---|---|
| acrAccountName | Name of the ACR account | string Optional |
| acrAccountSku | SKU of the ACR account | string Optional |
| armResourceId | This is populated once the ACR account is created. | ArmResourceId_STATUS Optional |
SystemCreatedStorageAccount
Used by: StorageAccountDetails.
| Property | Description | Type |
|---|---|---|
| allowBlobPublicAccess | Public blob access allowed | bool Optional |
| storageAccountHnsEnabled | HNS enabled for storage account | bool Optional |
| storageAccountName | Name of the storage account | string Optional |
| storageAccountType | Allowed values: “Standard_LRS”, “Standard_GRS”, “Standard_RAGRS”, “Standard_ZRS”, “Standard_GZRS”, “Standard_RAGZRS”, “Premium_LRS”, “Premium_ZRS” | string Optional |
SystemCreatedStorageAccount_STATUS
Used by: StorageAccountDetails_STATUS.
| Property | Description | Type |
|---|---|---|
| allowBlobPublicAccess | Public blob access allowed | bool Optional |
| armResourceId | This is populated once the storage account is created. | ArmResourceId_STATUS Optional |
| storageAccountHnsEnabled | HNS enabled for storage account | bool Optional |
| storageAccountName | Name of the storage account | string Optional |
| storageAccountType | Allowed values: “Standard_LRS”, “Standard_GRS”, “Standard_RAGRS”, “Standard_ZRS”, “Standard_GZRS”, “Standard_RAGZRS”, “Premium_LRS”, “Premium_ZRS” | string Optional |
UserCreatedAcrAccount
Used by: AcrDetails.
| Property | Description | Type |
|---|---|---|
| armResourceId | ARM ResourceId of a resource | ArmResourceId Optional |
UserCreatedAcrAccount_STATUS
Used by: AcrDetails_STATUS.
| Property | Description | Type |
|---|---|---|
| armResourceId | ARM ResourceId of a resource | ArmResourceId_STATUS Optional |
UserCreatedStorageAccount
Used by: StorageAccountDetails.
| Property | Description | Type |
|---|---|---|
| armResourceId | ARM ResourceId of a resource | ArmResourceId Optional |
UserCreatedStorageAccount_STATUS
Used by: StorageAccountDetails_STATUS.
| Property | Description | Type |
|---|---|---|
| armResourceId | ARM ResourceId of a resource | ArmResourceId_STATUS Optional |
UsernamePasswordAuthTypeWorkspaceConnectionProperties_AuthType
Used by: UsernamePasswordAuthTypeWorkspaceConnectionProperties.
| Value | Description |
|---|---|
| “UsernamePassword” |
UsernamePasswordAuthTypeWorkspaceConnectionProperties_AuthType_STATUS
Used by: UsernamePasswordAuthTypeWorkspaceConnectionProperties_STATUS.
| Value | Description |
|---|---|
| “UsernamePassword” |
UsernamePasswordAuthTypeWorkspaceConnectionProperties_ValueFormat
Used by: UsernamePasswordAuthTypeWorkspaceConnectionProperties.
| Value | Description |
|---|---|
| “JSON” |
UsernamePasswordAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS
Used by: UsernamePasswordAuthTypeWorkspaceConnectionProperties_STATUS.
| Value | Description |
|---|---|
| “JSON” |
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 |
| notebookServerPort | Notebook server port open for ssh connections. | int 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 |
| notebookServerPort | Notebook server port open for ssh connections. | int 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” |
WorkspaceConnectionAccessKey
Used by: AccessKeyAuthTypeWorkspaceConnectionProperties.
| Property | Description | Type |
|---|---|---|
| accessKeyId | string Optional |
|
| secretAccessKey | genruntime.SecretReference Optional |
WorkspaceConnectionAccessKey_STATUS
Used by: AccessKeyAuthTypeWorkspaceConnectionProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| accessKeyId | string Optional |
WorkspaceConnectionAccountKey
Used by: AccountKeyAuthTypeWorkspaceConnectionProperties.
| Property | Description | Type |
|---|---|---|
| key | genruntime.SecretReference Optional |
WorkspaceConnectionApiKey
Api key object for workspace connection credential.
Used by: ApiKeyAuthWorkspaceConnectionProperties.
| Property | Description | Type |
|---|---|---|
| key | genruntime.SecretReference Optional |
WorkspaceConnectionManagedIdentity
Used by: ManagedIdentityAuthTypeWorkspaceConnectionProperties.
| Property | Description | Type |
|---|---|---|
| clientId | string Optional |
|
| clientIdFromConfig | genruntime.ConfigMapReference Optional |
|
| resourceReference | genruntime.ResourceReference Optional |
WorkspaceConnectionManagedIdentity_STATUS
Used by: ManagedIdentityAuthTypeWorkspaceConnectionProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| clientId | string Optional |
|
| resourceId | string Optional |
WorkspaceConnectionOAuth2
ClientId and ClientSecret are required. Other properties are optional depending on each OAuth2 provider’s implementation.
Used by: OAuth2AuthTypeWorkspaceConnectionProperties.
| Property | Description | Type |
|---|---|---|
| authUrl | Required by Concur connection category | string Optional |
| clientId | Client id in the format of UUID | string Optional |
| clientIdFromConfig | Client id in the format of UUID | genruntime.ConfigMapReference Optional |
| clientSecret | genruntime.SecretReference Optional |
|
| developerToken | Required by GoogleAdWords connection category | genruntime.SecretReference Optional |
| password | genruntime.SecretReference Optional |
|
| refreshToken | Required by GoogleBigQuery, GoogleAdWords, Hubspot, QuickBooks, Square, Xero, Zoho where user needs to get RefreshToken offline | genruntime.SecretReference Optional |
| tenantId | Required by QuickBooks and Xero connection categories | string Optional |
| tenantIdFromConfig | Required by QuickBooks and Xero connection categories | genruntime.ConfigMapReference Optional |
| username | Concur, ServiceNow auth server AccessToken grant type is ‘Password’ which requires UsernamePassword | string Optional |
WorkspaceConnectionOAuth2_STATUS
ClientId and ClientSecret are required. Other properties are optional depending on each OAuth2 provider’s implementation.
Used by: OAuth2AuthTypeWorkspaceConnectionProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| authUrl | Required by Concur connection category | string Optional |
| clientId | Client id in the format of UUID | string Optional |
| tenantId | Required by QuickBooks and Xero connection categories | string Optional |
| username | Concur, ServiceNow auth server AccessToken grant type is ‘Password’ which requires UsernamePassword | string Optional |
WorkspaceConnectionPersonalAccessToken
Used by: PATAuthTypeWorkspaceConnectionProperties.
| Property | Description | Type |
|---|---|---|
| pat | genruntime.SecretReference Optional |
WorkspaceConnectionServicePrincipal
Used by: ServicePrincipalAuthTypeWorkspaceConnectionProperties.
| Property | Description | Type |
|---|---|---|
| clientId | string Optional |
|
| clientIdFromConfig | genruntime.ConfigMapReference Optional |
|
| clientSecret | genruntime.SecretReference Optional |
|
| tenantId | string Optional |
|
| tenantIdFromConfig | genruntime.ConfigMapReference Optional |
WorkspaceConnectionServicePrincipal_STATUS
Used by: ServicePrincipalAuthTypeWorkspaceConnectionProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| clientId | string Optional |
|
| tenantId | string Optional |
WorkspaceConnectionSharedAccessSignature
Used by: SASAuthTypeWorkspaceConnectionProperties.
| Property | Description | Type |
|---|---|---|
| sas | genruntime.SecretReference Optional |
WorkspaceConnectionUsernamePassword
Used by: UsernamePasswordAuthTypeWorkspaceConnectionProperties.
| Property | Description | Type |
|---|---|---|
| password | genruntime.SecretReference Optional |
|
| securityToken | Optional, required by connections like SalesForce for extra security in addition to UsernamePassword | genruntime.SecretReference Optional |
| username | string Optional |
WorkspaceConnectionUsernamePassword_STATUS
Used by: UsernamePasswordAuthTypeWorkspaceConnectionProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| username | string Optional |
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 |
ComputeInstanceContainer_STATUS
Defines an Aml Instance container.
Used by: ComputeInstanceProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| autosave | Auto save settings. | ComputeInstanceContainer_Autosave_STATUS Optional |
| environment | Environment information of this container. | ComputeInstanceEnvironmentInfo_STATUS Optional |
| gpu | Information of GPU. | string Optional |
| name | Name of the ComputeInstance container. | string Optional |
| network | network of this container. | ComputeInstanceContainer_Network_STATUS Optional |
| services | services of this containers. | map[string]v1.JSON[] 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 |
ComputeInstanceDataDisk_STATUS
Defines an Aml Instance DataDisk.
Used by: ComputeInstanceProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| caching | Caching type of Data Disk. | ComputeInstanceDataDisk_Caching_STATUS Optional |
| diskSizeGB | The initial disk size in gigabytes. | int Optional |
| lun | The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun. | int Optional |
| storageAccountType | type of this storage account. | ComputeInstanceDataDisk_StorageAccountType_STATUS Optional |
ComputeInstanceDataMount_STATUS
Defines an Aml Instance DataMount.
Used by: ComputeInstanceProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| createdBy | who this data mount created by. | string Optional |
| error | Error of this data mount. | string Optional |
| mountAction | Mount Action. | ComputeInstanceDataMount_MountAction_STATUS Optional |
| mountedOn | The time when the disk mounted. | string Optional |
| mountName | name of the ComputeInstance data mount. | string Optional |
| mountPath | Path of this data mount. | string Optional |
| mountState | Mount state. | ComputeInstanceDataMount_MountState_STATUS Optional |
| source | Source of the ComputeInstance data mount. | string Optional |
| sourceType | Data source type. | ComputeInstanceDataMount_SourceType_STATUS 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 |
| operationTrigger | Trigger of operation. | ComputeInstanceLastOperation_OperationTrigger_STATUS 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” |
ComputeInstanceVersion_STATUS
Version of computeInstance.
Used by: ComputeInstanceProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| runtime | Runtime of compute instance. | string Optional |
ComputeSchedules
The list of schedules to be applied on the computes
Used by: ComputeInstanceProperties.
| Property | Description | Type |
|---|---|---|
| computeStartStop | The list of compute start stop schedules to be applied. | ComputeStartStopSchedule[] Optional |
ComputeSchedules_STATUS
The list of schedules to be applied on the computes
Used by: ComputeInstanceProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| computeStartStop | The list of compute start stop schedules to be applied. | ComputeStartStopSchedule_STATUS[] Optional |
CustomService
Specifies the custom service configuration
Used by: ComputeInstanceProperties.
| Property | Description | Type |
|---|---|---|
| docker | Describes the docker settings for the image | Docker Optional |
| endpoints | Configuring the endpoints for the container | Endpoint[] Optional |
| environmentVariables | Environment Variable for the container | map[string]EnvironmentVariable Optional |
| image | Describes the Image Specifications | Image Optional |
| name | Name of the Custom Service | string Optional |
| volumes | Configuring the volumes for the container | VolumeDefinition[] Optional |
CustomService_STATUS
Specifies the custom service configuration
Used by: ComputeInstanceProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| docker | Describes the docker settings for the image | Docker_STATUS Optional |
| endpoints | Configuring the endpoints for the container | Endpoint_STATUS[] Optional |
| environmentVariables | Environment Variable for the container | map[string]EnvironmentVariable_STATUS Optional |
| image | Describes the Image Specifications | Image_STATUS Optional |
| name | Name of the Custom Service | string Optional |
| volumes | Configuring the volumes for the container | VolumeDefinition_STATUS[] Optional |
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 |
FqdnOutboundRule_Type
Used by: FqdnOutboundRule.
| Value | Description |
|---|---|
| “FQDN” |
FqdnOutboundRule_Type_STATUS
Used by: FqdnOutboundRule_STATUS.
| Value | Description |
|---|---|
| “FQDN” |
ImageMetadata_STATUS
Returns metadata about the operating system image for this compute instance.
Used by: ComputeInstanceProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| currentImageVersion | Specifies the current operating system image version this compute instance is running on. | string Optional |
| isLatestOsImageVersion | Specifies whether this compute instance is running on the latest operating system image. | bool Optional |
| latestImageVersion | Specifies the latest available operating system image version. | 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 |
PrivateEndpointDestination
Private Endpoint destination for a Private Endpoint Outbound Rule for the managed network of a machine learning workspace.
Used by: PrivateEndpointOutboundRule.
| Property | Description | Type |
|---|---|---|
| serviceResourceReference | genruntime.ResourceReference Optional |
|
| sparkEnabled | bool Optional |
|
| sparkStatus | Type of a managed network Outbound Rule of a machine learning workspace. | RuleStatus Optional |
| subresourceTargetReference | genruntime.ResourceReference Optional |
PrivateEndpointDestination_STATUS
Private Endpoint destination for a Private Endpoint Outbound Rule for the managed network of a machine learning workspace.
Used by: PrivateEndpointOutboundRule_STATUS.
| Property | Description | Type |
|---|---|---|
| serviceResourceId | string Optional |
|
| sparkEnabled | bool Optional |
|
| sparkStatus | Type of a managed network Outbound Rule of a machine learning workspace. | RuleStatus_STATUS Optional |
| subresourceTarget | string Optional |
PrivateEndpointOutboundRule_Type
Used by: PrivateEndpointOutboundRule.
| Value | Description |
|---|---|
| “PrivateEndpoint” |
PrivateEndpointOutboundRule_Type_STATUS
Used by: PrivateEndpointOutboundRule_STATUS.
| Value | Description |
|---|---|
| “PrivateEndpoint” |
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 |
RuleCategory
Category of a managed network Outbound Rule of a machine learning workspace.
Used by: FqdnOutboundRule, PrivateEndpointOutboundRule, and ServiceTagOutboundRule.
| Value | Description |
|---|---|
| “Dependency” | |
| “Recommended” | |
| “Required” | |
| “UserDefined” |
RuleCategory_STATUS
Category of a managed network Outbound Rule of a machine learning workspace.
Used by: FqdnOutboundRule_STATUS, PrivateEndpointOutboundRule_STATUS, and ServiceTagOutboundRule_STATUS.
| Value | Description |
|---|---|
| “Dependency” | |
| “Recommended” | |
| “Required” | |
| “UserDefined” |
RuleStatus
Type of a managed network Outbound Rule of a machine learning workspace.
Used by: FqdnOutboundRule, PrivateEndpointDestination, PrivateEndpointOutboundRule, and ServiceTagOutboundRule.
| Value | Description |
|---|---|
| “Active” | |
| “Inactive” |
RuleStatus_STATUS
Type of a managed network Outbound Rule of a machine learning workspace.
Used by: FqdnOutboundRule_STATUS, PrivateEndpointDestination_STATUS, PrivateEndpointOutboundRule_STATUS, and ServiceTagOutboundRule_STATUS.
| Value | Description |
|---|---|
| “Active” | |
| “Inactive” |
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 |
ServiceTagDestination
Service Tag destination for a Service Tag Outbound Rule for the managed network of a machine learning workspace.
Used by: ServiceTagOutboundRule.
| Property | Description | Type |
|---|---|---|
| action | The action enum for networking rule. | RuleAction Optional |
| portRanges | string Optional |
|
| protocol | string Optional |
|
| serviceTag | string Optional |
ServiceTagDestination_STATUS
Service Tag destination for a Service Tag Outbound Rule for the managed network of a machine learning workspace.
Used by: ServiceTagOutboundRule_STATUS.
| Property | Description | Type |
|---|---|---|
| action | The action enum for networking rule. | RuleAction_STATUS Optional |
| addressPrefixes | Optional, if provided, the ServiceTag property will be ignored. | string[] Optional |
| portRanges | string Optional |
|
| protocol | string Optional |
|
| serviceTag | string Optional |
ServiceTagOutboundRule_Type
Used by: ServiceTagOutboundRule.
| Value | Description |
|---|---|
| “ServiceTag” |
ServiceTagOutboundRule_Type_STATUS
Used by: ServiceTagOutboundRule_STATUS.
| Value | Description |
|---|---|
| “ServiceTag” |
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 Optional |
| objectIdFromConfig | User’s AAD Object Id. | genruntime.ConfigMapReference Optional |
| tenantId | User’s AAD Tenant Id. | string Optional |
| tenantIdFromConfig | User’s AAD Tenant Id. | genruntime.ConfigMapReference Optional |
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 |
ComputeInstanceContainer_Autosave_STATUS
Used by: ComputeInstanceContainer_STATUS.
| Value | Description |
|---|---|
| “Local” | |
| “None” | |
| “Remote” |
ComputeInstanceContainer_Network_STATUS
Used by: ComputeInstanceContainer_STATUS.
| Value | Description |
|---|---|
| “Bridge” | |
| “Host” |
ComputeInstanceDataDisk_Caching_STATUS
Used by: ComputeInstanceDataDisk_STATUS.
| Value | Description |
|---|---|
| “None” | |
| “ReadOnly” | |
| “ReadWrite” |
ComputeInstanceDataDisk_StorageAccountType_STATUS
Used by: ComputeInstanceDataDisk_STATUS.
| Value | Description |
|---|---|
| “Premium_LRS” | |
| “Standard_LRS” |
ComputeInstanceDataMount_MountAction_STATUS
Used by: ComputeInstanceDataMount_STATUS.
| Value | Description |
|---|---|
| “Mount” | |
| “Unmount” |
ComputeInstanceDataMount_MountState_STATUS
Used by: ComputeInstanceDataMount_STATUS.
| Value | Description |
|---|---|
| “MountFailed” | |
| “MountRequested” | |
| “Mounted” | |
| “UnmountFailed” | |
| “UnmountRequested” | |
| “Unmounted” |
ComputeInstanceDataMount_SourceType_STATUS
Used by: ComputeInstanceDataMount_STATUS.
| Value | Description |
|---|---|
| “Dataset” | |
| “Datastore” | |
| “URI” |
ComputeInstanceEnvironmentInfo_STATUS
Environment information
Used by: ComputeInstanceContainer_STATUS.
| Property | Description | Type |
|---|---|---|
| name | name of environment. | string Optional |
| version | version of environment. | 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” |
ComputeInstanceLastOperation_OperationTrigger_STATUS
Used by: ComputeInstanceLastOperation_STATUS.
| Value | Description |
|---|---|
| “IdleShutdown” | |
| “Schedule” | |
| “User” |
ComputeInstanceSshSettings_SshPublicAccess
Used by: ComputeInstanceSshSettings.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
ComputeInstanceSshSettings_SshPublicAccess_STATUS
Used by: ComputeInstanceSshSettings_STATUS.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
ComputeStartStopSchedule
Compute start stop schedule properties
Used by: ComputeSchedules.
| Property | Description | Type |
|---|---|---|
| action | [Required] The compute power action. | ComputePowerAction Optional |
| cron | Required if triggerType is Cron. | Cron Optional |
| recurrence | Required if triggerType is Recurrence. | Recurrence Optional |
| schedule | [Deprecated] Not used any more. | ScheduleBase Optional |
| status | Is the schedule enabled or disabled? | ScheduleStatus Optional |
| triggerType | [Required] The schedule trigger type. | ComputeTriggerType Optional |
ComputeStartStopSchedule_STATUS
Compute start stop schedule properties
Used by: ComputeSchedules_STATUS.
| Property | Description | Type |
|---|---|---|
| action | [Required] The compute power action. | ComputePowerAction_STATUS Optional |
| cron | Required if triggerType is Cron. | Cron_STATUS Optional |
| id | A system assigned id for the schedule. | string Optional |
| provisioningStatus | The current deployment state of schedule. | ComputeStartStopSchedule_ProvisioningStatus_STATUS Optional |
| recurrence | Required if triggerType is Recurrence. | Recurrence_STATUS Optional |
| schedule | [Deprecated] Not used any more. | ScheduleBase_STATUS Optional |
| status | Is the schedule enabled or disabled? | ScheduleStatus_STATUS Optional |
| triggerType | [Required] The schedule trigger type. | ComputeTriggerType_STATUS Optional |
Docker
Docker container configuration
Used by: CustomService.
| Property | Description | Type |
|---|---|---|
| privileged | Indicate whether container shall run in privileged or non-privileged mode. | bool Optional |
Docker_STATUS
Docker container configuration
Used by: CustomService_STATUS.
| Property | Description | Type |
|---|---|---|
| privileged | Indicate whether container shall run in privileged or non-privileged mode. | bool Optional |
Endpoint
Describes the endpoint configuration for the container
Used by: CustomService.
| Property | Description | Type |
|---|---|---|
| hostIp | Host IP over which the application is exposed from the container | string Optional |
| name | Name of the Endpoint | string Optional |
| protocol | Protocol over which communication will happen over this endpoint | Endpoint_Protocol Optional |
| published | Port over which the application is exposed from container. | int Optional |
| target | Application port inside the container. | int Optional |
Endpoint_STATUS
Describes the endpoint configuration for the container
Used by: CustomService_STATUS.
| Property | Description | Type |
|---|---|---|
| hostIp | Host IP over which the application is exposed from the container | string Optional |
| name | Name of the Endpoint | string Optional |
| protocol | Protocol over which communication will happen over this endpoint | Endpoint_Protocol_STATUS Optional |
| published | Port over which the application is exposed from container. | int Optional |
| target | Application port inside the container. | int Optional |
EnvironmentVariable
Environment Variables for the container
Used by: CustomService.
| Property | Description | Type |
|---|---|---|
| type | Type of the Environment Variable. Possible values are: local - For local variable | EnvironmentVariable_Type Optional |
| value | Value of the Environment variable | string Optional |
EnvironmentVariable_STATUS
Environment Variables for the container
Used by: CustomService_STATUS.
| Property | Description | Type |
|---|---|---|
| type | Type of the Environment Variable. Possible values are: local - For local variable | EnvironmentVariable_Type_STATUS Optional |
| value | Value of the Environment variable | string Optional |
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 |
Image
Describes the Image Specifications
Used by: CustomService.
| Property | Description | Type |
|---|---|---|
| reference | Image reference | string Optional |
| type | Type of the image. Possible values are: docker - For docker images. azureml - For AzureML images | Image_Type Optional |
Image_STATUS
Describes the Image Specifications
Used by: CustomService_STATUS.
| Property | Description | Type |
|---|---|---|
| reference | Image reference | string Optional |
| type | Type of the image. Possible values are: docker - For docker images. azureml - For AzureML images | Image_Type_STATUS 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 |
RuleAction
The action enum for networking rule.
Used by: ServiceTagDestination.
| Value | Description |
|---|---|
| “Allow” | |
| “Deny” |
RuleAction_STATUS
The action enum for networking rule.
Used by: ServiceTagDestination_STATUS.
| Value | Description |
|---|---|
| “Allow” | |
| “Deny” |
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” |
VolumeDefinition
Describes the volume configuration for the container
Used by: CustomService.
| Property | Description | Type |
|---|---|---|
| bind | Bind Options of the mount | BindOptions Optional |
| consistency | Consistency of the volume | string Optional |
| readOnly | Indicate whether to mount volume as readOnly. Default value for this is false. | bool Optional |
| source | Source of the mount. For bind mounts this is the host path. | string Optional |
| target | Target of the mount. For bind mounts this is the path in the container. | string Optional |
| tmpfs | tmpfs option of the mount | TmpfsOptions Optional |
| type | Type of Volume Definition. Possible Values: bind,volume,tmpfs,npipe | VolumeDefinition_Type Optional |
| volume | Volume Options of the mount | VolumeOptions Optional |
VolumeDefinition_STATUS
Describes the volume configuration for the container
Used by: CustomService_STATUS.
| Property | Description | Type |
|---|---|---|
| bind | Bind Options of the mount | BindOptions_STATUS Optional |
| consistency | Consistency of the volume | string Optional |
| readOnly | Indicate whether to mount volume as readOnly. Default value for this is false. | bool Optional |
| source | Source of the mount. For bind mounts this is the host path. | string Optional |
| target | Target of the mount. For bind mounts this is the path in the container. | string Optional |
| tmpfs | tmpfs option of the mount | TmpfsOptions_STATUS Optional |
| type | Type of Volume Definition. Possible Values: bind,volume,tmpfs,npipe | VolumeDefinition_Type_STATUS Optional |
| volume | Volume Options of the mount | VolumeOptions_STATUS Optional |
BindOptions
Describes the bind options for the container
Used by: VolumeDefinition.
| Property | Description | Type |
|---|---|---|
| createHostPath | Indicate whether to create host path. | bool Optional |
| propagation | Type of Bind Option | string Optional |
| selinux | Mention the selinux options. | string Optional |
BindOptions_STATUS
Describes the bind options for the container
Used by: VolumeDefinition_STATUS.
| Property | Description | Type |
|---|---|---|
| createHostPath | Indicate whether to create host path. | bool Optional |
| propagation | Type of Bind Option | string Optional |
| selinux | Mention the selinux options. | string Optional |
ComputePowerAction
The compute power action.
Used by: ComputeStartStopSchedule.
| Value | Description |
|---|---|
| “Start” | |
| “Stop” |
ComputePowerAction_STATUS
The compute power action.
Used by: ComputeStartStopSchedule_STATUS.
| Value | Description |
|---|---|
| “Start” | |
| “Stop” |
ComputeStartStopSchedule_ProvisioningStatus_STATUS
Used by: ComputeStartStopSchedule_STATUS.
| Value | Description |
|---|---|
| “Completed” | |
| “Failed” | |
| “Provisioning” |
ComputeTriggerType
Is the trigger type recurrence or cron.
Used by: ComputeStartStopSchedule.
| Value | Description |
|---|---|
| “Cron” | |
| “Recurrence” |
ComputeTriggerType_STATUS
Is the trigger type recurrence or cron.
Used by: ComputeStartStopSchedule_STATUS.
| Value | Description |
|---|---|
| “Cron” | |
| “Recurrence” |
Cron
The workflow trigger cron for ComputeStartStop schedule type.
Used by: ComputeStartStopSchedule.
| Property | Description | Type |
|---|---|---|
| expression | [Required] Specifies cron expression of schedule. The expression should follow NCronTab format. | string Optional |
| startTime | The start time in yyyy-MM-ddTHH:mm:ss format. | string Optional |
| timeZone | Specifies time zone in which the schedule runs. TimeZone should follow Windows time zone format. Refer: https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11 | string Optional |
Cron_STATUS
The workflow trigger cron for ComputeStartStop schedule type.
Used by: ComputeStartStopSchedule_STATUS.
| Property | Description | Type |
|---|---|---|
| expression | [Required] Specifies cron expression of schedule. The expression should follow NCronTab format. | string Optional |
| startTime | The start time in yyyy-MM-ddTHH:mm:ss format. | string Optional |
| timeZone | Specifies time zone in which the schedule runs. TimeZone should follow Windows time zone format. Refer: https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11 | string Optional |
Endpoint_Protocol
Used by: Endpoint.
| Value | Description |
|---|---|
| “http” | |
| “tcp” | |
| “udp” |
Endpoint_Protocol_STATUS
Used by: Endpoint_STATUS.
| Value | Description |
|---|---|
| “http” | |
| “tcp” | |
| “udp” |
EnvironmentVariable_Type
Used by: EnvironmentVariable.
| Value | Description |
|---|---|
| “local” |
EnvironmentVariable_Type_STATUS
Used by: EnvironmentVariable_STATUS.
| Value | Description |
|---|---|
| “local” |
Image_Type
Used by: Image.
| Value | Description |
|---|---|
| “azureml” | |
| “docker” |
Image_Type_STATUS
Used by: Image_STATUS.
| Value | Description |
|---|---|
| “azureml” | |
| “docker” |
Recurrence
The workflow trigger recurrence for ComputeStartStop schedule type.
Used by: ComputeStartStopSchedule.
| Property | Description | Type |
|---|---|---|
| frequency | [Required] The frequency to trigger schedule. | ComputeRecurrenceFrequency Optional |
| interval | [Required] Specifies schedule interval in conjunction with frequency | int Optional |
| schedule | [Required] The recurrence schedule. | ComputeRecurrenceSchedule Optional |
| startTime | The start time in yyyy-MM-ddTHH:mm:ss format. | string Optional |
| timeZone | Specifies time zone in which the schedule runs. TimeZone should follow Windows time zone format. Refer: https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11 | string Optional |
Recurrence_STATUS
The workflow trigger recurrence for ComputeStartStop schedule type.
Used by: ComputeStartStopSchedule_STATUS.
| Property | Description | Type |
|---|---|---|
| frequency | [Required] The frequency to trigger schedule. | ComputeRecurrenceFrequency_STATUS Optional |
| interval | [Required] Specifies schedule interval in conjunction with frequency | int Optional |
| schedule | [Required] The recurrence schedule. | ComputeRecurrenceSchedule_STATUS Optional |
| startTime | The start time in yyyy-MM-ddTHH:mm:ss format. | string Optional |
| timeZone | Specifies time zone in which the schedule runs. TimeZone should follow Windows time zone format. Refer: https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11 | string Optional |
ScheduleBase
Used by: ComputeStartStopSchedule.
| Property | Description | Type |
|---|---|---|
| provisioningStatus | The current deployment state of schedule. | ScheduleProvisioningState Optional |
| reference | A system assigned id for the schedule. | genruntime.ResourceReference Optional |
| status | Is the schedule enabled or disabled? | ScheduleStatus Optional |
ScheduleBase_STATUS
Used by: ComputeStartStopSchedule_STATUS.
| Property | Description | Type |
|---|---|---|
| id | A system assigned id for the schedule. | string Optional |
| provisioningStatus | The current deployment state of schedule. | ScheduleProvisioningState_STATUS Optional |
| status | Is the schedule enabled or disabled? | ScheduleStatus_STATUS Optional |
ScheduleStatus
Is the schedule enabled or disabled?
Used by: ComputeStartStopSchedule, and ScheduleBase.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
ScheduleStatus_STATUS
Is the schedule enabled or disabled?
Used by: ComputeStartStopSchedule_STATUS, and ScheduleBase_STATUS.
| Value | Description |
|---|---|
| “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: 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: workspace. | string Optional |
| timeout | Optional time period passed to timeout command. | string Optional |
TmpfsOptions
Describes the tmpfs options for the container
Used by: VolumeDefinition.
| Property | Description | Type |
|---|---|---|
| size | Mention the Tmpfs size | int Optional |
TmpfsOptions_STATUS
Describes the tmpfs options for the container
Used by: VolumeDefinition_STATUS.
| Property | Description | Type |
|---|---|---|
| size | Mention the Tmpfs size | int Optional |
VolumeDefinition_Type
Used by: VolumeDefinition.
| Value | Description |
|---|---|
| “bind” | |
| “npipe” | |
| “tmpfs” | |
| “volume” |
VolumeDefinition_Type_STATUS
Used by: VolumeDefinition_STATUS.
| Value | Description |
|---|---|
| “bind” | |
| “npipe” | |
| “tmpfs” | |
| “volume” |
VolumeOptions
Describes the volume options for the container
Used by: VolumeDefinition.
| Property | Description | Type |
|---|---|---|
| nocopy | Indicate whether volume is nocopy | bool Optional |
VolumeOptions_STATUS
Describes the volume options for the container
Used by: VolumeDefinition_STATUS.
| Property | Description | Type |
|---|---|---|
| nocopy | Indicate whether volume is nocopy | bool Optional |
ComputeRecurrenceFrequency
Enum to describe the frequency of a compute recurrence schedule
Used by: Recurrence.
| Value | Description |
|---|---|
| “Day” | |
| “Hour” | |
| “Minute” | |
| “Month” | |
| “Week” |
ComputeRecurrenceFrequency_STATUS
Enum to describe the frequency of a compute recurrence schedule
Used by: Recurrence_STATUS.
| Value | Description |
|---|---|
| “Day” | |
| “Hour” | |
| “Minute” | |
| “Month” | |
| “Week” |
ComputeRecurrenceSchedule
Used by: Recurrence.
| Property | Description | Type |
|---|---|---|
| hours | [Required] List of hours for the schedule. | int[] Required |
| minutes | [Required] List of minutes for the schedule. | int[] Required |
| monthDays | List of month days for the schedule | int[] Optional |
| weekDays | List of days for the schedule. | ComputeWeekDay[] Optional |
ComputeRecurrenceSchedule_STATUS
Used by: Recurrence_STATUS.
| Property | Description | Type |
|---|---|---|
| hours | [Required] List of hours for the schedule. | int[] Optional |
| minutes | [Required] List of minutes for the schedule. | int[] Optional |
| monthDays | List of month days for the schedule | int[] Optional |
| weekDays | List of days for the schedule. | ComputeWeekDay_STATUS[] Optional |
ScheduleProvisioningState
The current deployment state of schedule.
Used by: ScheduleBase.
| Value | Description |
|---|---|
| “Completed” | |
| “Failed” | |
| “Provisioning” |
ScheduleProvisioningState_STATUS
The current deployment state of schedule.
Used by: ScheduleBase_STATUS.
| Value | Description |
|---|---|
| “Completed” | |
| “Failed” | |
| “Provisioning” |
ComputeWeekDay
Enum of weekday
Used by: ComputeRecurrenceSchedule.
| Value | Description |
|---|---|
| “Friday” | |
| “Monday” | |
| “Saturday” | |
| “Sunday” | |
| “Thursday” | |
| “Tuesday” | |
| “Wednesday” |
ComputeWeekDay_STATUS
Enum of weekday
Used by: ComputeRecurrenceSchedule_STATUS.
| Value | Description |
|---|---|
| “Friday” | |
| “Monday” | |
| “Saturday” | |
| “Sunday” | |
| “Thursday” | |
| “Tuesday” | |
| “Wednesday” |