Authenticate with Machine Learning Server in Python with azureml-model-management-sdk
Important
This content is being retired and may not be updated in the future. The support for Machine Learning Server will end on July 1, 2022. For more information, see What's happening to Machine Learning Server?
Applies to: Machine Learning Server
The azureml-model-management-sdk package, delivered with Machine Learning Server, provides functions for publishing and managing a Python web service that is backed by the Python code block or script you provided.
This section describes how to authenticate with Machine Learning Server on-premises or in the cloud using azureml-model-management-sdk. Every API call between the client and the Web node must be authenticated. The azureml-model-management-sdk functions, which place API calls on your behalf, are no different. If the user does not provide a valid login, an Unauthorized HTTP 401 status code is returned.
Overview
azureml-model-management-sdk provides the client that supports several ways of authenticating against the Machine Learning Server. Authentication of user identity is handled via Active Directory. Machine Learning Server never stores or manages any usernames and passwords. Ask your administrator for authentication type configured for Machine Learning Server and the connection details.
By default, all web services operations are available to authenticated users. Tasks, such as deleting or updating a web service, are available only to the user who initially created the service. However, your administrator can also assign role-based authorization controls to further restrict the permissions around web services.
On premises authentication
Use this approach if you are:
- authenticating using Active Directory server on your network
- using the default administrator account
Pass the username and password as a Python tuple for on premises authentication. If you do not know your connection settings, contact your administrator.
# Import the DeployClient and MLServer classes from
# the azureml-model-management-sdk package so you can
# connect to Machine Learning Server (use=MLServer).
from azureml.deploy import DeployClient
from azureml.deploy.server import MLServer
# Define the location of the Machine Learning Server
HOST = '{{https://YOUR_HOST_ENDPOINT}}'
# And provide your username and password as a Python tuple
# for local admin with password Pass123!
# context = ('admin', 'Pass123!')
context = ('{{YOUR_USERNAME}}', '{{YOUR_PASSWORD}}')
client = DeployClient(HOST, use=MLServer, auth=context)
This code calls the /user/login API.
| Argument | Description |
|---|---|
| host endpoint | Required. The Machine Learning Server HTTP/HTTPS endpoint, including the port number. |
| username | Required. Enter your AD username or 'admin' if default administrator account defined. |
| password | Required. Enter the password. |
Cloud authentication (AAD)
Use this approach if you are authenticating using Azure Active Directory in the cloud.
Pass the credentials as a Python dictionary {} for AAD authentication.
# First, import the DeployClient and MLServer classes from
# the azureml-model-management-sdk package so you can
# connect to Machine Learning Server (use=MLServer).
from azureml.deploy import DeployClient
from azureml.deploy.server import MLServer
# Define the endpoint of the host Machine Learning Server.
HOST = '{{YOUR_HOST_ENDPOINT}}'
# Pass in credentials for the AAD context as a dictionary.
# Omit username & password to use ADAL to authenticate.
context = {
'authuri': 'https://login.windows.net',
'tenant': '{{AAD_DOMAIN}}',
'clientid': '{{NATIVE_APP_CLIENT_ID}}',
'resource': '{{WEB_APP_CLIENT_ID}}',
'username': '{{YOUR_USERNAME}}',
'password': '{{YOUR_PASSWORD}}'
}
client = DeployClient(HOST, use=MLServer, auth=context)
If you do not know your tenant ID, clientid, or other details, contact your administrator. Or, if you have access to the Azure portal for the relevant Azure subscription, you can find these authentication details.
| Argument | Description |
|---|---|
| host endpoint | Required. The Machine Learning Server HTTP/HTTPS endpoint, including the port number. This endpoint is the SIGN-ON URL value from the web application |
| authuri | Required. The URI of the authentication service for Azure Active Directory. |
| tenant | Required. The tenant ID of the Azure Active Directory account being used to authenticate is the domain of AAD account. |
| clientid | Required. The numeric CLIENT ID of the AAD "native" application for the Azure Active Directory account. |
| resource | Required. The numeric CLIENT ID from the AAD "Web" application for the Azure Active Directory account, also known by the Audience in the configuration file. |
| username | Optional. If NULL, user is prompted. See following section. |
| password | Optional. If NULL, user is prompted. See following section. |
Alternatives to putting the username and password in the script
If you omit the username and password from the dictionary for the AAD context, then you can either:
Get a device code to complete authentication and token creation via Azure Active Directory Authentication Libraries (ADAL). Enter that code at https://aka.ms/devicelogin to complete the authentication.
Programmatically authenticate using a call back, such as:
def callback_fn(code): print(code) context = { 'authuri': 'https://login.windows.net', 'tenant': '{{AAD_DOMAIN}}', 'clientid': '{{NATIVE_APP_CLIENT_ID}}', 'resource': '{{WEB_APP_CLIENT_ID}}', 'user_code_callback': callback_fn }
A note about access tokens
Keep in mind that all APIs require authentication; therefore, all users must authenticate when making an API call using the POST /login API or through Azure Active Directory.
To simplify this process, bearer access tokens are issued so that users need not provide their credentials for every single call. This bearer token is a lightweight security token that grants the “bearer” access to a protected resource, in this case, Machine Learning Server's APIs. After authentication, the user does not need to provide credentials again as long as the token is still valid, and a header is submitted with every request. The application must validate the user’s bearer token to ensure that authentication was successful for the intended parties. Learn more about managing these tokens.