Skip to main content

Microsoft Azure SDK for Python

This is the Microsoft Azure Service Management Legacy Client Library.

All packages in this bundle have been tested with Python 2.7, 3.3, 3.4 and 3.5.

For the newer Azure Resource Management (ARM) libraries, see azure-mgmt.

For a more complete set of Azure libraries, see the azure bundle package.

Compatibility

IMPORTANT: If you have an earlier version of the azure package (version < 1.0), you should uninstall it before installing this package.

You can check the version using pip:

pip freeze

If you see azure==0.11.0 (or any version below 1.0), uninstall it first:

pip uninstall azure

Features

  • Cloud Service management (Virtual Machines, VM Images, OS Images)

  • Storage accounts management

  • Scheduler management

  • Service Bus management

  • Affinity Group management

  • Management certificate management

  • Web Apps (Website) management

Installation

Download Package

To install via the Python Package Index (PyPI), type:

pip install azure-servicemanagement-legacy

Download Source Code

To get the source code of the SDK via git type:

git clone https://github.com/Azure/azure-sdk-for-python.git
cd azure-sdk-for-python
cd azure-servicemanagement-legacy
python setup.py install

Usage

Authentication

Set-up certificates

You will need two certificates, one for the server (a .cer file) and one for the client (a .pem file).

Using the Azure .PublishSettings certificate

You can download your Azure publish settings file and use the certificate that is embedded in that file to create the client certificate. The server certificate already exists, so you won’t need to upload one.

To do this, download your publish settings then use this code to create the .pem file.

from azure.servicemanagement import get_certificate_from_publish_settings

subscription_id = get_certificate_from_publish_settings(
    publish_settings_path='MyAccount.PublishSettings',
    path_to_write_certificate='mycert.pem',
    subscription_id='00000000-0000-0000-0000-000000000000',
)

The subscription id parameter is optional. If there are more than one subscription in the publish settings, the first one will be used.

Creating and uploading new certificate with OpenSSL

To create the .pem file using OpenSSL, execute this:

openssl req -x509 -nodes -days 365 -newkey rsa:1024 -keyout mycert.pem -out mycert.pem

To create the .cer certificate, execute this:

openssl x509 -inform pem -in mycert.pem -outform der -out mycert.cer

After you have created the certificate, you will need to upload the .cer file to Microsoft Azure via the “Upload” action of the “Settings” tab of the management portal.

ServiceManagementService

Initialization

To initialize the management service, pass in your subscription id and the path to the .pem file.

from azure.servicemanagement import ServiceManagementService
subscription_id = '00000000-0000-0000-0000-000000000000'
cert_file = 'mycert.pem'
sms = ServiceManagementService(subscription_id, cert_file)

List Available Locations

locations = sms.list_locations()
for location in locations:
    print(location.name)

Create a Storage Service

To create a storage service, you need a name for the service (between 3 and 24 lowercase characters and unique within Microsoft Azure), a label (up to 100 characters, automatically encoded to base-64), and either a location or an affinity group.

name = "mystorageservice"
desc = name
label = name
location = 'West US'

result = sms.create_storage_account(name, desc, label, location=location)
sms.wait_for_operation_status(result.request_id, timeout=30)

Create a Cloud Service

A cloud service is also known as a hosted service (from earlier versions of Microsoft Azure). The create_hosted_service method allows you to create a new hosted service by providing a hosted service name (which must be unique in Microsoft Azure), a label (automatically encoded to base-64), and the location or the affinity group for your service.

name = "myhostedservice"
desc = name
label = name
location = 'West US'

result = sms.create_hosted_service(name, label, desc, location=location)
sms.wait_for_operation_status(result.request_id, timeout=30)

Create a Virtual Machine

To create a virtual machine, you first need to create a cloud service. Then create the virtual machine deployment using the create_virtual_machine_deployment method.

from azure.servicemanagement import LinuxConfigurationSet, OSVirtualHardDisk

name = "myhostedservice"

# Name of an os image as returned by list_os_images
image_name = 'OpenLogic__OpenLogic-CentOS-62-20120531-en-us-30GB.vhd'

# Destination storage account container/blob where the VM disk
# will be created
media_link = 'url_to_target_storage_blob_for_vm_hd'

# Linux VM configuration, you can use WindowsConfigurationSet
# for a Windows VM instead
linux_config = LinuxConfigurationSet(
    'myhostname',
    'myuser',
    'mypassword',
    disable_ssh_password_authentication=True,
)

os_hd = OSVirtualHardDisk(image_name, media_link)

result = sms.create_virtual_machine_deployment(
    service_name=name,
    deployment_name=name,
    deployment_slot='production',
    label=name,
    role_name=name,
    system_config=linux_config,
    os_virtual_hard_disk=os_hd,
    role_size='Small',
)
sms.wait_for_operation_status(result.request_id, timeout=600)

Need Help?

Be sure to check out the Microsoft Azure Developer Forums on Stack Overflow if you have trouble with the provided code.

Contribute Code or Provide Feedback

If you would like to become an active contributor to this project please follow the instructions provided in Microsoft Azure Projects Contribution Guidelines.

If you encounter any bugs with the library please file an issue in the Issues section of the project.

Learn More

Microsoft Azure Python Developer Center

Release History

0.20.5 (2016-09-22)

Bugfix

  • #794 show_in_gui not correctly sent to the server

  • #793 recommended_vm_size is not populated

Thank you to colemickens for his contribution

0.20.4 (2016-08-01)

Bugfix

  • Incomplete parsing if XML contains namespace #257 #707

New

  • Associate/Dissociate Reserved IP #695 #716

Thank you to brandondahler, schaefi for their contributions.

0.20.3 (2016-03-31)

New

  • #519 Add support for the OSImage /details endpoint

Thank you to bear454 for his contribution.

0.20.2 (2016-01-20)

New

  • #487 #488 Add StaticVirtualNetworkIPAddress to network configuration

  • #497 Add replicate_vm_image, unreplicate_vm_image, share_vm_image

  • #501 #511 Add update_os_image_from_image_reference

Thank you to bear454, ekesken, schaefi for their contributions.

0.20.1 (2015-09-14)

News

  • Create a requests.Session() if the user doesn’t pass one in.

0.20.0 (2015-08-31)

Initial release of this package, from the split of the azure package. See the azure package release note for 1.0.0 for details and previous history.

Metadata

Release files for azure-servicemanagement-legacy 0.20.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for azure-servicemanagement-legacy 0.20.5
File Size Uploaded
azure-servicemanagement-legacy-0.20.5.zip 85.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for azure-servicemanagement-legacy 0.20.5
File Interpreter ABI Platform
azure_servicemanagement_legacy-0.20.5-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 164.8 kB

Release files / azure-servicemanagement-legacy-0.20.5.zip

Download URL azure-servicemanagement-legacy-0.20.5.zip
Size 85.4 kB
Tags Source
SHA-256 checksum
How to use checksums
350cc6ee6d2190964a30fbbee5a5cb270600fed08713796c642db661acb93749
BLAKE2b-256 checksum
How to use checksums
1c6ded872b401cd44880e411ec2ac1e232438952ed592c4c2a07131708ebdf52
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / azure_servicemanagement_legacy-0.20.5-py2.py3-none-any.whl

Download URL azure_servicemanagement_legacy-0.20.5-py2.py3-none-any.whl
Size 79.4 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
e7acc6e051afe447a5b0db909c63abdd2412cbe8e4f85284065f02e9573e99d8
BLAKE2b-256 checksum
How to use checksums
63a866d0210b99002342cc44cc9411d118917dd1bdb2f15db94fc6bc9e9477e2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page