azure_rm_ml_workspace

Create, Update or Delete an Azure Machine Learning Workspace

Collection: azure.azcollection

Full Name: azure.azcollection.azure_rm_ml_workspace

Synopsis

Create, Update or Delete an Azure Machine Learning Workspace

Parameters

Name	Type	Required	Default	Description
ad_user	string			Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url	string			Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
all_resources	bool		`false`	Only applies to O(state=absent). Delete all the dependent resources associated with the workspace (Azure Storage account, Azure Container Registry, Azure Application Insights, Azure Key Vault).
allow_roleassignment_on_rg	bool		`true`	A flag to determine if a workspace could have role assignments on resource group level.
api_profile	string		`latest`	Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack.
append_tags	bool		`true`	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.
application_insights	string			ARM id of the application insights associated with this workspace.
auth_source	string		`auto`	Controls the source of the credentials to use for authentication.
Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable.
When set to C(auto) (the default) the precedence is module parameters -> C(env) -> C(credential_file) -> C(cli).
When set to C(env), the credentials will be read from the environment variables.
When set to C(credential_file), it will read the profile from C(~/.azure/credentials).
When set to C(cli), the credentials will be sources from the Azure CLI profile. C(subscription_id) or the environment variable C(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 C(msi), the host machine must be an azure resource with an enabled MSI extension. C(subscription_id) or the environment variable C(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 C(msi) was added in Ansible 2.6.
cert_validation_mode	string			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 C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable.
client_id	string			Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi).
Can also be set via the C(AZURE_CLIENT_ID) environment variable.
cloud_environment	string		`AzureCloud`	For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable.
container_registry	string			ARM id of the container registry associated with this workspace.
default_resource_group	string			Only applies to O(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	bool		`false`	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 C(AZURE_DISABLE_INSTANCE_DISCOVERY) environment variable.
display_name	string			Display name for the workspace.
enable_data_isolation	bool		`false`	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.
hub_id	string			Only applies to O(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.
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.
name	string	yes		Name of the Azure ML workspace.
network_acls	list			List of inbound IP rules
oidc_token	string			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 C(AZURE_FEDERATED_TOKEN) environment variable.
oidc_token_file_path	string			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 C(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	bool		`false`	Only applies to O(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.
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	bool		`false`	Set to trigger the provisioning of the managed network when creating a worksapce with the manged network enabled, or else it does nothing.
public_network_access	string		`Disabled`	Allow public endpoint connectivity when a workspace is private link enabled.
resource_definition	string			Workspace definition in YAML
resource_group	string	yes		Name of resource group.
secret	string			Azure client secret. Use when authenticating with a Service Principal.
state	string		`present`	State of the Workspace. Use C(present) to create or update and C(absent) to delete.
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.
tags	dict			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			The thumbprint of the private key specified in I(x509_certificate_path).
Use when authenticating with a Service Principal.
Required if I(x509_certificate_path) is defined.
update_dependent_resources	bool		`false`	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.
x509_certificate_path	string			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.

Example

yaml

- name: Create ML Workspace
  azure.azcollection.azure_rm_ml_workspace:
    location: eastus
    name: MyWorkspace
    description: My Workspace created by Ansible
    resource_group: myResourceGroup
    resource_definition: |
      managed_network:
        isolation_mode: allow_only_approved_outbound
        outbound_rules:
        - name: microsoft
          destination: 'microsoft.com'
          type: fqdn
        - name: servicetag-w-prefixes
          destination:
            port_ranges: 80, 8080-8089
            protocol: TCP
            service_tag: sometag
            address_prefixes: ["168.63.129.16","10.0.0.0/24"]
          type: service_tag
    tags:
      createdByToolkit: Ansible