azure.azcollection.azure_rm_ml_workspace module – Create, Update or Delete an Azure Machine Learning Workspace

ad_user

string

Active Directory username. Use when authenticating with an Active Directory user rather than service principal.

adfs_authority_url

string

added in azure.azcollection 0.0.1

Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.

all_resources

boolean

Only applies to state=absent. Delete all the dependent resources associated with the workspace (Azure Storage account, Azure Container Registry, Azure Application Insights, Azure Key Vault).

Choices:

• false ← (default)
• true

allow_roleassignment_on_rg

boolean

A flag to determine if a workspace could have role assignments on resource group level.

Choices:

• false
• true ← (default)

api_profile

string

added in azure.azcollection 0.0.1

Selects an API profile to use when communicating with Azure services. Default value of latest is appropriate for public clouds; future values will allow use with Azure Stack.

Default: "latest"

append_tags

boolean

Use to control if tags field is canonical or just appends to existing tags.

When canonical, any tags not found in the tags parameter will be removed from the object’s metadata.

Choices:

• false
• true ← (default)

application_insights

string

ARM id of the application insights associated with this workspace.

auth_source

string

added in azure.azcollection 0.0.1

Controls the source of the credentials to use for authentication.

Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable.

When set to auto (the default) the precedence is module parameters -> env -> credential_file -> cli.

When set to env, the credentials will be read from the environment variables.

When set to credential_file, it will read the profile from ~/.azure/credentials.

When set to cli, the credentials will be sources from the Azure CLI profile. subscription_id or the environment variable AZURE_SUBSCRIPTION_ID can be used to identify the subscription ID if more than one is present otherwise the default az cli subscription is used.

When set to msi, the host machine must be an azure resource with an enabled MSI extension. subscription_id or the environment variable AZURE_SUBSCRIPTION_ID can be used to identify the subscription ID if the resource is granted access to more than one subscription, otherwise the first subscription is chosen.

The msi was added in Ansible 2.6.

Choices:

• "auto" ← (default)
• "cli"
• "credential_file"
• "env"
• "msi"

cert_validation_mode

string

added in azure.azcollection 0.0.1

Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing ignore. Can also be set via credential file profile or the AZURE_CERT_VALIDATION environment variable.

Choices:

• "ignore"
• "validate"

client_id

string

Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi).

Can also be set via the AZURE_CLIENT_ID environment variable.

cloud_environment

string

added in azure.azcollection 0.0.1

For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, AzureChinaCloud, AzureUSGovernment), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the AZURE_CLOUD_ENVIRONMENT environment variable.

Default: "AzureCloud"

container_registry

string

ARM id of the container registry associated with this workspace.

default_resource_group

string

Only applies to kind=hub. If set, then child projects of this hub will have their resource group set this by default.

description

string

Description of the Azure ML workspace.

disable_instance_discovery

boolean

added in azure.azcollection 2.3.0

Determines whether or not instance discovery is performed when attempting to authenticate. Setting this to true will completely disable both instance discovery and authority validation. This functionality is intended for use in scenarios where the metadata endpoint cannot be reached such as in private clouds or Azure Stack. The process of instance discovery entails retrieving authority metadata from https://login.microsoft.com/ to validate the authority. By setting this to **True**, the validation of the authority is disabled. As a result, it is crucial to ensure that the configured authority host is valid and trustworthy.

Set via credential file profile or the AZURE_DISABLE_INSTANCE_DISCOVERY environment variable.

Choices:

• false ← (default)
• true

display_name

string

Display name for the workspace.

enable_data_isolation

boolean

A flag to determine if a workspace has data isolation enabled. The flag can only be set at the creation stage, it can’t be updated.

Choices:

• false ← (default)
• true

hub_id

string

Only applies to kind=Project. An ARM ID which defines the parent hub of this project.

image_build_compute

string

The name of the compute target to use for building environment Docker images when the container registry is behind a VNet.

key_vault

string

ARM id of the key vault associated with this workspace.

kind

string

Specifies the workspace as a specific kind.

Choices:

• "hub"
• "project"

location

string

The location to be used for the new workspace.

log_mode

string

Parent argument.

log_path

string

Parent argument.

managed_network

string

Managed Network Isolation Mode for the workspace.

Choices:

• "disabled"
• "allow_internet_outbound"
• "allow_only_approved_outbound"

name

string / required

Name of the Azure ML workspace.

network_acls

list / elements=string

List of inbound IP rules

oidc_token

string

added in azure.azcollection 3.17.0

Direct OpenID Connect (OIDC) token (JWT) used for workload identity authentication.

This token is exchanged with Azure AD using OIDC federated identity.

Useful in CI systems (for example GitHub Actions, Azure DevOps) where an OIDC token is provided directly by the platform.

Can also be set via the AZURE_FEDERATED_TOKEN environment variable.

oidc_token_file_path

path

added in azure.azcollection 3.17.0

Path to a file containing an OpenID Connect (OIDC) token (JWT) used for workload identity authentication.

The file must contain only raw token.

This method is commonly used in platforms that materialize OIDC tokens as files

Can also be set via the AZURE_FEDERATED_TOKEN_FILE environment variable.

password

string

Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.

permanently_delete

boolean

Only applies to state=absent. Workspaces are soft-deleted state by default to allow recovery of workspace data. Set this flag to override the soft-delete behavior and permanently delete your workspace.

Choices:

• false ← (default)
• true

primary_user_assigned_identity

string

ARM identifier of primary user assigned managed identity, in case multiple ones are specified. Also the default managed identity for clusterless compute.

profile

string

Security profile found in ~/.azure/credentials file.

provision_network_now

boolean

Set to trigger the provisioning of the managed network when creating a worksapce with the manged network enabled, or else it does nothing.

Choices:

• false ← (default)
• true

public_network_access

string

Allow public endpoint connectivity when a workspace is private link enabled.

Choices:

• "Disabled" ← (default)
• "Enabled"

resource_definition

string

Workspace definition in YAML

resource_group

string / required

Name of resource group.

secret

string

Azure client secret. Use when authenticating with a Service Principal.

state

string

State of the Workspace. Use present to create or update and absent to delete.

Choices:

• "absent"
• "present" ← (default)

storage_account

string

ARM id of the storage account associated with this workspace.

subscription_id

string

Your Azure subscription Id.

system_datastores_auth_mode

string

Specifies the auth mode for the system data stores.

Choices:

• "accesskey"
• "identity"

tags

dictionary

Dictionary of string:string pairs to assign as metadata to the object.

Metadata tags on the object will be updated with any provided values.

To remove tags set append_tags option to false.

Currently, Azure DNS zones and Traffic Manager services also don’t allow the use of spaces in the tag.

Azure Front Door doesn’t support the use of

Azure Automation and Azure CDN only support 15 tags on resources.

tenant

string

Azure tenant ID. Use when authenticating with a Service Principal.

thumbprint

string

added in azure.azcollection 1.14.0

The thumbprint of the private key specified in x509_certificate_path.

Use when authenticating with a Service Principal.

Required if x509_certificate_path is defined.

update_dependent_resources

boolean

Specifying update_dependent_resources, gives your consent to update the workspace dependent resources. Updating the workspace-attached Azure Container Registry or Application Insights resource may break lineage of previous jobs, deployed inference endpoints, or your ability to rerun earlier jobs in this workspace.

Choices:

• false ← (default)
• true

x509_certificate_path

path

added in azure.azcollection 1.14.0

Path to the X509 certificate used to create the service principal in PEM format.

The certificate must be appended to the private key.

Use when authenticating with a Service Principal.

changed

boolean

Whether the resource is changed.

Returned: always

Sample: false

ml_workspace

dictionary

Workspace that was just created or updated.

Returned: always

Sample: {"allow_roleassignment_on_rg": false, "application_insights": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-ml-workspace/providers/Microsoft.insights/components/workspacinsightsxxxxxxxx", "description": "Workspace Integration Tests", "discovery_url": "https://westus3.api.azureml.ms/discovery", "display_name": "workspace-xxxxxxx-xxx", "enable_data_isolation": false, "hbi_workspace": false, "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-ml-workspace/providers/Microsoft.MachineLearningServices/workspaces/workspace-xxxxxxx-xxx", "identity": {"principal_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "tenant_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "type": "system_assigned"}, "key_vault": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-ml-workspace/providers/Microsoft.Keyvault/vaults/workspackeyvaultxxxxxxxx", "location": "westus3", "managed_network": {"firewall_sku": "standard", "isolation_mode": "allow_only_approved_outbound", "network_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "outbound_rules": [{"category": "user_defined", "destination": "microsoft.com", "name": "microsoft", "status": "Inactive", "type": "fqdn"}, {"category": "user_defined", "destination": {"address_prefixes": ["168.63.129.16", "10.0.0.0/24"], "port_ranges": "80, 8080-8089", "protocol": "TCP", "service_tag": "sometag"}, "name": "servicetag-w-prefixes", "status": "Inactive", "type": "service_tag"}], "status": {"spark_ready": false, "status": "Inactive"}}, "mlflow_tracking_uri": "azureml://westus3.api.azureml.ms/mlflow/v1.0/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-ml-workspace/providers/Microsoft.MachineLearningServices/workspaces/workspace-xxxxxxx-xxx", "name": "workspace-xxxxxxx-xxx", "network_acls": {"default_action": "Allow", "ip_rules": []}, "provision_network_now": false, "public_network_access": "Disabled", "resource_group": "test-ml-workspace", "serverless_compute": {"no_public_ip": false}, "storage_account": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-ml-workspace/providers/Microsoft.Storage/storageAccounts/workspacstoragexxxxxxxxx", "system_datastores_auth_mode": "accesskey", "tags": {"createdByToolkit": "sdk-v2-1.31.0", "foo": "bar"}}