machinelearningservices.azure.com/v1api20240401

machinelearningservices.azure.com/v1api20240401

Package v1api20240401 contains API Schema definitions for the machinelearningservices v1api20240401 API group

Resource Types:

    AADAuthTypeWorkspaceConnectionProperties

    (Appears on:WorkspaceConnectionPropertiesV2)

    Field Description
    authType
    AADAuthTypeWorkspaceConnectionProperties_AuthType

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory

    Category: Category of the connection

    expiryTime
    string
    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    AADAuthTypeWorkspaceConnectionProperties_ValueFormat

    ValueFormat: format for the workspace connection value

    AADAuthTypeWorkspaceConnectionProperties_ARM

    (Appears on:WorkspaceConnectionPropertiesV2_ARM)

    Field Description
    authType
    AADAuthTypeWorkspaceConnectionProperties_AuthType_ARM

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory_ARM

    Category: Category of the connection

    expiryTime
    string
    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    AADAuthTypeWorkspaceConnectionProperties_ValueFormat_ARM

    ValueFormat: format for the workspace connection value

    AADAuthTypeWorkspaceConnectionProperties_AuthType (string alias)

    (Appears on:AADAuthTypeWorkspaceConnectionProperties)

    Value Description

    "AAD"

    AADAuthTypeWorkspaceConnectionProperties_AuthType_ARM (string alias)

    (Appears on:AADAuthTypeWorkspaceConnectionProperties_ARM)

    Value Description

    "AAD"

    AADAuthTypeWorkspaceConnectionProperties_AuthType_STATUS (string alias)

    (Appears on:AADAuthTypeWorkspaceConnectionProperties_STATUS)

    Value Description

    "AAD"

    AADAuthTypeWorkspaceConnectionProperties_AuthType_STATUS_ARM (string alias)

    (Appears on:AADAuthTypeWorkspaceConnectionProperties_STATUS_ARM)

    Value Description

    "AAD"

    AADAuthTypeWorkspaceConnectionProperties_STATUS

    (Appears on:WorkspaceConnectionPropertiesV2_STATUS)

    Field Description
    authType
    AADAuthTypeWorkspaceConnectionProperties_AuthType_STATUS

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory_STATUS

    Category: Category of the connection

    createdByWorkspaceArmId
    string
    expiryTime
    string
    group
    ConnectionGroup_STATUS

    Group: Group based on connection category

    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    AADAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS

    ValueFormat: format for the workspace connection value

    AADAuthTypeWorkspaceConnectionProperties_STATUS_ARM

    (Appears on:WorkspaceConnectionPropertiesV2_STATUS_ARM)

    Field Description
    authType
    AADAuthTypeWorkspaceConnectionProperties_AuthType_STATUS_ARM

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory_STATUS_ARM

    Category: Category of the connection

    createdByWorkspaceArmId
    string
    expiryTime
    string
    group
    ConnectionGroup_STATUS_ARM

    Group: Group based on connection category

    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    AADAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS_ARM

    ValueFormat: format for the workspace connection value

    AADAuthTypeWorkspaceConnectionProperties_ValueFormat (string alias)

    (Appears on:AADAuthTypeWorkspaceConnectionProperties)

    Value Description

    "JSON"

    AADAuthTypeWorkspaceConnectionProperties_ValueFormat_ARM (string alias)

    (Appears on:AADAuthTypeWorkspaceConnectionProperties_ARM)

    Value Description

    "JSON"

    AADAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS (string alias)

    (Appears on:AADAuthTypeWorkspaceConnectionProperties_STATUS)

    Value Description

    "JSON"

    AADAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS_ARM (string alias)

    (Appears on:AADAuthTypeWorkspaceConnectionProperties_STATUS_ARM)

    Value Description

    "JSON"

    AKS

    (Appears on:Compute)

    Field Description
    computeLocation
    string

    ComputeLocation: Location for the underlying compute

    computeType
    AKS_ComputeType

    ComputeType: The type of compute

    description
    string

    Description: The description of the Machine Learning compute.

    disableLocalAuth
    bool

    DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.

    properties
    AKS_Properties

    Properties: AKS properties

    resourceReference
    genruntime.ResourceReference

    ResourceReference: ARM resource id of the underlying compute

    AKS_ARM

    (Appears on:Compute_ARM)

    Field Description
    computeLocation
    string

    ComputeLocation: Location for the underlying compute

    computeType
    AKS_ComputeType_ARM

    ComputeType: The type of compute

    description
    string

    Description: The description of the Machine Learning compute.

    disableLocalAuth
    bool

    DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.

    properties
    AKS_Properties_ARM

    Properties: AKS properties

    resourceId
    string

    AKS_ComputeType (string alias)

    (Appears on:AKS)

    Value Description

    "AKS"

    AKS_ComputeType_ARM (string alias)

    (Appears on:AKS_ARM)

    Value Description

    "AKS"

    AKS_ComputeType_STATUS (string alias)

    (Appears on:AKS_STATUS)

    Value Description

    "AKS"

    AKS_ComputeType_STATUS_ARM (string alias)

    (Appears on:AKS_STATUS_ARM)

    Value Description

    "AKS"

    AKS_Properties

    (Appears on:AKS)

    Field Description
    agentCount
    int

    AgentCount: Number of agents

    agentVmSize
    string

    AgentVmSize: Agent virtual machine size

    aksNetworkingConfiguration
    AksNetworkingConfiguration

    AksNetworkingConfiguration: AKS networking configuration for vnet

    clusterFqdn
    string

    ClusterFqdn: Cluster full qualified domain name

    clusterPurpose
    AKS_Properties_ClusterPurpose

    ClusterPurpose: Intended usage of the cluster

    loadBalancerSubnetReference
    genruntime.ResourceReference

    LoadBalancerSubnetReference: Load Balancer Subnet

    loadBalancerType
    AKS_Properties_LoadBalancerType

    LoadBalancerType: Load Balancer Type

    sslConfiguration
    SslConfiguration

    SslConfiguration: SSL configuration

    AKS_Properties_ARM

    (Appears on:AKS_ARM)

    Field Description
    agentCount
    int

    AgentCount: Number of agents

    agentVmSize
    string

    AgentVmSize: Agent virtual machine size

    aksNetworkingConfiguration
    AksNetworkingConfiguration_ARM

    AksNetworkingConfiguration: AKS networking configuration for vnet

    clusterFqdn
    string

    ClusterFqdn: Cluster full qualified domain name

    clusterPurpose
    AKS_Properties_ClusterPurpose_ARM

    ClusterPurpose: Intended usage of the cluster

    loadBalancerSubnet
    string
    loadBalancerType
    AKS_Properties_LoadBalancerType_ARM

    LoadBalancerType: Load Balancer Type

    sslConfiguration
    SslConfiguration_ARM

    SslConfiguration: SSL configuration

    AKS_Properties_ClusterPurpose (string alias)

    (Appears on:AKS_Properties)

    Value Description

    "DenseProd"

    "DevTest"

    "FastProd"

    AKS_Properties_ClusterPurpose_ARM (string alias)

    (Appears on:AKS_Properties_ARM)

    Value Description

    "DenseProd"

    "DevTest"

    "FastProd"

    AKS_Properties_ClusterPurpose_STATUS (string alias)

    (Appears on:AKS_Properties_STATUS)

    Value Description

    "DenseProd"

    "DevTest"

    "FastProd"

    AKS_Properties_ClusterPurpose_STATUS_ARM (string alias)

    (Appears on:AKS_Properties_STATUS_ARM)

    Value Description

    "DenseProd"

    "DevTest"

    "FastProd"

    AKS_Properties_LoadBalancerType (string alias)

    (Appears on:AKS_Properties)

    Value Description

    "InternalLoadBalancer"

    "PublicIp"

    AKS_Properties_LoadBalancerType_ARM (string alias)

    (Appears on:AKS_Properties_ARM)

    Value Description

    "InternalLoadBalancer"

    "PublicIp"

    AKS_Properties_LoadBalancerType_STATUS (string alias)

    (Appears on:AKS_Properties_STATUS)

    Value Description

    "InternalLoadBalancer"

    "PublicIp"

    AKS_Properties_LoadBalancerType_STATUS_ARM (string alias)

    (Appears on:AKS_Properties_STATUS_ARM)

    Value Description

    "InternalLoadBalancer"

    "PublicIp"

    AKS_Properties_STATUS

    (Appears on:AKS_STATUS)

    Field Description
    agentCount
    int

    AgentCount: Number of agents

    agentVmSize
    string

    AgentVmSize: Agent virtual machine size

    aksNetworkingConfiguration
    AksNetworkingConfiguration_STATUS

    AksNetworkingConfiguration: AKS networking configuration for vnet

    clusterFqdn
    string

    ClusterFqdn: Cluster full qualified domain name

    clusterPurpose
    AKS_Properties_ClusterPurpose_STATUS

    ClusterPurpose: Intended usage of the cluster

    loadBalancerSubnet
    string

    LoadBalancerSubnet: Load Balancer Subnet

    loadBalancerType
    AKS_Properties_LoadBalancerType_STATUS

    LoadBalancerType: Load Balancer Type

    sslConfiguration
    SslConfiguration_STATUS

    SslConfiguration: SSL configuration

    systemServices
    []SystemService_STATUS

    SystemServices: System services

    AKS_Properties_STATUS_ARM

    (Appears on:AKS_STATUS_ARM)

    Field Description
    agentCount
    int

    AgentCount: Number of agents

    agentVmSize
    string

    AgentVmSize: Agent virtual machine size

    aksNetworkingConfiguration
    AksNetworkingConfiguration_STATUS_ARM

    AksNetworkingConfiguration: AKS networking configuration for vnet

    clusterFqdn
    string

    ClusterFqdn: Cluster full qualified domain name

    clusterPurpose
    AKS_Properties_ClusterPurpose_STATUS_ARM

    ClusterPurpose: Intended usage of the cluster

    loadBalancerSubnet
    string

    LoadBalancerSubnet: Load Balancer Subnet

    loadBalancerType
    AKS_Properties_LoadBalancerType_STATUS_ARM

    LoadBalancerType: Load Balancer Type

    sslConfiguration
    SslConfiguration_STATUS_ARM

    SslConfiguration: SSL configuration

    systemServices
    []SystemService_STATUS_ARM

    SystemServices: System services

    AKS_ProvisioningState_STATUS (string alias)

    (Appears on:AKS_STATUS)

    Value Description

    "Canceled"

    "Creating"

    "Deleting"

    "Failed"

    "Succeeded"

    "Unknown"

    "Updating"

    AKS_ProvisioningState_STATUS_ARM (string alias)

    (Appears on:AKS_STATUS_ARM)

    Value Description

    "Canceled"

    "Creating"

    "Deleting"

    "Failed"

    "Succeeded"

    "Unknown"

    "Updating"

    AKS_STATUS

    (Appears on:Compute_STATUS)

    Field Description
    computeLocation
    string

    ComputeLocation: Location for the underlying compute

    computeType
    AKS_ComputeType_STATUS

    ComputeType: The type of compute

    createdOn
    string

    CreatedOn: The time at which the compute was created.

    description
    string

    Description: The description of the Machine Learning compute.

    disableLocalAuth
    bool

    DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.

    isAttachedCompute
    bool

    IsAttachedCompute: Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.

    modifiedOn
    string

    ModifiedOn: The time at which the compute was last modified.

    properties
    AKS_Properties_STATUS

    Properties: AKS properties

    provisioningErrors
    []ErrorResponse_STATUS

    ProvisioningErrors: Errors during provisioning

    provisioningState
    AKS_ProvisioningState_STATUS

    ProvisioningState: The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.

    resourceId
    string

    ResourceId: ARM resource id of the underlying compute

    AKS_STATUS_ARM

    (Appears on:Compute_STATUS_ARM)

    Field Description
    computeLocation
    string

    ComputeLocation: Location for the underlying compute

    computeType
    AKS_ComputeType_STATUS_ARM

    ComputeType: The type of compute

    createdOn
    string

    CreatedOn: The time at which the compute was created.

    description
    string

    Description: The description of the Machine Learning compute.

    disableLocalAuth
    bool

    DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.

    isAttachedCompute
    bool

    IsAttachedCompute: Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.

    modifiedOn
    string

    ModifiedOn: The time at which the compute was last modified.

    properties
    AKS_Properties_STATUS_ARM

    Properties: AKS properties

    provisioningErrors
    []ErrorResponse_STATUS_ARM

    ProvisioningErrors: Errors during provisioning

    provisioningState
    AKS_ProvisioningState_STATUS_ARM

    ProvisioningState: The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.

    resourceId
    string

    ResourceId: ARM resource id of the underlying compute

    APIVersion (string alias)

    Value Description

    "2024-04-01"

    AccessKeyAuthTypeWorkspaceConnectionProperties

    (Appears on:WorkspaceConnectionPropertiesV2)

    Field Description
    authType
    AccessKeyAuthTypeWorkspaceConnectionProperties_AuthType

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory

    Category: Category of the connection

    credentials
    WorkspaceConnectionAccessKey
    expiryTime
    string
    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    AccessKeyAuthTypeWorkspaceConnectionProperties_ValueFormat

    ValueFormat: format for the workspace connection value

    AccessKeyAuthTypeWorkspaceConnectionProperties_ARM

    (Appears on:WorkspaceConnectionPropertiesV2_ARM)

    Field Description
    authType
    AccessKeyAuthTypeWorkspaceConnectionProperties_AuthType_ARM

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory_ARM

    Category: Category of the connection

    credentials
    WorkspaceConnectionAccessKey_ARM
    expiryTime
    string
    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    AccessKeyAuthTypeWorkspaceConnectionProperties_ValueFormat_ARM

    ValueFormat: format for the workspace connection value

    AccessKeyAuthTypeWorkspaceConnectionProperties_AuthType (string alias)

    (Appears on:AccessKeyAuthTypeWorkspaceConnectionProperties)

    Value Description

    "AccessKey"

    AccessKeyAuthTypeWorkspaceConnectionProperties_AuthType_ARM (string alias)

    (Appears on:AccessKeyAuthTypeWorkspaceConnectionProperties_ARM)

    Value Description

    "AccessKey"

    AccessKeyAuthTypeWorkspaceConnectionProperties_AuthType_STATUS (string alias)

    (Appears on:AccessKeyAuthTypeWorkspaceConnectionProperties_STATUS)

    Value Description

    "AccessKey"

    AccessKeyAuthTypeWorkspaceConnectionProperties_AuthType_STATUS_ARM (string alias)

    (Appears on:AccessKeyAuthTypeWorkspaceConnectionProperties_STATUS_ARM)

    Value Description

    "AccessKey"

    AccessKeyAuthTypeWorkspaceConnectionProperties_STATUS

    (Appears on:WorkspaceConnectionPropertiesV2_STATUS)

    Field Description
    authType
    AccessKeyAuthTypeWorkspaceConnectionProperties_AuthType_STATUS

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory_STATUS

    Category: Category of the connection

    createdByWorkspaceArmId
    string
    credentials
    WorkspaceConnectionAccessKey_STATUS
    expiryTime
    string
    group
    ConnectionGroup_STATUS

    Group: Group based on connection category

    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    AccessKeyAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS

    ValueFormat: format for the workspace connection value

    AccessKeyAuthTypeWorkspaceConnectionProperties_STATUS_ARM

    (Appears on:WorkspaceConnectionPropertiesV2_STATUS_ARM)

    Field Description
    authType
    AccessKeyAuthTypeWorkspaceConnectionProperties_AuthType_STATUS_ARM

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory_STATUS_ARM

    Category: Category of the connection

    createdByWorkspaceArmId
    string
    credentials
    WorkspaceConnectionAccessKey_STATUS_ARM
    expiryTime
    string
    group
    ConnectionGroup_STATUS_ARM

    Group: Group based on connection category

    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    AccessKeyAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS_ARM

    ValueFormat: format for the workspace connection value

    AccessKeyAuthTypeWorkspaceConnectionProperties_ValueFormat (string alias)

    (Appears on:AccessKeyAuthTypeWorkspaceConnectionProperties)

    Value Description

    "JSON"

    AccessKeyAuthTypeWorkspaceConnectionProperties_ValueFormat_ARM (string alias)

    (Appears on:AccessKeyAuthTypeWorkspaceConnectionProperties_ARM)

    Value Description

    "JSON"

    AccessKeyAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS (string alias)

    (Appears on:AccessKeyAuthTypeWorkspaceConnectionProperties_STATUS)

    Value Description

    "JSON"

    AccessKeyAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS_ARM (string alias)

    (Appears on:AccessKeyAuthTypeWorkspaceConnectionProperties_STATUS_ARM)

    Value Description

    "JSON"

    AccountKeyAuthTypeWorkspaceConnectionProperties

    (Appears on:WorkspaceConnectionPropertiesV2)

    Field Description
    authType
    AccountKeyAuthTypeWorkspaceConnectionProperties_AuthType

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory

    Category: Category of the connection

    credentials
    WorkspaceConnectionAccountKey
    expiryTime
    string
    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    AccountKeyAuthTypeWorkspaceConnectionProperties_ValueFormat

    ValueFormat: format for the workspace connection value

    AccountKeyAuthTypeWorkspaceConnectionProperties_ARM

    (Appears on:WorkspaceConnectionPropertiesV2_ARM)

    Field Description
    authType
    AccountKeyAuthTypeWorkspaceConnectionProperties_AuthType_ARM

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory_ARM

    Category: Category of the connection

    credentials
    WorkspaceConnectionAccountKey_ARM
    expiryTime
    string
    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    AccountKeyAuthTypeWorkspaceConnectionProperties_ValueFormat_ARM

    ValueFormat: format for the workspace connection value

    AccountKeyAuthTypeWorkspaceConnectionProperties_AuthType (string alias)

    (Appears on:AccountKeyAuthTypeWorkspaceConnectionProperties)

    Value Description

    "AccountKey"

    AccountKeyAuthTypeWorkspaceConnectionProperties_AuthType_ARM (string alias)

    (Appears on:AccountKeyAuthTypeWorkspaceConnectionProperties_ARM)

    Value Description

    "AccountKey"

    AccountKeyAuthTypeWorkspaceConnectionProperties_AuthType_STATUS (string alias)

    (Appears on:AccountKeyAuthTypeWorkspaceConnectionProperties_STATUS)

    Value Description

    "AccountKey"

    AccountKeyAuthTypeWorkspaceConnectionProperties_AuthType_STATUS_ARM (string alias)

    (Appears on:AccountKeyAuthTypeWorkspaceConnectionProperties_STATUS_ARM)

    Value Description

    "AccountKey"

    AccountKeyAuthTypeWorkspaceConnectionProperties_STATUS

    (Appears on:WorkspaceConnectionPropertiesV2_STATUS)

    Field Description
    authType
    AccountKeyAuthTypeWorkspaceConnectionProperties_AuthType_STATUS

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory_STATUS

    Category: Category of the connection

    createdByWorkspaceArmId
    string
    credentials
    WorkspaceConnectionAccountKey_STATUS
    expiryTime
    string
    group
    ConnectionGroup_STATUS

    Group: Group based on connection category

    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    AccountKeyAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS

    ValueFormat: format for the workspace connection value

    AccountKeyAuthTypeWorkspaceConnectionProperties_STATUS_ARM

    (Appears on:WorkspaceConnectionPropertiesV2_STATUS_ARM)

    Field Description
    authType
    AccountKeyAuthTypeWorkspaceConnectionProperties_AuthType_STATUS_ARM

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory_STATUS_ARM

    Category: Category of the connection

    createdByWorkspaceArmId
    string
    credentials
    WorkspaceConnectionAccountKey_STATUS_ARM
    expiryTime
    string
    group
    ConnectionGroup_STATUS_ARM

    Group: Group based on connection category

    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    AccountKeyAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS_ARM

    ValueFormat: format for the workspace connection value

    AccountKeyAuthTypeWorkspaceConnectionProperties_ValueFormat (string alias)

    (Appears on:AccountKeyAuthTypeWorkspaceConnectionProperties)

    Value Description

    "JSON"

    AccountKeyAuthTypeWorkspaceConnectionProperties_ValueFormat_ARM (string alias)

    (Appears on:AccountKeyAuthTypeWorkspaceConnectionProperties_ARM)

    Value Description

    "JSON"

    AccountKeyAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS (string alias)

    (Appears on:AccountKeyAuthTypeWorkspaceConnectionProperties_STATUS)

    Value Description

    "JSON"

    AccountKeyAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS_ARM (string alias)

    (Appears on:AccountKeyAuthTypeWorkspaceConnectionProperties_STATUS_ARM)

    Value Description

    "JSON"

    AksNetworkingConfiguration

    (Appears on:AKS_Properties)

    Advance configuration for AKS networking

    Field Description
    dnsServiceIP
    string

    DnsServiceIP: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.

    dockerBridgeCidr
    string

    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.

    serviceCidr
    string

    ServiceCidr: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.

    subnetReference
    genruntime.ResourceReference

    SubnetReference: Virtual network subnet resource ID the compute nodes belong to

    AksNetworkingConfiguration_ARM

    (Appears on:AKS_Properties_ARM)

    Advance configuration for AKS networking

    Field Description
    dnsServiceIP
    string

    DnsServiceIP: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.

    dockerBridgeCidr
    string

    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.

    serviceCidr
    string

    ServiceCidr: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.

    subnetId
    string

    AksNetworkingConfiguration_STATUS

    (Appears on:AKS_Properties_STATUS)

    Advance configuration for AKS networking

    Field Description
    dnsServiceIP
    string

    DnsServiceIP: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.

    dockerBridgeCidr
    string

    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.

    serviceCidr
    string

    ServiceCidr: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.

    subnetId
    string

    SubnetId: Virtual network subnet resource ID the compute nodes belong to

    AksNetworkingConfiguration_STATUS_ARM

    (Appears on:AKS_Properties_STATUS_ARM)

    Advance configuration for AKS networking

    Field Description
    dnsServiceIP
    string

    DnsServiceIP: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.

    dockerBridgeCidr
    string

    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.

    serviceCidr
    string

    ServiceCidr: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.

    subnetId
    string

    SubnetId: Virtual network subnet resource ID the compute nodes belong to

    AmlCompute

    (Appears on:Compute)

    Field Description
    computeLocation
    string

    ComputeLocation: Location for the underlying compute

    computeType
    AmlCompute_ComputeType

    ComputeType: The type of compute

    description
    string

    Description: The description of the Machine Learning compute.

    disableLocalAuth
    bool

    DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.

    properties
    AmlComputeProperties

    Properties: Properties of AmlCompute

    resourceReference
    genruntime.ResourceReference

    ResourceReference: ARM resource id of the underlying compute

    AmlComputeProperties

    (Appears on:AmlCompute)

    AML Compute properties

    Field Description
    enableNodePublicIp
    bool

    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.

    isolatedNetwork
    bool

    IsolatedNetwork: Network is isolated or not

    osType
    AmlComputeProperties_OsType

    OsType: Compute OS Type

    propertyBag
    map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON

    PropertyBag: A property bag containing additional properties.

    remoteLoginPortPublicAccess
    AmlComputeProperties_RemoteLoginPortPublicAccess

    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.

    scaleSettings
    ScaleSettings

    ScaleSettings: Scale settings for AML Compute

    subnet
    ResourceId

    Subnet: Virtual network subnet resource ID the compute nodes belong to.

    userAccountCredentials
    UserAccountCredentials

    UserAccountCredentials: Credentials for an administrator user account that will be created on each compute node.

    virtualMachineImage
    VirtualMachineImage

    VirtualMachineImage: Virtual Machine image for AML Compute - windows only

    vmPriority
    AmlComputeProperties_VmPriority

    VmPriority: Virtual Machine priority

    vmSize
    string

    VmSize: Virtual Machine Size

    AmlComputeProperties_ARM

    (Appears on:AmlCompute_ARM)

    AML Compute properties

    Field Description
    enableNodePublicIp
    bool

    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.

    isolatedNetwork
    bool

    IsolatedNetwork: Network is isolated or not

    osType
    AmlComputeProperties_OsType_ARM

    OsType: Compute OS Type

    propertyBag
    map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON

    PropertyBag: A property bag containing additional properties.

    remoteLoginPortPublicAccess
    AmlComputeProperties_RemoteLoginPortPublicAccess_ARM

    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.

    scaleSettings
    ScaleSettings_ARM

    ScaleSettings: Scale settings for AML Compute

    subnet
    ResourceId_ARM

    Subnet: Virtual network subnet resource ID the compute nodes belong to.

    userAccountCredentials
    UserAccountCredentials_ARM

    UserAccountCredentials: Credentials for an administrator user account that will be created on each compute node.

    virtualMachineImage
    VirtualMachineImage_ARM

    VirtualMachineImage: Virtual Machine image for AML Compute - windows only

    vmPriority
    AmlComputeProperties_VmPriority_ARM

    VmPriority: Virtual Machine priority

    vmSize
    string

    VmSize: Virtual Machine Size

    AmlComputeProperties_AllocationState_STATUS (string alias)

    (Appears on:AmlComputeProperties_STATUS)

    Value Description

    "Resizing"

    "Steady"

    AmlComputeProperties_AllocationState_STATUS_ARM (string alias)

    (Appears on:AmlComputeProperties_STATUS_ARM)

    Value Description

    "Resizing"

    "Steady"

    AmlComputeProperties_OsType (string alias)

    (Appears on:AmlComputeProperties)

    Value Description

    "Linux"

    "Windows"

    AmlComputeProperties_OsType_ARM (string alias)

    (Appears on:AmlComputeProperties_ARM)

    Value Description

    "Linux"

    "Windows"

    AmlComputeProperties_OsType_STATUS (string alias)

    (Appears on:AmlComputeProperties_STATUS)

    Value Description

    "Linux"

    "Windows"

    AmlComputeProperties_OsType_STATUS_ARM (string alias)

    (Appears on:AmlComputeProperties_STATUS_ARM)

    Value Description

    "Linux"

    "Windows"

    AmlComputeProperties_RemoteLoginPortPublicAccess (string alias)

    (Appears on:AmlComputeProperties)

    Value Description

    "Disabled"

    "Enabled"

    "NotSpecified"

    AmlComputeProperties_RemoteLoginPortPublicAccess_ARM (string alias)

    (Appears on:AmlComputeProperties_ARM)

    Value Description

    "Disabled"

    "Enabled"

    "NotSpecified"

    AmlComputeProperties_RemoteLoginPortPublicAccess_STATUS (string alias)

    (Appears on:AmlComputeProperties_STATUS)

    Value Description

    "Disabled"

    "Enabled"

    "NotSpecified"

    AmlComputeProperties_RemoteLoginPortPublicAccess_STATUS_ARM (string alias)

    (Appears on:AmlComputeProperties_STATUS_ARM)

    Value Description

    "Disabled"

    "Enabled"

    "NotSpecified"

    AmlComputeProperties_STATUS

    (Appears on:AmlCompute_STATUS)

    AML Compute properties

    Field Description
    allocationState
    AmlComputeProperties_AllocationState_STATUS

    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.

    allocationStateTransitionTime
    string

    AllocationStateTransitionTime: The time at which the compute entered its current allocation state.

    currentNodeCount
    int

    CurrentNodeCount: The number of compute nodes currently assigned to the compute.

    enableNodePublicIp
    bool

    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.

    errors
    []ErrorResponse_STATUS

    Errors: Collection of errors encountered by various compute nodes during node setup.

    isolatedNetwork
    bool

    IsolatedNetwork: Network is isolated or not

    nodeStateCounts
    NodeStateCounts_STATUS

    NodeStateCounts: Counts of various node states on the compute.

    osType
    AmlComputeProperties_OsType_STATUS

    OsType: Compute OS Type

    propertyBag
    map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON

    PropertyBag: A property bag containing additional properties.

    remoteLoginPortPublicAccess
    AmlComputeProperties_RemoteLoginPortPublicAccess_STATUS

    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.

    scaleSettings
    ScaleSettings_STATUS

    ScaleSettings: Scale settings for AML Compute

    subnet
    ResourceId_STATUS

    Subnet: Virtual network subnet resource ID the compute nodes belong to.

    targetNodeCount
    int

    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.

    userAccountCredentials
    UserAccountCredentials_STATUS

    UserAccountCredentials: Credentials for an administrator user account that will be created on each compute node.

    virtualMachineImage
    VirtualMachineImage_STATUS

    VirtualMachineImage: Virtual Machine image for AML Compute - windows only

    vmPriority
    AmlComputeProperties_VmPriority_STATUS

    VmPriority: Virtual Machine priority

    vmSize
    string

    VmSize: Virtual Machine Size

    AmlComputeProperties_STATUS_ARM

    (Appears on:AmlCompute_STATUS_ARM)

    AML Compute properties

    Field Description
    allocationState
    AmlComputeProperties_AllocationState_STATUS_ARM

    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.

    allocationStateTransitionTime
    string

    AllocationStateTransitionTime: The time at which the compute entered its current allocation state.

    currentNodeCount
    int

    CurrentNodeCount: The number of compute nodes currently assigned to the compute.

    enableNodePublicIp
    bool

    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.

    errors
    []ErrorResponse_STATUS_ARM

    Errors: Collection of errors encountered by various compute nodes during node setup.

    isolatedNetwork
    bool

    IsolatedNetwork: Network is isolated or not

    nodeStateCounts
    NodeStateCounts_STATUS_ARM

    NodeStateCounts: Counts of various node states on the compute.

    osType
    AmlComputeProperties_OsType_STATUS_ARM

    OsType: Compute OS Type

    propertyBag
    map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON

    PropertyBag: A property bag containing additional properties.

    remoteLoginPortPublicAccess
    AmlComputeProperties_RemoteLoginPortPublicAccess_STATUS_ARM

    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.

    scaleSettings
    ScaleSettings_STATUS_ARM

    ScaleSettings: Scale settings for AML Compute

    subnet
    ResourceId_STATUS_ARM

    Subnet: Virtual network subnet resource ID the compute nodes belong to.

    targetNodeCount
    int

    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.

    userAccountCredentials
    UserAccountCredentials_STATUS_ARM

    UserAccountCredentials: Credentials for an administrator user account that will be created on each compute node.

    virtualMachineImage
    VirtualMachineImage_STATUS_ARM

    VirtualMachineImage: Virtual Machine image for AML Compute - windows only

    vmPriority
    AmlComputeProperties_VmPriority_STATUS_ARM

    VmPriority: Virtual Machine priority

    vmSize
    string

    VmSize: Virtual Machine Size

    AmlComputeProperties_VmPriority (string alias)

    (Appears on:AmlComputeProperties)

    Value Description

    "Dedicated"

    "LowPriority"

    AmlComputeProperties_VmPriority_ARM (string alias)

    (Appears on:AmlComputeProperties_ARM)

    Value Description

    "Dedicated"

    "LowPriority"

    AmlComputeProperties_VmPriority_STATUS (string alias)

    (Appears on:AmlComputeProperties_STATUS)

    Value Description

    "Dedicated"

    "LowPriority"

    AmlComputeProperties_VmPriority_STATUS_ARM (string alias)

    (Appears on:AmlComputeProperties_STATUS_ARM)

    Value Description

    "Dedicated"

    "LowPriority"

    AmlCompute_ARM

    (Appears on:Compute_ARM)

    Field Description
    computeLocation
    string

    ComputeLocation: Location for the underlying compute

    computeType
    AmlCompute_ComputeType_ARM

    ComputeType: The type of compute

    description
    string

    Description: The description of the Machine Learning compute.

    disableLocalAuth
    bool

    DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.

    properties
    AmlComputeProperties_ARM

    Properties: Properties of AmlCompute

    resourceId
    string

    AmlCompute_ComputeType (string alias)

    (Appears on:AmlCompute)

    Value Description

    "AmlCompute"

    AmlCompute_ComputeType_ARM (string alias)

    (Appears on:AmlCompute_ARM)

    Value Description

    "AmlCompute"

    AmlCompute_ComputeType_STATUS (string alias)

    (Appears on:AmlCompute_STATUS)

    Value Description

    "AmlCompute"

    AmlCompute_ComputeType_STATUS_ARM (string alias)

    (Appears on:AmlCompute_STATUS_ARM)

    Value Description

    "AmlCompute"

    AmlCompute_ProvisioningState_STATUS (string alias)

    (Appears on:AmlCompute_STATUS)

    Value Description

    "Canceled"

    "Creating"

    "Deleting"

    "Failed"

    "Succeeded"

    "Unknown"

    "Updating"

    AmlCompute_ProvisioningState_STATUS_ARM (string alias)

    (Appears on:AmlCompute_STATUS_ARM)

    Value Description

    "Canceled"

    "Creating"

    "Deleting"

    "Failed"

    "Succeeded"

    "Unknown"

    "Updating"

    AmlCompute_STATUS

    (Appears on:Compute_STATUS)

    Field Description
    computeLocation
    string

    ComputeLocation: Location for the underlying compute

    computeType
    AmlCompute_ComputeType_STATUS

    ComputeType: The type of compute

    createdOn
    string

    CreatedOn: The time at which the compute was created.

    description
    string

    Description: The description of the Machine Learning compute.

    disableLocalAuth
    bool

    DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.

    isAttachedCompute
    bool

    IsAttachedCompute: Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.

    modifiedOn
    string

    ModifiedOn: The time at which the compute was last modified.

    properties
    AmlComputeProperties_STATUS

    Properties: Properties of AmlCompute

    provisioningErrors
    []ErrorResponse_STATUS

    ProvisioningErrors: Errors during provisioning

    provisioningState
    AmlCompute_ProvisioningState_STATUS

    ProvisioningState: The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.

    resourceId
    string

    ResourceId: ARM resource id of the underlying compute

    AmlCompute_STATUS_ARM

    (Appears on:Compute_STATUS_ARM)

    Field Description
    computeLocation
    string

    ComputeLocation: Location for the underlying compute

    computeType
    AmlCompute_ComputeType_STATUS_ARM

    ComputeType: The type of compute

    createdOn
    string

    CreatedOn: The time at which the compute was created.

    description
    string

    Description: The description of the Machine Learning compute.

    disableLocalAuth
    bool

    DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.

    isAttachedCompute
    bool

    IsAttachedCompute: Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.

    modifiedOn
    string

    ModifiedOn: The time at which the compute was last modified.

    properties
    AmlComputeProperties_STATUS_ARM

    Properties: Properties of AmlCompute

    provisioningErrors
    []ErrorResponse_STATUS_ARM

    ProvisioningErrors: Errors during provisioning

    provisioningState
    AmlCompute_ProvisioningState_STATUS_ARM

    ProvisioningState: The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.

    resourceId
    string

    ResourceId: ARM resource id of the underlying compute

    ApiKeyAuthWorkspaceConnectionProperties

    (Appears on:WorkspaceConnectionPropertiesV2)

    Field Description
    authType
    ApiKeyAuthWorkspaceConnectionProperties_AuthType

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory

    Category: Category of the connection

    credentials
    WorkspaceConnectionApiKey

    Credentials: Api key object for workspace connection credential.

    expiryTime
    string
    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    ApiKeyAuthWorkspaceConnectionProperties_ValueFormat

    ValueFormat: format for the workspace connection value

    ApiKeyAuthWorkspaceConnectionProperties_ARM

    (Appears on:WorkspaceConnectionPropertiesV2_ARM)

    Field Description
    authType
    ApiKeyAuthWorkspaceConnectionProperties_AuthType_ARM

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory_ARM

    Category: Category of the connection

    credentials
    WorkspaceConnectionApiKey_ARM

    Credentials: Api key object for workspace connection credential.

    expiryTime
    string
    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    ApiKeyAuthWorkspaceConnectionProperties_ValueFormat_ARM

    ValueFormat: format for the workspace connection value

    ApiKeyAuthWorkspaceConnectionProperties_AuthType (string alias)

    (Appears on:ApiKeyAuthWorkspaceConnectionProperties)

    Value Description

    "ApiKey"

    ApiKeyAuthWorkspaceConnectionProperties_AuthType_ARM (string alias)

    (Appears on:ApiKeyAuthWorkspaceConnectionProperties_ARM)

    Value Description

    "ApiKey"

    ApiKeyAuthWorkspaceConnectionProperties_AuthType_STATUS (string alias)

    (Appears on:ApiKeyAuthWorkspaceConnectionProperties_STATUS)

    Value Description

    "ApiKey"

    ApiKeyAuthWorkspaceConnectionProperties_AuthType_STATUS_ARM (string alias)

    (Appears on:ApiKeyAuthWorkspaceConnectionProperties_STATUS_ARM)

    Value Description

    "ApiKey"

    ApiKeyAuthWorkspaceConnectionProperties_STATUS

    (Appears on:WorkspaceConnectionPropertiesV2_STATUS)

    Field Description
    authType
    ApiKeyAuthWorkspaceConnectionProperties_AuthType_STATUS

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory_STATUS

    Category: Category of the connection

    createdByWorkspaceArmId
    string
    credentials
    WorkspaceConnectionApiKey_STATUS

    Credentials: Api key object for workspace connection credential.

    expiryTime
    string
    group
    ConnectionGroup_STATUS

    Group: Group based on connection category

    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    ApiKeyAuthWorkspaceConnectionProperties_ValueFormat_STATUS

    ValueFormat: format for the workspace connection value

    ApiKeyAuthWorkspaceConnectionProperties_STATUS_ARM

    (Appears on:WorkspaceConnectionPropertiesV2_STATUS_ARM)

    Field Description
    authType
    ApiKeyAuthWorkspaceConnectionProperties_AuthType_STATUS_ARM

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory_STATUS_ARM

    Category: Category of the connection

    createdByWorkspaceArmId
    string
    credentials
    WorkspaceConnectionApiKey_STATUS_ARM

    Credentials: Api key object for workspace connection credential.

    expiryTime
    string
    group
    ConnectionGroup_STATUS_ARM

    Group: Group based on connection category

    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    ApiKeyAuthWorkspaceConnectionProperties_ValueFormat_STATUS_ARM

    ValueFormat: format for the workspace connection value

    ApiKeyAuthWorkspaceConnectionProperties_ValueFormat (string alias)

    (Appears on:ApiKeyAuthWorkspaceConnectionProperties)

    Value Description

    "JSON"

    ApiKeyAuthWorkspaceConnectionProperties_ValueFormat_ARM (string alias)

    (Appears on:ApiKeyAuthWorkspaceConnectionProperties_ARM)

    Value Description

    "JSON"

    ApiKeyAuthWorkspaceConnectionProperties_ValueFormat_STATUS (string alias)

    (Appears on:ApiKeyAuthWorkspaceConnectionProperties_STATUS)

    Value Description

    "JSON"

    ApiKeyAuthWorkspaceConnectionProperties_ValueFormat_STATUS_ARM (string alias)

    (Appears on:ApiKeyAuthWorkspaceConnectionProperties_STATUS_ARM)

    Value Description

    "JSON"

    AssignedUser

    (Appears on:PersonalComputeInstanceSettings)

    A user that can be assigned to a compute instance.

    Field Description
    objectId
    string

    ObjectId: User’s AAD Object Id.

    objectIdFromConfig
    genruntime.ConfigMapReference

    ObjectIdFromConfig: User’s AAD Object Id.

    tenantId
    string

    TenantId: User’s AAD Tenant Id.

    tenantIdFromConfig
    genruntime.ConfigMapReference

    TenantIdFromConfig: User’s AAD Tenant Id.

    AssignedUser_ARM

    (Appears on:PersonalComputeInstanceSettings_ARM)

    A user that can be assigned to a compute instance.

    Field Description
    objectId
    string

    ObjectId: User’s AAD Object Id.

    tenantId
    string

    TenantId: User’s AAD Tenant Id.

    AssignedUser_STATUS

    (Appears on:PersonalComputeInstanceSettings_STATUS)

    A user that can be assigned to a compute instance.

    Field Description
    objectId
    string

    ObjectId: User’s AAD Object Id.

    tenantId
    string

    TenantId: User’s AAD Tenant Id.

    AssignedUser_STATUS_ARM

    (Appears on:PersonalComputeInstanceSettings_STATUS_ARM)

    A user that can be assigned to a compute instance.

    Field Description
    objectId
    string

    ObjectId: User’s AAD Object Id.

    tenantId
    string

    TenantId: User’s AAD Tenant Id.

    AutoPauseProperties

    (Appears on:SynapseSpark_Properties)

    Auto pause properties

    Field Description
    delayInMinutes
    int
    enabled
    bool

    AutoPauseProperties_ARM

    (Appears on:SynapseSpark_Properties_ARM)

    Auto pause properties

    Field Description
    delayInMinutes
    int
    enabled
    bool

    AutoPauseProperties_STATUS

    (Appears on:SynapseSpark_Properties_STATUS)

    Auto pause properties

    Field Description
    delayInMinutes
    int
    enabled
    bool

    AutoPauseProperties_STATUS_ARM

    (Appears on:SynapseSpark_Properties_STATUS_ARM)

    Auto pause properties

    Field Description
    delayInMinutes
    int
    enabled
    bool

    AutoScaleProperties

    (Appears on:SynapseSpark_Properties)

    Auto scale properties

    Field Description
    enabled
    bool
    maxNodeCount
    int
    minNodeCount
    int

    AutoScaleProperties_ARM

    (Appears on:SynapseSpark_Properties_ARM)

    Auto scale properties

    Field Description
    enabled
    bool
    maxNodeCount
    int
    minNodeCount
    int

    AutoScaleProperties_STATUS

    (Appears on:SynapseSpark_Properties_STATUS)

    Auto scale properties

    Field Description
    enabled
    bool
    maxNodeCount
    int
    minNodeCount
    int

    AutoScaleProperties_STATUS_ARM

    (Appears on:SynapseSpark_Properties_STATUS_ARM)

    Auto scale properties

    Field Description
    enabled
    bool
    maxNodeCount
    int
    minNodeCount
    int

    BindOptions

    (Appears on:VolumeDefinition)

    Describes the bind options for the container

    Field Description
    createHostPath
    bool

    CreateHostPath: Indicate whether to create host path.

    propagation
    string

    Propagation: Type of Bind Option

    selinux
    string

    Selinux: Mention the selinux options.

    BindOptions_ARM

    (Appears on:VolumeDefinition_ARM)

    Describes the bind options for the container

    Field Description
    createHostPath
    bool

    CreateHostPath: Indicate whether to create host path.

    propagation
    string

    Propagation: Type of Bind Option

    selinux
    string

    Selinux: Mention the selinux options.

    BindOptions_STATUS

    (Appears on:VolumeDefinition_STATUS)

    Describes the bind options for the container

    Field Description
    createHostPath
    bool

    CreateHostPath: Indicate whether to create host path.

    propagation
    string

    Propagation: Type of Bind Option

    selinux
    string

    Selinux: Mention the selinux options.

    BindOptions_STATUS_ARM

    (Appears on:VolumeDefinition_STATUS_ARM)

    Describes the bind options for the container

    Field Description
    createHostPath
    bool

    CreateHostPath: Indicate whether to create host path.

    propagation
    string

    Propagation: Type of Bind Option

    selinux
    string

    Selinux: Mention the selinux options.

    Compute

    (Appears on:Workspaces_Compute_Spec)

    Field Description
    aks
    AKS

    AKS: Mutually exclusive with all other properties

    amlCompute
    AmlCompute

    AmlCompute: Mutually exclusive with all other properties

    computeInstance
    ComputeInstance

    ComputeInstance: Mutually exclusive with all other properties

    dataFactory
    DataFactory

    DataFactory: Mutually exclusive with all other properties

    dataLakeAnalytics
    DataLakeAnalytics

    DataLakeAnalytics: Mutually exclusive with all other properties

    databricks
    Databricks

    Databricks: Mutually exclusive with all other properties

    hdInsight
    HDInsight

    HDInsight: Mutually exclusive with all other properties

    kubernetes
    Kubernetes

    Kubernetes: Mutually exclusive with all other properties

    synapseSpark
    SynapseSpark

    SynapseSpark: Mutually exclusive with all other properties

    virtualMachine
    VirtualMachine

    VirtualMachine: Mutually exclusive with all other properties

    ComputeInstance

    (Appears on:Compute)

    Field Description
    computeLocation
    string

    ComputeLocation: Location for the underlying compute

    computeType
    ComputeInstance_ComputeType

    ComputeType: The type of compute

    description
    string

    Description: The description of the Machine Learning compute.

    disableLocalAuth
    bool

    DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.

    properties
    ComputeInstanceProperties

    Properties: Properties of ComputeInstance

    resourceReference
    genruntime.ResourceReference

    ResourceReference: ARM resource id of the underlying compute

    ComputeInstanceApplication_STATUS

    (Appears on:ComputeInstanceProperties_STATUS)

    Defines an Aml Instance application and its connectivity endpoint URI.

    Field Description
    displayName
    string

    DisplayName: Name of the ComputeInstance application.

    endpointUri
    string

    EndpointUri: Application’ endpoint URI.

    ComputeInstanceApplication_STATUS_ARM

    (Appears on:ComputeInstanceProperties_STATUS_ARM)

    Defines an Aml Instance application and its connectivity endpoint URI.

    Field Description
    displayName
    string

    DisplayName: Name of the ComputeInstance application.

    endpointUri
    string

    EndpointUri: Application’ endpoint URI.

    ComputeInstanceConnectivityEndpoints_STATUS

    (Appears on:ComputeInstanceProperties_STATUS)

    Defines all connectivity endpoints and properties for an ComputeInstance.

    Field Description
    privateIpAddress
    string

    PrivateIpAddress: Private IP Address of this ComputeInstance (local to the VNET in which the compute instance is deployed).

    publicIpAddress
    string

    PublicIpAddress: Public IP Address of this ComputeInstance.

    ComputeInstanceConnectivityEndpoints_STATUS_ARM

    (Appears on:ComputeInstanceProperties_STATUS_ARM)

    Defines all connectivity endpoints and properties for an ComputeInstance.

    Field Description
    privateIpAddress
    string

    PrivateIpAddress: Private IP Address of this ComputeInstance (local to the VNET in which the compute instance is deployed).

    publicIpAddress
    string

    PublicIpAddress: Public IP Address of this ComputeInstance.

    ComputeInstanceContainer_Autosave_STATUS (string alias)

    (Appears on:ComputeInstanceContainer_STATUS)

    Value Description

    "Local"

    "None"

    "Remote"

    ComputeInstanceContainer_Autosave_STATUS_ARM (string alias)

    (Appears on:ComputeInstanceContainer_STATUS_ARM)

    Value Description

    "Local"

    "None"

    "Remote"

    ComputeInstanceContainer_Network_STATUS (string alias)

    (Appears on:ComputeInstanceContainer_STATUS)

    Value Description

    "Bridge"

    "Host"

    ComputeInstanceContainer_Network_STATUS_ARM (string alias)

    (Appears on:ComputeInstanceContainer_STATUS_ARM)

    Value Description

    "Bridge"

    "Host"

    ComputeInstanceContainer_STATUS

    (Appears on:ComputeInstanceProperties_STATUS)

    Defines an Aml Instance container.

    Field Description
    autosave
    ComputeInstanceContainer_Autosave_STATUS

    Autosave: Auto save settings.

    environment
    ComputeInstanceEnvironmentInfo_STATUS

    Environment: Environment information of this container.

    gpu
    string

    Gpu: Information of GPU.

    name
    string

    Name: Name of the ComputeInstance container.

    network
    ComputeInstanceContainer_Network_STATUS

    Network: network of this container.

    services
    []Kubernetes v1.JSON

    Services: services of this containers.

    ComputeInstanceContainer_STATUS_ARM

    (Appears on:ComputeInstanceProperties_STATUS_ARM)

    Defines an Aml Instance container.

    Field Description
    autosave
    ComputeInstanceContainer_Autosave_STATUS_ARM

    Autosave: Auto save settings.

    environment
    ComputeInstanceEnvironmentInfo_STATUS_ARM

    Environment: Environment information of this container.

    gpu
    string

    Gpu: Information of GPU.

    name
    string

    Name: Name of the ComputeInstance container.

    network
    ComputeInstanceContainer_Network_STATUS_ARM

    Network: network of this container.

    services
    []Kubernetes v1.JSON

    Services: services of this containers.

    ComputeInstanceCreatedBy_STATUS

    (Appears on:ComputeInstanceProperties_STATUS)

    Describes information on user who created this ComputeInstance.

    Field Description
    userId
    string

    UserId: Uniquely identifies the user within his/her organization.

    userName
    string

    UserName: Name of the user.

    userOrgId
    string

    UserOrgId: Uniquely identifies user’ Azure Active Directory organization.

    ComputeInstanceCreatedBy_STATUS_ARM

    (Appears on:ComputeInstanceProperties_STATUS_ARM)

    Describes information on user who created this ComputeInstance.

    Field Description
    userId
    string

    UserId: Uniquely identifies the user within his/her organization.

    userName
    string

    UserName: Name of the user.

    userOrgId
    string

    UserOrgId: Uniquely identifies user’ Azure Active Directory organization.

    ComputeInstanceDataDisk_Caching_STATUS (string alias)

    (Appears on:ComputeInstanceDataDisk_STATUS)

    Value Description

    "None"

    "ReadOnly"

    "ReadWrite"

    ComputeInstanceDataDisk_Caching_STATUS_ARM (string alias)

    (Appears on:ComputeInstanceDataDisk_STATUS_ARM)

    Value Description

    "None"

    "ReadOnly"

    "ReadWrite"

    ComputeInstanceDataDisk_STATUS

    (Appears on:ComputeInstanceProperties_STATUS)

    Defines an Aml Instance DataDisk.

    Field Description
    caching
    ComputeInstanceDataDisk_Caching_STATUS

    Caching: Caching type of Data Disk.

    diskSizeGB
    int

    DiskSizeGB: The initial disk size in gigabytes.

    lun
    int

    Lun: The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun.

    storageAccountType
    ComputeInstanceDataDisk_StorageAccountType_STATUS

    StorageAccountType: type of this storage account.

    ComputeInstanceDataDisk_STATUS_ARM

    (Appears on:ComputeInstanceProperties_STATUS_ARM)

    Defines an Aml Instance DataDisk.

    Field Description
    caching
    ComputeInstanceDataDisk_Caching_STATUS_ARM

    Caching: Caching type of Data Disk.

    diskSizeGB
    int

    DiskSizeGB: The initial disk size in gigabytes.

    lun
    int

    Lun: The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun.

    storageAccountType
    ComputeInstanceDataDisk_StorageAccountType_STATUS_ARM

    StorageAccountType: type of this storage account.

    ComputeInstanceDataDisk_StorageAccountType_STATUS (string alias)

    (Appears on:ComputeInstanceDataDisk_STATUS)

    Value Description

    "Premium_LRS"

    "Standard_LRS"

    ComputeInstanceDataDisk_StorageAccountType_STATUS_ARM (string alias)

    (Appears on:ComputeInstanceDataDisk_STATUS_ARM)

    Value Description

    "Premium_LRS"

    "Standard_LRS"

    ComputeInstanceDataMount_MountAction_STATUS (string alias)

    (Appears on:ComputeInstanceDataMount_STATUS)

    Value Description

    "Mount"

    "Unmount"

    ComputeInstanceDataMount_MountAction_STATUS_ARM (string alias)

    (Appears on:ComputeInstanceDataMount_STATUS_ARM)

    Value Description

    "Mount"

    "Unmount"

    ComputeInstanceDataMount_MountState_STATUS (string alias)

    (Appears on:ComputeInstanceDataMount_STATUS)

    Value Description

    "MountFailed"

    "MountRequested"

    "Mounted"

    "UnmountFailed"

    "UnmountRequested"

    "Unmounted"

    ComputeInstanceDataMount_MountState_STATUS_ARM (string alias)

    (Appears on:ComputeInstanceDataMount_STATUS_ARM)

    Value Description

    "MountFailed"

    "MountRequested"

    "Mounted"

    "UnmountFailed"

    "UnmountRequested"

    "Unmounted"

    ComputeInstanceDataMount_STATUS

    (Appears on:ComputeInstanceProperties_STATUS)

    Defines an Aml Instance DataMount.

    Field Description
    createdBy
    string

    CreatedBy: who this data mount created by.

    error
    string

    Error: Error of this data mount.

    mountAction
    ComputeInstanceDataMount_MountAction_STATUS

    MountAction: Mount Action.

    mountName
    string

    MountName: name of the ComputeInstance data mount.

    mountPath
    string

    MountPath: Path of this data mount.

    mountState
    ComputeInstanceDataMount_MountState_STATUS

    MountState: Mount state.

    mountedOn
    string

    MountedOn: The time when the disk mounted.

    source
    string

    Source: Source of the ComputeInstance data mount.

    sourceType
    ComputeInstanceDataMount_SourceType_STATUS

    SourceType: Data source type.

    ComputeInstanceDataMount_STATUS_ARM

    (Appears on:ComputeInstanceProperties_STATUS_ARM)

    Defines an Aml Instance DataMount.

    Field Description
    createdBy
    string

    CreatedBy: who this data mount created by.

    error
    string

    Error: Error of this data mount.

    mountAction
    ComputeInstanceDataMount_MountAction_STATUS_ARM

    MountAction: Mount Action.

    mountName
    string

    MountName: name of the ComputeInstance data mount.

    mountPath
    string

    MountPath: Path of this data mount.

    mountState
    ComputeInstanceDataMount_MountState_STATUS_ARM

    MountState: Mount state.

    mountedOn
    string

    MountedOn: The time when the disk mounted.

    source
    string

    Source: Source of the ComputeInstance data mount.

    sourceType
    ComputeInstanceDataMount_SourceType_STATUS_ARM

    SourceType: Data source type.

    ComputeInstanceDataMount_SourceType_STATUS (string alias)

    (Appears on:ComputeInstanceDataMount_STATUS)

    Value Description

    "Dataset"

    "Datastore"

    "URI"

    ComputeInstanceDataMount_SourceType_STATUS_ARM (string alias)

    (Appears on:ComputeInstanceDataMount_STATUS_ARM)

    Value Description

    "Dataset"

    "Datastore"

    "URI"

    ComputeInstanceEnvironmentInfo_STATUS

    (Appears on:ComputeInstanceContainer_STATUS)

    Environment information

    Field Description
    name
    string

    Name: name of environment.

    version
    string

    Version: version of environment.

    ComputeInstanceEnvironmentInfo_STATUS_ARM

    (Appears on:ComputeInstanceContainer_STATUS_ARM)

    Environment information

    Field Description
    name
    string

    Name: name of environment.

    version
    string

    Version: version of environment.

    ComputeInstanceLastOperation_OperationName_STATUS (string alias)

    (Appears on:ComputeInstanceLastOperation_STATUS)

    Value Description

    "Create"

    "Delete"

    "Reimage"

    "Restart"

    "Start"

    "Stop"

    ComputeInstanceLastOperation_OperationName_STATUS_ARM (string alias)

    (Appears on:ComputeInstanceLastOperation_STATUS_ARM)

    Value Description

    "Create"

    "Delete"

    "Reimage"

    "Restart"

    "Start"

    "Stop"

    ComputeInstanceLastOperation_OperationStatus_STATUS (string alias)

    (Appears on:ComputeInstanceLastOperation_STATUS)

    Value Description

    "CreateFailed"

    "DeleteFailed"

    "InProgress"

    "ReimageFailed"

    "RestartFailed"

    "StartFailed"

    "StopFailed"

    "Succeeded"

    ComputeInstanceLastOperation_OperationStatus_STATUS_ARM (string alias)

    (Appears on:ComputeInstanceLastOperation_STATUS_ARM)

    Value Description

    "CreateFailed"

    "DeleteFailed"

    "InProgress"

    "ReimageFailed"

    "RestartFailed"

    "StartFailed"

    "StopFailed"

    "Succeeded"

    ComputeInstanceLastOperation_OperationTrigger_STATUS (string alias)

    (Appears on:ComputeInstanceLastOperation_STATUS)

    Value Description

    "IdleShutdown"

    "Schedule"

    "User"

    ComputeInstanceLastOperation_OperationTrigger_STATUS_ARM (string alias)

    (Appears on:ComputeInstanceLastOperation_STATUS_ARM)

    Value Description

    "IdleShutdown"

    "Schedule"

    "User"

    ComputeInstanceLastOperation_STATUS

    (Appears on:ComputeInstanceProperties_STATUS)

    The last operation on ComputeInstance.

    Field Description
    operationName
    ComputeInstanceLastOperation_OperationName_STATUS

    OperationName: Name of the last operation.

    operationStatus
    ComputeInstanceLastOperation_OperationStatus_STATUS

    OperationStatus: Operation status.

    operationTime
    string

    OperationTime: Time of the last operation.

    operationTrigger
    ComputeInstanceLastOperation_OperationTrigger_STATUS

    OperationTrigger: Trigger of operation.

    ComputeInstanceLastOperation_STATUS_ARM

    (Appears on:ComputeInstanceProperties_STATUS_ARM)

    The last operation on ComputeInstance.

    Field Description
    operationName
    ComputeInstanceLastOperation_OperationName_STATUS_ARM

    OperationName: Name of the last operation.

    operationStatus
    ComputeInstanceLastOperation_OperationStatus_STATUS_ARM

    OperationStatus: Operation status.

    operationTime
    string

    OperationTime: Time of the last operation.

    operationTrigger
    ComputeInstanceLastOperation_OperationTrigger_STATUS_ARM

    OperationTrigger: Trigger of operation.

    ComputeInstanceProperties

    (Appears on:ComputeInstance)

    Compute Instance properties

    Field Description
    applicationSharingPolicy
    ComputeInstanceProperties_ApplicationSharingPolicy

    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.

    computeInstanceAuthorizationType
    ComputeInstanceProperties_ComputeInstanceAuthorizationType

    ComputeInstanceAuthorizationType: The Compute Instance Authorization type. Available values are personal (default).

    customServices
    []CustomService

    CustomServices: List of Custom Services added to the compute.

    enableNodePublicIp
    bool

    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.

    personalComputeInstanceSettings
    PersonalComputeInstanceSettings

    PersonalComputeInstanceSettings: Settings for a personal compute instance.

    schedules
    ComputeSchedules

    Schedules: The list of schedules to be applied on the computes.

    setupScripts
    SetupScripts

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

    sshSettings
    ComputeInstanceSshSettings

    SshSettings: Specifies policy and settings for SSH access.

    subnet
    ResourceId

    Subnet: Virtual network subnet resource ID the compute nodes belong to.

    vmSize
    string

    VmSize: Virtual Machine Size

    ComputeInstanceProperties_ARM

    (Appears on:ComputeInstance_ARM)

    Compute Instance properties

    Field Description
    applicationSharingPolicy
    ComputeInstanceProperties_ApplicationSharingPolicy_ARM

    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.

    computeInstanceAuthorizationType
    ComputeInstanceProperties_ComputeInstanceAuthorizationType_ARM

    ComputeInstanceAuthorizationType: The Compute Instance Authorization type. Available values are personal (default).

    customServices
    []CustomService_ARM

    CustomServices: List of Custom Services added to the compute.

    enableNodePublicIp
    bool

    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.

    personalComputeInstanceSettings
    PersonalComputeInstanceSettings_ARM

    PersonalComputeInstanceSettings: Settings for a personal compute instance.

    schedules
    ComputeSchedules_ARM

    Schedules: The list of schedules to be applied on the computes.

    setupScripts
    SetupScripts_ARM

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

    sshSettings
    ComputeInstanceSshSettings_ARM

    SshSettings: Specifies policy and settings for SSH access.

    subnet
    ResourceId_ARM

    Subnet: Virtual network subnet resource ID the compute nodes belong to.

    vmSize
    string

    VmSize: Virtual Machine Size

    ComputeInstanceProperties_ApplicationSharingPolicy (string alias)

    (Appears on:ComputeInstanceProperties)

    Value Description

    "Personal"

    "Shared"

    ComputeInstanceProperties_ApplicationSharingPolicy_ARM (string alias)

    (Appears on:ComputeInstanceProperties_ARM)

    Value Description

    "Personal"

    "Shared"

    ComputeInstanceProperties_ApplicationSharingPolicy_STATUS (string alias)

    (Appears on:ComputeInstanceProperties_STATUS)

    Value Description

    "Personal"

    "Shared"

    ComputeInstanceProperties_ApplicationSharingPolicy_STATUS_ARM (string alias)

    (Appears on:ComputeInstanceProperties_STATUS_ARM)

    Value Description

    "Personal"

    "Shared"

    ComputeInstanceProperties_ComputeInstanceAuthorizationType (string alias)

    (Appears on:ComputeInstanceProperties)

    Value Description

    "personal"

    ComputeInstanceProperties_ComputeInstanceAuthorizationType_ARM (string alias)

    (Appears on:ComputeInstanceProperties_ARM)

    Value Description

    "personal"

    ComputeInstanceProperties_ComputeInstanceAuthorizationType_STATUS (string alias)

    (Appears on:ComputeInstanceProperties_STATUS)

    Value Description

    "personal"

    ComputeInstanceProperties_ComputeInstanceAuthorizationType_STATUS_ARM (string alias)

    (Appears on:ComputeInstanceProperties_STATUS_ARM)

    Value Description

    "personal"

    ComputeInstanceProperties_STATUS

    (Appears on:ComputeInstance_STATUS)

    Compute Instance properties

    Field Description
    applicationSharingPolicy
    ComputeInstanceProperties_ApplicationSharingPolicy_STATUS

    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.

    applications
    []ComputeInstanceApplication_STATUS

    Applications: Describes available applications and their endpoints on this ComputeInstance.

    computeInstanceAuthorizationType
    ComputeInstanceProperties_ComputeInstanceAuthorizationType_STATUS

    ComputeInstanceAuthorizationType: The Compute Instance Authorization type. Available values are personal (default).

    connectivityEndpoints
    ComputeInstanceConnectivityEndpoints_STATUS

    ConnectivityEndpoints: Describes all connectivity endpoints available for this ComputeInstance.

    containers
    []ComputeInstanceContainer_STATUS

    Containers: Describes informations of containers on this ComputeInstance.

    createdBy
    ComputeInstanceCreatedBy_STATUS

    CreatedBy: Describes information on user who created this ComputeInstance.

    customServices
    []CustomService_STATUS

    CustomServices: List of Custom Services added to the compute.

    dataDisks
    []ComputeInstanceDataDisk_STATUS

    DataDisks: Describes informations of dataDisks on this ComputeInstance.

    dataMounts
    []ComputeInstanceDataMount_STATUS

    DataMounts: Describes informations of dataMounts on this ComputeInstance.

    enableNodePublicIp
    bool

    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.

    errors
    []ErrorResponse_STATUS

    Errors: Collection of errors encountered on this ComputeInstance.

    lastOperation
    ComputeInstanceLastOperation_STATUS

    LastOperation: The last operation on ComputeInstance.

    osImageMetadata
    ImageMetadata_STATUS

    OsImageMetadata: Returns metadata about the operating system image for this compute instance.

    personalComputeInstanceSettings
    PersonalComputeInstanceSettings_STATUS

    PersonalComputeInstanceSettings: Settings for a personal compute instance.

    schedules
    ComputeSchedules_STATUS

    Schedules: The list of schedules to be applied on the computes.

    setupScripts
    SetupScripts_STATUS

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

    sshSettings
    ComputeInstanceSshSettings_STATUS

    SshSettings: Specifies policy and settings for SSH access.

    state
    ComputeInstanceState_STATUS

    State: The current state of this ComputeInstance.

    subnet
    ResourceId_STATUS

    Subnet: Virtual network subnet resource ID the compute nodes belong to.

    versions
    ComputeInstanceVersion_STATUS

    Versions: ComputeInstance version.

    vmSize
    string

    VmSize: Virtual Machine Size

    ComputeInstanceProperties_STATUS_ARM

    (Appears on:ComputeInstance_STATUS_ARM)

    Compute Instance properties

    Field Description
    applicationSharingPolicy
    ComputeInstanceProperties_ApplicationSharingPolicy_STATUS_ARM

    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.

    applications
    []ComputeInstanceApplication_STATUS_ARM

    Applications: Describes available applications and their endpoints on this ComputeInstance.

    computeInstanceAuthorizationType
    ComputeInstanceProperties_ComputeInstanceAuthorizationType_STATUS_ARM

    ComputeInstanceAuthorizationType: The Compute Instance Authorization type. Available values are personal (default).

    connectivityEndpoints
    ComputeInstanceConnectivityEndpoints_STATUS_ARM

    ConnectivityEndpoints: Describes all connectivity endpoints available for this ComputeInstance.

    containers
    []ComputeInstanceContainer_STATUS_ARM

    Containers: Describes informations of containers on this ComputeInstance.

    createdBy
    ComputeInstanceCreatedBy_STATUS_ARM

    CreatedBy: Describes information on user who created this ComputeInstance.

    customServices
    []CustomService_STATUS_ARM

    CustomServices: List of Custom Services added to the compute.

    dataDisks
    []ComputeInstanceDataDisk_STATUS_ARM

    DataDisks: Describes informations of dataDisks on this ComputeInstance.

    dataMounts
    []ComputeInstanceDataMount_STATUS_ARM

    DataMounts: Describes informations of dataMounts on this ComputeInstance.

    enableNodePublicIp
    bool

    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.

    errors
    []ErrorResponse_STATUS_ARM

    Errors: Collection of errors encountered on this ComputeInstance.

    lastOperation
    ComputeInstanceLastOperation_STATUS_ARM

    LastOperation: The last operation on ComputeInstance.

    osImageMetadata
    ImageMetadata_STATUS_ARM

    OsImageMetadata: Returns metadata about the operating system image for this compute instance.

    personalComputeInstanceSettings
    PersonalComputeInstanceSettings_STATUS_ARM

    PersonalComputeInstanceSettings: Settings for a personal compute instance.

    schedules
    ComputeSchedules_STATUS_ARM

    Schedules: The list of schedules to be applied on the computes.

    setupScripts
    SetupScripts_STATUS_ARM

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

    sshSettings
    ComputeInstanceSshSettings_STATUS_ARM

    SshSettings: Specifies policy and settings for SSH access.

    state
    ComputeInstanceState_STATUS_ARM

    State: The current state of this ComputeInstance.

    subnet
    ResourceId_STATUS_ARM

    Subnet: Virtual network subnet resource ID the compute nodes belong to.

    versions
    ComputeInstanceVersion_STATUS_ARM

    Versions: ComputeInstance version.

    vmSize
    string

    VmSize: Virtual Machine Size

    ComputeInstanceSshSettings

    (Appears on:ComputeInstanceProperties)

    Specifies policy and settings for SSH access.

    Field Description
    adminPublicKey
    string

    AdminPublicKey: Specifies the SSH rsa public key file as a string. Use “ssh-keygen -t rsa -b 2048” to generate your SSH key pairs.

    sshPublicAccess
    ComputeInstanceSshSettings_SshPublicAccess

    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_ARM

    (Appears on:ComputeInstanceProperties_ARM)

    Specifies policy and settings for SSH access.

    Field Description
    adminPublicKey
    string

    AdminPublicKey: Specifies the SSH rsa public key file as a string. Use “ssh-keygen -t rsa -b 2048” to generate your SSH key pairs.

    sshPublicAccess
    ComputeInstanceSshSettings_SshPublicAccess_ARM

    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_STATUS

    (Appears on:ComputeInstanceProperties_STATUS)

    Specifies policy and settings for SSH access.

    Field Description
    adminPublicKey
    string

    AdminPublicKey: Specifies the SSH rsa public key file as a string. Use “ssh-keygen -t rsa -b 2048” to generate your SSH key pairs.

    adminUserName
    string

    AdminUserName: Describes the admin user name.

    sshPort
    int

    SshPort: Describes the port for connecting through SSH.

    sshPublicAccess
    ComputeInstanceSshSettings_SshPublicAccess_STATUS

    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_STATUS_ARM

    (Appears on:ComputeInstanceProperties_STATUS_ARM)

    Specifies policy and settings for SSH access.

    Field Description
    adminPublicKey
    string

    AdminPublicKey: Specifies the SSH rsa public key file as a string. Use “ssh-keygen -t rsa -b 2048” to generate your SSH key pairs.

    adminUserName
    string

    AdminUserName: Describes the admin user name.

    sshPort
    int

    SshPort: Describes the port for connecting through SSH.

    sshPublicAccess
    ComputeInstanceSshSettings_SshPublicAccess_STATUS_ARM

    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 (string alias)

    (Appears on:ComputeInstanceSshSettings)

    Value Description

    "Disabled"

    "Enabled"

    ComputeInstanceSshSettings_SshPublicAccess_ARM (string alias)

    (Appears on:ComputeInstanceSshSettings_ARM)

    Value Description

    "Disabled"

    "Enabled"

    ComputeInstanceSshSettings_SshPublicAccess_STATUS (string alias)

    (Appears on:ComputeInstanceSshSettings_STATUS)

    Value Description

    "Disabled"

    "Enabled"

    ComputeInstanceSshSettings_SshPublicAccess_STATUS_ARM (string alias)

    (Appears on:ComputeInstanceSshSettings_STATUS_ARM)

    Value Description

    "Disabled"

    "Enabled"

    ComputeInstanceState_STATUS (string alias)

    (Appears on:ComputeInstanceProperties_STATUS)

    Current state of an ComputeInstance.

    Value Description

    "CreateFailed"

    "Creating"

    "Deleting"

    "JobRunning"

    "Restarting"

    "Running"

    "SettingUp"

    "SetupFailed"

    "Starting"

    "Stopped"

    "Stopping"

    "Unknown"

    "Unusable"

    "UserSettingUp"

    "UserSetupFailed"

    ComputeInstanceState_STATUS_ARM (string alias)

    (Appears on:ComputeInstanceProperties_STATUS_ARM)

    Current state of an ComputeInstance.

    Value Description

    "CreateFailed"

    "Creating"

    "Deleting"

    "JobRunning"

    "Restarting"

    "Running"

    "SettingUp"

    "SetupFailed"

    "Starting"

    "Stopped"

    "Stopping"

    "Unknown"

    "Unusable"

    "UserSettingUp"

    "UserSetupFailed"

    ComputeInstanceVersion_STATUS

    (Appears on:ComputeInstanceProperties_STATUS)

    Version of computeInstance.

    Field Description
    runtime
    string

    Runtime: Runtime of compute instance.

    ComputeInstanceVersion_STATUS_ARM

    (Appears on:ComputeInstanceProperties_STATUS_ARM)

    Version of computeInstance.

    Field Description
    runtime
    string

    Runtime: Runtime of compute instance.

    ComputeInstance_ARM

    (Appears on:Compute_ARM)

    Field Description
    computeLocation
    string

    ComputeLocation: Location for the underlying compute

    computeType
    ComputeInstance_ComputeType_ARM

    ComputeType: The type of compute

    description
    string

    Description: The description of the Machine Learning compute.

    disableLocalAuth
    bool

    DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.

    properties
    ComputeInstanceProperties_ARM

    Properties: Properties of ComputeInstance

    resourceId
    string

    ComputeInstance_ComputeType (string alias)

    (Appears on:ComputeInstance)

    Value Description

    "ComputeInstance"

    ComputeInstance_ComputeType_ARM (string alias)

    (Appears on:ComputeInstance_ARM)

    Value Description

    "ComputeInstance"

    ComputeInstance_ComputeType_STATUS (string alias)

    (Appears on:ComputeInstance_STATUS)

    Value Description

    "ComputeInstance"

    ComputeInstance_ComputeType_STATUS_ARM (string alias)

    (Appears on:ComputeInstance_STATUS_ARM)

    Value Description

    "ComputeInstance"

    ComputeInstance_ProvisioningState_STATUS (string alias)

    (Appears on:ComputeInstance_STATUS)

    Value Description

    "Canceled"

    "Creating"

    "Deleting"

    "Failed"

    "Succeeded"

    "Unknown"

    "Updating"

    ComputeInstance_ProvisioningState_STATUS_ARM (string alias)

    (Appears on:ComputeInstance_STATUS_ARM)

    Value Description

    "Canceled"

    "Creating"

    "Deleting"

    "Failed"

    "Succeeded"

    "Unknown"

    "Updating"

    ComputeInstance_STATUS

    (Appears on:Compute_STATUS)

    Field Description
    computeLocation
    string

    ComputeLocation: Location for the underlying compute

    computeType
    ComputeInstance_ComputeType_STATUS

    ComputeType: The type of compute

    createdOn
    string

    CreatedOn: The time at which the compute was created.

    description
    string

    Description: The description of the Machine Learning compute.

    disableLocalAuth
    bool

    DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.

    isAttachedCompute
    bool

    IsAttachedCompute: Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.

    modifiedOn
    string

    ModifiedOn: The time at which the compute was last modified.

    properties
    ComputeInstanceProperties_STATUS

    Properties: Properties of ComputeInstance

    provisioningErrors
    []ErrorResponse_STATUS

    ProvisioningErrors: Errors during provisioning

    provisioningState
    ComputeInstance_ProvisioningState_STATUS

    ProvisioningState: The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.

    resourceId
    string

    ResourceId: ARM resource id of the underlying compute

    ComputeInstance_STATUS_ARM

    (Appears on:Compute_STATUS_ARM)

    Field Description
    computeLocation
    string

    ComputeLocation: Location for the underlying compute

    computeType
    ComputeInstance_ComputeType_STATUS_ARM

    ComputeType: The type of compute

    createdOn
    string

    CreatedOn: The time at which the compute was created.

    description
    string

    Description: The description of the Machine Learning compute.

    disableLocalAuth
    bool

    DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.

    isAttachedCompute
    bool

    IsAttachedCompute: Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.

    modifiedOn
    string

    ModifiedOn: The time at which the compute was last modified.

    properties
    ComputeInstanceProperties_STATUS_ARM

    Properties: Properties of ComputeInstance

    provisioningErrors
    []ErrorResponse_STATUS_ARM

    ProvisioningErrors: Errors during provisioning

    provisioningState
    ComputeInstance_ProvisioningState_STATUS_ARM

    ProvisioningState: The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.

    resourceId
    string

    ResourceId: ARM resource id of the underlying compute

    ComputePowerAction (string alias)

    (Appears on:ComputeStartStopSchedule)

    The compute power action.

    Value Description

    "Start"

    "Stop"

    ComputePowerAction_ARM (string alias)

    (Appears on:ComputeStartStopSchedule_ARM)

    The compute power action.

    Value Description

    "Start"

    "Stop"

    ComputePowerAction_STATUS (string alias)

    (Appears on:ComputeStartStopSchedule_STATUS)

    The compute power action.

    Value Description

    "Start"

    "Stop"

    ComputePowerAction_STATUS_ARM (string alias)

    (Appears on:ComputeStartStopSchedule_STATUS_ARM)

    The compute power action.

    Value Description

    "Start"

    "Stop"

    ComputeRecurrenceFrequency (string alias)

    (Appears on:Recurrence)

    Enum to describe the frequency of a compute recurrence schedule

    Value Description

    "Day"

    "Hour"

    "Minute"

    "Month"

    "Week"

    ComputeRecurrenceFrequency_ARM (string alias)

    (Appears on:Recurrence_ARM)

    Enum to describe the frequency of a compute recurrence schedule

    Value Description

    "Day"

    "Hour"

    "Minute"

    "Month"

    "Week"

    ComputeRecurrenceFrequency_STATUS (string alias)

    (Appears on:Recurrence_STATUS)

    Enum to describe the frequency of a compute recurrence schedule

    Value Description

    "Day"

    "Hour"

    "Minute"

    "Month"

    "Week"

    ComputeRecurrenceFrequency_STATUS_ARM (string alias)

    (Appears on:Recurrence_STATUS_ARM)

    Enum to describe the frequency of a compute recurrence schedule

    Value Description

    "Day"

    "Hour"

    "Minute"

    "Month"

    "Week"

    ComputeRecurrenceSchedule

    (Appears on:Recurrence)

    Field Description
    hours
    []int

    Hours: [Required] List of hours for the schedule.

    minutes
    []int

    Minutes: [Required] List of minutes for the schedule.

    monthDays
    []int

    MonthDays: List of month days for the schedule

    weekDays
    []ComputeWeekDay

    WeekDays: List of days for the schedule.

    ComputeRecurrenceSchedule_ARM

    (Appears on:Recurrence_ARM)

    Field Description
    hours
    []int

    Hours: [Required] List of hours for the schedule.

    minutes
    []int

    Minutes: [Required] List of minutes for the schedule.

    monthDays
    []int

    MonthDays: List of month days for the schedule

    weekDays
    []ComputeWeekDay_ARM

    WeekDays: List of days for the schedule.

    ComputeRecurrenceSchedule_STATUS

    (Appears on:Recurrence_STATUS)

    Field Description
    hours
    []int

    Hours: [Required] List of hours for the schedule.

    minutes
    []int

    Minutes: [Required] List of minutes for the schedule.

    monthDays
    []int

    MonthDays: List of month days for the schedule

    weekDays
    []ComputeWeekDay_STATUS

    WeekDays: List of days for the schedule.

    ComputeRecurrenceSchedule_STATUS_ARM

    (Appears on:Recurrence_STATUS_ARM)

    Field Description
    hours
    []int

    Hours: [Required] List of hours for the schedule.

    minutes
    []int

    Minutes: [Required] List of minutes for the schedule.

    monthDays
    []int

    MonthDays: List of month days for the schedule

    weekDays
    []ComputeWeekDay_STATUS_ARM

    WeekDays: List of days for the schedule.

    ComputeRuntimeDto

    (Appears on:FeatureStoreSettings)

    Compute runtime config for feature store type workspace.

    Field Description
    sparkRuntimeVersion
    string

    ComputeRuntimeDto_ARM

    (Appears on:FeatureStoreSettings_ARM)

    Compute runtime config for feature store type workspace.

    Field Description
    sparkRuntimeVersion
    string

    ComputeRuntimeDto_STATUS

    (Appears on:FeatureStoreSettings_STATUS)

    Compute runtime config for feature store type workspace.

    Field Description
    sparkRuntimeVersion
    string

    ComputeRuntimeDto_STATUS_ARM

    (Appears on:FeatureStoreSettings_STATUS_ARM)

    Compute runtime config for feature store type workspace.

    Field Description
    sparkRuntimeVersion
    string

    ComputeSchedules

    (Appears on:ComputeInstanceProperties)

    The list of schedules to be applied on the computes

    Field Description
    computeStartStop
    []ComputeStartStopSchedule

    ComputeStartStop: The list of compute start stop schedules to be applied.

    ComputeSchedules_ARM

    (Appears on:ComputeInstanceProperties_ARM)

    The list of schedules to be applied on the computes

    Field Description
    computeStartStop
    []ComputeStartStopSchedule_ARM

    ComputeStartStop: The list of compute start stop schedules to be applied.

    ComputeSchedules_STATUS

    (Appears on:ComputeInstanceProperties_STATUS)

    The list of schedules to be applied on the computes

    Field Description
    computeStartStop
    []ComputeStartStopSchedule_STATUS

    ComputeStartStop: The list of compute start stop schedules to be applied.

    ComputeSchedules_STATUS_ARM

    (Appears on:ComputeInstanceProperties_STATUS_ARM)

    The list of schedules to be applied on the computes

    Field Description
    computeStartStop
    []ComputeStartStopSchedule_STATUS_ARM

    ComputeStartStop: The list of compute start stop schedules to be applied.

    ComputeStartStopSchedule

    (Appears on:ComputeSchedules)

    Compute start stop schedule properties

    Field Description
    action
    ComputePowerAction

    Action: [Required] The compute power action.

    cron
    Cron

    Cron: Required if triggerType is Cron.

    recurrence
    Recurrence

    Recurrence: Required if triggerType is Recurrence.

    schedule
    ScheduleBase

    Schedule: [Deprecated] Not used any more.

    status
    ScheduleStatus

    Status: Is the schedule enabled or disabled?

    triggerType
    ComputeTriggerType

    TriggerType: [Required] The schedule trigger type.

    ComputeStartStopSchedule_ARM

    (Appears on:ComputeSchedules_ARM)

    Compute start stop schedule properties

    Field Description
    action
    ComputePowerAction_ARM

    Action: [Required] The compute power action.

    cron
    Cron_ARM

    Cron: Required if triggerType is Cron.

    recurrence
    Recurrence_ARM

    Recurrence: Required if triggerType is Recurrence.

    schedule
    ScheduleBase_ARM

    Schedule: [Deprecated] Not used any more.

    status
    ScheduleStatus_ARM

    Status: Is the schedule enabled or disabled?

    triggerType
    ComputeTriggerType_ARM

    TriggerType: [Required] The schedule trigger type.

    ComputeStartStopSchedule_ProvisioningStatus_STATUS (string alias)

    (Appears on:ComputeStartStopSchedule_STATUS)

    Value Description

    "Completed"

    "Failed"

    "Provisioning"

    ComputeStartStopSchedule_ProvisioningStatus_STATUS_ARM (string alias)

    (Appears on:ComputeStartStopSchedule_STATUS_ARM)

    Value Description

    "Completed"

    "Failed"

    "Provisioning"

    ComputeStartStopSchedule_STATUS

    (Appears on:ComputeSchedules_STATUS)

    Compute start stop schedule properties

    Field Description
    action
    ComputePowerAction_STATUS

    Action: [Required] The compute power action.

    cron
    Cron_STATUS

    Cron: Required if triggerType is Cron.

    id
    string

    Id: A system assigned id for the schedule.

    provisioningStatus
    ComputeStartStopSchedule_ProvisioningStatus_STATUS

    ProvisioningStatus: The current deployment state of schedule.

    recurrence
    Recurrence_STATUS

    Recurrence: Required if triggerType is Recurrence.

    schedule
    ScheduleBase_STATUS

    Schedule: [Deprecated] Not used any more.

    status
    ScheduleStatus_STATUS

    Status: Is the schedule enabled or disabled?

    triggerType
    ComputeTriggerType_STATUS

    TriggerType: [Required] The schedule trigger type.

    ComputeStartStopSchedule_STATUS_ARM

    (Appears on:ComputeSchedules_STATUS_ARM)

    Compute start stop schedule properties

    Field Description
    action
    ComputePowerAction_STATUS_ARM

    Action: [Required] The compute power action.

    cron
    Cron_STATUS_ARM

    Cron: Required if triggerType is Cron.

    id
    string

    Id: A system assigned id for the schedule.

    provisioningStatus
    ComputeStartStopSchedule_ProvisioningStatus_STATUS_ARM

    ProvisioningStatus: The current deployment state of schedule.

    recurrence
    Recurrence_STATUS_ARM

    Recurrence: Required if triggerType is Recurrence.

    schedule
    ScheduleBase_STATUS_ARM

    Schedule: [Deprecated] Not used any more.

    status
    ScheduleStatus_STATUS_ARM

    Status: Is the schedule enabled or disabled?

    triggerType
    ComputeTriggerType_STATUS_ARM

    TriggerType: [Required] The schedule trigger type.

    ComputeTriggerType (string alias)

    (Appears on:ComputeStartStopSchedule)

    Is the trigger type recurrence or cron.

    Value Description

    "Cron"

    "Recurrence"

    ComputeTriggerType_ARM (string alias)

    (Appears on:ComputeStartStopSchedule_ARM)

    Is the trigger type recurrence or cron.

    Value Description

    "Cron"

    "Recurrence"

    ComputeTriggerType_STATUS (string alias)

    (Appears on:ComputeStartStopSchedule_STATUS)

    Is the trigger type recurrence or cron.

    Value Description

    "Cron"

    "Recurrence"

    ComputeTriggerType_STATUS_ARM (string alias)

    (Appears on:ComputeStartStopSchedule_STATUS_ARM)

    Is the trigger type recurrence or cron.

    Value Description

    "Cron"

    "Recurrence"

    ComputeWeekDay (string alias)

    (Appears on:ComputeRecurrenceSchedule)

    Enum of weekday

    Value Description

    "Friday"

    "Monday"

    "Saturday"

    "Sunday"

    "Thursday"

    "Tuesday"

    "Wednesday"

    ComputeWeekDay_ARM (string alias)

    (Appears on:ComputeRecurrenceSchedule_ARM)

    Enum of weekday

    Value Description

    "Friday"

    "Monday"

    "Saturday"

    "Sunday"

    "Thursday"

    "Tuesday"

    "Wednesday"

    ComputeWeekDay_STATUS (string alias)

    (Appears on:ComputeRecurrenceSchedule_STATUS)

    Enum of weekday

    Value Description

    "Friday"

    "Monday"

    "Saturday"

    "Sunday"

    "Thursday"

    "Tuesday"

    "Wednesday"

    ComputeWeekDay_STATUS_ARM (string alias)

    (Appears on:ComputeRecurrenceSchedule_STATUS_ARM)

    Enum of weekday

    Value Description

    "Friday"

    "Monday"

    "Saturday"

    "Sunday"

    "Thursday"

    "Tuesday"

    "Wednesday"

    Compute_ARM

    (Appears on:Workspaces_Compute_Spec_ARM)

    Field Description
    aks
    AKS_ARM

    AKS: Mutually exclusive with all other properties

    amlCompute
    AmlCompute_ARM

    AmlCompute: Mutually exclusive with all other properties

    computeInstance
    ComputeInstance_ARM

    ComputeInstance: Mutually exclusive with all other properties

    dataFactory
    DataFactory_ARM

    DataFactory: Mutually exclusive with all other properties

    dataLakeAnalytics
    DataLakeAnalytics_ARM

    DataLakeAnalytics: Mutually exclusive with all other properties

    databricks
    Databricks_ARM

    Databricks: Mutually exclusive with all other properties

    hdInsight
    HDInsight_ARM

    HDInsight: Mutually exclusive with all other properties

    kubernetes
    Kubernetes_ARM

    Kubernetes: Mutually exclusive with all other properties

    synapseSpark
    SynapseSpark_ARM

    SynapseSpark: Mutually exclusive with all other properties

    virtualMachine
    VirtualMachine_ARM

    VirtualMachine: Mutually exclusive with all other properties

    Compute_STATUS

    (Appears on:Workspaces_Compute_STATUS)

    Field Description
    aks
    AKS_STATUS

    AKS: Mutually exclusive with all other properties

    amlCompute
    AmlCompute_STATUS

    AmlCompute: Mutually exclusive with all other properties

    computeInstance
    ComputeInstance_STATUS

    ComputeInstance: Mutually exclusive with all other properties

    dataFactory
    DataFactory_STATUS

    DataFactory: Mutually exclusive with all other properties

    dataLakeAnalytics
    DataLakeAnalytics_STATUS

    DataLakeAnalytics: Mutually exclusive with all other properties

    databricks
    Databricks_STATUS

    Databricks: Mutually exclusive with all other properties

    hdInsight
    HDInsight_STATUS

    HDInsight: Mutually exclusive with all other properties

    kubernetes
    Kubernetes_STATUS

    Kubernetes: Mutually exclusive with all other properties

    synapseSpark
    SynapseSpark_STATUS

    SynapseSpark: Mutually exclusive with all other properties

    virtualMachine
    VirtualMachine_STATUS

    VirtualMachine: Mutually exclusive with all other properties

    Compute_STATUS_ARM

    (Appears on:Workspaces_Compute_STATUS_ARM)

    Field Description
    aks
    AKS_STATUS_ARM

    AKS: Mutually exclusive with all other properties

    amlCompute
    AmlCompute_STATUS_ARM

    AmlCompute: Mutually exclusive with all other properties

    computeInstance
    ComputeInstance_STATUS_ARM

    ComputeInstance: Mutually exclusive with all other properties

    dataFactory
    DataFactory_STATUS_ARM

    DataFactory: Mutually exclusive with all other properties

    dataLakeAnalytics
    DataLakeAnalytics_STATUS_ARM

    DataLakeAnalytics: Mutually exclusive with all other properties

    databricks
    Databricks_STATUS_ARM

    Databricks: Mutually exclusive with all other properties

    hdInsight
    HDInsight_STATUS_ARM

    HDInsight: Mutually exclusive with all other properties

    kubernetes
    Kubernetes_STATUS_ARM

    Kubernetes: Mutually exclusive with all other properties

    synapseSpark
    SynapseSpark_STATUS_ARM

    SynapseSpark: Mutually exclusive with all other properties

    virtualMachine
    VirtualMachine_STATUS_ARM

    VirtualMachine: Mutually exclusive with all other properties

    ConnectionCategory (string alias)

    (Appears on:AADAuthTypeWorkspaceConnectionProperties, AccessKeyAuthTypeWorkspaceConnectionProperties, AccountKeyAuthTypeWorkspaceConnectionProperties, ApiKeyAuthWorkspaceConnectionProperties, CustomKeysWorkspaceConnectionProperties, ManagedIdentityAuthTypeWorkspaceConnectionProperties, NoneAuthTypeWorkspaceConnectionProperties, OAuth2AuthTypeWorkspaceConnectionProperties, PATAuthTypeWorkspaceConnectionProperties, SASAuthTypeWorkspaceConnectionProperties, ServicePrincipalAuthTypeWorkspaceConnectionProperties, UsernamePasswordAuthTypeWorkspaceConnectionProperties)

    Category of the connection

    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_ARM (string alias)

    (Appears on:AADAuthTypeWorkspaceConnectionProperties_ARM, AccessKeyAuthTypeWorkspaceConnectionProperties_ARM, AccountKeyAuthTypeWorkspaceConnectionProperties_ARM, ApiKeyAuthWorkspaceConnectionProperties_ARM, CustomKeysWorkspaceConnectionProperties_ARM, ManagedIdentityAuthTypeWorkspaceConnectionProperties_ARM, NoneAuthTypeWorkspaceConnectionProperties_ARM, OAuth2AuthTypeWorkspaceConnectionProperties_ARM, PATAuthTypeWorkspaceConnectionProperties_ARM, SASAuthTypeWorkspaceConnectionProperties_ARM, ServicePrincipalAuthTypeWorkspaceConnectionProperties_ARM, UsernamePasswordAuthTypeWorkspaceConnectionProperties_ARM)

    Category of the connection

    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 (string alias)

    (Appears on:AADAuthTypeWorkspaceConnectionProperties_STATUS, AccessKeyAuthTypeWorkspaceConnectionProperties_STATUS, AccountKeyAuthTypeWorkspaceConnectionProperties_STATUS, ApiKeyAuthWorkspaceConnectionProperties_STATUS, CustomKeysWorkspaceConnectionProperties_STATUS, ManagedIdentityAuthTypeWorkspaceConnectionProperties_STATUS, NoneAuthTypeWorkspaceConnectionProperties_STATUS, OAuth2AuthTypeWorkspaceConnectionProperties_STATUS, PATAuthTypeWorkspaceConnectionProperties_STATUS, SASAuthTypeWorkspaceConnectionProperties_STATUS, ServicePrincipalAuthTypeWorkspaceConnectionProperties_STATUS, UsernamePasswordAuthTypeWorkspaceConnectionProperties_STATUS)

    Category of the connection

    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_ARM (string alias)

    (Appears on:AADAuthTypeWorkspaceConnectionProperties_STATUS_ARM, AccessKeyAuthTypeWorkspaceConnectionProperties_STATUS_ARM, AccountKeyAuthTypeWorkspaceConnectionProperties_STATUS_ARM, ApiKeyAuthWorkspaceConnectionProperties_STATUS_ARM, CustomKeysWorkspaceConnectionProperties_STATUS_ARM, ManagedIdentityAuthTypeWorkspaceConnectionProperties_STATUS_ARM, NoneAuthTypeWorkspaceConnectionProperties_STATUS_ARM, OAuth2AuthTypeWorkspaceConnectionProperties_STATUS_ARM, PATAuthTypeWorkspaceConnectionProperties_STATUS_ARM, SASAuthTypeWorkspaceConnectionProperties_STATUS_ARM, ServicePrincipalAuthTypeWorkspaceConnectionProperties_STATUS_ARM, UsernamePasswordAuthTypeWorkspaceConnectionProperties_STATUS_ARM)

    Category of the connection

    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 (string alias)

    (Appears on:AADAuthTypeWorkspaceConnectionProperties_STATUS, AccessKeyAuthTypeWorkspaceConnectionProperties_STATUS, AccountKeyAuthTypeWorkspaceConnectionProperties_STATUS, ApiKeyAuthWorkspaceConnectionProperties_STATUS, CustomKeysWorkspaceConnectionProperties_STATUS, ManagedIdentityAuthTypeWorkspaceConnectionProperties_STATUS, NoneAuthTypeWorkspaceConnectionProperties_STATUS, OAuth2AuthTypeWorkspaceConnectionProperties_STATUS, PATAuthTypeWorkspaceConnectionProperties_STATUS, SASAuthTypeWorkspaceConnectionProperties_STATUS, ServicePrincipalAuthTypeWorkspaceConnectionProperties_STATUS, UsernamePasswordAuthTypeWorkspaceConnectionProperties_STATUS)

    Group based on connection category

    Value Description

    "Azure"

    "AzureAI"

    "Database"

    "File"

    "GenericProtocol"

    "NoSQL"

    "ServicesAndApps"

    ConnectionGroup_STATUS_ARM (string alias)

    (Appears on:AADAuthTypeWorkspaceConnectionProperties_STATUS_ARM, AccessKeyAuthTypeWorkspaceConnectionProperties_STATUS_ARM, AccountKeyAuthTypeWorkspaceConnectionProperties_STATUS_ARM, ApiKeyAuthWorkspaceConnectionProperties_STATUS_ARM, CustomKeysWorkspaceConnectionProperties_STATUS_ARM, ManagedIdentityAuthTypeWorkspaceConnectionProperties_STATUS_ARM, NoneAuthTypeWorkspaceConnectionProperties_STATUS_ARM, OAuth2AuthTypeWorkspaceConnectionProperties_STATUS_ARM, PATAuthTypeWorkspaceConnectionProperties_STATUS_ARM, SASAuthTypeWorkspaceConnectionProperties_STATUS_ARM, ServicePrincipalAuthTypeWorkspaceConnectionProperties_STATUS_ARM, UsernamePasswordAuthTypeWorkspaceConnectionProperties_STATUS_ARM)

    Group based on connection category

    Value Description

    "Azure"

    "AzureAI"

    "Database"

    "File"

    "GenericProtocol"

    "NoSQL"

    "ServicesAndApps"

    CosmosDbSettings

    (Appears on:ServiceManagedResourcesSettings)

    Field Description
    collectionsThroughput
    int

    CollectionsThroughput: The throughput of the collections in cosmosdb database

    CosmosDbSettings_ARM

    (Appears on:ServiceManagedResourcesSettings_ARM)

    Field Description
    collectionsThroughput
    int

    CollectionsThroughput: The throughput of the collections in cosmosdb database

    CosmosDbSettings_STATUS

    (Appears on:ServiceManagedResourcesSettings_STATUS)

    Field Description
    collectionsThroughput
    int

    CollectionsThroughput: The throughput of the collections in cosmosdb database

    CosmosDbSettings_STATUS_ARM

    (Appears on:ServiceManagedResourcesSettings_STATUS_ARM)

    Field Description
    collectionsThroughput
    int

    CollectionsThroughput: The throughput of the collections in cosmosdb database

    Cron

    (Appears on:ComputeStartStopSchedule)

    The workflow trigger cron for ComputeStartStop schedule type.

    Field Description
    expression
    string

    Expression: [Required] Specifies cron expression of schedule. The expression should follow NCronTab format.

    startTime
    string

    StartTime: The start time in yyyy-MM-ddTHH:mm:ss format.

    timeZone
    string

    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

    Cron_ARM

    (Appears on:ComputeStartStopSchedule_ARM)

    The workflow trigger cron for ComputeStartStop schedule type.

    Field Description
    expression
    string

    Expression: [Required] Specifies cron expression of schedule. The expression should follow NCronTab format.

    startTime
    string

    StartTime: The start time in yyyy-MM-ddTHH:mm:ss format.

    timeZone
    string

    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

    Cron_STATUS

    (Appears on:ComputeStartStopSchedule_STATUS)

    The workflow trigger cron for ComputeStartStop schedule type.

    Field Description
    expression
    string

    Expression: [Required] Specifies cron expression of schedule. The expression should follow NCronTab format.

    startTime
    string

    StartTime: The start time in yyyy-MM-ddTHH:mm:ss format.

    timeZone
    string

    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

    Cron_STATUS_ARM

    (Appears on:ComputeStartStopSchedule_STATUS_ARM)

    The workflow trigger cron for ComputeStartStop schedule type.

    Field Description
    expression
    string

    Expression: [Required] Specifies cron expression of schedule. The expression should follow NCronTab format.

    startTime
    string

    StartTime: The start time in yyyy-MM-ddTHH:mm:ss format.

    timeZone
    string

    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

    CustomKeys

    (Appears on:CustomKeysWorkspaceConnectionProperties)

    Custom Keys credential object

    Field Description
    keys
    genruntime.SecretMapReference

    CustomKeysWorkspaceConnectionProperties

    (Appears on:WorkspaceConnectionPropertiesV2)

    Field Description
    authType
    CustomKeysWorkspaceConnectionProperties_AuthType

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory

    Category: Category of the connection

    credentials
    CustomKeys

    Credentials: Custom Keys credential object

    expiryTime
    string
    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    CustomKeysWorkspaceConnectionProperties_ValueFormat

    ValueFormat: format for the workspace connection value

    CustomKeysWorkspaceConnectionProperties_ARM

    (Appears on:WorkspaceConnectionPropertiesV2_ARM)

    Field Description
    authType
    CustomKeysWorkspaceConnectionProperties_AuthType_ARM

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory_ARM

    Category: Category of the connection

    credentials
    CustomKeys_ARM

    Credentials: Custom Keys credential object

    expiryTime
    string
    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    CustomKeysWorkspaceConnectionProperties_ValueFormat_ARM

    ValueFormat: format for the workspace connection value

    CustomKeysWorkspaceConnectionProperties_AuthType (string alias)

    (Appears on:CustomKeysWorkspaceConnectionProperties)

    Value Description

    "CustomKeys"

    CustomKeysWorkspaceConnectionProperties_AuthType_ARM (string alias)

    (Appears on:CustomKeysWorkspaceConnectionProperties_ARM)

    Value Description

    "CustomKeys"

    CustomKeysWorkspaceConnectionProperties_AuthType_STATUS (string alias)

    (Appears on:CustomKeysWorkspaceConnectionProperties_STATUS)

    Value Description

    "CustomKeys"

    CustomKeysWorkspaceConnectionProperties_AuthType_STATUS_ARM (string alias)

    (Appears on:CustomKeysWorkspaceConnectionProperties_STATUS_ARM)

    Value Description

    "CustomKeys"

    CustomKeysWorkspaceConnectionProperties_STATUS

    (Appears on:WorkspaceConnectionPropertiesV2_STATUS)

    Field Description
    authType
    CustomKeysWorkspaceConnectionProperties_AuthType_STATUS

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory_STATUS

    Category: Category of the connection

    createdByWorkspaceArmId
    string
    credentials
    CustomKeys_STATUS

    Credentials: Custom Keys credential object

    expiryTime
    string
    group
    ConnectionGroup_STATUS

    Group: Group based on connection category

    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    CustomKeysWorkspaceConnectionProperties_ValueFormat_STATUS

    ValueFormat: format for the workspace connection value

    CustomKeysWorkspaceConnectionProperties_STATUS_ARM

    (Appears on:WorkspaceConnectionPropertiesV2_STATUS_ARM)

    Field Description
    authType
    CustomKeysWorkspaceConnectionProperties_AuthType_STATUS_ARM

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory_STATUS_ARM

    Category: Category of the connection

    createdByWorkspaceArmId
    string
    credentials
    CustomKeys_STATUS_ARM

    Credentials: Custom Keys credential object

    expiryTime
    string
    group
    ConnectionGroup_STATUS_ARM

    Group: Group based on connection category

    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    CustomKeysWorkspaceConnectionProperties_ValueFormat_STATUS_ARM

    ValueFormat: format for the workspace connection value

    CustomKeysWorkspaceConnectionProperties_ValueFormat (string alias)

    (Appears on:CustomKeysWorkspaceConnectionProperties)

    Value Description

    "JSON"

    CustomKeysWorkspaceConnectionProperties_ValueFormat_ARM (string alias)

    (Appears on:CustomKeysWorkspaceConnectionProperties_ARM)

    Value Description

    "JSON"

    CustomKeysWorkspaceConnectionProperties_ValueFormat_STATUS (string alias)

    (Appears on:CustomKeysWorkspaceConnectionProperties_STATUS)

    Value Description

    "JSON"

    CustomKeysWorkspaceConnectionProperties_ValueFormat_STATUS_ARM (string alias)

    (Appears on:CustomKeysWorkspaceConnectionProperties_STATUS_ARM)

    Value Description

    "JSON"

    CustomKeys_ARM

    (Appears on:CustomKeysWorkspaceConnectionProperties_ARM)

    Custom Keys credential object

    Field Description
    keys
    map[string]string

    CustomKeys_STATUS

    (Appears on:CustomKeysWorkspaceConnectionProperties_STATUS)

    Custom Keys credential object

    Field Description
    keys
    map[string]string

    CustomKeys_STATUS_ARM

    (Appears on:CustomKeysWorkspaceConnectionProperties_STATUS_ARM)

    Custom Keys credential object

    Field Description
    keys
    map[string]string

    CustomService

    (Appears on:ComputeInstanceProperties)

    Specifies the custom service configuration

    Field Description
    docker
    Docker

    Docker: Describes the docker settings for the image

    endpoints
    []Endpoint

    Endpoints: Configuring the endpoints for the container

    environmentVariables
    map[string]./api/machinelearningservices/v1api20240401.EnvironmentVariable

    EnvironmentVariables: Environment Variable for the container

    image
    Image

    Image: Describes the Image Specifications

    name
    string

    Name: Name of the Custom Service

    volumes
    []VolumeDefinition

    Volumes: Configuring the volumes for the container

    CustomService_ARM

    (Appears on:ComputeInstanceProperties_ARM)

    Specifies the custom service configuration

    Field Description
    docker
    Docker_ARM

    Docker: Describes the docker settings for the image

    endpoints
    []Endpoint_ARM

    Endpoints: Configuring the endpoints for the container

    environmentVariables
    map[string]./api/machinelearningservices/v1api20240401.EnvironmentVariable_ARM

    EnvironmentVariables: Environment Variable for the container

    image
    Image_ARM

    Image: Describes the Image Specifications

    name
    string

    Name: Name of the Custom Service

    volumes
    []VolumeDefinition_ARM

    Volumes: Configuring the volumes for the container

    CustomService_STATUS

    (Appears on:ComputeInstanceProperties_STATUS)

    Specifies the custom service configuration

    Field Description
    docker
    Docker_STATUS

    Docker: Describes the docker settings for the image

    endpoints
    []Endpoint_STATUS

    Endpoints: Configuring the endpoints for the container

    environmentVariables
    map[string]./api/machinelearningservices/v1api20240401.EnvironmentVariable_STATUS

    EnvironmentVariables: Environment Variable for the container

    image
    Image_STATUS

    Image: Describes the Image Specifications

    name
    string

    Name: Name of the Custom Service

    volumes
    []VolumeDefinition_STATUS

    Volumes: Configuring the volumes for the container

    CustomService_STATUS_ARM

    (Appears on:ComputeInstanceProperties_STATUS_ARM)

    Specifies the custom service configuration

    Field Description
    docker
    Docker_STATUS_ARM

    Docker: Describes the docker settings for the image

    endpoints
    []Endpoint_STATUS_ARM

    Endpoints: Configuring the endpoints for the container

    environmentVariables
    map[string]./api/machinelearningservices/v1api20240401.EnvironmentVariable_STATUS_ARM

    EnvironmentVariables: Environment Variable for the container

    image
    Image_STATUS_ARM

    Image: Describes the Image Specifications

    name
    string

    Name: Name of the Custom Service

    volumes
    []VolumeDefinition_STATUS_ARM

    Volumes: Configuring the volumes for the container

    DataFactory

    (Appears on:Compute)

    Field Description
    computeLocation
    string

    ComputeLocation: Location for the underlying compute

    computeType
    DataFactory_ComputeType

    ComputeType: The type of compute

    description
    string

    Description: The description of the Machine Learning compute.

    disableLocalAuth
    bool

    DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.

    resourceReference
    genruntime.ResourceReference

    ResourceReference: ARM resource id of the underlying compute

    DataFactory_ARM

    (Appears on:Compute_ARM)

    Field Description
    computeLocation
    string

    ComputeLocation: Location for the underlying compute

    computeType
    DataFactory_ComputeType_ARM

    ComputeType: The type of compute

    description
    string

    Description: The description of the Machine Learning compute.

    disableLocalAuth
    bool

    DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.

    resourceId
    string

    DataFactory_ComputeType (string alias)

    (Appears on:DataFactory)

    Value Description

    "DataFactory"

    DataFactory_ComputeType_ARM (string alias)

    (Appears on:DataFactory_ARM)

    Value Description

    "DataFactory"

    DataFactory_ComputeType_STATUS (string alias)

    (Appears on:DataFactory_STATUS)

    Value Description

    "DataFactory"

    DataFactory_ComputeType_STATUS_ARM (string alias)

    (Appears on:DataFactory_STATUS_ARM)

    Value Description

    "DataFactory"

    DataFactory_ProvisioningState_STATUS (string alias)

    (Appears on:DataFactory_STATUS)

    Value Description

    "Canceled"

    "Creating"

    "Deleting"

    "Failed"

    "Succeeded"

    "Unknown"

    "Updating"

    DataFactory_ProvisioningState_STATUS_ARM (string alias)

    (Appears on:DataFactory_STATUS_ARM)

    Value Description

    "Canceled"

    "Creating"

    "Deleting"

    "Failed"

    "Succeeded"

    "Unknown"

    "Updating"

    DataFactory_STATUS

    (Appears on:Compute_STATUS)

    Field Description
    computeLocation
    string

    ComputeLocation: Location for the underlying compute

    computeType
    DataFactory_ComputeType_STATUS

    ComputeType: The type of compute

    createdOn
    string

    CreatedOn: The time at which the compute was created.

    description
    string

    Description: The description of the Machine Learning compute.

    disableLocalAuth
    bool

    DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.

    isAttachedCompute
    bool

    IsAttachedCompute: Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.

    modifiedOn
    string

    ModifiedOn: The time at which the compute was last modified.

    provisioningErrors
    []ErrorResponse_STATUS

    ProvisioningErrors: Errors during provisioning

    provisioningState
    DataFactory_ProvisioningState_STATUS

    ProvisioningState: The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.

    resourceId
    string

    ResourceId: ARM resource id of the underlying compute

    DataFactory_STATUS_ARM

    (Appears on:Compute_STATUS_ARM)

    Field Description
    computeLocation
    string

    ComputeLocation: Location for the underlying compute

    computeType
    DataFactory_ComputeType_STATUS_ARM

    ComputeType: The type of compute

    createdOn
    string

    CreatedOn: The time at which the compute was created.

    description
    string

    Description: The description of the Machine Learning compute.

    disableLocalAuth
    bool

    DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.

    isAttachedCompute
    bool

    IsAttachedCompute: Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.

    modifiedOn
    string

    ModifiedOn: The time at which the compute was last modified.

    provisioningErrors
    []ErrorResponse_STATUS_ARM

    ProvisioningErrors: Errors during provisioning

    provisioningState
    DataFactory_ProvisioningState_STATUS_ARM

    ProvisioningState: The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.

    resourceId
    string

    ResourceId: ARM resource id of the underlying compute

    DataLakeAnalytics

    (Appears on:Compute)

    Field Description
    computeLocation
    string

    ComputeLocation: Location for the underlying compute

    computeType
    DataLakeAnalytics_ComputeType

    ComputeType: The type of compute

    description
    string

    Description: The description of the Machine Learning compute.

    disableLocalAuth
    bool

    DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.

    properties
    DataLakeAnalytics_Properties
    resourceReference
    genruntime.ResourceReference

    ResourceReference: ARM resource id of the underlying compute

    DataLakeAnalytics_ARM

    (Appears on:Compute_ARM)

    Field Description
    computeLocation
    string

    ComputeLocation: Location for the underlying compute

    computeType
    DataLakeAnalytics_ComputeType_ARM

    ComputeType: The type of compute

    description
    string

    Description: The description of the Machine Learning compute.

    disableLocalAuth
    bool

    DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.

    properties
    DataLakeAnalytics_Properties_ARM
    resourceId
    string

    DataLakeAnalytics_ComputeType (string alias)

    (Appears on:DataLakeAnalytics)

    Value Description

    "DataLakeAnalytics"

    DataLakeAnalytics_ComputeType_ARM (string alias)

    (Appears on:DataLakeAnalytics_ARM)

    Value Description

    "DataLakeAnalytics"

    DataLakeAnalytics_ComputeType_STATUS (string alias)

    (Appears on:DataLakeAnalytics_STATUS)

    Value Description

    "DataLakeAnalytics"

    DataLakeAnalytics_ComputeType_STATUS_ARM (string alias)

    (Appears on:DataLakeAnalytics_STATUS_ARM)

    Value Description

    "DataLakeAnalytics"

    DataLakeAnalytics_Properties

    (Appears on:DataLakeAnalytics)

    Field Description
    dataLakeStoreAccountName
    string

    DataLakeStoreAccountName: DataLake Store Account Name

    DataLakeAnalytics_Properties_ARM

    (Appears on:DataLakeAnalytics_ARM)

    Field Description
    dataLakeStoreAccountName
    string

    DataLakeStoreAccountName: DataLake Store Account Name

    DataLakeAnalytics_Properties_STATUS

    (Appears on:DataLakeAnalytics_STATUS)

    Field Description
    dataLakeStoreAccountName
    string

    DataLakeStoreAccountName: DataLake Store Account Name

    DataLakeAnalytics_Properties_STATUS_ARM

    (Appears on:DataLakeAnalytics_STATUS_ARM)

    Field Description
    dataLakeStoreAccountName
    string

    DataLakeStoreAccountName: DataLake Store Account Name

    DataLakeAnalytics_ProvisioningState_STATUS (string alias)

    (Appears on:DataLakeAnalytics_STATUS)

    Value Description

    "Canceled"

    "Creating"

    "Deleting"

    "Failed"

    "Succeeded"

    "Unknown"

    "Updating"

    DataLakeAnalytics_ProvisioningState_STATUS_ARM (string alias)

    (Appears on:DataLakeAnalytics_STATUS_ARM)

    Value Description

    "Canceled"

    "Creating"

    "Deleting"

    "Failed"

    "Succeeded"

    "Unknown"

    "Updating"

    DataLakeAnalytics_STATUS

    (Appears on:Compute_STATUS)

    Field Description
    computeLocation
    string

    ComputeLocation: Location for the underlying compute

    computeType
    DataLakeAnalytics_ComputeType_STATUS

    ComputeType: The type of compute

    createdOn
    string

    CreatedOn: The time at which the compute was created.

    description
    string

    Description: The description of the Machine Learning compute.

    disableLocalAuth
    bool

    DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.

    isAttachedCompute
    bool

    IsAttachedCompute: Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.

    modifiedOn
    string

    ModifiedOn: The time at which the compute was last modified.

    properties
    DataLakeAnalytics_Properties_STATUS
    provisioningErrors
    []ErrorResponse_STATUS

    ProvisioningErrors: Errors during provisioning

    provisioningState
    DataLakeAnalytics_ProvisioningState_STATUS

    ProvisioningState: The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.

    resourceId
    string

    ResourceId: ARM resource id of the underlying compute

    DataLakeAnalytics_STATUS_ARM

    (Appears on:Compute_STATUS_ARM)

    Field Description
    computeLocation
    string

    ComputeLocation: Location for the underlying compute

    computeType
    DataLakeAnalytics_ComputeType_STATUS_ARM

    ComputeType: The type of compute

    createdOn
    string

    CreatedOn: The time at which the compute was created.

    description
    string

    Description: The description of the Machine Learning compute.

    disableLocalAuth
    bool

    DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.

    isAttachedCompute
    bool

    IsAttachedCompute: Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.

    modifiedOn
    string

    ModifiedOn: The time at which the compute was last modified.

    properties
    DataLakeAnalytics_Properties_STATUS_ARM
    provisioningErrors
    []ErrorResponse_STATUS_ARM

    ProvisioningErrors: Errors during provisioning

    provisioningState
    DataLakeAnalytics_ProvisioningState_STATUS_ARM

    ProvisioningState: The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.

    resourceId
    string

    ResourceId: ARM resource id of the underlying compute

    Databricks

    (Appears on:Compute)

    Field Description
    computeLocation
    string

    ComputeLocation: Location for the underlying compute

    computeType
    Databricks_ComputeType

    ComputeType: The type of compute

    description
    string

    Description: The description of the Machine Learning compute.

    disableLocalAuth
    bool

    DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.

    properties
    DatabricksProperties

    Properties: Properties of Databricks

    resourceReference
    genruntime.ResourceReference

    ResourceReference: ARM resource id of the underlying compute

    DatabricksProperties

    (Appears on:Databricks)

    Properties of Databricks

    Field Description
    databricksAccessToken
    genruntime.SecretReference

    DatabricksAccessToken: Databricks access token

    workspaceUrl
    string

    WorkspaceUrl: Workspace Url

    DatabricksProperties_ARM

    (Appears on:Databricks_ARM)

    Properties of Databricks

    Field Description
    databricksAccessToken
    string

    DatabricksAccessToken: Databricks access token

    workspaceUrl
    string

    WorkspaceUrl: Workspace Url

    DatabricksProperties_STATUS

    (Appears on:Databricks_STATUS)

    Properties of Databricks

    Field Description
    workspaceUrl
    string

    WorkspaceUrl: Workspace Url

    DatabricksProperties_STATUS_ARM

    (Appears on:Databricks_STATUS_ARM)

    Properties of Databricks

    Field Description
    workspaceUrl
    string

    WorkspaceUrl: Workspace Url

    Databricks_ARM

    (Appears on:Compute_ARM)

    Field Description
    computeLocation
    string

    ComputeLocation: Location for the underlying compute

    computeType
    Databricks_ComputeType_ARM

    ComputeType: The type of compute

    description
    string

    Description: The description of the Machine Learning compute.

    disableLocalAuth
    bool

    DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.

    properties
    DatabricksProperties_ARM

    Properties: Properties of Databricks

    resourceId
    string

    Databricks_ComputeType (string alias)

    (Appears on:Databricks)

    Value Description

    "Databricks"

    Databricks_ComputeType_ARM (string alias)

    (Appears on:Databricks_ARM)

    Value Description

    "Databricks"

    Databricks_ComputeType_STATUS (string alias)

    (Appears on:Databricks_STATUS)

    Value Description

    "Databricks"

    Databricks_ComputeType_STATUS_ARM (string alias)

    (Appears on:Databricks_STATUS_ARM)

    Value Description

    "Databricks"

    Databricks_ProvisioningState_STATUS (string alias)

    (Appears on:Databricks_STATUS)

    Value Description

    "Canceled"

    "Creating"

    "Deleting"

    "Failed"

    "Succeeded"

    "Unknown"

    "Updating"

    Databricks_ProvisioningState_STATUS_ARM (string alias)

    (Appears on:Databricks_STATUS_ARM)

    Value Description

    "Canceled"

    "Creating"

    "Deleting"

    "Failed"

    "Succeeded"

    "Unknown"

    "Updating"

    Databricks_STATUS

    (Appears on:Compute_STATUS)

    Field Description
    computeLocation
    string

    ComputeLocation: Location for the underlying compute

    computeType
    Databricks_ComputeType_STATUS

    ComputeType: The type of compute

    createdOn
    string

    CreatedOn: The time at which the compute was created.

    description
    string

    Description: The description of the Machine Learning compute.

    disableLocalAuth
    bool

    DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.

    isAttachedCompute
    bool

    IsAttachedCompute: Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.

    modifiedOn
    string

    ModifiedOn: The time at which the compute was last modified.

    properties
    DatabricksProperties_STATUS

    Properties: Properties of Databricks

    provisioningErrors
    []ErrorResponse_STATUS

    ProvisioningErrors: Errors during provisioning

    provisioningState
    Databricks_ProvisioningState_STATUS

    ProvisioningState: The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.

    resourceId
    string

    ResourceId: ARM resource id of the underlying compute

    Databricks_STATUS_ARM

    (Appears on:Compute_STATUS_ARM)

    Field Description
    computeLocation
    string

    ComputeLocation: Location for the underlying compute

    computeType
    Databricks_ComputeType_STATUS_ARM

    ComputeType: The type of compute

    createdOn
    string

    CreatedOn: The time at which the compute was created.

    description
    string

    Description: The description of the Machine Learning compute.

    disableLocalAuth
    bool

    DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.

    isAttachedCompute
    bool

    IsAttachedCompute: Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.

    modifiedOn
    string

    ModifiedOn: The time at which the compute was last modified.

    properties
    DatabricksProperties_STATUS_ARM

    Properties: Properties of Databricks

    provisioningErrors
    []ErrorResponse_STATUS_ARM

    ProvisioningErrors: Errors during provisioning

    provisioningState
    Databricks_ProvisioningState_STATUS_ARM

    ProvisioningState: The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.

    resourceId
    string

    ResourceId: ARM resource id of the underlying compute

    Docker

    (Appears on:CustomService)

    Docker container configuration

    Field Description
    privileged
    bool

    Privileged: Indicate whether container shall run in privileged or non-privileged mode.

    Docker_ARM

    (Appears on:CustomService_ARM)

    Docker container configuration

    Field Description
    privileged
    bool

    Privileged: Indicate whether container shall run in privileged or non-privileged mode.

    Docker_STATUS

    (Appears on:CustomService_STATUS)

    Docker container configuration

    Field Description
    privileged
    bool

    Privileged: Indicate whether container shall run in privileged or non-privileged mode.

    Docker_STATUS_ARM

    (Appears on:CustomService_STATUS_ARM)

    Docker container configuration

    Field Description
    privileged
    bool

    Privileged: Indicate whether container shall run in privileged or non-privileged mode.

    EncryptionKeyVaultProperties

    (Appears on:EncryptionProperty)

    Field Description
    identityClientId
    string

    IdentityClientId: For future use - The client id of the identity which will be used to access key vault.

    identityClientIdFromConfig
    genruntime.ConfigMapReference

    IdentityClientIdFromConfig: For future use - The client id of the identity which will be used to access key vault.

    keyIdentifier
    string

    KeyIdentifier: Key vault uri to access the encryption key.

    keyVaultArmReference
    genruntime.ResourceReference

    KeyVaultArmReference: The ArmId of the keyVault where the customer owned encryption key is present.

    EncryptionKeyVaultProperties_ARM

    (Appears on:EncryptionProperty_ARM)

    Field Description
    identityClientId
    string

    IdentityClientId: For future use - The client id of the identity which will be used to access key vault.

    keyIdentifier
    string

    KeyIdentifier: Key vault uri to access the encryption key.

    keyVaultArmId
    string

    EncryptionKeyVaultProperties_STATUS

    (Appears on:EncryptionProperty_STATUS)

    Field Description
    identityClientId
    string

    IdentityClientId: For future use - The client id of the identity which will be used to access key vault.

    keyIdentifier
    string

    KeyIdentifier: Key vault uri to access the encryption key.

    keyVaultArmId
    string

    KeyVaultArmId: The ArmId of the keyVault where the customer owned encryption key is present.

    EncryptionKeyVaultProperties_STATUS_ARM

    (Appears on:EncryptionProperty_STATUS_ARM)

    Field Description
    identityClientId
    string

    IdentityClientId: For future use - The client id of the identity which will be used to access key vault.

    keyIdentifier
    string

    KeyIdentifier: Key vault uri to access the encryption key.

    keyVaultArmId
    string

    KeyVaultArmId: The ArmId of the keyVault where the customer owned encryption key is present.

    EncryptionProperty

    (Appears on:Workspace_Spec)

    Field Description
    identity
    IdentityForCmk

    Identity: The identity that will be used to access the key vault for encryption at rest.

    keyVaultProperties
    EncryptionKeyVaultProperties

    KeyVaultProperties: Customer Key vault properties.

    EncryptionProperty_ARM

    (Appears on:WorkspaceProperties_ARM)

    Field Description
    identity
    IdentityForCmk_ARM

    Identity: The identity that will be used to access the key vault for encryption at rest.

    keyVaultProperties
    EncryptionKeyVaultProperties_ARM

    KeyVaultProperties: Customer Key vault properties.

    EncryptionProperty_STATUS

    (Appears on:Workspace_STATUS)

    Field Description
    identity
    IdentityForCmk_STATUS

    Identity: The identity that will be used to access the key vault for encryption at rest.

    keyVaultProperties
    EncryptionKeyVaultProperties_STATUS

    KeyVaultProperties: Customer Key vault properties.

    status
    EncryptionProperty_Status_STATUS

    Status: Indicates whether or not the encryption is enabled for the workspace.

    EncryptionProperty_STATUS_ARM

    (Appears on:WorkspaceProperties_STATUS_ARM)

    Field Description
    identity
    IdentityForCmk_STATUS_ARM

    Identity: The identity that will be used to access the key vault for encryption at rest.

    keyVaultProperties
    EncryptionKeyVaultProperties_STATUS_ARM

    KeyVaultProperties: Customer Key vault properties.

    status
    EncryptionProperty_Status_STATUS_ARM

    Status: Indicates whether or not the encryption is enabled for the workspace.

    EncryptionProperty_Status_STATUS (string alias)

    (Appears on:EncryptionProperty_STATUS)

    Value Description

    "Disabled"

    "Enabled"

    EncryptionProperty_Status_STATUS_ARM (string alias)

    (Appears on:EncryptionProperty_STATUS_ARM)

    Value Description

    "Disabled"

    "Enabled"

    Endpoint

    (Appears on:CustomService)

    Describes the endpoint configuration for the container

    Field Description
    hostIp
    string

    HostIp: Host IP over which the application is exposed from the container

    name
    string

    Name: Name of the Endpoint

    protocol
    Endpoint_Protocol

    Protocol: Protocol over which communication will happen over this endpoint

    published
    int

    Published: Port over which the application is exposed from container.

    target
    int

    Target: Application port inside the container.

    Endpoint_ARM

    (Appears on:CustomService_ARM)

    Describes the endpoint configuration for the container

    Field Description
    hostIp
    string

    HostIp: Host IP over which the application is exposed from the container

    name
    string

    Name: Name of the Endpoint

    protocol
    Endpoint_Protocol_ARM

    Protocol: Protocol over which communication will happen over this endpoint

    published
    int

    Published: Port over which the application is exposed from container.

    target
    int

    Target: Application port inside the container.

    Endpoint_Protocol (string alias)

    (Appears on:Endpoint)

    Value Description

    "http"

    "tcp"

    "udp"

    Endpoint_Protocol_ARM (string alias)

    (Appears on:Endpoint_ARM)

    Value Description

    "http"

    "tcp"

    "udp"

    Endpoint_Protocol_STATUS (string alias)

    (Appears on:Endpoint_STATUS)

    Value Description

    "http"

    "tcp"

    "udp"

    Endpoint_Protocol_STATUS_ARM (string alias)

    (Appears on:Endpoint_STATUS_ARM)

    Value Description

    "http"

    "tcp"

    "udp"

    Endpoint_STATUS

    (Appears on:CustomService_STATUS)

    Describes the endpoint configuration for the container

    Field Description
    hostIp
    string

    HostIp: Host IP over which the application is exposed from the container

    name
    string

    Name: Name of the Endpoint

    protocol
    Endpoint_Protocol_STATUS

    Protocol: Protocol over which communication will happen over this endpoint

    published
    int

    Published: Port over which the application is exposed from container.

    target
    int

    Target: Application port inside the container.

    Endpoint_STATUS_ARM

    (Appears on:CustomService_STATUS_ARM)

    Describes the endpoint configuration for the container

    Field Description
    hostIp
    string

    HostIp: Host IP over which the application is exposed from the container

    name
    string

    Name: Name of the Endpoint

    protocol
    Endpoint_Protocol_STATUS_ARM

    Protocol: Protocol over which communication will happen over this endpoint

    published
    int

    Published: Port over which the application is exposed from container.

    target
    int

    Target: Application port inside the container.

    EnvironmentVariable

    (Appears on:CustomService)

    Environment Variables for the container

    Field Description
    type
    EnvironmentVariable_Type

    Type: Type of the Environment Variable. Possible values are: local - For local variable

    value
    string

    Value: Value of the Environment variable

    EnvironmentVariable_ARM

    (Appears on:CustomService_ARM)

    Environment Variables for the container

    Field Description
    type
    EnvironmentVariable_Type_ARM

    Type: Type of the Environment Variable. Possible values are: local - For local variable

    value
    string

    Value: Value of the Environment variable

    EnvironmentVariable_STATUS

    (Appears on:CustomService_STATUS)

    Environment Variables for the container

    Field Description
    type
    EnvironmentVariable_Type_STATUS

    Type: Type of the Environment Variable. Possible values are: local - For local variable

    value
    string

    Value: Value of the Environment variable

    EnvironmentVariable_STATUS_ARM

    (Appears on:CustomService_STATUS_ARM)

    Environment Variables for the container

    Field Description
    type
    EnvironmentVariable_Type_STATUS_ARM

    Type: Type of the Environment Variable. Possible values are: local - For local variable

    value
    string

    Value: Value of the Environment variable

    EnvironmentVariable_Type (string alias)

    (Appears on:EnvironmentVariable)

    Value Description

    "local"

    EnvironmentVariable_Type_ARM (string alias)

    (Appears on:EnvironmentVariable_ARM)

    Value Description

    "local"

    EnvironmentVariable_Type_STATUS (string alias)

    (Appears on:EnvironmentVariable_STATUS)

    Value Description

    "local"

    EnvironmentVariable_Type_STATUS_ARM (string alias)

    (Appears on:EnvironmentVariable_STATUS_ARM)

    Value Description

    "local"

    ErrorAdditionalInfo_STATUS

    (Appears on:ErrorDetail_STATUS, ErrorDetail_STATUS_Unrolled)

    The resource management error additional info.

    Field Description
    info
    map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON

    Info: The additional info.

    type
    string

    Type: The additional info type.

    ErrorAdditionalInfo_STATUS_ARM

    (Appears on:ErrorDetail_STATUS_ARM, ErrorDetail_STATUS_Unrolled_ARM)

    The resource management error additional info.

    Field Description
    info
    map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON

    Info: The additional info.

    type
    string

    Type: The additional info type.

    ErrorDetail_STATUS

    (Appears on:ErrorResponse_STATUS)

    The error detail.

    Field Description
    additionalInfo
    []ErrorAdditionalInfo_STATUS

    AdditionalInfo: The error additional info.

    code
    string

    Code: The error code.

    details
    []ErrorDetail_STATUS_Unrolled

    Details: The error details.

    message
    string

    Message: The error message.

    target
    string

    Target: The error target.

    ErrorDetail_STATUS_ARM

    (Appears on:ErrorResponse_STATUS_ARM)

    The error detail.

    Field Description
    additionalInfo
    []ErrorAdditionalInfo_STATUS_ARM

    AdditionalInfo: The error additional info.

    code
    string

    Code: The error code.

    details
    []ErrorDetail_STATUS_Unrolled_ARM

    Details: The error details.

    message
    string

    Message: The error message.

    target
    string

    Target: The error target.

    ErrorDetail_STATUS_Unrolled

    (Appears on:ErrorDetail_STATUS)

    Field Description
    additionalInfo
    []ErrorAdditionalInfo_STATUS

    AdditionalInfo: The error additional info.

    code
    string

    Code: The error code.

    message
    string

    Message: The error message.

    target
    string

    Target: The error target.

    ErrorDetail_STATUS_Unrolled_ARM

    (Appears on:ErrorDetail_STATUS_ARM)

    Field Description
    additionalInfo
    []ErrorAdditionalInfo_STATUS_ARM

    AdditionalInfo: The error additional info.

    code
    string

    Code: The error code.

    message
    string

    Message: The error message.

    target
    string

    Target: The error target.

    ErrorResponse_STATUS

    (Appears on:AKS_STATUS, AmlComputeProperties_STATUS, AmlCompute_STATUS, ComputeInstanceProperties_STATUS, ComputeInstance_STATUS, DataFactory_STATUS, DataLakeAnalytics_STATUS, Databricks_STATUS, HDInsight_STATUS, Kubernetes_STATUS, SynapseSpark_STATUS, VirtualMachine_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.).

    Field Description
    error
    ErrorDetail_STATUS

    Error: The error object.

    ErrorResponse_STATUS_ARM

    (Appears on:AKS_STATUS_ARM, AmlComputeProperties_STATUS_ARM, AmlCompute_STATUS_ARM, ComputeInstanceProperties_STATUS_ARM, ComputeInstance_STATUS_ARM, DataFactory_STATUS_ARM, DataLakeAnalytics_STATUS_ARM, Databricks_STATUS_ARM, HDInsight_STATUS_ARM, Kubernetes_STATUS_ARM, SynapseSpark_STATUS_ARM, VirtualMachine_STATUS_ARM)

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

    Field Description
    error
    ErrorDetail_STATUS_ARM

    Error: The error object.

    FeatureStoreSettings

    (Appears on:Workspace_Spec)

    Settings for feature store type workspace.

    Field Description
    computeRuntime
    ComputeRuntimeDto

    ComputeRuntime: Compute runtime config for feature store type workspace.

    offlineStoreConnectionName
    string
    onlineStoreConnectionName
    string

    FeatureStoreSettings_ARM

    (Appears on:WorkspaceProperties_ARM)

    Settings for feature store type workspace.

    Field Description
    computeRuntime
    ComputeRuntimeDto_ARM

    ComputeRuntime: Compute runtime config for feature store type workspace.

    offlineStoreConnectionName
    string
    onlineStoreConnectionName
    string

    FeatureStoreSettings_STATUS

    (Appears on:Workspace_STATUS)

    Settings for feature store type workspace.

    Field Description
    computeRuntime
    ComputeRuntimeDto_STATUS

    ComputeRuntime: Compute runtime config for feature store type workspace.

    offlineStoreConnectionName
    string
    onlineStoreConnectionName
    string

    FeatureStoreSettings_STATUS_ARM

    (Appears on:WorkspaceProperties_STATUS_ARM)

    Settings for feature store type workspace.

    Field Description
    computeRuntime
    ComputeRuntimeDto_STATUS_ARM

    ComputeRuntime: Compute runtime config for feature store type workspace.

    offlineStoreConnectionName
    string
    onlineStoreConnectionName
    string

    FqdnOutboundRule

    (Appears on:OutboundRule)

    Field Description
    category
    RuleCategory

    Category: Category of a managed network Outbound Rule of a machine learning workspace.

    destination
    string
    status
    RuleStatus

    Status: Type of a managed network Outbound Rule of a machine learning workspace.

    type
    FqdnOutboundRule_Type

    FqdnOutboundRule_ARM

    (Appears on:OutboundRule_ARM)

    Field Description
    category
    RuleCategory_ARM

    Category: Category of a managed network Outbound Rule of a machine learning workspace.

    destination
    string
    status
    RuleStatus_ARM

    Status: Type of a managed network Outbound Rule of a machine learning workspace.

    type
    FqdnOutboundRule_Type_ARM

    FqdnOutboundRule_STATUS

    (Appears on:OutboundRule_STATUS)

    Field Description
    category
    RuleCategory_STATUS

    Category: Category of a managed network Outbound Rule of a machine learning workspace.

    destination
    string
    status
    RuleStatus_STATUS

    Status: Type of a managed network Outbound Rule of a machine learning workspace.

    type
    FqdnOutboundRule_Type_STATUS

    FqdnOutboundRule_STATUS_ARM

    (Appears on:OutboundRule_STATUS_ARM)

    Field Description
    category
    RuleCategory_STATUS_ARM

    Category: Category of a managed network Outbound Rule of a machine learning workspace.

    destination
    string
    status
    RuleStatus_STATUS_ARM

    Status: Type of a managed network Outbound Rule of a machine learning workspace.

    type
    FqdnOutboundRule_Type_STATUS_ARM

    FqdnOutboundRule_Type (string alias)

    (Appears on:FqdnOutboundRule)

    Value Description

    "FQDN"

    FqdnOutboundRule_Type_ARM (string alias)

    (Appears on:FqdnOutboundRule_ARM)

    Value Description

    "FQDN"

    FqdnOutboundRule_Type_STATUS (string alias)

    (Appears on:FqdnOutboundRule_STATUS)

    Value Description

    "FQDN"

    FqdnOutboundRule_Type_STATUS_ARM (string alias)

    (Appears on:FqdnOutboundRule_STATUS_ARM)

    Value Description

    "FQDN"

    HDInsight

    (Appears on:Compute)

    Field Description
    computeLocation
    string

    ComputeLocation: Location for the underlying compute

    computeType
    HDInsight_ComputeType

    ComputeType: The type of compute

    description
    string

    Description: The description of the Machine Learning compute.

    disableLocalAuth
    bool

    DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.

    properties
    HDInsightProperties

    Properties: HDInsight compute properties

    resourceReference
    genruntime.ResourceReference

    ResourceReference: ARM resource id of the underlying compute

    HDInsightProperties

    (Appears on:HDInsight)

    HDInsight compute properties

    Field Description
    address
    string

    Address: Public IP address of the master node of the cluster.

    administratorAccount
    VirtualMachineSshCredentials

    AdministratorAccount: Admin credentials for master node of the cluster

    sshPort
    int

    SshPort: Port open for ssh connections on the master node of the cluster.

    HDInsightProperties_ARM

    (Appears on:HDInsight_ARM)

    HDInsight compute properties

    Field Description
    address
    string

    Address: Public IP address of the master node of the cluster.

    administratorAccount
    VirtualMachineSshCredentials_ARM

    AdministratorAccount: Admin credentials for master node of the cluster

    sshPort
    int

    SshPort: Port open for ssh connections on the master node of the cluster.

    HDInsightProperties_STATUS

    (Appears on:HDInsight_STATUS)

    HDInsight compute properties

    Field Description
    address
    string

    Address: Public IP address of the master node of the cluster.

    administratorAccount
    VirtualMachineSshCredentials_STATUS

    AdministratorAccount: Admin credentials for master node of the cluster

    sshPort
    int

    SshPort: Port open for ssh connections on the master node of the cluster.

    HDInsightProperties_STATUS_ARM

    (Appears on:HDInsight_STATUS_ARM)

    HDInsight compute properties

    Field Description
    address
    string

    Address: Public IP address of the master node of the cluster.

    administratorAccount
    VirtualMachineSshCredentials_STATUS_ARM

    AdministratorAccount: Admin credentials for master node of the cluster

    sshPort
    int

    SshPort: Port open for ssh connections on the master node of the cluster.

    HDInsight_ARM

    (Appears on:Compute_ARM)

    Field Description
    computeLocation
    string

    ComputeLocation: Location for the underlying compute

    computeType
    HDInsight_ComputeType_ARM

    ComputeType: The type of compute

    description
    string

    Description: The description of the Machine Learning compute.

    disableLocalAuth
    bool

    DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.

    properties
    HDInsightProperties_ARM

    Properties: HDInsight compute properties

    resourceId
    string

    HDInsight_ComputeType (string alias)

    (Appears on:HDInsight)

    Value Description

    "HDInsight"

    HDInsight_ComputeType_ARM (string alias)

    (Appears on:HDInsight_ARM)

    Value Description

    "HDInsight"

    HDInsight_ComputeType_STATUS (string alias)

    (Appears on:HDInsight_STATUS)

    Value Description

    "HDInsight"

    HDInsight_ComputeType_STATUS_ARM (string alias)

    (Appears on:HDInsight_STATUS_ARM)

    Value Description

    "HDInsight"

    HDInsight_ProvisioningState_STATUS (string alias)

    (Appears on:HDInsight_STATUS)

    Value Description

    "Canceled"

    "Creating"

    "Deleting"

    "Failed"

    "Succeeded"

    "Unknown"

    "Updating"

    HDInsight_ProvisioningState_STATUS_ARM (string alias)

    (Appears on:HDInsight_STATUS_ARM)

    Value Description

    "Canceled"

    "Creating"

    "Deleting"

    "Failed"

    "Succeeded"

    "Unknown"

    "Updating"

    HDInsight_STATUS

    (Appears on:Compute_STATUS)

    Field Description
    computeLocation
    string

    ComputeLocation: Location for the underlying compute

    computeType
    HDInsight_ComputeType_STATUS

    ComputeType: The type of compute

    createdOn
    string

    CreatedOn: The time at which the compute was created.

    description
    string

    Description: The description of the Machine Learning compute.

    disableLocalAuth
    bool

    DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.

    isAttachedCompute
    bool

    IsAttachedCompute: Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.

    modifiedOn
    string

    ModifiedOn: The time at which the compute was last modified.

    properties
    HDInsightProperties_STATUS

    Properties: HDInsight compute properties

    provisioningErrors
    []ErrorResponse_STATUS

    ProvisioningErrors: Errors during provisioning

    provisioningState
    HDInsight_ProvisioningState_STATUS

    ProvisioningState: The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.

    resourceId
    string

    ResourceId: ARM resource id of the underlying compute

    HDInsight_STATUS_ARM

    (Appears on:Compute_STATUS_ARM)

    Field Description
    computeLocation
    string

    ComputeLocation: Location for the underlying compute

    computeType
    HDInsight_ComputeType_STATUS_ARM

    ComputeType: The type of compute

    createdOn
    string

    CreatedOn: The time at which the compute was created.

    description
    string

    Description: The description of the Machine Learning compute.

    disableLocalAuth
    bool

    DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.

    isAttachedCompute
    bool

    IsAttachedCompute: Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.

    modifiedOn
    string

    ModifiedOn: The time at which the compute was last modified.

    properties
    HDInsightProperties_STATUS_ARM

    Properties: HDInsight compute properties

    provisioningErrors
    []ErrorResponse_STATUS_ARM

    ProvisioningErrors: Errors during provisioning

    provisioningState
    HDInsight_ProvisioningState_STATUS_ARM

    ProvisioningState: The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.

    resourceId
    string

    ResourceId: ARM resource id of the underlying compute

    IdentityForCmk

    (Appears on:EncryptionProperty)

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

    Field Description
    userAssignedIdentityReference
    genruntime.ResourceReference

    UserAssignedIdentityReference: The ArmId of the user assigned identity that will be used to access the customer managed key vault

    IdentityForCmk_ARM

    (Appears on:EncryptionProperty_ARM)

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

    Field Description
    userAssignedIdentity
    string

    IdentityForCmk_STATUS

    (Appears on:EncryptionProperty_STATUS)

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

    Field Description
    userAssignedIdentity
    string

    UserAssignedIdentity: The ArmId of the user assigned identity that will be used to access the customer managed key vault

    IdentityForCmk_STATUS_ARM

    (Appears on:EncryptionProperty_STATUS_ARM)

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

    Field Description
    userAssignedIdentity
    string

    UserAssignedIdentity: The ArmId of the user assigned identity that will be used to access the customer managed key vault

    Image

    (Appears on:CustomService)

    Describes the Image Specifications

    Field Description
    reference
    string

    Reference: Image reference

    type
    Image_Type

    Type: Type of the image. Possible values are: docker - For docker images. azureml - For AzureML images

    ImageMetadata_STATUS

    (Appears on:ComputeInstanceProperties_STATUS)

    Returns metadata about the operating system image for this compute instance.

    Field Description
    currentImageVersion
    string

    CurrentImageVersion: Specifies the current operating system image version this compute instance is running on.

    isLatestOsImageVersion
    bool

    IsLatestOsImageVersion: Specifies whether this compute instance is running on the latest operating system image.

    latestImageVersion
    string

    LatestImageVersion: Specifies the latest available operating system image version.

    ImageMetadata_STATUS_ARM

    (Appears on:ComputeInstanceProperties_STATUS_ARM)

    Returns metadata about the operating system image for this compute instance.

    Field Description
    currentImageVersion
    string

    CurrentImageVersion: Specifies the current operating system image version this compute instance is running on.

    isLatestOsImageVersion
    bool

    IsLatestOsImageVersion: Specifies whether this compute instance is running on the latest operating system image.

    latestImageVersion
    string

    LatestImageVersion: Specifies the latest available operating system image version.

    Image_ARM

    (Appears on:CustomService_ARM)

    Describes the Image Specifications

    Field Description
    reference
    string

    Reference: Image reference

    type
    Image_Type_ARM

    Type: Type of the image. Possible values are: docker - For docker images. azureml - For AzureML images

    Image_STATUS

    (Appears on:CustomService_STATUS)

    Describes the Image Specifications

    Field Description
    reference
    string

    Reference: Image reference

    type
    Image_Type_STATUS

    Type: Type of the image. Possible values are: docker - For docker images. azureml - For AzureML images

    Image_STATUS_ARM

    (Appears on:CustomService_STATUS_ARM)

    Describes the Image Specifications

    Field Description
    reference
    string

    Reference: Image reference

    type
    Image_Type_STATUS_ARM

    Type: Type of the image. Possible values are: docker - For docker images. azureml - For AzureML images

    Image_Type (string alias)

    (Appears on:Image)

    Value Description

    "azureml"

    "docker"

    Image_Type_ARM (string alias)

    (Appears on:Image_ARM)

    Value Description

    "azureml"

    "docker"

    Image_Type_STATUS (string alias)

    (Appears on:Image_STATUS)

    Value Description

    "azureml"

    "docker"

    Image_Type_STATUS_ARM (string alias)

    (Appears on:Image_STATUS_ARM)

    Value Description

    "azureml"

    "docker"

    InstanceTypeSchema

    (Appears on:KubernetesProperties)

    Instance type schema.

    Field Description
    nodeSelector
    map[string]string

    NodeSelector: Node Selector

    resources
    InstanceTypeSchema_Resources

    Resources: Resource requests/limits for this instance type

    InstanceTypeSchema_ARM

    (Appears on:KubernetesProperties_ARM)

    Instance type schema.

    Field Description
    nodeSelector
    map[string]string

    NodeSelector: Node Selector

    resources
    InstanceTypeSchema_Resources_ARM

    Resources: Resource requests/limits for this instance type

    InstanceTypeSchema_Resources

    (Appears on:InstanceTypeSchema)

    Field Description
    limits
    map[string]string

    Limits: Resource limits for this instance type

    requests
    map[string]string

    Requests: Resource requests for this instance type

    InstanceTypeSchema_Resources_ARM

    (Appears on:InstanceTypeSchema_ARM)

    Field Description
    limits
    map[string]string

    Limits: Resource limits for this instance type

    requests
    map[string]string

    Requests: Resource requests for this instance type

    InstanceTypeSchema_Resources_STATUS

    (Appears on:InstanceTypeSchema_STATUS)

    Field Description
    limits
    map[string]string

    Limits: Resource limits for this instance type

    requests
    map[string]string

    Requests: Resource requests for this instance type

    InstanceTypeSchema_Resources_STATUS_ARM

    (Appears on:InstanceTypeSchema_STATUS_ARM)

    Field Description
    limits
    map[string]string

    Limits: Resource limits for this instance type

    requests
    map[string]string

    Requests: Resource requests for this instance type

    InstanceTypeSchema_STATUS

    (Appears on:KubernetesProperties_STATUS)

    Instance type schema.

    Field Description
    nodeSelector
    map[string]string

    NodeSelector: Node Selector

    resources
    InstanceTypeSchema_Resources_STATUS

    Resources: Resource requests/limits for this instance type

    InstanceTypeSchema_STATUS_ARM

    (Appears on:KubernetesProperties_STATUS_ARM)

    Instance type schema.

    Field Description
    nodeSelector
    map[string]string

    NodeSelector: Node Selector

    resources
    InstanceTypeSchema_Resources_STATUS_ARM

    Resources: Resource requests/limits for this instance type

    IsolationMode (string alias)

    (Appears on:ManagedNetworkSettings)

    Isolation mode for the managed network of a machine learning workspace.

    Value Description

    "AllowInternetOutbound"

    "AllowOnlyApprovedOutbound"

    "Disabled"

    IsolationMode_ARM (string alias)

    (Appears on:ManagedNetworkSettings_ARM)

    Isolation mode for the managed network of a machine learning workspace.

    Value Description

    "AllowInternetOutbound"

    "AllowOnlyApprovedOutbound"

    "Disabled"

    IsolationMode_STATUS (string alias)

    (Appears on:ManagedNetworkSettings_STATUS)

    Isolation mode for the managed network of a machine learning workspace.

    Value Description

    "AllowInternetOutbound"

    "AllowOnlyApprovedOutbound"

    "Disabled"

    IsolationMode_STATUS_ARM (string alias)

    (Appears on:ManagedNetworkSettings_STATUS_ARM)

    Isolation mode for the managed network of a machine learning workspace.

    Value Description

    "AllowInternetOutbound"

    "AllowOnlyApprovedOutbound"

    "Disabled"

    Kubernetes

    (Appears on:Compute)

    Field Description
    computeLocation
    string

    ComputeLocation: Location for the underlying compute

    computeType
    Kubernetes_ComputeType

    ComputeType: The type of compute

    description
    string

    Description: The description of the Machine Learning compute.

    disableLocalAuth
    bool

    DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.

    properties
    KubernetesProperties

    Properties: Properties of Kubernetes

    resourceReference
    genruntime.ResourceReference

    ResourceReference: ARM resource id of the underlying compute

    KubernetesProperties

    (Appears on:Kubernetes)

    Kubernetes properties

    Field Description
    defaultInstanceType
    string

    DefaultInstanceType: Default instance type

    extensionInstanceReleaseTrain
    string

    ExtensionInstanceReleaseTrain: Extension instance release train.

    extensionPrincipalId
    string

    ExtensionPrincipalId: Extension principal-id.

    extensionPrincipalIdFromConfig
    genruntime.ConfigMapReference

    ExtensionPrincipalIdFromConfig: Extension principal-id.

    instanceTypes
    map[string]./api/machinelearningservices/v1api20240401.InstanceTypeSchema

    InstanceTypes: Instance Type Schema

    namespace
    string

    Namespace: Compute namespace

    relayConnectionString
    genruntime.SecretReference

    RelayConnectionString: Relay connection string.

    serviceBusConnectionString
    genruntime.SecretReference

    ServiceBusConnectionString: ServiceBus connection string.

    vcName
    string

    VcName: VC name.

    KubernetesProperties_ARM

    (Appears on:Kubernetes_ARM)

    Kubernetes properties

    Field Description
    defaultInstanceType
    string

    DefaultInstanceType: Default instance type

    extensionInstanceReleaseTrain
    string

    ExtensionInstanceReleaseTrain: Extension instance release train.

    extensionPrincipalId
    string

    ExtensionPrincipalId: Extension principal-id.

    instanceTypes
    map[string]./api/machinelearningservices/v1api20240401.InstanceTypeSchema_ARM

    InstanceTypes: Instance Type Schema

    namespace
    string

    Namespace: Compute namespace

    relayConnectionString
    string

    RelayConnectionString: Relay connection string.

    serviceBusConnectionString
    string

    ServiceBusConnectionString: ServiceBus connection string.

    vcName
    string

    VcName: VC name.

    KubernetesProperties_STATUS

    (Appears on:Kubernetes_STATUS)

    Kubernetes properties

    Field Description
    defaultInstanceType
    string

    DefaultInstanceType: Default instance type

    extensionInstanceReleaseTrain
    string

    ExtensionInstanceReleaseTrain: Extension instance release train.

    extensionPrincipalId
    string

    ExtensionPrincipalId: Extension principal-id.

    instanceTypes
    map[string]./api/machinelearningservices/v1api20240401.InstanceTypeSchema_STATUS

    InstanceTypes: Instance Type Schema

    namespace
    string

    Namespace: Compute namespace

    vcName
    string

    VcName: VC name.

    KubernetesProperties_STATUS_ARM

    (Appears on:Kubernetes_STATUS_ARM)

    Kubernetes properties

    Field Description
    defaultInstanceType
    string

    DefaultInstanceType: Default instance type

    extensionInstanceReleaseTrain
    string

    ExtensionInstanceReleaseTrain: Extension instance release train.

    extensionPrincipalId
    string

    ExtensionPrincipalId: Extension principal-id.

    instanceTypes
    map[string]./api/machinelearningservices/v1api20240401.InstanceTypeSchema_STATUS_ARM

    InstanceTypes: Instance Type Schema

    namespace
    string

    Namespace: Compute namespace

    vcName
    string

    VcName: VC name.

    Kubernetes_ARM

    (Appears on:Compute_ARM)

    Field Description
    computeLocation
    string

    ComputeLocation: Location for the underlying compute

    computeType
    Kubernetes_ComputeType_ARM

    ComputeType: The type of compute

    description
    string

    Description: The description of the Machine Learning compute.

    disableLocalAuth
    bool

    DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.

    properties
    KubernetesProperties_ARM

    Properties: Properties of Kubernetes

    resourceId
    string

    Kubernetes_ComputeType (string alias)

    (Appears on:Kubernetes)

    Value Description

    "Kubernetes"

    Kubernetes_ComputeType_ARM (string alias)

    (Appears on:Kubernetes_ARM)

    Value Description

    "Kubernetes"

    Kubernetes_ComputeType_STATUS (string alias)

    (Appears on:Kubernetes_STATUS)

    Value Description

    "Kubernetes"

    Kubernetes_ComputeType_STATUS_ARM (string alias)

    (Appears on:Kubernetes_STATUS_ARM)

    Value Description

    "Kubernetes"

    Kubernetes_ProvisioningState_STATUS (string alias)

    (Appears on:Kubernetes_STATUS)

    Value Description

    "Canceled"

    "Creating"

    "Deleting"

    "Failed"

    "Succeeded"

    "Unknown"

    "Updating"

    Kubernetes_ProvisioningState_STATUS_ARM (string alias)

    (Appears on:Kubernetes_STATUS_ARM)

    Value Description

    "Canceled"

    "Creating"

    "Deleting"

    "Failed"

    "Succeeded"

    "Unknown"

    "Updating"

    Kubernetes_STATUS

    (Appears on:Compute_STATUS)

    Field Description
    computeLocation
    string

    ComputeLocation: Location for the underlying compute

    computeType
    Kubernetes_ComputeType_STATUS

    ComputeType: The type of compute

    createdOn
    string

    CreatedOn: The time at which the compute was created.

    description
    string

    Description: The description of the Machine Learning compute.

    disableLocalAuth
    bool

    DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.

    isAttachedCompute
    bool

    IsAttachedCompute: Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.

    modifiedOn
    string

    ModifiedOn: The time at which the compute was last modified.

    properties
    KubernetesProperties_STATUS

    Properties: Properties of Kubernetes

    provisioningErrors
    []ErrorResponse_STATUS

    ProvisioningErrors: Errors during provisioning

    provisioningState
    Kubernetes_ProvisioningState_STATUS

    ProvisioningState: The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.

    resourceId
    string

    ResourceId: ARM resource id of the underlying compute

    Kubernetes_STATUS_ARM

    (Appears on:Compute_STATUS_ARM)

    Field Description
    computeLocation
    string

    ComputeLocation: Location for the underlying compute

    computeType
    Kubernetes_ComputeType_STATUS_ARM

    ComputeType: The type of compute

    createdOn
    string

    CreatedOn: The time at which the compute was created.

    description
    string

    Description: The description of the Machine Learning compute.

    disableLocalAuth
    bool

    DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.

    isAttachedCompute
    bool

    IsAttachedCompute: Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.

    modifiedOn
    string

    ModifiedOn: The time at which the compute was last modified.

    properties
    KubernetesProperties_STATUS_ARM

    Properties: Properties of Kubernetes

    provisioningErrors
    []ErrorResponse_STATUS_ARM

    ProvisioningErrors: Errors during provisioning

    provisioningState
    Kubernetes_ProvisioningState_STATUS_ARM

    ProvisioningState: The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.

    resourceId
    string

    ResourceId: ARM resource id of the underlying compute

    ManagedIdentityAuthTypeWorkspaceConnectionProperties

    (Appears on:WorkspaceConnectionPropertiesV2)

    Field Description
    authType
    ManagedIdentityAuthTypeWorkspaceConnectionProperties_AuthType

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory

    Category: Category of the connection

    credentials
    WorkspaceConnectionManagedIdentity
    expiryTime
    string
    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    ManagedIdentityAuthTypeWorkspaceConnectionProperties_ValueFormat

    ValueFormat: format for the workspace connection value

    ManagedIdentityAuthTypeWorkspaceConnectionProperties_ARM

    (Appears on:WorkspaceConnectionPropertiesV2_ARM)

    Field Description
    authType
    ManagedIdentityAuthTypeWorkspaceConnectionProperties_AuthType_ARM

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory_ARM

    Category: Category of the connection

    credentials
    WorkspaceConnectionManagedIdentity_ARM
    expiryTime
    string
    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    ManagedIdentityAuthTypeWorkspaceConnectionProperties_ValueFormat_ARM

    ValueFormat: format for the workspace connection value

    ManagedIdentityAuthTypeWorkspaceConnectionProperties_AuthType (string alias)

    (Appears on:ManagedIdentityAuthTypeWorkspaceConnectionProperties)

    Value Description

    "ManagedIdentity"

    ManagedIdentityAuthTypeWorkspaceConnectionProperties_AuthType_ARM (string alias)

    (Appears on:ManagedIdentityAuthTypeWorkspaceConnectionProperties_ARM)

    Value Description

    "ManagedIdentity"

    ManagedIdentityAuthTypeWorkspaceConnectionProperties_AuthType_STATUS (string alias)

    (Appears on:ManagedIdentityAuthTypeWorkspaceConnectionProperties_STATUS)

    Value Description

    "ManagedIdentity"

    ManagedIdentityAuthTypeWorkspaceConnectionProperties_AuthType_STATUS_ARM (string alias)

    (Appears on:ManagedIdentityAuthTypeWorkspaceConnectionProperties_STATUS_ARM)

    Value Description

    "ManagedIdentity"

    ManagedIdentityAuthTypeWorkspaceConnectionProperties_STATUS

    (Appears on:WorkspaceConnectionPropertiesV2_STATUS)

    Field Description
    authType
    ManagedIdentityAuthTypeWorkspaceConnectionProperties_AuthType_STATUS

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory_STATUS

    Category: Category of the connection

    createdByWorkspaceArmId
    string
    credentials
    WorkspaceConnectionManagedIdentity_STATUS
    expiryTime
    string
    group
    ConnectionGroup_STATUS

    Group: Group based on connection category

    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    ManagedIdentityAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS

    ValueFormat: format for the workspace connection value

    ManagedIdentityAuthTypeWorkspaceConnectionProperties_STATUS_ARM

    (Appears on:WorkspaceConnectionPropertiesV2_STATUS_ARM)

    Field Description
    authType
    ManagedIdentityAuthTypeWorkspaceConnectionProperties_AuthType_STATUS_ARM

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory_STATUS_ARM

    Category: Category of the connection

    createdByWorkspaceArmId
    string
    credentials
    WorkspaceConnectionManagedIdentity_STATUS_ARM
    expiryTime
    string
    group
    ConnectionGroup_STATUS_ARM

    Group: Group based on connection category

    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    ManagedIdentityAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS_ARM

    ValueFormat: format for the workspace connection value

    ManagedIdentityAuthTypeWorkspaceConnectionProperties_ValueFormat (string alias)

    (Appears on:ManagedIdentityAuthTypeWorkspaceConnectionProperties)

    Value Description

    "JSON"

    ManagedIdentityAuthTypeWorkspaceConnectionProperties_ValueFormat_ARM (string alias)

    (Appears on:ManagedIdentityAuthTypeWorkspaceConnectionProperties_ARM)

    Value Description

    "JSON"

    ManagedIdentityAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS (string alias)

    (Appears on:ManagedIdentityAuthTypeWorkspaceConnectionProperties_STATUS)

    Value Description

    "JSON"

    ManagedIdentityAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS_ARM (string alias)

    (Appears on:ManagedIdentityAuthTypeWorkspaceConnectionProperties_STATUS_ARM)

    Value Description

    "JSON"

    ManagedNetworkProvisionStatus

    (Appears on:ManagedNetworkSettings)

    Status of the Provisioning for the managed network of a machine learning workspace.

    Field Description
    sparkReady
    bool
    status
    ManagedNetworkStatus

    Status: Status for the managed network of a machine learning workspace.

    ManagedNetworkProvisionStatus_ARM

    (Appears on:ManagedNetworkSettings_ARM)

    Status of the Provisioning for the managed network of a machine learning workspace.

    Field Description
    sparkReady
    bool
    status
    ManagedNetworkStatus_ARM

    Status: Status for the managed network of a machine learning workspace.

    ManagedNetworkProvisionStatus_STATUS

    (Appears on:ManagedNetworkSettings_STATUS)

    Status of the Provisioning for the managed network of a machine learning workspace.

    Field Description
    sparkReady
    bool
    status
    ManagedNetworkStatus_STATUS

    Status: Status for the managed network of a machine learning workspace.

    ManagedNetworkProvisionStatus_STATUS_ARM

    (Appears on:ManagedNetworkSettings_STATUS_ARM)

    Status of the Provisioning for the managed network of a machine learning workspace.

    Field Description
    sparkReady
    bool
    status
    ManagedNetworkStatus_STATUS_ARM

    Status: Status for the managed network of a machine learning workspace.

    ManagedNetworkSettings

    (Appears on:Workspace_Spec)

    Managed Network settings for a machine learning workspace.

    Field Description
    isolationMode
    IsolationMode

    IsolationMode: Isolation mode for the managed network of a machine learning workspace.

    outboundRules
    map[string]./api/machinelearningservices/v1api20240401.OutboundRule
    status
    ManagedNetworkProvisionStatus

    Status: Status of the Provisioning for the managed network of a machine learning workspace.

    ManagedNetworkSettings_ARM

    (Appears on:WorkspaceProperties_ARM)

    Managed Network settings for a machine learning workspace.

    Field Description
    isolationMode
    IsolationMode_ARM

    IsolationMode: Isolation mode for the managed network of a machine learning workspace.

    outboundRules
    map[string]./api/machinelearningservices/v1api20240401.OutboundRule_ARM
    status
    ManagedNetworkProvisionStatus_ARM

    Status: Status of the Provisioning for the managed network of a machine learning workspace.

    ManagedNetworkSettings_STATUS

    (Appears on:Workspace_STATUS)

    Managed Network settings for a machine learning workspace.

    Field Description
    isolationMode
    IsolationMode_STATUS

    IsolationMode: Isolation mode for the managed network of a machine learning workspace.

    networkId
    string
    outboundRules
    map[string]./api/machinelearningservices/v1api20240401.OutboundRule_STATUS
    status
    ManagedNetworkProvisionStatus_STATUS

    Status: Status of the Provisioning for the managed network of a machine learning workspace.

    ManagedNetworkSettings_STATUS_ARM

    (Appears on:WorkspaceProperties_STATUS_ARM)

    Managed Network settings for a machine learning workspace.

    Field Description
    isolationMode
    IsolationMode_STATUS_ARM

    IsolationMode: Isolation mode for the managed network of a machine learning workspace.

    networkId
    string
    outboundRules
    map[string]./api/machinelearningservices/v1api20240401.OutboundRule_STATUS_ARM
    status
    ManagedNetworkProvisionStatus_STATUS_ARM

    Status: Status of the Provisioning for the managed network of a machine learning workspace.

    ManagedNetworkStatus (string alias)

    (Appears on:ManagedNetworkProvisionStatus)

    Status for the managed network of a machine learning workspace.

    Value Description

    "Active"

    "Inactive"

    ManagedNetworkStatus_ARM (string alias)

    (Appears on:ManagedNetworkProvisionStatus_ARM)

    Status for the managed network of a machine learning workspace.

    Value Description

    "Active"

    "Inactive"

    ManagedNetworkStatus_STATUS (string alias)

    (Appears on:ManagedNetworkProvisionStatus_STATUS)

    Status for the managed network of a machine learning workspace.

    Value Description

    "Active"

    "Inactive"

    ManagedNetworkStatus_STATUS_ARM (string alias)

    (Appears on:ManagedNetworkProvisionStatus_STATUS_ARM)

    Status for the managed network of a machine learning workspace.

    Value Description

    "Active"

    "Inactive"

    ManagedServiceIdentity

    (Appears on:Workspace_Spec, Workspaces_Compute_Spec)

    Managed service identity (system assigned and/or user assigned identities)

    Field Description
    type
    ManagedServiceIdentityType

    Type: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

    userAssignedIdentities
    []UserAssignedIdentityDetails

    ManagedServiceIdentityType (string alias)

    (Appears on:ManagedServiceIdentity)

    Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

    Value Description

    "None"

    "SystemAssigned"

    "SystemAssigned,UserAssigned"

    "UserAssigned"

    ManagedServiceIdentityType_ARM (string alias)

    (Appears on:ManagedServiceIdentity_ARM)

    Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

    Value Description

    "None"

    "SystemAssigned"

    "SystemAssigned,UserAssigned"

    "UserAssigned"

    ManagedServiceIdentityType_STATUS (string alias)

    (Appears on:ManagedServiceIdentity_STATUS)

    Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

    Value Description

    "None"

    "SystemAssigned"

    "SystemAssigned,UserAssigned"

    "UserAssigned"

    ManagedServiceIdentityType_STATUS_ARM (string alias)

    (Appears on:ManagedServiceIdentity_STATUS_ARM)

    Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

    Value Description

    "None"

    "SystemAssigned"

    "SystemAssigned,UserAssigned"

    "UserAssigned"

    ManagedServiceIdentity_ARM

    (Appears on:Workspace_Spec_ARM, Workspaces_Compute_Spec_ARM)

    Managed service identity (system assigned and/or user assigned identities)

    Field Description
    type
    ManagedServiceIdentityType_ARM

    Type: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

    userAssignedIdentities
    map[string]./api/machinelearningservices/v1api20240401.UserAssignedIdentityDetails_ARM

    ManagedServiceIdentity_STATUS

    (Appears on:Workspace_STATUS, Workspaces_Compute_STATUS)

    Managed service identity (system assigned and/or user assigned identities)

    Field Description
    principalId
    string

    PrincipalId: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.

    tenantId
    string

    TenantId: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.

    type
    ManagedServiceIdentityType_STATUS

    Type: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

    userAssignedIdentities
    map[string]./api/machinelearningservices/v1api20240401.UserAssignedIdentity_STATUS

    ManagedServiceIdentity_STATUS_ARM

    (Appears on:Workspace_STATUS_ARM, Workspaces_Compute_STATUS_ARM)

    Managed service identity (system assigned and/or user assigned identities)

    Field Description
    principalId
    string

    PrincipalId: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.

    tenantId
    string

    TenantId: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.

    type
    ManagedServiceIdentityType_STATUS_ARM

    Type: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

    userAssignedIdentities
    map[string]./api/machinelearningservices/v1api20240401.UserAssignedIdentity_STATUS_ARM

    NodeStateCounts_STATUS

    (Appears on:AmlComputeProperties_STATUS)

    Counts of various compute node states on the amlCompute.

    Field Description
    idleNodeCount
    int

    IdleNodeCount: Number of compute nodes in idle state.

    leavingNodeCount
    int

    LeavingNodeCount: Number of compute nodes which are leaving the amlCompute.

    preemptedNodeCount
    int

    PreemptedNodeCount: Number of compute nodes which are in preempted state.

    preparingNodeCount
    int

    PreparingNodeCount: Number of compute nodes which are being prepared.

    runningNodeCount
    int

    RunningNodeCount: Number of compute nodes which are running jobs.

    unusableNodeCount
    int

    UnusableNodeCount: Number of compute nodes which are in unusable state.

    NodeStateCounts_STATUS_ARM

    (Appears on:AmlComputeProperties_STATUS_ARM)

    Counts of various compute node states on the amlCompute.

    Field Description
    idleNodeCount
    int

    IdleNodeCount: Number of compute nodes in idle state.

    leavingNodeCount
    int

    LeavingNodeCount: Number of compute nodes which are leaving the amlCompute.

    preemptedNodeCount
    int

    PreemptedNodeCount: Number of compute nodes which are in preempted state.

    preparingNodeCount
    int

    PreparingNodeCount: Number of compute nodes which are being prepared.

    runningNodeCount
    int

    RunningNodeCount: Number of compute nodes which are running jobs.

    unusableNodeCount
    int

    UnusableNodeCount: Number of compute nodes which are in unusable state.

    NoneAuthTypeWorkspaceConnectionProperties

    (Appears on:WorkspaceConnectionPropertiesV2)

    Field Description
    authType
    NoneAuthTypeWorkspaceConnectionProperties_AuthType

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory

    Category: Category of the connection

    expiryTime
    string
    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    NoneAuthTypeWorkspaceConnectionProperties_ValueFormat

    ValueFormat: format for the workspace connection value

    NoneAuthTypeWorkspaceConnectionProperties_ARM

    (Appears on:WorkspaceConnectionPropertiesV2_ARM)

    Field Description
    authType
    NoneAuthTypeWorkspaceConnectionProperties_AuthType_ARM

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory_ARM

    Category: Category of the connection

    expiryTime
    string
    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    NoneAuthTypeWorkspaceConnectionProperties_ValueFormat_ARM

    ValueFormat: format for the workspace connection value

    NoneAuthTypeWorkspaceConnectionProperties_AuthType (string alias)

    (Appears on:NoneAuthTypeWorkspaceConnectionProperties)

    Value Description

    "None"

    NoneAuthTypeWorkspaceConnectionProperties_AuthType_ARM (string alias)

    (Appears on:NoneAuthTypeWorkspaceConnectionProperties_ARM)

    Value Description

    "None"

    NoneAuthTypeWorkspaceConnectionProperties_AuthType_STATUS (string alias)

    (Appears on:NoneAuthTypeWorkspaceConnectionProperties_STATUS)

    Value Description

    "None"

    NoneAuthTypeWorkspaceConnectionProperties_AuthType_STATUS_ARM (string alias)

    (Appears on:NoneAuthTypeWorkspaceConnectionProperties_STATUS_ARM)

    Value Description

    "None"

    NoneAuthTypeWorkspaceConnectionProperties_STATUS

    (Appears on:WorkspaceConnectionPropertiesV2_STATUS)

    Field Description
    authType
    NoneAuthTypeWorkspaceConnectionProperties_AuthType_STATUS

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory_STATUS

    Category: Category of the connection

    createdByWorkspaceArmId
    string
    expiryTime
    string
    group
    ConnectionGroup_STATUS

    Group: Group based on connection category

    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    NoneAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS

    ValueFormat: format for the workspace connection value

    NoneAuthTypeWorkspaceConnectionProperties_STATUS_ARM

    (Appears on:WorkspaceConnectionPropertiesV2_STATUS_ARM)

    Field Description
    authType
    NoneAuthTypeWorkspaceConnectionProperties_AuthType_STATUS_ARM

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory_STATUS_ARM

    Category: Category of the connection

    createdByWorkspaceArmId
    string
    expiryTime
    string
    group
    ConnectionGroup_STATUS_ARM

    Group: Group based on connection category

    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    NoneAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS_ARM

    ValueFormat: format for the workspace connection value

    NoneAuthTypeWorkspaceConnectionProperties_ValueFormat (string alias)

    (Appears on:NoneAuthTypeWorkspaceConnectionProperties)

    Value Description

    "JSON"

    NoneAuthTypeWorkspaceConnectionProperties_ValueFormat_ARM (string alias)

    (Appears on:NoneAuthTypeWorkspaceConnectionProperties_ARM)

    Value Description

    "JSON"

    NoneAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS (string alias)

    (Appears on:NoneAuthTypeWorkspaceConnectionProperties_STATUS)

    Value Description

    "JSON"

    NoneAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS_ARM (string alias)

    (Appears on:NoneAuthTypeWorkspaceConnectionProperties_STATUS_ARM)

    Value Description

    "JSON"

    NotebookPreparationError_STATUS

    (Appears on:NotebookResourceInfo_STATUS)

    Field Description
    errorMessage
    string
    statusCode
    int

    NotebookPreparationError_STATUS_ARM

    (Appears on:NotebookResourceInfo_STATUS_ARM)

    Field Description
    errorMessage
    string
    statusCode
    int

    NotebookResourceInfo_STATUS

    (Appears on:Workspace_STATUS)

    Field Description
    fqdn
    string
    notebookPreparationError
    NotebookPreparationError_STATUS

    NotebookPreparationError: The error that occurs when preparing notebook.

    resourceId
    string

    ResourceId: the data plane resourceId that used to initialize notebook component

    NotebookResourceInfo_STATUS_ARM

    (Appears on:WorkspaceProperties_STATUS_ARM)

    Field Description
    fqdn
    string
    notebookPreparationError
    NotebookPreparationError_STATUS_ARM

    NotebookPreparationError: The error that occurs when preparing notebook.

    resourceId
    string

    ResourceId: the data plane resourceId that used to initialize notebook component

    OAuth2AuthTypeWorkspaceConnectionProperties

    (Appears on:WorkspaceConnectionPropertiesV2)

    Field Description
    authType
    OAuth2AuthTypeWorkspaceConnectionProperties_AuthType

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory

    Category: Category of the connection

    credentials
    WorkspaceConnectionOAuth2

    Credentials: ClientId and ClientSecret are required. Other properties are optional depending on each OAuth2 provider’s implementation.

    expiryTime
    string
    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    OAuth2AuthTypeWorkspaceConnectionProperties_ValueFormat

    ValueFormat: format for the workspace connection value

    OAuth2AuthTypeWorkspaceConnectionProperties_ARM

    (Appears on:WorkspaceConnectionPropertiesV2_ARM)

    Field Description
    authType
    OAuth2AuthTypeWorkspaceConnectionProperties_AuthType_ARM

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory_ARM

    Category: Category of the connection

    credentials
    WorkspaceConnectionOAuth2_ARM

    Credentials: ClientId and ClientSecret are required. Other properties are optional depending on each OAuth2 provider’s implementation.

    expiryTime
    string
    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    OAuth2AuthTypeWorkspaceConnectionProperties_ValueFormat_ARM

    ValueFormat: format for the workspace connection value

    OAuth2AuthTypeWorkspaceConnectionProperties_AuthType (string alias)

    (Appears on:OAuth2AuthTypeWorkspaceConnectionProperties)

    Value Description

    "OAuth2"

    OAuth2AuthTypeWorkspaceConnectionProperties_AuthType_ARM (string alias)

    (Appears on:OAuth2AuthTypeWorkspaceConnectionProperties_ARM)

    Value Description

    "OAuth2"

    OAuth2AuthTypeWorkspaceConnectionProperties_AuthType_STATUS (string alias)

    (Appears on:OAuth2AuthTypeWorkspaceConnectionProperties_STATUS)

    Value Description

    "OAuth2"

    OAuth2AuthTypeWorkspaceConnectionProperties_AuthType_STATUS_ARM (string alias)

    (Appears on:OAuth2AuthTypeWorkspaceConnectionProperties_STATUS_ARM)

    Value Description

    "OAuth2"

    OAuth2AuthTypeWorkspaceConnectionProperties_STATUS

    (Appears on:WorkspaceConnectionPropertiesV2_STATUS)

    Field Description
    authType
    OAuth2AuthTypeWorkspaceConnectionProperties_AuthType_STATUS

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory_STATUS

    Category: Category of the connection

    createdByWorkspaceArmId
    string
    credentials
    WorkspaceConnectionOAuth2_STATUS

    Credentials: ClientId and ClientSecret are required. Other properties are optional depending on each OAuth2 provider’s implementation.

    expiryTime
    string
    group
    ConnectionGroup_STATUS

    Group: Group based on connection category

    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    OAuth2AuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS

    ValueFormat: format for the workspace connection value

    OAuth2AuthTypeWorkspaceConnectionProperties_STATUS_ARM

    (Appears on:WorkspaceConnectionPropertiesV2_STATUS_ARM)

    Field Description
    authType
    OAuth2AuthTypeWorkspaceConnectionProperties_AuthType_STATUS_ARM

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory_STATUS_ARM

    Category: Category of the connection

    createdByWorkspaceArmId
    string
    credentials
    WorkspaceConnectionOAuth2_STATUS_ARM

    Credentials: ClientId and ClientSecret are required. Other properties are optional depending on each OAuth2 provider’s implementation.

    expiryTime
    string
    group
    ConnectionGroup_STATUS_ARM

    Group: Group based on connection category

    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    OAuth2AuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS_ARM

    ValueFormat: format for the workspace connection value

    OAuth2AuthTypeWorkspaceConnectionProperties_ValueFormat (string alias)

    (Appears on:OAuth2AuthTypeWorkspaceConnectionProperties)

    Value Description

    "JSON"

    OAuth2AuthTypeWorkspaceConnectionProperties_ValueFormat_ARM (string alias)

    (Appears on:OAuth2AuthTypeWorkspaceConnectionProperties_ARM)

    Value Description

    "JSON"

    OAuth2AuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS (string alias)

    (Appears on:OAuth2AuthTypeWorkspaceConnectionProperties_STATUS)

    Value Description

    "JSON"

    OAuth2AuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS_ARM (string alias)

    (Appears on:OAuth2AuthTypeWorkspaceConnectionProperties_STATUS_ARM)

    Value Description

    "JSON"

    OutboundRule

    (Appears on:ManagedNetworkSettings)

    Field Description
    fqdn
    FqdnOutboundRule

    FQDN: Mutually exclusive with all other properties

    privateEndpoint
    PrivateEndpointOutboundRule

    PrivateEndpoint: Mutually exclusive with all other properties

    serviceTag
    ServiceTagOutboundRule

    ServiceTag: Mutually exclusive with all other properties

    OutboundRule_ARM

    (Appears on:ManagedNetworkSettings_ARM)

    Field Description
    fqdn
    FqdnOutboundRule_ARM

    FQDN: Mutually exclusive with all other properties

    privateEndpoint
    PrivateEndpointOutboundRule_ARM

    PrivateEndpoint: Mutually exclusive with all other properties

    serviceTag
    ServiceTagOutboundRule_ARM

    ServiceTag: Mutually exclusive with all other properties

    OutboundRule_STATUS

    (Appears on:ManagedNetworkSettings_STATUS)

    Field Description
    fqdn
    FqdnOutboundRule_STATUS

    FQDN: Mutually exclusive with all other properties

    privateEndpoint
    PrivateEndpointOutboundRule_STATUS

    PrivateEndpoint: Mutually exclusive with all other properties

    serviceTag
    ServiceTagOutboundRule_STATUS

    ServiceTag: Mutually exclusive with all other properties

    OutboundRule_STATUS_ARM

    (Appears on:ManagedNetworkSettings_STATUS_ARM)

    Field Description
    fqdn
    FqdnOutboundRule_STATUS_ARM

    FQDN: Mutually exclusive with all other properties

    privateEndpoint
    PrivateEndpointOutboundRule_STATUS_ARM

    PrivateEndpoint: Mutually exclusive with all other properties

    serviceTag
    ServiceTagOutboundRule_STATUS_ARM

    ServiceTag: Mutually exclusive with all other properties

    PATAuthTypeWorkspaceConnectionProperties

    (Appears on:WorkspaceConnectionPropertiesV2)

    Field Description
    authType
    PATAuthTypeWorkspaceConnectionProperties_AuthType

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory

    Category: Category of the connection

    credentials
    WorkspaceConnectionPersonalAccessToken
    expiryTime
    string
    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    PATAuthTypeWorkspaceConnectionProperties_ValueFormat

    ValueFormat: format for the workspace connection value

    PATAuthTypeWorkspaceConnectionProperties_ARM

    (Appears on:WorkspaceConnectionPropertiesV2_ARM)

    Field Description
    authType
    PATAuthTypeWorkspaceConnectionProperties_AuthType_ARM

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory_ARM

    Category: Category of the connection

    credentials
    WorkspaceConnectionPersonalAccessToken_ARM
    expiryTime
    string
    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    PATAuthTypeWorkspaceConnectionProperties_ValueFormat_ARM

    ValueFormat: format for the workspace connection value

    PATAuthTypeWorkspaceConnectionProperties_AuthType (string alias)

    (Appears on:PATAuthTypeWorkspaceConnectionProperties)

    Value Description

    "PAT"

    PATAuthTypeWorkspaceConnectionProperties_AuthType_ARM (string alias)

    (Appears on:PATAuthTypeWorkspaceConnectionProperties_ARM)

    Value Description

    "PAT"

    PATAuthTypeWorkspaceConnectionProperties_AuthType_STATUS (string alias)

    (Appears on:PATAuthTypeWorkspaceConnectionProperties_STATUS)

    Value Description

    "PAT"

    PATAuthTypeWorkspaceConnectionProperties_AuthType_STATUS_ARM (string alias)

    (Appears on:PATAuthTypeWorkspaceConnectionProperties_STATUS_ARM)

    Value Description

    "PAT"

    PATAuthTypeWorkspaceConnectionProperties_STATUS

    (Appears on:WorkspaceConnectionPropertiesV2_STATUS)

    Field Description
    authType
    PATAuthTypeWorkspaceConnectionProperties_AuthType_STATUS

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory_STATUS

    Category: Category of the connection

    createdByWorkspaceArmId
    string
    credentials
    WorkspaceConnectionPersonalAccessToken_STATUS
    expiryTime
    string
    group
    ConnectionGroup_STATUS

    Group: Group based on connection category

    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    PATAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS

    ValueFormat: format for the workspace connection value

    PATAuthTypeWorkspaceConnectionProperties_STATUS_ARM

    (Appears on:WorkspaceConnectionPropertiesV2_STATUS_ARM)

    Field Description
    authType
    PATAuthTypeWorkspaceConnectionProperties_AuthType_STATUS_ARM

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory_STATUS_ARM

    Category: Category of the connection

    createdByWorkspaceArmId
    string
    credentials
    WorkspaceConnectionPersonalAccessToken_STATUS_ARM
    expiryTime
    string
    group
    ConnectionGroup_STATUS_ARM

    Group: Group based on connection category

    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    PATAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS_ARM

    ValueFormat: format for the workspace connection value

    PATAuthTypeWorkspaceConnectionProperties_ValueFormat (string alias)

    (Appears on:PATAuthTypeWorkspaceConnectionProperties)

    Value Description

    "JSON"

    PATAuthTypeWorkspaceConnectionProperties_ValueFormat_ARM (string alias)

    (Appears on:PATAuthTypeWorkspaceConnectionProperties_ARM)

    Value Description

    "JSON"

    PATAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS (string alias)

    (Appears on:PATAuthTypeWorkspaceConnectionProperties_STATUS)

    Value Description

    "JSON"

    PATAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS_ARM (string alias)

    (Appears on:PATAuthTypeWorkspaceConnectionProperties_STATUS_ARM)

    Value Description

    "JSON"

    PersonalComputeInstanceSettings

    (Appears on:ComputeInstanceProperties)

    Settings for a personal compute instance.

    Field Description
    assignedUser
    AssignedUser

    AssignedUser: A user explicitly assigned to a personal compute instance.

    PersonalComputeInstanceSettings_ARM

    (Appears on:ComputeInstanceProperties_ARM)

    Settings for a personal compute instance.

    Field Description
    assignedUser
    AssignedUser_ARM

    AssignedUser: A user explicitly assigned to a personal compute instance.

    PersonalComputeInstanceSettings_STATUS

    (Appears on:ComputeInstanceProperties_STATUS)

    Settings for a personal compute instance.

    Field Description
    assignedUser
    AssignedUser_STATUS

    AssignedUser: A user explicitly assigned to a personal compute instance.

    PersonalComputeInstanceSettings_STATUS_ARM

    (Appears on:ComputeInstanceProperties_STATUS_ARM)

    Settings for a personal compute instance.

    Field Description
    assignedUser
    AssignedUser_STATUS_ARM

    AssignedUser: A user explicitly assigned to a personal compute instance.

    PrivateEndpointConnection_STATUS

    (Appears on:Workspace_STATUS)

    The Private Endpoint Connection resource.

    Field Description
    id
    string

    Id: Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}

    PrivateEndpointConnection_STATUS_ARM

    (Appears on:WorkspaceProperties_STATUS_ARM)

    The Private Endpoint Connection resource.

    Field Description
    id
    string

    Id: Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}

    PrivateEndpointDestination

    (Appears on:PrivateEndpointOutboundRule)

    Private Endpoint destination for a Private Endpoint Outbound Rule for the managed network of a machine learning workspace.

    Field Description
    serviceResourceReference
    genruntime.ResourceReference
    sparkEnabled
    bool
    sparkStatus
    RuleStatus

    SparkStatus: Type of a managed network Outbound Rule of a machine learning workspace.

    subresourceTargetReference
    genruntime.ResourceReference

    PrivateEndpointDestination_ARM

    (Appears on:PrivateEndpointOutboundRule_ARM)

    Private Endpoint destination for a Private Endpoint Outbound Rule for the managed network of a machine learning workspace.

    Field Description
    serviceResourceId
    string
    sparkEnabled
    bool
    sparkStatus
    RuleStatus_ARM

    SparkStatus: Type of a managed network Outbound Rule of a machine learning workspace.

    subresourceTarget
    string

    PrivateEndpointDestination_STATUS

    (Appears on:PrivateEndpointOutboundRule_STATUS)

    Private Endpoint destination for a Private Endpoint Outbound Rule for the managed network of a machine learning workspace.

    Field Description
    serviceResourceId
    string
    sparkEnabled
    bool
    sparkStatus
    RuleStatus_STATUS

    SparkStatus: Type of a managed network Outbound Rule of a machine learning workspace.

    subresourceTarget
    string

    PrivateEndpointDestination_STATUS_ARM

    (Appears on:PrivateEndpointOutboundRule_STATUS_ARM)

    Private Endpoint destination for a Private Endpoint Outbound Rule for the managed network of a machine learning workspace.

    Field Description
    serviceResourceId
    string
    sparkEnabled
    bool
    sparkStatus
    RuleStatus_STATUS_ARM

    SparkStatus: Type of a managed network Outbound Rule of a machine learning workspace.

    subresourceTarget
    string

    PrivateEndpointOutboundRule

    (Appears on:OutboundRule)

    Field Description
    category
    RuleCategory

    Category: Category of a managed network Outbound Rule of a machine learning workspace.

    destination
    PrivateEndpointDestination

    Destination: Private Endpoint destination for a Private Endpoint Outbound Rule for the managed network of a machine learning workspace.

    status
    RuleStatus

    Status: Type of a managed network Outbound Rule of a machine learning workspace.

    type
    PrivateEndpointOutboundRule_Type

    PrivateEndpointOutboundRule_ARM

    (Appears on:OutboundRule_ARM)

    Field Description
    category
    RuleCategory_ARM

    Category: Category of a managed network Outbound Rule of a machine learning workspace.

    destination
    PrivateEndpointDestination_ARM

    Destination: Private Endpoint destination for a Private Endpoint Outbound Rule for the managed network of a machine learning workspace.

    status
    RuleStatus_ARM

    Status: Type of a managed network Outbound Rule of a machine learning workspace.

    type
    PrivateEndpointOutboundRule_Type_ARM

    PrivateEndpointOutboundRule_STATUS

    (Appears on:OutboundRule_STATUS)

    Field Description
    category
    RuleCategory_STATUS

    Category: Category of a managed network Outbound Rule of a machine learning workspace.

    destination
    PrivateEndpointDestination_STATUS

    Destination: Private Endpoint destination for a Private Endpoint Outbound Rule for the managed network of a machine learning workspace.

    status
    RuleStatus_STATUS

    Status: Type of a managed network Outbound Rule of a machine learning workspace.

    type
    PrivateEndpointOutboundRule_Type_STATUS

    PrivateEndpointOutboundRule_STATUS_ARM

    (Appears on:OutboundRule_STATUS_ARM)

    Field Description
    category
    RuleCategory_STATUS_ARM

    Category: Category of a managed network Outbound Rule of a machine learning workspace.

    destination
    PrivateEndpointDestination_STATUS_ARM

    Destination: Private Endpoint destination for a Private Endpoint Outbound Rule for the managed network of a machine learning workspace.

    status
    RuleStatus_STATUS_ARM

    Status: Type of a managed network Outbound Rule of a machine learning workspace.

    type
    PrivateEndpointOutboundRule_Type_STATUS_ARM

    PrivateEndpointOutboundRule_Type (string alias)

    (Appears on:PrivateEndpointOutboundRule)

    Value Description

    "PrivateEndpoint"

    PrivateEndpointOutboundRule_Type_ARM (string alias)

    (Appears on:PrivateEndpointOutboundRule_ARM)

    Value Description

    "PrivateEndpoint"

    PrivateEndpointOutboundRule_Type_STATUS (string alias)

    (Appears on:PrivateEndpointOutboundRule_STATUS)

    Value Description

    "PrivateEndpoint"

    PrivateEndpointOutboundRule_Type_STATUS_ARM (string alias)

    (Appears on:PrivateEndpointOutboundRule_STATUS_ARM)

    Value Description

    "PrivateEndpoint"

    PrivateEndpointServiceConnectionStatus (string alias)

    (Appears on:SharedPrivateLinkResource)

    The private endpoint connection status.

    Value Description

    "Approved"

    "Disconnected"

    "Pending"

    "Rejected"

    "Timeout"

    PrivateEndpointServiceConnectionStatus_ARM (string alias)

    (Appears on:SharedPrivateLinkResourceProperty_ARM)

    The private endpoint connection status.

    Value Description

    "Approved"

    "Disconnected"

    "Pending"

    "Rejected"

    "Timeout"

    PrivateEndpointServiceConnectionStatus_STATUS (string alias)

    (Appears on:SharedPrivateLinkResource_STATUS)

    The private endpoint connection status.

    Value Description

    "Approved"

    "Disconnected"

    "Pending"

    "Rejected"

    "Timeout"

    PrivateEndpointServiceConnectionStatus_STATUS_ARM (string alias)

    (Appears on:SharedPrivateLinkResourceProperty_STATUS_ARM)

    The private endpoint connection status.

    Value Description

    "Approved"

    "Disconnected"

    "Pending"

    "Rejected"

    "Timeout"

    Recurrence

    (Appears on:ComputeStartStopSchedule)

    The workflow trigger recurrence for ComputeStartStop schedule type.

    Field Description
    frequency
    ComputeRecurrenceFrequency

    Frequency: [Required] The frequency to trigger schedule.

    interval
    int

    Interval: [Required] Specifies schedule interval in conjunction with frequency

    schedule
    ComputeRecurrenceSchedule

    Schedule: [Required] The recurrence schedule.

    startTime
    string

    StartTime: The start time in yyyy-MM-ddTHH:mm:ss format.

    timeZone
    string

    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

    Recurrence_ARM

    (Appears on:ComputeStartStopSchedule_ARM)

    The workflow trigger recurrence for ComputeStartStop schedule type.

    Field Description
    frequency
    ComputeRecurrenceFrequency_ARM

    Frequency: [Required] The frequency to trigger schedule.

    interval
    int

    Interval: [Required] Specifies schedule interval in conjunction with frequency

    schedule
    ComputeRecurrenceSchedule_ARM

    Schedule: [Required] The recurrence schedule.

    startTime
    string

    StartTime: The start time in yyyy-MM-ddTHH:mm:ss format.

    timeZone
    string

    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

    Recurrence_STATUS

    (Appears on:ComputeStartStopSchedule_STATUS)

    The workflow trigger recurrence for ComputeStartStop schedule type.

    Field Description
    frequency
    ComputeRecurrenceFrequency_STATUS

    Frequency: [Required] The frequency to trigger schedule.

    interval
    int

    Interval: [Required] Specifies schedule interval in conjunction with frequency

    schedule
    ComputeRecurrenceSchedule_STATUS

    Schedule: [Required] The recurrence schedule.

    startTime
    string

    StartTime: The start time in yyyy-MM-ddTHH:mm:ss format.

    timeZone
    string

    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

    Recurrence_STATUS_ARM

    (Appears on:ComputeStartStopSchedule_STATUS_ARM)

    The workflow trigger recurrence for ComputeStartStop schedule type.

    Field Description
    frequency
    ComputeRecurrenceFrequency_STATUS_ARM

    Frequency: [Required] The frequency to trigger schedule.

    interval
    int

    Interval: [Required] Specifies schedule interval in conjunction with frequency

    schedule
    ComputeRecurrenceSchedule_STATUS_ARM

    Schedule: [Required] The recurrence schedule.

    startTime
    string

    StartTime: The start time in yyyy-MM-ddTHH:mm:ss format.

    timeZone
    string

    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

    ResourceId

    (Appears on:AmlComputeProperties, ComputeInstanceProperties)

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

    Field Description
    reference
    genruntime.ResourceReference

    Reference: The ID of the resource

    ResourceId_ARM

    (Appears on:AmlComputeProperties_ARM, ComputeInstanceProperties_ARM)

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

    Field Description
    id
    string

    ResourceId_STATUS

    (Appears on:AmlComputeProperties_STATUS, ComputeInstanceProperties_STATUS)

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

    Field Description
    id
    string

    Id: The ID of the resource

    ResourceId_STATUS_ARM

    (Appears on:AmlComputeProperties_STATUS_ARM, ComputeInstanceProperties_STATUS_ARM)

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

    Field Description
    id
    string

    Id: The ID of the resource

    RuleAction (string alias)

    (Appears on:ServiceTagDestination)

    The action enum for networking rule.

    Value Description

    "Allow"

    "Deny"

    RuleAction_ARM (string alias)

    (Appears on:ServiceTagDestination_ARM)

    The action enum for networking rule.

    Value Description

    "Allow"

    "Deny"

    RuleAction_STATUS (string alias)

    (Appears on:ServiceTagDestination_STATUS)

    The action enum for networking rule.

    Value Description

    "Allow"

    "Deny"

    RuleAction_STATUS_ARM (string alias)

    (Appears on:ServiceTagDestination_STATUS_ARM)

    The action enum for networking rule.

    Value Description

    "Allow"

    "Deny"

    RuleCategory (string alias)

    (Appears on:FqdnOutboundRule, PrivateEndpointOutboundRule, ServiceTagOutboundRule)

    Category of a managed network Outbound Rule of a machine learning workspace.

    Value Description

    "Dependency"

    "Recommended"

    "Required"

    "UserDefined"

    RuleCategory_ARM (string alias)

    (Appears on:FqdnOutboundRule_ARM, PrivateEndpointOutboundRule_ARM, ServiceTagOutboundRule_ARM)

    Category of a managed network Outbound Rule of a machine learning workspace.

    Value Description

    "Dependency"

    "Recommended"

    "Required"

    "UserDefined"

    RuleCategory_STATUS (string alias)

    (Appears on:FqdnOutboundRule_STATUS, PrivateEndpointOutboundRule_STATUS, ServiceTagOutboundRule_STATUS)

    Category of a managed network Outbound Rule of a machine learning workspace.

    Value Description

    "Dependency"

    "Recommended"

    "Required"

    "UserDefined"

    RuleCategory_STATUS_ARM (string alias)

    (Appears on:FqdnOutboundRule_STATUS_ARM, PrivateEndpointOutboundRule_STATUS_ARM, ServiceTagOutboundRule_STATUS_ARM)

    Category of a managed network Outbound Rule of a machine learning workspace.

    Value Description

    "Dependency"

    "Recommended"

    "Required"

    "UserDefined"

    RuleStatus (string alias)

    (Appears on:FqdnOutboundRule, PrivateEndpointDestination, PrivateEndpointOutboundRule, ServiceTagOutboundRule)

    Type of a managed network Outbound Rule of a machine learning workspace.

    Value Description

    "Active"

    "Inactive"

    RuleStatus_ARM (string alias)

    (Appears on:FqdnOutboundRule_ARM, PrivateEndpointDestination_ARM, PrivateEndpointOutboundRule_ARM, ServiceTagOutboundRule_ARM)

    Type of a managed network Outbound Rule of a machine learning workspace.

    Value Description

    "Active"

    "Inactive"

    RuleStatus_STATUS (string alias)

    (Appears on:FqdnOutboundRule_STATUS, PrivateEndpointDestination_STATUS, PrivateEndpointOutboundRule_STATUS, ServiceTagOutboundRule_STATUS)

    Type of a managed network Outbound Rule of a machine learning workspace.

    Value Description

    "Active"

    "Inactive"

    RuleStatus_STATUS_ARM (string alias)

    (Appears on:FqdnOutboundRule_STATUS_ARM, PrivateEndpointDestination_STATUS_ARM, PrivateEndpointOutboundRule_STATUS_ARM, ServiceTagOutboundRule_STATUS_ARM)

    Type of a managed network Outbound Rule of a machine learning workspace.

    Value Description

    "Active"

    "Inactive"

    SASAuthTypeWorkspaceConnectionProperties

    (Appears on:WorkspaceConnectionPropertiesV2)

    Field Description
    authType
    SASAuthTypeWorkspaceConnectionProperties_AuthType

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory

    Category: Category of the connection

    credentials
    WorkspaceConnectionSharedAccessSignature
    expiryTime
    string
    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    SASAuthTypeWorkspaceConnectionProperties_ValueFormat

    ValueFormat: format for the workspace connection value

    SASAuthTypeWorkspaceConnectionProperties_ARM

    (Appears on:WorkspaceConnectionPropertiesV2_ARM)

    Field Description
    authType
    SASAuthTypeWorkspaceConnectionProperties_AuthType_ARM

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory_ARM

    Category: Category of the connection

    credentials
    WorkspaceConnectionSharedAccessSignature_ARM
    expiryTime
    string
    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    SASAuthTypeWorkspaceConnectionProperties_ValueFormat_ARM

    ValueFormat: format for the workspace connection value

    SASAuthTypeWorkspaceConnectionProperties_AuthType (string alias)

    (Appears on:SASAuthTypeWorkspaceConnectionProperties)

    Value Description

    "SAS"

    SASAuthTypeWorkspaceConnectionProperties_AuthType_ARM (string alias)

    (Appears on:SASAuthTypeWorkspaceConnectionProperties_ARM)

    Value Description

    "SAS"

    SASAuthTypeWorkspaceConnectionProperties_AuthType_STATUS (string alias)

    (Appears on:SASAuthTypeWorkspaceConnectionProperties_STATUS)

    Value Description

    "SAS"

    SASAuthTypeWorkspaceConnectionProperties_AuthType_STATUS_ARM (string alias)

    (Appears on:SASAuthTypeWorkspaceConnectionProperties_STATUS_ARM)

    Value Description

    "SAS"

    SASAuthTypeWorkspaceConnectionProperties_STATUS

    (Appears on:WorkspaceConnectionPropertiesV2_STATUS)

    Field Description
    authType
    SASAuthTypeWorkspaceConnectionProperties_AuthType_STATUS

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory_STATUS

    Category: Category of the connection

    createdByWorkspaceArmId
    string
    credentials
    WorkspaceConnectionSharedAccessSignature_STATUS
    expiryTime
    string
    group
    ConnectionGroup_STATUS

    Group: Group based on connection category

    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    SASAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS

    ValueFormat: format for the workspace connection value

    SASAuthTypeWorkspaceConnectionProperties_STATUS_ARM

    (Appears on:WorkspaceConnectionPropertiesV2_STATUS_ARM)

    Field Description
    authType
    SASAuthTypeWorkspaceConnectionProperties_AuthType_STATUS_ARM

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory_STATUS_ARM

    Category: Category of the connection

    createdByWorkspaceArmId
    string
    credentials
    WorkspaceConnectionSharedAccessSignature_STATUS_ARM
    expiryTime
    string
    group
    ConnectionGroup_STATUS_ARM

    Group: Group based on connection category

    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    SASAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS_ARM

    ValueFormat: format for the workspace connection value

    SASAuthTypeWorkspaceConnectionProperties_ValueFormat (string alias)

    (Appears on:SASAuthTypeWorkspaceConnectionProperties)

    Value Description

    "JSON"

    SASAuthTypeWorkspaceConnectionProperties_ValueFormat_ARM (string alias)

    (Appears on:SASAuthTypeWorkspaceConnectionProperties_ARM)

    Value Description

    "JSON"

    SASAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS (string alias)

    (Appears on:SASAuthTypeWorkspaceConnectionProperties_STATUS)

    Value Description

    "JSON"

    SASAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS_ARM (string alias)

    (Appears on:SASAuthTypeWorkspaceConnectionProperties_STATUS_ARM)

    Value Description

    "JSON"

    ScaleSettings

    (Appears on:AmlComputeProperties)

    scale settings for AML Compute

    Field Description
    maxNodeCount
    int

    MaxNodeCount: Max number of nodes to use

    minNodeCount
    int

    MinNodeCount: Min number of nodes to use

    nodeIdleTimeBeforeScaleDown
    string

    NodeIdleTimeBeforeScaleDown: Node Idle Time before scaling down amlCompute. This string needs to be in the RFC Format.

    ScaleSettings_ARM

    (Appears on:AmlComputeProperties_ARM)

    scale settings for AML Compute

    Field Description
    maxNodeCount
    int

    MaxNodeCount: Max number of nodes to use

    minNodeCount
    int

    MinNodeCount: Min number of nodes to use

    nodeIdleTimeBeforeScaleDown
    string

    NodeIdleTimeBeforeScaleDown: Node Idle Time before scaling down amlCompute. This string needs to be in the RFC Format.

    ScaleSettings_STATUS

    (Appears on:AmlComputeProperties_STATUS)

    scale settings for AML Compute

    Field Description
    maxNodeCount
    int

    MaxNodeCount: Max number of nodes to use

    minNodeCount
    int

    MinNodeCount: Min number of nodes to use

    nodeIdleTimeBeforeScaleDown
    string

    NodeIdleTimeBeforeScaleDown: Node Idle Time before scaling down amlCompute. This string needs to be in the RFC Format.

    ScaleSettings_STATUS_ARM

    (Appears on:AmlComputeProperties_STATUS_ARM)

    scale settings for AML Compute

    Field Description
    maxNodeCount
    int

    MaxNodeCount: Max number of nodes to use

    minNodeCount
    int

    MinNodeCount: Min number of nodes to use

    nodeIdleTimeBeforeScaleDown
    string

    NodeIdleTimeBeforeScaleDown: Node Idle Time before scaling down amlCompute. This string needs to be in the RFC Format.

    ScheduleBase

    (Appears on:ComputeStartStopSchedule)

    Field Description
    provisioningStatus
    ScheduleProvisioningState

    ProvisioningStatus: The current deployment state of schedule.

    reference
    genruntime.ResourceReference

    Reference: A system assigned id for the schedule.

    status
    ScheduleStatus

    Status: Is the schedule enabled or disabled?

    ScheduleBase_ARM

    (Appears on:ComputeStartStopSchedule_ARM)

    Field Description
    id
    string
    provisioningStatus
    ScheduleProvisioningState_ARM

    ProvisioningStatus: The current deployment state of schedule.

    status
    ScheduleStatus_ARM

    Status: Is the schedule enabled or disabled?

    ScheduleBase_STATUS

    (Appears on:ComputeStartStopSchedule_STATUS)

    Field Description
    id
    string

    Id: A system assigned id for the schedule.

    provisioningStatus
    ScheduleProvisioningState_STATUS

    ProvisioningStatus: The current deployment state of schedule.

    status
    ScheduleStatus_STATUS

    Status: Is the schedule enabled or disabled?

    ScheduleBase_STATUS_ARM

    (Appears on:ComputeStartStopSchedule_STATUS_ARM)

    Field Description
    id
    string

    Id: A system assigned id for the schedule.

    provisioningStatus
    ScheduleProvisioningState_STATUS_ARM

    ProvisioningStatus: The current deployment state of schedule.

    status
    ScheduleStatus_STATUS_ARM

    Status: Is the schedule enabled or disabled?

    ScheduleProvisioningState (string alias)

    (Appears on:ScheduleBase)

    The current deployment state of schedule.

    Value Description

    "Completed"

    "Failed"

    "Provisioning"

    ScheduleProvisioningState_ARM (string alias)

    (Appears on:ScheduleBase_ARM)

    The current deployment state of schedule.

    Value Description

    "Completed"

    "Failed"

    "Provisioning"

    ScheduleProvisioningState_STATUS (string alias)

    (Appears on:ScheduleBase_STATUS)

    The current deployment state of schedule.

    Value Description

    "Completed"

    "Failed"

    "Provisioning"

    ScheduleProvisioningState_STATUS_ARM (string alias)

    (Appears on:ScheduleBase_STATUS_ARM)

    The current deployment state of schedule.

    Value Description

    "Completed"

    "Failed"

    "Provisioning"

    ScheduleStatus (string alias)

    (Appears on:ComputeStartStopSchedule, ScheduleBase)

    Is the schedule enabled or disabled?

    Value Description

    "Disabled"

    "Enabled"

    ScheduleStatus_ARM (string alias)

    (Appears on:ComputeStartStopSchedule_ARM, ScheduleBase_ARM)

    Is the schedule enabled or disabled?

    Value Description

    "Disabled"

    "Enabled"

    ScheduleStatus_STATUS (string alias)

    (Appears on:ComputeStartStopSchedule_STATUS, ScheduleBase_STATUS)

    Is the schedule enabled or disabled?

    Value Description

    "Disabled"

    "Enabled"

    ScheduleStatus_STATUS_ARM (string alias)

    (Appears on:ComputeStartStopSchedule_STATUS_ARM, ScheduleBase_STATUS_ARM)

    Is the schedule enabled or disabled?

    Value Description

    "Disabled"

    "Enabled"

    ScriptReference

    (Appears on:ScriptsToExecute)

    Script reference

    Field Description
    scriptArguments
    string

    ScriptArguments: Optional command line arguments passed to the script to run.

    scriptData
    string

    ScriptData: The location of scripts in the mounted volume.

    scriptSource
    string

    ScriptSource: The storage source of the script: workspace.

    timeout
    string

    Timeout: Optional time period passed to timeout command.

    ScriptReference_ARM

    (Appears on:ScriptsToExecute_ARM)

    Script reference

    Field Description
    scriptArguments
    string

    ScriptArguments: Optional command line arguments passed to the script to run.

    scriptData
    string

    ScriptData: The location of scripts in the mounted volume.

    scriptSource
    string

    ScriptSource: The storage source of the script: workspace.

    timeout
    string

    Timeout: Optional time period passed to timeout command.

    ScriptReference_STATUS

    (Appears on:ScriptsToExecute_STATUS)

    Script reference

    Field Description
    scriptArguments
    string

    ScriptArguments: Optional command line arguments passed to the script to run.

    scriptData
    string

    ScriptData: The location of scripts in the mounted volume.

    scriptSource
    string

    ScriptSource: The storage source of the script: workspace.

    timeout
    string

    Timeout: Optional time period passed to timeout command.

    ScriptReference_STATUS_ARM

    (Appears on:ScriptsToExecute_STATUS_ARM)

    Script reference

    Field Description
    scriptArguments
    string

    ScriptArguments: Optional command line arguments passed to the script to run.

    scriptData
    string

    ScriptData: The location of scripts in the mounted volume.

    scriptSource
    string

    ScriptSource: The storage source of the script: workspace.

    timeout
    string

    Timeout: Optional time period passed to timeout command.

    ScriptsToExecute

    (Appears on:SetupScripts)

    Customized setup scripts

    Field Description
    creationScript
    ScriptReference

    CreationScript: Script that’s run only once during provision of the compute.

    startupScript
    ScriptReference

    StartupScript: Script that’s run every time the machine starts.

    ScriptsToExecute_ARM

    (Appears on:SetupScripts_ARM)

    Customized setup scripts

    Field Description
    creationScript
    ScriptReference_ARM

    CreationScript: Script that’s run only once during provision of the compute.

    startupScript
    ScriptReference_ARM

    StartupScript: Script that’s run every time the machine starts.

    ScriptsToExecute_STATUS

    (Appears on:SetupScripts_STATUS)

    Customized setup scripts

    Field Description
    creationScript
    ScriptReference_STATUS

    CreationScript: Script that’s run only once during provision of the compute.

    startupScript
    ScriptReference_STATUS

    StartupScript: Script that’s run every time the machine starts.

    ScriptsToExecute_STATUS_ARM

    (Appears on:SetupScripts_STATUS_ARM)

    Customized setup scripts

    Field Description
    creationScript
    ScriptReference_STATUS_ARM

    CreationScript: Script that’s run only once during provision of the compute.

    startupScript
    ScriptReference_STATUS_ARM

    StartupScript: Script that’s run every time the machine starts.

    ServerlessComputeSettings

    (Appears on:Workspace_Spec)

    Field Description
    serverlessComputeCustomSubnetReference
    genruntime.ResourceReference

    ServerlessComputeCustomSubnetReference: The resource ID of an existing virtual network subnet in which serverless compute nodes should be deployed

    serverlessComputeNoPublicIP
    bool

    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

    ServerlessComputeSettings_ARM

    (Appears on:WorkspaceProperties_ARM)

    Field Description
    serverlessComputeCustomSubnet
    string
    serverlessComputeNoPublicIP
    bool

    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

    ServerlessComputeSettings_STATUS

    (Appears on:Workspace_STATUS)

    Field Description
    serverlessComputeCustomSubnet
    string

    ServerlessComputeCustomSubnet: The resource ID of an existing virtual network subnet in which serverless compute nodes should be deployed

    serverlessComputeNoPublicIP
    bool

    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

    ServerlessComputeSettings_STATUS_ARM

    (Appears on:WorkspaceProperties_STATUS_ARM)

    Field Description
    serverlessComputeCustomSubnet
    string

    ServerlessComputeCustomSubnet: The resource ID of an existing virtual network subnet in which serverless compute nodes should be deployed

    serverlessComputeNoPublicIP
    bool

    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

    ServiceManagedResourcesSettings

    (Appears on:Workspace_Spec)

    Field Description
    cosmosDb
    CosmosDbSettings

    CosmosDb: The settings for the service managed cosmosdb account.

    ServiceManagedResourcesSettings_ARM

    (Appears on:WorkspaceProperties_ARM)

    Field Description
    cosmosDb
    CosmosDbSettings_ARM

    CosmosDb: The settings for the service managed cosmosdb account.

    ServiceManagedResourcesSettings_STATUS

    (Appears on:Workspace_STATUS)

    Field Description
    cosmosDb
    CosmosDbSettings_STATUS

    CosmosDb: The settings for the service managed cosmosdb account.

    ServiceManagedResourcesSettings_STATUS_ARM

    (Appears on:WorkspaceProperties_STATUS_ARM)

    Field Description
    cosmosDb
    CosmosDbSettings_STATUS_ARM

    CosmosDb: The settings for the service managed cosmosdb account.

    ServicePrincipalAuthTypeWorkspaceConnectionProperties

    (Appears on:WorkspaceConnectionPropertiesV2)

    Field Description
    authType
    ServicePrincipalAuthTypeWorkspaceConnectionProperties_AuthType

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory

    Category: Category of the connection

    credentials
    WorkspaceConnectionServicePrincipal
    expiryTime
    string
    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    ServicePrincipalAuthTypeWorkspaceConnectionProperties_ValueFormat

    ValueFormat: format for the workspace connection value

    ServicePrincipalAuthTypeWorkspaceConnectionProperties_ARM

    (Appears on:WorkspaceConnectionPropertiesV2_ARM)

    Field Description
    authType
    ServicePrincipalAuthTypeWorkspaceConnectionProperties_AuthType_ARM

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory_ARM

    Category: Category of the connection

    credentials
    WorkspaceConnectionServicePrincipal_ARM
    expiryTime
    string
    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    ServicePrincipalAuthTypeWorkspaceConnectionProperties_ValueFormat_ARM

    ValueFormat: format for the workspace connection value

    ServicePrincipalAuthTypeWorkspaceConnectionProperties_AuthType (string alias)

    (Appears on:ServicePrincipalAuthTypeWorkspaceConnectionProperties)

    Value Description

    "ServicePrincipal"

    ServicePrincipalAuthTypeWorkspaceConnectionProperties_AuthType_ARM (string alias)

    (Appears on:ServicePrincipalAuthTypeWorkspaceConnectionProperties_ARM)

    Value Description

    "ServicePrincipal"

    ServicePrincipalAuthTypeWorkspaceConnectionProperties_AuthType_STATUS (string alias)

    (Appears on:ServicePrincipalAuthTypeWorkspaceConnectionProperties_STATUS)

    Value Description

    "ServicePrincipal"

    ServicePrincipalAuthTypeWorkspaceConnectionProperties_AuthType_STATUS_ARM (string alias)

    (Appears on:ServicePrincipalAuthTypeWorkspaceConnectionProperties_STATUS_ARM)

    Value Description

    "ServicePrincipal"

    ServicePrincipalAuthTypeWorkspaceConnectionProperties_STATUS

    (Appears on:WorkspaceConnectionPropertiesV2_STATUS)

    Field Description
    authType
    ServicePrincipalAuthTypeWorkspaceConnectionProperties_AuthType_STATUS

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory_STATUS

    Category: Category of the connection

    createdByWorkspaceArmId
    string
    credentials
    WorkspaceConnectionServicePrincipal_STATUS
    expiryTime
    string
    group
    ConnectionGroup_STATUS

    Group: Group based on connection category

    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    ServicePrincipalAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS

    ValueFormat: format for the workspace connection value

    ServicePrincipalAuthTypeWorkspaceConnectionProperties_STATUS_ARM

    (Appears on:WorkspaceConnectionPropertiesV2_STATUS_ARM)

    Field Description
    authType
    ServicePrincipalAuthTypeWorkspaceConnectionProperties_AuthType_STATUS_ARM

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory_STATUS_ARM

    Category: Category of the connection

    createdByWorkspaceArmId
    string
    credentials
    WorkspaceConnectionServicePrincipal_STATUS_ARM
    expiryTime
    string
    group
    ConnectionGroup_STATUS_ARM

    Group: Group based on connection category

    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    ServicePrincipalAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS_ARM

    ValueFormat: format for the workspace connection value

    ServicePrincipalAuthTypeWorkspaceConnectionProperties_ValueFormat (string alias)

    (Appears on:ServicePrincipalAuthTypeWorkspaceConnectionProperties)

    Value Description

    "JSON"

    ServicePrincipalAuthTypeWorkspaceConnectionProperties_ValueFormat_ARM (string alias)

    (Appears on:ServicePrincipalAuthTypeWorkspaceConnectionProperties_ARM)

    Value Description

    "JSON"

    ServicePrincipalAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS (string alias)

    (Appears on:ServicePrincipalAuthTypeWorkspaceConnectionProperties_STATUS)

    Value Description

    "JSON"

    ServicePrincipalAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS_ARM (string alias)

    (Appears on:ServicePrincipalAuthTypeWorkspaceConnectionProperties_STATUS_ARM)

    Value Description

    "JSON"

    ServiceTagDestination

    (Appears on:ServiceTagOutboundRule)

    Service Tag destination for a Service Tag Outbound Rule for the managed network of a machine learning workspace.

    Field Description
    action
    RuleAction

    Action: The action enum for networking rule.

    portRanges
    string
    protocol
    string
    serviceTag
    string

    ServiceTagDestination_ARM

    (Appears on:ServiceTagOutboundRule_ARM)

    Service Tag destination for a Service Tag Outbound Rule for the managed network of a machine learning workspace.

    Field Description
    action
    RuleAction_ARM

    Action: The action enum for networking rule.

    portRanges
    string
    protocol
    string
    serviceTag
    string

    ServiceTagDestination_STATUS

    (Appears on:ServiceTagOutboundRule_STATUS)

    Service Tag destination for a Service Tag Outbound Rule for the managed network of a machine learning workspace.

    Field Description
    action
    RuleAction_STATUS

    Action: The action enum for networking rule.

    addressPrefixes
    []string

    AddressPrefixes: Optional, if provided, the ServiceTag property will be ignored.

    portRanges
    string
    protocol
    string
    serviceTag
    string

    ServiceTagDestination_STATUS_ARM

    (Appears on:ServiceTagOutboundRule_STATUS_ARM)

    Service Tag destination for a Service Tag Outbound Rule for the managed network of a machine learning workspace.

    Field Description
    action
    RuleAction_STATUS_ARM

    Action: The action enum for networking rule.

    addressPrefixes
    []string

    AddressPrefixes: Optional, if provided, the ServiceTag property will be ignored.

    portRanges
    string
    protocol
    string
    serviceTag
    string

    ServiceTagOutboundRule

    (Appears on:OutboundRule)

    Field Description
    category
    RuleCategory

    Category: Category of a managed network Outbound Rule of a machine learning workspace.

    destination
    ServiceTagDestination

    Destination: Service Tag destination for a Service Tag Outbound Rule for the managed network of a machine learning workspace.

    status
    RuleStatus

    Status: Type of a managed network Outbound Rule of a machine learning workspace.

    type
    ServiceTagOutboundRule_Type

    ServiceTagOutboundRule_ARM

    (Appears on:OutboundRule_ARM)

    Field Description
    category
    RuleCategory_ARM

    Category: Category of a managed network Outbound Rule of a machine learning workspace.

    destination
    ServiceTagDestination_ARM

    Destination: Service Tag destination for a Service Tag Outbound Rule for the managed network of a machine learning workspace.

    status
    RuleStatus_ARM

    Status: Type of a managed network Outbound Rule of a machine learning workspace.

    type
    ServiceTagOutboundRule_Type_ARM

    ServiceTagOutboundRule_STATUS

    (Appears on:OutboundRule_STATUS)

    Field Description
    category
    RuleCategory_STATUS

    Category: Category of a managed network Outbound Rule of a machine learning workspace.

    destination
    ServiceTagDestination_STATUS

    Destination: Service Tag destination for a Service Tag Outbound Rule for the managed network of a machine learning workspace.

    status
    RuleStatus_STATUS

    Status: Type of a managed network Outbound Rule of a machine learning workspace.

    type
    ServiceTagOutboundRule_Type_STATUS

    ServiceTagOutboundRule_STATUS_ARM

    (Appears on:OutboundRule_STATUS_ARM)

    Field Description
    category
    RuleCategory_STATUS_ARM

    Category: Category of a managed network Outbound Rule of a machine learning workspace.

    destination
    ServiceTagDestination_STATUS_ARM

    Destination: Service Tag destination for a Service Tag Outbound Rule for the managed network of a machine learning workspace.

    status
    RuleStatus_STATUS_ARM

    Status: Type of a managed network Outbound Rule of a machine learning workspace.

    type
    ServiceTagOutboundRule_Type_STATUS_ARM

    ServiceTagOutboundRule_Type (string alias)

    (Appears on:ServiceTagOutboundRule)

    Value Description

    "ServiceTag"

    ServiceTagOutboundRule_Type_ARM (string alias)

    (Appears on:ServiceTagOutboundRule_ARM)

    Value Description

    "ServiceTag"

    ServiceTagOutboundRule_Type_STATUS (string alias)

    (Appears on:ServiceTagOutboundRule_STATUS)

    Value Description

    "ServiceTag"

    ServiceTagOutboundRule_Type_STATUS_ARM (string alias)

    (Appears on:ServiceTagOutboundRule_STATUS_ARM)

    Value Description

    "ServiceTag"

    SetupScripts

    (Appears on:ComputeInstanceProperties)

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

    Field Description
    scripts
    ScriptsToExecute

    Scripts: Customized setup scripts

    SetupScripts_ARM

    (Appears on:ComputeInstanceProperties_ARM)

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

    Field Description
    scripts
    ScriptsToExecute_ARM

    Scripts: Customized setup scripts

    SetupScripts_STATUS

    (Appears on:ComputeInstanceProperties_STATUS)

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

    Field Description
    scripts
    ScriptsToExecute_STATUS

    Scripts: Customized setup scripts

    SetupScripts_STATUS_ARM

    (Appears on:ComputeInstanceProperties_STATUS_ARM)

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

    Field Description
    scripts
    ScriptsToExecute_STATUS_ARM

    Scripts: Customized setup scripts

    SharedPrivateLinkResource

    (Appears on:Workspace_Spec)

    Field Description
    groupId
    string

    GroupId: The private link resource group id.

    name
    string

    Name: Unique name of the private link.

    privateLinkResourceReference
    genruntime.ResourceReference

    PrivateLinkResourceReference: The resource id that private link links to.

    requestMessage
    string

    RequestMessage: Request message.

    status
    PrivateEndpointServiceConnectionStatus

    Status: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

    SharedPrivateLinkResourceProperty_ARM

    (Appears on:SharedPrivateLinkResource_ARM)

    Properties of a shared private link resource.

    Field Description
    groupId
    string

    GroupId: The private link resource group id.

    privateLinkResourceId
    string
    requestMessage
    string

    RequestMessage: Request message.

    status
    PrivateEndpointServiceConnectionStatus_ARM

    Status: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

    SharedPrivateLinkResourceProperty_STATUS_ARM

    (Appears on:SharedPrivateLinkResource_STATUS_ARM)

    Properties of a shared private link resource.

    Field Description
    groupId
    string

    GroupId: The private link resource group id.

    privateLinkResourceId
    string

    PrivateLinkResourceId: The resource id that private link links to.

    requestMessage
    string

    RequestMessage: Request message.

    status
    PrivateEndpointServiceConnectionStatus_STATUS_ARM

    Status: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

    SharedPrivateLinkResource_ARM

    (Appears on:WorkspaceProperties_ARM)

    Field Description
    name
    string

    Name: Unique name of the private link.

    properties
    SharedPrivateLinkResourceProperty_ARM

    Properties: Resource properties.

    SharedPrivateLinkResource_STATUS

    (Appears on:Workspace_STATUS)

    Field Description
    groupId
    string

    GroupId: The private link resource group id.

    name
    string

    Name: Unique name of the private link.

    privateLinkResourceId
    string

    PrivateLinkResourceId: The resource id that private link links to.

    requestMessage
    string

    RequestMessage: Request message.

    status
    PrivateEndpointServiceConnectionStatus_STATUS

    Status: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

    SharedPrivateLinkResource_STATUS_ARM

    (Appears on:WorkspaceProperties_STATUS_ARM)

    Field Description
    name
    string

    Name: Unique name of the private link.

    properties
    SharedPrivateLinkResourceProperty_STATUS_ARM

    Properties: Resource properties.

    Sku

    (Appears on:Workspace_Spec, Workspaces_Compute_Spec)

    The resource model definition representing SKU

    Field Description
    capacity
    int

    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.

    family
    string

    Family: If the service has different generations of hardware, for the same SKU, then that can be captured here.

    name
    string

    Name: The name of the SKU. Ex - P3. It is typically a letter+number code

    size
    string

    Size: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.

    tier
    SkuTier

    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 (string alias)

    (Appears on:Sku)

    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.

    Value Description

    "Basic"

    "Free"

    "Premium"

    "Standard"

    SkuTier_ARM (string alias)

    (Appears on:Sku_ARM)

    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.

    Value Description

    "Basic"

    "Free"

    "Premium"

    "Standard"

    SkuTier_STATUS (string alias)

    (Appears on:Sku_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.

    Value Description

    "Basic"

    "Free"

    "Premium"

    "Standard"

    SkuTier_STATUS_ARM (string alias)

    (Appears on:Sku_STATUS_ARM)

    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.

    Value Description

    "Basic"

    "Free"

    "Premium"

    "Standard"

    Sku_ARM

    (Appears on:Workspace_Spec_ARM, Workspaces_Compute_Spec_ARM)

    The resource model definition representing SKU

    Field Description
    capacity
    int

    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.

    family
    string

    Family: If the service has different generations of hardware, for the same SKU, then that can be captured here.

    name
    string

    Name: The name of the SKU. Ex - P3. It is typically a letter+number code

    size
    string

    Size: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.

    tier
    SkuTier_ARM

    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.

    Sku_STATUS

    (Appears on:Workspace_STATUS, Workspaces_Compute_STATUS)

    The resource model definition representing SKU

    Field Description
    capacity
    int

    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.

    family
    string

    Family: If the service has different generations of hardware, for the same SKU, then that can be captured here.

    name
    string

    Name: The name of the SKU. Ex - P3. It is typically a letter+number code

    size
    string

    Size: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.

    tier
    SkuTier_STATUS

    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.

    Sku_STATUS_ARM

    (Appears on:Workspace_STATUS_ARM, Workspaces_Compute_STATUS_ARM)

    The resource model definition representing SKU

    Field Description
    capacity
    int

    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.

    family
    string

    Family: If the service has different generations of hardware, for the same SKU, then that can be captured here.

    name
    string

    Name: The name of the SKU. Ex - P3. It is typically a letter+number code

    size
    string

    Size: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.

    tier
    SkuTier_STATUS_ARM

    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.

    SslConfiguration

    (Appears on:AKS_Properties)

    The ssl configuration for scoring

    Field Description
    cert
    genruntime.SecretReference

    Cert: Cert data

    cname
    string

    Cname: CNAME of the cert

    key
    genruntime.SecretReference

    Key: Key data

    leafDomainLabel
    string

    LeafDomainLabel: Leaf domain label of public endpoint

    overwriteExistingDomain
    bool

    OverwriteExistingDomain: Indicates whether to overwrite existing domain label.

    status
    SslConfiguration_Status

    Status: Enable or disable ssl for scoring

    SslConfiguration_ARM

    (Appears on:AKS_Properties_ARM)

    The ssl configuration for scoring

    Field Description
    cert
    string

    Cert: Cert data

    cname
    string

    Cname: CNAME of the cert

    key
    string

    Key: Key data

    leafDomainLabel
    string

    LeafDomainLabel: Leaf domain label of public endpoint

    overwriteExistingDomain
    bool

    OverwriteExistingDomain: Indicates whether to overwrite existing domain label.

    status
    SslConfiguration_Status_ARM

    Status: Enable or disable ssl for scoring

    SslConfiguration_STATUS

    (Appears on:AKS_Properties_STATUS)

    The ssl configuration for scoring

    Field Description
    cname
    string

    Cname: CNAME of the cert

    leafDomainLabel
    string

    LeafDomainLabel: Leaf domain label of public endpoint

    overwriteExistingDomain
    bool

    OverwriteExistingDomain: Indicates whether to overwrite existing domain label.

    status
    SslConfiguration_Status_STATUS

    Status: Enable or disable ssl for scoring

    SslConfiguration_STATUS_ARM

    (Appears on:AKS_Properties_STATUS_ARM)

    The ssl configuration for scoring

    Field Description
    cname
    string

    Cname: CNAME of the cert

    leafDomainLabel
    string

    LeafDomainLabel: Leaf domain label of public endpoint

    overwriteExistingDomain
    bool

    OverwriteExistingDomain: Indicates whether to overwrite existing domain label.

    status
    SslConfiguration_Status_STATUS_ARM

    Status: Enable or disable ssl for scoring

    SslConfiguration_Status (string alias)

    (Appears on:SslConfiguration)

    Value Description

    "Auto"

    "Disabled"

    "Enabled"

    SslConfiguration_Status_ARM (string alias)

    (Appears on:SslConfiguration_ARM)

    Value Description

    "Auto"

    "Disabled"

    "Enabled"

    SslConfiguration_Status_STATUS (string alias)

    (Appears on:SslConfiguration_STATUS)

    Value Description

    "Auto"

    "Disabled"

    "Enabled"

    SslConfiguration_Status_STATUS_ARM (string alias)

    (Appears on:SslConfiguration_STATUS_ARM)

    Value Description

    "Auto"

    "Disabled"

    "Enabled"

    SynapseSpark

    (Appears on:Compute)

    Field Description
    computeLocation
    string

    ComputeLocation: Location for the underlying compute

    computeType
    SynapseSpark_ComputeType

    ComputeType: The type of compute

    description
    string

    Description: The description of the Machine Learning compute.

    disableLocalAuth
    bool

    DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.

    properties
    SynapseSpark_Properties
    resourceReference
    genruntime.ResourceReference

    ResourceReference: ARM resource id of the underlying compute

    SynapseSpark_ARM

    (Appears on:Compute_ARM)

    Field Description
    computeLocation
    string

    ComputeLocation: Location for the underlying compute

    computeType
    SynapseSpark_ComputeType_ARM

    ComputeType: The type of compute

    description
    string

    Description: The description of the Machine Learning compute.

    disableLocalAuth
    bool

    DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.

    properties
    SynapseSpark_Properties_ARM
    resourceId
    string

    SynapseSpark_ComputeType (string alias)

    (Appears on:SynapseSpark)

    Value Description

    "SynapseSpark"

    SynapseSpark_ComputeType_ARM (string alias)

    (Appears on:SynapseSpark_ARM)

    Value Description

    "SynapseSpark"

    SynapseSpark_ComputeType_STATUS (string alias)

    (Appears on:SynapseSpark_STATUS)

    Value Description

    "SynapseSpark"

    SynapseSpark_ComputeType_STATUS_ARM (string alias)

    (Appears on:SynapseSpark_STATUS_ARM)

    Value Description

    "SynapseSpark"

    SynapseSpark_Properties

    (Appears on:SynapseSpark)

    Field Description
    autoPauseProperties
    AutoPauseProperties

    AutoPauseProperties: Auto pause properties.

    autoScaleProperties
    AutoScaleProperties

    AutoScaleProperties: Auto scale properties.

    nodeCount
    int

    NodeCount: The number of compute nodes currently assigned to the compute.

    nodeSize
    string

    NodeSize: Node size.

    nodeSizeFamily
    string

    NodeSizeFamily: Node size family.

    poolName
    string

    PoolName: Pool name.

    resourceGroup
    string

    ResourceGroup: Name of the resource group in which workspace is located.

    sparkVersion
    string

    SparkVersion: Spark version.

    subscriptionId
    string

    SubscriptionId: Azure subscription identifier.

    workspaceName
    string

    WorkspaceName: Name of Azure Machine Learning workspace.

    SynapseSpark_Properties_ARM

    (Appears on:SynapseSpark_ARM)

    Field Description
    autoPauseProperties
    AutoPauseProperties_ARM

    AutoPauseProperties: Auto pause properties.

    autoScaleProperties
    AutoScaleProperties_ARM

    AutoScaleProperties: Auto scale properties.

    nodeCount
    int

    NodeCount: The number of compute nodes currently assigned to the compute.

    nodeSize
    string

    NodeSize: Node size.

    nodeSizeFamily
    string

    NodeSizeFamily: Node size family.

    poolName
    string

    PoolName: Pool name.

    resourceGroup
    string

    ResourceGroup: Name of the resource group in which workspace is located.

    sparkVersion
    string

    SparkVersion: Spark version.

    subscriptionId
    string

    SubscriptionId: Azure subscription identifier.

    workspaceName
    string

    WorkspaceName: Name of Azure Machine Learning workspace.

    SynapseSpark_Properties_STATUS

    (Appears on:SynapseSpark_STATUS)

    Field Description
    autoPauseProperties
    AutoPauseProperties_STATUS

    AutoPauseProperties: Auto pause properties.

    autoScaleProperties
    AutoScaleProperties_STATUS

    AutoScaleProperties: Auto scale properties.

    nodeCount
    int

    NodeCount: The number of compute nodes currently assigned to the compute.

    nodeSize
    string

    NodeSize: Node size.

    nodeSizeFamily
    string

    NodeSizeFamily: Node size family.

    poolName
    string

    PoolName: Pool name.

    resourceGroup
    string

    ResourceGroup: Name of the resource group in which workspace is located.

    sparkVersion
    string

    SparkVersion: Spark version.

    subscriptionId
    string

    SubscriptionId: Azure subscription identifier.

    workspaceName
    string

    WorkspaceName: Name of Azure Machine Learning workspace.

    SynapseSpark_Properties_STATUS_ARM

    (Appears on:SynapseSpark_STATUS_ARM)

    Field Description
    autoPauseProperties
    AutoPauseProperties_STATUS_ARM

    AutoPauseProperties: Auto pause properties.

    autoScaleProperties
    AutoScaleProperties_STATUS_ARM

    AutoScaleProperties: Auto scale properties.

    nodeCount
    int

    NodeCount: The number of compute nodes currently assigned to the compute.

    nodeSize
    string

    NodeSize: Node size.

    nodeSizeFamily
    string

    NodeSizeFamily: Node size family.

    poolName
    string

    PoolName: Pool name.

    resourceGroup
    string

    ResourceGroup: Name of the resource group in which workspace is located.

    sparkVersion
    string

    SparkVersion: Spark version.

    subscriptionId
    string

    SubscriptionId: Azure subscription identifier.

    workspaceName
    string

    WorkspaceName: Name of Azure Machine Learning workspace.

    SynapseSpark_ProvisioningState_STATUS (string alias)

    (Appears on:SynapseSpark_STATUS)

    Value Description

    "Canceled"

    "Creating"

    "Deleting"

    "Failed"

    "Succeeded"

    "Unknown"

    "Updating"

    SynapseSpark_ProvisioningState_STATUS_ARM (string alias)

    (Appears on:SynapseSpark_STATUS_ARM)

    Value Description

    "Canceled"

    "Creating"

    "Deleting"

    "Failed"

    "Succeeded"

    "Unknown"

    "Updating"

    SynapseSpark_STATUS

    (Appears on:Compute_STATUS)

    Field Description
    computeLocation
    string

    ComputeLocation: Location for the underlying compute

    computeType
    SynapseSpark_ComputeType_STATUS

    ComputeType: The type of compute

    createdOn
    string

    CreatedOn: The time at which the compute was created.

    description
    string

    Description: The description of the Machine Learning compute.

    disableLocalAuth
    bool

    DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.

    isAttachedCompute
    bool

    IsAttachedCompute: Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.

    modifiedOn
    string

    ModifiedOn: The time at which the compute was last modified.

    properties
    SynapseSpark_Properties_STATUS
    provisioningErrors
    []ErrorResponse_STATUS

    ProvisioningErrors: Errors during provisioning

    provisioningState
    SynapseSpark_ProvisioningState_STATUS

    ProvisioningState: The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.

    resourceId
    string

    ResourceId: ARM resource id of the underlying compute

    SynapseSpark_STATUS_ARM

    (Appears on:Compute_STATUS_ARM)

    Field Description
    computeLocation
    string

    ComputeLocation: Location for the underlying compute

    computeType
    SynapseSpark_ComputeType_STATUS_ARM

    ComputeType: The type of compute

    createdOn
    string

    CreatedOn: The time at which the compute was created.

    description
    string

    Description: The description of the Machine Learning compute.

    disableLocalAuth
    bool

    DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.

    isAttachedCompute
    bool

    IsAttachedCompute: Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.

    modifiedOn
    string

    ModifiedOn: The time at which the compute was last modified.

    properties
    SynapseSpark_Properties_STATUS_ARM
    provisioningErrors
    []ErrorResponse_STATUS_ARM

    ProvisioningErrors: Errors during provisioning

    provisioningState
    SynapseSpark_ProvisioningState_STATUS_ARM

    ProvisioningState: The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.

    resourceId
    string

    ResourceId: ARM resource id of the underlying compute

    SystemData_CreatedByType_STATUS (string alias)

    (Appears on:SystemData_STATUS)

    Value Description

    "Application"

    "Key"

    "ManagedIdentity"

    "User"

    SystemData_CreatedByType_STATUS_ARM (string alias)

    (Appears on:SystemData_STATUS_ARM)

    Value Description

    "Application"

    "Key"

    "ManagedIdentity"

    "User"

    SystemData_LastModifiedByType_STATUS (string alias)

    (Appears on:SystemData_STATUS)

    Value Description

    "Application"

    "Key"

    "ManagedIdentity"

    "User"

    SystemData_LastModifiedByType_STATUS_ARM (string alias)

    (Appears on:SystemData_STATUS_ARM)

    Value Description

    "Application"

    "Key"

    "ManagedIdentity"

    "User"

    SystemData_STATUS

    (Appears on:Workspace_STATUS, Workspaces_Compute_STATUS, Workspaces_Connection_STATUS)

    Metadata pertaining to creation and last modification of the resource.

    Field Description
    createdAt
    string

    CreatedAt: The timestamp of resource creation (UTC).

    createdBy
    string

    CreatedBy: The identity that created the resource.

    createdByType
    SystemData_CreatedByType_STATUS

    CreatedByType: The type of identity that created the resource.

    lastModifiedAt
    string

    LastModifiedAt: The timestamp of resource last modification (UTC)

    lastModifiedBy
    string

    LastModifiedBy: The identity that last modified the resource.

    lastModifiedByType
    SystemData_LastModifiedByType_STATUS

    LastModifiedByType: The type of identity that last modified the resource.

    SystemData_STATUS_ARM

    (Appears on:Workspace_STATUS_ARM, Workspaces_Compute_STATUS_ARM, Workspaces_Connection_STATUS_ARM)

    Metadata pertaining to creation and last modification of the resource.

    Field Description
    createdAt
    string

    CreatedAt: The timestamp of resource creation (UTC).

    createdBy
    string

    CreatedBy: The identity that created the resource.

    createdByType
    SystemData_CreatedByType_STATUS_ARM

    CreatedByType: The type of identity that created the resource.

    lastModifiedAt
    string

    LastModifiedAt: The timestamp of resource last modification (UTC)

    lastModifiedBy
    string

    LastModifiedBy: The identity that last modified the resource.

    lastModifiedByType
    SystemData_LastModifiedByType_STATUS_ARM

    LastModifiedByType: The type of identity that last modified the resource.

    SystemService_STATUS

    (Appears on:AKS_Properties_STATUS)

    A system service running on a compute.

    Field Description
    publicIpAddress
    string

    PublicIpAddress: Public IP address

    systemServiceType
    string

    SystemServiceType: The type of this system service.

    version
    string

    Version: The version for this type.

    SystemService_STATUS_ARM

    (Appears on:AKS_Properties_STATUS_ARM)

    A system service running on a compute.

    Field Description
    publicIpAddress
    string

    PublicIpAddress: Public IP address

    systemServiceType
    string

    SystemServiceType: The type of this system service.

    version
    string

    Version: The version for this type.

    TmpfsOptions

    (Appears on:VolumeDefinition)

    Describes the tmpfs options for the container

    Field Description
    size
    int

    Size: Mention the Tmpfs size

    TmpfsOptions_ARM

    (Appears on:VolumeDefinition_ARM)

    Describes the tmpfs options for the container

    Field Description
    size
    int

    Size: Mention the Tmpfs size

    TmpfsOptions_STATUS

    (Appears on:VolumeDefinition_STATUS)

    Describes the tmpfs options for the container

    Field Description
    size
    int

    Size: Mention the Tmpfs size

    TmpfsOptions_STATUS_ARM

    (Appears on:VolumeDefinition_STATUS_ARM)

    Describes the tmpfs options for the container

    Field Description
    size
    int

    Size: Mention the Tmpfs size

    UserAccountCredentials

    (Appears on:AmlComputeProperties)

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

    Field Description
    adminUserName
    string

    AdminUserName: Name of the administrator user account which can be used to SSH to nodes.

    adminUserPassword
    genruntime.SecretReference

    AdminUserPassword: Password of the administrator user account.

    adminUserSshPublicKey
    genruntime.SecretReference

    AdminUserSshPublicKey: SSH public key of the administrator user account.

    UserAccountCredentials_ARM

    (Appears on:AmlComputeProperties_ARM)

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

    Field Description
    adminUserName
    string

    AdminUserName: Name of the administrator user account which can be used to SSH to nodes.

    adminUserPassword
    string

    AdminUserPassword: Password of the administrator user account.

    adminUserSshPublicKey
    string

    AdminUserSshPublicKey: SSH public key of the administrator user account.

    UserAccountCredentials_STATUS

    (Appears on:AmlComputeProperties_STATUS)

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

    Field Description
    adminUserName
    string

    AdminUserName: Name of the administrator user account which can be used to SSH to nodes.

    UserAccountCredentials_STATUS_ARM

    (Appears on:AmlComputeProperties_STATUS_ARM)

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

    Field Description
    adminUserName
    string

    AdminUserName: Name of the administrator user account which can be used to SSH to nodes.

    UserAssignedIdentityDetails

    (Appears on:ManagedServiceIdentity)

    Information about the user assigned identity for the resource

    Field Description
    reference
    genruntime.ResourceReference

    UserAssignedIdentityDetails_ARM

    (Appears on:ManagedServiceIdentity_ARM)

    Information about the user assigned identity for the resource

    UserAssignedIdentity_STATUS

    (Appears on:ManagedServiceIdentity_STATUS)

    User assigned identity properties

    Field Description
    clientId
    string

    ClientId: The client ID of the assigned identity.

    principalId
    string

    PrincipalId: The principal ID of the assigned identity.

    UserAssignedIdentity_STATUS_ARM

    (Appears on:ManagedServiceIdentity_STATUS_ARM)

    User assigned identity properties

    Field Description
    clientId
    string

    ClientId: The client ID of the assigned identity.

    principalId
    string

    PrincipalId: The principal ID of the assigned identity.

    UsernamePasswordAuthTypeWorkspaceConnectionProperties

    (Appears on:WorkspaceConnectionPropertiesV2)

    Field Description
    authType
    UsernamePasswordAuthTypeWorkspaceConnectionProperties_AuthType

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory

    Category: Category of the connection

    credentials
    WorkspaceConnectionUsernamePassword
    expiryTime
    string
    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    UsernamePasswordAuthTypeWorkspaceConnectionProperties_ValueFormat

    ValueFormat: format for the workspace connection value

    UsernamePasswordAuthTypeWorkspaceConnectionProperties_ARM

    (Appears on:WorkspaceConnectionPropertiesV2_ARM)

    Field Description
    authType
    UsernamePasswordAuthTypeWorkspaceConnectionProperties_AuthType_ARM

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory_ARM

    Category: Category of the connection

    credentials
    WorkspaceConnectionUsernamePassword_ARM
    expiryTime
    string
    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    UsernamePasswordAuthTypeWorkspaceConnectionProperties_ValueFormat_ARM

    ValueFormat: format for the workspace connection value

    UsernamePasswordAuthTypeWorkspaceConnectionProperties_AuthType (string alias)

    (Appears on:UsernamePasswordAuthTypeWorkspaceConnectionProperties)

    Value Description

    "UsernamePassword"

    UsernamePasswordAuthTypeWorkspaceConnectionProperties_AuthType_ARM (string alias)

    (Appears on:UsernamePasswordAuthTypeWorkspaceConnectionProperties_ARM)

    Value Description

    "UsernamePassword"

    UsernamePasswordAuthTypeWorkspaceConnectionProperties_AuthType_STATUS (string alias)

    (Appears on:UsernamePasswordAuthTypeWorkspaceConnectionProperties_STATUS)

    Value Description

    "UsernamePassword"

    UsernamePasswordAuthTypeWorkspaceConnectionProperties_AuthType_STATUS_ARM (string alias)

    (Appears on:UsernamePasswordAuthTypeWorkspaceConnectionProperties_STATUS_ARM)

    Value Description

    "UsernamePassword"

    UsernamePasswordAuthTypeWorkspaceConnectionProperties_STATUS

    (Appears on:WorkspaceConnectionPropertiesV2_STATUS)

    Field Description
    authType
    UsernamePasswordAuthTypeWorkspaceConnectionProperties_AuthType_STATUS

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory_STATUS

    Category: Category of the connection

    createdByWorkspaceArmId
    string
    credentials
    WorkspaceConnectionUsernamePassword_STATUS
    expiryTime
    string
    group
    ConnectionGroup_STATUS

    Group: Group based on connection category

    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    UsernamePasswordAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS

    ValueFormat: format for the workspace connection value

    UsernamePasswordAuthTypeWorkspaceConnectionProperties_STATUS_ARM

    (Appears on:WorkspaceConnectionPropertiesV2_STATUS_ARM)

    Field Description
    authType
    UsernamePasswordAuthTypeWorkspaceConnectionProperties_AuthType_STATUS_ARM

    AuthType: Authentication type of the connection target

    category
    ConnectionCategory_STATUS_ARM

    Category: Category of the connection

    createdByWorkspaceArmId
    string
    credentials
    WorkspaceConnectionUsernamePassword_STATUS_ARM
    expiryTime
    string
    group
    ConnectionGroup_STATUS_ARM

    Group: Group based on connection category

    isSharedToAll
    bool
    metadata
    map[string]string

    Metadata: Store user metadata for this connection

    sharedUserList
    []string
    target
    string
    value
    string

    Value: Value details of the workspace connection.

    valueFormat
    UsernamePasswordAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS_ARM

    ValueFormat: format for the workspace connection value

    UsernamePasswordAuthTypeWorkspaceConnectionProperties_ValueFormat (string alias)

    (Appears on:UsernamePasswordAuthTypeWorkspaceConnectionProperties)

    Value Description

    "JSON"

    UsernamePasswordAuthTypeWorkspaceConnectionProperties_ValueFormat_ARM (string alias)

    (Appears on:UsernamePasswordAuthTypeWorkspaceConnectionProperties_ARM)

    Value Description

    "JSON"

    UsernamePasswordAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS (string alias)

    (Appears on:UsernamePasswordAuthTypeWorkspaceConnectionProperties_STATUS)

    Value Description

    "JSON"

    UsernamePasswordAuthTypeWorkspaceConnectionProperties_ValueFormat_STATUS_ARM (string alias)

    (Appears on:UsernamePasswordAuthTypeWorkspaceConnectionProperties_STATUS_ARM)

    Value Description

    "JSON"

    VirtualMachine

    (Appears on:Compute)

    Field Description
    computeLocation
    string

    ComputeLocation: Location for the underlying compute

    computeType
    VirtualMachine_ComputeType

    ComputeType: The type of compute

    description
    string

    Description: The description of the Machine Learning compute.

    disableLocalAuth
    bool

    DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.

    properties
    VirtualMachine_Properties
    resourceReference
    genruntime.ResourceReference

    ResourceReference: ARM resource id of the underlying compute

    VirtualMachineImage

    (Appears on:AmlComputeProperties)

    Virtual Machine image for Windows AML Compute

    Field Description
    reference
    genruntime.ResourceReference

    Reference: Virtual Machine image path

    VirtualMachineImage_ARM

    (Appears on:AmlComputeProperties_ARM)

    Virtual Machine image for Windows AML Compute

    Field Description
    id
    string

    VirtualMachineImage_STATUS

    (Appears on:AmlComputeProperties_STATUS)

    Virtual Machine image for Windows AML Compute

    Field Description
    id
    string

    Id: Virtual Machine image path

    VirtualMachineImage_STATUS_ARM

    (Appears on:AmlComputeProperties_STATUS_ARM)

    Virtual Machine image for Windows AML Compute

    Field Description
    id
    string

    Id: Virtual Machine image path

    VirtualMachineSshCredentials

    (Appears on:HDInsightProperties, VirtualMachine_Properties)

    Admin credentials for virtual machine

    Field Description
    password
    genruntime.SecretReference

    Password: Password of admin account

    privateKeyData
    genruntime.SecretReference

    PrivateKeyData: Private key data

    publicKeyData
    genruntime.SecretReference

    PublicKeyData: Public key data

    username
    string

    Username: Username of admin account

    VirtualMachineSshCredentials_ARM

    (Appears on:HDInsightProperties_ARM, VirtualMachine_Properties_ARM)

    Admin credentials for virtual machine

    Field Description
    password
    string

    Password: Password of admin account

    privateKeyData
    string

    PrivateKeyData: Private key data

    publicKeyData
    string

    PublicKeyData: Public key data

    username
    string

    Username: Username of admin account

    VirtualMachineSshCredentials_STATUS

    (Appears on:HDInsightProperties_STATUS, VirtualMachine_Properties_STATUS)

    Admin credentials for virtual machine

    Field Description
    username
    string

    Username: Username of admin account

    VirtualMachineSshCredentials_STATUS_ARM

    (Appears on:HDInsightProperties_STATUS_ARM, VirtualMachine_Properties_STATUS_ARM)

    Admin credentials for virtual machine

    Field Description
    username
    string

    Username: Username of admin account

    VirtualMachine_ARM

    (Appears on:Compute_ARM)

    Field Description
    computeLocation
    string

    ComputeLocation: Location for the underlying compute

    computeType
    VirtualMachine_ComputeType_ARM

    ComputeType: The type of compute

    description
    string

    Description: The description of the Machine Learning compute.

    disableLocalAuth
    bool

    DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.

    properties
    VirtualMachine_Properties_ARM
    resourceId
    string

    VirtualMachine_ComputeType (string alias)

    (Appears on:VirtualMachine)

    Value Description

    "VirtualMachine"

    VirtualMachine_ComputeType_ARM (string alias)

    (Appears on:VirtualMachine_ARM)

    Value Description

    "VirtualMachine"

    VirtualMachine_ComputeType_STATUS (string alias)

    (Appears on:VirtualMachine_STATUS)

    Value Description

    "VirtualMachine"

    VirtualMachine_ComputeType_STATUS_ARM (string alias)

    (Appears on:VirtualMachine_STATUS_ARM)

    Value Description

    "VirtualMachine"

    VirtualMachine_Properties

    (Appears on:VirtualMachine)

    Field Description
    address
    string

    Address: Public IP address of the virtual machine.

    administratorAccount
    VirtualMachineSshCredentials

    AdministratorAccount: Admin credentials for virtual machine

    isNotebookInstanceCompute
    bool

    IsNotebookInstanceCompute: Indicates whether this compute will be used for running notebooks.

    notebookServerPort
    int

    NotebookServerPort: Notebook server port open for ssh connections.

    sshPort
    int

    SshPort: Port open for ssh connections.

    virtualMachineSize
    string

    VirtualMachineSize: Virtual Machine size

    VirtualMachine_Properties_ARM

    (Appears on:VirtualMachine_ARM)

    Field Description
    address
    string

    Address: Public IP address of the virtual machine.

    administratorAccount
    VirtualMachineSshCredentials_ARM

    AdministratorAccount: Admin credentials for virtual machine

    isNotebookInstanceCompute
    bool

    IsNotebookInstanceCompute: Indicates whether this compute will be used for running notebooks.

    notebookServerPort
    int

    NotebookServerPort: Notebook server port open for ssh connections.

    sshPort
    int

    SshPort: Port open for ssh connections.

    virtualMachineSize
    string

    VirtualMachineSize: Virtual Machine size

    VirtualMachine_Properties_STATUS

    (Appears on:VirtualMachine_STATUS)

    Field Description
    address
    string

    Address: Public IP address of the virtual machine.

    administratorAccount
    VirtualMachineSshCredentials_STATUS

    AdministratorAccount: Admin credentials for virtual machine

    isNotebookInstanceCompute
    bool

    IsNotebookInstanceCompute: Indicates whether this compute will be used for running notebooks.

    notebookServerPort
    int

    NotebookServerPort: Notebook server port open for ssh connections.

    sshPort
    int

    SshPort: Port open for ssh connections.

    virtualMachineSize
    string

    VirtualMachineSize: Virtual Machine size

    VirtualMachine_Properties_STATUS_ARM

    (Appears on:VirtualMachine_STATUS_ARM)

    Field Description
    address
    string

    Address: Public IP address of the virtual machine.

    administratorAccount
    VirtualMachineSshCredentials_STATUS_ARM

    AdministratorAccount: Admin credentials for virtual machine

    isNotebookInstanceCompute
    bool

    IsNotebookInstanceCompute: Indicates whether this compute will be used for running notebooks.

    notebookServerPort
    int

    NotebookServerPort: Notebook server port open for ssh connections.

    sshPort
    int

    SshPort: Port open for ssh connections.

    virtualMachineSize
    string

    VirtualMachineSize: Virtual Machine size

    VirtualMachine_ProvisioningState_STATUS (string alias)

    (Appears on:VirtualMachine_STATUS)

    Value Description

    "Canceled"

    "Creating"

    "Deleting"

    "Failed"

    "Succeeded"

    "Unknown"

    "Updating"

    VirtualMachine_ProvisioningState_STATUS_ARM (string alias)

    (Appears on:VirtualMachine_STATUS_ARM)

    Value Description

    "Canceled"

    "Creating"

    "Deleting"

    "Failed"

    "Succeeded"

    "Unknown"

    "Updating"

    VirtualMachine_STATUS

    (Appears on:Compute_STATUS)

    Field Description
    computeLocation
    string

    ComputeLocation: Location for the underlying compute

    computeType
    VirtualMachine_ComputeType_STATUS

    ComputeType: The type of compute

    createdOn
    string

    CreatedOn: The time at which the compute was created.

    description
    string

    Description: The description of the Machine Learning compute.

    disableLocalAuth
    bool

    DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.

    isAttachedCompute
    bool

    IsAttachedCompute: Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.

    modifiedOn
    string

    ModifiedOn: The time at which the compute was last modified.

    properties
    VirtualMachine_Properties_STATUS
    provisioningErrors
    []ErrorResponse_STATUS

    ProvisioningErrors: Errors during provisioning

    provisioningState
    VirtualMachine_ProvisioningState_STATUS

    ProvisioningState: The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.

    resourceId
    string

    ResourceId: ARM resource id of the underlying compute

    VirtualMachine_STATUS_ARM

    (Appears on:Compute_STATUS_ARM)

    Field Description
    computeLocation
    string

    ComputeLocation: Location for the underlying compute

    computeType
    VirtualMachine_ComputeType_STATUS_ARM

    ComputeType: The type of compute

    createdOn
    string

    CreatedOn: The time at which the compute was created.

    description
    string

    Description: The description of the Machine Learning compute.

    disableLocalAuth
    bool

    DisableLocalAuth: Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.

    isAttachedCompute
    bool

    IsAttachedCompute: Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.

    modifiedOn
    string

    ModifiedOn: The time at which the compute was last modified.

    properties
    VirtualMachine_Properties_STATUS_ARM
    provisioningErrors
    []ErrorResponse_STATUS_ARM

    ProvisioningErrors: Errors during provisioning

    provisioningState
    VirtualMachine_ProvisioningState_STATUS_ARM

    ProvisioningState: The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.

    resourceId
    string

    ResourceId: ARM resource id of the underlying compute

    VolumeDefinition

    (Appears on:CustomService)

    Describes the volume configuration for the container

    Field Description
    bind
    BindOptions

    Bind: Bind Options of the mount

    consistency
    string

    Consistency: Consistency of the volume

    readOnly
    bool

    ReadOnly: Indicate whether to mount volume as readOnly. Default value for this is false.

    source
    string

    Source: Source of the mount. For bind mounts this is the host path.

    target
    string

    Target: Target of the mount. For bind mounts this is the path in the container.

    tmpfs
    TmpfsOptions

    Tmpfs: tmpfs option of the mount

    type
    VolumeDefinition_Type

    Type: Type of Volume Definition. Possible Values: bind,volume,tmpfs,npipe

    volume
    VolumeOptions

    Volume: Volume Options of the mount

    VolumeDefinition_ARM

    (Appears on:CustomService_ARM)

    Describes the volume configuration for the container

    Field Description
    bind
    BindOptions_ARM

    Bind: Bind Options of the mount

    consistency
    string

    Consistency: Consistency of the volume

    readOnly
    bool

    ReadOnly: Indicate whether to mount volume as readOnly. Default value for this is false.

    source
    string

    Source: Source of the mount. For bind mounts this is the host path.

    target
    string

    Target: Target of the mount. For bind mounts this is the path in the container.

    tmpfs
    TmpfsOptions_ARM

    Tmpfs: tmpfs option of the mount

    type
    VolumeDefinition_Type_ARM

    Type: Type of Volume Definition. Possible Values: bind,volume,tmpfs,npipe

    volume
    VolumeOptions_ARM

    Volume: Volume Options of the mount

    VolumeDefinition_STATUS

    (Appears on:CustomService_STATUS)

    Describes the volume configuration for the container

    Field Description
    bind
    BindOptions_STATUS

    Bind: Bind Options of the mount

    consistency
    string

    Consistency: Consistency of the volume

    readOnly
    bool

    ReadOnly: Indicate whether to mount volume as readOnly. Default value for this is false.

    source
    string

    Source: Source of the mount. For bind mounts this is the host path.

    target
    string

    Target: Target of the mount. For bind mounts this is the path in the container.

    tmpfs
    TmpfsOptions_STATUS

    Tmpfs: tmpfs option of the mount

    type
    VolumeDefinition_Type_STATUS

    Type: Type of Volume Definition. Possible Values: bind,volume,tmpfs,npipe

    volume
    VolumeOptions_STATUS

    Volume: Volume Options of the mount

    VolumeDefinition_STATUS_ARM

    (Appears on:CustomService_STATUS_ARM)

    Describes the volume configuration for the container

    Field Description
    bind
    BindOptions_STATUS_ARM

    Bind: Bind Options of the mount

    consistency
    string

    Consistency: Consistency of the volume

    readOnly
    bool

    ReadOnly: Indicate whether to mount volume as readOnly. Default value for this is false.

    source
    string

    Source: Source of the mount. For bind mounts this is the host path.

    target
    string

    Target: Target of the mount. For bind mounts this is the path in the container.

    tmpfs
    TmpfsOptions_STATUS_ARM

    Tmpfs: tmpfs option of the mount

    type
    VolumeDefinition_Type_STATUS_ARM

    Type: Type of Volume Definition. Possible Values: bind,volume,tmpfs,npipe

    volume
    VolumeOptions_STATUS_ARM

    Volume: Volume Options of the mount

    VolumeDefinition_Type (string alias)

    (Appears on:VolumeDefinition)

    Value Description

    "bind"

    "npipe"

    "tmpfs"

    "volume"

    VolumeDefinition_Type_ARM (string alias)

    (Appears on:VolumeDefinition_ARM)

    Value Description

    "bind"

    "npipe"

    "tmpfs"

    "volume"

    VolumeDefinition_Type_STATUS (string alias)

    (Appears on:VolumeDefinition_STATUS)

    Value Description

    "bind"

    "npipe"

    "tmpfs"

    "volume"

    VolumeDefinition_Type_STATUS_ARM (string alias)

    (Appears on:VolumeDefinition_STATUS_ARM)

    Value Description

    "bind"

    "npipe"

    "tmpfs"

    "volume"

    VolumeOptions

    (Appears on:VolumeDefinition)

    Describes the volume options for the container

    Field Description
    nocopy
    bool

    Nocopy: Indicate whether volume is nocopy

    VolumeOptions_ARM

    (Appears on:VolumeDefinition_ARM)

    Describes the volume options for the container

    Field Description
    nocopy
    bool

    Nocopy: Indicate whether volume is nocopy

    VolumeOptions_STATUS

    (Appears on:VolumeDefinition_STATUS)

    Describes the volume options for the container

    Field Description
    nocopy
    bool

    Nocopy: Indicate whether volume is nocopy

    VolumeOptions_STATUS_ARM

    (Appears on:VolumeDefinition_STATUS_ARM)

    Describes the volume options for the container

    Field Description
    nocopy
    bool

    Nocopy: Indicate whether volume is nocopy

    Workspace

    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}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    Workspace_Spec


    allowPublicAccessWhenBehindVnet
    bool

    AllowPublicAccessWhenBehindVnet: The flag to indicate whether to allow public access when behind VNet.

    applicationInsightsReference
    genruntime.ResourceReference

    ApplicationInsightsReference: ARM id of the application insights associated with this workspace.

    associatedWorkspaces
    []string
    azureName
    string

    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.

    containerRegistryReference
    genruntime.ResourceReference

    ContainerRegistryReference: ARM id of the container registry associated with this workspace.

    description
    string

    Description: The description of this workspace.

    discoveryUrl
    string

    DiscoveryUrl: Url for the discovery service to identify regional endpoints for machine learning experimentation services

    enableDataIsolation
    bool
    encryption
    EncryptionProperty

    Encryption: The encryption settings of Azure ML workspace.

    featureStoreSettings
    FeatureStoreSettings

    FeatureStoreSettings: Settings for feature store type workspace.

    friendlyName
    string

    FriendlyName: The friendly name for this workspace. This name in mutable

    hbiWorkspace
    bool

    HbiWorkspace: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service

    hubResourceReference
    genruntime.ResourceReference
    identity
    ManagedServiceIdentity

    Identity: The identity of the resource.

    imageBuildCompute
    string

    ImageBuildCompute: The compute name for image build

    keyVaultReference
    genruntime.ResourceReference

    KeyVaultReference: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created

    kind
    string
    location
    string

    Location: Specifies the location of the resource.

    managedNetwork
    ManagedNetworkSettings

    ManagedNetwork: Managed Network settings for a machine learning workspace.

    operatorSpec
    WorkspaceOperatorSpec

    OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure

    owner
    genruntime.KnownResourceReference

    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

    primaryUserAssignedIdentityReference
    genruntime.ResourceReference

    PrimaryUserAssignedIdentityReference: The user assigned identity resource id that represents the workspace identity.

    publicNetworkAccess
    WorkspaceProperties_PublicNetworkAccess

    PublicNetworkAccess: Whether requests from Public Network are allowed.

    serverlessComputeSettings
    ServerlessComputeSettings

    ServerlessComputeSettings: Settings for serverless compute created in the workspace

    serviceManagedResourcesSettings
    ServiceManagedResourcesSettings

    ServiceManagedResourcesSettings: The service managed resource settings.

    sharedPrivateLinkResources
    []SharedPrivateLinkResource

    SharedPrivateLinkResources: The list of shared private link resources in this workspace.

    sku
    Sku

    Sku: The sku of the workspace.

    storageAccountReference
    genruntime.ResourceReference

    StorageAccountReference: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created

    tags
    map[string]string

    Tags: Contains resource tags defined as key/value pairs.

    v1LegacyMode
    bool

    V1LegacyMode: Enabling v1_legacy_mode may prevent you from using features provided by the v2 API.

    workspaceHubConfig
    WorkspaceHubConfig

    WorkspaceHubConfig: WorkspaceHub’s configuration object.

    status
    Workspace_STATUS

    WorkspaceConnectionAccessKey

    (Appears on:AccessKeyAuthTypeWorkspaceConnectionProperties)

    Field Description
    accessKeyId
    string
    secretAccessKey
    genruntime.SecretReference

    WorkspaceConnectionAccessKey_ARM

    (Appears on:AccessKeyAuthTypeWorkspaceConnectionProperties_ARM)

    Field Description
    accessKeyId
    string
    secretAccessKey
    string

    WorkspaceConnectionAccessKey_STATUS

    (Appears on:AccessKeyAuthTypeWorkspaceConnectionProperties_STATUS)

    Field Description
    accessKeyId
    string

    WorkspaceConnectionAccessKey_STATUS_ARM

    (Appears on:AccessKeyAuthTypeWorkspaceConnectionProperties_STATUS_ARM)

    Field Description
    accessKeyId
    string

    WorkspaceConnectionAccountKey

    (Appears on:AccountKeyAuthTypeWorkspaceConnectionProperties)

    Field Description
    key
    genruntime.SecretReference

    WorkspaceConnectionAccountKey_ARM

    (Appears on:AccountKeyAuthTypeWorkspaceConnectionProperties_ARM)

    Field Description
    key
    string

    WorkspaceConnectionAccountKey_STATUS

    (Appears on:AccountKeyAuthTypeWorkspaceConnectionProperties_STATUS)

    WorkspaceConnectionAccountKey_STATUS_ARM

    (Appears on:AccountKeyAuthTypeWorkspaceConnectionProperties_STATUS_ARM)

    WorkspaceConnectionApiKey

    (Appears on:ApiKeyAuthWorkspaceConnectionProperties)

    Api key object for workspace connection credential.

    Field Description
    key
    genruntime.SecretReference

    WorkspaceConnectionApiKey_ARM

    (Appears on:ApiKeyAuthWorkspaceConnectionProperties_ARM)

    Api key object for workspace connection credential.

    Field Description
    key
    string

    WorkspaceConnectionApiKey_STATUS

    (Appears on:ApiKeyAuthWorkspaceConnectionProperties_STATUS)

    Api key object for workspace connection credential.

    WorkspaceConnectionApiKey_STATUS_ARM

    (Appears on:ApiKeyAuthWorkspaceConnectionProperties_STATUS_ARM)

    Api key object for workspace connection credential.

    WorkspaceConnectionManagedIdentity

    (Appears on:ManagedIdentityAuthTypeWorkspaceConnectionProperties)

    Field Description
    clientId
    string
    clientIdFromConfig
    genruntime.ConfigMapReference
    resourceReference
    genruntime.ResourceReference

    WorkspaceConnectionManagedIdentity_ARM

    (Appears on:ManagedIdentityAuthTypeWorkspaceConnectionProperties_ARM)

    Field Description
    clientId
    string
    resourceId
    string

    WorkspaceConnectionManagedIdentity_STATUS

    (Appears on:ManagedIdentityAuthTypeWorkspaceConnectionProperties_STATUS)

    Field Description
    clientId
    string
    resourceId
    string

    WorkspaceConnectionManagedIdentity_STATUS_ARM

    (Appears on:ManagedIdentityAuthTypeWorkspaceConnectionProperties_STATUS_ARM)

    Field Description
    clientId
    string
    resourceId
    string

    WorkspaceConnectionOAuth2

    (Appears on:OAuth2AuthTypeWorkspaceConnectionProperties)

    ClientId and ClientSecret are required. Other properties are optional depending on each OAuth2 provider’s implementation.

    Field Description
    authUrl
    string

    AuthUrl: Required by Concur connection category

    clientId
    string

    ClientId: Client id in the format of UUID

    clientIdFromConfig
    genruntime.ConfigMapReference

    ClientIdFromConfig: Client id in the format of UUID

    clientSecret
    genruntime.SecretReference
    developerToken
    genruntime.SecretReference

    DeveloperToken: Required by GoogleAdWords connection category

    password
    genruntime.SecretReference
    refreshToken
    genruntime.SecretReference

    RefreshToken: Required by GoogleBigQuery, GoogleAdWords, Hubspot, QuickBooks, Square, Xero, Zoho where user needs to get RefreshToken offline

    tenantId
    string

    TenantId: Required by QuickBooks and Xero connection categories

    tenantIdFromConfig
    genruntime.ConfigMapReference

    TenantIdFromConfig: Required by QuickBooks and Xero connection categories

    username
    string

    Username: Concur, ServiceNow auth server AccessToken grant type is ‘Password’ which requires UsernamePassword

    WorkspaceConnectionOAuth2_ARM

    (Appears on:OAuth2AuthTypeWorkspaceConnectionProperties_ARM)

    ClientId and ClientSecret are required. Other properties are optional depending on each OAuth2 provider’s implementation.

    Field Description
    authUrl
    string

    AuthUrl: Required by Concur connection category

    clientId
    string

    ClientId: Client id in the format of UUID

    clientSecret
    string
    developerToken
    string

    DeveloperToken: Required by GoogleAdWords connection category

    password
    string
    refreshToken
    string

    RefreshToken: Required by GoogleBigQuery, GoogleAdWords, Hubspot, QuickBooks, Square, Xero, Zoho where user needs to get RefreshToken offline

    tenantId
    string

    TenantId: Required by QuickBooks and Xero connection categories

    username
    string

    Username: Concur, ServiceNow auth server AccessToken grant type is ‘Password’ which requires UsernamePassword

    WorkspaceConnectionOAuth2_STATUS

    (Appears on:OAuth2AuthTypeWorkspaceConnectionProperties_STATUS)

    ClientId and ClientSecret are required. Other properties are optional depending on each OAuth2 provider’s implementation.

    Field Description
    authUrl
    string

    AuthUrl: Required by Concur connection category

    clientId
    string

    ClientId: Client id in the format of UUID

    tenantId
    string

    TenantId: Required by QuickBooks and Xero connection categories

    username
    string

    Username: Concur, ServiceNow auth server AccessToken grant type is ‘Password’ which requires UsernamePassword

    WorkspaceConnectionOAuth2_STATUS_ARM

    (Appears on:OAuth2AuthTypeWorkspaceConnectionProperties_STATUS_ARM)

    ClientId and ClientSecret are required. Other properties are optional depending on each OAuth2 provider’s implementation.

    Field Description
    authUrl
    string

    AuthUrl: Required by Concur connection category

    clientId
    string

    ClientId: Client id in the format of UUID

    tenantId
    string

    TenantId: Required by QuickBooks and Xero connection categories

    username
    string

    Username: Concur, ServiceNow auth server AccessToken grant type is ‘Password’ which requires UsernamePassword

    WorkspaceConnectionPersonalAccessToken

    (Appears on:PATAuthTypeWorkspaceConnectionProperties)

    Field Description
    pat
    genruntime.SecretReference

    WorkspaceConnectionPersonalAccessToken_ARM

    (Appears on:PATAuthTypeWorkspaceConnectionProperties_ARM)

    Field Description
    pat
    string

    WorkspaceConnectionPersonalAccessToken_STATUS

    (Appears on:PATAuthTypeWorkspaceConnectionProperties_STATUS)

    WorkspaceConnectionPersonalAccessToken_STATUS_ARM

    (Appears on:PATAuthTypeWorkspaceConnectionProperties_STATUS_ARM)

    WorkspaceConnectionPropertiesV2

    (Appears on:Workspaces_Connection_Spec)

    Field Description
    aad
    AADAuthTypeWorkspaceConnectionProperties

    AAD: Mutually exclusive with all other properties

    accessKey
    AccessKeyAuthTypeWorkspaceConnectionProperties

    AccessKey: Mutually exclusive with all other properties

    accountKey
    AccountKeyAuthTypeWorkspaceConnectionProperties

    AccountKey: Mutually exclusive with all other properties

    apiKey
    ApiKeyAuthWorkspaceConnectionProperties

    ApiKey: Mutually exclusive with all other properties

    customKeys
    CustomKeysWorkspaceConnectionProperties

    CustomKeys: Mutually exclusive with all other properties

    managedIdentity
    ManagedIdentityAuthTypeWorkspaceConnectionProperties

    ManagedIdentity: Mutually exclusive with all other properties

    none
    NoneAuthTypeWorkspaceConnectionProperties

    None: Mutually exclusive with all other properties

    oAuth2
    OAuth2AuthTypeWorkspaceConnectionProperties

    OAuth2: Mutually exclusive with all other properties

    pat
    PATAuthTypeWorkspaceConnectionProperties

    PAT: Mutually exclusive with all other properties

    sas
    SASAuthTypeWorkspaceConnectionProperties

    SAS: Mutually exclusive with all other properties

    servicePrincipal
    ServicePrincipalAuthTypeWorkspaceConnectionProperties

    ServicePrincipal: Mutually exclusive with all other properties

    usernamePassword
    UsernamePasswordAuthTypeWorkspaceConnectionProperties

    UsernamePassword: Mutually exclusive with all other properties

    WorkspaceConnectionPropertiesV2_ARM

    (Appears on:Workspaces_Connection_Spec_ARM)

    Field Description
    aad
    AADAuthTypeWorkspaceConnectionProperties_ARM

    AAD: Mutually exclusive with all other properties

    accessKey
    AccessKeyAuthTypeWorkspaceConnectionProperties_ARM

    AccessKey: Mutually exclusive with all other properties

    accountKey
    AccountKeyAuthTypeWorkspaceConnectionProperties_ARM

    AccountKey: Mutually exclusive with all other properties

    apiKey
    ApiKeyAuthWorkspaceConnectionProperties_ARM

    ApiKey: Mutually exclusive with all other properties

    customKeys
    CustomKeysWorkspaceConnectionProperties_ARM

    CustomKeys: Mutually exclusive with all other properties

    managedIdentity
    ManagedIdentityAuthTypeWorkspaceConnectionProperties_ARM

    ManagedIdentity: Mutually exclusive with all other properties

    none
    NoneAuthTypeWorkspaceConnectionProperties_ARM

    None: Mutually exclusive with all other properties

    oAuth2
    OAuth2AuthTypeWorkspaceConnectionProperties_ARM

    OAuth2: Mutually exclusive with all other properties

    pat
    PATAuthTypeWorkspaceConnectionProperties_ARM

    PAT: Mutually exclusive with all other properties

    sas
    SASAuthTypeWorkspaceConnectionProperties_ARM

    SAS: Mutually exclusive with all other properties

    servicePrincipal
    ServicePrincipalAuthTypeWorkspaceConnectionProperties_ARM

    ServicePrincipal: Mutually exclusive with all other properties

    usernamePassword
    UsernamePasswordAuthTypeWorkspaceConnectionProperties_ARM

    UsernamePassword: Mutually exclusive with all other properties

    WorkspaceConnectionPropertiesV2_STATUS

    (Appears on:Workspaces_Connection_STATUS)

    Field Description
    aad
    AADAuthTypeWorkspaceConnectionProperties_STATUS

    AAD: Mutually exclusive with all other properties

    accessKey
    AccessKeyAuthTypeWorkspaceConnectionProperties_STATUS

    AccessKey: Mutually exclusive with all other properties

    accountKey
    AccountKeyAuthTypeWorkspaceConnectionProperties_STATUS

    AccountKey: Mutually exclusive with all other properties

    apiKey
    ApiKeyAuthWorkspaceConnectionProperties_STATUS

    ApiKey: Mutually exclusive with all other properties

    customKeys
    CustomKeysWorkspaceConnectionProperties_STATUS

    CustomKeys: Mutually exclusive with all other properties

    managedIdentity
    ManagedIdentityAuthTypeWorkspaceConnectionProperties_STATUS

    ManagedIdentity: Mutually exclusive with all other properties

    none
    NoneAuthTypeWorkspaceConnectionProperties_STATUS

    None: Mutually exclusive with all other properties

    oAuth2
    OAuth2AuthTypeWorkspaceConnectionProperties_STATUS

    OAuth2: Mutually exclusive with all other properties

    pat
    PATAuthTypeWorkspaceConnectionProperties_STATUS

    PAT: Mutually exclusive with all other properties

    sas
    SASAuthTypeWorkspaceConnectionProperties_STATUS

    SAS: Mutually exclusive with all other properties

    servicePrincipal
    ServicePrincipalAuthTypeWorkspaceConnectionProperties_STATUS

    ServicePrincipal: Mutually exclusive with all other properties

    usernamePassword
    UsernamePasswordAuthTypeWorkspaceConnectionProperties_STATUS

    UsernamePassword: Mutually exclusive with all other properties

    WorkspaceConnectionPropertiesV2_STATUS_ARM

    (Appears on:Workspaces_Connection_STATUS_ARM)

    Field Description
    aad
    AADAuthTypeWorkspaceConnectionProperties_STATUS_ARM

    AAD: Mutually exclusive with all other properties

    accessKey
    AccessKeyAuthTypeWorkspaceConnectionProperties_STATUS_ARM

    AccessKey: Mutually exclusive with all other properties

    accountKey
    AccountKeyAuthTypeWorkspaceConnectionProperties_STATUS_ARM

    AccountKey: Mutually exclusive with all other properties

    apiKey
    ApiKeyAuthWorkspaceConnectionProperties_STATUS_ARM

    ApiKey: Mutually exclusive with all other properties

    customKeys
    CustomKeysWorkspaceConnectionProperties_STATUS_ARM

    CustomKeys: Mutually exclusive with all other properties

    managedIdentity
    ManagedIdentityAuthTypeWorkspaceConnectionProperties_STATUS_ARM

    ManagedIdentity: Mutually exclusive with all other properties

    none
    NoneAuthTypeWorkspaceConnectionProperties_STATUS_ARM

    None: Mutually exclusive with all other properties

    oAuth2
    OAuth2AuthTypeWorkspaceConnectionProperties_STATUS_ARM

    OAuth2: Mutually exclusive with all other properties

    pat
    PATAuthTypeWorkspaceConnectionProperties_STATUS_ARM

    PAT: Mutually exclusive with all other properties

    sas
    SASAuthTypeWorkspaceConnectionProperties_STATUS_ARM

    SAS: Mutually exclusive with all other properties

    servicePrincipal
    ServicePrincipalAuthTypeWorkspaceConnectionProperties_STATUS_ARM

    ServicePrincipal: Mutually exclusive with all other properties

    usernamePassword
    UsernamePasswordAuthTypeWorkspaceConnectionProperties_STATUS_ARM

    UsernamePassword: Mutually exclusive with all other properties

    WorkspaceConnectionServicePrincipal

    (Appears on:ServicePrincipalAuthTypeWorkspaceConnectionProperties)

    Field Description
    clientId
    string
    clientIdFromConfig
    genruntime.ConfigMapReference
    clientSecret
    genruntime.SecretReference
    tenantId
    string
    tenantIdFromConfig
    genruntime.ConfigMapReference

    WorkspaceConnectionServicePrincipal_ARM

    (Appears on:ServicePrincipalAuthTypeWorkspaceConnectionProperties_ARM)

    Field Description
    clientId
    string
    clientSecret
    string
    tenantId
    string

    WorkspaceConnectionServicePrincipal_STATUS

    (Appears on:ServicePrincipalAuthTypeWorkspaceConnectionProperties_STATUS)

    Field Description
    clientId
    string
    tenantId
    string

    WorkspaceConnectionServicePrincipal_STATUS_ARM

    (Appears on:ServicePrincipalAuthTypeWorkspaceConnectionProperties_STATUS_ARM)

    Field Description
    clientId
    string
    tenantId
    string

    WorkspaceConnectionSharedAccessSignature

    (Appears on:SASAuthTypeWorkspaceConnectionProperties)

    Field Description
    sas
    genruntime.SecretReference

    WorkspaceConnectionSharedAccessSignature_ARM

    (Appears on:SASAuthTypeWorkspaceConnectionProperties_ARM)

    Field Description
    sas
    string

    WorkspaceConnectionSharedAccessSignature_STATUS

    (Appears on:SASAuthTypeWorkspaceConnectionProperties_STATUS)

    WorkspaceConnectionSharedAccessSignature_STATUS_ARM

    (Appears on:SASAuthTypeWorkspaceConnectionProperties_STATUS_ARM)

    WorkspaceConnectionUsernamePassword

    (Appears on:UsernamePasswordAuthTypeWorkspaceConnectionProperties)

    Field Description
    password
    genruntime.SecretReference
    securityToken
    genruntime.SecretReference

    SecurityToken: Optional, required by connections like SalesForce for extra security in addition to UsernamePassword

    username
    string

    WorkspaceConnectionUsernamePassword_ARM

    (Appears on:UsernamePasswordAuthTypeWorkspaceConnectionProperties_ARM)

    Field Description
    password
    string
    securityToken
    string

    SecurityToken: Optional, required by connections like SalesForce for extra security in addition to UsernamePassword

    username
    string

    WorkspaceConnectionUsernamePassword_STATUS

    (Appears on:UsernamePasswordAuthTypeWorkspaceConnectionProperties_STATUS)

    Field Description
    username
    string

    WorkspaceConnectionUsernamePassword_STATUS_ARM

    (Appears on:UsernamePasswordAuthTypeWorkspaceConnectionProperties_STATUS_ARM)

    Field Description
    username
    string

    WorkspaceHubConfig

    (Appears on:Workspace_Spec)

    WorkspaceHub’s configuration object.

    Field Description
    additionalWorkspaceStorageAccounts
    []string
    defaultWorkspaceResourceGroup
    string

    WorkspaceHubConfig_ARM

    (Appears on:WorkspaceProperties_ARM)

    WorkspaceHub’s configuration object.

    Field Description
    additionalWorkspaceStorageAccounts
    []string
    defaultWorkspaceResourceGroup
    string

    WorkspaceHubConfig_STATUS

    (Appears on:Workspace_STATUS)

    WorkspaceHub’s configuration object.

    Field Description
    additionalWorkspaceStorageAccounts
    []string
    defaultWorkspaceResourceGroup
    string

    WorkspaceHubConfig_STATUS_ARM

    (Appears on:WorkspaceProperties_STATUS_ARM)

    WorkspaceHub’s configuration object.

    Field Description
    additionalWorkspaceStorageAccounts
    []string
    defaultWorkspaceResourceGroup
    string

    WorkspaceOperatorSecrets

    (Appears on:WorkspaceOperatorSpec)

    Field Description
    appInsightsInstrumentationKey
    genruntime.SecretDestination

    AppInsightsInstrumentationKey: indicates where the AppInsightsInstrumentationKey secret should be placed. If omitted, the secret will not be retrieved from Azure.

    containerRegistryPassword
    genruntime.SecretDestination

    ContainerRegistryPassword: indicates where the ContainerRegistryPassword secret should be placed. If omitted, the secret will not be retrieved from Azure.

    containerRegistryPassword2
    genruntime.SecretDestination

    ContainerRegistryPassword2: indicates where the ContainerRegistryPassword2 secret should be placed. If omitted, the secret will not be retrieved from Azure.

    containerRegistryUserName
    genruntime.SecretDestination

    ContainerRegistryUserName: indicates where the ContainerRegistryUserName secret should be placed. If omitted, the secret will not be retrieved from Azure.

    primaryNotebookAccessKey
    genruntime.SecretDestination

    PrimaryNotebookAccessKey: indicates where the PrimaryNotebookAccessKey secret should be placed. If omitted, the secret will not be retrieved from Azure.

    secondaryNotebookAccessKey
    genruntime.SecretDestination

    SecondaryNotebookAccessKey: indicates where the SecondaryNotebookAccessKey secret should be placed. If omitted, the secret will not be retrieved from Azure.

    userStorageKey
    genruntime.SecretDestination

    UserStorageKey: indicates where the UserStorageKey secret should be placed. If omitted, the secret will not be retrieved from Azure.

    WorkspaceOperatorSpec

    (Appears on:Workspace_Spec)

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

    Field Description
    secrets
    WorkspaceOperatorSecrets

    Secrets: configures where to place Azure generated secrets.

    WorkspaceProperties_ARM

    (Appears on:Workspace_Spec_ARM)

    The properties of a machine learning workspace.

    Field Description
    allowPublicAccessWhenBehindVnet
    bool

    AllowPublicAccessWhenBehindVnet: The flag to indicate whether to allow public access when behind VNet.

    applicationInsights
    string
    associatedWorkspaces
    []string
    containerRegistry
    string
    description
    string

    Description: The description of this workspace.

    discoveryUrl
    string

    DiscoveryUrl: Url for the discovery service to identify regional endpoints for machine learning experimentation services

    enableDataIsolation
    bool
    encryption
    EncryptionProperty_ARM

    Encryption: The encryption settings of Azure ML workspace.

    featureStoreSettings
    FeatureStoreSettings_ARM

    FeatureStoreSettings: Settings for feature store type workspace.

    friendlyName
    string

    FriendlyName: The friendly name for this workspace. This name in mutable

    hbiWorkspace
    bool

    HbiWorkspace: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service

    hubResourceId
    string
    imageBuildCompute
    string

    ImageBuildCompute: The compute name for image build

    keyVault
    string
    managedNetwork
    ManagedNetworkSettings_ARM

    ManagedNetwork: Managed Network settings for a machine learning workspace.

    primaryUserAssignedIdentity
    string
    publicNetworkAccess
    WorkspaceProperties_PublicNetworkAccess_ARM

    PublicNetworkAccess: Whether requests from Public Network are allowed.

    serverlessComputeSettings
    ServerlessComputeSettings_ARM

    ServerlessComputeSettings: Settings for serverless compute created in the workspace

    serviceManagedResourcesSettings
    ServiceManagedResourcesSettings_ARM

    ServiceManagedResourcesSettings: The service managed resource settings.

    sharedPrivateLinkResources
    []SharedPrivateLinkResource_ARM

    SharedPrivateLinkResources: The list of shared private link resources in this workspace.

    storageAccount
    string
    v1LegacyMode
    bool

    V1LegacyMode: Enabling v1_legacy_mode may prevent you from using features provided by the v2 API.

    workspaceHubConfig
    WorkspaceHubConfig_ARM

    WorkspaceHubConfig: WorkspaceHub’s configuration object.

    WorkspaceProperties_ProvisioningState_STATUS (string alias)

    (Appears on:Workspace_STATUS)

    Value Description

    "Canceled"

    "Creating"

    "Deleting"

    "Failed"

    "Succeeded"

    "Unknown"

    "Updating"

    WorkspaceProperties_ProvisioningState_STATUS_ARM (string alias)

    (Appears on:WorkspaceProperties_STATUS_ARM)

    Value Description

    "Canceled"

    "Creating"

    "Deleting"

    "Failed"

    "Succeeded"

    "Unknown"

    "Updating"

    WorkspaceProperties_PublicNetworkAccess (string alias)

    (Appears on:Workspace_Spec)

    Value Description

    "Disabled"

    "Enabled"

    WorkspaceProperties_PublicNetworkAccess_ARM (string alias)

    (Appears on:WorkspaceProperties_ARM)

    Value Description

    "Disabled"

    "Enabled"

    WorkspaceProperties_PublicNetworkAccess_STATUS (string alias)

    (Appears on:Workspace_STATUS)

    Value Description

    "Disabled"

    "Enabled"

    WorkspaceProperties_PublicNetworkAccess_STATUS_ARM (string alias)

    (Appears on:WorkspaceProperties_STATUS_ARM)

    Value Description

    "Disabled"

    "Enabled"

    WorkspaceProperties_STATUS_ARM

    (Appears on:Workspace_STATUS_ARM)

    The properties of a machine learning workspace.

    Field Description
    allowPublicAccessWhenBehindVnet
    bool

    AllowPublicAccessWhenBehindVnet: The flag to indicate whether to allow public access when behind VNet.

    applicationInsights
    string

    ApplicationInsights: ARM id of the application insights associated with this workspace.

    associatedWorkspaces
    []string
    containerRegistry
    string

    ContainerRegistry: ARM id of the container registry associated with this workspace.

    description
    string

    Description: The description of this workspace.

    discoveryUrl
    string

    DiscoveryUrl: Url for the discovery service to identify regional endpoints for machine learning experimentation services

    enableDataIsolation
    bool
    encryption
    EncryptionProperty_STATUS_ARM

    Encryption: The encryption settings of Azure ML workspace.

    featureStoreSettings
    FeatureStoreSettings_STATUS_ARM

    FeatureStoreSettings: Settings for feature store type workspace.

    friendlyName
    string

    FriendlyName: The friendly name for this workspace. This name in mutable

    hbiWorkspace
    bool

    HbiWorkspace: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service

    hubResourceId
    string
    imageBuildCompute
    string

    ImageBuildCompute: The compute name for image build

    keyVault
    string

    KeyVault: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created

    managedNetwork
    ManagedNetworkSettings_STATUS_ARM

    ManagedNetwork: Managed Network settings for a machine learning workspace.

    mlFlowTrackingUri
    string

    MlFlowTrackingUri: The URI associated with this workspace that machine learning flow must point at to set up tracking.

    notebookInfo
    NotebookResourceInfo_STATUS_ARM

    NotebookInfo: The notebook info of Azure ML workspace.

    primaryUserAssignedIdentity
    string

    PrimaryUserAssignedIdentity: The user assigned identity resource id that represents the workspace identity.

    privateEndpointConnections
    []PrivateEndpointConnection_STATUS_ARM

    PrivateEndpointConnections: The list of private endpoint connections in the workspace.

    privateLinkCount
    int

    PrivateLinkCount: Count of private connections in the workspace

    provisioningState
    WorkspaceProperties_ProvisioningState_STATUS_ARM

    ProvisioningState: The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning.

    publicNetworkAccess
    WorkspaceProperties_PublicNetworkAccess_STATUS_ARM

    PublicNetworkAccess: Whether requests from Public Network are allowed.

    serverlessComputeSettings
    ServerlessComputeSettings_STATUS_ARM

    ServerlessComputeSettings: Settings for serverless compute created in the workspace

    serviceManagedResourcesSettings
    ServiceManagedResourcesSettings_STATUS_ARM

    ServiceManagedResourcesSettings: The service managed resource settings.

    serviceProvisionedResourceGroup
    string

    ServiceProvisionedResourceGroup: The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace

    sharedPrivateLinkResources
    []SharedPrivateLinkResource_STATUS_ARM

    SharedPrivateLinkResources: The list of shared private link resources in this workspace.

    storageAccount
    string

    StorageAccount: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created

    storageHnsEnabled
    bool

    StorageHnsEnabled: If the storage associated with the workspace has hierarchical namespace(HNS) enabled.

    tenantId
    string

    TenantId: The tenant id associated with this workspace.

    v1LegacyMode
    bool

    V1LegacyMode: Enabling v1_legacy_mode may prevent you from using features provided by the v2 API.

    workspaceHubConfig
    WorkspaceHubConfig_STATUS_ARM

    WorkspaceHubConfig: WorkspaceHub’s configuration object.

    workspaceId
    string

    WorkspaceId: The immutable id associated with this workspace.

    Workspace_STATUS

    (Appears on:Workspace)

    An object that represents a machine learning workspace.

    Field Description
    allowPublicAccessWhenBehindVnet
    bool

    AllowPublicAccessWhenBehindVnet: The flag to indicate whether to allow public access when behind VNet.

    applicationInsights
    string

    ApplicationInsights: ARM id of the application insights associated with this workspace.

    associatedWorkspaces
    []string
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    containerRegistry
    string

    ContainerRegistry: ARM id of the container registry associated with this workspace.

    description
    string

    Description: The description of this workspace.

    discoveryUrl
    string

    DiscoveryUrl: Url for the discovery service to identify regional endpoints for machine learning experimentation services

    enableDataIsolation
    bool
    encryption
    EncryptionProperty_STATUS

    Encryption: The encryption settings of Azure ML workspace.

    featureStoreSettings
    FeatureStoreSettings_STATUS

    FeatureStoreSettings: Settings for feature store type workspace.

    friendlyName
    string

    FriendlyName: The friendly name for this workspace. This name in mutable

    hbiWorkspace
    bool

    HbiWorkspace: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service

    hubResourceId
    string
    id
    string

    Id: Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}

    identity
    ManagedServiceIdentity_STATUS

    Identity: The identity of the resource.

    imageBuildCompute
    string

    ImageBuildCompute: The compute name for image build

    keyVault
    string

    KeyVault: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created

    kind
    string
    location
    string

    Location: Specifies the location of the resource.

    managedNetwork
    ManagedNetworkSettings_STATUS

    ManagedNetwork: Managed Network settings for a machine learning workspace.

    mlFlowTrackingUri
    string

    MlFlowTrackingUri: The URI associated with this workspace that machine learning flow must point at to set up tracking.

    name
    string

    Name: The name of the resource

    notebookInfo
    NotebookResourceInfo_STATUS

    NotebookInfo: The notebook info of Azure ML workspace.

    primaryUserAssignedIdentity
    string

    PrimaryUserAssignedIdentity: The user assigned identity resource id that represents the workspace identity.

    privateEndpointConnections
    []PrivateEndpointConnection_STATUS

    PrivateEndpointConnections: The list of private endpoint connections in the workspace.

    privateLinkCount
    int

    PrivateLinkCount: Count of private connections in the workspace

    provisioningState
    WorkspaceProperties_ProvisioningState_STATUS

    ProvisioningState: The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning.

    publicNetworkAccess
    WorkspaceProperties_PublicNetworkAccess_STATUS

    PublicNetworkAccess: Whether requests from Public Network are allowed.

    serverlessComputeSettings
    ServerlessComputeSettings_STATUS

    ServerlessComputeSettings: Settings for serverless compute created in the workspace

    serviceManagedResourcesSettings
    ServiceManagedResourcesSettings_STATUS

    ServiceManagedResourcesSettings: The service managed resource settings.

    serviceProvisionedResourceGroup
    string

    ServiceProvisionedResourceGroup: The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace

    sharedPrivateLinkResources
    []SharedPrivateLinkResource_STATUS

    SharedPrivateLinkResources: The list of shared private link resources in this workspace.

    sku
    Sku_STATUS

    Sku: The sku of the workspace.

    storageAccount
    string

    StorageAccount: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created

    storageHnsEnabled
    bool

    StorageHnsEnabled: If the storage associated with the workspace has hierarchical namespace(HNS) enabled.

    systemData
    SystemData_STATUS

    SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information.

    tags
    map[string]string

    Tags: Contains resource tags defined as key/value pairs.

    tenantId
    string

    TenantId: The tenant id associated with this workspace.

    type
    string

    Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

    v1LegacyMode
    bool

    V1LegacyMode: Enabling v1_legacy_mode may prevent you from using features provided by the v2 API.

    workspaceHubConfig
    WorkspaceHubConfig_STATUS

    WorkspaceHubConfig: WorkspaceHub’s configuration object.

    workspaceId
    string

    WorkspaceId: The immutable id associated with this workspace.

    Workspace_STATUS_ARM

    An object that represents a machine learning workspace.

    Field Description
    id
    string

    Id: Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}

    identity
    ManagedServiceIdentity_STATUS_ARM

    Identity: The identity of the resource.

    kind
    string
    location
    string

    Location: Specifies the location of the resource.

    name
    string

    Name: The name of the resource

    properties
    WorkspaceProperties_STATUS_ARM

    Properties: The properties of the machine learning workspace.

    sku
    Sku_STATUS_ARM

    Sku: The sku of the workspace.

    systemData
    SystemData_STATUS_ARM

    SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information.

    tags
    map[string]string

    Tags: Contains resource tags defined as key/value pairs.

    type
    string

    Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

    Workspace_Spec

    (Appears on:Workspace)

    Field Description
    allowPublicAccessWhenBehindVnet
    bool

    AllowPublicAccessWhenBehindVnet: The flag to indicate whether to allow public access when behind VNet.

    applicationInsightsReference
    genruntime.ResourceReference

    ApplicationInsightsReference: ARM id of the application insights associated with this workspace.

    associatedWorkspaces
    []string
    azureName
    string

    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.

    containerRegistryReference
    genruntime.ResourceReference

    ContainerRegistryReference: ARM id of the container registry associated with this workspace.

    description
    string

    Description: The description of this workspace.

    discoveryUrl
    string

    DiscoveryUrl: Url for the discovery service to identify regional endpoints for machine learning experimentation services

    enableDataIsolation
    bool
    encryption
    EncryptionProperty

    Encryption: The encryption settings of Azure ML workspace.

    featureStoreSettings
    FeatureStoreSettings

    FeatureStoreSettings: Settings for feature store type workspace.

    friendlyName
    string

    FriendlyName: The friendly name for this workspace. This name in mutable

    hbiWorkspace
    bool

    HbiWorkspace: The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service

    hubResourceReference
    genruntime.ResourceReference
    identity
    ManagedServiceIdentity

    Identity: The identity of the resource.

    imageBuildCompute
    string

    ImageBuildCompute: The compute name for image build

    keyVaultReference
    genruntime.ResourceReference

    KeyVaultReference: ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created

    kind
    string
    location
    string

    Location: Specifies the location of the resource.

    managedNetwork
    ManagedNetworkSettings

    ManagedNetwork: Managed Network settings for a machine learning workspace.

    operatorSpec
    WorkspaceOperatorSpec

    OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure

    owner
    genruntime.KnownResourceReference

    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

    primaryUserAssignedIdentityReference
    genruntime.ResourceReference

    PrimaryUserAssignedIdentityReference: The user assigned identity resource id that represents the workspace identity.

    publicNetworkAccess
    WorkspaceProperties_PublicNetworkAccess

    PublicNetworkAccess: Whether requests from Public Network are allowed.

    serverlessComputeSettings
    ServerlessComputeSettings

    ServerlessComputeSettings: Settings for serverless compute created in the workspace

    serviceManagedResourcesSettings
    ServiceManagedResourcesSettings

    ServiceManagedResourcesSettings: The service managed resource settings.

    sharedPrivateLinkResources
    []SharedPrivateLinkResource

    SharedPrivateLinkResources: The list of shared private link resources in this workspace.

    sku
    Sku

    Sku: The sku of the workspace.

    storageAccountReference
    genruntime.ResourceReference

    StorageAccountReference: ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created

    tags
    map[string]string

    Tags: Contains resource tags defined as key/value pairs.

    v1LegacyMode
    bool

    V1LegacyMode: Enabling v1_legacy_mode may prevent you from using features provided by the v2 API.

    workspaceHubConfig
    WorkspaceHubConfig

    WorkspaceHubConfig: WorkspaceHub’s configuration object.

    Workspace_Spec_ARM

    Field Description
    identity
    ManagedServiceIdentity_ARM

    Identity: The identity of the resource.

    kind
    string
    location
    string

    Location: Specifies the location of the resource.

    name
    string
    properties
    WorkspaceProperties_ARM

    Properties: The properties of the machine learning workspace.

    sku
    Sku_ARM

    Sku: The sku of the workspace.

    tags
    map[string]string

    Tags: Contains resource tags defined as key/value pairs.

    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}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    Workspaces_Compute_Spec


    azureName
    string

    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.

    identity
    ManagedServiceIdentity

    Identity: The identity of the resource.

    location
    string

    Location: Specifies the location of the resource.

    owner
    genruntime.KnownResourceReference

    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

    properties
    Compute

    Properties: Compute properties

    sku
    Sku

    Sku: The sku of the workspace.

    tags
    map[string]string

    Tags: Contains resource tags defined as key/value pairs.

    status
    Workspaces_Compute_STATUS

    WorkspacesConnection

    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}/​connections/​{connectionName}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    Workspaces_Connection_Spec


    azureName
    string

    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.

    owner
    genruntime.KnownResourceReference

    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

    properties
    WorkspaceConnectionPropertiesV2
    status
    Workspaces_Connection_STATUS

    Workspaces_Compute_STATUS

    (Appears on:WorkspacesCompute)

    Field Description
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    id
    string

    Id: Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}

    identity
    ManagedServiceIdentity_STATUS

    Identity: The identity of the resource.

    location
    string

    Location: Specifies the location of the resource.

    name
    string

    Name: The name of the resource

    properties
    Compute_STATUS

    Properties: Compute properties

    sku
    Sku_STATUS

    Sku: The sku of the workspace.

    systemData
    SystemData_STATUS

    SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information.

    tags
    map[string]string

    Tags: Contains resource tags defined as key/value pairs.

    type
    string

    Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

    Workspaces_Compute_STATUS_ARM

    Field Description
    id
    string

    Id: Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}

    identity
    ManagedServiceIdentity_STATUS_ARM

    Identity: The identity of the resource.

    location
    string

    Location: Specifies the location of the resource.

    name
    string

    Name: The name of the resource

    properties
    Compute_STATUS_ARM

    Properties: Compute properties

    sku
    Sku_STATUS_ARM

    Sku: The sku of the workspace.

    systemData
    SystemData_STATUS_ARM

    SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information.

    tags
    map[string]string

    Tags: Contains resource tags defined as key/value pairs.

    type
    string

    Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

    Workspaces_Compute_Spec

    (Appears on:WorkspacesCompute)

    Field Description
    azureName
    string

    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.

    identity
    ManagedServiceIdentity

    Identity: The identity of the resource.

    location
    string

    Location: Specifies the location of the resource.

    owner
    genruntime.KnownResourceReference

    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

    properties
    Compute

    Properties: Compute properties

    sku
    Sku

    Sku: The sku of the workspace.

    tags
    map[string]string

    Tags: Contains resource tags defined as key/value pairs.

    Workspaces_Compute_Spec_ARM

    Field Description
    identity
    ManagedServiceIdentity_ARM

    Identity: The identity of the resource.

    location
    string

    Location: Specifies the location of the resource.

    name
    string
    properties
    Compute_ARM

    Properties: Compute properties

    sku
    Sku_ARM

    Sku: The sku of the workspace.

    tags
    map[string]string

    Tags: Contains resource tags defined as key/value pairs.

    Workspaces_Connection_STATUS

    (Appears on:WorkspacesConnection)

    Field Description
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    id
    string

    Id: Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}

    name
    string

    Name: The name of the resource

    properties
    WorkspaceConnectionPropertiesV2_STATUS
    systemData
    SystemData_STATUS

    SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information.

    type
    string

    Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

    Workspaces_Connection_STATUS_ARM

    Field Description
    id
    string

    Id: Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}

    name
    string

    Name: The name of the resource

    properties
    WorkspaceConnectionPropertiesV2_STATUS_ARM
    systemData
    SystemData_STATUS_ARM

    SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information.

    type
    string

    Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

    Workspaces_Connection_Spec

    (Appears on:WorkspacesConnection)

    Field Description
    azureName
    string

    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.

    owner
    genruntime.KnownResourceReference

    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

    properties
    WorkspaceConnectionPropertiesV2

    Workspaces_Connection_Spec_ARM

    Field Description
    name
    string
    properties
    WorkspaceConnectionPropertiesV2_ARM