azure.azcollection.azure_rm_ml_workspace module – Create, Update or Delete an Azure Machine Learning Workspace
Note
This module is part of the azure.azcollection collection (version 3.15.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install azure.azcollection.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: azure.azcollection.azure_rm_ml_workspace.
New in azure.azcollection 3.15.0
Synopsis
Create, Update or Delete an Azure Machine Learning Workspace.
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.7
The host that executes this module must have the azure.azcollection collection installed via galaxy
All python packages listed in collection’s requirements.txt must be installed via pip on the host that executes modules from azure.azcollection
Full installation instructions may be found https://galaxy.ansible.com/azure/azcollection
Parameters
Parameter |
Comments |
|---|---|
Active Directory username. Use when authenticating with an Active Directory user rather than service principal. |
|
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. |
|
Only applies to Choices:
|
|
A flag to determine if a workspace could have role assignments on resource group level. Choices:
|
|
Selects an API profile to use when communicating with Azure services. Default value of Default: |
|
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:
|
|
ARM id of the application insights associated with this workspace. |
|
Controls the source of the credentials to use for authentication. Can also be set via the When set to When set to When set to When set to When set to The Choices:
|
|
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 Choices:
|
|
Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi). Can also be set via the |
|
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, Default: |
|
ARM id of the container registry associated with this workspace. |
|
Only applies to |
|
Description of the Azure ML workspace. |
|
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 Choices:
|
|
Display name for the workspace. |
|
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:
|
|
Only applies to |
|
The name of the compute target to use for building environment Docker images when the container registry is behind a VNet. |
|
ARM id of the key vault associated with this workspace. |
|
Specifies the workspace as a specific kind. Choices:
|
|
The location to be used for the new workspace. |
|
Parent argument. |
|
Parent argument. |
|
Managed Network Isolation Mode for the workspace. Choices:
|
|
Name of the Azure ML workspace. |
|
List of inbound IP rules |
|
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. |
|
Only applies to Choices:
|
|
ARM identifier of primary user assigned managed identity, in case multiple ones are specified. Also the default managed identity for clusterless compute. |
|
Security profile found in ~/.azure/credentials file. |
|
Set to trigger the provisioning of the managed network when creating a worksapce with the manged network enabled, or else it does nothing. Choices:
|
|
Allow public endpoint connectivity when a workspace is private link enabled. Choices:
|
|
Workspace definition in YAML |
|
Name of resource group. |
|
Azure client secret. Use when authenticating with a Service Principal. |
|
State of the Workspace. Use Choices:
|
|
ARM id of the storage account associated with this workspace. |
|
Your Azure subscription Id. |
|
Specifies the auth mode for the system data stores. Choices:
|
|
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. |
|
Azure tenant ID. Use when authenticating with a Service Principal. |
|
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. |
|
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:
|
|
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. |
Notes
Note
For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with
az login.Authentication is also possible using a service principal or Active Directory user.
To authenticate via service principal, pass subscription_id, client_id, secret and tenant or set environment variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.
To authenticate via Active Directory user, pass ad_user and password, or set AZURE_AD_USER and AZURE_PASSWORD in the environment.
Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing a [default] section and the following keys: subscription_id, client_id, secret and tenant or subscription_id, ad_user and password. It is also possible to add additional profiles. Specify the profile by passing profile or setting AZURE_PROFILE in the environment.
See Also
See also
- Sign in with Azure CLI
How to authenticate using the
az logincommand.
Examples
- 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Whether the resource is changed. Returned: always Sample: |
|
Workspace that was just created or updated. Returned: always Sample: |