Azure SDK for Python DocumentationRelease 1.0.3
Microsoft
Sep 14, 2017
Contents
1 Installation: 1
2 Documentation: 3
3 Features: 5
4 System Requirements: 7
5 Need Help?: 9
6 Contributing: 116.1 Contribute Code or Provide Feedback: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
7 Learn More 13
8 Indices and tables 158.1 Service Bus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158.2 Resource Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178.3 Resource Management Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218.4 Storage Resource Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228.5 Compute and Network Resource Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238.6 Service Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288.7 azure package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308.8 azure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
Python Module Index 169
i
ii
CHAPTER 1
Installation:
You can use pip to install the latest released version of azure:
pip install azure
If you want to install azure from source:
git clone git://github.com/Azure/azure-sdk-for-python.gitcd azure-sdk-for-pythonpython setup.py install
1
Azure SDK for Python Documentation, Release 1.0.3
2 Chapter 1. Installation:
CHAPTER 2
Documentation:
• Resource Management – (API)
– Compute Resource Management – (API)
– Network Resource Management – (API)
– Storage Resource Management – (API)
• Service Management – (API)
• Service Bus – (API)
• Storage
• All Documentation
3
Azure SDK for Python Documentation, Release 1.0.3
4 Chapter 2. Documentation:
CHAPTER 3
Features:
• Storage Blob, File, Table, Queue
– see the Azure storage Git repository or readthedocs for a complete list of supported features.
• Service Bus
– Queues: create, list and delete queues; create, list, and delete subscriptions; send, receive, unlock anddelete messages
– Topics: create, list, and delete topics; create, list, and delete rules
• Resource Management (Preview)
– Compute: create virtual machines and more
– Network: create virtual networks, network interfaces, public ips and more
– Resource: create resource groups, register providers and more
– Storage: create storage accounts, list keys, and more
• Service Management
– storage accounts: create, update, delete, list, regenerate keys
– affinity groups: create, update, delete, list, get properties
– locations: list
– hosted services: create, update, delete, list, get properties
– deployment: create, get, delete, swap, change configuration, update status, upgrade, rollback
– role instance: reboot, reimage
– discover addresses and ports for the endpoints of other role instances in your service
– get configuration settings and access local resources
– get role instance information for current role and other role instances
– query and set the status of the current role
5
Azure SDK for Python Documentation, Release 1.0.3
6 Chapter 3. Features:
CHAPTER 4
System Requirements:
The supported Python versions are 2.7.x, 3.3.x, 3.4.x, and 3.5.x To download Python, please visit https://www.python.org/download/
We recommend Python Tools for Visual Studio as a development environment for developing your applications. Pleasevisit http://aka.ms/python for more information.
7
Azure SDK for Python Documentation, Release 1.0.3
8 Chapter 4. System Requirements:
CHAPTER 5
Need Help?:
Be sure to check out the Microsoft Azure Developer Forums on Stack Overflow if you have trouble with the providedcode.
9
Azure SDK for Python Documentation, Release 1.0.3
10 Chapter 5. Need Help?:
CHAPTER 6
Contributing:
Contribute Code or Provide Feedback:
If you would like to become an active contributor to this project please follow the instructions provided in MicrosoftAzure Projects Contribution Guidelines.
If you encounter any bugs with the library please file an issue in the Issues section of the project.
11
Azure SDK for Python Documentation, Release 1.0.3
12 Chapter 6. Contributing:
CHAPTER 7
Learn More
Microsoft Azure Python Developer Center
13
Azure SDK for Python Documentation, Release 1.0.3
14 Chapter 7. Learn More
CHAPTER 8
Indices and tables
• genindex
• modindex
• search
Service Bus
ServiceBus Queues
ServiceBus Queues are an alternative to Storage Queues that might be useful in scenarios where more advancedmessaging features are needed (larger message sizes, message ordering, single-operaiton destructive reads, scheduleddelivery) using push-style delivery (using long polling).
The service can use Shared Access Signature authentication, or ACS authentication.
Service bus namespaces created using the Azure portal after August 2014 no longer support ACS authentication. Youcan create ACS compatible namespaces with the Azure SDK.
Shared Access Signature Authentication
To use Shared Access Signature authentication, create the service bus service with:
from azure.servicebus import ServiceBusService
key_name = 'RootManageSharedAccessKey' # SharedAccessKeyName from Azure portalkey_value = '' # SharedAccessKey from Azure portalsbs = ServiceBusService(service_namespace,
shared_access_key_name=key_name,shared_access_key_value=key_value)
15
Azure SDK for Python Documentation, Release 1.0.3
ACS Authentication
To use ACS authentication, create the service bus service with:
from azure.servicebus import ServiceBusService
account_key = '' # DEFAULT KEY from Azure portalissuer = 'owner' # DEFAULT ISSUER from Azure portalsbs = ServiceBusService(service_namespace,
account_key=account_key,issuer=issuer)
Sending and Receiving Messages
The create_queue method can be used to ensure a queue exists:
sbs.create_queue('taskqueue')
The send_queue_message method can then be called to insert the message into the queue:
from azure.servicebus import Message
msg = Message('Hello World!')sbs.send_queue_message('taskqueue', msg)
It is then possible to call the receive_queue_message method to dequeue the message.
msg = sbs.receive_queue_message('taskqueue')
ServiceBus Topics
ServiceBus topics are an abstraction on top of ServiceBus Queues that make pub/sub scenarios easy to implement.
The create_topic method can be used to create a server-side topic:
sbs.create_topic('taskdiscussion')
The send_topic_message method can be used to send a message to a topic:
from azure.servicebus import Message
msg = Message(b'Hello World!')sbs.send_topic_message('taskdiscussion', msg)
Please consider that the message should be anything, not only readable data, then it has to be bytes in Python 3 andyou should have to manage your encoding yourself in Python 2.
A client can then create a subscription and start consuming messages by calling the create_subscription methodfollowed by the receive_subscription_message method. Please note that any messages sent before the subscription iscreated will not be received.
from azure.servicebus import Message
sbs.create_subscription('taskdiscussion', 'client1')msg = Message('Hello World!')
16 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
sbs.send_topic_message('taskdiscussion', msg)msg = sbs.receive_subscription_message('taskdiscussion', 'client1')
Event Hub
Event Hubs enable the collection of event streams at high throughput, from a diverse set of devices and services.
The create_event_hub method can be used to create an event hub:
sbs.create_event_hub('myhub')
To send an event:
sbs.send_event('myhub', '{ "DeviceId":"dev-01", "Temperature":"37.0" }')
The event content is the event message or JSON-encoded string that contains multiple messages.
Resource Management
This is a preview release
The ARM libraries are being released as a preview, to solicit feedback.
Future releases are subject to breaking changes.
The Python code generator used to create this version of the ARM libraries is being replaced, and may not generatecode that is compatible with this version of the ARM libraries.
Although future revisions will likely have breaking changes, the ARM concepts along with the REST APIs that thelibrary is wrapping should remain the same.
Please try the libraries and give us feedback, which we can incorporate into future versions.
Compute, Network and Storage Resource Management
The ARM libraries are separated into several packages:
• azure-mgmt-resource
• azure-mgmt-compute
• azure-mgmt-network
• azure-mgmt-storage
See Storage Resource Management for examples of managing storage accounts.
See Compute and Network Resource Management for examples of managing virtual machines.
See the examples below for managing resource groups.
8.2. Resource Management 17
Azure SDK for Python Documentation, Release 1.0.3
Authentication
All authentication with ARM is done via tokens.
For this preview release, we support authentication with a service principal.
In future releases, we will support additional scenarios using an ADAL library.
See Resource Management Authentication for details on getting an authentication token.
Create the management client
The following code creates an instance of the management client.
You will need to provide your subscription_id which can be retrieved from your subscription list.
See Resource Management Authentication for details on getting an authentication token.
from azure.mgmt.common import SubscriptionCloudCredentialsfrom azure.mgmt.resource import ResourceManagementClient
# TODO: Replace this with your subscription idsubscription_id = '33333333-3333-3333-3333-333333333333'creds = SubscriptionCloudCredentials(subscription_id, auth_token)
resource_client = ResourceManagementClient(creds)
Create resource group
from azure.mgmt.resource import ResourceGroup
group_name = 'mynewresourcegroup'result = resource_client.resource_groups.create_or_update(
group_name,ResourceGroup(
location='westus',tags={
'tag1': 'value1',},
))
List resource groups
result = resource_client.resource_groups.list(None)for group in result.resource_groups:
print(group.name)
Create resource
This creates an availability set using the generic resource API.
18 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
from azure.mgmt.resource import ResourceIdentity, GenericResource
resource_name = 'MyAvailabilitySet'
result = resource_client.resources.create_or_update(group_name,ResourceIdentity(
resource_name=resource_name,resource_provider_api_version="2015-05-01-preview",resource_provider_namespace="Microsoft.Compute",resource_type="availabilitySets",
),GenericResource(
location='West US',properties='{}',
),)
Create deployment from linked template
This creates resources specified in a linked JSON template.
from azure.mgmt.resource import Deploymentfrom azure.mgmt.resource import DeploymentPropertiesfrom azure.mgmt.resource import DeploymentModefrom azure.mgmt.resource import ParametersLinkfrom azure.mgmt.resource import TemplateLink
deployment_name = 'MyDeployment'
template = TemplateLink(uri='https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/
→˓101-create-availability-set/azuredeploy.json',)
parameters = ParametersLink(uri='https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/
→˓101-create-availability-set/azuredeploy.parameters.json',)
result = resource_client.deployments.create_or_update(group_name,deployment_name,Deployment(
properties=DeploymentProperties(mode=DeploymentMode.incremental,template_link=template,parameters_link=parameters,
))
)
Create deployment from template
This creates resources specified in a JSON template.
8.2. Resource Management 19
Azure SDK for Python Documentation, Release 1.0.3
from azure.mgmt.resource import Deploymentfrom azure.mgmt.resource import DeploymentPropertiesfrom azure.mgmt.resource import DeploymentMode
deployment_name = 'MyDeployment'
template = """{"$schema": "https://schema.management.azure.com/schemas/2015-01-01/
→˓deploymentTemplate.json#","contentVersion": "1.0.0.0","parameters": {"location": {
"type": "string","allowedValues": [
"East US","West US","West Europe","East Asia","South East Asia"
],"metadata": {
"description": "Location to deploy to"}
}},"resources": [{
"type": "Microsoft.Compute/availabilitySets","name": "availabilitySet1","apiVersion": "2015-05-01-preview","location": "[parameters('location')]","properties": {}
}]
}"""
# Note: when specifying values for parameters, omit the outer elements $schema,→˓contentVersion, parametersparameters = '{"location": { "value": "West US"}}'
result = resource_client.deployments.create_or_update(group_name,deployment_name,Deployment(
properties=DeploymentProperties(mode=DeploymentMode.incremental,template=template,parameters=parameters,
))
)
More examples
• Azure Resource Viewer Web Application Sample
• Azure Resource Manager Unit tests
20 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
Note that the ADAL library used by the Azure Resource Viewer sample hasn’t been officially released yet. Theapplication has a pre-release of ADAL in its wheelhouse folder.
Resource Management Authentication
For general information on resource management, see Resource Management.
Create Service Principal
First we need to create a service principal in Azure Active Directory.
Although creating an application can be done with the Azure Portal, it is currently not possible to assign a role to theapplication using the Azure Portal.
The following instructions use the Azure-CLI to create the application and assign a role. You can also use AzurePowerShell.
Go to the following links to
1. Install the Azure-CLI.
2. Connect to the Azure-CLI.
3. Authenticate to your Service Principal using the Azure-CLI.
The instructions above give the application ‘Reader’ permissions. You can use the ‘Owner’ permission for moreaccess.
If you have access to more than one Azure subscription, make sure to activate the correct subscription when usingAzure-CLI. See the azure account list and azure account set commands.
Get token
Then, use the following code to obtain an authentication token.
import requests
def get_token_from_client_credentials(endpoint, client_id, client_secret):payload = {
'grant_type': 'client_credentials','client_id': client_id,'client_secret': client_secret,'resource': 'https://management.core.windows.net/',
}response = requests.post(endpoint, data=payload).json()return response['access_token']
In the code below:
• Set endpoint to the value of “OAuth 2.0 Token Endpoint”. Click on VIEW ENDPOINTS on the bottomtoolbar in Azure portal, Active Directory, in APPLICATIONS page.
• Set client_id to the value of ApplicationId when the application was created using CLI.
• Set client_secret to the password used when the application was created using CLI.
8.3. Resource Management Authentication 21
Azure SDK for Python Documentation, Release 1.0.3
auth_token = get_token_from_client_credentials(endpoint='https://login.microsoftonline.com/00000000-0000-0000-0000-000000000000/
→˓oauth2/token',client_id='11111111-1111-1111-1111-111111111111',client_secret='2222222222222222222222222222222222222222222=',
)
Storage Resource Management
For general information on resource management, see Resource Management.
Create the management client
The following code creates an instance of the management client.
You will need to provide your subscription_id which can be retrieved from your subscription list.
See Resource Management Authentication for details on getting an authentication token.
from azure.mgmt.common import SubscriptionCloudCredentialsfrom azure.mgmt.storage import StorageManagementClient
# TODO: Replace this with your subscription idsubscription_id = '33333333-3333-3333-3333-333333333333'creds = SubscriptionCloudCredentials(subscription_id, auth_token)
storage_client = StorageManagementClient(creds)
Registration
Some operations in the storage ARM APIs require a one-time registration of the storage provider with your subscrip-tion.
Use the following code to do the registration. You can use the same credentials you created in the previous section.
from azure.mgmt.resource import ResourceManagementClient
resource_client = ResourceManagementClient(creds)resource_client.providers.register('Microsoft.Storage')
Create storage account
The following code creates a new storage account under an existing resource group. To create or manage resourcegroups, see Resource Management.
from azure.mgmt.storage import StorageAccountCreateParameters, AccountType
group_name = 'myresourcegroup'account_name = 'mystorageaccountname'result = storage_client.storage_accounts.create(
group_name,account_name,
22 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
StorageAccountCreateParameters(location='westus',account_type=AccountType.standard_lrs,
),)
List storage accounts
group_name = 'myresourcegroup'result = storage_client.storage_accounts.list_by_resource_group(group_name)for storage_account in result.storage_accounts:
print(storage_account.name)print(storage_account.account_type)print(storage_account.location)print(storage_account.provisioning_state)print('')
Get storage account keys
group_name = 'myresourcegroup'account_name = 'mystorageaccountname'result = storage_client.storage_accounts.list_keys(group_name, account_name)print(result.storage_account_keys.key1)print(result.storage_account_keys.key2)
Compute and Network Resource Management
For general information on resource management, see Resource Management.
Create the management client
The following code creates an instance of the management client.
You will need to provide your subscription_id which can be retrieved from your subscription list.
See Resource Management Authentication for details on getting an authentication token.
from azure.mgmt.common import SubscriptionCloudCredentialsimport azure.mgmt.computeimport azure.mgmt.network
# TODO: Replace this with your subscription idsubscription_id = '33333333-3333-3333-3333-333333333333'creds = SubscriptionCloudCredentials(subscription_id, auth_token)
compute_client = azure.mgmt.compute.ComputeManagementClient(creds)network_client = azure.mgmt.network.NetworkResourceProviderClient(creds)
8.5. Compute and Network Resource Management 23
Azure SDK for Python Documentation, Release 1.0.3
Registration
Some operations in the compute/network ARM APIs require a one-time registration of the storage provider with yoursubscription.
Use the following code to do the registration. You can use the same credentials you created in the previous section.
import azure.mgmt.resource
resource_client = azure.mgmt.resource.ResourceManagementClient(creds)resource_client.providers.register('Microsoft.Compute')resource_client.providers.register('Microsoft.Network')
List images
Use the following code to print all of the available images to use for creating virtual machines, including all skus andversions.
region = 'eastus2'
result_list_pub = compute_client.virtual_machine_images.list_publishers(azure.mgmt.compute.VirtualMachineImageListPublishersParameters(
location=region,),
)
for publisher in result_list_pub.resources:result_list_offers = compute_client.virtual_machine_images.list_offers(
azure.mgmt.compute.VirtualMachineImageListOffersParameters(location=region,publisher_name=publisher.name,
),)
for offer in result_list_offers.resources:result_list_skus = compute_client.virtual_machine_images.list_skus(
azure.mgmt.compute.VirtualMachineImageListSkusParameters(location=region,publisher_name=publisher.name,offer=offer.name,
),)
for sku in result_list_skus.resources:result_list = compute_client.virtual_machine_images.list(
azure.mgmt.compute.VirtualMachineImageListParameters(location=region,publisher_name=publisher.name,offer=offer.name,skus=sku.name,
),)
for version in result_list.resources:result_get = compute_client.virtual_machine_images.get(
azure.mgmt.compute.VirtualMachineImageGetParameters(location=region,
24 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
publisher_name=publisher.name,offer=offer.name,skus=sku.name,version=version.name,
),)
print('PUBLISHER: {0}, OFFER: {1}, SKU: {2}, VERSION: {3}'.format(publisher.name,offer.name,sku.name,version.name,
))
Create virtual machine
The following code creates a new virtual machine. Creating a virtual machine involves creating a resource group,storage accounts, virtual network resources, and finally the virtual machine.
To create or manage resource groups, see Resource Management.
To create or manage storage accounts, see Storage Resource Management.
import azure.mgmt.computeimport azure.mgmt.networkimport azure.mgmt.resourceimport azure.mgmt.storage
resource_client = azure.mgmt.resource.ResourceManagementClient(creds)storage_client = azure.mgmt.storage.StorageManagementClient(creds)compute_client = azure.mgmt.compute.ComputeManagementClient(creds)network_client = azure.mgmt.network.NetworkResourceProviderClient(creds)
BASE_NAME = 'pythonexample'
GROUP_NAME = BASE_NAMESTORAGE_NAME = BASE_NAMEVIRTUAL_NETWORK_NAME = BASE_NAMESUBNET_NAME = BASE_NAMENETWORK_INTERFACE_NAME = BASE_NAMEVM_NAME = BASE_NAMEOS_DISK_NAME = BASE_NAMEPUBLIC_IP_NAME = BASE_NAMECOMPUTER_NAME = BASE_NAMEADMIN_USERNAME='azureadminuser'ADMIN_PASSWORD='<censored>'REGION = 'eastus2'IMAGE_PUBLISHER = 'Canonical'IMAGE_OFFER = 'UbuntuServer'IMAGE_SKU = '15.04'IMAGE_VERSION = '15.04.201508180'
# 1. Create a resource groupresult = resource_client.resource_groups.create_or_update(
GROUP_NAME,azure.mgmt.resource.ResourceGroup(
location=REGION,
8.5. Compute and Network Resource Management 25
Azure SDK for Python Documentation, Release 1.0.3
),)
# 2. Create a storage accountresult = storage_client.storage_accounts.create(
GROUP_NAME,STORAGE_NAME,azure.mgmt.storage.StorageAccountCreateParameters(
location=REGION,account_type=azure.mgmt.storage.AccountType.standard_lrs,
),)
# 3. Create the network interface using a helper function (defined below)nic_id = create_network_interface(
network_client,REGION,GROUP_NAME,NETWORK_INTERFACE_NAME,VIRTUAL_NETWORK_NAME,SUBNET_NAME,PUBLIC_IP_NAME,
)
# 4. Create the virtual machineresult = compute_client.virtual_machines.create_or_update(
GROUP_NAME,azure.mgmt.compute.VirtualMachine(
location=REGION,name=VM_NAME,os_profile=azure.mgmt.compute.OSProfile(
admin_username=ADMIN_USERNAME,admin_password=ADMIN_PASSWORD,computer_name=COMPUTER_NAME,
),hardware_profile=azure.mgmt.compute.HardwareProfile(
virtual_machine_size=azure.mgmt.compute.VirtualMachineSizeTypes.standard_→˓a0
),network_profile=azure.mgmt.compute.NetworkProfile(
network_interfaces=[azure.mgmt.compute.NetworkInterfaceReference(
reference_uri=nic_id,),
],),storage_profile=azure.mgmt.compute.StorageProfile(
os_disk=azure.mgmt.compute.OSDisk(caching=azure.mgmt.compute.CachingTypes.none,create_option=azure.mgmt.compute.DiskCreateOptionTypes.from_image,name=OS_DISK_NAME,virtual_hard_disk=azure.mgmt.compute.VirtualHardDisk(
uri='https://{0}.blob.core.windows.net/vhds/{1}.vhd'.format(STORAGE_NAME,OS_DISK_NAME,
),),
),
26 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
image_reference = azure.mgmt.compute.ImageReference(publisher=IMAGE_PUBLISHER,offer=IMAGE_OFFER,sku=IMAGE_SKU,version=IMAGE_VERSION,
),),
),)
# Display the public ip address# You can now connect to the machine using SSHresult = network_client.public_ip_addresses.get(GROUP_NAME, PUBLIC_IP_NAME)print('VM available at {}'.format(result.public_ip_address.ip_address))
This is the helper function that creates the network resources, such as virtual network, public ip and network interface.
def create_network_interface(network_client, region, group_name, interface_name,network_name, subnet_name, ip_name):
result = network_client.virtual_networks.create_or_update(group_name,network_name,azure.mgmt.network.VirtualNetwork(
location=region,address_space=azure.mgmt.network.AddressSpace(
address_prefixes=['10.1.0.0/16',
],),subnets=[
azure.mgmt.network.Subnet(name=subnet_name,address_prefix='10.1.0.0/24',
),],
),)
result = network_client.subnets.get(group_name, network_name, subnet_name)subnet = result.subnet
result = network_client.public_ip_addresses.create_or_update(group_name,ip_name,azure.mgmt.network.PublicIpAddress(
location=region,public_ip_allocation_method='Dynamic',idle_timeout_in_minutes=4,
),)
result = network_client.public_ip_addresses.get(group_name, ip_name)public_ip_id = result.public_ip_address.id
result = network_client.network_interfaces.create_or_update(group_name,interface_name,
8.5. Compute and Network Resource Management 27
Azure SDK for Python Documentation, Release 1.0.3
azure.mgmt.network.NetworkInterface(name=interface_name,location=region,ip_configurations=[
azure.mgmt.network.NetworkInterfaceIpConfiguration(name='default',private_ip_allocation_method=azure.mgmt.network.
→˓IpAllocationMethod.dynamic,subnet=subnet,public_ip_address=azure.mgmt.network.ResourceId(
id=public_ip_id,),
),],
),)
result = network_client.network_interfaces.get(group_name,interface_name,
)
return result.network_interface.id
Service Management
Usage
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 theclient 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 onewill be used.
Creating and uploading new certificate with OpenSSL
To create the .pem file using OpenSSL, execute this:
28 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
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” actionof the “Settings” tab of the management portal.
Initialization
To initialize the management service, pass in your subscription id and the path to the .pem file.
from azure.servicemanagement import ServiceManagementServicesubscription_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 withinMicrosoft Azure), a label (up to 100 characters, automatically encoded to base-64), and either a location or an affinitygroup.
name = "mystorageservice"desc = namelabel = namelocation = 'West US'
result = sms.create_storage_account(name, desc, label, location=location)
Create a Cloud Service
A cloud service is also known as a hosted service (from earlier versions of Microsoft Azure). The cre-ate_hosted_service method allows you to create a new hosted service by providing a hosted service name (whichmust be unique in Microsoft Azure), a label (automatically encoded to base-64), and the location or the affinity groupfor your service.
name = "myhostedservice"desc = namelabel = namelocation = 'West US'
result = sms.create_hosted_service(name, label, desc, location=location)
8.6. Service Management 29
Azure SDK for Python Documentation, Release 1.0.3
Create a Deployment
To make a new deployment to Azure you must store the package file in a Microsoft Azure Blob Storage account underthe same subscription as the hosted service to which the package is being uploaded. You can create a deploymentpackage with the Microsoft Azure PowerShell cmdlets, or with the cspack commandline tool.
service_name = "myhostedservice"deployment_name = "v1"slot = 'Production'package_url = "URL_for_.cspkg_file"configuration = base64.b64encode(open(file_path, 'rb').read('path_to_.cscfg_file'))label = service_name
result = sms.create_deployment(service_name,slot,deployment_name,package_url,label,configuration)
operation = sms.get_operation_status(result.request_id)print('Operation status: ' + operation.status)
azure package
Subpackages
azure.common package
Module contents
exception azure.common.AzureConflictHttpError(message, status_code)Bases: azure.common.AzureHttpError
exception azure.common.AzureExceptionBases: exceptions.Exception
exception azure.common.AzureHttpError(message, status_code)Bases: azure.common.AzureException
exception azure.common.AzureMissingResourceHttpError(message, status_code)Bases: azure.common.AzureHttpError
azure.mgmt package
Subpackages
azure.mgmt.common package
Submodules
30 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
azure.mgmt.common.arm module
class azure.mgmt.common.arm.ResourceBase(**kwargs)Bases: object
locationGets the location of the resource.
tagsGets the tags attached to the resource.
class azure.mgmt.common.arm.ResourceBaseExtended(**kwargs)Bases: azure.mgmt.common.arm.ResourceBase
idGets the ID of the resource.
nameGets the name of the resource.
typeGets the type of the resource.
azure.mgmt.common.filters module
class azure.mgmt.common.filters.LogFilter(name=’azure.mgmt.common.filters’, level=10)Bases: object
Log the request to a standard python logger. Example of enabling logging to the console:
import logging logger = logging.getLogger(‘azure.mgmt.common.filters’) log-ger.setLevel(logging.DEBUG) logger.addHandler(logging.StreamHandler())
send(prepared_request)
class azure.mgmt.common.filters.RequestFilter(session)Bases: object
Send the request.
send(prepared_request)
class azure.mgmt.common.filters.SigningFilter(creds)Bases: object
Sign the request.
send(prepared_request)
class azure.mgmt.common.filters.UserAgentFilter(user_agent)Bases: object
Add a user-agent header to the request.
send(prepared_request)
Module contents
class azure.mgmt.common.AzureOperationResponse(**kwargs)Bases: object
8.7. azure package 31
Azure SDK for Python Documentation, Release 1.0.3
“A standard service response including an HTTP status code and request ID.
class azure.mgmt.common.OperationStatusBases: object
The status of an azure long running request. The field naming doesn’t conform to the python style, so to workwith the common code-generator, which has defined the same type in C# style
Failed = ‘Failed’resourcemanagement.py still uses these
InProgress = ‘InProgress’
Succeeded = ‘Succeeded’
failed = ‘Failed’
in_progress = ‘InProgress’
succeeded = ‘Succeeded’
class azure.mgmt.common.OperationStatusResponse(*args, **kwargs)Bases: azure.mgmt.common.AzureOperationResponse
Represent the response from a long running operation. It contains the status of the specified operation, indicatingwhether it has succeeded, is in progress, or has failed. If the operation failed, the error field includes the HTTPstatus code for the failed request, and also includes error information regarding the failure.
class ErrorDetailsIf the asynchronous operation failed, the response body includes the HTTP status code for the failedrequest, and also includes error information regarding the failure.
class azure.mgmt.common.Service(credentials, **kwargs)Bases: object
Basic service
add_filter(filter)
base_uriGets the URI used as the base for all cloud service requests.
credentialsGets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription IDforms part of the URI for every service call.
send_request(http_request)
class azure.mgmt.common.SubscriptionCloudCredentials(subscription_id, access_token, ac-cess_token_type=’Bearer’)
Bases: object
Contains the credentials and subscription required to connect to a azure service
access_token
access_token_type
sign_request(request)
subscription_id
32 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
azure.mgmt.compute package
Submodules
azure.mgmt.compute.computemanagement module
class azure.mgmt.compute.computemanagement.AdditionalUnattendContent(**kwargs)Bases: object
Gets or sets additional XML formatted information that can be included in the Unattend.xml file, which is usedby Windows Setup. Contents are defined by setting name, component name, and the pass in which the contentis a applied.
component_nameGets or sets the component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.
contentGets or sets XML formatted content that is added to the unattend.xml file in the specified pass and compo-nent.The XML must be less than 4 KB and must include the root element for the setting or feature that isbeing inserted.
pass_nameGets or sets the pass name. Currently, the only allowable value is oobeSystem.
setting_nameGets or sets setting name (e.g. FirstLogonCommands, AutoLogon )
class azure.mgmt.compute.computemanagement.ApiEntityReference(**kwargs)Bases: object
The API entity reference.
reference_uriGets or sets the relative URL in the previous Service Management API’s namespace. For Example: /sub-scriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/...
class azure.mgmt.compute.computemanagement.ApiError(**kwargs)Bases: azure.mgmt.compute.computemanagement.ApiErrorBase
Api error.
detailsGets or sets the Api error details
inner_errorGets or sets the Api inner error
class azure.mgmt.compute.computemanagement.ApiErrorBase(**kwargs)Bases: object
Api error base.
codeGets or sets the error code.
messageGets or sets the error message.
targetGets or sets the target of the particular error.
8.7. azure package 33
Azure SDK for Python Documentation, Release 1.0.3
class azure.mgmt.compute.computemanagement.AvailabilitySet(**kwargs)Bases: azure.mgmt.common.arm.ResourceBaseExtended
Create or update Availability Set parameters.
platform_fault_domain_countGets or sets Fault Domain count.
platform_update_domain_countGets or sets Update Domain count.
statusesGets or sets the resource status information.
virtual_machines_referencesGets or sets a list containing reference to all Virtual Machines created under this Availability Set.
class azure.mgmt.compute.computemanagement.AvailabilitySetCreateOrUpdateResponse(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
The Create Availability Set operation response.
availability_setGets or sets the details of the Availability Set.
class azure.mgmt.compute.computemanagement.AvailabilitySetGetResponse(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
GET Availability Set operation response.
availability_setGets or sets the details of the Availability Set.
class azure.mgmt.compute.computemanagement.AvailabilitySetListResponse(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
The List Availability Set operation response.
availability_setsGets or sets the list of availability sets
class azure.mgmt.compute.computemanagement.AvailabilitySetOperations(client)Bases: object
Operations for managing the availability sets in compute management. __NOTE__: An instance of this class isautomatically created for an instance of the [ComputeManagementClient]
clientGets a reference to the Microsoft.Azure.Management.Compute.ComputeManagementClient.
create_or_update(resource_group_name, parameters)The operation to create or update the availability set.
Args:
resource_group_name (string): The name of the resource group.
parameters (AvailabilitySet): Parameters supplied to the Create Availability Set operation.
Returns:
AvailabilitySetCreateOrUpdateResponse: The Create Availability Set operation response.
delete(resource_group_name, availability_set_name)The operation to delete the availability set.
34 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
Args:
resource_group_name (string): The name of the resource group.
availability_set_name (string): The name of the availability set.
Returns:
AzureOperationResponse: A standard service response including an HTTP status code and request ID.
get(resource_group_name, availability_set_name)The operation to get the availability set.
Args:
resource_group_name (string): The name of the resource group.
availability_set_name (string): The name of the availability set.
Returns:
AvailabilitySetGetResponse: GET Availability Set operation response.
list(resource_group_name)The operation to list the availability sets.
Args:
resource_group_name (string): The name of the resource group.
Returns:
AvailabilitySetListResponse: The List Availability Set operation response.
list_available_sizes(resource_group_name, availability_set_name)Lists virtual-machine-sizes available to be used for an availability set.
Args:
resource_group_name (string): The name of the resource group.
availability_set_name (string): The name of the availability set.
Returns:
VirtualMachineSizeListResponse: The List Virtual Machine operation response.
class azure.mgmt.compute.computemanagement.AvailabilitySetReference(**kwargs)Bases: azure.mgmt.compute.computemanagement.ApiEntityReference
Describes an availability set reference.
class azure.mgmt.compute.computemanagement.CachingTypesBases: object
The caching types of OS or data disk.
none = ‘None’
read_only = ‘ReadOnly’
read_write = ‘ReadWrite’
class azure.mgmt.compute.computemanagement.ComponentNamesBases: object
Component names supported by AdditionalUnattendContent.
microsoft_windows_shell_setup = ‘Microsoft-Windows-Shell-Setup’
8.7. azure package 35
Azure SDK for Python Documentation, Release 1.0.3
class azure.mgmt.compute.computemanagement.ComputeLongRunningOperationResponse(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
The Compute service response for long-running operations.
end_timeGets the operation end time
errorGets the operation error, if any occurred.
outputOperation output data (raw JSON)
start_timeGets the operation start time
statusGets the operation status.
tracking_operation_idGets the operation identifier.
class azure.mgmt.compute.computemanagement.ComputeManagementClient(credentials,**kwargs)
Bases: azure.mgmt.common.Service
The Compute Management Client.
api_versionGets the API version.
availability_setsOperations for managing the availability sets in compute management.
get_long_running_operation_status(operation_status_link)The Get Operation Status operation returns the status of the specified operation. After calling an asyn-chronous operation, you can call GetLongRunningOperationStatus to determine whether the operation hassucceeded, failed, or is still in progress.
Args:
operation_status_link (string): Location value returned by the Begin operation.
Returns:
ComputeLongRunningOperationResponse: The Compute service response for long-running operations.
long_running_operation_initial_timeoutGets or sets the initial timeout for Long Running Operations.
long_running_operation_retry_timeoutGets or sets the retry timeout for Long Running Operations.
usageOperations for listing usage.
virtual_machine_extension_imagesOperations for managing the virtual machine extension images in compute management.
virtual_machine_extensionsOperations for managing the virtual machine extensions in compute management.
virtual_machine_imagesOperations for managing the virtual machine images in compute management.
36 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
virtual_machine_sizesOperations for listing virtual machine sizes available in a region.
virtual_machinesOperations for managing the virtual machines in compute management.
class azure.mgmt.compute.computemanagement.ComputeOperationResponse(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
The compute long running operation response.
azure_async_operationGets or sets the the Azure Async Operation Uri.
class azure.mgmt.compute.computemanagement.ComputeOperationStatusBases: object
The operation status.
failed = ‘Failed’
in_progress = ‘InProgress’
preempted = ‘Preempted’
succeeded = ‘Succeeded’
class azure.mgmt.compute.computemanagement.DataDisk(**kwargs)Bases: azure.mgmt.compute.computemanagement.Disk
Describes a data disk.
disk_size_gbGets or sets the disk size in GB for a blank data disk to be created.
lunGets or sets the logical unit number.
class azure.mgmt.compute.computemanagement.DataDiskImage(**kwargs)Bases: object
Contains the data disk images information.
lunGets the LUN number for a data disk.This value is used to identify data disk image inside the VMImagetherefore it must be unique for each data disk.The allowed character for the value is digit.
class azure.mgmt.compute.computemanagement.Disk(**kwargs)Bases: object
Describes a disk.
cachingGets or sets the caching type.
create_optionGets or sets the create option.
nameGets or sets the disk name.
source_imageGets or sets the Source User Image VirtualHardDisk. This VirtualHardDisk will be copied before using itto attach to the Virtual Machine.If SourceImage is provided, the destination VirtualHardDisk should notexist.
8.7. azure package 37
Azure SDK for Python Documentation, Release 1.0.3
virtual_hard_diskGets or sets the Virtual Hard Disk.
class azure.mgmt.compute.computemanagement.DiskCreateOptionTypesBases: object
The create options for disks.
attach = ‘attach’
empty = ‘empty’
from_image = ‘fromImage’
class azure.mgmt.compute.computemanagement.DiskInstanceView(**kwargs)Bases: azure.mgmt.compute.computemanagement.ResourceInstanceView
The instance view of the disk.
nameGets or sets the disk name.
class azure.mgmt.compute.computemanagement.HardwareProfile(**kwargs)Bases: object
Describes a hardware profile.
virtual_machine_sizeThe virtual machine size name.
class azure.mgmt.compute.computemanagement.ImageReference(**kwargs)Bases: object
The image reference.
offerGets or sets the image offer.
publisherGets or sets the image publisher.
skuGets or sets the image sku.
versionGets or sets the image version. The allowed formats are Major.Minor.Build or ‘latest’. Major, Minor andBuild being decimal numbers. Specify ‘latest’ to use the latest version of image.
class azure.mgmt.compute.computemanagement.InnerError(**kwargs)Bases: object
Inner error details.
error_detailGets or sets the internal error message or exception dump.
exception_typeGets or sets the exception type.
class azure.mgmt.compute.computemanagement.InstanceViewStatus(**kwargs)Bases: object
Instance view status.
codeGets or sets the status Code.
38 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
display_statusGets or sets the short localizable label for the status.
levelGets or sets the level Code.
messageGets or sets the optional detailed Message, including for alerts and error messages.
timeGets or sets the time of the status.
class azure.mgmt.compute.computemanagement.LinuxConfiguration(**kwargs)Bases: object
Describes Windows Configuration of the OS Profile.
disable_password_authenticationGets or sets whether Authentication using user name and password is allowed or not
ssh_configurationGets or sets the SSH configuration for linux VMs
class azure.mgmt.compute.computemanagement.ListParameters(**kwargs)Bases: object
Specifies the parameters to be passed to List APIs.
class azure.mgmt.compute.computemanagement.ListUsagesResponse(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
The List Usages operation response.
usagesGets or sets the list Compute Resource Usages.
class azure.mgmt.compute.computemanagement.NetworkInterfaceReference(**kwargs)Bases: azure.mgmt.compute.computemanagement.ApiEntityReference
Describes a network interface reference.
primaryGets or sets whether this is a primary NIC on a virtual machine
class azure.mgmt.compute.computemanagement.NetworkProfile(**kwargs)Bases: object
Describes a network profile.
network_interfacesGets or sets the network interfaces.
class azure.mgmt.compute.computemanagement.OSDisk(**kwargs)Bases: azure.mgmt.compute.computemanagement.Disk
Describes an Operating System disk.
operating_system_typeGets or sets the Operating System type.
class azure.mgmt.compute.computemanagement.OSDiskImage(**kwargs)Bases: object
Contains the os disk image information.
8.7. azure package 39
Azure SDK for Python Documentation, Release 1.0.3
operating_systemGets or sets the operating system of the osDiskImage.
class azure.mgmt.compute.computemanagement.OSProfile(**kwargs)Bases: object
Describes an OS profile.
admin_passwordGets or sets the admin user password.
admin_usernameGets or sets the admin user name.
computer_nameGets or sets the computer name.
custom_dataGets or sets a base-64 encoded string of custom data.
linux_configurationGets or sets the Linux Configuration of the OS profile.
secretsGets or sets the List of certificates for addition to the VM.
windows_configurationGets or sets the Windows Configuration of the OS profile.
class azure.mgmt.compute.computemanagement.OperatingSystemTypesBases: object
The Operating System type.
linux = ‘Linux’
windows = ‘Windows’
class azure.mgmt.compute.computemanagement.PassNamesBases: object
Pass names supported by AdditionalUnattendContent.
oobe_system = ‘oobeSystem’
class azure.mgmt.compute.computemanagement.Plan(**kwargs)Bases: object
Plan for the resource.
nameGets or sets the plan ID.
productGets or sets the offer ID.
promotion_codeGets or sets the promotion code.
publisherGets or sets the publisher ID.
class azure.mgmt.compute.computemanagement.ProtocolTypesBases: object
The Operating System type.
40 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
http = ‘Http’
https = ‘Https’
class azure.mgmt.compute.computemanagement.ProvisioningStateTypesBases: object
The provisioning state.
creating = ‘Creating’
deleting = ‘Deleting’
failed = ‘Failed’
succeeded = ‘Succeeded’
updating = ‘Updating’
class azure.mgmt.compute.computemanagement.PurchasePlan(**kwargs)Bases: object
Used for establishing the purchase context of any 3rd Party artifact through MarketPlace.
nameGets or sets the plan ID.
productGets or sets the product ID.
publisherGets or sets the publisher ID.
class azure.mgmt.compute.computemanagement.ResourceInstanceView(**kwargs)Bases: object
The instance view of a resource.
statusesGets or sets the resource status information.
class azure.mgmt.compute.computemanagement.SettingNamesBases: object
Setting names supported by AdditionalUnattendContent.
auto_logon = ‘AutoLogon’
first_logon_commands = ‘FirstLogonCommands’
class azure.mgmt.compute.computemanagement.SourceImageReference(**kwargs)Bases: azure.mgmt.compute.computemanagement.ApiEntityReference
The source image reference.
class azure.mgmt.compute.computemanagement.SourceVaultReference(**kwargs)Bases: azure.mgmt.compute.computemanagement.ApiEntityReference
Contains a Source Key Vault relative URL.
class azure.mgmt.compute.computemanagement.SshConfiguration(**kwargs)Bases: object
SSH configuration for Linux based VMs running on Azure
public_keysGets or sets the list of SSH public keys used to authenticate with linux based VMs
8.7. azure package 41
Azure SDK for Python Documentation, Release 1.0.3
class azure.mgmt.compute.computemanagement.SshPublicKey(**kwargs)Bases: object
Contains information about SSH certificate public key and the path on the Linux VM where the public key isplaced.
key_dataGets or sets Certificate public key used to authenticate with VM through SSH.The certificate must be inPem format with or without headers.
pathGets or sets the full path on the created VM where SSH public key is stored. If the file already exists, thespecified key is appended to the file.
class azure.mgmt.compute.computemanagement.StatusLevelTypesBases: object
The Level of the status.
error = ‘Error’
info = ‘Info’
warning = ‘Warning’
class azure.mgmt.compute.computemanagement.StorageProfile(**kwargs)Bases: object
Describes a storage profile.
data_disksGets or sets the data disks.
image_referenceGets or sets the image reference.
os_diskGets or sets the OS disk.
source_imageGets or sets the source image reference.
class azure.mgmt.compute.computemanagement.Usage(**kwargs)Bases: object
Describes Compute Resource Usage.
current_valueGets or sets the current value of the usage.
limitGets or sets the limit of usage.
nameGets or sets the name of the type of usage.
unitGets or sets an enum describing the unit of measurement.
class azure.mgmt.compute.computemanagement.UsageName(**kwargs)Bases: object
The Usage Names.
42 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
localized_valueGets or sets a localized string describing the resource name.
valueGets or sets a string describing the resource name.
class azure.mgmt.compute.computemanagement.UsageOperations(client)Bases: object
Operations for listing usage. __NOTE__: An instance of this class is automatically created for an instance ofthe [ComputeManagementClient]
clientGets a reference to the Microsoft.Azure.Management.Compute.ComputeManagementClient.
list(location)Lists compute usages for a subscription.
Args:
location (string): The location upon which resource usage is queried.
Returns:
ListUsagesResponse: The List Usages operation response.
class azure.mgmt.compute.computemanagement.UsageUnitBases: object
The usage unit.
count = ‘Count’
class azure.mgmt.compute.computemanagement.VaultCertificate(**kwargs)Bases: object
Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM.
certificate_storeGets or sets the Certificate store in LocalMachine to add the certificate to on Windows, leave empty onLinux.
certificate_urlGets or sets the URL referencing a secret in a Key Vault which contains a properly formatted certificate.
class azure.mgmt.compute.computemanagement.VaultSecretGroup(**kwargs)Bases: object
Describes a set of certificates which are all in the same Key Vault.
source_vaultGets or sets the Relative URL of the Key Vault containing all of the certificates in VaultCertificates.
vault_certificatesGets or sets the list of key vault references in SourceVault which contain certificates
class azure.mgmt.compute.computemanagement.VirtualHardDisk(**kwargs)Bases: object
Describes the uri of a disk.
uriGets or sets the virtual hard disk’s uri. It should be a valid Uri to a virtual hard disk.
8.7. azure package 43
Azure SDK for Python Documentation, Release 1.0.3
class azure.mgmt.compute.computemanagement.VirtualMachine(**kwargs)Bases: azure.mgmt.common.arm.ResourceBaseExtended
Describes a Virtual Machine.
availability_set_referenceGets or sets the reference Id of the availailbity set to which this virtual machine belongs.
extensionsGets the virtual machine child extension resources.
hardware_profileGets or sets the hardware profile.
instance_viewGets the virtual machine instance view.
network_profileGets or sets the network profile.
os_profileGets or sets the OS profile.
planGets or sets the purchase plan when deploying virtual machine from VM Marketplace images.
provisioning_stateGets or sets the provisioning state, which only appears in the response.
storage_profileGets or sets the storage profile.
class azure.mgmt.compute.computemanagement.VirtualMachineAgentInstanceView(**kwargs)Bases: azure.mgmt.compute.computemanagement.ResourceInstanceView
The instance view of the VM Agent running on the virtual machine.
extension_handlersGets or sets the virtual machine extension handler instance view.
vm_agent_versionGets or sets the VM Agent full version.
class azure.mgmt.compute.computemanagement.VirtualMachineCaptureParameters(**kwargs)Bases: object
Capture Virtual Machine parameters.
destination_container_nameGets or sets the destination container name.
overwriteGets or sets whether it overwrites destination VirtualHardDisk if true, in case of conflict.
virtual_hard_disk_name_prefixGets or sets the captured VirtualHardDisk’s name prefix.
class azure.mgmt.compute.computemanagement.VirtualMachineCreateOrUpdateResponse(**kwargs)Bases: azure.mgmt.compute.computemanagement.ComputeOperationResponse
The Create Virtual Machine operation response.
virtual_machineGets or sets details of the Virtual Machine.
44 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
class azure.mgmt.compute.computemanagement.VirtualMachineExtension(**kwargs)Bases: azure.mgmt.common.arm.ResourceBaseExtended
Describes a Virtual Machine Extension.
auto_upgrade_minor_versionGets or sets whether the extension handler should be automatically upgraded across minor versions.
extension_typeGets or sets the type of the extension handler.
instance_viewGets or sets the virtual machine extension instance view.
protected_settingsGets or sets Json formatted protected settings for the extension.
provisioning_stateGets or sets the provisioning state, which only appears in the response.
publisherGets or sets the name of the extension handler publisher.
settingsGets or sets Json formatted public settings for the extension.
type_handler_versionGets or sets the type version of the extension handler.
class azure.mgmt.compute.computemanagement.VirtualMachineExtensionCreateOrUpdateResponse(**kwargs)Bases: azure.mgmt.compute.computemanagement.ComputeOperationResponse
The compute long running operation response.
virtual_machine_extensionGets or sets details of the Virtual Machine Extension.
class azure.mgmt.compute.computemanagement.VirtualMachineExtensionGetResponse(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
The Get VM-Extension operation response.
virtual_machine_extensionGets or sets details of the Virtual Machine extension.
class azure.mgmt.compute.computemanagement.VirtualMachineExtensionHandlerInstanceView(**kwargs)Bases: object
The instance view of a virtual machine extension handler.
statusGets or sets the extension handler status.
typeGets or sets full type of the extension handler which includes both publisher and type.
type_handler_versionGets or sets the type version of the extension handler.
class azure.mgmt.compute.computemanagement.VirtualMachineExtensionImage(**kwargs)Bases: azure.mgmt.compute.computemanagement.VirtualMachineImageResource
Describes a Virtual Machine Extension Image.
8.7. azure package 45
Azure SDK for Python Documentation, Release 1.0.3
compute_roleGets or sets the type of role (IaaS or PaaS) this extension supports.
handler_schemaGets or sets the schema defined by publisher, where extension consumers should provide settings in amatching schema.
operating_systemGets or sets the operating system this extension supports.
supports_multiple_extensionsGets or sets whether the handler can support multiple extensions.
vm_scale_set_enabledGets or sets whether the extension can be used on xRP VMScaleSets.By default existing extensions areusable on scalesets, but there might be cases where a publisher wants to explicitly indicate the extension isonly enabled for CRP VMs but not VMSS.
class azure.mgmt.compute.computemanagement.VirtualMachineExtensionImageGetParameters(**kwargs)Bases: azure.mgmt.compute.computemanagement.VirtualMachineExtensionImageListVersionsParameters
Contains the parameteres required to get a virtual machine extension image.
versionUnique version number that distinguish each monthly release of this product. The allowed characters aredigit and period.Format: <MajorVersion>.<MinorVersion>Example: 1.0.0 or 1.1.0
class azure.mgmt.compute.computemanagement.VirtualMachineExtensionImageGetResponse(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
The get virtual machine extension image operation response.
virtual_machine_extension_imageGets the details of the Virtual Machine Extension Image.
class azure.mgmt.compute.computemanagement.VirtualMachineExtensionImageListTypesParameters(**kwargs)Bases: object
Contains the parameteres required to list virtual machine extension image types.
locationLocation of the PIR, used for orchestration and required by CSM to direct request to appropriate PIRregion. Example: westus, eastus.
publisher_namePublisher identifier. For example: Microsoft.Windows or Canonical.
class azure.mgmt.compute.computemanagement.VirtualMachineExtensionImageListVersionsParameters(**kwargs)Bases: azure.mgmt.compute.computemanagement.VirtualMachineExtensionImageListTypesParameters
Contains the parameteres required to list virtual machine extension image versions.
filter_expressionODAta filter expression.https://msdn.microsoft.com/en-us/library/hh169248(v=nav.70).aspxSupportedoperatives: -eq -startswith Examples: To list the all version that begin with 1.0 $filter=startswith(name,‘1.0’) To get the latest version $filter= name eq ‘latest’
typeUnique (across the publisher) identifier to distinguish an extension for this publisher. Example: ‘BGInfo’or ‘VMAccess’.The allowed characters are uppercase or lowercase letters, digit, hypen(-), period (.)Dot orhyphen is not allowed the end of value. Max length is 64.
46 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
class azure.mgmt.compute.computemanagement.VirtualMachineExtensionImageOperations(client)Bases: object
Operations for managing the virtual machine extension images in compute management. __NOTE__: An in-stance of this class is automatically created for an instance of the [ComputeManagementClient]
clientGets a reference to the Microsoft.Azure.Management.Compute.ComputeManagementClient.
get(parameters)Gets a virtual machine extension image.
Args:
parameters (VirtualMachineExtensionImageGetParameters)
Returns:
VirtualMachineExtensionImageGetResponse: The get virtual machine extension image operation re-sponse.
list_types(parameters)Gets a list of virtual machine extension image types.
Args:
parameters (VirtualMachineExtensionImageListTypesParameters)
Returns:
VirtualMachineImageResourceList: A list of virtual machine image resource information.
list_versions(parameters)Gets a list of virtual machine extension image versions.
Args:
parameters (VirtualMachineExtensionImageListVersionsParameters)
Returns:
VirtualMachineImageResourceList: A list of virtual machine image resource information.
class azure.mgmt.compute.computemanagement.VirtualMachineExtensionInstanceView(**kwargs)Bases: azure.mgmt.compute.computemanagement.ResourceInstanceView
The instance view of a virtual machine extension.
extension_typeGets or sets the full type of the extension handler which includes both publisher and type.
nameGets or sets the virtual machine extension name.
sub_statusesGets or sets the resource status information.
type_handler_versionGets or sets the type version of the extension handler.
class azure.mgmt.compute.computemanagement.VirtualMachineExtensionOperations(client)Bases: object
Operations for managing the virtual machine extensions in compute management. __NOTE__: An instance ofthis class is automatically created for an instance of the [ComputeManagementClient]
8.7. azure package 47
Azure SDK for Python Documentation, Release 1.0.3
begin_creating_or_updating(resource_group_name, vm_name, extension_parameters)The operation to create or update the extension.
Args:
resource_group_name (string): The name of the resource group.
vm_name (string): The name of the virtual machine where the extension should be create or updated.
extension_parameters (VirtualMachineExtension): Parameters supplied to the Create Virtual Machine Ex-tension operation.
Returns:
VirtualMachineExtensionCreateOrUpdateResponse: The compute long running operation response.
begin_deleting(resource_group_name, vm_name, vm_extension_name)The operation to delete the extension.
Args:
resource_group_name (string): The name of the resource group.
vm_name (string): The name of the virtual machine where the extension should be deleted.
vm_extension_name (string): The name of the virtual machine extension.
Returns:
ComputeOperationResponse: The compute long running operation response.
clientGets a reference to the Microsoft.Azure.Management.Compute.ComputeManagementClient.
create_or_update(resource_group_name, vm_name, extension_parameters)The operation to create or update the extension.
Args:
resource_group_name (string): The name of the resource group.
vm_name (string): The name of the virtual machine where the extension should be create or updated.
extension_parameters (VirtualMachineExtension): Parameters supplied to the Create Virtual Machine Ex-tension operation.
Returns:
ComputeLongRunningOperationResponse: The Compute service response for long-running operations.
delete(resource_group_name, vm_name, vm_extension_name)Args:
resource_group_name (string): The name of the resource group.
vm_name (string): The name of the virtual machine where the extension should be deleted.
vm_extension_name (string): The name of the virtual machine extension.
Returns:
ComputeLongRunningOperationResponse: The Compute service response for long-running operations.
get(resource_group_name, vm_name, vm_extension_name)The operation to get the extension.
Args:
resource_group_name (string): The name of the resource group.
48 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
vm_name (string): The name of the virtual machine containing the extension.
vm_extension_name (string): The name of the virtual machine extension.
Returns:
VirtualMachineExtensionGetResponse: The Get VM-Extension operation response.
get_with_instance_view(resource_group_name, vm_name, vm_extension_name)The operation to get an extension along with its instance view.
Args:
resource_group_name (string): The name of the resource group.
vm_name (string): The name of the virtual machine containing the extension.
vm_extension_name (string): The name of the virtual machine extension.
Returns:
VirtualMachineExtensionGetResponse: The Get VM-Extension operation response.
class azure.mgmt.compute.computemanagement.VirtualMachineGetResponse(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
The GetVM operation response.
virtual_machineGets or sets the details of the Virtual Machine.
class azure.mgmt.compute.computemanagement.VirtualMachineImage(**kwargs)Bases: azure.mgmt.compute.computemanagement.VirtualMachineImageResource
Describes a Virtual Machine Image.
data_disk_images
os_disk_image
purchase_plan
class azure.mgmt.compute.computemanagement.VirtualMachineImageGetParameters(**kwargs)Bases: azure.mgmt.compute.computemanagement.VirtualMachineImageListDetailsParameters
Contains the parameters required to get a virtual machine image.
versionUnique version number that distinguish each monthly release of this product. The allowed characters aredigit and period.Format: <MajorVersion>.<MinorVersion>Example: 1.0.0 or 1.1.0
class azure.mgmt.compute.computemanagement.VirtualMachineImageGetResponse(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
The get vm image operation response.
virtual_machine_imageGets the details of the Virtual Machine Image.
class azure.mgmt.compute.computemanagement.VirtualMachineImageListDetailsParameters(**kwargs)Bases: azure.mgmt.compute.computemanagement.VirtualMachineImageListSkusParameters
Contains the parameters required to list virtual machine images with details.
skusA distinct identifier for an item in image name. For example: DataCenter or Enterprise
8.7. azure package 49
Azure SDK for Python Documentation, Release 1.0.3
class azure.mgmt.compute.computemanagement.VirtualMachineImageListOffersParameters(**kwargs)Bases: azure.mgmt.compute.computemanagement.VirtualMachineImageListPublishersParameters
Contains the parameters required to list offers.
publisher_namePublisher identifier. For example: Microsoft.Windows or Canonical.
class azure.mgmt.compute.computemanagement.VirtualMachineImageListParameters(**kwargs)Bases: azure.mgmt.compute.computemanagement.VirtualMachineImageListDetailsParameters
Contains the parameters required to list virtual machine image versions.
filter_expressionODAta filter expression.https://msdn.microsoft.com/en-us/library/hh169248(v=nav.70).aspxSupportedoperatives: -eq -startswith Examples: To list the all version that begin with 1.0 $filter=startswith(name,‘1.0’) To get the latest version $filter= name eq ‘latest’
class azure.mgmt.compute.computemanagement.VirtualMachineImageListPublishersParameters(**kwargs)Bases: object
Contains the parameters required to list publishers.
locationLocation of the PIR, used for orchestration and required by CSM to direct request to appropriate PIRregion. Example: westus, eastus.
class azure.mgmt.compute.computemanagement.VirtualMachineImageListSkusParameters(**kwargs)Bases: azure.mgmt.compute.computemanagement.VirtualMachineImageListOffersParameters
Contains the parameters required to list skus.
offerUnique identifier to distinguish an image. The vmImageName must be unique within publisher’s names-pace. Example: WindowsServer2012
class azure.mgmt.compute.computemanagement.VirtualMachineImageOperations(client)Bases: object
Operations for managing the virtual machine images in compute management. __NOTE__: An instance of thisclass is automatically created for an instance of the [ComputeManagementClient]
clientGets a reference to the Microsoft.Azure.Management.Compute.ComputeManagementClient.
get(parameters)Gets a virtual machine image.
Args:
parameters (VirtualMachineImageGetParameters)
Returns:
VirtualMachineImageGetResponse: The get vm image operation response.
list(parameters)Gets a list of virtual machine images.
Args:
parameters (VirtualMachineImageListParameters)
Returns:
VirtualMachineImageResourceList: A list of virtual machine image resource information.
50 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
list_offers(parameters)Gets a list of virtual machine image offers.
Args:
parameters (VirtualMachineImageListOffersParameters)
Returns:
VirtualMachineImageResourceList: A list of virtual machine image resource information.
list_publishers(parameters)Gets a list of virtual machine image publishers.
Args:
parameters (VirtualMachineImageListPublishersParameters)
Returns:
VirtualMachineImageResourceList: A list of virtual machine image resource information.
list_skus(parameters)Gets a list of virtual machine image skus.
Args:
parameters (VirtualMachineImageListSkusParameters)
Returns:
VirtualMachineImageResourceList: A list of virtual machine image resource information.
class azure.mgmt.compute.computemanagement.VirtualMachineImageResource(**kwargs)Bases: object
Virtual machine image resource information.
idGets or sets the ID of the artifact.
locationGets or sets the location of the resource.
nameGets or sets the name of the resource.
class azure.mgmt.compute.computemanagement.VirtualMachineImageResourceList(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
A list of virtual machine image resource information.
resourcesGets a list of virtual machine image resources.
class azure.mgmt.compute.computemanagement.VirtualMachineInstanceView(**kwargs)Bases: azure.mgmt.compute.computemanagement.ResourceInstanceView
The instance view of a virtual machine.
disksGets or sets the the disks information.
extensionsGets or sets the extensions information.
8.7. azure package 51
Azure SDK for Python Documentation, Release 1.0.3
platform_fault_domainGets or sets the Fault Domain count.
platform_update_domainGets or sets the Update Domain count.
remote_desktop_thumbprintGets or sets the Remote desktop certificate thumbprint.
statusesGets or sets the VM status.
vm_agentGets or sets the VM Agent running on the virtual machine.
class azure.mgmt.compute.computemanagement.VirtualMachineListResponse(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
The List Virtual Machine operation response.
next_linkGets or sets the uri to fetch the next page of VMs. Call ListNext() with this to fetch the next page of VirtualMachines.
virtual_machinesGets or sets the list of virtual machines.
class azure.mgmt.compute.computemanagement.VirtualMachineOperations(client)Bases: object
Operations for managing the virtual machines in compute management. __NOTE__: An instance of this classis automatically created for an instance of the [ComputeManagementClient]
begin_capturing(resource_group_name, vm_name, parameters)Captures the VM by copying VirtualHardDisks of the VM and outputs a template that can be used to createsimilar VMs.
Args:
resource_group_name (string): The name of the resource group.
vm_name (string): The name of the virtual machine.
parameters (VirtualMachineCaptureParameters): Parameters supplied to the Capture Virtual Machine op-eration.
Returns:
ComputeOperationResponse: The compute long running operation response.
begin_creating_or_updating(resource_group_name, parameters)The operation to create or update a virtual machine.
Args:
resource_group_name (string): The name of the resource group.
parameters (VirtualMachine): Parameters supplied to the Create Virtual Machine operation.
Returns:
VirtualMachineCreateOrUpdateResponse: The Create Virtual Machine operation response.
begin_deallocating(resource_group_name, vm_name)Shuts down the Virtual Machine and releases the compute resources. You are not billed for the computeresources that this Virtual Machine uses.
52 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
Args:
resource_group_name (string): The name of the resource group.
vm_name (string): The name of the virtual machine.
Returns:
ComputeOperationResponse: The compute long running operation response.
begin_deleting(resource_group_name, vm_name)The operation to delete a virtual machine.
Args:
resource_group_name (string): The name of the resource group.
vm_name (string): The name of the virtual machine.
Returns:
ComputeOperationResponse: The compute long running operation response.
begin_powering_off(resource_group_name, vm_name)The operation to power off (stop) a virtual machine.
Args:
resource_group_name (string): The name of the resource group.
vm_name (string): The name of the virtual machine.
Returns:
ComputeOperationResponse: The compute long running operation response.
begin_restarting(resource_group_name, vm_name)The operation to restart a virtual machine.
Args:
resource_group_name (string): The name of the resource group.
vm_name (string): The name of the virtual machine.
Returns:
ComputeOperationResponse: The compute long running operation response.
begin_starting(resource_group_name, vm_name)The operation to start a virtual machine.
Args:
resource_group_name (string): The name of the resource group.
vm_name (string): The name of the virtual machine.
Returns:
ComputeOperationResponse: The compute long running operation response.
capture(resource_group_name, vm_name, parameters)Captures the VM by copying VirtualHardDisks of the VM and outputs a template that can be used to createsimilar VMs.
Args:
resource_group_name (string): The name of the resource group.
8.7. azure package 53
Azure SDK for Python Documentation, Release 1.0.3
vm_name (string): The name of the virtual machine.
parameters (VirtualMachineCaptureParameters): Parameters supplied to the Capture Virtual Machine op-eration.
Returns:
ComputeLongRunningOperationResponse: The Compute service response for long-running operations.
clientGets a reference to the Microsoft.Azure.Management.Compute.ComputeManagementClient.
create_or_update(resource_group_name, parameters)The operation to create or update a virtual machine.
Args:
resource_group_name (string): The name of the resource group.
parameters (VirtualMachine): Parameters supplied to the Create Virtual Machine operation.
Returns:
ComputeLongRunningOperationResponse: The Compute service response for long-running operations.
deallocate(resource_group_name, vm_name)Shuts down the Virtual Machine and releases the compute resources. You are not billed for the computeresources that this Virtual Machine uses.
Args:
resource_group_name (string): The name of the resource group.
vm_name (string): The name of the virtual machine.
Returns:
ComputeLongRunningOperationResponse: The Compute service response for long-running operations.
delete(resource_group_name, vm_name)The operation to delete a virtual machine.
Args:
resource_group_name (string): The name of the resource group.
vm_name (string): The name of the virtual machine.
Returns:
ComputeLongRunningOperationResponse: The Compute service response for long-running operations.
generalize(resource_group_name, vm_name)Sets the state of the VM as Generalized.
Args:
resource_group_name (string): The name of the resource group.
vm_name (string): The name of the virtual machine.
Returns:
AzureOperationResponse: A standard service response including an HTTP status code and request ID.
get(resource_group_name, vm_name)The operation to get a virtual machine.
Args:
54 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
resource_group_name (string): The name of the resource group.
vm_name (string): The name of the virtual machine.
Returns:
VirtualMachineGetResponse: The GetVM operation response.
get_with_instance_view(resource_group_name, vm_name)The operation to get a virtual machine along with its instance view.
Args:
resource_group_name (string): The name of the resource group.
vm_name (string): The name of the virtual machine.
Returns:
VirtualMachineGetResponse: The GetVM operation response.
list(resource_group_name)The operation to list virtual machines under a resource group.
Args:
resource_group_name (string): The name of the resource group.
Returns:
VirtualMachineListResponse: The List Virtual Machine operation response.
list_all(parameters)Gets the list of Virtual Machines in the subscription. Use nextLink property in the response to get the nextpage of Virtual Machines. Do this till nextLink is not null to fetch all the Virtual Machines.
Args:
parameters (ListParameters)
Returns:
VirtualMachineListResponse: The List Virtual Machine operation response.
list_available_sizes(resource_group_name, vm_name)Lists virtual-machine-sizes available to be used for a virtual machine.
Args:
resource_group_name (string): The name of the resource group.
vm_name (string): The name of the virtual machine.
Returns:
VirtualMachineSizeListResponse: The List Virtual Machine operation response.
list_next(next_link)Gets the next page of Virtual Machines. NextLink is obtained by making a ListAll() callwhich fetches thefirst page of Virtual Machines and a link to fetch the next page.
Args:
next_link (string): NextLink from the previous successful call to ListVirtualMachines operation.
Returns:
VirtualMachineListResponse: The List Virtual Machine operation response.
8.7. azure package 55
Azure SDK for Python Documentation, Release 1.0.3
power_off(resource_group_name, vm_name)The operation to power off (stop) a virtual machine.
Args:
resource_group_name (string): The name of the resource group.
vm_name (string): The name of the virtual machine.
Returns:
ComputeLongRunningOperationResponse: The Compute service response for long-running operations.
restart(resource_group_name, vm_name)The operation to restart a virtual machine.
Args:
resource_group_name (string): The name of the resource group.
vm_name (string): The name of the virtual machine.
Returns:
ComputeLongRunningOperationResponse: The Compute service response for long-running operations.
start(resource_group_name, vm_name)The operation to start a virtual machine.
Args:
resource_group_name (string): The name of the resource group.
vm_name (string): The name of the virtual machine.
Returns:
ComputeLongRunningOperationResponse: The Compute service response for long-running operations.
class azure.mgmt.compute.computemanagement.VirtualMachineReference(**kwargs)Bases: azure.mgmt.compute.computemanagement.ApiEntityReference
Describes a virtual machine reference.
class azure.mgmt.compute.computemanagement.VirtualMachineSize(**kwargs)Bases: object
Describes the properties of a VM size.
max_data_disk_countGets or sets the Maximum number of data disks allowed by a VM size.
memory_in_mbGets or sets the Memory size supported by a VM size.
nameGets or sets the VM size name.
number_of_coresGets or sets the Number of cores supported by a VM size.
os_disk_size_in_mbGets or sets the OS disk size allowed by a VM size.
resource_disk_size_in_mbGets or sets the Resource disk size allowed by a VM size.
56 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
class azure.mgmt.compute.computemanagement.VirtualMachineSizeListResponse(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
The List Virtual Machine operation response.
virtual_machine_sizesGets or sets the list of virtual machine sizes.
class azure.mgmt.compute.computemanagement.VirtualMachineSizeOperations(client)Bases: object
Operations for listing virtual machine sizes available in a region. __NOTE__: An instance of this class isautomatically created for an instance of the [ComputeManagementClient]
clientGets a reference to the Microsoft.Azure.Management.Compute.ComputeManagementClient.
list(location)Lists virtual-machine-sizes available in a location for a subscription.
Args:
location (string): The location upon which virtual-machine-sizes is queried.
Returns:
VirtualMachineSizeListResponse: The List Virtual Machine operation response.
class azure.mgmt.compute.computemanagement.VirtualMachineSizeTypesBases: object
The virtual machine size.
basic_a0 = ‘Basic_A0’
basic_a1 = ‘Basic_A1’
basic_a2 = ‘Basic_A2’
basic_a3 = ‘Basic_A3’
basic_a4 = ‘Basic_A4’
standard_a0 = ‘Standard_A0’
standard_a1 = ‘Standard_A1’
standard_a2 = ‘Standard_A2’
standard_a3 = ‘Standard_A3’
standard_a4 = ‘Standard_A4’
standard_a5 = ‘Standard_A5’
standard_a6 = ‘Standard_A6’
standard_a7 = ‘Standard_A7’
standard_a8 = ‘Standard_A8’
standard_a9 = ‘Standard_A9’
standard_g1 = ‘Standard_G1’
standard_g2 = ‘Standard_G2’
standard_g3 = ‘Standard_G3’
8.7. azure package 57
Azure SDK for Python Documentation, Release 1.0.3
standard_g4 = ‘Standard_G4’
standard_g5 = ‘Standard_G5’
class azure.mgmt.compute.computemanagement.WinRMConfiguration(**kwargs)Bases: object
Describes Windows Remote Management configuration of the VM
listenersGets or sets the list of Windows Remote Management listeners
class azure.mgmt.compute.computemanagement.WinRMListener(**kwargs)Bases: object
Describes Protocol and thumbprint of Windows Remote Management listener
certificate_urlGets or sets the Certificate URL in KMS for Https listeners. Should be null for Http listeners.
protocolGets or sets the Protocol used by WinRM listener. Currently only Http and Https are supported.
class azure.mgmt.compute.computemanagement.WindowsConfiguration(**kwargs)Bases: object
Describes Windows Configuration of the OS Profile.
additional_unattend_contentsGets or sets the additional base-64 encoded XML formatted information that can be included in the Unat-tend.xml file.
enable_automatic_updatesGets or sets whether Windows updates are automatically installed on the VM
provision_vm_agentGets or sets whether VM Agent should be provisioned on the Virtual Machine.
time_zoneGets or sets the Time Zone of the VM
win_rm_configurationGets or sets the Windows Remote Management configuration of the VM
Module contents
azure.mgmt.network package
Submodules
azure.mgmt.network.networkresourceprovider module
class azure.mgmt.network.networkresourceprovider.AddressSpace(**kwargs)Bases: object
AddressSpace contains an array of IP address ranges that can be used by subnets
address_prefixesGets or sets List of address blocks reserved for this virtual network in CIDR notation
58 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
class azure.mgmt.network.networkresourceprovider.AzureAsyncOperationResponse(**kwargs)Bases: azure.mgmt.network.networkresourceprovider.RetriableOperationResponse
The response body contains the status of the specified asynchronous operation, indicating whether it has suc-ceeded, is inprogress, or has failed. Note that this status is distinct from the HTTP status code returned for theGet Operation Status operation itself. If the asynchronous operation succeeded, the response body includes theHTTP status code for the successful request. If the asynchronous operation failed, the response body includesthe HTTP status code for the failed request and error information regarding the failure.
statusStatus of the AzureAsuncOperation
class azure.mgmt.network.networkresourceprovider.BackendAddressPool(**kwargs)Bases: azure.mgmt.network.networkresourceprovider.ChildResource
Pool of backend IP addresseses
backend_ip_configurationsGets collection of references to IPs defined in NICs
load_balancing_rulesGets Load Balancing rules that use this Backend Address Pool
provisioning_stateProvisioning state of the PublicIP resource Updating/Deleting/Failed
class azure.mgmt.network.networkresourceprovider.ChildResource(**kwargs)Bases: azure.mgmt.network.networkresourceprovider.ResourceId
A common class for general resource information
etagA unique read-only string that changes whenever the resource is updated
nameGets name of the resource that is unique within a resource group. This name can be used to access theresource
class azure.mgmt.network.networkresourceprovider.ConnectionResetSharedKey(**kwargs)Bases: object
key_lengthThe virtual network connection reset shared key length
class azure.mgmt.network.networkresourceprovider.ConnectionResetSharedKeyPutResponse(**kwargs)Bases: azure.mgmt.network.networkresourceprovider.UpdateOperationResponse
Response for PutVirtualNetworkGatewayConnectionResetSharedKey Api servive call
connection_reset_shared_keyPuts the virtual network gateway connection reset shared key that exists in a resource group
class azure.mgmt.network.networkresourceprovider.ConnectionSharedKey(**kwargs)Bases: object
Response for GetConnectionSharedKey Api servive call
valueThe virtual network connection shared key value
class azure.mgmt.network.networkresourceprovider.ConnectionSharedKeyPutResponse(**kwargs)Bases: azure.mgmt.network.networkresourceprovider.UpdateOperationResponse
Response for PutVirtualNetworkGatewayConnectionSharedKey Api servive call
8.7. azure package 59
Azure SDK for Python Documentation, Release 1.0.3
connection_shared_keyPuts the virtual network gateway connection shared key that exists in a resource group
class azure.mgmt.network.networkresourceprovider.ConnectionSharedKeyResponse(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
Response for CheckConnectionSharedKey Api servive call
valueThe virtual network connection shared key value
class azure.mgmt.network.networkresourceprovider.DhcpOptions(**kwargs)Bases: object
DHCPOptions contains an array of DNS servers available to VMs deployed in the virtual networkStandardDHCP option for a subnet overrides VNET DHCP options.
dns_serversGets or sets list of DNS servers IP addresses
class azure.mgmt.network.networkresourceprovider.DnsNameAvailabilityResponse(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
Response for CheckDnsNameAvailability Api servive call
dns_name_availabilityDomain availability (True/False)
class azure.mgmt.network.networkresourceprovider.DnsSettings(**kwargs)Bases: object
Dns Settings of a resource
applied_dns_serversGets or sets list of Applied DNS servers IP addresses
dns_serversGets or sets list of DNS servers IP addresses
class azure.mgmt.network.networkresourceprovider.Error(**kwargs)Bases: object
code
details
inner_error
message
target
class azure.mgmt.network.networkresourceprovider.ErrorDetails(**kwargs)Bases: object
code
message
target
class azure.mgmt.network.networkresourceprovider.FrontendIpConfiguration(**kwargs)Bases: azure.mgmt.network.networkresourceprovider.ChildResource
Frontend IP address of the load balancer
60 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
inbound_nat_rulesRead only.Inbound rules URIs that use this frontend IP
load_balancing_rulesGets Load Balancing rules URIs that use this frontend IP
private_ip_addressGets or sets the IP address of the Load Balancer.This is only specified if a specific private IP address shallbe allocated from the subnet specified in subnetRef
private_ip_allocation_methodGets or sets PrivateIP allocation method (Static/Dynamic)
provisioning_stateGets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed
public_ip_addressGets or sets the reference of the PublicIP resource
subnetGets or sets the reference of the subnet resource.A subnet from wher the load balancer gets its privatefrontend address
class azure.mgmt.network.networkresourceprovider.InboundNatRule(**kwargs)Bases: azure.mgmt.network.networkresourceprovider.ChildResource
Inbound NAT rule of the loadbalancer
backend_ip_configurationGets or sets a reference to a private ip address defined on a NetworkInterface of a VM. Traffic sent tofrontendPort of each of the frontendIPConfigurations is forwarded to the backed IP
backend_portGets or sets a port used for internal connections on the endpoint. The localPort attribute maps the eternalport of the endpoint to an internal port on a role. This is useful in scenarios where a role must communicateto an internal compotnent on a port that is different from the one that is exposed externally. If not specified,the value of localPort is the same as the port attribute. Set the value of localPort to ‘*’ to automaticallyassign an unallocated port that is discoverable using the runtime API
enable_floating_ipConfigures a virtual machine’s endpoint for the floating IP capability required to configure a SQL Al-waysOn availability Group. This setting is required when using the SQL Always ON availability Groupsin SQL server. This setting can’t be changed after you create the endpoint
frontend_ip_configurationGets or sets a reference to frontend IP Addresses
frontend_portGets or sets the port for the external endpoint. You can spcify any port number you choose, but the portnumbers specified for each role in the service must be unique. Possible values range between 1 and 65535,inclusive
idle_timeout_in_minutesGets or sets the timeout for the Tcp idle connection. The value can be set between 4 and 30 minutes. Thedefault value is 4 minutes. This emlement is only used when the protocol is set to Tcp
protocolGets or sets the transport potocol for the external endpoint. Possible values are Udp or Tcp
provisioning_stateGets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed
8.7. azure package 61
Azure SDK for Python Documentation, Release 1.0.3
class azure.mgmt.network.networkresourceprovider.IpAllocationMethodBases: object
IP address allocation method
dynamic = ‘Dynamic’
static = ‘Static’
class azure.mgmt.network.networkresourceprovider.LoadBalancer(**kwargs)Bases: azure.mgmt.network.networkresourceprovider.TopLevelResource
LoadBalancer resource
backend_address_poolsGets or sets Pools of backend IP addresseses
frontend_ip_configurationsGets or sets frontend IP addresses of the load balancer
inbound_nat_rulesGets or sets list of inbound rules
load_balancing_rulesGets or sets loadbalancing rules
probesGets or sets list of Load balancer probes
provisioning_stateGets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed
class azure.mgmt.network.networkresourceprovider.LoadBalancerGetResponse(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
Response of a GET Load Balancer operation
load_balancerGets a Load Balancer in a resource group
class azure.mgmt.network.networkresourceprovider.LoadBalancerListResponse(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
Response for ListLoadBalancers Api service call
load_balancersGets a list of LoadBalancers in a resource group
next_linkGets the URL to get the next set of results.
class azure.mgmt.network.networkresourceprovider.LoadBalancerOperations(client)Bases: object
The Network Resource Provider API includes operations for managing the load balancers for your subscription.__NOTE__: An instance of this class is automatically created for an instance of the [NetworkResourceProvider-Client]
begin_create_or_updating(resource_group_name, load_balancer_name, parameters)The Put LoadBalancer operation creates/updates a LoadBalancer
Args:
resource_group_name (string): The name of the resource group.
load_balancer_name (string): The name of the loadBalancer.
62 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
parameters (LoadBalancer): Parameters supplied to the create/delete LoadBalancer operation
Returns:
LoadBalancerPutResponse: Response of a PUT Load Balancer operation
begin_deleting(resource_group_name, load_balancer_name)The delete loadbalancer operation deletes the specified loadbalancer.
Args:
resource_group_name (string): The name of the resource group.
load_balancer_name (string): The name of the loadBalancer.
Returns:
UpdateOperationResponse: If the resource provide needs to return an error to any operation, it shouldreturn the appropriate HTTP error code and a message body as can be seen below.The message should belocalized per the Accept-Language header specified in the original request such thatit could be directly beexposed to users
clientGets a reference to the Microsoft.Azure.Management.Network.NetworkResourceProviderClient.
create_or_update(resource_group_name, load_balancer_name, parameters)The Put LoadBalancer operation creates/updates a LoadBalancer
Args:
resource_group_name (string): The name of the resource group.
load_balancer_name (string): The name of the loadBalancer.
parameters (LoadBalancer): Parameters supplied to the create/update LoadBalancer operation
Returns:
AzureAsyncOperationResponse: The response body contains the status of the specified asynchronousoperation, indicating whether it has succeeded, is inprogress, or has failed. Note that this status is distinctfrom the HTTP status code returned for the Get Operation Status operation itself. If the asynchronousoperation succeeded, the response body includes the HTTP status code for the successful request. If theasynchronous operation failed, the response body includes the HTTP status code for the failed request anderror information regarding the failure.
delete(resource_group_name, load_balancer_name)Args:
resource_group_name (string): The name of the resource group.
load_balancer_name (string): The name of the loadBalancer.
Returns:
AzureOperationResponse: A standard service response including an HTTP status code and request ID.
get(resource_group_name, load_balancer_name)The Get ntework interface operation retreives information about the specified network interface.
Args:
resource_group_name (string): The name of the resource group.
load_balancer_name (string): The name of the loadBalancer.
Returns:
8.7. azure package 63
Azure SDK for Python Documentation, Release 1.0.3
LoadBalancerGetResponse: Response of a GET Load Balancer operation
list(resource_group_name)The List loadBalancer opertion retrieves all the loadbalancers in a resource group.
Args:
resource_group_name (string): The name of the resource group.
Returns:
LoadBalancerListResponse: Response for ListLoadBalancers Api service call
list_all()The List loadBalancer opertion retrieves all the loadbalancers in a subscription.
Returns:
LoadBalancerListResponse: Response for ListLoadBalancers Api service call
class azure.mgmt.network.networkresourceprovider.LoadBalancerPutResponse(**kwargs)Bases: azure.mgmt.network.networkresourceprovider.UpdateOperationResponse
Response of a PUT Load Balancer operation
load_balancerGets Load Balancer in a resource group
class azure.mgmt.network.networkresourceprovider.LoadBalancingRule(**kwargs)Bases: azure.mgmt.network.networkresourceprovider.ChildResource
Rules of the load balancer
backend_address_poolGets or sets a reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in thebackend IPs
backend_portGets or sets a port used for internal connections on the endpoint. The localPort attribute maps the eternalport of the endpoint to an internal port on a role. This is useful in scenarios where a role must communicateto an internal compotnent on a port that is different from the one that is exposed externally. If not specified,the value of localPort is the same as the port attribute. Set the value of localPort to ‘*’ to automaticallyassign an unallocated port that is discoverable using the runtime API
enable_floating_ipConfigures a virtual machine’s endpoint for the floating IP capability required to configure a SQL Al-waysOn availability Group. This setting is required when using the SQL Always ON availability Groupsin SQL server. This setting can’t be changed after you create the endpoint
frontend_ip_configurationGets or sets a reference to frontend IP Addresses
frontend_portGets or sets the port for the external endpoint. You can specify any port number you choose, but the portnumbers specified for each role in the service must be unique. Possible values range between 1 and 65535,inclusive
idle_timeout_in_minutesGets or sets the timeout for the Tcp idle connection. The value can be set between 4 and 30 minutes. Thedefault value is 4 minutes. This emlement is only used when the protocol is set to Tcp
load_distributionGets or sets the load distribution policy for this rule
64 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
probeGets or sets the reference of the load balancer probe used by the Load Balancing rule.
protocolGets or sets the transport protocol for the external endpoint. Possible values are Udp or Tcp
provisioning_stateGets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed
class azure.mgmt.network.networkresourceprovider.LoadDistributionBases: object
The load distribution policy
default = ‘Default’
source_ip = ‘SourceIP’
source_ip_protocol = ‘SourceIPProtocol’
class azure.mgmt.network.networkresourceprovider.LocalNetworkGateway(**kwargs)Bases: azure.mgmt.network.networkresourceprovider.TopLevelResource
A common class for general resource information
gateway_ip_addressIP address of local network gateway.
local_network_site_address_spaceLocal network site Address space
provisioning_stateGets or sets Provisioning state of the LocalNetworkGateway resource Updating/Deleting/Failed
class azure.mgmt.network.networkresourceprovider.LocalNetworkGatewayGetResponse(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
Response for GetLocalNetworkgateway Api servive call.
local_network_gatewayGets local network gateway details that exists in a resource group
class azure.mgmt.network.networkresourceprovider.LocalNetworkGatewayListResponse(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
Response for ListLocalNetworkGateways Api service call
local_network_gatewaysGets List of LocalNetworkGateways that exists in a resource group
next_linkGets the URL to get the next set of results.
class azure.mgmt.network.networkresourceprovider.LocalNetworkGatewayOperations(client)Bases: object
The Network Resource Provider API includes operations for managing the Virtual network Gateway for yoursubscription. __NOTE__: An instance of this class is automatically created for an instance of the [NetworkRe-sourceProviderClient]
begin_create_or_updating(resource_group_name, local_network_gateway_name, parameters)The Put LocalNetworkGateway operation creates/updates a local network gateway in the specified resourcegroup through Network resource provider.
Args:
8.7. azure package 65
Azure SDK for Python Documentation, Release 1.0.3
resource_group_name (string): The name of the resource group.
local_network_gateway_name (string): The name of the local network gateway.
parameters (LocalNetworkGateway): Parameters supplied to the Begin Create or update Local NetworkGateway operation through Network resource provider.
Returns:
LocalNetworkGatewayPutResponse: Response for PutLocalNetworkGateway Api servive call
begin_deleting(resource_group_name, local_network_gateway_name)The Delete LocalNetworkGateway operation deletes the specifed local network Gateway through Networkresource provider.
Args:
resource_group_name (string): The name of the resource group.
local_network_gateway_name (string): The name of the local network gateway.
Returns:
UpdateOperationResponse: If the resource provide needs to return an error to any operation, it shouldreturn the appropriate HTTP error code and a message body as can be seen below.The message should belocalized per the Accept-Language header specified in the original request such thatit could be directly beexposed to users
clientGets a reference to the Microsoft.Azure.Management.Network.NetworkResourceProviderClient.
create_or_update(resource_group_name, local_network_gateway_name, parameters)The Put LocalNetworkGateway operation creates/updates a local network gateway in the specified resourcegroup through Network resource provider.
Args:
resource_group_name (string): The name of the resource group.
local_network_gateway_name (string): The name of the local network gateway.
parameters (LocalNetworkGateway): Parameters supplied to the Begin Create or update Local NetworkGateway operation through Network resource provider.
Returns:
AzureAsyncOperationResponse: The response body contains the status of the specified asynchronousoperation, indicating whether it has succeeded, is inprogress, or has failed. Note that this status is distinctfrom the HTTP status code returned for the Get Operation Status operation itself. If the asynchronousoperation succeeded, the response body includes the HTTP status code for the successful request. If theasynchronous operation failed, the response body includes the HTTP status code for the failed request anderror information regarding the failure.
delete(resource_group_name, local_network_gateway_name)The Delete LocalNetworkGateway operation deletes the specifed local network Gateway through Networkresource provider.
Args:
resource_group_name (string): The name of the resource group.
local_network_gateway_name (string): The name of the local network gateway.
Returns:
AzureOperationResponse: A standard service response including an HTTP status code and request ID.
66 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
get(resource_group_name, local_network_gateway_name)The Get LocalNetworkGateway operation retrieves information about the specified local network gatewaythrough Network resource provider.
Args:
resource_group_name (string): The name of the resource group.
local_network_gateway_name (string): The name of the local network gateway.
Returns:
LocalNetworkGatewayGetResponse: Response for GetLocalNetworkgateway Api servive call.
list(resource_group_name)The List LocalNetworkGateways opertion retrieves all the local network gateways stored.
Args:
resource_group_name (string): The name of the resource group.
Returns:
LocalNetworkGatewayListResponse: Response for ListLocalNetworkGateways Api service call
class azure.mgmt.network.networkresourceprovider.LocalNetworkGatewayPutResponse(**kwargs)Bases: azure.mgmt.network.networkresourceprovider.UpdateOperationResponse
Response for PutLocalNetworkGateway Api servive call
local_network_gatewayPuts the local network gateway that exists in a resource group
class azure.mgmt.network.networkresourceprovider.NetworkInterface(**kwargs)Bases: azure.mgmt.network.networkresourceprovider.TopLevelResource
A NetworkInterface in a resource group
dns_settingsGets or sets DNsSettings in NetworkInterface
ip_configurationsGets or sets list of IPConfigurations of the NetworkInterface
mac_addressGets the MAC Address of the network interface
network_security_groupGets or sets the reference of the NetworkSecurityGroup resource
primaryGets whether this is a primary NIC on a virtual machine
provisioning_stateGets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed
virtual_machineGets or sets the reference of a VirtualMachine
class azure.mgmt.network.networkresourceprovider.NetworkInterfaceGetResponse(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
Response for GetNetworkInterface Api service call
network_interfaceGets or sets a NetworkInterface that exists in a resource group
8.7. azure package 67
Azure SDK for Python Documentation, Release 1.0.3
class azure.mgmt.network.networkresourceprovider.NetworkInterfaceIpConfiguration(**kwargs)Bases: azure.mgmt.network.networkresourceprovider.ChildResource
IPConfiguration in a NetworkInterface
load_balancer_backend_address_poolsGets or sets the reference of LoadBalancerBackendAddressPool resource
load_balancer_inbound_nat_rulesGets or sets list of references of LoadBalancerInboundNatRules
private_ip_addressGets or sets the privateIPAddress of the Network Interface IP Configuration
private_ip_allocation_methodGets or sets PrivateIP allocation method (Static/Dynamic)
provisioning_stateGets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed
public_ip_addressGets or sets the reference of the PublicIP resource
subnetGets or sets the reference of the subnet resource
class azure.mgmt.network.networkresourceprovider.NetworkInterfaceListResponse(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
Response for ListNetworkInterface Api service call
network_interfacesGets or sets list of NetworkInterfaces in a resource group
next_linkGets the URL to get the next set of results.
class azure.mgmt.network.networkresourceprovider.NetworkInterfaceOperations(client)Bases: object
The Network Resource Provider API includes operations for managing the subnets for your subscription.__NOTE__: An instance of this class is automatically created for an instance of the [NetworkResourceProvider-Client]
begin_create_or_updating(resource_group_name, network_interface_name, parameters)The Put NetworkInterface operation creates/updates a networkInterface
Args:
resource_group_name (string): The name of the resource group.
network_interface_name (string): The name of the network interface.
parameters (NetworkInterface): Parameters supplied to the create/update NetworkInterface operation
Returns:
NetworkInterfacePutResponse: Response for PutNetworkInterface Api servive call
begin_deleting(resource_group_name, network_interface_name)The delete netwokInterface operation deletes the specified netwokInterface.
Args:
resource_group_name (string): The name of the resource group.
68 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
network_interface_name (string): The name of the network interface.
Returns:
UpdateOperationResponse: If the resource provide needs to return an error to any operation, it shouldreturn the appropriate HTTP error code and a message body as can be seen below.The message should belocalized per the Accept-Language header specified in the original request such thatit could be directly beexposed to users
clientGets a reference to the Microsoft.Azure.Management.Network.NetworkResourceProviderClient.
create_or_update(resource_group_name, network_interface_name, parameters)The Put NetworkInterface operation creates/updates a networkInterface
Args:
resource_group_name (string): The name of the resource group.
network_interface_name (string): The name of the network interface.
parameters (NetworkInterface): Parameters supplied to the create/update NetworkInterface operation
Returns:
AzureAsyncOperationResponse: The response body contains the status of the specified asynchronousoperation, indicating whether it has succeeded, is inprogress, or has failed. Note that this status is distinctfrom the HTTP status code returned for the Get Operation Status operation itself. If the asynchronousoperation succeeded, the response body includes the HTTP status code for the successful request. If theasynchronous operation failed, the response body includes the HTTP status code for the failed request anderror information regarding the failure.
delete(resource_group_name, network_interface_name)Args:
resource_group_name (string): The name of the resource group.
network_interface_name (string): The name of the network interface.
Returns:
AzureOperationResponse: A standard service response including an HTTP status code and request ID.
get(resource_group_name, network_interface_name)The Get ntework interface operation retreives information about the specified network interface.
Args:
resource_group_name (string): The name of the resource group.
network_interface_name (string): The name of the network interface.
Returns:
NetworkInterfaceGetResponse: Response for GetNetworkInterface Api service call
list(resource_group_name)The List networkInterfaces opertion retrieves all the networkInterfaces in a resource group.
Args:
resource_group_name (string): The name of the resource group.
Returns:
NetworkInterfaceListResponse: Response for ListNetworkInterface Api service call
8.7. azure package 69
Azure SDK for Python Documentation, Release 1.0.3
list_all()The List networkInterfaces opertion retrieves all the networkInterfaces in a subscription.
Returns:
NetworkInterfaceListResponse: Response for ListNetworkInterface Api service call
class azure.mgmt.network.networkresourceprovider.NetworkInterfacePutResponse(**kwargs)Bases: azure.mgmt.network.networkresourceprovider.UpdateOperationResponse
Response for PutNetworkInterface Api servive call
network_interfaceGets a NetworkInterface that exists in a resource group
class azure.mgmt.network.networkresourceprovider.NetworkResourceProviderClient(credentials,**kwargs)
Bases: azure.mgmt.common.Service
The Windows Azure Network management API provides a RESTful set of web services that interact withWindows Azure Networks service to manage your network resrources. The API has entities that capture therelationship between an end user and the Windows Azure Networks service.
api_versionGets the API version.
check_dns_name_availability(location, domain_name_label)Checks whether a domain name in the cloudapp.net zone is available for use.
Args:
location (string): The location of the domain name
domain_name_label (string): The domain name to be verified. It must conform to the following regularexpression: ^[a-z][a-z0-9-]{1,61}[a-z0-9]$.
Returns:
DnsNameAvailabilityResponse: Response for CheckDnsNameAvailability Api servive call
get_long_running_operation_status(azure_async_operation)The Get Operation Status operation returns the status of the specified operation. After calling an asyn-chronous operation, you can call Get Operation Status to determine whether the operation has succeeded,failed, or is still in progress.
Args:
azure_async_operation (string): Location value returned by the Begin operation.
Returns:
AzureAsyncOperationResponse: The response body contains the status of the specified asynchronousoperation, indicating whether it has succeeded, is inprogress, or has failed. Note that this status is distinctfrom the HTTP status code returned for the Get Operation Status operation itself. If the asynchronousoperation succeeded, the response body includes the HTTP status code for the successful request. If theasynchronous operation failed, the response body includes the HTTP status code for the failed request anderror information regarding the failure.
load_balancersThe Network Resource Provider API includes operations for managing the load balancers for your sub-scription.
local_network_gatewaysThe Network Resource Provider API includes operations for managing the Virtual network Gateway foryour subscription.
70 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
long_running_operation_initial_timeoutGets or sets the initial timeout for Long Running Operations.
long_running_operation_retry_timeoutGets or sets the retry timeout for Long Running Operations.
network_interfacesThe Network Resource Provider API includes operations for managing the subnets for your subscription.
network_security_groupsThe Network Resource Provider API includes operations for managing the NetworkSecurityGroups foryour subscription.
public_ip_addressesThe Network Resource Provider API includes operations for managing the PublicIPAddress for your sub-scription.
security_rulesThe Network Resource Provider API includes operations for managing the SecurityRules for your sub-scription.
subnetsThe Network Resource Provider API includes operations for managing the subnets for your subscription.
usagesOperations for listing usage.
virtual_network_gateway_connectionsThe Network Resource Provider API includes operations for managing the Virtual network Gateway foryour subscription.
virtual_network_gatewaysThe Network Resource Provider API includes operations for managing the Virtual network Gateway foryour subscription.
virtual_networksThe Network Resource Provider API includes operations for managing the Virtual Networks for yoursubscription.
class azure.mgmt.network.networkresourceprovider.NetworkSecurityGroup(**kwargs)Bases: azure.mgmt.network.networkresourceprovider.TopLevelResource
NetworkSecurityGroup resource
default_security_rulesGets or sets Default security rules of network security group
network_interfacesGets collection of references to Network Interfaces
provisioning_stateGets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed
security_rulesGets or sets Security rules of network security group
subnetsGets collection of references to subnets
class azure.mgmt.network.networkresourceprovider.NetworkSecurityGroupGetResponse(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
Response for GetNetworkSecurityGroup Api service call
8.7. azure package 71
Azure SDK for Python Documentation, Release 1.0.3
network_security_groupGets a Network Security Group in a resource group
class azure.mgmt.network.networkresourceprovider.NetworkSecurityGroupListResponse(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
Response for ListNetworkSecurityGroups Api servive call
network_security_groupsGets List of NetworkSecurityGroups in a resource group
next_linkGets the URL to get the next set of results.
class azure.mgmt.network.networkresourceprovider.NetworkSecurityGroupOperations(client)Bases: object
The Network Resource Provider API includes operations for managing the NetworkSecurityGroups for yoursubscription. __NOTE__: An instance of this class is automatically created for an instance of the [NetworkRe-sourceProviderClient]
begin_create_or_updating(resource_group_name, network_security_group_name, parame-ters)
The Put NetworkSecurityGroup operation creates/updates a network security groupin the specified re-source group.
Args:
resource_group_name (string): The name of the resource group.
network_security_group_name (string): The name of the network security group.
parameters (NetworkSecurityGroup): Parameters supplied to the create/update Network Security Groupoperation
Returns:
NetworkSecurityGroupPutResponse: Response for PUT NetworkSecurityGroups Api servive call
begin_deleting(resource_group_name, network_security_group_name)The Delete NetworkSecurityGroup operation deletes the specifed network security group
Args:
resource_group_name (string): The name of the resource group.
network_security_group_name (string): The name of the network security group.
Returns:
UpdateOperationResponse: If the resource provide needs to return an error to any operation, it shouldreturn the appropriate HTTP error code and a message body as can be seen below.The message should belocalized per the Accept-Language header specified in the original request such thatit could be directly beexposed to users
clientGets a reference to the Microsoft.Azure.Management.Network.NetworkResourceProviderClient.
create_or_update(resource_group_name, network_security_group_name, parameters)The Put NetworkSecurityGroup operation creates/updates a network security groupin the specified re-source group.
Args:
resource_group_name (string): The name of the resource group.
72 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
network_security_group_name (string): The name of the network security group.
parameters (NetworkSecurityGroup): Parameters supplied to the create/update Network Security Groupoperation
Returns:
AzureAsyncOperationResponse: The response body contains the status of the specified asynchronousoperation, indicating whether it has succeeded, is inprogress, or has failed. Note that this status is distinctfrom the HTTP status code returned for the Get Operation Status operation itself. If the asynchronousoperation succeeded, the response body includes the HTTP status code for the successful request. If theasynchronous operation failed, the response body includes the HTTP status code for the failed request anderror information regarding the failure.
delete(resource_group_name, network_security_group_name)The Delete NetworkSecurityGroup operation deletes the specifed network security group
Args:
resource_group_name (string): The name of the resource group.
network_security_group_name (string): The name of the network security group.
Returns:
AzureOperationResponse: A standard service response including an HTTP status code and request ID.
get(resource_group_name, network_security_group_name)The Get NetworkSecurityGroups operation retrieves information about the specified network securitygroup.
Args:
resource_group_name (string): The name of the resource group.
network_security_group_name (string): The name of the network security group.
Returns:
NetworkSecurityGroupGetResponse: Response for GetNetworkSecurityGroup Api service call
list(resource_group_name)The list NetworkSecurityGroups returns all network security groups in a resource group
Args:
resource_group_name (string): The name of the resource group.
Returns:
NetworkSecurityGroupListResponse: Response for ListNetworkSecurityGroups Api servive call
list_all()The list NetworkSecurityGroups returns all network security groups in a subscription
Returns:
NetworkSecurityGroupListResponse: Response for ListNetworkSecurityGroups Api servive call
class azure.mgmt.network.networkresourceprovider.NetworkSecurityGroupPutResponse(**kwargs)Bases: azure.mgmt.network.networkresourceprovider.UpdateOperationResponse
Response for PUT NetworkSecurityGroups Api servive call
network_security_groupGets NetworkSecurityGroups in a resource group
8.7. azure package 73
Azure SDK for Python Documentation, Release 1.0.3
class azure.mgmt.network.networkresourceprovider.OperationStatusBases: object
The status of the asynchronous request.
failed = ‘Failed’
in_progress = ‘InProgress’
succeeded = ‘Succeeded’
class azure.mgmt.network.networkresourceprovider.Probe(**kwargs)Bases: azure.mgmt.network.networkresourceprovider.ChildResource
Load balancer Probe
interval_in_secondsGets or sets the interval, in seconds, for how frequently to probe the endpoint for health status. Typically,the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probesbefore taking the instance out of rotation. The default value is 15, the minimum value is 5
load_balancing_rulesGets Load balancer rules that use this probe
number_of_probesGets or sets the number of probes where if no response, will result in stopping further traffic from beingdelivered to the endpoint. This values allows endponints to be taken out of rotation faster or slower thanthe typical times used in Azure.
portGets or sets Port for communicating the probe. Possible values range from 1 to 65535, inclusive.
protocolGets or sets the protocol of the end point. Possible values are http pr Tcp. If Tcp is specified, a receivedACK is required for the probe to be successful. If http is specified,a 200 OK response from the specifiesURI is required for the probe to be successful
provisioning_stateGets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed
request_pathGets or sets the URI used for requesting health status from the VM. Path is required if a protocol is set tohttp. Otherwise, it is not allowed. There is no default value
class azure.mgmt.network.networkresourceprovider.ProbeProtocolBases: object
Protocol for load balancer probe
http = ‘Http’
tcp = ‘Tcp’
class azure.mgmt.network.networkresourceprovider.ProvisioningStateBases: object
Provisioning state of the resource
deleting = ‘Deleting’
failed = ‘Failed’
succeeded = ‘Succeeded’
updating = ‘Updating’
74 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
class azure.mgmt.network.networkresourceprovider.PublicIpAddress(**kwargs)Bases: azure.mgmt.network.networkresourceprovider.TopLevelResource
PublicIPAddress resource
dns_settingsGets or sets FQDN of the DNS record associated with the public IP address
idle_timeout_in_minutesGets or sets the Idletimeout of the public IP address
ip_addressGets the assigned public IP address
ip_configurationGets a reference to the network interface IP configurations using this public IP address
provisioning_stateGets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed
public_ip_allocation_methodGets or sets PublicIP allocation method (Static/Dynamic)
class azure.mgmt.network.networkresourceprovider.PublicIpAddressDnsSettings(**kwargs)Bases: object
Contains FQDN of the DNS record associated with the public IP address
domain_name_labelGets or sets the Domain name label.The concatenation of the domain name label and the regionalized DNSzone make up the fully qualified domain name associated with the public IP address. If a domain namelabel is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.
fqdnGets the FQDN, Fully qualified domain name of the A DNS record associated with the public IP. This isthe concatenation of the domainNameLabel and the regionalized DNS zone.
reverse_fqdnGets or Sests the Reverse FQDN. A user-visible, fully qualified domain name that resolves to this publicIP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP addressin the in-addr.arpa domain to the reverse FQDN.
class azure.mgmt.network.networkresourceprovider.PublicIpAddressGetResponse(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
Response for GetPublicIpAddress Api servive call
public_ip_addressGets publicIP address that exists in a resource group
class azure.mgmt.network.networkresourceprovider.PublicIpAddressListResponse(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
Response for ListPublicIpAddresses Api service call
next_linkGets the URL to get the next set of results.
public_ip_addressesGets List of publicIP addresses that exists in a resource group
class azure.mgmt.network.networkresourceprovider.PublicIpAddressOperations(client)Bases: object
8.7. azure package 75
Azure SDK for Python Documentation, Release 1.0.3
The Network Resource Provider API includes operations for managing the PublicIPAddress for your subscrip-tion. __NOTE__: An instance of this class is automatically created for an instance of the [NetworkResource-ProviderClient]
begin_create_or_updating(resource_group_name, public_ip_address_name, parameters)The Put PublicIPAddress operation creates/updates a stable/dynamic PublicIP address
Args:
resource_group_name (string): The name of the resource group.
public_ip_address_name (string): The name of the publicIpAddress.
parameters (PublicIpAddress): Parameters supplied to the create/update PublicIPAddress operation
Returns:
PublicIpAddressPutResponse: Response for PutPublicIpAddress Api servive call
begin_deleting(resource_group_name, public_ip_address_name)The delete publicIpAddress operation deletes the specified publicIpAddress.
Args:
resource_group_name (string): The name of the resource group.
public_ip_address_name (string): The name of the subnet.
Returns:
UpdateOperationResponse: If the resource provide needs to return an error to any operation, it shouldreturn the appropriate HTTP error code and a message body as can be seen below.The message should belocalized per the Accept-Language header specified in the original request such thatit could be directly beexposed to users
clientGets a reference to the Microsoft.Azure.Management.Network.NetworkResourceProviderClient.
create_or_update(resource_group_name, public_ip_address_name, parameters)The Put PublicIPAddress operation creates/updates a stable/dynamic PublicIP address
Args:
resource_group_name (string): The name of the resource group.
public_ip_address_name (string): The name of the publicIpAddress.
parameters (PublicIpAddress): Parameters supplied to the create PublicIPAddress operation
Returns:
AzureAsyncOperationResponse: The response body contains the status of the specified asynchronousoperation, indicating whether it has succeeded, is inprogress, or has failed. Note that this status is distinctfrom the HTTP status code returned for the Get Operation Status operation itself. If the asynchronousoperation succeeded, the response body includes the HTTP status code for the successful request. If theasynchronous operation failed, the response body includes the HTTP status code for the failed request anderror information regarding the failure.
delete(resource_group_name, public_ip_address_name)The Get Role operation retrieves information about the specified virtual machine.
Args:
resource_group_name (string): The name of the resource group.
public_ip_address_name (string): The name of the subnet.
76 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
Returns:
AzureOperationResponse: A standard service response including an HTTP status code and request ID.
get(resource_group_name, public_ip_address_name)The Get publicIpAddress operation retreives information about the specified pubicIpAddress
Args:
resource_group_name (string): The name of the resource group.
public_ip_address_name (string): The name of the subnet.
Returns:
PublicIpAddressGetResponse: Response for GetPublicIpAddress Api servive call
list(resource_group_name)The List publicIpAddress opertion retrieves all the publicIpAddresses in a resource group.
Args:
resource_group_name (string): The name of the resource group.
Returns:
PublicIpAddressListResponse: Response for ListPublicIpAddresses Api service call
list_all()The List publicIpAddress opertion retrieves all the publicIpAddresses in a subscription.
Returns:
PublicIpAddressListResponse: Response for ListPublicIpAddresses Api service call
class azure.mgmt.network.networkresourceprovider.PublicIpAddressPutResponse(**kwargs)Bases: azure.mgmt.network.networkresourceprovider.UpdateOperationResponse
Response for PutPublicIpAddress Api servive call
public_ip_addressGets a publicIP address that exists in a resource group
class azure.mgmt.network.networkresourceprovider.ResourceId(**kwargs)Bases: object
Id of the resource
idId of the resource
class azure.mgmt.network.networkresourceprovider.ResourceProperties(**kwargs)Bases: object
provisioning_stateGets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed
class azure.mgmt.network.networkresourceprovider.ResourceProviderErrorResponse(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
If the resource provide needs to return an error to any operation, it should return the appropriate HTTP errorcode and a message body as can be seen below.The message should be localized per the Accept-Languageheader specified in the original request such thatit could be directly be exposed to users
error
8.7. azure package 77
Azure SDK for Python Documentation, Release 1.0.3
class azure.mgmt.network.networkresourceprovider.RetriableOperationResponse(**kwargs)Bases: azure.mgmt.network.networkresourceprovider.ResourceProviderErrorResponse
If the resource provide needs to return an error to any operation, it should return the appropriate HTTP errorcode and a message body as can be seen below.The message should be localized per the Accept-Languageheader specified in the original request such thatit could be directly be exposed to users
retry_afterThe recommended retry interval for the Get Azure-AsyncOperation call
class azure.mgmt.network.networkresourceprovider.SecurityRule(**kwargs)Bases: azure.mgmt.network.networkresourceprovider.ChildResource
Network security rule
accessGets or sets network traffic is allowed or denied. Possible values are “Allow” and “Deny”
descriptionGets or sets a description for this rule. Restricted to 140 chars.
destination_address_prefixGets or sets destination address prefix. CIDR or source IP range. Asterix “*” can also be used to match allsource IPs. Default tags such as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used.
destination_port_rangeGets or sets Destination Port or Range. Integer or range between 0 and 65535. Asterix “*” can also beused to match all ports.
directionGets or sets the direction of the rule.InBound or Outbound. The direction specifies if rule will be evaluatedon incoming or outcoming traffic.
priorityGets or sets the priority of the rule. The value can be between 100 and 4096. The priority number must beunique for each rule in the collection. The lower the priority number, the higher the priority of the rule.
protocolGets or sets Network protocol this rule applies to. Can be Tcp, Udp or All(*).
provisioning_stateGets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed
source_address_prefixGets or sets source address prefix. CIDR or source IP range. Asterix “*” can also be used to match allsource IPs. Default tags such as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used.If this is an ingress rule, specifies where network traffic originates from.
source_port_rangeGets or sets Source Port or Range. Integer or range between 0 and 65535. Asterix “*” can also be used tomatch all ports.
class azure.mgmt.network.networkresourceprovider.SecurityRuleAccessBases: object
Access for network security rule
allow = ‘Allow’
deny = ‘Deny’
class azure.mgmt.network.networkresourceprovider.SecurityRuleDirectionBases: object
78 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
Dircetion of network security rule
inbound = ‘Inbound’
outbound = ‘Outbound’
class azure.mgmt.network.networkresourceprovider.SecurityRuleGetResponse(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
Response for GetSecurityRule Api service call
security_ruleGets the security rule in a network security group
class azure.mgmt.network.networkresourceprovider.SecurityRuleListResponse(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
Response for ListSecurityRule Api service callRetrieves all security rules that belongs to a network securitygroup
next_linkGets the URL to get the next set of results.
security_rulesGets security rules in a network security group
class azure.mgmt.network.networkresourceprovider.SecurityRuleOperations(client)Bases: object
The Network Resource Provider API includes operations for managing the SecurityRules for your subscription.__NOTE__: An instance of this class is automatically created for an instance of the [NetworkResourceProvider-Client]
begin_create_or_updating(resource_group_name, network_security_group_name, secu-rity_rule_name, security_rule_parameters)
The Put network security rule operation creates/updates a security rule in the specified network securitygroup
Args:
resource_group_name (string): The name of the resource group.
network_security_group_name (string): The name of the network security group.
security_rule_name (string): The name of the security rule.
security_rule_parameters (SecurityRule): Parameters supplied to the create/update network security ruleoperation
Returns:
SecurityRulePutResponse: Response for PUT SecurityRule Api service call
begin_deleting(resource_group_name, network_security_group_name, security_rule_name)The delete network security rule operation deletes the specified network security rule.
Args:
resource_group_name (string): The name of the resource group.
network_security_group_name (string): The name of the network security group.
security_rule_name (string): The name of the security rule.
Returns:
8.7. azure package 79
Azure SDK for Python Documentation, Release 1.0.3
UpdateOperationResponse: If the resource provide needs to return an error to any operation, it shouldreturn the appropriate HTTP error code and a message body as can be seen below.The message should belocalized per the Accept-Language header specified in the original request such thatit could be directly beexposed to users
clientGets a reference to the Microsoft.Azure.Management.Network.NetworkResourceProviderClient.
create_or_update(resource_group_name, network_security_group_name, security_rule_name, se-curity_rule_parameters)
The Put network security rule operation creates/updates a security rule in the specified network securitygroup
Args:
resource_group_name (string): The name of the resource group.
network_security_group_name (string): The name of the network security group.
security_rule_name (string): The name of the security rule.
security_rule_parameters (SecurityRule): Parameters supplied to the create/update network security ruleoperation
Returns:
AzureAsyncOperationResponse: The response body contains the status of the specified asynchronousoperation, indicating whether it has succeeded, is inprogress, or has failed. Note that this status is distinctfrom the HTTP status code returned for the Get Operation Status operation itself. If the asynchronousoperation succeeded, the response body includes the HTTP status code for the successful request. If theasynchronous operation failed, the response body includes the HTTP status code for the failed request anderror information regarding the failure.
delete(resource_group_name, network_security_group_name, security_rule_name)The delete network security rule operation deletes the specified network security rule.
Args:
resource_group_name (string): The name of the resource group.
network_security_group_name (string): The name of the network security group.
security_rule_name (string): The name of the security rule.
Returns:
AzureOperationResponse: A standard service response including an HTTP status code and request ID.
get(resource_group_name, network_security_group_name, security_rule_name)The Get NetworkSecurityRule operation retreives information about the specified network security rule.
Args:
resource_group_name (string): The name of the resource group.
network_security_group_name (string): The name of the network security group.
security_rule_name (string): The name of the security rule.
Returns:
SecurityRuleGetResponse: Response for GetSecurityRule Api service call
list(resource_group_name, network_security_group_name)The List network security rule opertion retrieves all the security rules in a network security group.
Args:
80 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
resource_group_name (string): The name of the resource group.
network_security_group_name (string): The name of the network security group.
Returns:
SecurityRuleListResponse: Response for ListSecurityRule Api service callRetrieves all security rules thatbelongs to a network security group
class azure.mgmt.network.networkresourceprovider.SecurityRuleProtocolBases: object
Protocol for network security rule
all = ‘*’
tcp = ‘Tcp’
udp = ‘Udp’
class azure.mgmt.network.networkresourceprovider.SecurityRulePutResponse(**kwargs)Bases: azure.mgmt.network.networkresourceprovider.UpdateOperationResponse
Response for PUT SecurityRule Api service call
security_ruleGets the security rule in a network security group
class azure.mgmt.network.networkresourceprovider.Subnet(**kwargs)Bases: azure.mgmt.network.networkresourceprovider.ChildResource
Subnet in a VirtualNework resource
address_prefixGets or sets Address prefix for the subnet.
ip_configurationsGets array of references to the network interface IP configurations using subnet
network_security_groupGets or sets the reference of the NetworkSecurityGroup resource
provisioning_stateGets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed
class azure.mgmt.network.networkresourceprovider.SubnetGetResponse(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
Response for GetSubnet Api service call
subnetGets the subnet in a virtual network
class azure.mgmt.network.networkresourceprovider.SubnetListResponse(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
Response for ListSubnets Api service callRetrieves all subnet that belongs to a virtual network
next_linkGets the URL to get the next set of results.
subnetsGets the subnets in a virtual network
class azure.mgmt.network.networkresourceprovider.SubnetOperations(client)Bases: object
8.7. azure package 81
Azure SDK for Python Documentation, Release 1.0.3
The Network Resource Provider API includes operations for managing the subnets for your subscription.__NOTE__: An instance of this class is automatically created for an instance of the [NetworkResourceProvider-Client]
begin_create_or_updating(resource_group_name, virtual_network_name, subnet_name, sub-net_parameters)
The Put Subnet operation creates/updates a subnet in thespecified virtual network
Args:
resource_group_name (string): The name of the resource group.
virtual_network_name (string): The name of the virtual network.
subnet_name (string): The name of the subnet.
subnet_parameters (Subnet): Parameters supplied to the create/update Subnet operation
Returns:
SubnetPutResponse: Response for PutSubnet Api service call
begin_deleting(resource_group_name, virtual_network_name, subnet_name)The delete subnet operation deletes the specified subnet.
Args:
resource_group_name (string): The name of the resource group.
virtual_network_name (string): The name of the virtual network.
subnet_name (string): The name of the subnet.
Returns:
UpdateOperationResponse: If the resource provide needs to return an error to any operation, it shouldreturn the appropriate HTTP error code and a message body as can be seen below.The message should belocalized per the Accept-Language header specified in the original request such thatit could be directly beexposed to users
clientGets a reference to the Microsoft.Azure.Management.Network.NetworkResourceProviderClient.
create_or_update(resource_group_name, virtual_network_name, subnet_name, sub-net_parameters)
The Put Subnet operation creates/updates a subnet in thespecified virtual network
Args:
resource_group_name (string): The name of the resource group.
virtual_network_name (string): The name of the virtual network.
subnet_name (string): The name of the subnet.
subnet_parameters (Subnet): Parameters supplied to the create/update Subnet operation
Returns:
AzureAsyncOperationResponse: The response body contains the status of the specified asynchronousoperation, indicating whether it has succeeded, is inprogress, or has failed. Note that this status is distinctfrom the HTTP status code returned for the Get Operation Status operation itself. If the asynchronousoperation succeeded, the response body includes the HTTP status code for the successful request. If theasynchronous operation failed, the response body includes the HTTP status code for the failed request anderror information regarding the failure.
82 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
delete(resource_group_name, virtual_network_name, subnet_name)The delete subnet operation deletes the specified subnet.
Args:
resource_group_name (string): The name of the resource group.
virtual_network_name (string): The name of the virtual network.
subnet_name (string): The name of the subnet.
Returns:
AzureOperationResponse: A standard service response including an HTTP status code and request ID.
get(resource_group_name, virtual_network_name, subnet_name)The Get subnet operation retreives information about the specified subnet.
Args:
resource_group_name (string): The name of the resource group.
virtual_network_name (string): The name of the virtual network.
subnet_name (string): The name of the subnet.
Returns:
SubnetGetResponse: Response for GetSubnet Api service call
list(resource_group_name, virtual_network_name)The List subnets opertion retrieves all the subnets in a virtual network.
Args:
resource_group_name (string): The name of the resource group.
virtual_network_name (string): The name of the virtual network.
Returns:
SubnetListResponse: Response for ListSubnets Api service callRetrieves all subnet that belongs to a vir-tual network
class azure.mgmt.network.networkresourceprovider.SubnetPutResponse(**kwargs)Bases: azure.mgmt.network.networkresourceprovider.UpdateOperationResponse
Response for PutSubnet Api service call
subnetGets the subnet in a virtual network
class azure.mgmt.network.networkresourceprovider.TopLevelResource(**kwargs)Bases: azure.mgmt.common.arm.ResourceBaseExtended
A common class for general resource information
etagGets a unique read-only string that changes whenever the resource is updated
class azure.mgmt.network.networkresourceprovider.TransportProtocolBases: object
Provisioning state of the resource
tcp = ‘Tcp’
udp = ‘Udp’
8.7. azure package 83
Azure SDK for Python Documentation, Release 1.0.3
class azure.mgmt.network.networkresourceprovider.UpdateOperationResponse(**kwargs)Bases: azure.mgmt.network.networkresourceprovider.RetriableOperationResponse
If the resource provide needs to return an error to any operation, it should return the appropriate HTTP errorcode and a message body as can be seen below.The message should be localized per the Accept-Languageheader specified in the original request such thatit could be directly be exposed to users
azure_async_operationUsers can perform a Get on Azure-AsyncOperation to get the status of their up-date(PUT/PATCH/DELETE) operations
class azure.mgmt.network.networkresourceprovider.Usage(**kwargs)Bases: object
Describes Network Resource Usage.
current_valueGets or sets the current value of the usage.
limitGets or sets the limit of usage.
nameGets or sets the name of the type of usage.
unitGets or sets an enum describing the unit of measurement.
class azure.mgmt.network.networkresourceprovider.UsageName(**kwargs)Bases: object
The Usage Names.
localized_valueGets or sets a localized string describing the resource name.
valueGets or sets a string describing the resource name.
class azure.mgmt.network.networkresourceprovider.UsageOperations(client)Bases: object
Operations for listing usage. __NOTE__: An instance of this class is automatically created for an instance ofthe [NetworkResourceProviderClient]
clientGets a reference to the Microsoft.Azure.Management.Network.NetworkResourceProviderClient.
list(location)Lists compute usages for a subscription.
Args:
location (string): The location upon which resource usage is queried.
Returns:
UsagesListResponse: The List Usages operation response.
class azure.mgmt.network.networkresourceprovider.UsageUnitBases: object
The usage unit.
count = ‘Count’
84 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
class azure.mgmt.network.networkresourceprovider.UsagesListResponse(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
The List Usages operation response.
usagesGets or sets the list Network Resource Usages.
class azure.mgmt.network.networkresourceprovider.VirtualNetwork(**kwargs)Bases: azure.mgmt.network.networkresourceprovider.TopLevelResource
Virtual Network resource
address_spaceGets or sets AddressSpace that contains an array of IP address ranges that can be used by subnets
dhcp_optionsGets or sets DHCPOptions that contains an array of DNS servers available to VMs deployed in the virtualnetwork
provisioning_stateGets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed
subnetsGets or sets List of subnets in a VirtualNetwork
class azure.mgmt.network.networkresourceprovider.VirtualNetworkGateway(**kwargs)Bases: azure.mgmt.network.networkresourceprovider.TopLevelResource
A common class for general resource information
enable_bgpEnableBgp Flag
gateway_sizeThe size of this virtual network gateway.
gateway_typeThe type of this virtual network gateway.
ip_configurationsIpConfigurations for Virtual network gateway.
provisioning_stateGets or sets Provisioning state of the VirtualNetworkGateway resource Updating/Deleting/Failed
class azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayConnection(**kwargs)Bases: azure.mgmt.network.networkresourceprovider.TopLevelResource
A common class for general resource information
connection_typeGateway connection type -Ipsec/Dedicated/VpnClient/Vnet2Vnet
local_network_gateway2
provisioning_stateGets or sets Provisioning state of the VirtualNetworkGatewayConnection resource Updat-ing/Deleting/Failed
routing_weightThe Routing weight.
shared_keyThe Ipsec share key.
8.7. azure package 85
Azure SDK for Python Documentation, Release 1.0.3
virtual_network_gateway1
virtual_network_gateway2
class azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayConnectionGetResponse(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
Response for GetVitualNetworkGatewayConnection Api servive call.
virtual_network_gateway_connectionGets virtual network gateway connection details that exists in a resource group
class azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayConnectionListResponse(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
Response for ListVirtualNetworkGatewayConnections Api service call
next_linkGets the URL to get the next set of results.
virtual_network_gateway_connectionsGets List of VirtualNetworkGatewayConnections that exists in a resource group
class azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayConnectionOperations(client)Bases: object
The Network Resource Provider API includes operations for managing the Virtual network Gateway for yoursubscription. __NOTE__: An instance of this class is automatically created for an instance of the [NetworkRe-sourceProviderClient]
begin_create_or_updating(resource_group_name, virtual_network_gateway_connection_name,parameters)
The Put VirtualNetworkGatewayConnection operation creates/updates a virtual network gateway connec-tion in the specified resource group through Network resource provider.
Args:
resource_group_name (string): The name of the resource group.
virtual_network_gateway_connection_name (string): The name of the virtual network gateway conenc-tion.
parameters (VirtualNetworkGatewayConnection): Parameters supplied to the Begin Create or update Vir-tual Network Gateway connection operation through Network resource provider.
Returns:
VirtualNetworkGatewayConnectionPutResponse: Response for CreateOrUpdateVirtualNetworkGateway-Connection Api servive call
begin_deleting(resource_group_name, virtual_network_gateway_connection_name)The Delete VirtualNetworkGatewayConnection operation deletes the specifed virtual network Gatewayconnection through Network resource provider.
Args:
resource_group_name (string): The name of the resource group.
virtual_network_gateway_connection_name (string): The name of the virtual network gateway connec-tion.
Returns:
UpdateOperationResponse: If the resource provide needs to return an error to any operation, it shouldreturn the appropriate HTTP error code and a message body as can be seen below.The message should be
86 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
localized per the Accept-Language header specified in the original request such thatit could be directly beexposed to users
begin_reset_shared_key(resource_group_name, virtual_network_gateway_connection_name,parameters)
The VirtualNetworkGatewayConnectionResetSharedKey operation resets the virtual network gatewayconnection shared key for passed virtual network gateway connection in the specified resource groupthrough Network resource provider.
Args:
resource_group_name (string): The name of the resource group.
virtual_network_gateway_connection_name (string): The virtual network gateway connection reset sharedkey Name.
parameters (ConnectionResetSharedKey): Parameters supplied to the Begin Reset Virtual Network Gate-way connection shared key operation through Network resource provider.
Returns:
ConnectionResetSharedKeyPutResponse: Response for PutVirtualNetworkGatewayConnectionReset-SharedKey Api servive call
begin_set_shared_key(resource_group_name, virtual_network_gateway_connection_name, pa-rameters)
The Put VirtualNetworkGatewayConnectionSharedKey operation sets the virtual network gateway con-nection shared key for passed virtual network gateway connection in the specified resource group throughNetwork resource provider.
Args:
resource_group_name (string): The name of the resource group.
virtual_network_gateway_connection_name (string): The virtual network gateway connection name.
parameters (ConnectionSharedKey): Parameters supplied to the Begin Set Virtual Network Gatewayconection Shared key operation throughNetwork resource provider.
Returns:
ConnectionSharedKeyPutResponse: Response for PutVirtualNetworkGatewayConnectionSharedKey Apiservive call
clientGets a reference to the Microsoft.Azure.Management.Network.NetworkResourceProviderClient.
create_or_update(resource_group_name, virtual_network_gateway_connection_name, parame-ters)
The CreateOrUpdate Virtual network Gateway connection creates a new or updates an existing virtualnet-work gateway connection through Network resource provider.
Args:
resource_group_name (string): The name of the resource group.
virtual_network_gateway_connection_name (string): The name of the virtual network gateway conenc-tion.
parameters (VirtualNetworkGatewayConnection): Parameters supplied to the Begin Create or update Vir-tual Network Gateway connection operation through Network resource provider.
Returns:
AzureAsyncOperationResponse: The response body contains the status of the specified asynchronousoperation, indicating whether it has succeeded, is inprogress, or has failed. Note that this status is distinct
8.7. azure package 87
Azure SDK for Python Documentation, Release 1.0.3
from the HTTP status code returned for the Get Operation Status operation itself. If the asynchronousoperation succeeded, the response body includes the HTTP status code for the successful request. If theasynchronous operation failed, the response body includes the HTTP status code for the failed request anderror information regarding the failure.
delete(resource_group_name, virtual_network_gateway_connection_name)The Delete VirtualNetworkGatewayConnection operation deletes the specifed virtual network Gatewayconnection through Network resource provider.
Args:
resource_group_name (string): The name of the resource group.
virtual_network_gateway_connection_name (string): The name of the virtual network gateway connec-tion.
Returns:
AzureOperationResponse: A standard service response including an HTTP status code and request ID.
get(resource_group_name, virtual_network_gateway_connection_name)The Get VirtualNetworkGatewayConnection operation retrieves information about the specified virtualnetwork gateway connection through Network resource provider.
Args:
resource_group_name (string): The name of the resource group.
virtual_network_gateway_connection_name (string): The name of the virtual network gateway connec-tion.
Returns:
VirtualNetworkGatewayConnectionGetResponse: Response for GetVitualNetworkGatewayConnectionApi servive call.
get_shared_key(resource_group_name, connection_shared_key_name)The Get VirtualNetworkGatewayConnectionSharedKey operation retrieves information about the specifiedvirtual network gateway connection shared key through Network resource provider.
Args:
resource_group_name (string): The name of the resource group.
connection_shared_key_name (string): The virtual network gateway connection shared key name.
Returns:
ConnectionSharedKeyResponse: Response for CheckConnectionSharedKey Api servive call
list(resource_group_name)The List VirtualNetworkGatewayConnections operation retrieves all the virtual network gateways connec-tions created.
Args:
resource_group_name (string): The name of the resource group.
Returns:
VirtualNetworkGatewayConnectionListResponse: Response for ListVirtualNetworkGatewayConnectionsApi service call
reset_shared_key(resource_group_name, virtual_network_gateway_connection_name, parame-ters)
The Reset VirtualNetworkGatewayConnectionSharedKey operation resets the virtual network gateway
88 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
connection shared key for passed virtual network gateway connection in the specified resource groupthrough Network resource provider.
Args:
resource_group_name (string): The name of the resource group.
virtual_network_gateway_connection_name (string): The virtual network gateway connection name.
parameters (ConnectionResetSharedKey): Parameters supplied to the Begin Reset Virtual Network Gate-way connection shared key operation through Network resource provider.
Returns:
AzureAsyncOperationResponse: The response body contains the status of the specified asynchronousoperation, indicating whether it has succeeded, is inprogress, or has failed. Note that this status is distinctfrom the HTTP status code returned for the Get Operation Status operation itself. If the asynchronousoperation succeeded, the response body includes the HTTP status code for the successful request. If theasynchronous operation failed, the response body includes the HTTP status code for the failed request anderror information regarding the failure.
set_shared_key(resource_group_name, virtual_network_gateway_connection_name, parameters)The Put VirtualNetworkGatewayConnectionSharedKey operation sets the virtual network gateway con-nection shared key for passed virtual network gateway connection in the specified resource group throughNetwork resource provider.
Args:
resource_group_name (string): The name of the resource group.
virtual_network_gateway_connection_name (string): The virtual network gateway connection name.
parameters (ConnectionSharedKey): Parameters supplied to the Begin Create or update Virtual NetworkGateway connection shared key operation through Network resource provider.
Returns:
AzureAsyncOperationResponse: The response body contains the status of the specified asynchronousoperation, indicating whether it has succeeded, is inprogress, or has failed. Note that this status is distinctfrom the HTTP status code returned for the Get Operation Status operation itself. If the asynchronousoperation succeeded, the response body includes the HTTP status code for the successful request. If theasynchronous operation failed, the response body includes the HTTP status code for the failed request anderror information regarding the failure.
class azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayConnectionPutResponse(**kwargs)Bases: azure.mgmt.network.networkresourceprovider.UpdateOperationResponse
Response for CreateOrUpdateVirtualNetworkGatewayConnection Api servive call
virtual_network_gateway_connectionGets the virtual network gateway connection that exists in a resource group
class azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayConnectionTypeBases: object
The different connection types that a virtual network gateway can have.
dedicated = ‘Dedicated’
ipsec = ‘IPsec’
vnet2_vnet = ‘Vnet2Vnet’
vpn_client = ‘VPNClient’
8.7. azure package 89
Azure SDK for Python Documentation, Release 1.0.3
class azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayGetResponse(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
Response for GetVitualNetworkgateway Api servive call.
virtual_network_gatewayGets virtual network gateway details that exists in a resource group
class azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayIpConfiguration(**kwargs)Bases: azure.mgmt.network.networkresourceprovider.ChildResource
IpConfiguration for Virtual network gateway
private_ip_addressGets or sets the privateIPAddress of the Network Interface IP Configuration
private_ip_allocation_methodGets or sets PrivateIP allocation method (Static/Dynamic)
provisioning_stateGets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed
public_ip_addressGets or sets the reference of the PublicIP resource
subnetGets or sets the reference of the subnet resource
class azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayListResponse(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
Response for ListVirtualNetworkGateways Api service call
next_linkGets the URL to get the next set of results.
virtual_network_gatewaysGets List of VirtualNetworkGateways that exists in a resource group
class azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayOperations(client)Bases: object
The Network Resource Provider API includes operations for managing the Virtual network Gateway for yoursubscription. __NOTE__: An instance of this class is automatically created for an instance of the [NetworkRe-sourceProviderClient]
begin_create_or_updating(resource_group_name, virtual_network_gateway_name, parame-ters)
The Put VirtualNetworkGateway operation creates/updates a virtual network gateway in the specified re-source group through Network resource provider.
Args:
resource_group_name (string): The name of the resource group.
virtual_network_gateway_name (string): The name of the virtual network gateway.
parameters (VirtualNetworkGateway): Parameters supplied to the Begin Create or update Virtual NetworkGateway operation through Network resource provider.
Returns:
VirtualNetworkGatewayPutResponse: Response for PutVirtualNetworkGateway Api servive call
90 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
begin_deleting(resource_group_name, virtual_network_gateway_name)The Delete VirtualNetworkGateway operation deletes the specifed virtual network Gateway through Net-work resource provider.
Args:
resource_group_name (string): The name of the resource group.
virtual_network_gateway_name (string): The name of the virtual network gateway.
Returns:
UpdateOperationResponse: If the resource provide needs to return an error to any operation, it shouldreturn the appropriate HTTP error code and a message body as can be seen below.The message should belocalized per the Accept-Language header specified in the original request such thatit could be directly beexposed to users
begin_reset(resource_group_name, virtual_network_gateway_name, parameters)The Reset VirtualNetworkGateway operation resets the primary of the virtual network gatewayin the spec-ified resource group through Network resource provider.
Args:
resource_group_name (string): The name of the resource group.
virtual_network_gateway_name (string): The name of the virtual network gateway.
parameters (VirtualNetworkGateway): Parameters supplied to the Begin Reset Virtual Network Gatewayoperation through Network resource provider.
Returns:
VirtualNetworkGatewayPutResponse: Response for PutVirtualNetworkGateway Api servive call
clientGets a reference to the Microsoft.Azure.Management.Network.NetworkResourceProviderClient.
create_or_update(resource_group_name, virtual_network_gateway_name, parameters)The Put VirtualNetworkGateway operation creates/updates a virtual network gateway in the specified re-source group through Network resource provider.
Args:
resource_group_name (string): The name of the resource group.
virtual_network_gateway_name (string): The name of the virtual network gateway.
parameters (VirtualNetworkGateway): Parameters supplied to the Begin Create or update Virtual NetworkGateway operation through Network resource provider.
Returns:
AzureAsyncOperationResponse: The response body contains the status of the specified asynchronousoperation, indicating whether it has succeeded, is inprogress, or has failed. Note that this status is distinctfrom the HTTP status code returned for the Get Operation Status operation itself. If the asynchronousoperation succeeded, the response body includes the HTTP status code for the successful request. If theasynchronous operation failed, the response body includes the HTTP status code for the failed request anderror information regarding the failure.
delete(resource_group_name, virtual_network_gateway_name)The Delete VirtualNetworkGateway operation deletes the specifed virtual network Gateway through Net-work resource provider.
Args:
8.7. azure package 91
Azure SDK for Python Documentation, Release 1.0.3
resource_group_name (string): The name of the resource group.
virtual_network_gateway_name (string): The name of the virtual network gateway.
Returns:
AzureOperationResponse: A standard service response including an HTTP status code and request ID.
get(resource_group_name, virtual_network_gateway_name)The Get VirtualNetworkGateway operation retrieves information about the specified virtual network gate-way through Network resource provider.
Args:
resource_group_name (string): The name of the resource group.
virtual_network_gateway_name (string): The name of the virtual network gateway.
Returns:
VirtualNetworkGatewayGetResponse: Response for GetVitualNetworkgateway Api servive call.
list(resource_group_name)The List VirtualNetworkGateways opertion retrieves all the virtual network gateways stored.
Args:
resource_group_name (string): The name of the resource group.
Returns:
VirtualNetworkGatewayListResponse: Response for ListVirtualNetworkGateways Api service call
reset(resource_group_name, virtual_network_gateway_name, parameters)The Reset VirtualNetworkGateway operation resets the primary of the virtual network gateway in thespecified resource group through Network resource provider.
Args:
resource_group_name (string): The name of the resource group.
virtual_network_gateway_name (string): The name of the virtual network gateway.
parameters (VirtualNetworkGateway): Parameters supplied to the Begin Reset Virtual Network Gatewayoperation through Network resource provider.
Returns:
AzureAsyncOperationResponse: The response body contains the status of the specified asynchronousoperation, indicating whether it has succeeded, is inprogress, or has failed. Note that this status is distinctfrom the HTTP status code returned for the Get Operation Status operation itself. If the asynchronousoperation succeeded, the response body includes the HTTP status code for the successful request. If theasynchronous operation failed, the response body includes the HTTP status code for the failed request anderror information regarding the failure.
class azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayPutResponse(**kwargs)Bases: azure.mgmt.network.networkresourceprovider.UpdateOperationResponse
Response for PutVirtualNetworkGateway Api servive call
virtual_network_gatewayPuts the virtual network gateway that exists in a resource group
class azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewaySizeBases: object
The different SKUs that a gateway can have.
92 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
default = ‘Default’
high_performance = ‘HighPerformance’
class azure.mgmt.network.networkresourceprovider.VirtualNetworkGetResponse(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
Response for GetVirtualNetworks API service calls.
virtual_networkGets a VirtualNetwork in a resource group
class azure.mgmt.network.networkresourceprovider.VirtualNetworkListResponse(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
Response for ListVirtualNetworks Api servive call
next_linkGets the URL to get the next set of results.
virtual_networksGets list of VirtualNetworks in a resource group
class azure.mgmt.network.networkresourceprovider.VirtualNetworkOperations(client)Bases: object
The Network Resource Provider API includes operations for managing the Virtual Networks for your subscrip-tion. __NOTE__: An instance of this class is automatically created for an instance of the [NetworkResource-ProviderClient]
begin_create_or_updating(resource_group_name, virtual_network_name, parameters)The Put VirtualNetwork operation creates/updates a virtual network in the specified resource group.
Args:
resource_group_name (string): The name of the resource group.
virtual_network_name (string): The name of the virtual network.
parameters (VirtualNetwork): Parameters supplied to the create/update Virtual Network operation
Returns:
VirtualNetworkPutResponse: Response for PutVirtualNetworks API service calls.
begin_deleting(resource_group_name, virtual_network_name)The Delete VirtualNetwork operation deletes the specifed virtual network
Args:
resource_group_name (string): The name of the resource group.
virtual_network_name (string): The name of the virtual network.
Returns:
UpdateOperationResponse: If the resource provide needs to return an error to any operation, it shouldreturn the appropriate HTTP error code and a message body as can be seen below.The message should belocalized per the Accept-Language header specified in the original request such thatit could be directly beexposed to users
clientGets a reference to the Microsoft.Azure.Management.Network.NetworkResourceProviderClient.
8.7. azure package 93
Azure SDK for Python Documentation, Release 1.0.3
create_or_update(resource_group_name, virtual_network_name, parameters)The Put VirtualNetwork operation creates/updates a virtual networkin the specified resource group.
Args:
resource_group_name (string): The name of the resource group.
virtual_network_name (string): The name of the virtual network.
parameters (VirtualNetwork): Parameters supplied to the create/update Virtual Network operation
Returns:
AzureAsyncOperationResponse: The response body contains the status of the specified asynchronousoperation, indicating whether it has succeeded, is inprogress, or has failed. Note that this status is distinctfrom the HTTP status code returned for the Get Operation Status operation itself. If the asynchronousoperation succeeded, the response body includes the HTTP status code for the successful request. If theasynchronous operation failed, the response body includes the HTTP status code for the failed request anderror information regarding the failure.
delete(resource_group_name, virtual_network_name)The Delete VirtualNetwork operation deletes the specifed virtual network
Args:
resource_group_name (string): The name of the resource group.
virtual_network_name (string): The name of the virtual network.
Returns:
AzureOperationResponse: A standard service response including an HTTP status code and request ID.
get(resource_group_name, virtual_network_name)The Get VirtualNetwork operation retrieves information about the specified virtual network.
Args:
resource_group_name (string): The name of the resource group.
virtual_network_name (string): The name of the virtual network.
Returns:
VirtualNetworkGetResponse: Response for GetVirtualNetworks API service calls.
list(resource_group_name)The list VirtualNetwork returns all Virtual Networks in a resource group
Args:
resource_group_name (string): The name of the resource group.
Returns:
VirtualNetworkListResponse: Response for ListVirtualNetworks Api servive call
list_all()The list VirtualNetwork returns all Virtual Networks in a subscription
Returns:
VirtualNetworkListResponse: Response for ListVirtualNetworks Api servive call
class azure.mgmt.network.networkresourceprovider.VirtualNetworkPutResponse(**kwargs)Bases: azure.mgmt.network.networkresourceprovider.UpdateOperationResponse
Response for PutVirtualNetworks API service calls.
94 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
virtual_networkGets a VirtualNetwork in a resource group
class azure.mgmt.network.networkresourceprovider.VpnGatewayTypeBases: object
dynamic_routing = ‘DynamicRouting’
static_routing = ‘StaticRouting’
Module contents
azure.mgmt.resource package
Submodules
azure.mgmt.resource.resourcemanagement module
class azure.mgmt.resource.resourcemanagement.BasicDependency(**kwargs)Bases: object
Deployment dependency information.
idGets or sets the ID of the dependency.
resource_nameGets or sets the dependency resource name.
resource_typeGets or sets the dependency resource type.
class azure.mgmt.resource.resourcemanagement.Dependency(**kwargs)Bases: azure.mgmt.resource.resourcemanagement.BasicDependency
Deployment dependency information.
depends_onGets the list of dependencies.
class azure.mgmt.resource.resourcemanagement.Deployment(**kwargs)Bases: object
Deployment operation parameters.
propertiesGets or sets the deployment properties.
class azure.mgmt.resource.resourcemanagement.DeploymentExtended(**kwargs)Bases: object
Deployment information.
idGets or sets the ID of the deployment.
nameGets or sets the name of the deployment.
propertiesGets or sets deployment properties.
8.7. azure package 95
Azure SDK for Python Documentation, Release 1.0.3
class azure.mgmt.resource.resourcemanagement.DeploymentGetResult(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
Template deployment information.
deploymentGets or sets the deployment.
class azure.mgmt.resource.resourcemanagement.DeploymentListParameters(**kwargs)Bases: object
Deployment list operation parameters.
provisioning_stateGet or sets the provisioning state to filer by. Optional.
topGet or sets the number of records to return. Optional.
class azure.mgmt.resource.resourcemanagement.DeploymentListResult(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
List of deployments.
deploymentsGets or sets the list of deployments.
next_linkGets or sets the URL to get the next set of results.
class azure.mgmt.resource.resourcemanagement.DeploymentModeBases: object
Specifies the deployment type for the deployment operations.
incremental = ‘Incremental’
class azure.mgmt.resource.resourcemanagement.DeploymentOperation(**kwargs)Bases: object
Deployment operation information.
idGets or sets full deployment operation id.
operation_idGets or sets deployment operation id.
propertiesGets or sets deployment properties.
class azure.mgmt.resource.resourcemanagement.DeploymentOperationOperations(client)Bases: object
Operations for managing deployment operations. __NOTE__: An instance of this class is automatically createdfor an instance of the [ResourceManagementClient]
clientGets a reference to the Microsoft.Azure.Management.Resources.ResourceManagementClient.
get(resource_group_name, deployment_name, operation_id)Get a list of deployments operations.
Args:
resource_group_name (string): The name of the resource group. The name is case insensitive.
96 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
deployment_name (string): The name of the deployment.
operation_id (string): Operation Id.
Returns:
DeploymentOperationsGetResult: Deployment operation.
list(resource_group_name, deployment_name, parameters)Gets a list of deployments operations.
Args:
resource_group_name (string): The name of the resource group. The name is case insensitive.
deployment_name (string): The name of the deployment.
parameters (DeploymentOperationsListParameters): Query parameters.
Returns:
DeploymentOperationsListResult: List of deployment operations.
list_next(next_link)Gets a next list of deployments operations.
Args:
next_link (string): NextLink from the previous successful call to List operation.
Returns:
DeploymentOperationsListResult: List of deployment operations.
class azure.mgmt.resource.resourcemanagement.DeploymentOperationProperties(**kwargs)Bases: object
Deployment operation properties.
provisioning_stateGets or sets the state of the provisioning.
status_codeGets or sets operation status code.
status_messageGets or sets operation status message.
target_resourceGets or sets the target resource.
timestampGets or sets the date and time of the operation.
class azure.mgmt.resource.resourcemanagement.DeploymentOperations(client)Bases: object
Operations for managing deployments. __NOTE__: An instance of this class is automatically created for aninstance of the [ResourceManagementClient]
cancel(resource_group_name, deployment_name)Cancel a currently running template deployment.
Args:
resource_group_name (string): The name of the resource group. The name is case insensitive.
deployment_name (string): The name of the deployment.
8.7. azure package 97
Azure SDK for Python Documentation, Release 1.0.3
Returns:
AzureOperationResponse: A standard service response including an HTTP status code and request ID.
clientGets a reference to the Microsoft.Azure.Management.Resources.ResourceManagementClient.
create_or_update(resource_group_name, deployment_name, parameters)Create a named template deployment using a template.
Args:
resource_group_name (string): The name of the resource group. The name is case insensitive.
deployment_name (string): The name of the deployment.
parameters (Deployment): Additional parameters supplied to the operation.
Returns:
DeploymentOperationsCreateResult: Template deployment operation create result.
get(resource_group_name, deployment_name)Get a deployment.
Args:
resource_group_name (string): The name of the resource group to get. The name is case insensitive.
deployment_name (string): The name of the deployment.
Returns:
DeploymentGetResult: Template deployment information.
list(resource_group_name, parameters)Get a list of deployments.
Args:
resource_group_name (string): The name of the resource group to filter by. The name is case insensitive.
parameters (DeploymentListParameters): Query parameters. If null is passed returns all deployments.
Returns:
DeploymentListResult: List of deployments.
list_next(next_link)Get a list of deployments.
Args:
next_link (string): NextLink from the previous successful call to List operation.
Returns:
DeploymentListResult: List of deployments.
validate(resource_group_name, deployment_name, parameters)Validate a deployment template.
Args:
resource_group_name (string): The name of the resource group. The name is case insensitive.
deployment_name (string): The name of the deployment.
parameters (Deployment): Deployment to validate.
98 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
Returns:
DeploymentValidateResponse: Information from validate template deployment response.
class azure.mgmt.resource.resourcemanagement.DeploymentOperationsCreateResult(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
Template deployment operation create result.
deploymentGets or sets the deployment.
class azure.mgmt.resource.resourcemanagement.DeploymentOperationsGetResult(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
Deployment operation.
operationGets or sets the deployment operation.
class azure.mgmt.resource.resourcemanagement.DeploymentOperationsListParameters(**kwargs)Bases: object
Deployment operation list parameters.
topGet or sets the number of records to return. Optional.
class azure.mgmt.resource.resourcemanagement.DeploymentOperationsListResult(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
List of deployment operations.
next_linkGets or sets the URL to get the next set of results.
operationsGets or sets the list of deployments.
class azure.mgmt.resource.resourcemanagement.DeploymentProperties(**kwargs)Bases: object
Deployment properties.
modeGets or sets the deployment mode.
parametersDeployment parameters. Use only one of Parameters or ParametersLink.
parameters_linkGets or sets the URI referencing the parameters. Use only one of Parameters or ParametersLink.
templateGets or sets the template content. Use only one of Template or TemplateLink.
template_linkGets or sets the URI referencing the template. Use only one of Template or TemplateLink.
class azure.mgmt.resource.resourcemanagement.DeploymentPropertiesExtended(**kwargs)Bases: azure.mgmt.resource.resourcemanagement.DeploymentProperties
Deployment properties with additional details.
correlation_idGets or sets the correlation ID of the deployment.
8.7. azure package 99
Azure SDK for Python Documentation, Release 1.0.3
dependenciesGets the list of deployment dependencies.
outputsGets or sets key/value pairs that represent deploymentoutput.
providersGets the list of resource providers needed for the deployment.
provisioning_stateGets or sets the state of the provisioning.
timestampGets or sets the timestamp of the template deployment.
class azure.mgmt.resource.resourcemanagement.DeploymentValidateResponse(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
Information from validate template deployment response.
errorGets or sets validation error.
is_validGets or sets the value indicating whether the template is valid or not.
propertiesGets or sets the template deployment properties.
class azure.mgmt.resource.resourcemanagement.GenericResource(**kwargs)Bases: azure.mgmt.common.arm.ResourceBase
Resource information.
planGets or sets the plan of the resource.
propertiesGets or sets the resource properties.
provisioning_stateGets or sets resource provisioning state.
class azure.mgmt.resource.resourcemanagement.GenericResourceExtended(**kwargs)Bases: azure.mgmt.common.arm.ResourceBaseExtended
Resource information.
planGets or sets the plan of the resource.
propertiesGets or sets the resource properties.
provisioning_stateGets or sets resource provisioning state.
class azure.mgmt.resource.resourcemanagement.LongRunningOperationResponse(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
A standard service response for long running operations.
error
operation_status_link
100 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
retry_after
status
class azure.mgmt.resource.resourcemanagement.ParametersLink(**kwargs)Bases: object
Entity representing the reference to the deployment paramaters.
content_versionIf included it must match the ContentVersion in the template.
uriURI referencing the template.
class azure.mgmt.resource.resourcemanagement.Plan(**kwargs)Bases: object
Plan for the resource.
nameGets or sets the plan ID.
productGets or sets the offer ID.
promotion_codeGets or sets the promotion code.
publisherGets or sets the publisher ID.
class azure.mgmt.resource.resourcemanagement.Provider(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
Resource provider information.
idGets or sets the provider id.
namespaceGets or sets the namespace of the provider.
registration_stateGets or sets the registration state of the provider.
resource_typesGets or sets the collection of provider resource types.
class azure.mgmt.resource.resourcemanagement.ProviderGetResult(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
Resource provider information.
providerGets or sets the resource provider.
class azure.mgmt.resource.resourcemanagement.ProviderListParameters(**kwargs)Bases: object
Deployment list operation parameters.
topGet or sets the number of records to return. Optional.
8.7. azure package 101
Azure SDK for Python Documentation, Release 1.0.3
class azure.mgmt.resource.resourcemanagement.ProviderListResult(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
List of resource providers.
next_linkGets or sets the URL to get the next set of results.
providersGets or sets the list of resource providers.
class azure.mgmt.resource.resourcemanagement.ProviderOperations(client)Bases: object
Operations for managing providers. __NOTE__: An instance of this class is automatically created for an in-stance of the [ResourceManagementClient]
clientGets a reference to the Microsoft.Azure.Management.Resources.ResourceManagementClient.
get(resource_provider_namespace)Gets a resource provider.
Args:
resource_provider_namespace (string): Namespace of the resource provider.
Returns:
ProviderGetResult: Resource provider information.
list(parameters)Gets a list of resource providers.
Args:
parameters (ProviderListParameters): Query parameters. If null is passed returns all deployments.
Returns:
ProviderListResult: List of resource providers.
list_next(next_link)Get a list of deployments.
Args:
next_link (string): NextLink from the previous successful call to List operation.
Returns:
ProviderListResult: List of resource providers.
register(resource_provider_namespace)Registers provider to be used with a subscription.
Args:
resource_provider_namespace (string): Namespace of the resource provider.
Returns:
ProviderRegistionResult: Resource provider registration information.
unregister(resource_provider_namespace)Unregisters provider from a subscription.
Args:
102 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
resource_provider_namespace (string): Namespace of the resource provider.
Returns:
ProviderUnregistionResult: Resource provider registration information.
class azure.mgmt.resource.resourcemanagement.ProviderRegistionResult(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
Resource provider registration information.
providerGets or sets the resource provider.
class azure.mgmt.resource.resourcemanagement.ProviderRegistrationStateBases: object
Provider registration states.
not_registered = ‘NotRegistered’
registered = ‘Registered’
registering = ‘Registering’
unregistering = ‘Unregistering’
class azure.mgmt.resource.resourcemanagement.ProviderResourceType(**kwargs)Bases: object
Resource type managed by the resource provider.
api_versionsGets or sets the api version.
locationsGets or sets the collection of locations where this resource type can be created in.
nameGets or sets the resource type.
propertiesGets or sets the properties.
class azure.mgmt.resource.resourcemanagement.ProviderUnregistionResult(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
Resource provider registration information.
providerGets or sets the resource provider.
class azure.mgmt.resource.resourcemanagement.ProvisioningStateBases: object
Common provisioning states.
accepted = ‘Accepted’
canceled = ‘Canceled’
created = ‘Created’
creating = ‘Creating’
deleted = ‘Deleted’
deleting = ‘Deleting’
8.7. azure package 103
Azure SDK for Python Documentation, Release 1.0.3
failed = ‘Failed’
not_specified = ‘NotSpecified’
registering = ‘Registering’
running = ‘Running’
succeeded = ‘Succeeded’
class azure.mgmt.resource.resourcemanagement.ResourceCreateOrUpdateResult(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
Resource information.
resourceGets or sets the resource.
class azure.mgmt.resource.resourcemanagement.ResourceExistsResult(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
Resource group information.
existsGets or sets the value indicating whether the resource group exists.
class azure.mgmt.resource.resourcemanagement.ResourceGetResult(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
Resource information.
resourceGets or sets the resource.
class azure.mgmt.resource.resourcemanagement.ResourceGroup(**kwargs)Bases: object
Resource group information.
locationGets or sets the location of the resource group. It cannot be changed after the resource group has beencreated. Has to be one of the supported Azure Locations, such as West US, East US, West Europe, EastAsia, etc.
propertiesGets or sets the resource group properties.
provisioning_stateGets or sets resource group provisioning state.
tagsGets or sets the tags attached to the resource group.
class azure.mgmt.resource.resourcemanagement.ResourceGroupCreateOrUpdateResult(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
Resource group information.
resource_groupGets or sets the resource group.
class azure.mgmt.resource.resourcemanagement.ResourceGroupExistsResult(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
Resource group information.
104 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
existsGets or sets the value indicating whether the resource group exists.
class azure.mgmt.resource.resourcemanagement.ResourceGroupExtended(**kwargs)Bases: azure.mgmt.resource.resourcemanagement.ResourceGroup
Resource group information.
idGets or sets the ID of the resource group.
nameGets or sets the Name of the resource group.
class azure.mgmt.resource.resourcemanagement.ResourceGroupGetResult(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
Resource group information.
resource_groupGets or sets the resource group.
class azure.mgmt.resource.resourcemanagement.ResourceGroupListParameters(**kwargs)Bases: object
Resource group information.
tag_nameFilter the results based on a particular tag name. Optional.
tag_valueFilter the results for a tag name along with a particular tag value. Optional.
topNumber of records to return. Optional.
class azure.mgmt.resource.resourcemanagement.ResourceGroupListResult(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
List of resource groups.
next_linkGets or sets the URL to get the next set of results.
resource_groupsGets or sets the list of resource groups.
class azure.mgmt.resource.resourcemanagement.ResourceGroupOperations(client)Bases: object
Operations for managing resource groups. __NOTE__: An instance of this class is automatically created for aninstance of the [ResourceManagementClient]
begin_deleting(resource_group_name)Begin deleting resource group.To determine whether the operation has finished processing the request, callGetLongRunningOperationStatus.
Args:
resource_group_name (string): The name of the resource group to be deleted. The name is case insensitive.
Returns:
LongRunningOperationResponse: A standard service response for long running operations.
8.7. azure package 105
Azure SDK for Python Documentation, Release 1.0.3
check_existence(resource_group_name)Checks whether resource group exists.
Args:
resource_group_name (string): The name of the resource group to check. The name is case insensitive.
Returns:
ResourceGroupExistsResult: Resource group information.
clientGets a reference to the Microsoft.Azure.Management.Resources.ResourceManagementClient.
create_or_update(resource_group_name, parameters)Create a resource group.
Args:
resource_group_name (string): The name of the resource group to be created or updated.
parameters (ResourceGroup): Parameters supplied to the create or update resource group service operation.
Returns:
ResourceGroupCreateOrUpdateResult: Resource group information.
delete(resource_group_name)Delete resource group and all of its resources.
Args:
resource_group_name (string): The name of the resource group to be deleted. The name is case insensitive.
Returns:
AzureOperationResponse: A standard service response including an HTTP status code and request ID.
get(resource_group_name)Get a resource group.
Args:
resource_group_name (string): The name of the resource group to get. The name is case insensitive.
Returns:
ResourceGroupGetResult: Resource group information.
list(parameters)Gets a collection of resource groups.
Args:
parameters (ResourceGroupListParameters): Query parameters. If null is passed returns all resourcegroups.
Returns:
ResourceGroupListResult: List of resource groups.
list_next(next_link)Get a list of deployments.
Args:
next_link (string): NextLink from the previous successful call to List operation.
Returns:
106 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
ResourceGroupListResult: List of resource groups.
patch(resource_group_name, parameters)Resource groups can be updated through a simple PATCH operation to a group address. The format of therequest is the same as that for creating a resource groups, though if a field is unspecified current value willbe carried over.
Args:
resource_group_name (string): The name of the resource group to be created or updated. The name is caseinsensitive.
parameters (ResourceGroup): Parameters supplied to the update state resource group service operation.
Returns:
ResourceGroupPatchResult: Resource group information.
class azure.mgmt.resource.resourcemanagement.ResourceGroupPatchResult(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
Resource group information.
resource_groupGets or sets the resource group.
class azure.mgmt.resource.resourcemanagement.ResourceIdentity(**kwargs)
class azure.mgmt.resource.resourcemanagement.ResourceListParameters(**kwargs)Bases: object
Resource group information.
resource_group_nameGets or sets resource resource group to filter by. Optional.
resource_typeFilter the results for a particular resource type. Optional.
tag_nameFilter the results based on a particular tag name. Optional.
tag_valueFilter the results for a tag name along with a particular tag value. Optional.
topNumber of records to return. Optional.
class azure.mgmt.resource.resourcemanagement.ResourceListResult(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
List of resource groups.
next_linkGets or sets the URL to get the next set of results.
resourcesGets or sets the list of resource groups.
class azure.mgmt.resource.resourcemanagement.ResourceManagementClient(credentials,**kwargs)
Bases: azure.mgmt.common.Service
api_versionGets the API version.
8.7. azure package 107
Azure SDK for Python Documentation, Release 1.0.3
deployment_operationsOperations for managing deployment operations.
deploymentsOperations for managing deployments.
get_long_running_operation_status(operation_status_link)The Get Operation Status operation returns the status of the specified operation. After calling an asyn-chronous operation, you can call Get Operation Status to determine whether the operation has succeeded,failed, or is still in progress.
Args:
operation_status_link (string): Location value returned by the Begin operation.
Returns:
LongRunningOperationResponse: A standard service response for long running operations.
long_running_operation_initial_timeoutGets or sets the initial timeout for Long Running Operations.
long_running_operation_retry_timeoutGets or sets the retry timeout for Long Running Operations.
providersOperations for managing providers.
resource_groupsOperations for managing resource groups.
resource_provider_operation_detailsOperations for managing Resource provider operations.
resourcesOperations for managing resources.
tagsOperations for managing tags.
class azure.mgmt.resource.resourcemanagement.ResourceManagementError(**kwargs)Bases: object
codeGets or sets the error code returned from the server.
messageGets or sets the error message returned from the server.
targetGets or sets the target of the error.
class azure.mgmt.resource.resourcemanagement.ResourceManagementErrorWithDetails(**kwargs)Bases: azure.mgmt.resource.resourcemanagement.ResourceManagementError
detailsGets or sets validation error.
class azure.mgmt.resource.resourcemanagement.ResourceOperations(client)Bases: object
Operations for managing resources. __NOTE__: An instance of this class is automatically created for an in-stance of the [ResourceManagementClient]
108 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
check_existence(resource_group_name, identity)Checks whether resource exists.
Args:
resource_group_name (string): The name of the resource group. The name is case insensitive.
identity (ResourceIdentity): Resource identity.
Returns:
ResourceExistsResult: Resource group information.
clientGets a reference to the Microsoft.Azure.Management.Resources.ResourceManagementClient.
create_or_update(resource_group_name, identity, parameters)Create a resource.
Args:
resource_group_name (string): The name of the resource group. The name is case insensitive.
identity (ResourceIdentity): Resource identity.
parameters (GenericResource): Create or update resource parameters.
Returns:
ResourceCreateOrUpdateResult: Resource information.
delete(resource_group_name, identity)Delete resource and all of its resources.
Args:
resource_group_name (string): The name of the resource group. The name is case insensitive.
identity (ResourceIdentity): Resource identity.
Returns:
AzureOperationResponse: A standard service response including an HTTP status code and request ID.
get(resource_group_name, identity)Returns a resource belonging to a resource group.
Args:
resource_group_name (string): The name of the resource group. The name is case insensitive.
identity (ResourceIdentity): Resource identity.
Returns:
ResourceGetResult: Resource information.
list(parameters)Get all of the resources under a subscription.
Args:
parameters (ResourceListParameters): Query parameters. If null is passed returns all resource groups.
Returns:
ResourceListResult: List of resource groups.
8.7. azure package 109
Azure SDK for Python Documentation, Release 1.0.3
list_next(next_link)Get a list of deployments.
Args:
next_link (string): NextLink from the previous successful call to List operation.
Returns:
ResourceListResult: List of resource groups.
move_resources(source_resource_group_name, parameters)Move resources within or across subscriptions.
Args:
source_resource_group_name (string): Source resource group name.
parameters (ResourcesMoveInfo): move resources’ parameters.
Returns:
AzureOperationResponse: A standard service response including an HTTP status code and request ID.
class azure.mgmt.resource.resourcemanagement.ResourceProviderOperationDefinition(**kwargs)Bases: object
Resource provider operation information.
nameGets or sets the provider operation name.
resource_provider_operation_display_propertiesGets or sets the display property of the provider operation.
class azure.mgmt.resource.resourcemanagement.ResourceProviderOperationDetailListResult(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
List of resource provider operations.
resource_provider_operation_detailsGets or sets the list of resource provider operations.
class azure.mgmt.resource.resourcemanagement.ResourceProviderOperationDetailsOperations(client)Bases: object
Operations for managing Resource provider operations. __NOTE__: An instance of this class is automaticallycreated for an instance of the [ResourceManagementClient]
clientGets a reference to the Microsoft.Azure.Management.Resources.ResourceManagementClient.
list(identity)Gets a list of resource providers.
Args:
identity (ResourceIdentity): Resource identity.
Returns:
ResourceProviderOperationDetailListResult: List of resource provider operations.
class azure.mgmt.resource.resourcemanagement.ResourceProviderOperationDisplayProperties(**kwargs)Bases: object
Resource provider operation’s display properties.
110 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
descriptionGets or sets operation description.
operationGets or sets operation.
providerGets or sets operation provider.
publisherGets or sets operation description.
resourceGets or sets operation resource.
class azure.mgmt.resource.resourcemanagement.ResourcesMoveInfo(**kwargs)Bases: object
Parameters of move resources.
resourcesGets or sets the ids of the resources.
target_resource_groupThe target resource group.
class azure.mgmt.resource.resourcemanagement.TagCount(**kwargs)Bases: object
Tag count.
typeType of count.
valueValue of count.
class azure.mgmt.resource.resourcemanagement.TagCreateResult(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
Tag information.
tagGets or sets the tag.
class azure.mgmt.resource.resourcemanagement.TagCreateValueResult(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
Tag information.
valueGets or sets the tag value.
class azure.mgmt.resource.resourcemanagement.TagDetails(**kwargs)Bases: object
Tag details.
countGets or sets the tag count.
idGets or sets the tag ID.
8.7. azure package 111
Azure SDK for Python Documentation, Release 1.0.3
nameGets or sets the tag name.
valuesGets or sets the list of tag values.
class azure.mgmt.resource.resourcemanagement.TagOperations(client)Bases: object
Operations for managing tags. __NOTE__: An instance of this class is automatically created for an instance ofthe [ResourceManagementClient]
clientGets a reference to the Microsoft.Azure.Management.Resources.ResourceManagementClient.
create_or_update(tag_name)Create a subscription resource tag.
Args:
tag_name (string): The name of the tag.
Returns:
TagCreateResult: Tag information.
create_or_update_value(tag_name, tag_value)Create a subscription resource tag value.
Args:
tag_name (string): The name of the tag.
tag_value (string): The value of the tag.
Returns:
TagCreateValueResult: Tag information.
delete(tag_name)Delete a subscription resource tag.
Args:
tag_name (string): The name of the tag.
Returns:
AzureOperationResponse: A standard service response including an HTTP status code and request ID.
delete_value(tag_name, tag_value)Delete a subscription resource tag value.
Args:
tag_name (string): The name of the tag.
tag_value (string): The value of the tag.
Returns:
AzureOperationResponse: A standard service response including an HTTP status code and request ID.
list()Get a list of subscription resource tags.
Returns:
112 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
TagsListResult: List of subscription tags.
list_next(next_link)Get a list of tags under a subscription.
Args:
next_link (string): NextLink from the previous successful call to List operation.
Returns:
TagsListResult: List of subscription tags.
class azure.mgmt.resource.resourcemanagement.TagValue(**kwargs)Bases: object
Tag information.
countGets or sets the tag value count.
idGets or sets the tag ID.
valueGets or sets the tag value.
class azure.mgmt.resource.resourcemanagement.TagsListResult(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
List of subscription tags.
next_linkGets or sets the URL to get the next set of results.
tagsGets or sets the list of tags.
class azure.mgmt.resource.resourcemanagement.TargetResource(**kwargs)Bases: object
Target resource.
idGets or sets the ID of the resource.
resource_nameGets or sets the name of the resource.
resource_typeGets or sets the type of the resource.
class azure.mgmt.resource.resourcemanagement.TemplateLink(**kwargs)Bases: object
Entity representing the reference to the template.
content_versionIf included it must match the ContentVersion in the template.
uriURI referencing the template.
8.7. azure package 113
Azure SDK for Python Documentation, Release 1.0.3
Module contents
azure.mgmt.storage package
Submodules
azure.mgmt.storage.storagemanagement module
class azure.mgmt.storage.storagemanagement.AccountStatusBases: object
available = ‘Available’
unavailable = ‘Unavailable’
class azure.mgmt.storage.storagemanagement.AccountTypeBases: object
premium_lrs = ‘Premium_LRS’
standard_grs = ‘Standard_GRS’
standard_lrs = ‘Standard_LRS’
standard_ragrs = ‘Standard_RAGRS’
standard_zrs = ‘Standard_ZRS’
class azure.mgmt.storage.storagemanagement.CheckNameAvailabilityResponse(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
The CheckNameAvailability operation response.
messageGets an error message explaining the Reason value in more detail.
name_availableGets a boolean value that indicates whether the name is available for you to use. If true, the name isavailable. If false, the name has already been taken or invalid and cannot be used.
reasonGets the reason that a storage account name could not be used. The Reason element is only returned ifNameAvailable is false.
class azure.mgmt.storage.storagemanagement.CustomDomain(**kwargs)Bases: object
The custom domain assigned to this storage account. This can be set via Update.
nameGets or sets the custom domain name. Name is the CNAME source.
use_sub_domainIndicates whether indirect CName validation is enabled. Default value is false. This should only be set onupdates
class azure.mgmt.storage.storagemanagement.Endpoints(**kwargs)Bases: object
The URIs that are used to perform a retrieval of a public blob, queue or table object.
blobGets the blob endpoint.
114 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
queueGets the queue endpoint.
tableGets the table endpoint.
class azure.mgmt.storage.storagemanagement.KeyNameBases: object
The key names.
key1 = ‘key1’
key2 = ‘key2’
class azure.mgmt.storage.storagemanagement.ProvisioningStateBases: object
creating = ‘Creating’
resolving_dns = ‘ResolvingDNS’
succeeded = ‘Succeeded’
class azure.mgmt.storage.storagemanagement.ReasonBases: object
account_name_invalid = ‘AccountNameInvalid’
already_exists = ‘AlreadyExists’
class azure.mgmt.storage.storagemanagement.StorageAccount(**kwargs)Bases: azure.mgmt.common.arm.ResourceBaseExtended
The storage account.
account_typeGets the type of the storage account.
creation_timeGets the creation date and time of the storage account in UTC.
custom_domainGets the user assigned custom domain assigned to this storage account.
last_geo_failover_timeGets the timestamp of the most recent instance of a failover to the secondary location. Only the mostrecent timestamp is retained. This element is not returned if there has never been a failover instance. Onlyavailable if the accountType is StandardGRS or StandardRAGRS.
primary_endpointsGets the URLs that are used to perform a retrieval of a public blob, queue or table object.Note that Stan-dardZRS and PremiumLRS accounts only return the blob endpoint.
primary_locationGets the location of the primary for the storage account.
provisioning_stateGets the status of the storage account at the time the operation was called.
secondary_endpointsGets the URLs that are used to perform a retrieval of a public blob, queue or table object from the secondarylocation of the storage account. Only available if the accountType is StandardRAGRS.
8.7. azure package 115
Azure SDK for Python Documentation, Release 1.0.3
secondary_locationGets the location of the geo replicated secondary for the storage account. Only available if the accountTypeis StandardGRS or StandardRAGRS.
status_of_primaryGets the status indicating whether the primary location of the storage account is available or unavailable.
status_of_secondaryGets the status indicating whether the secondary location of the storage account is available or unavailable.Only available if the accountType is StandardGRS or StandardRAGRS.
class azure.mgmt.storage.storagemanagement.StorageAccountCreateParameters(**kwargs)Bases: object
The parameters to provide for the account.
account_typeGets or sets the account type.
locationGets or sets the location of the resource. This will be one of the supported and registered Azure GeoRegions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changedonce it is created.
tagsGets or sets a list of key value pairs that describe the resource. These tags can be used in viewing andgrouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource.Each tag must have a key no greater than 128 characters and value no greater than 256 characters.
class azure.mgmt.storage.storagemanagement.StorageAccountCreateResponse(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
The Create storage account operation response.
operation_status_linkGets the URL where the status of the create operation can be checked.
retry_afterGets the delay that the client should use when checking for the status of the operation. This delay isspecified in seconds as an integer; min 5 seconds, max 900 seconds (15 minutes). The storage resourceprovider will return 25 seconds initially.
statusGets the status of the create request.
storage_accountGets the storage account with the created properties populated.
class azure.mgmt.storage.storagemanagement.StorageAccountGetPropertiesResponse(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
The Get storage account operation response.
storage_accountGets the returned storage account.
class azure.mgmt.storage.storagemanagement.StorageAccountKeys(**kwargs)Bases: object
The access keys for the storage account.
key1Gets the value of key 1.
116 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
key2Gets the value of key 2.
class azure.mgmt.storage.storagemanagement.StorageAccountListKeysResponse(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
The ListKeys operation response.
storage_account_keysGets the access keys for the storage account.
class azure.mgmt.storage.storagemanagement.StorageAccountListResponse(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
The list storage accounts operation response.
next_linkGets the link to the next set of results. Currently this will always be empty as the API does not supportpagination.
storage_accountsGets the list of storage accounts and their properties.
class azure.mgmt.storage.storagemanagement.StorageAccountOperations(client)Bases: object
Operations for managing storage accounts. __NOTE__: An instance of this class is automatically created for aninstance of the [StorageManagementClient]
begin_create(resource_group_name, account_name, parameters)Asynchronously creates a new storage account with the specified parameters. Existing accounts cannot beupdated with this API and should instead use the Update Storage Account API. If an account is alreadycreated and subsequent PUT request is issued with exact same set of properties, then HTTP 200 would bereturned.
Args:
resource_group_name (string): The name of the resource group within the user’s subscription.
account_name (string): The name of the storage account within the specified resource group. Storageaccount names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
parameters (StorageAccountCreateParameters): The parameters to provide for the created account.
Returns:
StorageAccountCreateResponse: The Create storage account operation response.
check_name_availability(account_name)Checks that account name is valid and is not in use.
Args:
account_name (string): The name of the storage account within the specified resource group. Storageaccount names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
Returns:
CheckNameAvailabilityResponse: The CheckNameAvailability operation response.
clientGets a reference to the Microsoft.Azure.Management.Storage.StorageManagementClient.
create(resource_group_name, account_name, parameters)Asynchronously creates a new storage account with the specified parameters. Existing accounts cannot be
8.7. azure package 117
Azure SDK for Python Documentation, Release 1.0.3
updated with this API and should instead use the Update Storage Account API. If an account is alreadycreated and subsequent create request is issued with exact same set of properties, the request succeeds.Themax number of storage accounts that can be created per subscription is limited to 20.
Args:
resource_group_name (string): The name of the resource group within the user’s subscription.
account_name (string): The name of the storage account within the specified resource group. Storageaccount names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
parameters (StorageAccountCreateParameters): The parameters to provide for the created account.
Returns:
StorageAccountCreateResponse: The Create storage account operation response.
delete(resource_group_name, account_name)Deletes a storage account in Microsoft Azure.
Args:
resource_group_name (string): The name of the resource group within the user’s subscription.
account_name (string): The name of the storage account within the specified resource group. Storageaccount names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
Returns:
AzureOperationResponse: A standard service response including an HTTP status code and request ID.
get_properties(resource_group_name, account_name)Returns the properties for the specified storage account including but not limited to name, account type,location, and account status. The ListKeys operation should be used to retrieve storage keys.
Args:
resource_group_name (string): The name of the resource group within the user’s subscription.
account_name (string): The name of the storage account within the specified resource group. Storageaccount names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
Returns:
StorageAccountGetPropertiesResponse: The Get storage account operation response.
list()Lists all the storage accounts available under the subscription. Note that storage keys are not returned; usethe ListKeys operation for this.
Returns:
StorageAccountListResponse: The list storage accounts operation response.
list_by_resource_group(resource_group_name)Lists all the storage accounts available under the given resource group. Note that storage keys are notreturned; use the ListKeys operation for this.
Args:
resource_group_name (string): The name of the resource group within the user’s subscription.
Returns:
StorageAccountListResponse: The list storage accounts operation response.
118 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
list_keys(resource_group_name, account_name)Lists the access keys for the specified storage account.
Args:
resource_group_name (string): The name of the resource group.
account_name (string): The name of the storage account.
Returns:
StorageAccountListKeysResponse: The ListKeys operation response.
regenerate_key(resource_group_name, account_name, regenerate_key)Regenerates the access keys for the specified storage account.
Args:
resource_group_name (string): The name of the resource group within the user’s subscription.
account_name (string): The name of the storage account within the specified resource group. Storageaccount names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
regenerate_key (KeyName): Specifies name of the key which should be regenerated.
Returns:
StorageAccountRegenerateKeyResponse: The RegenerateKey operation response.
update(resource_group_name, account_name, parameters)Updates the account type or tags for a storage account. It can also be used to add a custom domain (notethat custom domains cannot be added via the Create operation). Only one custom domain is supportedper storage account. This API can only be used to update one of tags, accountType, or customDomain percall. To update multiple of these properties, call the API multiple times with one change per call. Thiscall does not change the storage keys for the account. If you want to change storage account keys, use theRegenerateKey operation. The location and name of the storage account cannot be changed after creation.
Args:
resource_group_name (string): The name of the resource group within the user’s subscription.
account_name (string): The name of the storage account within the specified resource group. Storageaccount names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
parameters (StorageAccountUpdateParameters): The parameters to update on the account. Note that onlyone property can be changed at a time using this API.
Returns:
StorageAccountUpdateResponse: The Update storage account operation response.
class azure.mgmt.storage.storagemanagement.StorageAccountRegenerateKeyResponse(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
The RegenerateKey operation response.
storage_account_keysGets the access keys associated with the storage account, one of which mayhave been regenerated by thisoperation.
class azure.mgmt.storage.storagemanagement.StorageAccountUpdateParameters(**kwargs)Bases: object
The parameters to update on the account.
8.7. azure package 119
Azure SDK for Python Documentation, Release 1.0.3
account_typeGets or sets the account type. Note that StandardZRS and PremiumLRS accounts cannot be changed toother account types, and other account types cannot be changed to StandardZRS or PremiumLRS.
custom_domainUser domain assigned to the storage account. Name is the CNAME source. Only one custom domain issupported per storage account at this time. To clear the existing custom domain, use an empty string forthe custom domain name property.
tagsGets or sets a list of key value pairs that describe the resource. These tags can be used in viewing andgrouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource.Each tag must have a key no greater than 128 characters and value no greater than 256 characters. This isa full replace so all the existing tags will be replaced on Update.
class azure.mgmt.storage.storagemanagement.StorageAccountUpdateResponse(**kwargs)Bases: azure.mgmt.common.AzureOperationResponse
The Update storage account operation response.
storage_accountGets the storage account with the updated properties populated.
class azure.mgmt.storage.storagemanagement.StorageManagementClient(credentials,**kwargs)
Bases: azure.mgmt.common.Service
The Storage Management Client.
account_type_to_string(value)Convert an enum of type AccountType to a string.
Args:
value (AccountType): The value to convert to a string.
Returns:
string: The enum value as a string.
api_versionGets the API version.
get_create_operation_status(operation_status_link)The Get Create Operation Status operation returns the status of the specified create operation. After callingthe asynchronous Begin Create operation, you can call Get Create Operation Status to determine whetherthe operation has succeeded, failed, or is still in progress.
Args:
operation_status_link (string): The URL where the status of the long-running create operation can bechecked.
Returns:
StorageAccountCreateResponse: The Create storage account operation response.
key_name_to_string(value)Convert an enum of type KeyName to a string.
Args:
value (KeyName): The value to convert to a string.
Returns:
120 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
string: The enum value as a string.
long_running_operation_initial_timeoutGets or sets the initial timeout for Long Running Operations.
long_running_operation_retry_timeoutGets or sets the retry timeout for Long Running Operations.
parse_account_type(value)Parse enum values for type AccountType.
Args:
value (string): The value to parse.
Returns:
AccountType: The enum value.
parse_key_name(value)Parse enum values for type KeyName.
Args:
value (string): The value to parse.
Returns:
KeyName: The enum value.
storage_accountsOperations for managing storage accounts.
Module contents
Module contents
azure.servicebus package
Submodules
azure.servicebus.constants module
azure.servicebus.models module
class azure.servicebus.models.AuthorizationRule(claim_type=None, claim_value=None,rights=None, key_name=None, pri-mary_key=None, secondary_key=None)
Bases: azure.servicebus._common_models.WindowsAzureData
exception azure.servicebus.models.AzureServiceBusPeekLockErrorBases: azure.common.AzureException
Indicates that peek-lock is required for this operation.
exception azure.servicebus.models.AzureServiceBusResourceNotFoundBases: azure.common.AzureException
Indicates that the resource doesn’t exist.
8.7. azure package 121
Azure SDK for Python Documentation, Release 1.0.3
class azure.servicebus.models.EventHub(message_retention_in_days=None, status=None,user_metadata=None, partition_count=None)
Bases: azure.servicebus._common_models.WindowsAzureData
class azure.servicebus.models.Message(body=None, service_bus_service=None, lo-cation=None, custom_properties=None,type=’application/atom+xml;type=entry;charset=utf-8’,broker_properties=None)
Bases: azure.servicebus._common_models.WindowsAzureData
Message class that used in send message/get mesage apis.
add_headers(request)add addtional headers to request for message request.
delete()Deletes itself if find queue name or topic name and subscription name.
unlock()Unlocks itself if find queue name or topic name and subscription name.
class azure.servicebus.models.Queue(lock_duration=None, max_size_in_megabytes=None,requires_duplicate_detection=None, re-quires_session=None, default_message_time_to_live=None,dead_lettering_on_message_expiration=None, du-plicate_detection_history_time_window=None,max_delivery_count=None, en-able_batched_operations=None, size_in_bytes=None,message_count=None)
Bases: azure.servicebus._common_models.WindowsAzureData
Queue class corresponding to Queue Description: http://msdn.microsoft.com/en-us/library/windowsazure/hh780773
class azure.servicebus.models.Rule(filter_type=None, filter_expression=None, ac-tion_type=None, action_expression=None)
Bases: azure.servicebus._common_models.WindowsAzureData
Rule class corresponding to Rule Description: http://msdn.microsoft.com/en-us/library/windowsazure/hh780753.
class azure.servicebus.models.Subscription(lock_duration=None, requires_session=None,default_message_time_to_live=None,dead_lettering_on_message_expiration=None,dead_lettering_on_filter_evaluation_exceptions=None,enable_batched_operations=None,max_delivery_count=None, mes-sage_count=None)
Bases: azure.servicebus._common_models.WindowsAzureData
Subscription class corresponding to Subscription Description: http://msdn.microsoft.com/en-us/library/windowsazure/hh780763.
class azure.servicebus.models.Topic(default_message_time_to_live=None,max_size_in_megabytes=None, re-quires_duplicate_detection=None, dupli-cate_detection_history_time_window=None, en-able_batched_operations=None, size_in_bytes=None)
Bases: azure.servicebus._common_models.WindowsAzureData
Topic class corresponding to Topic Description: http://msdn.microsoft.com/en-us/library/windowsazure/hh780749.
122 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
max_size_in_mega_bytes
azure.servicebus.servicebusservice module
class azure.servicebus.servicebusservice.ServiceBusSASAuthentication(key_name,key_value)
sign_request(request, httpclient)
class azure.servicebus.servicebusservice.ServiceBusService(service_namespace=None,account_key=None,issuer=None,x_ms_version=‘2011-06-01’,host_base=’.servicebus.windows.net’,shared_access_key_name=None,shared_access_key_value=None,authentication=None,timeout=65, re-quest_session=None)
Bases: object
Initializes the service bus service for a namespace with the specified authentication settings (SAS or ACS).
service_namespace: Service bus namespace, required for all operations. If None, the value is set to theAZURE_SERVICEBUS_NAMESPACE env variable.
account_key: ACS authentication account key. If None, the value is set to theAZURE_SERVICEBUS_ACCESS_KEY env variable. Note that if both SAS and ACS settings arespecified, SAS is used.
issuer: ACS authentication issuer. If None, the value is set to the AZURE_SERVICEBUS_ISSUER env vari-able. Note that if both SAS and ACS settings are specified, SAS is used.
x_ms_version: Unused. Kept for backwards compatibility.
host_base: Optional. Live host base url. Defaults to Azure url. Override this for on-premise.
shared_access_key_name: SAS authentication key name. Note that if both SAS and ACS settings are speci-fied, SAS is used.
shared_access_key_value: SAS authentication key value. Note that if both SAS and ACS settings are speci-fied, SAS is used.
authentication: Instance of authentication class. If this is specified, then ACS and SAS parameters are ignored.
timeout: Optional. Timeout for the http request, in seconds.
request_session: Optional. Session object to use for http requests.
account_key
create_event_hub(hub_name, hub=None, fail_on_exist=False)Creates a new Event Hub.
hub_name: Name of event hub.
hub: Optional. Event hub properties. Instance of EventHub class.
hub.message_retention_in_days: Number of days to retain the events for this Event Hub.
8.7. azure package 123
Azure SDK for Python Documentation, Release 1.0.3
hub.status: Status of the Event Hub (enabled or disabled). hub.user_metadata: User metadata.hub.partition_count: Number of shards on the Event Hub. fail_on_exist:
Specify whether to throw an exception when the event hub exists.
create_queue(queue_name, queue=None, fail_on_exist=False)Creates a new queue. Once created, this queue’s resource manifest is immutable.
queue_name: Name of the queue to create.
queue: Queue object to create.
fail_on_exist: Specify whether to throw an exception when the queue exists.
create_rule(topic_name, subscription_name, rule_name, rule=None, fail_on_exist=False)Creates a new rule. Once created, this rule’s resource manifest is immutable.
topic_name: Name of the topic.
subscription_name: Name of the subscription.
rule_name: Name of the rule.
fail_on_exist: Specify whether to throw an exception when the rule exists.
create_subscription(topic_name, subscription_name, subscription=None, fail_on_exist=False)Creates a new subscription. Once created, this subscription resource manifest is immutable.
topic_name: Name of the topic.
subscription_name: Name of the subscription.
fail_on_exist: Specify whether throw exception when subscription exists.
create_topic(topic_name, topic=None, fail_on_exist=False)Creates a new topic. Once created, this topic resource manifest is immutable.
topic_name: Name of the topic to create.
topic: Topic object to create.
fail_on_exist: Specify whether to throw an exception when the topic exists.
delete_event_hub(hub_name, fail_not_exist=False)Deletes an Event Hub. This operation will also remove all associated state.
hub_name: Name of the event hub to delete.
fail_not_exist: Specify whether to throw an exception if the event hub doesn’t exist.
delete_queue(queue_name, fail_not_exist=False)Deletes an existing queue. This operation will also remove all associated state including messages in thequeue.
queue_name: Name of the queue to delete.
fail_not_exist: Specify whether to throw an exception if the queue doesn’t exist.
delete_queue_message(queue_name, sequence_number, lock_token)Completes processing on a locked message and delete it from the queue. This operation should onlybe called after processing a previously locked message is successful to maintain At-Least-Once deliveryassurances.
queue_name: Name of the queue.
sequence_number: The sequence number of the message to be deleted as returned in BrokerProper-ties[’SequenceNumber’] by the Peek Message operation.
124 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
lock_token: The ID of the lock as returned by the Peek Message operation in BrokerProper-ties[’LockToken’]
delete_rule(topic_name, subscription_name, rule_name, fail_not_exist=False)Deletes an existing rule.
topic_name: Name of the topic.
subscription_name: Name of the subscription.
rule_name: Name of the rule to delete. DEFAULT_RULE_NAME=$Default. Use DE-FAULT_RULE_NAME to delete default rule for the subscription.
fail_not_exist: Specify whether throw exception when rule doesn’t exist.
delete_subscription(topic_name, subscription_name, fail_not_exist=False)Deletes an existing subscription.
topic_name: Name of the topic.
subscription_name: Name of the subscription to delete.
fail_not_exist: Specify whether to throw an exception when the subscription doesn’t exist.
delete_subscription_message(topic_name, subscription_name, sequence_number,lock_token)
Completes processing on a locked message and delete it from the subscription. This operation should onlybe called after processing a previously locked message is successful to maintain At-Least-Once deliveryassurances.
topic_name: Name of the topic.
subscription_name: Name of the subscription.
sequence_number: The sequence number of the message to be deleted as returned in BrokerProper-ties[’SequenceNumber’] by the Peek Message operation.
lock_token: The ID of the lock as returned by the Peek Message operation in BrokerProper-ties[’LockToken’]
delete_topic(topic_name, fail_not_exist=False)Deletes an existing topic. This operation will also remove all associated state including associated sub-scriptions.
topic_name: Name of the topic to delete.
fail_not_exist: Specify whether throw exception when topic doesn’t exist.
get_event_hub(hub_name)Retrieves an existing event hub.
hub_name: Name of the event hub.
get_queue(queue_name)Retrieves an existing queue.
queue_name: Name of the queue.
get_rule(topic_name, subscription_name, rule_name)Retrieves the description for the specified rule.
topic_name: Name of the topic.
subscription_name: Name of the subscription.
rule_name: Name of the rule.
8.7. azure package 125
Azure SDK for Python Documentation, Release 1.0.3
get_subscription(topic_name, subscription_name)Gets an existing subscription.
topic_name: Name of the topic.
subscription_name: Name of the subscription.
get_topic(topic_name)Retrieves the description for the specified topic.
topic_name: Name of the topic.
issuer
list_queues()Enumerates the queues in the service namespace.
list_rules(topic_name, subscription_name)Retrieves the rules that exist under the specified subscription.
topic_name: Name of the topic.
subscription_name: Name of the subscription.
list_subscriptions(topic_name)Retrieves the subscriptions in the specified topic.
topic_name: Name of the topic.
list_topics()Retrieves the topics in the service namespace.
peek_lock_queue_message(queue_name, timeout=‘60’)Automically retrieves and locks a message from a queue for processing. The message is guaranteed not tobe delivered to other receivers (on the same subscription only) during the lock duration period specified inthe queue description. Once the lock expires, the message will be available to other receivers. In order tocomplete processing of the message, the receiver should issue a delete command with the lock ID receivedfrom this operation. To abandon processing of the message and unlock it for other receivers, an UnlockMessage command should be issued, or the lock duration period can expire.
queue_name: Name of the queue.
timeout: Optional. The timeout parameter is expressed in seconds.
peek_lock_subscription_message(topic_name, subscription_name, timeout=‘60’)This operation is used to atomically retrieve and lock a message for processing. The message is guaranteednot to be delivered to other receivers during the lock duration period specified in buffer description. Oncethe lock expires, the message will be available to other receivers (on the same subscription only) duringthe lock duration period specified in the topic description. Once the lock expires, the message will beavailable to other receivers. In order to complete processing of the message, the receiver should issue adelete command with the lock ID received from this operation. To abandon processing of the message andunlock it for other receivers, an Unlock Message command should be issued, or the lock duration periodcan expire.
topic_name: Name of the topic.
subscription_name: Name of the subscription.
timeout: Optional. The timeout parameter is expressed in seconds.
read_delete_queue_message(queue_name, timeout=‘60’)Reads and deletes a message from a queue as an atomic operation. This operation should be used when abest-effort guarantee is sufficient for an application; that is, using this operation it is possible for messagesto be lost if processing fails.
126 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
queue_name: Name of the queue.
timeout: Optional. The timeout parameter is expressed in seconds.
read_delete_subscription_message(topic_name, subscription_name, timeout=‘60’)Read and delete a message from a subscription as an atomic operation. This operation should be usedwhen a best-effort guarantee is sufficient for an application; that is, using this operation it is possible formessages to be lost if processing fails.
topic_name: Name of the topic.
subscription_name: Name of the subscription.
timeout: Optional. The timeout parameter is expressed in seconds.
receive_queue_message(queue_name, peek_lock=True, timeout=60)Receive a message from a queue for processing.
queue_name: Name of the queue.
peek_lock: Optional. True to retrieve and lock the message. False to read and delete the message. Defaultis True (lock).
timeout: Optional. The timeout parameter is expressed in seconds.
receive_subscription_message(topic_name, subscription_name, peek_lock=True, time-out=60)
Receive a message from a subscription for processing.
topic_name: Name of the topic.
subscription_name: Name of the subscription.
peek_lock: Optional. True to retrieve and lock the message. False to read and delete the message. Defaultis True (lock).
timeout: Optional. The timeout parameter is expressed in seconds.
send_event(hub_name, message, device_id=None, broker_properties=None)Sends a new message event to an Event Hub.
send_queue_message(queue_name, message=None)Sends a message into the specified queue. The limit to the number of messages which may be present inthe topic is governed by the message size the MaxTopicSizeInMegaBytes. If this message will cause thequeue to exceed its quota, a quota exceeded error is returned and the message will be rejected.
queue_name: Name of the queue.
message: Message object containing message body and properties.
send_topic_message(topic_name, message=None)Enqueues a message into the specified topic. The limit to the number of messages which may be presentin the topic is governed by the message size in MaxTopicSizeInBytes. If this message causes the topic toexceed its quota, a quota exceeded error is returned and the message will be rejected.
topic_name: Name of the topic.
message: Message object containing message body and properties.
set_proxy(host, port, user=None, password=None)Sets the proxy server host and port for the HTTP CONNECT Tunnelling.
host: Address of the proxy. Ex: ‘192.168.0.100’
port: Port of the proxy. Ex: 6000
user: User for proxy authorization.
8.7. azure package 127
Azure SDK for Python Documentation, Release 1.0.3
password: Password for proxy authorization.
timeout
unlock_queue_message(queue_name, sequence_number, lock_token)Unlocks a message for processing by other receivers on a given subscription. This operation deletes thelock object, causing the message to be unlocked. A message must have first been locked by a receiverbefore this operation is called.
queue_name: Name of the queue.
sequence_number: The sequence number of the message to be unlocked as returned in BrokerProper-ties[’SequenceNumber’] by the Peek Message operation.
lock_token: The ID of the lock as returned by the Peek Message operation in BrokerProper-ties[’LockToken’]
unlock_subscription_message(topic_name, subscription_name, sequence_number,lock_token)
Unlock a message for processing by other receivers on a given subscription. This operation deletes thelock object, causing the message to be unlocked. A message must have first been locked by a receiverbefore this operation is called.
topic_name: Name of the topic.
subscription_name: Name of the subscription.
sequence_number: The sequence number of the message to be unlocked as returned in BrokerProper-ties[’SequenceNumber’] by the Peek Message operation.
lock_token: The ID of the lock as returned by the Peek Message operation in BrokerProper-ties[’LockToken’]
update_event_hub(hub_name, hub=None)Updates an Event Hub.
hub_name: Name of event hub.
hub: Optional. Event hub properties. Instance of EventHub class.
hub.message_retention_in_days: Number of days to retain the events for this Event Hub.
with_filter(filter)Returns a new service which will process requests with the specified filter. Filtering operations can includelogging, automatic retrying, etc... The filter is a lambda which receives the HTTPRequest and anotherlambda. The filter can perform any pre-processing on the request, pass it off to the next lambda, and thenperform any post-processing on the response.
class azure.servicebus.servicebusservice.ServiceBusWrapTokenAuthentication(account_key,is-suer)
sign_request(request, httpclient)
Module contents
azure.servicemanagement package
Submodules
128 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
azure.servicemanagement.constants module
azure.servicemanagement.models module
class azure.servicemanagement.models.AdditionalUnattendContentBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.AffinityGroupBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.AffinityGroupsBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.AsynchronousOperationResult(request_id=None)Bases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.AttachedToBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.AuthorizationRuleBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.AuthorizationRulesBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.AvailabilityResponseBases: azure.servicemanagement._common_models.WindowsAzureData
exception azure.servicemanagement.models.AzureAsyncOperationHttpError(message,sta-tus_code,result)
Bases: azure.common.AzureHttpError
Indicates that a batch operation failed
class azure.servicemanagement.models.CaptureRoleAsVMImage(os_state=None,vm_image_name=None,vm_image_label=None,description=None,language=None, im-age_family=None, recom-mended_vm_size=None)
Bases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.CertificateBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.CertificateSetting(thumbprint=u’‘,store_name=u’‘,store_location=u’‘)
Bases: azure.servicemanagement._common_models.WindowsAzureData
Initializes a certificate setting.
thumbprint: Specifies the thumbprint of the certificate to be provisioned. The thumbprint must specify anexisting service certificate.
store_name: Specifies the name of the certificate store from which retrieve certificate.
store_location: Specifies the target certificate store location on the virtual machine. The only supported valueis LocalMachine.
8.7. azure package 129
Azure SDK for Python Documentation, Release 1.0.3
class azure.servicemanagement.models.CertificatesBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.CloudServiceBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.CloudServicesBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.ComponentSettingBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.ComponentSettingsBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.ComponentsBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.ComputeCapabilitiesBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.ConfigurationSetBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.ConfigurationSetInputEndpoint(name=u’‘,protocol=u’‘,port=u’‘, lo-cal_port=u’‘,load_balanced_endpoint_set_name=u’‘,en-able_direct_server_return=False,idle_timeout_in_minutes=4)
Bases: azure.servicemanagement._common_models.WindowsAzureData
Initializes a network configuration input endpoint.
name: Specifies the name for the external endpoint.
protocol: Specifies the protocol to use to inspect the virtual machine availability status. Possible values are:HTTP, TCP.
port: Specifies the external port to use for the endpoint.
local_port: Specifies the internal port on which the virtual machine is listening to serve the endpoint.
load_balanced_endpoint_set_name: Specifies a name for a set of load-balanced endpoints. Specifying thiselement for a given endpoint adds it to the set. If you are setting an endpoint to use to connect to the virtualmachine via the Remote Desktop, do not set this property.
enable_direct_server_return: Specifies whether direct server return load balancing is enabled.
class azure.servicemanagement.models.ConfigurationSetInputEndpointsBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.ConfigurationSetsBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.CountDetailsBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.CreateServerResponseBases: azure.servicemanagement._common_models.WindowsAzureData
130 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
class azure.servicemanagement.models.CredentialsBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.DataBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.DataDiskConfigurationBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.DataDiskConfigurationsBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.DataVirtualHardDisk(media_link=u’‘,host_caching=None,disk_label=u’‘,disk_name=u’‘, lun=0,logical_disk_size_in_gb=0,source_media_link=None)
Bases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.DataVirtualHardDisksBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.DatabaseBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.DeploymentBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.DeploymentsBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.DiskBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.DisksBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.DnsServerBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.DomainJoinBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.EventLogBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.FirewallRuleBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.HostNameSslStateBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.HostNameSslStatesBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.HostedServiceBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.HostedServicePropertiesBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.HostedServicesBases: azure.servicemanagement._common_models.WindowsAzureData
8.7. azure package 131
Azure SDK for Python Documentation, Release 1.0.3
class azure.servicemanagement.models.ImagesBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.InputEndpointBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.InputEndpointsBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.InstanceEndpointBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.InstanceEndpointsBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.IntrinsicSettingsBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.KeyPair(fingerprint=u’‘, path=u’‘)Bases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.KeyPairsBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.LinuxConfigurationSet(host_name=None,user_name=None,user_password=None,dis-able_ssh_password_authentication=None,custom_data=None)
Bases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.Listener(protocol=u’‘, certificate_thumbprint=u’‘)Bases: azure.servicemanagement._common_models.WindowsAzureData
Specifies the protocol and certificate information for the listener.
protocol: Specifies the protocol of listener. Possible values are: Http, Https. The value is case sensitive.
certificate_thumbprint: Optional. Specifies the certificate thumbprint for the secure connection. If this valueis not specified, a self-signed certificate is generated and used for the Virtual Machine.
class azure.servicemanagement.models.ListenersBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.LoadBalancerProbeBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.LocationBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.LocationsBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.MaxRecurrenceBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.MetricAvailabilitiesBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.MetricAvailabilityBases: azure.servicemanagement._common_models.WindowsAzureData
132 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
class azure.servicemanagement.models.MetricDefinitionBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.MetricDefinitionsBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.MetricPropertiesBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.MetricResponseBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.MetricResponsesBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.MetricRollupsBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.MetricSampleBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.MetricValuesBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.NotificationHubDescriptionBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.OSDiskConfigurationBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.OSImageBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.OSVirtualHardDisk(source_image_name=None,media_link=None,host_caching=None,disk_label=None,disk_name=None, os=None, re-mote_source_image_link=None)
Bases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.OperatingSystemBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.OperatingSystemFamiliesBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.OperatingSystemFamilyBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.OperatingSystemsBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.OperationBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.OperationCallerBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.OperationErrorBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.OperationStatusBases: azure.servicemanagement._common_models.WindowsAzureData
8.7. azure package 133
Azure SDK for Python Documentation, Release 1.0.3
class azure.servicemanagement.models.PassesBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.PersistentVMDowntimeInfoBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.PersistentVMRoleBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.PublicIP(name=u’‘)Bases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.PublicIPsBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.PublicKey(fingerprint=u’‘, path=u’‘)Bases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.PublicKeysBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.PublishDataBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.PublishProfileBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.QueueDescriptionBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.QuotaBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.RelayDescriptionBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.ReservedIPBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.ReservedIPsBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.ResourceBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.ResourceExtensionBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.ResourceExtensionParameterValueBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.ResourceExtensionParameterValuesBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.ResourceExtensionReference(reference_name=u’‘,publisher=u’‘,name=u’‘, ver-sion=u’‘)
Bases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.ResourceExtensionReferencesBases: azure.servicemanagement._common_models.WindowsAzureData
134 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
class azure.servicemanagement.models.ResourceExtensionsBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.ResourcesBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.RoleBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.RoleInstanceBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.RoleInstanceListBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.RoleListBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.RoleSizeBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.RoleSizesBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.SSHBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.ServerBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.ServerQuotaBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.ServersBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.ServiceBusNamespaceBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.ServiceBusRegionBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.ServiceObjectiveBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.SiteBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.SitesBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.StorageAccountPropertiesBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.StorageServiceBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.StorageServiceKeysBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.StorageServicesBases: azure.servicemanagement._common_models.WindowsAzureData
8.7. azure package 135
Azure SDK for Python Documentation, Release 1.0.3
class azure.servicemanagement.models.StoredCertificateSettingsBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.SubnetBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.SubnetsBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.SubscriptionBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.SubscriptionCertificateBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.SubscriptionCertificatesBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.SubscriptionOperationBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.SubscriptionOperationCollectionBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.SubscriptionOperationStatusBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.SubscriptionOperationsBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.SubscriptionsBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.TopicDescriptionBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.UnattendComponentBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.UnattendPassBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.UpgradeStatusBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.VMImage(name=None, label=None, description=None)Bases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.VMImagesBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.ValuesBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.VirtualIPBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.VirtualIPsBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.VirtualNetworkSiteBases: azure.servicemanagement._common_models.WindowsAzureData
136 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
class azure.servicemanagement.models.VirtualNetworkSitesBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.WebSpaceBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.WebSpacesBases: azure.servicemanagement._common_models.WindowsAzureData
class azure.servicemanagement.models.WinRMBases: azure.servicemanagement._common_models.WindowsAzureData
Contains configuration settings for the Windows Remote Management service on the Virtual Machine.
class azure.servicemanagement.models.WindowsConfigurationSet(computer_name=None,ad-min_password=None,re-set_password_on_first_logon=None,en-able_automatic_updates=None,time_zone=None, ad-min_username=None,custom_data=None)
Bases: azure.servicemanagement._common_models.WindowsAzureData
azure.servicemanagement.publishsettings module
azure.servicemanagement.publishsettings.get_certificate_from_publish_settings(publish_settings_path,path_to_write_certificate,sub-scrip-tion_id=None)
Writes a certificate file to the specified location. This can then be used to instantiate ServiceManagementService.Returns the subscription ID.
publish_settings_path: Path to subscription file downloaded from http://go.microsoft.com/fwlink/?LinkID=301775
path_to_write_certificate: Path to write the certificate file.
subscription_id: (optional) Provide a subscription id here if you wish to use a specific subscription under thepublish settings file.
azure.servicemanagement.schedulermanagementservice module
class azure.servicemanagement.schedulermanagementservice.SchedulerManagementService(subscription_id=None,cert_file=None,host=’management.core.windows.net’,re-quest_session=None,time-out=65)
Bases: azure.servicemanagement.servicemanagementclient._ServiceManagementClient
8.7. azure package 137
Azure SDK for Python Documentation, Release 1.0.3
Note that this class is a preliminary work on Scheduler management. Since it lack a lot a features, final versioncan be slightly different from the current one.
Initializes the scheduler management service.
subscription_id: Subscription to manage.
cert_file: Path to .pem certificate file (httplib), or location of the certificate in your Personal certificate store(winhttp) in the CURRENT_USERmyCertificateName format. If a request_session is specified, then thisis unused.
host: Live ServiceClient URL. Defaults to Azure public cloud.
request_session: Session object to use for http requests. If this is specified, it replaces the default use ofhttplib or winhttp. Also, the cert_file parameter is unused when a session is passed in. The sessionobject handles authentication, and as such can support multiple types of authentication: .pem certificate,oauth. For example, you can pass in a Session instance from the requests library. To use .pem certificateauthentication with requests library, set the path to the .pem file on the session.cert attribute.
timeout: Optional. Timeout for the http request, in seconds.
check_job_collection_name(cloud_service_id, job_collection_id)The Check Name Availability operation checks if a new job collection with the given name may be created,or if it is unavailable. The result of the operation is a Boolean true or false.
cloud_service_id: The cloud service id
job_collection_id: The name of the job_collection_id.
create_cloud_service(cloud_service_id, label, description, geo_region)The Create Cloud Service request creates a new cloud service. When job collections are created, they arehosted within a cloud service. A cloud service groups job collections together in a given region. Once acloud service has been created, job collections can then be created and contained within it.
cloud_service_id: The cloud service id
label: The name of the cloud service.
description: The description of the cloud service.
geo_region: The geographical region of the webspace that will be created.
create_job(cloud_service_id, job_collection_id, job_id, job)The Create Job request creates a new job. cloud_service_id:
The cloud service id
job_collection_id: Name of the hosted service.
job_id: The job id you wish to create.
job: A dictionary of the payload
create_job_collection(cloud_service_id, job_collection_id, plan=’Standard’)The Create Job Collection request is specified as follows. Replace <subscription-id> with your subscrip-tion ID, <cloud-service-id> with your cloud service ID, and <job-collection-id> with the ID of the jobcollection you’d like to create. There are no “default” pre-existing job collections every job collectionmust be manually created.
cloud_service_id: The cloud service id
job_collection_id: Name of the hosted service.
138 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
delete_cloud_service(cloud_service_id)The Get Cloud Service operation gets all the resources (job collections) in the cloud service.
cloud_service_id: The cloud service id
delete_job(cloud_service_id, job_collection_id, job_id)The Delete Job request creates a new job. cloud_service_id:
The cloud service id
job_collection_id: Name of the hosted service.
job_id: The job id you wish to create.
delete_job_collection(cloud_service_id, job_collection_id)The Delete Job Collection request is specified as follows. Replace <subscription-id> with your subscrip-tion ID, <cloud-service-id> with your cloud service ID, and <job-collection-id> with the ID of the jobcollection you’d like to delete.
cloud_service_id: The cloud service id
job_collection_id: Name of the hosted service.
get_all_jobs(cloud_service_id, job_collection_id)The Get All Jobs operation gets all the jobs in a job collection. The full list of jobs can be accessed byexcluding any job ID in the GET call (i.e. /jobs.)
The return type is
cloud_service_id: The cloud service id
job_collection_id: Name of the hosted service.
get_cloud_service(cloud_service_id)The Get Cloud Service operation gets all the resources (job collections) in the cloud service.
cloud_service_id: The cloud service id
get_job(cloud_service_id, job_collection_id, job_id)The Get Job operation gets the details (including the current job status) of the specified job from thespecified job collection.
The return type is
cloud_service_id: The cloud service id
job_collection_id: Name of the hosted service.
job_id: The job id you wish to create.
get_job_collection(cloud_service_id, job_collection_id)The Get Job Collection operation gets the details of a job collection
cloud_service_id: The cloud service id
job_collection_id: Name of the hosted service.
list_cloud_services()List the cloud services for scheduling defined on the account.
8.7. azure package 139
Azure SDK for Python Documentation, Release 1.0.3
azure.servicemanagement.servicebusmanagementservice module
class azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService(subscription_id=None,cert_file=None,host=’management.core.windows.net’,re-quest_session=None,time-out=65)
Bases: azure.servicemanagement.servicemanagementclient._ServiceManagementClient
Initializes the service bus management service.
subscription_id: Subscription to manage.
cert_file: Path to .pem certificate file (httplib), or location of the certificate in your Personal certificate store(winhttp) in the CURRENT_USERmyCertificateName format. If a request_session is specified, then thisis unused.
host: Live ServiceClient URL. Defaults to Azure public cloud.
request_session: Session object to use for http requests. If this is specified, it replaces the default use ofhttplib or winhttp. Also, the cert_file parameter is unused when a session is passed in. The sessionobject handles authentication, and as such can support multiple types of authentication: .pem certificate,oauth. For example, you can pass in a Session instance from the requests library. To use .pem certificateauthentication with requests library, set the path to the .pem file on the session.cert attribute.
timeout: Optional. Timeout for the http request, in seconds.
check_namespace_availability(name)Checks to see if the specified service bus namespace is available, or if it has already been taken.
name: Name of the service bus namespace to validate.
create_namespace(name, region)Create a new service bus namespace.
name: Name of the service bus namespace to create.
region: Region to create the namespace in.
delete_namespace(name)Delete a service bus namespace.
name: Name of the service bus namespace to delete.
get_metrics_data_notification_hub(name, hub_name, metric, rollup, filter_expresssion)Retrieves the list of supported metrics for this namespace and topic
name: Name of the service bus namespace.
hub_name: Name of the service bus notification hub in this namespace.
metric: name of a supported metric
rollup: name of a supported rollup
filter_expression: filter, for instance “$filter=Timestamp gt datetime‘2014-10-01T00:00:00Z”’
get_metrics_data_queue(name, queue_name, metric, rollup, filter_expresssion)Retrieves the list of supported metrics for this namespace and queue
name: Name of the service bus namespace.
140 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
queue_name: Name of the service bus queue in this namespace.
metric: name of a supported metric
rollup: name of a supported rollup
filter_expression: filter, for instance “$filter=Timestamp gt datetime‘2014-10-01T00:00:00Z”’
get_metrics_data_relay(name, relay_name, metric, rollup, filter_expresssion)Retrieves the list of supported metrics for this namespace and relay
name: Name of the service bus namespace.
relay_name: Name of the service bus relay in this namespace.
metric: name of a supported metric
rollup: name of a supported rollup
filter_expression: filter, for instance “$filter=Timestamp gt datetime‘2014-10-01T00:00:00Z”’
get_metrics_data_topic(name, topic_name, metric, rollup, filter_expresssion)Retrieves the list of supported metrics for this namespace and topic
name: Name of the service bus namespace.
topic_name: Name of the service bus queue in this namespace.
metric: name of a supported metric
rollup: name of a supported rollup
filter_expression: filter, for instance “$filter=Timestamp gt datetime‘2014-10-01T00:00:00Z”’
get_metrics_rollups_notification_hub(name, hub_name, metric)This operation gets rollup data for Service Bus metrics notification hub. Rollup data includes the timegranularity for the telemetry aggregation as well as the retention settings for each time granularity.
name: Name of the service bus namespace.
hub_name: Name of the service bus notification hub in this namespace.
metric: name of a supported metric
get_metrics_rollups_queue(name, queue_name, metric)This operation gets rollup data for Service Bus metrics queue. Rollup data includes the time granularityfor the telemetry aggregation as well as the retention settings for each time granularity.
name: Name of the service bus namespace.
queue_name: Name of the service bus queue in this namespace.
metric: name of a supported metric
get_metrics_rollups_relay(name, relay_name, metric)This operation gets rollup data for Service Bus metrics relay. Rollup data includes the time granularity forthe telemetry aggregation as well as the retention settings for each time granularity.
name: Name of the service bus namespace.
relay_name: Name of the service bus relay in this namespace.
metric: name of a supported metric
get_metrics_rollups_topic(name, topic_name, metric)This operation gets rollup data for Service Bus metrics topic. Rollup data includes the time granularity forthe telemetry aggregation as well as the retention settings for each time granularity.
8.7. azure package 141
Azure SDK for Python Documentation, Release 1.0.3
name: Name of the service bus namespace.
topic_name: Name of the service bus queue in this namespace.
metric: name of a supported metric
get_namespace(name)Get details about a specific namespace.
name: Name of the service bus namespace.
get_regions()Get list of available service bus regions.
get_supported_metrics_notification_hub(name, hub_name)Retrieves the list of supported metrics for this namespace and topic
name: Name of the service bus namespace.
hub_name: Name of the service bus notification hub in this namespace.
get_supported_metrics_queue(name, queue_name)Retrieves the list of supported metrics for this namespace and queue
name: Name of the service bus namespace.
queue_name: Name of the service bus queue in this namespace.
get_supported_metrics_relay(name, relay_name)Retrieves the list of supported metrics for this namespace and relay
name: Name of the service bus namespace.
relay_name: Name of the service bus relay in this namespace.
get_supported_metrics_topic(name, topic_name)Retrieves the list of supported metrics for this namespace and topic
name: Name of the service bus namespace.
topic_name: Name of the service bus queue in this namespace.
list_namespaces()List the service bus namespaces defined on the account.
list_notification_hubs(name)Retrieves the notification hubs in the service namespace.
name: Name of the service bus namespace.
list_queues(name)Enumerates the queues in the service namespace.
name: Name of the service bus namespace.
list_relays(name)Retrieves the relays in the service namespace.
name: Name of the service bus namespace.
list_topics(name)Retrieves the topics in the service namespace.
name: Name of the service bus namespace.
142 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
azure.servicemanagement.servicemanagementclient module
azure.servicemanagement.servicemanagementclient.parse_response_for_async_op(response)Extracts request id from response header.
azure.servicemanagement.servicemanagementservice module
class azure.servicemanagement.servicemanagementservice.ServiceManagementService(subscription_id=None,cert_file=None,host=’management.core.windows.net’,re-quest_session=None,time-out=65)
Bases: azure.servicemanagement.servicemanagementclient._ServiceManagementClient
Initializes the management service.
subscription_id: Subscription to manage.
cert_file: Path to .pem certificate file (httplib), or location of the certificate in your Personal certificate store(winhttp) in the CURRENT_USERmyCertificateName format. If a request_session is specified, then thisis unused.
host: Live ServiceClient URL. Defaults to Azure public cloud.
request_session: Session object to use for http requests. If this is specified, it replaces the default use ofhttplib or winhttp. Also, the cert_file parameter is unused when a session is passed in. The sessionobject handles authentication, and as such can support multiple types of authentication: .pem certificate,oauth. For example, you can pass in a Session instance from the requests library. To use .pem certificateauthentication with requests library, set the path to the .pem file on the session.cert attribute.
timeout: Optional. Timeout for the http request, in seconds.
add_data_disk(service_name, deployment_name, role_name, lun, host_caching=None,media_link=None, disk_label=None, disk_name=None, logi-cal_disk_size_in_gb=None, source_media_link=None)
Adds a data disk to a virtual machine.
service_name: The name of the service.
deployment_name: The name of the deployment.
role_name: The name of the role.
lun: Specifies the Logical Unit Number (LUN) for the disk. The LUN specifies the slot in which the datadrive appears when mounted for usage by the virtual machine. Valid LUN values are 0 through 15.
host_caching: Specifies the platform caching behavior of data disk blob for read/write efficiency. Thedefault vault is ReadOnly. Possible values are: None, ReadOnly, ReadWrite
media_link: Specifies the location of the blob in Windows Azure blob store where the media for the diskis located. The blob location must belong to the storage account in the subscription specified by the<subscription-id> value in the operation call. Example: http://example.blob.core.windows.net/disks/mydisk.vhd
disk_label: Specifies the description of the data disk. When you attach a disk, either by directly referenc-ing a media using the MediaLink element or specifying the target disk size, you can use the DiskLabelelement to customize the name property of the target data disk.
8.7. azure package 143
Azure SDK for Python Documentation, Release 1.0.3
disk_name: Specifies the name of the disk. Windows Azure uses the specified disk to create the data diskfor the machine and populates this field with the disk name.
logical_disk_size_in_gb: Specifies the size, in GB, of an empty disk to be attached to the role. The diskcan be created as part of disk attach or create VM role call by specifying the value for this property.Windows Azure creates the empty disk based on size preference and attaches the newly created diskto the Role.
source_media_link: Specifies the location of a blob in account storage which is mounted as a data diskwhen the virtual machine is created.
add_disk(has_operating_system, label, media_link, name, os)Adds a disk to the user image repository. The disk can be an OS disk or a data disk.
has_operating_system: Deprecated.
label: Specifies the description of the disk.
media_link: Specifies the location of the blob in Windows Azure blob store where the media for the diskis located. The blob location must belong to the storage account in the current subscription specifiedby the <subscription-id> value in the operation call. Example: http://example.blob.core.windows.net/disks/mydisk.vhd
name: Specifies a name for the disk. Windows Azure uses the name to identify the disk when creatingvirtual machines from the disk.
os: The OS type of the disk. Possible values are: Linux, Windows
add_dns_server(service_name, deployment_name, dns_server_name, address)Adds a DNS server definition to an existing deployment.
service_name: The name of the service.
deployment_name: The name of the deployment.
dns_server_name: Specifies the name of the DNS server.
address: Specifies the IP address of the DNS server.
add_management_certificate(public_key, thumbprint, data)The Add Management Certificate operation adds a certificate to the list of management certificates. Man-agement certificates, which are also known as subscription certificates, authenticate clients attempting toconnect to resources associated with your Windows Azure subscription.
public_key: A base64 representation of the management certificate public key.
thumbprint: The thumb print that uniquely identifies the management certificate.
data: The certificate’s raw data in base-64 encoded .cer format.
add_os_image(label, media_link, name, os)Adds an OS image that is currently stored in a storage account in your subscription to the image repository.
label: Specifies the friendly name of the image.
media_link: Specifies the location of the blob in Windows Azure blob store where the media for theimage is located. The blob location must belong to a storage account in the subscription specifiedby the <subscription-id> value in the operation call. Example: http://example.blob.core.windows.net/disks/mydisk.vhd
name: Specifies a name for the OS image that Windows Azure uses to identify the image when creatingone or more virtual machines.
os: The operating system type of the OS image. Possible values are: Linux, Windows
144 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
add_role(service_name, deployment_name, role_name, system_config, os_virtual_hard_disk,network_config=None, availability_set_name=None, data_virtual_hard_disks=None,role_size=None, role_type=’PersistentVMRole’, resource_extension_references=None,provision_guest_agent=None, vm_image_name=None, media_location=None)
Adds a virtual machine to an existing deployment.
service_name: The name of the service.
deployment_name: The name of the deployment.
role_name: The name of the role.
system_config: Contains the metadata required to provision a virtual machine from a Windows or LinuxOS image. Use an instance of WindowsConfigurationSet or LinuxConfigurationSet.
os_virtual_hard_disk: Contains the parameters Windows Azure uses to create the operating system diskfor the virtual machine. If you are creating a Virtual Machine by using a VM Image, this parameter isnot used.
network_config: Encapsulates the metadata required to create the virtual network configuration for avirtual machine. If you do not include a network configuration set you will not be able to access theVM through VIPs over the internet. If your virtual machine belongs to a virtual network you can notspecify which subnet address space it resides under.
availability_set_name: Specifies the name of an availability set to which to add the virtual machine. Thisvalue controls the virtual machine allocation in the Windows Azure environment. Virtual machinesspecified in the same availability set are allocated to different nodes to maximize availability.
data_virtual_hard_disks: Contains the parameters Windows Azure uses to create a data disk for a virtualmachine.
role_size: The size of the virtual machine to allocate. The default value is Small. Possible values are:ExtraSmall, Small, Medium, Large, ExtraLarge. The specified value must be compatible with thedisk selected in the OSVirtualHardDisk values.
role_type: The type of the role for the virtual machine. The only supported value is PersistentVMRole.
resource_extension_references: Optional. Contains a collection of resource extensions that are to beinstalled on the Virtual Machine. This element is used if provision_guest_agent is set to True.
provision_guest_agent: Optional. Indicates whether the VM Agent is installed on the Virtual Machine.To run a resource extension in a Virtual Machine, this service must be installed.
vm_image_name: Optional. Specifies the name of the VM Image that is to be used to create the VirtualMachine. If this is specified, the system_config and network_config parameters are not used.
media_location: Optional. Required if the Virtual Machine is being created from a published VM Image.Specifies the location of the VHD file that is created when VMImageName specifies a published VMImage.
add_service_certificate(service_name, data, certificate_format, password=None)Adds a certificate to a hosted service.
service_name: Name of the hosted service.
data: The base-64 encoded form of the pfx/cer file.
certificate_format: The service certificate format.
password: The certificate password. Default to None when using cer format.
8.7. azure package 145
Azure SDK for Python Documentation, Release 1.0.3
capture_role(service_name, deployment_name, role_name, post_capture_action, tar-get_image_name, target_image_label, provisioning_configuration=None)
The Capture Role operation captures a virtual machine image to your image gallery. From the capturedimage, you can create additional customized virtual machines.
service_name: The name of the service.
deployment_name: The name of the deployment.
role_name: The name of the role.
post_capture_action: Specifies the action after capture operation completes. Possible values are: Delete,Reprovision.
target_image_name: Specifies the image name of the captured virtual machine.
target_image_label: Specifies the friendly name of the captured virtual machine.
provisioning_configuration: Use an instance of WindowsConfigurationSet or LinuxConfigurationSet.
capture_vm_image(service_name, deployment_name, role_name, options)Creates a copy of the operating system virtual hard disk (VHD) and all of the data VHDs that are associatedwith the Virtual Machine, saves the VHD copies in the same storage location as the original VHDs, andregisters the copies as a VM Image in the image repository that is associated with the specified subscription.
service_name: The name of the service.
deployment_name: The name of the deployment.
role_name: The name of the role.
options: An instance of CaptureRoleAsVMImage class.
options.os_state: Required. Specifies the state of the operating system in the image. Possible values are:Generalized, Specialized A Virtual Machine that is fully configured and running contains a Special-ized operating system. A Virtual Machine on which the Sysprep command has been run with thegeneralize option contains a Generalized operating system. If you capture an image from a general-ized Virtual Machine, the machine is deleted after the image is captured. It is recommended that allVirtual Machines are shut down before capturing an image.
options.vm_image_name: Required. Specifies the name of the VM Image.
options.vm_image_label: Required. Specifies the label of the VM Image.
options.description: Optional. Specifies the description of the VM Image.
options.language: Optional. Specifies the language of the VM Image.
options.image_family: Optional. Specifies a value that can be used to group VM Images.
options.recommended_vm_size: Optional. Specifies the size to use for the Virtual Machine that is cre-ated from the VM Image.
change_deployment_configuration(service_name, deployment_name, configuration,treat_warnings_as_error=False, mode=’Auto’, ex-tended_properties=None)
Initiates a change to the deployment configuration.
service_name: Name of the hosted service.
deployment_name: The name of the deployment.
configuration: The base-64 encoded service configuration file for the deployment.
treat_warnings_as_error: Indicates whether to treat package validation warnings as errors. If set to true,the Created Deployment operation fails if there are validation warnings on the service package.
146 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
mode: If set to Manual, WalkUpgradeDomain must be called to apply the update. If set to Auto, theWindows Azure platform will automatically apply the update To each upgrade domain for the service.Possible values are: Auto, Manual
extended_properties: Dictionary containing name/value pairs of storage account properties. You canhave a maximum of 50 extended property name/value pairs. The maximum length of the Nameelement is 64 characters, only alphanumeric characters and underscores are valid in the Name, andthe name must start with a letter. The value has a maximum length of 255 characters.
check_hosted_service_name_availability(service_name)Checks to see if the specified hosted service name is available, or if it has already been taken.
service_name: Name of the hosted service.
check_storage_account_name_availability(service_name)Checks to see if the specified storage account name is available, or if it has already been taken.
service_name: Name of the storage service account.
create_affinity_group(name, label, location, description=None)Creates a new affinity group for the specified subscription.
name: A name for the affinity group that is unique to the subscription.
label: A name for the affinity group. The name can be up to 100 characters in length.
location: The data center location where the affinity group will be created. To list available locations, usethe list_location function.
description: A description for the affinity group. The description can be up to 1024 characters in length.
create_deployment(service_name, deployment_slot, name, package_url, label, configu-ration, start_deployment=False, treat_warnings_as_error=False, ex-tended_properties=None)
Uploads a new service package and creates a new deployment on staging or production.
service_name: Name of the hosted service.
deployment_slot: The environment to which the hosted service is deployed. Valid values are: staging,production
name: The name for the deployment. The deployment name must be unique among other deploymentsfor the hosted service.
package_url: A URL that refers to the location of the service package in the Blob service. The servicepackage can be located either in a storage account beneath the same subscription or a Shared AccessSignature (SAS) URI from any storage account.
label: A name for the hosted service. The name can be up to 100 characters in length. It is recommendedthat the label be unique within the subscription. The name can be used to identify the hosted servicefor your tracking purposes.
configuration: The base-64 encoded service configuration file for the deployment.
start_deployment: Indicates whether to start the deployment immediately after it is created. If false, theservice model is still deployed to the virtual machines but the code is not run immediately. Instead,the service is Suspended until you call Update Deployment Status and set the status to Running, atwhich time the service will be started. A deployed service still incurs charges, even if it is suspended.
treat_warnings_as_error: Indicates whether to treat package validation warnings as errors. If set to true,the Created Deployment operation fails if there are validation warnings on the service package.
extended_properties: Dictionary containing name/value pairs of storage account properties. You canhave a maximum of 50 extended property name/value pairs. The maximum length of the Name
8.7. azure package 147
Azure SDK for Python Documentation, Release 1.0.3
element is 64 characters, only alphanumeric characters and underscores are valid in the Name, andthe name must start with a letter. The value has a maximum length of 255 characters.
create_hosted_service(service_name, label, description=None, location=None, affin-ity_group=None, extended_properties=None)
Creates a new hosted service in Windows Azure.
service_name: A name for the hosted service that is unique within Windows Azure. This name is theDNS prefix name and can be used to access the hosted service.
label: A name for the hosted service. The name can be up to 100 characters in length. The name can beused to identify the storage account for your tracking purposes.
description: A description for the hosted service. The description can be up to 1024 characters in length.
location: The location where the hosted service will be created. You can specify either a location oraffinity_group, but not both.
affinity_group: The name of an existing affinity group associated with this subscription. This nameis a GUID and can be retrieved by examining the name element of the response body returned bylist_affinity_groups. You can specify either a location or affinity_group, but not both.
extended_properties: Dictionary containing name/value pairs of storage account properties. You canhave a maximum of 50 extended property name/value pairs. The maximum length of the Nameelement is 64 characters, only alphanumeric characters and underscores are valid in the Name, andthe name must start with a letter. The value has a maximum length of 255 characters.
create_reserved_ip_address(name, label=None, location=None)Reserves an IPv4 address for the specified subscription.
name: Required. Specifies the name for the reserved IP address.
label: Optional. Specifies a label for the reserved IP address. The label can be up to 100 characters longand can be used for your tracking purposes.
location: Required. Specifies the location of the reserved IP address. This should be the same locationthat is assigned to the cloud service containing the deployment that will use the reserved IP address.To see the available locations, you can use list_locations.
create_storage_account(service_name, description, label, affinity_group=None,location=None, geo_replication_enabled=None, ex-tended_properties=None, account_type=’Standard_GRS’)
Creates a new storage account in Windows Azure.
service_name: A name for the storage account that is unique within Windows Azure. Storage accountnames must be between 3 and 24 characters in length and use numbers and lower-case letters only.
description: A description for the storage account. The description may be up to 1024 characters inlength.
label: A name for the storage account. The name may be up to 100 characters in length. The name can beused to identify the storage account for your tracking purposes.
affinity_group: The name of an existing affinity group in the specified subscription. You can specifyeither a location or affinity_group, but not both.
location: The location where the storage account is created. You can specify either a location or affin-ity_group, but not both.
geo_replication_enabled: Deprecated. Replaced by the account_type parameter.
extended_properties: Dictionary containing name/value pairs of storage account properties. You canhave a maximum of 50 extended property name/value pairs. The maximum length of the Name
148 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
element is 64 characters, only alphanumeric characters and underscores are valid in the Name, andthe name must start with a letter. The value has a maximum length of 255 characters.
account_type: Specifies whether the account supports locally-redundant storage, geo-redundant storage,zone-redundant storage, or read access geo-redundant storage. Possible values are:
Standard_LRS, Standard_ZRS, Standard_GRS, Standard_RAGRS
create_virtual_machine_deployment(service_name, deployment_name, deployment_slot, la-bel, role_name, system_config, os_virtual_hard_disk,network_config=None, availabil-ity_set_name=None, data_virtual_hard_disks=None,role_size=None, role_type=’PersistentVMRole’,virtual_network_name=None, re-source_extension_references=None, provi-sion_guest_agent=None, vm_image_name=None,media_location=None, dns_servers=None, re-served_ip_name=None)
Provisions a virtual machine based on the supplied configuration.
service_name: Name of the hosted service.
deployment_name: The name for the deployment. The deployment name must be unique among otherdeployments for the hosted service.
deployment_slot: The environment to which the hosted service is deployed. Valid values are: staging,production
label: Specifies an identifier for the deployment. The label can be up to 100 characters long. The labelcan be used for tracking purposes.
role_name: The name of the role.
system_config: Contains the metadata required to provision a virtual machine from a Windows or LinuxOS image. Use an instance of WindowsConfigurationSet or LinuxConfigurationSet.
os_virtual_hard_disk: Contains the parameters Windows Azure uses to create the operating system diskfor the virtual machine. If you are creating a Virtual Machine by using a VM Image, this parameter isnot used.
network_config: Encapsulates the metadata required to create the virtual network configuration for avirtual machine. If you do not include a network configuration set you will not be able to access theVM through VIPs over the internet. If your virtual machine belongs to a virtual network you can notspecify which subnet address space it resides under. Use an instance of ConfigurationSet.
availability_set_name: Specifies the name of an availability set to which to add the virtual machine. Thisvalue controls the virtual machine allocation in the Windows Azure environment. Virtual machinesspecified in the same availability set are allocated to different nodes to maximize availability.
data_virtual_hard_disks: Contains the parameters Windows Azure uses to create a data disk for a virtualmachine.
role_size: The size of the virtual machine to allocate. The default valueis Small. Possible values are: ExtraSmall,Small,Medium,Large, Ex-traLarge,A5,A6,A7,A8,A9,Basic_A0,Basic_A1,Basic_A2,Basic_A3, Ba-sic_A4,Standard_D1,Standard_D2,Standard_D3,Standard_D4, Stan-dard_D11,Standard_D12,Standard_D13,Standard_D14,Standard_G1, Stan-dard_G2,Sandard_G3,Standard_G4,Standard_G5. The specified value must be compatible with thedisk selected in the OSVirtualHardDisk values.
role_type: The type of the role for the virtual machine. The only supported value is PersistentVMRole.
8.7. azure package 149
Azure SDK for Python Documentation, Release 1.0.3
virtual_network_name: Specifies the name of an existing virtual network to which the deployment willbelong.
resource_extension_references: Optional. Contains a collection of resource extensions that are to beinstalled on the Virtual Machine. This element is used if provision_guest_agent is set to True. Use aniterable of instances of ResourceExtensionReference.
provision_guest_agent: Optional. Indicates whether the VM Agent is installed on the Virtual Machine.To run a resource extension in a Virtual Machine, this service must be installed.
vm_image_name: Optional. Specifies the name of the VM Image that is to be used to create the VirtualMachine. If this is specified, the system_config and network_config parameters are not used.
media_location: Optional. Required if the Virtual Machine is being created from a published VM Image.Specifies the location of the VHD file that is created when VMImageName specifies a published VMImage.
dns_servers: Optional. List of DNS servers (use DnsServer class) to associate with the Virtual Machine.
reserved_ip_name: Optional. Specifies the name of a reserved IP address that is to be assigned to thedeployment. You must run create_reserved_ip_address before you can assign the address to the de-ployment using this element.
create_vm_image(vm_image)Creates a VM Image in the image repository that is associated with the specified subscription using aspecified set of virtual hard disks.
vm_image: An instance of VMImage class.
vm_image.name: Required. Specifies the name of the image. vm_image.label: Required. Specifiesan identifier for the image. vm_image.description: Optional. Specifies the description of the image.vm_image.os_disk_configuration:
Required. Specifies configuration information for the operating system disk that is associatedwith the image.
vm_image.os_disk_configuration.host_caching: Optional. Specifies the caching behavior of the oper-ating system disk. Possible values are: None, ReadOnly, ReadWrite
vm_image.os_disk_configuration.os_state: Required. Specifies the state of the operating system in theimage. Possible values are: Generalized, Specialized A Virtual Machine that is fully configured andrunning contains a Specialized operating system. A Virtual Machine on which the Sysprep commandhas been run with the generalize option contains a Generalized operating system.
vm_image.os_disk_configuration.os: Required. Specifies the operating system type of the image.
vm_image.os_disk_configuration.media_link: Required. Specifies the location of the blob in WindowsAzure storage. The blob location belongs to a storage account in the subscription specified by the<subscription-id> value in the operation call.
vm_image.data_disk_configurations: Optional. Specifies configuration information for the data disksthat are associated with the image. A VM Image might not have data disks associated with it.
vm_image.data_disk_configurations[].host_caching: Optional. Specifies the caching behavior of thedata disk. Possible values are: None, ReadOnly, ReadWrite
vm_image.data_disk_configurations[].lun: Optional if the lun for the disk is 0. Specifies the LogicalUnit Number (LUN) for the data disk.
vm_image.data_disk_configurations[].media_link: Required. Specifies the location of the blob in Win-dows Azure storage. The blob location belongs to a storage account in the subscription specified bythe <subscription-id> value in the operation call.
150 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
vm_image.data_disk_configurations[].logical_size_in_gb: Required. Specifies the size, in GB, of thedata disk.
vm_image.language: Optional. Specifies the language of the image. vm_image.image_family:
Optional. Specifies a value that can be used to group VM Images.
vm_image.recommended_vm_size: Optional. Specifies the size to use for the Virtual Machine that iscreated from the VM Image.
vm_image.eula: Optional. Specifies the End User License Agreement that is associated with the image.The value for this element is a string, but it is recommended that the value be a URL that points to aEULA.
vm_image.icon_uri: Optional. Specifies the URI to the icon that is displayed for the image in the Man-agement Portal.
vm_image.small_icon_uri: Optional. Specifies the URI to the small icon that is displayed for the imagein the Management Portal.
vm_image.privacy_uri: Optional. Specifies the URI that points to a document that contains the privacypolicy related to the image.
vm_image.published_date: Optional. Specifies the date when the image was added to the image reposi-tory.
vm_image.show_in_gui: Optional. Indicates whether the VM Images should be listed in the portal.
delete_affinity_group(affinity_group_name)Deletes an affinity group in the specified subscription.
affinity_group_name: The name of the affinity group.
delete_data_disk(service_name, deployment_name, role_name, lun, delete_vhd=False)Removes the specified data disk from a virtual machine.
service_name: The name of the service.
deployment_name: The name of the deployment.
role_name: The name of the role.
lun: The Logical Unit Number (LUN) for the disk.
delete_vhd: Deletes the underlying vhd blob in Azure storage.
delete_deployment(service_name, deployment_name, delete_vhd=False)Deletes the specified deployment.
service_name: Name of the hosted service.
deployment_name: The name of the deployment.
delete_disk(disk_name, delete_vhd=False)Deletes the specified data or operating system disk from your image repository.
disk_name: The name of the disk to delete.
delete_vhd: Deletes the underlying vhd blob in Azure storage.
delete_dns_server(service_name, deployment_name, dns_server_name)Deletes a DNS server from a deployment.
service_name: The name of the service.
8.7. azure package 151
Azure SDK for Python Documentation, Release 1.0.3
deployment_name: The name of the deployment.
dns_server_name: Name of the DNS server that you want to delete.
delete_hosted_service(service_name, complete=False)Deletes the specified hosted service from Windows Azure.
service_name: Name of the hosted service.
complete: True if all OS/data disks and the source blobs for the disks should also be deleted from storage.
delete_management_certificate(thumbprint)The Delete Management Certificate operation deletes a certificate from the list of management certificates.Management certificates, which are also known as subscription certificates, authenticate clients attemptingto connect to resources associated with your Windows Azure subscription.
thumbprint: The thumb print that uniquely identifies the management certificate.
delete_os_image(image_name, delete_vhd=False)Deletes the specified OS image from your image repository.
image_name: The name of the image.
delete_vhd: Deletes the underlying vhd blob in Azure storage.
delete_reserved_ip_address(name)Deletes a reserved IP address from the specified subscription.
name: Required. Name of the reserved IP address.
delete_role(service_name, deployment_name, role_name, complete=False)Deletes the specified virtual machine.
service_name: The name of the service.
deployment_name: The name of the deployment.
role_name: The name of the role.
complete: True if all OS/data disks and the source blobs for the disks should also be deleted from storage.
delete_role_instances(service_name, deployment_name, role_instance_names)Reinstalls the operating system on instances of web roles or worker roles and initializes the storage re-sources that are used by them. If you do not want to initialize storage resources, you can use reim-age_role_instance.
service_name: Name of the hosted service.
deployment_name: The name of the deployment.
role_instance_names: List of role instance names.
delete_service_certificate(service_name, thumbalgorithm, thumbprint)Deletes a service certificate from the certificate store of a hosted service.
service_name: Name of the hosted service.
thumbalgorithm: The algorithm for the certificate’s thumbprint.
thumbprint: The hexadecimal representation of the thumbprint.
delete_storage_account(service_name)Deletes the specified storage account from Windows Azure.
service_name: Name of the storage service account.
152 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
delete_vm_image(vm_image_name, delete_vhd=False)Deletes the specified VM Image from the image repository that is associated with the specified subscrip-tion.
vm_image_name: The name of the image.
delete_vhd: Deletes the underlying vhd blob in Azure storage.
get_affinity_group_properties(affinity_group_name)Returns the system properties associated with the specified affinity group.
affinity_group_name: The name of the affinity group.
get_data_disk(service_name, deployment_name, role_name, lun)Retrieves the specified data disk from a virtual machine.
service_name: The name of the service.
deployment_name: The name of the deployment.
role_name: The name of the role.
lun: The Logical Unit Number (LUN) for the disk.
get_deployment_by_name(service_name, deployment_name)Returns configuration information, status, and system properties for a deployment.
service_name: Name of the hosted service.
deployment_name: The name of the deployment.
get_deployment_by_slot(service_name, deployment_slot)Returns configuration information, status, and system properties for a deployment.
service_name: Name of the hosted service.
deployment_slot: The environment to which the hosted service is deployed. Valid values are: staging,production
get_disk(disk_name)Retrieves a disk from your image repository.
get_hosted_service_properties(service_name, embed_detail=False)Retrieves system properties for the specified hosted service. These properties include the service name andservice type; the name of the affinity group to which the service belongs, or its location if it is not part ofan affinity group; and optionally, information on the service’s deployments.
service_name: Name of the hosted service.
embed_detail: When True, the management service returns properties for all deployments of the service,as well as for the service itself.
get_management_certificate(thumbprint)The Get Management Certificate operation retrieves information about the management certificate withthe specified thumbprint. Management certificates, which are also known as subscription certificates,authenticate clients attempting to connect to resources associated with your Windows Azure subscription.
thumbprint: The thumbprint value of the certificate.
get_os_image(image_name)Retrieves an OS image from the image repository.
get_reserved_ip_address(name)Retrieves information about the specified reserved IP address.
name: Required. Name of the reserved IP address.
8.7. azure package 153
Azure SDK for Python Documentation, Release 1.0.3
get_role(service_name, deployment_name, role_name)Retrieves the specified virtual machine.
service_name: The name of the service.
deployment_name: The name of the deployment.
role_name: The name of the role.
get_service_certificate(service_name, thumbalgorithm, thumbprint)Returns the public data for the specified X.509 certificate associated with a hosted service.
service_name: Name of the hosted service.
thumbalgorithm: The algorithm for the certificate’s thumbprint.
thumbprint: The hexadecimal representation of the thumbprint.
get_storage_account_keys(service_name)Returns the primary and secondary access keys for the specified storage account.
service_name: Name of the storage service account.
get_storage_account_properties(service_name)Returns system properties for the specified storage account.
service_name: Name of the storage service account.
get_subscription()Returns account and resource allocation information on the specified subscription.
list_affinity_groups()Lists the affinity groups associated with the specified subscription.
list_disks()Retrieves a list of the disks in your image repository.
list_hosted_services()Lists the hosted services available under the current subscription.
Note that you will receive a list of HostedService instances, without all details inside. For instance, de-ployments will be None. If you want deployments information for a specific host service, you have to callget_hosted_service_properties with embed_detail=True.
list_locations()Lists all of the data center locations that are valid for your subscription.
list_management_certificates()The List Management Certificates operation lists and returns basic information about all of the man-agement certificates associated with the specified subscription. Management certificates, which are alsoknown as subscription certificates, authenticate clients attempting to connect to resources associated withyour Windows Azure subscription.
list_operating_system_families()Lists the guest operating system families available in Windows Azure, and also lists the operating systemversions available for each family.
list_operating_systems()Lists the versions of the guest operating system that are currently available in Windows Azure.
list_os_images()Retrieves a list of the OS images from the image repository.
list_reserved_ip_addresses()Lists the IP addresses that have been reserved for the specified subscription.
154 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
list_resource_extension_versions(publisher_name, extension_name)Lists the versions of a resource extension that are available to add to a Virtual Machine.
publisher_name: Name of the resource extension publisher.
extension_name: Name of the resource extension.
list_resource_extensions()Lists the resource extensions that are available to add to a Virtual Machine.
list_role_sizes()Lists the role sizes that are available under the specified subscription.
list_service_certificates(service_name)Lists all of the service certificates associated with the specified hosted service.
service_name: Name of the hosted service.
list_storage_accounts()Lists the storage accounts available under the current subscription.
list_subscription_operations(start_time=None, end_time=None, object_id_filter=None,operation_result_filter=None, continuation_token=None)
List subscription operations.
start_time: Required. An ISO8601 date. end_time: Required. An ISO8601 date. object_id_filter:Optional. Returns subscription operations only for the specified object type and object ID opera-tion_result_filter: Optional. Returns subscription operations only for the specified result status, ei-ther Succeeded, Failed, or InProgress. continuation_token: Optional. More information at: https://msdn.microsoft.com/en-us/library/azure/gg715318.aspx
list_subscriptions()Returns a list of subscriptions that you can access.
You must make sure that the request that is made to the management service is secure using an ActiveDirectory access token.
list_virtual_network_sites()Retrieves a list of the virtual networks.
list_vm_images(location=None, publisher=None, category=None)Retrieves a list of the VM Images from the image repository that is associated with the specified subscrip-tion.
reboot_role_instance(service_name, deployment_name, role_instance_name)Requests a reboot of a role instance that is running in a deployment.
service_name: Name of the hosted service.
deployment_name: The name of the deployment.
role_instance_name: The name of the role instance.
rebuild_role_instance(service_name, deployment_name, role_instance_name)Reinstalls the operating system on instances of web roles or worker roles and initializes the storage re-sources that are used by them. If you do not want to initialize storage resources, you can use reim-age_role_instance.
service_name: Name of the hosted service.
deployment_name: The name of the deployment.
role_instance_name: The name of the role instance.
8.7. azure package 155
Azure SDK for Python Documentation, Release 1.0.3
regenerate_storage_account_keys(service_name, key_type)Regenerates the primary or secondary access key for the specified storage account.
service_name: Name of the storage service account.
key_type: Specifies which key to regenerate. Valid values are: Primary, Secondary
reimage_role_instance(service_name, deployment_name, role_instance_name)Requests a reimage of a role instance that is running in a deployment.
service_name: Name of the hosted service.
deployment_name: The name of the deployment.
role_instance_name: The name of the role instance.
replicate_vm_image(vm_image_name, regions, offer, sku, version)Replicate a VM image to multiple target locations. This operation is only for publishers. You have to beregistered as image publisher with Microsoft Azure to be able to call this.
vm_image_name: Specifies the name of the VM Image that is to be used for replication
regions: Specified a list of regions to replicate the image to Note: The regions in the request body are notadditive. If a VM Image has already been replicated to Regions A, B, and C, and a request is made toreplicate to Regions A and D, the VM Image will remain in Region A, will be replicated in Region D,and will be unreplicated from Regions B and C
offer: Specifies the publisher defined name of the offer. The allowed characters are uppercase or lowercaseletters, digit, hypen(-), period (.).The maximum allowed length is 64 characters.
sku: Specifies the publisher defined name of the Sku. The allowed characters are uppercase or lowercaseletters, digit, hypen(-), period (.). The maximum allowed length is 64 characters.
version: Specifies the publisher defined version of the image. The allowed characters are digit and period.Format: <MajorVersion>.<MinorVersion>.<Patch> Example: ‘1.0.0’ or ‘1.1.0’ The 3 version numberto follow standard of most of the RPs. See http://semver.org
restart_role(service_name, deployment_name, role_name)Restarts the specified virtual machine.
service_name: The name of the service.
deployment_name: The name of the deployment.
role_name: The name of the role.
rollback_update_or_upgrade(service_name, deployment_name, mode, force)Cancels an in progress configuration change (update) or upgrade and returns the deployment to its statebefore the upgrade or configuration change was started.
service_name: Name of the hosted service.
deployment_name: The name of the deployment.
mode:
Specifies whether the rollback should proceed automatically. auto - The rollback proceeds with-out further user input. manual - You must call the Walk Upgrade Domain operation to
apply the rollback to each upgrade domain.
force: Specifies whether the rollback should proceed even when it will cause local data to be lost fromsome role instances. True if the rollback should proceed; otherwise false if the rollback should fail.
156 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
share_vm_image(vm_image_name, permission)Share an already replicated OS image. This operation is only for publishers. You have to be registered asimage publisher with Windows Azure to be able to call this.
vm_image_name: The name of the virtual machine image to share
permission: The sharing permission: public, msdn, or private
shutdown_role(service_name, deployment_name, role_name, post_shutdown_action=’Stopped’)Shuts down the specified virtual machine.
service_name: The name of the service.
deployment_name: The name of the deployment.
role_name: The name of the role.
post_shutdown_action:
Specifies how the Virtual Machine should be shut down. Values are:
Stopped Shuts down the Virtual Machine but retains the compute resources. You will continueto be billed for the resources that the stopped machine uses.
StoppedDeallocated Shuts down the Virtual Machine and releases the compute resources. Youare not billed for the compute resources that this Virtual Machine uses. If a static VirtualNetwork IP address is assigned to the Virtual Machine, it is reserved.
shutdown_roles(service_name, deployment_name, role_names, post_shutdown_action=’Stopped’)Shuts down the specified virtual machines.
service_name: The name of the service.
deployment_name: The name of the deployment.
role_names: The names of the roles, as an enumerable of strings.
post_shutdown_action:
Specifies how the Virtual Machine should be shut down. Values are:
Stopped Shuts down the Virtual Machine but retains the compute resources. You will continueto be billed for the resources that the stopped machine uses.
StoppedDeallocated Shuts down the Virtual Machine and releases the compute resources. Youare not billed for the compute resources that this Virtual Machine uses. If a static VirtualNetwork IP address is assigned to the Virtual Machine, it is reserved.
start_role(service_name, deployment_name, role_name)Starts the specified virtual machine.
service_name: The name of the service.
deployment_name: The name of the deployment.
role_name: The name of the role.
start_roles(service_name, deployment_name, role_names)Starts the specified virtual machines.
service_name: The name of the service.
deployment_name: The name of the deployment.
role_names: The names of the roles, as an enumerable of strings.
8.7. azure package 157
Azure SDK for Python Documentation, Release 1.0.3
swap_deployment(service_name, production, source_deployment)Initiates a virtual IP swap between the staging and production deployment environments for a service. If theservice is currently running in the staging environment, it will be swapped to the production environment.If it is running in the production environment, it will be swapped to staging.
service_name: Name of the hosted service.
production: The name of the production deployment.
source_deployment: The name of the source deployment.
unreplicate_vm_image(vm_image_name)Unreplicate a VM image from all regions This operation is only for publishers. You have to be registeredas image publisher with Microsoft Azure to be able to call this
vm_image_name: Specifies the name of the VM Image that is to be used for unreplication. The VMImage Name should be the user VM Image, not the published name of the VM Image.
update_affinity_group(affinity_group_name, label, description=None)Updates the label and/or the description for an affinity group for the specified subscription.
affinity_group_name: The name of the affinity group.
label: A name for the affinity group. The name can be up to 100 characters in length.
description: A description for the affinity group. The description can be up to 1024 characters in length.
update_data_disk(service_name, deployment_name, role_name, lun, host_caching=None, me-dia_link=None, updated_lun=None, disk_label=None, disk_name=None, logi-cal_disk_size_in_gb=None)
Updates the specified data disk attached to the specified virtual machine.
service_name: The name of the service.
deployment_name: The name of the deployment.
role_name: The name of the role.
lun: Specifies the Logical Unit Number (LUN) for the disk. The LUN specifies the slot in which the datadrive appears when mounted for usage by the virtual machine. Valid LUN values are 0 through 15.
host_caching: Specifies the platform caching behavior of data disk blob for read/write efficiency. Thedefault vault is ReadOnly. Possible values are: None, ReadOnly, ReadWrite
media_link: Specifies the location of the blob in Windows Azure blob store where the media for the diskis located. The blob location must belong to the storage account in the subscription specified by the<subscription-id> value in the operation call. Example: http://example.blob.core.windows.net/disks/mydisk.vhd
updated_lun: Specifies the Logical Unit Number (LUN) for the disk. The LUN specifies the slot inwhich the data drive appears when mounted for usage by the virtual machine. Valid LUN values are0 through 15.
disk_label: Specifies the description of the data disk. When you attach a disk, either by directly referenc-ing a media using the MediaLink element or specifying the target disk size, you can use the DiskLabelelement to customize the name property of the target data disk.
disk_name: Specifies the name of the disk. Windows Azure uses the specified disk to create the data diskfor the machine and populates this field with the disk name.
logical_disk_size_in_gb: Specifies the size, in GB, of an empty disk to be attached to the role. The diskcan be created as part of disk attach or create VM role call by specifying the value for this property.Windows Azure creates the empty disk based on size preference and attaches the newly created diskto the Role.
158 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
update_deployment_status(service_name, deployment_name, status)Initiates a change in deployment status.
service_name: Name of the hosted service.
deployment_name: The name of the deployment.
status: The change to initiate to the deployment status. Possible values include:
Running, Suspended
update_disk(disk_name, has_operating_system=None, label=None, media_link=None, name=None,os=None)
Updates an existing disk in your image repository.
disk_name: The name of the disk to update.
has_operating_system: Deprecated.
label: Specifies the description of the disk.
media_link: Deprecated.
name: Deprecated.
os: Deprecated.
update_dns_server(service_name, deployment_name, dns_server_name, address)Updates the ip address of a DNS server.
service_name: The name of the service.
deployment_name: The name of the deployment.
dns_server_name: Specifies the name of the DNS server.
address: Specifies the IP address of the DNS server.
update_hosted_service(service_name, label=None, description=None, ex-tended_properties=None)
Updates the label and/or the description for a hosted service in Windows Azure.
service_name: Name of the hosted service.
label: A name for the hosted service. The name may be up to 100 characters in length. You must specifya value for either Label or Description, or for both. It is recommended that the label be unique withinthe subscription. The name can be used identify the hosted service for your tracking purposes.
description: A description for the hosted service. The description may be up to 1024 characters in length.You must specify a value for either Label or Description, or for both.
extended_properties: Dictionary containing name/value pairs of storage account properties. You canhave a maximum of 50 extended property name/value pairs. The maximum length of the Nameelement is 64 characters, only alphanumeric characters and underscores are valid in the Name, andthe name must start with a letter. The value has a maximum length of 255 characters.
update_os_image(image_name, label, media_link, name, os)Updates an OS image that in your image repository.
image_name: The name of the image to update.
label: Specifies the friendly name of the image to be updated. You cannot use this operation to updateimages provided by the Windows Azure platform.
media_link: Specifies the location of the blob in Windows Azure blob store where the media for theimage is located. The blob location must belong to a storage account in the subscription specified
8.7. azure package 159
Azure SDK for Python Documentation, Release 1.0.3
by the <subscription-id> value in the operation call. Example: http://example.blob.core.windows.net/disks/mydisk.vhd
name: Specifies a name for the OS image that Windows Azure uses to identify the image when creatingone or more VM Roles.
os: The operating system type of the OS image. Possible values are: Linux, Windows
update_os_image_from_image_reference(image_name, os_image)Updates metadata elements from a given OS image reference.
image_name: The name of the image to update.
os_image: An instance of OSImage class.
os_image.label: Optional. Specifies an identifier for the image. os_image.description: Optional. Spec-ifies the description of the image. os_image.language: Optional. Specifies the language of the image.os_image.image_family:
Optional. Specifies a value that can be used to group VM Images.
os_image.recommended_vm_size: Optional. Specifies the size to use for the Virtual Machine that iscreated from the VM Image.
os_image.eula: Optional. Specifies the End User License Agreement that is associated with the image.The value for this element is a string, but it is recommended that the value be a URL that points to aEULA.
os_image.icon_uri: Optional. Specifies the URI to the icon that is displayed for the image in the Man-agement Portal.
os_image.small_icon_uri: Optional. Specifies the URI to the small icon that is displayed for the imagein the Management Portal.
os_image.privacy_uri: Optional. Specifies the URI that points to a document that contains the privacypolicy related to the image.
os_image.published_date: Optional. Specifies the date when the image was added to the image reposi-tory.
os.image.media_link: Required: Specifies the location of the blob in Windows Azure blob store wherethe media for the image is located. The blob location must belong to a storage account in the sub-scription specified by the <subscription-id> value in the operation call. Example: http://example.blob.core.windows.net/disks/mydisk.vhd
os_image.name: Specifies a name for the OS image that Windows Azure uses to identify the image whencreating one or more VM Roles.
os_image.os: The operating system type of the OS image. Possible values are: Linux, Windows
update_role(service_name, deployment_name, role_name, os_virtual_hard_disk=None, net-work_config=None, availability_set_name=None, data_virtual_hard_disks=None,role_size=None, role_type=’PersistentVMRole’, resource_extension_references=None,provision_guest_agent=None)
Updates the specified virtual machine.
service_name: The name of the service.
deployment_name: The name of the deployment.
role_name: The name of the role.
os_virtual_hard_disk: Contains the parameters Windows Azure uses to create the operating system diskfor the virtual machine.
160 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
network_config: Encapsulates the metadata required to create the virtual network configuration for avirtual machine. If you do not include a network configuration set you will not be able to access theVM through VIPs over the internet. If your virtual machine belongs to a virtual network you can notspecify which subnet address space it resides under.
availability_set_name: Specifies the name of an availability set to which to add the virtual machine. Thisvalue controls the virtual machine allocation in the Windows Azure environment. Virtual machinesspecified in the same availability set are allocated to different nodes to maximize availability.
data_virtual_hard_disks: Contains the parameters Windows Azure uses to create a data disk for a virtualmachine.
role_size: The size of the virtual machine to allocate. The default value is Small. Possible values are:ExtraSmall, Small, Medium, Large, ExtraLarge. The specified value must be compatible with thedisk selected in the OSVirtualHardDisk values.
role_type: The type of the role for the virtual machine. The only supported value is PersistentVMRole.
resource_extension_references: Optional. Contains a collection of resource extensions that are to beinstalled on the Virtual Machine. This element is used if provision_guest_agent is set to True.
provision_guest_agent: Optional. Indicates whether the VM Agent is installed on the Virtual Machine.To run a resource extension in a Virtual Machine, this service must be installed.
update_storage_account(service_name, description=None, label=None,geo_replication_enabled=None, extended_properties=None, ac-count_type=’Standard_GRS’)
Updates the label, the description, and enables or disables the geo-replication status for a storage accountin Windows Azure.
service_name: Name of the storage service account.
description: A description for the storage account. The description may be up to 1024 characters inlength.
label: A name for the storage account. The name may be up to 100 characters in length. The name can beused to identify the storage account for your tracking purposes.
geo_replication_enabled: Deprecated. Replaced by the account_type parameter.
extended_properties: Dictionary containing name/value pairs of storage account properties. You canhave a maximum of 50 extended property name/value pairs. The maximum length of the Nameelement is 64 characters, only alphanumeric characters and underscores are valid in the Name, andthe name must start with a letter. The value has a maximum length of 255 characters.
account_type: Specifies whether the account supports locally-redundant storage, geo-redundant storage,zone-redundant storage, or read access geo-redundant storage. Possible values are:
Standard_LRS, Standard_ZRS, Standard_GRS, Standard_RAGRS
update_vm_image(vm_image_name, vm_image)Updates a VM Image in the image repository that is associated with the specified subscription.
vm_image_name: Name of image to update.
vm_image: An instance of VMImage class.
vm_image.label: Optional. Specifies an identifier for the image. vm_image.os_disk_configuration:
Required. Specifies configuration information for the operating system disk that is associatedwith the image.
vm_image.os_disk_configuration.host_caching: Optional. Specifies the caching behavior of the oper-ating system disk. Possible values are: None, ReadOnly, ReadWrite
8.7. azure package 161
Azure SDK for Python Documentation, Release 1.0.3
vm_image.data_disk_configurations: Optional. Specifies configuration information for the data disksthat are associated with the image. A VM Image might not have data disks associated with it.
vm_image.data_disk_configurations[].name: Required. Specifies the name of the data disk.
vm_image.data_disk_configurations[].host_caching: Optional. Specifies the caching behavior of thedata disk. Possible values are: None, ReadOnly, ReadWrite
vm_image.data_disk_configurations[].lun: Optional if the lun for the disk is 0. Specifies the LogicalUnit Number (LUN) for the data disk.
vm_image.description: Optional. Specifies the description of the image. vm_image.language: Optional.Specifies the language of the image. vm_image.image_family:
Optional. Specifies a value that can be used to group VM Images.
vm_image.recommended_vm_size: Optional. Specifies the size to use for the Virtual Machine that iscreated from the VM Image.
vm_image.eula: Optional. Specifies the End User License Agreement that is associated with the image.The value for this element is a string, but it is recommended that the value be a URL that points to aEULA.
vm_image.icon_uri: Optional. Specifies the URI to the icon that is displayed for the image in the Man-agement Portal.
vm_image.small_icon_uri: Optional. Specifies the URI to the small icon that is displayed for the imagein the Management Portal.
vm_image.privacy_uri: Optional. Specifies the URI that points to a document that contains the privacypolicy related to the image.
vm_image.published_date: Optional. Specifies the date when the image was added to the image reposi-tory.
vm_image.show_in_gui: Optional. Indicates whether the VM Images should be listed in the portal.
upgrade_deployment(service_name, deployment_name, mode, package_url, configuration, label,force, role_to_upgrade=None, extended_properties=None)
Initiates an upgrade.
service_name: Name of the hosted service.
deployment_name: The name of the deployment.
mode: If set to Manual, WalkUpgradeDomain must be called to apply the update. If set to Auto, theWindows Azure platform will automatically apply the update To each upgrade domain for the service.Possible values are: Auto, Manual
package_url: A URL that refers to the location of the service package in the Blob service. The servicepackage can be located either in a storage account beneath the same subscription or a Shared AccessSignature (SAS) URI from any storage account.
configuration: The base-64 encoded service configuration file for the deployment.
label: A name for the hosted service. The name can be up to 100 characters in length. It is recommendedthat the label be unique within the subscription. The name can be used to identify the hosted servicefor your tracking purposes.
force: Specifies whether the rollback should proceed even when it will cause local data to be lost fromsome role instances. True if the rollback should proceed; otherwise false if the rollback should fail.
role_to_upgrade: The name of the specific role to upgrade.
162 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
extended_properties: Dictionary containing name/value pairs of storage account properties. You canhave a maximum of 50 extended property name/value pairs. The maximum length of the Nameelement is 64 characters, only alphanumeric characters and underscores are valid in the Name, andthe name must start with a letter. The value has a maximum length of 255 characters.
walk_upgrade_domain(service_name, deployment_name, upgrade_domain)Specifies the next upgrade domain to be walked during manual in-place upgrade or configuration change.
service_name: Name of the hosted service.
deployment_name: The name of the deployment.
upgrade_domain: An integer value that identifies the upgrade domain to walk. Upgrade domains areidentified with a zero-based index: the first upgrade domain has an ID of 0, the second has an ID of1, and so on.
azure.servicemanagement.sqldatabasemanagementservice module
class azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementService(subscription_id=None,cert_file=None,host=’management.core.windows.net’,re-quest_session=None,time-out=65)
Bases: azure.servicemanagement.servicemanagementclient._ServiceManagementClient
Note that this class is a preliminary work on SQL Database management. Since it lack a lot a features, finalversion can be slightly different from the current one.
Initializes the sql database management service.
subscription_id: Subscription to manage.
cert_file: Path to .pem certificate file (httplib), or location of the certificate in your Personal certificate store(winhttp) in the CURRENT_USERmyCertificateName format. If a request_session is specified, then thisis unused.
host: Live ServiceClient URL. Defaults to Azure public cloud.
request_session: Session object to use for http requests. If this is specified, it replaces the default use ofhttplib or winhttp. Also, the cert_file parameter is unused when a session is passed in. The sessionobject handles authentication, and as such can support multiple types of authentication: .pem certificate,oauth. For example, you can pass in a Session instance from the requests library. To use .pem certificateauthentication with requests library, set the path to the .pem file on the session.cert attribute.
timeout: Optional. Timeout for the http request, in seconds.
create_database(server_name, name, service_objective_id, edition=None, collation_name=None,max_size_bytes=None)
Creates a new Azure SQL Database.
server_name: Name of the server to contain the new database.
name: Required. The name for the new database. See Naming Requirements in Azure SQL DatabaseGeneral Guidelines and Limitations and Database Identifiers for more information.
service_objective_id: Required. The GUID corresponding to the performance level for Edition. See ListService Level Objectives for current values.
8.7. azure package 163
Azure SDK for Python Documentation, Release 1.0.3
edition: Optional. The Service Tier (Edition) for the new database. If omitted, the default is Web. Validvalues are Web, Business, Basic, Standard, and Premium. See Azure SQL Database Service Tiers(Editions) and Web and Business Edition Sunset FAQ for more information.
collation_name: Optional. The database collation. This can be any collation supported by SQL. If omit-ted, the default collation is used. See SQL Server Collation Support in Azure SQL Database GeneralGuidelines and Limitations for more information.
max_size_bytes: Optional. Sets the maximum size, in bytes, for the database. This value must be withinthe range of allowed values for Edition. If omitted, the default value for the edition is used. See AzureSQL Database Service Tiers (Editions) for current maximum databases sizes. Convert MB or GBvalues to bytes. 1 MB = 1048576 bytes. 1 GB = 1073741824 bytes.
create_firewall_rule(server_name, name, start_ip_address, end_ip_address)Creates an Azure SQL Database server firewall rule.
server_name: Name of the server to set the firewall rule on.
name: The name of the new firewall rule.
start_ip_address: The lowest IP address in the range of the server-level firewall setting. IP addressesequal to or greater than this can attempt to connect to the server. The lowest possible IP address is0.0.0.0.
end_ip_address: The highest IP address in the range of the server-level firewall setting. IP addressesequal to or less than this can attempt to connect to the server. The highest possible IP address is255.255.255.255.
create_server(admin_login, admin_password, location)Create a new Azure SQL Database server.
admin_login: The administrator login name for the new server.
admin_password: The administrator login password for the new server.
location: The region to deploy the new server.
delete_database(server_name, name)Deletes an Azure SQL Database.
server_name: Name of the server where the database is located.
name: Name of the database to delete.
delete_firewall_rule(server_name, name)Deletes an Azure SQL Database server firewall rule.
server_name: Name of the server with the firewall rule you want to delete.
name: Name of the firewall rule you want to delete.
delete_server(server_name)Deletes an Azure SQL Database server (including all its databases).
server_name: Name of the server you want to delete.
get_server_event_logs(server_name, start_date, interval_size_in_minutes, event_types=’‘)Gets the event logs for an Azure SQL Database Server.
server_name: Name of the server to retrieve the event logs from.
start_date: The starting date and time of the events to retrieve in UTC format, for example ‘2011-09-2816:05:00’.
interval_size_in_minutes: Size of the event logs to retrieve (in minutes). Valid values are: 5, 60, or 1440.
164 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
event_types: The event type of the log entries you want to retrieve. Valid values are:
• connection_successful
• connection_failed
• connection_terminated
• deadlock
• throttling
• throttling_long_transaction
To return all event types pass in an empty string.
list_databases(name)List the SQL databases defined on the specified server name
list_firewall_rules(server_name)Retrieves the set of firewall rules for an Azure SQL Database Server.
server_name: Name of the server.
list_quotas(server_name)Gets quotas for an Azure SQL Database Server.
server_name: Name of the server.
list_servers()List the SQL servers defined on the account.
list_service_level_objectives(server_name)Gets the service level objectives for an Azure SQL Database server.
server_name: Name of the server.
set_server_admin_password(server_name, admin_password)Reset the administrator password for a server.
server_name: Name of the server to change the password.
admin_password: The new administrator password for the server.
update_database(server_name, name, new_database_name=None, service_objective_id=None,edition=None, max_size_bytes=None)
Updates existing database details.
server_name: Name of the server to contain the new database.
name: Required. The name for the new database. See Naming Requirements in Azure SQL DatabaseGeneral Guidelines and Limitations and Database Identifiers for more information.
new_database_name: Optional. The new name for the new database.
service_objective_id: Optional. The new service level to apply to the database. For more informationabout service levels, see Azure SQL Database Service Tiers and Performance Levels. Use List ServiceLevel Objectives to get the correct ID for the desired service objective.
edition: Optional. The new edition for the new database.
max_size_bytes: Optional. The new size of the database in bytes. For information on available sizes foreach edition, see Azure SQL Database Service Tiers (Editions).
update_firewall_rule(server_name, name, start_ip_address, end_ip_address)Update a firewall rule for an Azure SQL Database server.
server_name: Name of the server to set the firewall rule on.
8.7. azure package 165
Azure SDK for Python Documentation, Release 1.0.3
name: The name of the firewall rule to update.
start_ip_address: The lowest IP address in the range of the server-level firewall setting. IP addressesequal to or greater than this can attempt to connect to the server. The lowest possible IP address is0.0.0.0.
end_ip_address: The highest IP address in the range of the server-level firewall setting. IP addressesequal to or less than this can attempt to connect to the server. The highest possible IP address is255.255.255.255.
azure.servicemanagement.websitemanagementservice module
class azure.servicemanagement.websitemanagementservice.WebsiteManagementService(subscription_id=None,cert_file=None,host=’management.core.windows.net’,re-quest_session=None,time-out=65)
Bases: azure.servicemanagement.servicemanagementclient._ServiceManagementClient
Note that this class is a preliminary work on WebSite management. Since it lack a lot a features, final versioncan be slightly different from the current one.
Initializes the website management service.
subscription_id: Subscription to manage.
cert_file: Path to .pem certificate file (httplib), or location of the certificate in your Personal certificate store(winhttp) in the CURRENT_USERmyCertificateName format. If a request_session is specified, then thisis unused.
host: Live ServiceClient URL. Defaults to Azure public cloud.
request_session: Session object to use for http requests. If this is specified, it replaces the default use ofhttplib or winhttp. Also, the cert_file parameter is unused when a session is passed in. The sessionobject handles authentication, and as such can support multiple types of authentication: .pem certificate,oauth. For example, you can pass in a Session instance from the requests library. To use .pem certificateauthentication with requests library, set the path to the .pem file on the session.cert attribute.
timeout: Optional. Timeout for the http request, in seconds.
create_site(webspace_name, website_name, geo_region, host_names,plan=’VirtualDedicatedPlan’, compute_mode=’Shared’, server_farm=None,site_mode=None)
Create a website.
webspace_name: The name of the webspace.
website_name: The name of the website.
geo_region: The geographical region of the webspace that will be created.
host_names: An array of fully qualified domain names for website. Only one hostname can be specifiedin the azurewebsites.net domain. The hostname should match the name of the website. Customdomains can only be specified for Shared or Standard websites.
plan: This value must be ‘VirtualDedicatedPlan’.
166 Chapter 8. Indices and tables
Azure SDK for Python Documentation, Release 1.0.3
compute_mode: This value should be ‘Shared’ for the Free or Paid Shared offerings, or ‘Dedicated’ forthe Standard offering. The default value is ‘Shared’. If you set it to ‘Dedicated’, you must specify avalue for the server_farm parameter.
server_farm: The name of the Server Farm associated with this website. This is a required value forStandard mode.
site_mode: Can be None, ‘Limited’ or ‘Basic’. This value is ‘Limited’ for the Free offering, and ‘Ba-sic’ for the Paid Shared offering. Standard mode does not use the site_mode parameter; it uses thecompute_mode parameter.
delete_site(webspace_name, website_name, delete_empty_server_farm=False,delete_metrics=False)
Delete a website.
webspace_name: The name of the webspace.
website_name: The name of the website.
delete_empty_server_farm: If the site being deleted is the last web site in a server farm, you can deletethe server farm by setting this to True.
delete_metrics: To also delete the metrics for the site that you are deleting, you can set this to True.
get_historical_usage_metrics(webspace_name, website_name, metrics=None,start_time=None, end_time=None, time_grain=None)
Get historical usage metrics.
webspace_name: The name of the webspace.
website_name: The name of the website.
metrics: Optional. List of metrics name. Otherwise, all metrics returned.
start_time: Optional. An ISO8601 date. Otherwise, current hour is used.
end_time: Optional. An ISO8601 date. Otherwise, current time is used.
time_grain: Optional. A rollup name, as P1D. OTherwise, default rollup for the metrics is used.
More information and metrics name at: http://msdn.microsoft.com/en-us/library/azure/dn166964.aspx
get_metric_definitions(webspace_name, website_name)Get metric definitions of metrics available of this web site.
webspace_name: The name of the webspace.
website_name: The name of the website.
get_publish_profile(webspace_name, website_name)Get a site’s publish profile as an object
webspace_name: The name of the webspace.
website_name: The name of the website.
get_publish_profile_xml(webspace_name, website_name)Get a site’s publish profile as a string
webspace_name: The name of the webspace.
website_name: The name of the website.
get_site(webspace_name, website_name)List the web sites defined on this webspace.
webspace_name: The name of the webspace.
8.7. azure package 167
Azure SDK for Python Documentation, Release 1.0.3
website_name: The name of the website.
get_webspace(webspace_name)Get details of a specific webspace.
webspace_name: The name of the webspace.
list_sites(webspace_name)List the web sites defined on this webspace.
webspace_name: The name of the webspace.
list_webspaces()List the webspaces defined on the account.
restart_site(webspace_name, website_name)Restart a web site.
webspace_name: The name of the webspace.
website_name: The name of the website.
update_site(webspace_name, website_name, state=None)Update a web site.
webspace_name: The name of the webspace.
website_name: The name of the website.
state: The wanted state (‘Running’ or ‘Stopped’ accepted)
Module contents
Module contents
azure
168 Chapter 8. Indices and tables
Python Module Index
aazure, 168azure.common, 30azure.mgmt, 121azure.mgmt.common, 31azure.mgmt.common.arm, 31azure.mgmt.common.filters, 31azure.mgmt.compute, 58azure.mgmt.compute.computemanagement,
33azure.mgmt.network, 95azure.mgmt.network.networkresourceprovider,
58azure.mgmt.resource, 114azure.mgmt.resource.resourcemanagement,
95azure.mgmt.storage, 121azure.mgmt.storage.storagemanagement,
114azure.servicebus, 128azure.servicebus.constants, 121azure.servicebus.models, 121azure.servicebus.servicebusservice, 123azure.servicemanagement, 168azure.servicemanagement.constants, 129azure.servicemanagement.models, 129azure.servicemanagement.publishsettings,
137azure.servicemanagement.schedulermanagementservice,
137azure.servicemanagement.servicebusmanagementservice,
140azure.servicemanagement.servicemanagementclient,
143azure.servicemanagement.servicemanagementservice,
143azure.servicemanagement.sqldatabasemanagementservice,
163azure.servicemanagement.websitemanagementservice,
166
169
Azure SDK for Python Documentation, Release 1.0.3
170 Python Module Index
Index
Aaccepted (azure.mgmt.resource.resourcemanagement.ProvisioningState
attribute), 103access (azure.mgmt.network.networkresourceprovider.SecurityRule
attribute), 78access_token (azure.mgmt.common.SubscriptionCloudCredentials
attribute), 32access_token_type (azure.mgmt.common.SubscriptionCloudCredentials
attribute), 32account_key (azure.servicebus.servicebusservice.ServiceBusService
attribute), 123account_name_invalid (azure.mgmt.storage.storagemanagement.Reason
attribute), 115account_type (azure.mgmt.storage.storagemanagement.StorageAccount
attribute), 115account_type (azure.mgmt.storage.storagemanagement.StorageAccountCreateParameters
attribute), 116account_type (azure.mgmt.storage.storagemanagement.StorageAccountUpdateParameters
attribute), 119account_type_to_string()
(azure.mgmt.storage.storagemanagement.StorageManagementClientmethod), 120
AccountStatus (class inazure.mgmt.storage.storagemanagement),114
AccountType (class inazure.mgmt.storage.storagemanagement),114
add_data_disk() (azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 143
add_disk() (azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 144
add_dns_server() (azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 144
add_filter() (azure.mgmt.common.Service method), 32add_headers() (azure.servicebus.models.Message
method), 122add_management_certificate()
(azure.servicemanagement.servicemanagementservice.ServiceManagementService
method), 144add_os_image() (azure.servicemanagement.servicemanagementservice.ServiceManagementService
method), 144add_role() (azure.servicemanagement.servicemanagementservice.ServiceManagementService
method), 144add_service_certificate() (azure.servicemanagement.servicemanagementservice.ServiceManagementService
method), 145additional_unattend_contents
(azure.mgmt.compute.computemanagement.WindowsConfigurationattribute), 58
AdditionalUnattendContent (class inazure.mgmt.compute.computemanagement),33
AdditionalUnattendContent (class inazure.servicemanagement.models), 129
address_prefix (azure.mgmt.network.networkresourceprovider.Subnetattribute), 81
address_prefixes (azure.mgmt.network.networkresourceprovider.AddressSpaceattribute), 58
address_space (azure.mgmt.network.networkresourceprovider.VirtualNetworkattribute), 85
AddressSpace (class inazure.mgmt.network.networkresourceprovider),58
admin_password (azure.mgmt.compute.computemanagement.OSProfileattribute), 40
admin_username (azure.mgmt.compute.computemanagement.OSProfileattribute), 40
AffinityGroup (class inazure.servicemanagement.models), 129
AffinityGroups (class inazure.servicemanagement.models), 129
all (azure.mgmt.network.networkresourceprovider.SecurityRuleProtocolattribute), 81
allow (azure.mgmt.network.networkresourceprovider.SecurityRuleAccessattribute), 78
already_exists (azure.mgmt.storage.storagemanagement.Reasonattribute), 115
api_version (azure.mgmt.compute.computemanagement.ComputeManagementClientattribute), 36
171
Azure SDK for Python Documentation, Release 1.0.3
api_version (azure.mgmt.network.networkresourceprovider.NetworkResourceProviderClientattribute), 70
api_version (azure.mgmt.resource.resourcemanagement.ResourceManagementClientattribute), 107
api_version (azure.mgmt.storage.storagemanagement.StorageManagementClientattribute), 120
api_versions (azure.mgmt.resource.resourcemanagement.ProviderResourceTypeattribute), 103
ApiEntityReference (class inazure.mgmt.compute.computemanagement),33
ApiError (class in azure.mgmt.compute.computemanagement),33
ApiErrorBase (class inazure.mgmt.compute.computemanagement),33
applied_dns_servers (azure.mgmt.network.networkresourceprovider.DnsSettingsattribute), 60
AsynchronousOperationResult (class inazure.servicemanagement.models), 129
attach (azure.mgmt.compute.computemanagement.DiskCreateOptionTypesattribute), 38
AttachedTo (class in azure.servicemanagement.models),129
AuthorizationRule (class in azure.servicebus.models),121
AuthorizationRule (class inazure.servicemanagement.models), 129
AuthorizationRules (class inazure.servicemanagement.models), 129
auto_logon (azure.mgmt.compute.computemanagement.SettingNamesattribute), 41
auto_upgrade_minor_version(azure.mgmt.compute.computemanagement.VirtualMachineExtensionattribute), 45
availability_set (azure.mgmt.compute.computemanagement.AvailabilitySetCreateOrUpdateResponseattribute), 34
availability_set (azure.mgmt.compute.computemanagement.AvailabilitySetGetResponseattribute), 34
availability_set_reference(azure.mgmt.compute.computemanagement.VirtualMachineattribute), 44
availability_sets (azure.mgmt.compute.computemanagement.AvailabilitySetListResponseattribute), 34
availability_sets (azure.mgmt.compute.computemanagement.ComputeManagementClientattribute), 36
AvailabilityResponse (class inazure.servicemanagement.models), 129
AvailabilitySet (class inazure.mgmt.compute.computemanagement),33
AvailabilitySetCreateOrUpdateResponse (class inazure.mgmt.compute.computemanagement),34
AvailabilitySetGetResponse (class inazure.mgmt.compute.computemanagement),34
AvailabilitySetListResponse (class inazure.mgmt.compute.computemanagement),34
AvailabilitySetOperations (class inazure.mgmt.compute.computemanagement),34
AvailabilitySetReference (class inazure.mgmt.compute.computemanagement),35
available (azure.mgmt.storage.storagemanagement.AccountStatusattribute), 114
azure (module), 168azure.common (module), 30azure.mgmt (module), 121azure.mgmt.common (module), 31azure.mgmt.common.arm (module), 31azure.mgmt.common.filters (module), 31azure.mgmt.compute (module), 58azure.mgmt.compute.computemanagement (module), 33azure.mgmt.network (module), 95azure.mgmt.network.networkresourceprovider (module),
58azure.mgmt.resource (module), 114azure.mgmt.resource.resourcemanagement (module), 95azure.mgmt.storage (module), 121azure.mgmt.storage.storagemanagement (module), 114azure.servicebus (module), 128azure.servicebus.constants (module), 121azure.servicebus.models (module), 121azure.servicebus.servicebusservice (module), 123azure.servicemanagement (module), 168azure.servicemanagement.constants (module), 129azure.servicemanagement.models (module), 129azure.servicemanagement.publishsettings (module), 137azure.servicemanagement.schedulermanagementservice
(module), 137azure.servicemanagement.servicebusmanagementservice
(module), 140azure.servicemanagement.servicemanagementclient
(module), 143azure.servicemanagement.servicemanagementservice
(module), 143azure.servicemanagement.sqldatabasemanagementservice
(module), 163azure.servicemanagement.websitemanagementservice
(module), 166azure_async_operation (azure.mgmt.compute.computemanagement.ComputeOperationResponse
attribute), 37azure_async_operation (azure.mgmt.network.networkresourceprovider.UpdateOperationResponse
attribute), 84AzureAsyncOperationHttpError, 129
172 Index
Azure SDK for Python Documentation, Release 1.0.3
AzureAsyncOperationResponse (class inazure.mgmt.network.networkresourceprovider),58
AzureConflictHttpError, 30AzureException, 30AzureHttpError, 30AzureMissingResourceHttpError, 30AzureOperationResponse (class in azure.mgmt.common),
31AzureServiceBusPeekLockError, 121AzureServiceBusResourceNotFound, 121
Bbackend_address_pool (azure.mgmt.network.networkresourceprovider.LoadBalancingRule
attribute), 64backend_address_pools (azure.mgmt.network.networkresourceprovider.LoadBalancer
attribute), 62backend_ip_configuration
(azure.mgmt.network.networkresourceprovider.InboundNatRuleattribute), 61
backend_ip_configurations(azure.mgmt.network.networkresourceprovider.BackendAddressPoolattribute), 59
backend_port (azure.mgmt.network.networkresourceprovider.InboundNatRuleattribute), 61
backend_port (azure.mgmt.network.networkresourceprovider.LoadBalancingRuleattribute), 64
BackendAddressPool (class inazure.mgmt.network.networkresourceprovider),59
base_uri (azure.mgmt.common.Service attribute), 32basic_a0 (azure.mgmt.compute.computemanagement.VirtualMachineSizeTypes
attribute), 57basic_a1 (azure.mgmt.compute.computemanagement.VirtualMachineSizeTypes
attribute), 57basic_a2 (azure.mgmt.compute.computemanagement.VirtualMachineSizeTypes
attribute), 57basic_a3 (azure.mgmt.compute.computemanagement.VirtualMachineSizeTypes
attribute), 57basic_a4 (azure.mgmt.compute.computemanagement.VirtualMachineSizeTypes
attribute), 57BasicDependency (class in
azure.mgmt.resource.resourcemanagement), 95begin_capturing() (azure.mgmt.compute.computemanagement.VirtualMachineOperations
method), 52begin_create() (azure.mgmt.storage.storagemanagement.StorageAccountOperations
method), 117begin_create_or_updating()
(azure.mgmt.network.networkresourceprovider.LoadBalancerOperationsmethod), 62
begin_create_or_updating()(azure.mgmt.network.networkresourceprovider.LocalNetworkGatewayOperationsmethod), 65
begin_create_or_updating()
(azure.mgmt.network.networkresourceprovider.NetworkInterfaceOperationsmethod), 68
begin_create_or_updating()(azure.mgmt.network.networkresourceprovider.NetworkSecurityGroupOperationsmethod), 72
begin_create_or_updating()(azure.mgmt.network.networkresourceprovider.PublicIpAddressOperationsmethod), 76
begin_create_or_updating()(azure.mgmt.network.networkresourceprovider.SecurityRuleOperationsmethod), 79
begin_create_or_updating()(azure.mgmt.network.networkresourceprovider.SubnetOperationsmethod), 82
begin_create_or_updating()(azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayConnectionOperationsmethod), 86
begin_create_or_updating()(azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayOperationsmethod), 90
begin_create_or_updating()(azure.mgmt.network.networkresourceprovider.VirtualNetworkOperationsmethod), 93
begin_creating_or_updating()(azure.mgmt.compute.computemanagement.VirtualMachineExtensionOperationsmethod), 47
begin_creating_or_updating()(azure.mgmt.compute.computemanagement.VirtualMachineOperationsmethod), 52
begin_deallocating() (azure.mgmt.compute.computemanagement.VirtualMachineOperationsmethod), 52
begin_deleting() (azure.mgmt.compute.computemanagement.VirtualMachineExtensionOperationsmethod), 48
begin_deleting() (azure.mgmt.compute.computemanagement.VirtualMachineOperationsmethod), 53
begin_deleting() (azure.mgmt.network.networkresourceprovider.LoadBalancerOperationsmethod), 63
begin_deleting() (azure.mgmt.network.networkresourceprovider.LocalNetworkGatewayOperationsmethod), 66
begin_deleting() (azure.mgmt.network.networkresourceprovider.NetworkInterfaceOperationsmethod), 68
begin_deleting() (azure.mgmt.network.networkresourceprovider.NetworkSecurityGroupOperationsmethod), 72
begin_deleting() (azure.mgmt.network.networkresourceprovider.PublicIpAddressOperationsmethod), 76
begin_deleting() (azure.mgmt.network.networkresourceprovider.SecurityRuleOperationsmethod), 79
begin_deleting() (azure.mgmt.network.networkresourceprovider.SubnetOperationsmethod), 82
begin_deleting() (azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayConnectionOperationsmethod), 86
begin_deleting() (azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayOperationsmethod), 90
begin_deleting() (azure.mgmt.network.networkresourceprovider.VirtualNetworkOperations
Index 173
Azure SDK for Python Documentation, Release 1.0.3
method), 93begin_deleting() (azure.mgmt.resource.resourcemanagement.ResourceGroupOperations
method), 105begin_powering_off() (azure.mgmt.compute.computemanagement.VirtualMachineOperations
method), 53begin_reset() (azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayOperations
method), 91begin_reset_shared_key()
(azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayConnectionOperationsmethod), 87
begin_restarting() (azure.mgmt.compute.computemanagement.VirtualMachineOperationsmethod), 53
begin_set_shared_key() (azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayConnectionOperationsmethod), 87
begin_starting() (azure.mgmt.compute.computemanagement.VirtualMachineOperationsmethod), 53
blob (azure.mgmt.storage.storagemanagement.Endpointsattribute), 114
Ccaching (azure.mgmt.compute.computemanagement.Disk
attribute), 37CachingTypes (class in
azure.mgmt.compute.computemanagement),35
cancel() (azure.mgmt.resource.resourcemanagement.DeploymentOperationsmethod), 97
canceled (azure.mgmt.resource.resourcemanagement.ProvisioningStateattribute), 103
capture() (azure.mgmt.compute.computemanagement.VirtualMachineOperationsmethod), 53
capture_role() (azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 145
capture_vm_image() (azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 146
CaptureRoleAsVMImage (class inazure.servicemanagement.models), 129
Certificate (class in azure.servicemanagement.models),129
certificate_store (azure.mgmt.compute.computemanagement.VaultCertificateattribute), 43
certificate_url (azure.mgmt.compute.computemanagement.VaultCertificateattribute), 43
certificate_url (azure.mgmt.compute.computemanagement.WinRMListenerattribute), 58
Certificates (class in azure.servicemanagement.models),129
CertificateSetting (class inazure.servicemanagement.models), 129
change_deployment_configuration()(azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 146
check_dns_name_availability()(azure.mgmt.network.networkresourceprovider.NetworkResourceProviderClient
method), 70check_existence() (azure.mgmt.resource.resourcemanagement.ResourceGroupOperations
method), 105check_existence() (azure.mgmt.resource.resourcemanagement.ResourceOperations
method), 108check_hosted_service_name_availability()
(azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 147
check_job_collection_name()(azure.servicemanagement.schedulermanagementservice.SchedulerManagementServicemethod), 138
check_name_availability()(azure.mgmt.storage.storagemanagement.StorageAccountOperationsmethod), 117
check_namespace_availability()(azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementServicemethod), 140
check_storage_account_name_availability()(azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 147
CheckNameAvailabilityResponse (class inazure.mgmt.storage.storagemanagement),114
ChildResource (class inazure.mgmt.network.networkresourceprovider),59
client (azure.mgmt.compute.computemanagement.AvailabilitySetOperationsattribute), 34
client (azure.mgmt.compute.computemanagement.UsageOperationsattribute), 43
client (azure.mgmt.compute.computemanagement.VirtualMachineExtensionImageOperationsattribute), 47
client (azure.mgmt.compute.computemanagement.VirtualMachineExtensionOperationsattribute), 48
client (azure.mgmt.compute.computemanagement.VirtualMachineImageOperationsattribute), 50
client (azure.mgmt.compute.computemanagement.VirtualMachineOperationsattribute), 54
client (azure.mgmt.compute.computemanagement.VirtualMachineSizeOperationsattribute), 57
client (azure.mgmt.network.networkresourceprovider.LoadBalancerOperationsattribute), 63
client (azure.mgmt.network.networkresourceprovider.LocalNetworkGatewayOperationsattribute), 66
client (azure.mgmt.network.networkresourceprovider.NetworkInterfaceOperationsattribute), 69
client (azure.mgmt.network.networkresourceprovider.NetworkSecurityGroupOperationsattribute), 72
client (azure.mgmt.network.networkresourceprovider.PublicIpAddressOperationsattribute), 76
client (azure.mgmt.network.networkresourceprovider.SecurityRuleOperationsattribute), 80
client (azure.mgmt.network.networkresourceprovider.SubnetOperationsattribute), 82
174 Index
Azure SDK for Python Documentation, Release 1.0.3
client (azure.mgmt.network.networkresourceprovider.UsageOperationsattribute), 84
client (azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayConnectionOperationsattribute), 87
client (azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayOperationsattribute), 91
client (azure.mgmt.network.networkresourceprovider.VirtualNetworkOperationsattribute), 93
client (azure.mgmt.resource.resourcemanagement.DeploymentOperationOperationsattribute), 96
client (azure.mgmt.resource.resourcemanagement.DeploymentOperationsattribute), 98
client (azure.mgmt.resource.resourcemanagement.ProviderOperationsattribute), 102
client (azure.mgmt.resource.resourcemanagement.ResourceGroupOperationsattribute), 106
client (azure.mgmt.resource.resourcemanagement.ResourceOperationsattribute), 109
client (azure.mgmt.resource.resourcemanagement.ResourceProviderOperationDetailsOperationsattribute), 110
client (azure.mgmt.resource.resourcemanagement.TagOperationsattribute), 112
client (azure.mgmt.storage.storagemanagement.StorageAccountOperationsattribute), 117
CloudService (class inazure.servicemanagement.models), 130
CloudServices (class inazure.servicemanagement.models), 130
code (azure.mgmt.compute.computemanagement.ApiErrorBaseattribute), 33
code (azure.mgmt.compute.computemanagement.InstanceViewStatusattribute), 38
code (azure.mgmt.network.networkresourceprovider.Errorattribute), 60
code (azure.mgmt.network.networkresourceprovider.ErrorDetailsattribute), 60
code (azure.mgmt.resource.resourcemanagement.ResourceManagementErrorattribute), 108
component_name (azure.mgmt.compute.computemanagement.AdditionalUnattendContentattribute), 33
ComponentNames (class inazure.mgmt.compute.computemanagement),35
Components (class in azure.servicemanagement.models),130
ComponentSetting (class inazure.servicemanagement.models), 130
ComponentSettings (class inazure.servicemanagement.models), 130
compute_role (azure.mgmt.compute.computemanagement.VirtualMachineExtensionImageattribute), 45
ComputeCapabilities (class inazure.servicemanagement.models), 130
ComputeLongRunningOperationResponse (class in
azure.mgmt.compute.computemanagement),35
ComputeManagementClient (class inazure.mgmt.compute.computemanagement),36
ComputeOperationResponse (class inazure.mgmt.compute.computemanagement),37
ComputeOperationStatus (class inazure.mgmt.compute.computemanagement),37
computer_name (azure.mgmt.compute.computemanagement.OSProfileattribute), 40
ConfigurationSet (class inazure.servicemanagement.models), 130
ConfigurationSetInputEndpoint (class inazure.servicemanagement.models), 130
ConfigurationSetInputEndpoints (class inazure.servicemanagement.models), 130
ConfigurationSets (class inazure.servicemanagement.models), 130
connection_reset_shared_key(azure.mgmt.network.networkresourceprovider.ConnectionResetSharedKeyPutResponseattribute), 59
connection_shared_key (azure.mgmt.network.networkresourceprovider.ConnectionSharedKeyPutResponseattribute), 59
connection_type (azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayConnectionattribute), 85
ConnectionResetSharedKey (class inazure.mgmt.network.networkresourceprovider),59
ConnectionResetSharedKeyPutResponse (class inazure.mgmt.network.networkresourceprovider),59
ConnectionSharedKey (class inazure.mgmt.network.networkresourceprovider),59
ConnectionSharedKeyPutResponse (class inazure.mgmt.network.networkresourceprovider),59
ConnectionSharedKeyResponse (class inazure.mgmt.network.networkresourceprovider),60
content (azure.mgmt.compute.computemanagement.AdditionalUnattendContentattribute), 33
content_version (azure.mgmt.resource.resourcemanagement.ParametersLinkattribute), 101
content_version (azure.mgmt.resource.resourcemanagement.TemplateLinkattribute), 113
correlation_id (azure.mgmt.resource.resourcemanagement.DeploymentPropertiesExtendedattribute), 99
count (azure.mgmt.compute.computemanagement.UsageUnitattribute), 43
count (azure.mgmt.network.networkresourceprovider.UsageUnit
Index 175
Azure SDK for Python Documentation, Release 1.0.3
attribute), 84count (azure.mgmt.resource.resourcemanagement.TagDetails
attribute), 111count (azure.mgmt.resource.resourcemanagement.TagValue
attribute), 113CountDetails (class in azure.servicemanagement.models),
130create() (azure.mgmt.storage.storagemanagement.StorageAccountOperations
method), 117create_affinity_group() (azure.servicemanagement.servicemanagementservice.ServiceManagementService
method), 147create_cloud_service() (azure.servicemanagement.schedulermanagementservice.SchedulerManagementService
method), 138create_database() (azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementService
method), 163create_deployment() (azure.servicemanagement.servicemanagementservice.ServiceManagementService
method), 147create_event_hub() (azure.servicebus.servicebusservice.ServiceBusService
method), 123create_firewall_rule() (azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementService
method), 164create_hosted_service() (azure.servicemanagement.servicemanagementservice.ServiceManagementService
method), 148create_job() (azure.servicemanagement.schedulermanagementservice.SchedulerManagementService
method), 138create_job_collection() (azure.servicemanagement.schedulermanagementservice.SchedulerManagementService
method), 138create_namespace() (azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService
method), 140create_option (azure.mgmt.compute.computemanagement.Disk
attribute), 37create_or_update() (azure.mgmt.compute.computemanagement.AvailabilitySetOperations
method), 34create_or_update() (azure.mgmt.compute.computemanagement.VirtualMachineExtensionOperations
method), 48create_or_update() (azure.mgmt.compute.computemanagement.VirtualMachineOperations
method), 54create_or_update() (azure.mgmt.network.networkresourceprovider.LoadBalancerOperations
method), 63create_or_update() (azure.mgmt.network.networkresourceprovider.LocalNetworkGatewayOperations
method), 66create_or_update() (azure.mgmt.network.networkresourceprovider.NetworkInterfaceOperations
method), 69create_or_update() (azure.mgmt.network.networkresourceprovider.NetworkSecurityGroupOperations
method), 72create_or_update() (azure.mgmt.network.networkresourceprovider.PublicIpAddressOperations
method), 76create_or_update() (azure.mgmt.network.networkresourceprovider.SecurityRuleOperations
method), 80create_or_update() (azure.mgmt.network.networkresourceprovider.SubnetOperations
method), 82create_or_update() (azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayConnectionOperations
method), 87create_or_update() (azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayOperations
method), 91create_or_update() (azure.mgmt.network.networkresourceprovider.VirtualNetworkOperations
method), 93create_or_update() (azure.mgmt.resource.resourcemanagement.DeploymentOperations
method), 98create_or_update() (azure.mgmt.resource.resourcemanagement.ResourceGroupOperations
method), 106create_or_update() (azure.mgmt.resource.resourcemanagement.ResourceOperations
method), 109create_or_update() (azure.mgmt.resource.resourcemanagement.TagOperations
method), 112create_or_update_value()
(azure.mgmt.resource.resourcemanagement.TagOperationsmethod), 112
create_queue() (azure.servicebus.servicebusservice.ServiceBusServicemethod), 124
create_reserved_ip_address()(azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 148
create_rule() (azure.servicebus.servicebusservice.ServiceBusServicemethod), 124
create_server() (azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementServicemethod), 164
create_site() (azure.servicemanagement.websitemanagementservice.WebsiteManagementServicemethod), 166
create_storage_account()(azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 148
create_subscription() (azure.servicebus.servicebusservice.ServiceBusServicemethod), 124
create_topic() (azure.servicebus.servicebusservice.ServiceBusServicemethod), 124
create_virtual_machine_deployment()(azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 149
create_vm_image() (azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 150
created (azure.mgmt.resource.resourcemanagement.ProvisioningStateattribute), 103
CreateServerResponse (class inazure.servicemanagement.models), 130
creating (azure.mgmt.compute.computemanagement.ProvisioningStateTypesattribute), 41
creating (azure.mgmt.resource.resourcemanagement.ProvisioningStateattribute), 103
creating (azure.mgmt.storage.storagemanagement.ProvisioningStateattribute), 115
creation_time (azure.mgmt.storage.storagemanagement.StorageAccountattribute), 115
credentials (azure.mgmt.common.Service attribute), 32Credentials (class in azure.servicemanagement.models),
130current_value (azure.mgmt.compute.computemanagement.Usage
attribute), 42
176 Index
Azure SDK for Python Documentation, Release 1.0.3
current_value (azure.mgmt.network.networkresourceprovider.Usageattribute), 84
custom_data (azure.mgmt.compute.computemanagement.OSProfileattribute), 40
custom_domain (azure.mgmt.storage.storagemanagement.StorageAccountattribute), 115
custom_domain (azure.mgmt.storage.storagemanagement.StorageAccountUpdateParametersattribute), 120
CustomDomain (class inazure.mgmt.storage.storagemanagement),114
DData (class in azure.servicemanagement.models), 131data_disk_images (azure.mgmt.compute.computemanagement.VirtualMachineImage
attribute), 49data_disks (azure.mgmt.compute.computemanagement.StorageProfile
attribute), 42Database (class in azure.servicemanagement.models),
131DataDisk (class in azure.mgmt.compute.computemanagement),
37DataDiskConfiguration (class in
azure.servicemanagement.models), 131DataDiskConfigurations (class in
azure.servicemanagement.models), 131DataDiskImage (class in
azure.mgmt.compute.computemanagement),37
DataVirtualHardDisk (class inazure.servicemanagement.models), 131
DataVirtualHardDisks (class inazure.servicemanagement.models), 131
deallocate() (azure.mgmt.compute.computemanagement.VirtualMachineOperationsmethod), 54
dedicated (azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayConnectionTypeattribute), 89
default (azure.mgmt.network.networkresourceprovider.LoadDistributionattribute), 65
default (azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewaySizeattribute), 92
default_security_rules (azure.mgmt.network.networkresourceprovider.NetworkSecurityGroupattribute), 71
delete() (azure.mgmt.compute.computemanagement.AvailabilitySetOperationsmethod), 34
delete() (azure.mgmt.compute.computemanagement.VirtualMachineExtensionOperationsmethod), 48
delete() (azure.mgmt.compute.computemanagement.VirtualMachineOperationsmethod), 54
delete() (azure.mgmt.network.networkresourceprovider.LoadBalancerOperationsmethod), 63
delete() (azure.mgmt.network.networkresourceprovider.LocalNetworkGatewayOperationsmethod), 66
delete() (azure.mgmt.network.networkresourceprovider.NetworkInterfaceOperationsmethod), 69
delete() (azure.mgmt.network.networkresourceprovider.NetworkSecurityGroupOperationsmethod), 73
delete() (azure.mgmt.network.networkresourceprovider.PublicIpAddressOperationsmethod), 76
delete() (azure.mgmt.network.networkresourceprovider.SecurityRuleOperationsmethod), 80
delete() (azure.mgmt.network.networkresourceprovider.SubnetOperationsmethod), 82
delete() (azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayConnectionOperationsmethod), 88
delete() (azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayOperationsmethod), 91
delete() (azure.mgmt.network.networkresourceprovider.VirtualNetworkOperationsmethod), 94
delete() (azure.mgmt.resource.resourcemanagement.ResourceGroupOperationsmethod), 106
delete() (azure.mgmt.resource.resourcemanagement.ResourceOperationsmethod), 109
delete() (azure.mgmt.resource.resourcemanagement.TagOperationsmethod), 112
delete() (azure.mgmt.storage.storagemanagement.StorageAccountOperationsmethod), 118
delete() (azure.servicebus.models.Message method), 122delete_affinity_group() (azure.servicemanagement.servicemanagementservice.ServiceManagementService
method), 151delete_cloud_service() (azure.servicemanagement.schedulermanagementservice.SchedulerManagementService
method), 138delete_data_disk() (azure.servicemanagement.servicemanagementservice.ServiceManagementService
method), 151delete_database() (azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementService
method), 164delete_deployment() (azure.servicemanagement.servicemanagementservice.ServiceManagementService
method), 151delete_disk() (azure.servicemanagement.servicemanagementservice.ServiceManagementService
method), 151delete_dns_server() (azure.servicemanagement.servicemanagementservice.ServiceManagementService
method), 151delete_event_hub() (azure.servicebus.servicebusservice.ServiceBusService
method), 124delete_firewall_rule() (azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementService
method), 164delete_hosted_service() (azure.servicemanagement.servicemanagementservice.ServiceManagementService
method), 152delete_job() (azure.servicemanagement.schedulermanagementservice.SchedulerManagementService
method), 139delete_job_collection() (azure.servicemanagement.schedulermanagementservice.SchedulerManagementService
method), 139delete_management_certificate()
(azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 152
delete_namespace() (azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementServicemethod), 140
Index 177
Azure SDK for Python Documentation, Release 1.0.3
delete_os_image() (azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 152
delete_queue() (azure.servicebus.servicebusservice.ServiceBusServicemethod), 124
delete_queue_message() (azure.servicebus.servicebusservice.ServiceBusServicemethod), 124
delete_reserved_ip_address()(azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 152
delete_role() (azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 152
delete_role_instances() (azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 152
delete_rule() (azure.servicebus.servicebusservice.ServiceBusServicemethod), 125
delete_server() (azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementServicemethod), 164
delete_service_certificate()(azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 152
delete_site() (azure.servicemanagement.websitemanagementservice.WebsiteManagementServicemethod), 167
delete_storage_account()(azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 152
delete_subscription() (azure.servicebus.servicebusservice.ServiceBusServicemethod), 125
delete_subscription_message()(azure.servicebus.servicebusservice.ServiceBusServicemethod), 125
delete_topic() (azure.servicebus.servicebusservice.ServiceBusServicemethod), 125
delete_value() (azure.mgmt.resource.resourcemanagement.TagOperationsmethod), 112
delete_vm_image() (azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 152
deleted (azure.mgmt.resource.resourcemanagement.ProvisioningStateattribute), 103
deleting (azure.mgmt.compute.computemanagement.ProvisioningStateTypesattribute), 41
deleting (azure.mgmt.network.networkresourceprovider.ProvisioningStateattribute), 74
deleting (azure.mgmt.resource.resourcemanagement.ProvisioningStateattribute), 103
deny (azure.mgmt.network.networkresourceprovider.SecurityRuleAccessattribute), 78
dependencies (azure.mgmt.resource.resourcemanagement.DeploymentPropertiesExtendedattribute), 99
Dependency (class in azure.mgmt.resource.resourcemanagement),95
depends_on (azure.mgmt.resource.resourcemanagement.Dependencyattribute), 95
deployment (azure.mgmt.resource.resourcemanagement.DeploymentGetResultattribute), 96
deployment (azure.mgmt.resource.resourcemanagement.DeploymentOperationsCreateResultattribute), 99
Deployment (class in azure.mgmt.resource.resourcemanagement),95
Deployment (class in azure.servicemanagement.models),131
deployment_operations (azure.mgmt.resource.resourcemanagement.ResourceManagementClientattribute), 107
DeploymentExtended (class inazure.mgmt.resource.resourcemanagement), 95
DeploymentGetResult (class inazure.mgmt.resource.resourcemanagement), 95
DeploymentListParameters (class inazure.mgmt.resource.resourcemanagement), 96
DeploymentListResult (class inazure.mgmt.resource.resourcemanagement), 96
DeploymentMode (class inazure.mgmt.resource.resourcemanagement), 96
DeploymentOperation (class inazure.mgmt.resource.resourcemanagement), 96
DeploymentOperationOperations (class inazure.mgmt.resource.resourcemanagement), 96
DeploymentOperationProperties (class inazure.mgmt.resource.resourcemanagement), 97
DeploymentOperations (class inazure.mgmt.resource.resourcemanagement), 97
DeploymentOperationsCreateResult (class inazure.mgmt.resource.resourcemanagement), 99
DeploymentOperationsGetResult (class inazure.mgmt.resource.resourcemanagement), 99
DeploymentOperationsListParameters (class inazure.mgmt.resource.resourcemanagement), 99
DeploymentOperationsListResult (class inazure.mgmt.resource.resourcemanagement), 99
DeploymentProperties (class inazure.mgmt.resource.resourcemanagement), 99
DeploymentPropertiesExtended (class inazure.mgmt.resource.resourcemanagement), 99
deployments (azure.mgmt.resource.resourcemanagement.DeploymentListResultattribute), 96
deployments (azure.mgmt.resource.resourcemanagement.ResourceManagementClientattribute), 108
Deployments (class inazure.servicemanagement.models), 131
DeploymentValidateResponse (class inazure.mgmt.resource.resourcemanagement),100
description (azure.mgmt.network.networkresourceprovider.SecurityRuleattribute), 78
description (azure.mgmt.resource.resourcemanagement.ResourceProviderOperationDisplayPropertiesattribute), 110
destination_address_prefix(azure.mgmt.network.networkresourceprovider.SecurityRuleattribute), 78
178 Index
Azure SDK for Python Documentation, Release 1.0.3
destination_container_name(azure.mgmt.compute.computemanagement.VirtualMachineCaptureParametersattribute), 44
destination_port_range (azure.mgmt.network.networkresourceprovider.SecurityRuleattribute), 78
details (azure.mgmt.compute.computemanagement.ApiErrorattribute), 33
details (azure.mgmt.network.networkresourceprovider.Errorattribute), 60
details (azure.mgmt.resource.resourcemanagement.ResourceManagementErrorWithDetailsattribute), 108
dhcp_options (azure.mgmt.network.networkresourceprovider.VirtualNetworkattribute), 85
DhcpOptions (class inazure.mgmt.network.networkresourceprovider),60
direction (azure.mgmt.network.networkresourceprovider.SecurityRuleattribute), 78
disable_password_authentication(azure.mgmt.compute.computemanagement.LinuxConfigurationattribute), 39
Disk (class in azure.mgmt.compute.computemanagement),37
Disk (class in azure.servicemanagement.models), 131disk_size_gb (azure.mgmt.compute.computemanagement.DataDisk
attribute), 37DiskCreateOptionTypes (class in
azure.mgmt.compute.computemanagement),38
DiskInstanceView (class inazure.mgmt.compute.computemanagement),38
disks (azure.mgmt.compute.computemanagement.VirtualMachineInstanceViewattribute), 51
Disks (class in azure.servicemanagement.models), 131display_status (azure.mgmt.compute.computemanagement.InstanceViewStatus
attribute), 38dns_name_availability (azure.mgmt.network.networkresourceprovider.DnsNameAvailabilityResponse
attribute), 60dns_servers (azure.mgmt.network.networkresourceprovider.DhcpOptions
attribute), 60dns_servers (azure.mgmt.network.networkresourceprovider.DnsSettings
attribute), 60dns_settings (azure.mgmt.network.networkresourceprovider.NetworkInterface
attribute), 67dns_settings (azure.mgmt.network.networkresourceprovider.PublicIpAddress
attribute), 75DnsNameAvailabilityResponse (class in
azure.mgmt.network.networkresourceprovider),60
DnsServer (class in azure.servicemanagement.models),131
DnsSettings (class in azure.mgmt.network.networkresourceprovider),60
domain_name_label (azure.mgmt.network.networkresourceprovider.PublicIpAddressDnsSettingsattribute), 75
DomainJoin (class in azure.servicemanagement.models),131
dynamic (azure.mgmt.network.networkresourceprovider.IpAllocationMethodattribute), 62
dynamic_routing (azure.mgmt.network.networkresourceprovider.VpnGatewayTypeattribute), 95
Eempty (azure.mgmt.compute.computemanagement.DiskCreateOptionTypes
attribute), 38enable_automatic_updates
(azure.mgmt.compute.computemanagement.WindowsConfigurationattribute), 58
enable_bgp (azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayattribute), 85
enable_floating_ip (azure.mgmt.network.networkresourceprovider.InboundNatRuleattribute), 61
enable_floating_ip (azure.mgmt.network.networkresourceprovider.LoadBalancingRuleattribute), 64
end_time (azure.mgmt.compute.computemanagement.ComputeLongRunningOperationResponseattribute), 36
Endpoints (class in azure.mgmt.storage.storagemanagement),114
error (azure.mgmt.compute.computemanagement.ComputeLongRunningOperationResponseattribute), 36
error (azure.mgmt.compute.computemanagement.StatusLevelTypesattribute), 42
error (azure.mgmt.network.networkresourceprovider.ResourceProviderErrorResponseattribute), 77
error (azure.mgmt.resource.resourcemanagement.DeploymentValidateResponseattribute), 100
error (azure.mgmt.resource.resourcemanagement.LongRunningOperationResponseattribute), 100
Error (class in azure.mgmt.network.networkresourceprovider),60
error_detail (azure.mgmt.compute.computemanagement.InnerErrorattribute), 38
ErrorDetails (class in azure.mgmt.network.networkresourceprovider),60
etag (azure.mgmt.network.networkresourceprovider.ChildResourceattribute), 59
etag (azure.mgmt.network.networkresourceprovider.TopLevelResourceattribute), 83
EventHub (class in azure.servicebus.models), 121EventLog (class in azure.servicemanagement.models),
131exception_type (azure.mgmt.compute.computemanagement.InnerError
attribute), 38exists (azure.mgmt.resource.resourcemanagement.ResourceExistsResult
attribute), 104exists (azure.mgmt.resource.resourcemanagement.ResourceGroupExistsResult
attribute), 104
Index 179
Azure SDK for Python Documentation, Release 1.0.3
extension_handlers (azure.mgmt.compute.computemanagement.VirtualMachineAgentInstanceViewattribute), 44
extension_type (azure.mgmt.compute.computemanagement.VirtualMachineExtensionattribute), 45
extension_type (azure.mgmt.compute.computemanagement.VirtualMachineExtensionInstanceViewattribute), 47
extensions (azure.mgmt.compute.computemanagement.VirtualMachineattribute), 44
extensions (azure.mgmt.compute.computemanagement.VirtualMachineInstanceViewattribute), 51
FFailed (azure.mgmt.common.OperationStatus attribute),
32failed (azure.mgmt.common.OperationStatus attribute),
32failed (azure.mgmt.compute.computemanagement.ComputeOperationStatus
attribute), 37failed (azure.mgmt.compute.computemanagement.ProvisioningStateTypes
attribute), 41failed (azure.mgmt.network.networkresourceprovider.OperationStatus
attribute), 74failed (azure.mgmt.network.networkresourceprovider.ProvisioningState
attribute), 74failed (azure.mgmt.resource.resourcemanagement.ProvisioningState
attribute), 103filter_expression (azure.mgmt.compute.computemanagement.VirtualMachineExtensionImageListVersionsParameters
attribute), 46filter_expression (azure.mgmt.compute.computemanagement.VirtualMachineImageListParameters
attribute), 50FirewallRule (class in azure.servicemanagement.models),
131first_logon_commands (azure.mgmt.compute.computemanagement.SettingNames
attribute), 41fqdn (azure.mgmt.network.networkresourceprovider.PublicIpAddressDnsSettings
attribute), 75from_image (azure.mgmt.compute.computemanagement.DiskCreateOptionTypes
attribute), 38frontend_ip_configuration
(azure.mgmt.network.networkresourceprovider.InboundNatRuleattribute), 61
frontend_ip_configuration(azure.mgmt.network.networkresourceprovider.LoadBalancingRuleattribute), 64
frontend_ip_configurations(azure.mgmt.network.networkresourceprovider.LoadBalancerattribute), 62
frontend_port (azure.mgmt.network.networkresourceprovider.InboundNatRuleattribute), 61
frontend_port (azure.mgmt.network.networkresourceprovider.LoadBalancingRuleattribute), 64
FrontendIpConfiguration (class inazure.mgmt.network.networkresourceprovider),60
Ggateway_ip_address (azure.mgmt.network.networkresourceprovider.LocalNetworkGateway
attribute), 65gateway_size (azure.mgmt.network.networkresourceprovider.VirtualNetworkGateway
attribute), 85gateway_type (azure.mgmt.network.networkresourceprovider.VirtualNetworkGateway
attribute), 85generalize() (azure.mgmt.compute.computemanagement.VirtualMachineOperations
method), 54GenericResource (class in
azure.mgmt.resource.resourcemanagement),100
GenericResourceExtended (class inazure.mgmt.resource.resourcemanagement),100
get() (azure.mgmt.compute.computemanagement.AvailabilitySetOperationsmethod), 35
get() (azure.mgmt.compute.computemanagement.VirtualMachineExtensionImageOperationsmethod), 47
get() (azure.mgmt.compute.computemanagement.VirtualMachineExtensionOperationsmethod), 48
get() (azure.mgmt.compute.computemanagement.VirtualMachineImageOperationsmethod), 50
get() (azure.mgmt.compute.computemanagement.VirtualMachineOperationsmethod), 54
get() (azure.mgmt.network.networkresourceprovider.LoadBalancerOperationsmethod), 63
get() (azure.mgmt.network.networkresourceprovider.LocalNetworkGatewayOperationsmethod), 66
get() (azure.mgmt.network.networkresourceprovider.NetworkInterfaceOperationsmethod), 69
get() (azure.mgmt.network.networkresourceprovider.NetworkSecurityGroupOperationsmethod), 73
get() (azure.mgmt.network.networkresourceprovider.PublicIpAddressOperationsmethod), 77
get() (azure.mgmt.network.networkresourceprovider.SecurityRuleOperationsmethod), 80
get() (azure.mgmt.network.networkresourceprovider.SubnetOperationsmethod), 83
get() (azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayConnectionOperationsmethod), 88
get() (azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayOperationsmethod), 92
get() (azure.mgmt.network.networkresourceprovider.VirtualNetworkOperationsmethod), 94
get() (azure.mgmt.resource.resourcemanagement.DeploymentOperationOperationsmethod), 96
get() (azure.mgmt.resource.resourcemanagement.DeploymentOperationsmethod), 98
get() (azure.mgmt.resource.resourcemanagement.ProviderOperationsmethod), 102
get() (azure.mgmt.resource.resourcemanagement.ResourceGroupOperationsmethod), 106
get() (azure.mgmt.resource.resourcemanagement.ResourceOperations
180 Index
Azure SDK for Python Documentation, Release 1.0.3
method), 109get_affinity_group_properties()
(azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 153
get_all_jobs() (azure.servicemanagement.schedulermanagementservice.SchedulerManagementServicemethod), 139
get_certificate_from_publish_settings() (in moduleazure.servicemanagement.publishsettings), 137
get_cloud_service() (azure.servicemanagement.schedulermanagementservice.SchedulerManagementServicemethod), 139
get_create_operation_status()(azure.mgmt.storage.storagemanagement.StorageManagementClientmethod), 120
get_data_disk() (azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 153
get_deployment_by_name()(azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 153
get_deployment_by_slot()(azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 153
get_disk() (azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 153
get_event_hub() (azure.servicebus.servicebusservice.ServiceBusServicemethod), 125
get_historical_usage_metrics()(azure.servicemanagement.websitemanagementservice.WebsiteManagementServicemethod), 167
get_hosted_service_properties()(azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 153
get_job() (azure.servicemanagement.schedulermanagementservice.SchedulerManagementServicemethod), 139
get_job_collection() (azure.servicemanagement.schedulermanagementservice.SchedulerManagementServicemethod), 139
get_long_running_operation_status()(azure.mgmt.compute.computemanagement.ComputeManagementClientmethod), 36
get_long_running_operation_status()(azure.mgmt.network.networkresourceprovider.NetworkResourceProviderClientmethod), 70
get_long_running_operation_status()(azure.mgmt.resource.resourcemanagement.ResourceManagementClientmethod), 108
get_management_certificate()(azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 153
get_metric_definitions() (azure.servicemanagement.websitemanagementservice.WebsiteManagementServicemethod), 167
get_metrics_data_notification_hub()(azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementServicemethod), 140
get_metrics_data_queue()(azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService
method), 140get_metrics_data_relay()
(azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementServicemethod), 141
get_metrics_data_topic()(azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementServicemethod), 141
get_metrics_rollups_notification_hub()(azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementServicemethod), 141
get_metrics_rollups_queue()(azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementServicemethod), 141
get_metrics_rollups_relay()(azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementServicemethod), 141
get_metrics_rollups_topic()(azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementServicemethod), 141
get_namespace() (azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementServicemethod), 142
get_os_image() (azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 153
get_properties() (azure.mgmt.storage.storagemanagement.StorageAccountOperationsmethod), 118
get_publish_profile() (azure.servicemanagement.websitemanagementservice.WebsiteManagementServicemethod), 167
get_publish_profile_xml()(azure.servicemanagement.websitemanagementservice.WebsiteManagementServicemethod), 167
get_queue() (azure.servicebus.servicebusservice.ServiceBusServicemethod), 125
get_regions() (azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementServicemethod), 142
get_reserved_ip_address()(azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 153
get_role() (azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 153
get_rule() (azure.servicebus.servicebusservice.ServiceBusServicemethod), 125
get_server_event_logs() (azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementServicemethod), 164
get_service_certificate() (azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 154
get_shared_key() (azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayConnectionOperationsmethod), 88
get_site() (azure.servicemanagement.websitemanagementservice.WebsiteManagementServicemethod), 167
get_storage_account_keys()(azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 154
get_storage_account_properties()(azure.servicemanagement.servicemanagementservice.ServiceManagementService
Index 181
Azure SDK for Python Documentation, Release 1.0.3
method), 154get_subscription() (azure.servicebus.servicebusservice.ServiceBusService
method), 125get_subscription() (azure.servicemanagement.servicemanagementservice.ServiceManagementService
method), 154get_supported_metrics_notification_hub()
(azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementServicemethod), 142
get_supported_metrics_queue()(azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementServicemethod), 142
get_supported_metrics_relay()(azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementServicemethod), 142
get_supported_metrics_topic()(azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementServicemethod), 142
get_topic() (azure.servicebus.servicebusservice.ServiceBusServicemethod), 126
get_webspace() (azure.servicemanagement.websitemanagementservice.WebsiteManagementServicemethod), 168
get_with_instance_view()(azure.mgmt.compute.computemanagement.VirtualMachineExtensionOperationsmethod), 49
get_with_instance_view()(azure.mgmt.compute.computemanagement.VirtualMachineOperationsmethod), 55
Hhandler_schema (azure.mgmt.compute.computemanagement.VirtualMachineExtensionImage
attribute), 46hardware_profile (azure.mgmt.compute.computemanagement.VirtualMachine
attribute), 44HardwareProfile (class in
azure.mgmt.compute.computemanagement),38
high_performance (azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewaySizeattribute), 93
HostedService (class inazure.servicemanagement.models), 131
HostedServiceProperties (class inazure.servicemanagement.models), 131
HostedServices (class inazure.servicemanagement.models), 131
HostNameSslState (class inazure.servicemanagement.models), 131
HostNameSslStates (class inazure.servicemanagement.models), 131
http (azure.mgmt.compute.computemanagement.ProtocolTypesattribute), 40
http (azure.mgmt.network.networkresourceprovider.ProbeProtocolattribute), 74
https (azure.mgmt.compute.computemanagement.ProtocolTypesattribute), 41
Iid (azure.mgmt.common.arm.ResourceBaseExtended at-
tribute), 31id (azure.mgmt.compute.computemanagement.VirtualMachineImageResource
attribute), 51id (azure.mgmt.network.networkresourceprovider.ResourceId
attribute), 77id (azure.mgmt.resource.resourcemanagement.BasicDependency
attribute), 95id (azure.mgmt.resource.resourcemanagement.DeploymentExtended
attribute), 95id (azure.mgmt.resource.resourcemanagement.DeploymentOperation
attribute), 96id (azure.mgmt.resource.resourcemanagement.Provider
attribute), 101id (azure.mgmt.resource.resourcemanagement.ResourceGroupExtended
attribute), 105id (azure.mgmt.resource.resourcemanagement.TagDetails
attribute), 111id (azure.mgmt.resource.resourcemanagement.TagValue
attribute), 113id (azure.mgmt.resource.resourcemanagement.TargetResource
attribute), 113idle_timeout_in_minutes
(azure.mgmt.network.networkresourceprovider.InboundNatRuleattribute), 61
idle_timeout_in_minutes(azure.mgmt.network.networkresourceprovider.LoadBalancingRuleattribute), 64
idle_timeout_in_minutes(azure.mgmt.network.networkresourceprovider.PublicIpAddressattribute), 75
image_reference (azure.mgmt.compute.computemanagement.StorageProfileattribute), 42
ImageReference (class inazure.mgmt.compute.computemanagement),38
Images (class in azure.servicemanagement.models), 131in_progress (azure.mgmt.common.OperationStatus at-
tribute), 32in_progress (azure.mgmt.compute.computemanagement.ComputeOperationStatus
attribute), 37in_progress (azure.mgmt.network.networkresourceprovider.OperationStatus
attribute), 74inbound (azure.mgmt.network.networkresourceprovider.SecurityRuleDirection
attribute), 79inbound_nat_rules (azure.mgmt.network.networkresourceprovider.FrontendIpConfiguration
attribute), 60inbound_nat_rules (azure.mgmt.network.networkresourceprovider.LoadBalancer
attribute), 62InboundNatRule (class in
azure.mgmt.network.networkresourceprovider),61
incremental (azure.mgmt.resource.resourcemanagement.DeploymentMode
182 Index
Azure SDK for Python Documentation, Release 1.0.3
attribute), 96info (azure.mgmt.compute.computemanagement.StatusLevelTypes
attribute), 42inner_error (azure.mgmt.compute.computemanagement.ApiError
attribute), 33inner_error (azure.mgmt.network.networkresourceprovider.Error
attribute), 60InnerError (class in azure.mgmt.compute.computemanagement),
38InProgress (azure.mgmt.common.OperationStatus at-
tribute), 32InputEndpoint (class in
azure.servicemanagement.models), 132InputEndpoints (class in
azure.servicemanagement.models), 132instance_view (azure.mgmt.compute.computemanagement.VirtualMachine
attribute), 44instance_view (azure.mgmt.compute.computemanagement.VirtualMachineExtension
attribute), 45InstanceEndpoint (class in
azure.servicemanagement.models), 132InstanceEndpoints (class in
azure.servicemanagement.models), 132InstanceViewStatus (class in
azure.mgmt.compute.computemanagement),38
interval_in_seconds (azure.mgmt.network.networkresourceprovider.Probeattribute), 74
IntrinsicSettings (class inazure.servicemanagement.models), 132
ip_address (azure.mgmt.network.networkresourceprovider.PublicIpAddressattribute), 75
ip_configuration (azure.mgmt.network.networkresourceprovider.PublicIpAddressattribute), 75
ip_configurations (azure.mgmt.network.networkresourceprovider.NetworkInterfaceattribute), 67
ip_configurations (azure.mgmt.network.networkresourceprovider.Subnetattribute), 81
ip_configurations (azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayattribute), 85
IpAllocationMethod (class inazure.mgmt.network.networkresourceprovider),61
ipsec (azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayConnectionTypeattribute), 89
is_valid (azure.mgmt.resource.resourcemanagement.DeploymentValidateResponseattribute), 100
issuer (azure.servicebus.servicebusservice.ServiceBusServiceattribute), 126
Kkey1 (azure.mgmt.storage.storagemanagement.KeyName
attribute), 115
key1 (azure.mgmt.storage.storagemanagement.StorageAccountKeysattribute), 116
key2 (azure.mgmt.storage.storagemanagement.KeyNameattribute), 115
key2 (azure.mgmt.storage.storagemanagement.StorageAccountKeysattribute), 116
key_data (azure.mgmt.compute.computemanagement.SshPublicKeyattribute), 42
key_length (azure.mgmt.network.networkresourceprovider.ConnectionResetSharedKeyattribute), 59
key_name_to_string() (azure.mgmt.storage.storagemanagement.StorageManagementClientmethod), 120
KeyName (class in azure.mgmt.storage.storagemanagement),115
KeyPair (class in azure.servicemanagement.models), 132KeyPairs (class in azure.servicemanagement.models),
132
Llast_geo_failover_time (azure.mgmt.storage.storagemanagement.StorageAccount
attribute), 115level (azure.mgmt.compute.computemanagement.InstanceViewStatus
attribute), 39limit (azure.mgmt.compute.computemanagement.Usage
attribute), 42limit (azure.mgmt.network.networkresourceprovider.Usage
attribute), 84linux (azure.mgmt.compute.computemanagement.OperatingSystemTypes
attribute), 40linux_configuration (azure.mgmt.compute.computemanagement.OSProfile
attribute), 40LinuxConfiguration (class in
azure.mgmt.compute.computemanagement),39
LinuxConfigurationSet (class inazure.servicemanagement.models), 132
list() (azure.mgmt.compute.computemanagement.AvailabilitySetOperationsmethod), 35
list() (azure.mgmt.compute.computemanagement.UsageOperationsmethod), 43
list() (azure.mgmt.compute.computemanagement.VirtualMachineImageOperationsmethod), 50
list() (azure.mgmt.compute.computemanagement.VirtualMachineOperationsmethod), 55
list() (azure.mgmt.compute.computemanagement.VirtualMachineSizeOperationsmethod), 57
list() (azure.mgmt.network.networkresourceprovider.LoadBalancerOperationsmethod), 64
list() (azure.mgmt.network.networkresourceprovider.LocalNetworkGatewayOperationsmethod), 67
list() (azure.mgmt.network.networkresourceprovider.NetworkInterfaceOperationsmethod), 69
list() (azure.mgmt.network.networkresourceprovider.NetworkSecurityGroupOperationsmethod), 73
Index 183
Azure SDK for Python Documentation, Release 1.0.3
list() (azure.mgmt.network.networkresourceprovider.PublicIpAddressOperationsmethod), 77
list() (azure.mgmt.network.networkresourceprovider.SecurityRuleOperationsmethod), 80
list() (azure.mgmt.network.networkresourceprovider.SubnetOperationsmethod), 83
list() (azure.mgmt.network.networkresourceprovider.UsageOperationsmethod), 84
list() (azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayConnectionOperationsmethod), 88
list() (azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayOperationsmethod), 92
list() (azure.mgmt.network.networkresourceprovider.VirtualNetworkOperationsmethod), 94
list() (azure.mgmt.resource.resourcemanagement.DeploymentOperationOperationsmethod), 97
list() (azure.mgmt.resource.resourcemanagement.DeploymentOperationsmethod), 98
list() (azure.mgmt.resource.resourcemanagement.ProviderOperationsmethod), 102
list() (azure.mgmt.resource.resourcemanagement.ResourceGroupOperationsmethod), 106
list() (azure.mgmt.resource.resourcemanagement.ResourceOperationsmethod), 109
list() (azure.mgmt.resource.resourcemanagement.ResourceProviderOperationDetailsOperationsmethod), 110
list() (azure.mgmt.resource.resourcemanagement.TagOperationsmethod), 112
list() (azure.mgmt.storage.storagemanagement.StorageAccountOperationsmethod), 118
list_affinity_groups() (azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 154
list_all() (azure.mgmt.compute.computemanagement.VirtualMachineOperationsmethod), 55
list_all() (azure.mgmt.network.networkresourceprovider.LoadBalancerOperationsmethod), 64
list_all() (azure.mgmt.network.networkresourceprovider.NetworkInterfaceOperationsmethod), 69
list_all() (azure.mgmt.network.networkresourceprovider.NetworkSecurityGroupOperationsmethod), 73
list_all() (azure.mgmt.network.networkresourceprovider.PublicIpAddressOperationsmethod), 77
list_all() (azure.mgmt.network.networkresourceprovider.VirtualNetworkOperationsmethod), 94
list_available_sizes() (azure.mgmt.compute.computemanagement.AvailabilitySetOperationsmethod), 35
list_available_sizes() (azure.mgmt.compute.computemanagement.VirtualMachineOperationsmethod), 55
list_by_resource_group()(azure.mgmt.storage.storagemanagement.StorageAccountOperationsmethod), 118
list_cloud_services() (azure.servicemanagement.schedulermanagementservice.SchedulerManagementServicemethod), 139
list_databases() (azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementService
method), 165list_disks() (azure.servicemanagement.servicemanagementservice.ServiceManagementService
method), 154list_firewall_rules() (azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementService
method), 165list_hosted_services() (azure.servicemanagement.servicemanagementservice.ServiceManagementService
method), 154list_keys() (azure.mgmt.storage.storagemanagement.StorageAccountOperations
method), 118list_locations() (azure.servicemanagement.servicemanagementservice.ServiceManagementService
method), 154list_management_certificates()
(azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 154
list_namespaces() (azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementServicemethod), 142
list_next() (azure.mgmt.compute.computemanagement.VirtualMachineOperationsmethod), 55
list_next() (azure.mgmt.resource.resourcemanagement.DeploymentOperationOperationsmethod), 97
list_next() (azure.mgmt.resource.resourcemanagement.DeploymentOperationsmethod), 98
list_next() (azure.mgmt.resource.resourcemanagement.ProviderOperationsmethod), 102
list_next() (azure.mgmt.resource.resourcemanagement.ResourceGroupOperationsmethod), 106
list_next() (azure.mgmt.resource.resourcemanagement.ResourceOperationsmethod), 109
list_next() (azure.mgmt.resource.resourcemanagement.TagOperationsmethod), 113
list_notification_hubs() (azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementServicemethod), 142
list_offers() (azure.mgmt.compute.computemanagement.VirtualMachineImageOperationsmethod), 50
list_operating_system_families()(azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 154
list_operating_systems() (azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 154
list_os_images() (azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 154
list_publishers() (azure.mgmt.compute.computemanagement.VirtualMachineImageOperationsmethod), 51
list_queues() (azure.servicebus.servicebusservice.ServiceBusServicemethod), 126
list_queues() (azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementServicemethod), 142
list_quotas() (azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementServicemethod), 165
list_relays() (azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementServicemethod), 142
list_reserved_ip_addresses()(azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 154
184 Index
Azure SDK for Python Documentation, Release 1.0.3
list_resource_extension_versions()(azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 154
list_resource_extensions()(azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 155
list_role_sizes() (azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 155
list_rules() (azure.servicebus.servicebusservice.ServiceBusServicemethod), 126
list_servers() (azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementServicemethod), 165
list_service_certificates()(azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 155
list_service_level_objectives()(azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementServicemethod), 165
list_sites() (azure.servicemanagement.websitemanagementservice.WebsiteManagementServicemethod), 168
list_skus() (azure.mgmt.compute.computemanagement.VirtualMachineImageOperationsmethod), 51
list_storage_accounts() (azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 155
list_subscription_operations()(azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 155
list_subscriptions() (azure.servicebus.servicebusservice.ServiceBusServicemethod), 126
list_subscriptions() (azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 155
list_topics() (azure.servicebus.servicebusservice.ServiceBusServicemethod), 126
list_topics() (azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementServicemethod), 142
list_types() (azure.mgmt.compute.computemanagement.VirtualMachineExtensionImageOperationsmethod), 47
list_versions() (azure.mgmt.compute.computemanagement.VirtualMachineExtensionImageOperationsmethod), 47
list_virtual_network_sites()(azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 155
list_vm_images() (azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 155
list_webspaces() (azure.servicemanagement.websitemanagementservice.WebsiteManagementServicemethod), 168
Listener (class in azure.servicemanagement.models), 132listeners (azure.mgmt.compute.computemanagement.WinRMConfiguration
attribute), 58Listeners (class in azure.servicemanagement.models),
132ListParameters (class in
azure.mgmt.compute.computemanagement),39
ListUsagesResponse (class inazure.mgmt.compute.computemanagement),39
load_balancer (azure.mgmt.network.networkresourceprovider.LoadBalancerGetResponseattribute), 62
load_balancer (azure.mgmt.network.networkresourceprovider.LoadBalancerPutResponseattribute), 64
load_balancer_backend_address_pools(azure.mgmt.network.networkresourceprovider.NetworkInterfaceIpConfigurationattribute), 68
load_balancer_inbound_nat_rules(azure.mgmt.network.networkresourceprovider.NetworkInterfaceIpConfigurationattribute), 68
load_balancers (azure.mgmt.network.networkresourceprovider.LoadBalancerListResponseattribute), 62
load_balancers (azure.mgmt.network.networkresourceprovider.NetworkResourceProviderClientattribute), 70
load_balancing_rules (azure.mgmt.network.networkresourceprovider.BackendAddressPoolattribute), 59
load_balancing_rules (azure.mgmt.network.networkresourceprovider.FrontendIpConfigurationattribute), 61
load_balancing_rules (azure.mgmt.network.networkresourceprovider.LoadBalancerattribute), 62
load_balancing_rules (azure.mgmt.network.networkresourceprovider.Probeattribute), 74
load_distribution (azure.mgmt.network.networkresourceprovider.LoadBalancingRuleattribute), 64
LoadBalancer (class inazure.mgmt.network.networkresourceprovider),62
LoadBalancerGetResponse (class inazure.mgmt.network.networkresourceprovider),62
LoadBalancerListResponse (class inazure.mgmt.network.networkresourceprovider),62
LoadBalancerOperations (class inazure.mgmt.network.networkresourceprovider),62
LoadBalancerProbe (class inazure.servicemanagement.models), 132
LoadBalancerPutResponse (class inazure.mgmt.network.networkresourceprovider),64
LoadBalancingRule (class inazure.mgmt.network.networkresourceprovider),64
LoadDistribution (class inazure.mgmt.network.networkresourceprovider),65
local_network_gateway (azure.mgmt.network.networkresourceprovider.LocalNetworkGatewayGetResponseattribute), 65
local_network_gateway (azure.mgmt.network.networkresourceprovider.LocalNetworkGatewayPutResponseattribute), 67
Index 185
Azure SDK for Python Documentation, Release 1.0.3
local_network_gateway2(azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayConnectionattribute), 85
local_network_gateways (azure.mgmt.network.networkresourceprovider.LocalNetworkGatewayListResponseattribute), 65
local_network_gateways (azure.mgmt.network.networkresourceprovider.NetworkResourceProviderClientattribute), 70
local_network_site_address_space(azure.mgmt.network.networkresourceprovider.LocalNetworkGatewayattribute), 65
localized_value (azure.mgmt.compute.computemanagement.UsageNameattribute), 42
localized_value (azure.mgmt.network.networkresourceprovider.UsageNameattribute), 84
LocalNetworkGateway (class inazure.mgmt.network.networkresourceprovider),65
LocalNetworkGatewayGetResponse (class inazure.mgmt.network.networkresourceprovider),65
LocalNetworkGatewayListResponse (class inazure.mgmt.network.networkresourceprovider),65
LocalNetworkGatewayOperations (class inazure.mgmt.network.networkresourceprovider),65
LocalNetworkGatewayPutResponse (class inazure.mgmt.network.networkresourceprovider),67
location (azure.mgmt.common.arm.ResourceBase at-tribute), 31
location (azure.mgmt.compute.computemanagement.VirtualMachineExtensionImageListTypesParametersattribute), 46
location (azure.mgmt.compute.computemanagement.VirtualMachineImageListPublishersParametersattribute), 50
location (azure.mgmt.compute.computemanagement.VirtualMachineImageResourceattribute), 51
location (azure.mgmt.resource.resourcemanagement.ResourceGroupattribute), 104
location (azure.mgmt.storage.storagemanagement.StorageAccountCreateParametersattribute), 116
Location (class in azure.servicemanagement.models), 132locations (azure.mgmt.resource.resourcemanagement.ProviderResourceType
attribute), 103Locations (class in azure.servicemanagement.models),
132LogFilter (class in azure.mgmt.common.filters), 31long_running_operation_initial_timeout
(azure.mgmt.compute.computemanagement.ComputeManagementClientattribute), 36
long_running_operation_initial_timeout(azure.mgmt.network.networkresourceprovider.NetworkResourceProviderClientattribute), 71
long_running_operation_initial_timeout
(azure.mgmt.resource.resourcemanagement.ResourceManagementClientattribute), 108
long_running_operation_initial_timeout(azure.mgmt.storage.storagemanagement.StorageManagementClientattribute), 121
long_running_operation_retry_timeout(azure.mgmt.compute.computemanagement.ComputeManagementClientattribute), 36
long_running_operation_retry_timeout(azure.mgmt.network.networkresourceprovider.NetworkResourceProviderClientattribute), 71
long_running_operation_retry_timeout(azure.mgmt.resource.resourcemanagement.ResourceManagementClientattribute), 108
long_running_operation_retry_timeout(azure.mgmt.storage.storagemanagement.StorageManagementClientattribute), 121
LongRunningOperationResponse (class inazure.mgmt.resource.resourcemanagement),100
lun (azure.mgmt.compute.computemanagement.DataDiskattribute), 37
lun (azure.mgmt.compute.computemanagement.DataDiskImageattribute), 37
Mmac_address (azure.mgmt.network.networkresourceprovider.NetworkInterface
attribute), 67max_data_disk_count (azure.mgmt.compute.computemanagement.VirtualMachineSize
attribute), 56max_size_in_mega_bytes
(azure.servicebus.models.Topic attribute),122
MaxRecurrence (class inazure.servicemanagement.models), 132
memory_in_mb (azure.mgmt.compute.computemanagement.VirtualMachineSizeattribute), 56
message (azure.mgmt.compute.computemanagement.ApiErrorBaseattribute), 33
message (azure.mgmt.compute.computemanagement.InstanceViewStatusattribute), 39
message (azure.mgmt.network.networkresourceprovider.Errorattribute), 60
message (azure.mgmt.network.networkresourceprovider.ErrorDetailsattribute), 60
message (azure.mgmt.resource.resourcemanagement.ResourceManagementErrorattribute), 108
message (azure.mgmt.storage.storagemanagement.CheckNameAvailabilityResponseattribute), 114
Message (class in azure.servicebus.models), 122MetricAvailabilities (class in
azure.servicemanagement.models), 132MetricAvailability (class in
azure.servicemanagement.models), 132
186 Index
Azure SDK for Python Documentation, Release 1.0.3
MetricDefinition (class inazure.servicemanagement.models), 132
MetricDefinitions (class inazure.servicemanagement.models), 133
MetricProperties (class inazure.servicemanagement.models), 133
MetricResponse (class inazure.servicemanagement.models), 133
MetricResponses (class inazure.servicemanagement.models), 133
MetricRollups (class inazure.servicemanagement.models), 133
MetricSample (class inazure.servicemanagement.models), 133
MetricValues (class inazure.servicemanagement.models), 133
microsoft_windows_shell_setup(azure.mgmt.compute.computemanagement.ComponentNamesattribute), 35
mode (azure.mgmt.resource.resourcemanagement.DeploymentPropertiesattribute), 99
move_resources() (azure.mgmt.resource.resourcemanagement.ResourceOperationsmethod), 110
Nname (azure.mgmt.common.arm.ResourceBaseExtended
attribute), 31name (azure.mgmt.compute.computemanagement.Disk
attribute), 37name (azure.mgmt.compute.computemanagement.DiskInstanceView
attribute), 38name (azure.mgmt.compute.computemanagement.Plan
attribute), 40name (azure.mgmt.compute.computemanagement.PurchasePlan
attribute), 41name (azure.mgmt.compute.computemanagement.Usage
attribute), 42name (azure.mgmt.compute.computemanagement.VirtualMachineExtensionInstanceView
attribute), 47name (azure.mgmt.compute.computemanagement.VirtualMachineImageResource
attribute), 51name (azure.mgmt.compute.computemanagement.VirtualMachineSize
attribute), 56name (azure.mgmt.network.networkresourceprovider.ChildResource
attribute), 59name (azure.mgmt.network.networkresourceprovider.Usage
attribute), 84name (azure.mgmt.resource.resourcemanagement.DeploymentExtended
attribute), 95name (azure.mgmt.resource.resourcemanagement.Plan
attribute), 101name (azure.mgmt.resource.resourcemanagement.ProviderResourceType
attribute), 103
name (azure.mgmt.resource.resourcemanagement.ResourceGroupExtendedattribute), 105
name (azure.mgmt.resource.resourcemanagement.ResourceProviderOperationDefinitionattribute), 110
name (azure.mgmt.resource.resourcemanagement.TagDetailsattribute), 111
name (azure.mgmt.storage.storagemanagement.CustomDomainattribute), 114
name_available (azure.mgmt.storage.storagemanagement.CheckNameAvailabilityResponseattribute), 114
namespace (azure.mgmt.resource.resourcemanagement.Providerattribute), 101
network_interface (azure.mgmt.network.networkresourceprovider.NetworkInterfaceGetResponseattribute), 67
network_interface (azure.mgmt.network.networkresourceprovider.NetworkInterfacePutResponseattribute), 70
network_interfaces (azure.mgmt.compute.computemanagement.NetworkProfileattribute), 39
network_interfaces (azure.mgmt.network.networkresourceprovider.NetworkInterfaceListResponseattribute), 68
network_interfaces (azure.mgmt.network.networkresourceprovider.NetworkResourceProviderClientattribute), 71
network_interfaces (azure.mgmt.network.networkresourceprovider.NetworkSecurityGroupattribute), 71
network_profile (azure.mgmt.compute.computemanagement.VirtualMachineattribute), 44
network_security_group (azure.mgmt.network.networkresourceprovider.NetworkInterfaceattribute), 67
network_security_group (azure.mgmt.network.networkresourceprovider.NetworkSecurityGroupGetResponseattribute), 71
network_security_group (azure.mgmt.network.networkresourceprovider.NetworkSecurityGroupPutResponseattribute), 73
network_security_group (azure.mgmt.network.networkresourceprovider.Subnetattribute), 81
network_security_groups(azure.mgmt.network.networkresourceprovider.NetworkResourceProviderClientattribute), 71
network_security_groups(azure.mgmt.network.networkresourceprovider.NetworkSecurityGroupListResponseattribute), 72
NetworkInterface (class inazure.mgmt.network.networkresourceprovider),67
NetworkInterfaceGetResponse (class inazure.mgmt.network.networkresourceprovider),67
NetworkInterfaceIpConfiguration (class inazure.mgmt.network.networkresourceprovider),67
NetworkInterfaceListResponse (class inazure.mgmt.network.networkresourceprovider),68
NetworkInterfaceOperations (class inazure.mgmt.network.networkresourceprovider),
Index 187
Azure SDK for Python Documentation, Release 1.0.3
68NetworkInterfacePutResponse (class in
azure.mgmt.network.networkresourceprovider),70
NetworkInterfaceReference (class inazure.mgmt.compute.computemanagement),39
NetworkProfile (class inazure.mgmt.compute.computemanagement),39
NetworkResourceProviderClient (class inazure.mgmt.network.networkresourceprovider),70
NetworkSecurityGroup (class inazure.mgmt.network.networkresourceprovider),71
NetworkSecurityGroupGetResponse (class inazure.mgmt.network.networkresourceprovider),71
NetworkSecurityGroupListResponse (class inazure.mgmt.network.networkresourceprovider),72
NetworkSecurityGroupOperations (class inazure.mgmt.network.networkresourceprovider),72
NetworkSecurityGroupPutResponse (class inazure.mgmt.network.networkresourceprovider),73
next_link (azure.mgmt.compute.computemanagement.VirtualMachineListResponseattribute), 52
next_link (azure.mgmt.network.networkresourceprovider.LoadBalancerListResponseattribute), 62
next_link (azure.mgmt.network.networkresourceprovider.LocalNetworkGatewayListResponseattribute), 65
next_link (azure.mgmt.network.networkresourceprovider.NetworkInterfaceListResponseattribute), 68
next_link (azure.mgmt.network.networkresourceprovider.NetworkSecurityGroupListResponseattribute), 72
next_link (azure.mgmt.network.networkresourceprovider.PublicIpAddressListResponseattribute), 75
next_link (azure.mgmt.network.networkresourceprovider.SecurityRuleListResponseattribute), 79
next_link (azure.mgmt.network.networkresourceprovider.SubnetListResponseattribute), 81
next_link (azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayConnectionListResponseattribute), 86
next_link (azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayListResponseattribute), 90
next_link (azure.mgmt.network.networkresourceprovider.VirtualNetworkListResponseattribute), 93
next_link (azure.mgmt.resource.resourcemanagement.DeploymentListResultattribute), 96
next_link (azure.mgmt.resource.resourcemanagement.DeploymentOperationsListResultattribute), 99
next_link (azure.mgmt.resource.resourcemanagement.ProviderListResultattribute), 102
next_link (azure.mgmt.resource.resourcemanagement.ResourceGroupListResultattribute), 105
next_link (azure.mgmt.resource.resourcemanagement.ResourceListResultattribute), 107
next_link (azure.mgmt.resource.resourcemanagement.TagsListResultattribute), 113
next_link (azure.mgmt.storage.storagemanagement.StorageAccountListResponseattribute), 117
none (azure.mgmt.compute.computemanagement.CachingTypesattribute), 35
not_registered (azure.mgmt.resource.resourcemanagement.ProviderRegistrationStateattribute), 103
not_specified (azure.mgmt.resource.resourcemanagement.ProvisioningStateattribute), 104
NotificationHubDescription (class inazure.servicemanagement.models), 133
number_of_cores (azure.mgmt.compute.computemanagement.VirtualMachineSizeattribute), 56
number_of_probes (azure.mgmt.network.networkresourceprovider.Probeattribute), 74
Ooffer (azure.mgmt.compute.computemanagement.ImageReference
attribute), 38offer (azure.mgmt.compute.computemanagement.VirtualMachineImageListSkusParameters
attribute), 50oobe_system (azure.mgmt.compute.computemanagement.PassNames
attribute), 40operating_system (azure.mgmt.compute.computemanagement.OSDiskImage
attribute), 39operating_system (azure.mgmt.compute.computemanagement.VirtualMachineExtensionImage
attribute), 46operating_system_type (azure.mgmt.compute.computemanagement.OSDisk
attribute), 39OperatingSystem (class in
azure.servicemanagement.models), 133OperatingSystemFamilies (class in
azure.servicemanagement.models), 133OperatingSystemFamily (class in
azure.servicemanagement.models), 133OperatingSystems (class in
azure.servicemanagement.models), 133OperatingSystemTypes (class in
azure.mgmt.compute.computemanagement),40
operation (azure.mgmt.resource.resourcemanagement.DeploymentOperationsGetResultattribute), 99
operation (azure.mgmt.resource.resourcemanagement.ResourceProviderOperationDisplayPropertiesattribute), 111
Operation (class in azure.servicemanagement.models),133
188 Index
Azure SDK for Python Documentation, Release 1.0.3
operation_id (azure.mgmt.resource.resourcemanagement.DeploymentOperationattribute), 96
operation_status_link (azure.mgmt.resource.resourcemanagement.LongRunningOperationResponseattribute), 100
operation_status_link (azure.mgmt.storage.storagemanagement.StorageAccountCreateResponseattribute), 116
OperationCaller (class inazure.servicemanagement.models), 133
OperationError (class inazure.servicemanagement.models), 133
operations (azure.mgmt.resource.resourcemanagement.DeploymentOperationsListResultattribute), 99
OperationStatus (class in azure.mgmt.common), 32OperationStatus (class in
azure.mgmt.network.networkresourceprovider),73
OperationStatus (class inazure.servicemanagement.models), 133
OperationStatusResponse (class in azure.mgmt.common),32
OperationStatusResponse.ErrorDetails (class inazure.mgmt.common), 32
os_disk (azure.mgmt.compute.computemanagement.StorageProfileattribute), 42
os_disk_image (azure.mgmt.compute.computemanagement.VirtualMachineImageattribute), 49
os_disk_size_in_mb (azure.mgmt.compute.computemanagement.VirtualMachineSizeattribute), 56
os_profile (azure.mgmt.compute.computemanagement.VirtualMachineattribute), 44
OSDisk (class in azure.mgmt.compute.computemanagement),39
OSDiskConfiguration (class inazure.servicemanagement.models), 133
OSDiskImage (class inazure.mgmt.compute.computemanagement),39
OSImage (class in azure.servicemanagement.models),133
OSProfile (class in azure.mgmt.compute.computemanagement),40
OSVirtualHardDisk (class inazure.servicemanagement.models), 133
outbound (azure.mgmt.network.networkresourceprovider.SecurityRuleDirectionattribute), 79
output (azure.mgmt.compute.computemanagement.ComputeLongRunningOperationResponseattribute), 36
outputs (azure.mgmt.resource.resourcemanagement.DeploymentPropertiesExtendedattribute), 100
overwrite (azure.mgmt.compute.computemanagement.VirtualMachineCaptureParametersattribute), 44
Pparameters (azure.mgmt.resource.resourcemanagement.DeploymentProperties
attribute), 99parameters_link (azure.mgmt.resource.resourcemanagement.DeploymentProperties
attribute), 99ParametersLink (class in
azure.mgmt.resource.resourcemanagement),101
parse_account_type() (azure.mgmt.storage.storagemanagement.StorageManagementClientmethod), 121
parse_key_name() (azure.mgmt.storage.storagemanagement.StorageManagementClientmethod), 121
parse_response_for_async_op() (in moduleazure.servicemanagement.servicemanagementclient),143
pass_name (azure.mgmt.compute.computemanagement.AdditionalUnattendContentattribute), 33
Passes (class in azure.servicemanagement.models), 134PassNames (class in azure.mgmt.compute.computemanagement),
40patch() (azure.mgmt.resource.resourcemanagement.ResourceGroupOperations
method), 107path (azure.mgmt.compute.computemanagement.SshPublicKey
attribute), 42peek_lock_queue_message()
(azure.servicebus.servicebusservice.ServiceBusServicemethod), 126
peek_lock_subscription_message()(azure.servicebus.servicebusservice.ServiceBusServicemethod), 126
PersistentVMDowntimeInfo (class inazure.servicemanagement.models), 134
PersistentVMRole (class inazure.servicemanagement.models), 134
plan (azure.mgmt.compute.computemanagement.VirtualMachineattribute), 44
plan (azure.mgmt.resource.resourcemanagement.GenericResourceattribute), 100
plan (azure.mgmt.resource.resourcemanagement.GenericResourceExtendedattribute), 100
Plan (class in azure.mgmt.compute.computemanagement),40
Plan (class in azure.mgmt.resource.resourcemanagement),101
platform_fault_domain (azure.mgmt.compute.computemanagement.VirtualMachineInstanceViewattribute), 51
platform_fault_domain_count(azure.mgmt.compute.computemanagement.AvailabilitySetattribute), 34
platform_update_domain(azure.mgmt.compute.computemanagement.VirtualMachineInstanceViewattribute), 52
platform_update_domain_count(azure.mgmt.compute.computemanagement.AvailabilitySetattribute), 34
port (azure.mgmt.network.networkresourceprovider.Probe
Index 189
Azure SDK for Python Documentation, Release 1.0.3
attribute), 74power_off() (azure.mgmt.compute.computemanagement.VirtualMachineOperations
method), 55preempted (azure.mgmt.compute.computemanagement.ComputeOperationStatus
attribute), 37premium_lrs (azure.mgmt.storage.storagemanagement.AccountType
attribute), 114primary (azure.mgmt.compute.computemanagement.NetworkInterfaceReference
attribute), 39primary (azure.mgmt.network.networkresourceprovider.NetworkInterface
attribute), 67primary_endpoints (azure.mgmt.storage.storagemanagement.StorageAccount
attribute), 115primary_location (azure.mgmt.storage.storagemanagement.StorageAccount
attribute), 115priority (azure.mgmt.network.networkresourceprovider.SecurityRule
attribute), 78private_ip_address (azure.mgmt.network.networkresourceprovider.FrontendIpConfiguration
attribute), 61private_ip_address (azure.mgmt.network.networkresourceprovider.NetworkInterfaceIpConfiguration
attribute), 68private_ip_address (azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayIpConfiguration
attribute), 90private_ip_allocation_method
(azure.mgmt.network.networkresourceprovider.FrontendIpConfigurationattribute), 61
private_ip_allocation_method(azure.mgmt.network.networkresourceprovider.NetworkInterfaceIpConfigurationattribute), 68
private_ip_allocation_method(azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayIpConfigurationattribute), 90
probe (azure.mgmt.network.networkresourceprovider.LoadBalancingRuleattribute), 64
Probe (class in azure.mgmt.network.networkresourceprovider),74
ProbeProtocol (class inazure.mgmt.network.networkresourceprovider),74
probes (azure.mgmt.network.networkresourceprovider.LoadBalancerattribute), 62
product (azure.mgmt.compute.computemanagement.Planattribute), 40
product (azure.mgmt.compute.computemanagement.PurchasePlanattribute), 41
product (azure.mgmt.resource.resourcemanagement.Planattribute), 101
promotion_code (azure.mgmt.compute.computemanagement.Planattribute), 40
promotion_code (azure.mgmt.resource.resourcemanagement.Planattribute), 101
properties (azure.mgmt.resource.resourcemanagement.Deploymentattribute), 95
properties (azure.mgmt.resource.resourcemanagement.DeploymentExtended
attribute), 95properties (azure.mgmt.resource.resourcemanagement.DeploymentOperation
attribute), 96properties (azure.mgmt.resource.resourcemanagement.DeploymentValidateResponse
attribute), 100properties (azure.mgmt.resource.resourcemanagement.GenericResource
attribute), 100properties (azure.mgmt.resource.resourcemanagement.GenericResourceExtended
attribute), 100properties (azure.mgmt.resource.resourcemanagement.ProviderResourceType
attribute), 103properties (azure.mgmt.resource.resourcemanagement.ResourceGroup
attribute), 104protected_settings (azure.mgmt.compute.computemanagement.VirtualMachineExtension
attribute), 45protocol (azure.mgmt.compute.computemanagement.WinRMListener
attribute), 58protocol (azure.mgmt.network.networkresourceprovider.InboundNatRule
attribute), 61protocol (azure.mgmt.network.networkresourceprovider.LoadBalancingRule
attribute), 65protocol (azure.mgmt.network.networkresourceprovider.Probe
attribute), 74protocol (azure.mgmt.network.networkresourceprovider.SecurityRule
attribute), 78ProtocolTypes (class in
azure.mgmt.compute.computemanagement),40
provider (azure.mgmt.resource.resourcemanagement.ProviderGetResultattribute), 101
provider (azure.mgmt.resource.resourcemanagement.ProviderRegistionResultattribute), 103
provider (azure.mgmt.resource.resourcemanagement.ProviderUnregistionResultattribute), 103
provider (azure.mgmt.resource.resourcemanagement.ResourceProviderOperationDisplayPropertiesattribute), 111
Provider (class in azure.mgmt.resource.resourcemanagement),101
ProviderGetResult (class inazure.mgmt.resource.resourcemanagement),101
ProviderListParameters (class inazure.mgmt.resource.resourcemanagement),101
ProviderListResult (class inazure.mgmt.resource.resourcemanagement),101
ProviderOperations (class inazure.mgmt.resource.resourcemanagement),102
ProviderRegistionResult (class inazure.mgmt.resource.resourcemanagement),103
ProviderRegistrationState (class in
190 Index
Azure SDK for Python Documentation, Release 1.0.3
azure.mgmt.resource.resourcemanagement),103
ProviderResourceType (class inazure.mgmt.resource.resourcemanagement),103
providers (azure.mgmt.resource.resourcemanagement.DeploymentPropertiesExtendedattribute), 100
providers (azure.mgmt.resource.resourcemanagement.ProviderListResultattribute), 102
providers (azure.mgmt.resource.resourcemanagement.ResourceManagementClientattribute), 108
ProviderUnregistionResult (class inazure.mgmt.resource.resourcemanagement),103
provision_vm_agent (azure.mgmt.compute.computemanagement.WindowsConfigurationattribute), 58
provisioning_state (azure.mgmt.compute.computemanagement.VirtualMachineattribute), 44
provisioning_state (azure.mgmt.compute.computemanagement.VirtualMachineExtensionattribute), 45
provisioning_state (azure.mgmt.network.networkresourceprovider.BackendAddressPoolattribute), 59
provisioning_state (azure.mgmt.network.networkresourceprovider.FrontendIpConfigurationattribute), 61
provisioning_state (azure.mgmt.network.networkresourceprovider.InboundNatRuleattribute), 61
provisioning_state (azure.mgmt.network.networkresourceprovider.LoadBalancerattribute), 62
provisioning_state (azure.mgmt.network.networkresourceprovider.LoadBalancingRuleattribute), 65
provisioning_state (azure.mgmt.network.networkresourceprovider.LocalNetworkGatewayattribute), 65
provisioning_state (azure.mgmt.network.networkresourceprovider.NetworkInterfaceattribute), 67
provisioning_state (azure.mgmt.network.networkresourceprovider.NetworkInterfaceIpConfigurationattribute), 68
provisioning_state (azure.mgmt.network.networkresourceprovider.NetworkSecurityGroupattribute), 71
provisioning_state (azure.mgmt.network.networkresourceprovider.Probeattribute), 74
provisioning_state (azure.mgmt.network.networkresourceprovider.PublicIpAddressattribute), 75
provisioning_state (azure.mgmt.network.networkresourceprovider.ResourcePropertiesattribute), 77
provisioning_state (azure.mgmt.network.networkresourceprovider.SecurityRuleattribute), 78
provisioning_state (azure.mgmt.network.networkresourceprovider.Subnetattribute), 81
provisioning_state (azure.mgmt.network.networkresourceprovider.VirtualNetworkattribute), 85
provisioning_state (azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayattribute), 85
provisioning_state (azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayConnectionattribute), 85
provisioning_state (azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayIpConfigurationattribute), 90
provisioning_state (azure.mgmt.resource.resourcemanagement.DeploymentListParametersattribute), 96
provisioning_state (azure.mgmt.resource.resourcemanagement.DeploymentOperationPropertiesattribute), 97
provisioning_state (azure.mgmt.resource.resourcemanagement.DeploymentPropertiesExtendedattribute), 100
provisioning_state (azure.mgmt.resource.resourcemanagement.GenericResourceattribute), 100
provisioning_state (azure.mgmt.resource.resourcemanagement.GenericResourceExtendedattribute), 100
provisioning_state (azure.mgmt.resource.resourcemanagement.ResourceGroupattribute), 104
provisioning_state (azure.mgmt.storage.storagemanagement.StorageAccountattribute), 115
ProvisioningState (class inazure.mgmt.network.networkresourceprovider),74
ProvisioningState (class inazure.mgmt.resource.resourcemanagement),103
ProvisioningState (class inazure.mgmt.storage.storagemanagement),115
ProvisioningStateTypes (class inazure.mgmt.compute.computemanagement),41
public_ip_address (azure.mgmt.network.networkresourceprovider.FrontendIpConfigurationattribute), 61
public_ip_address (azure.mgmt.network.networkresourceprovider.NetworkInterfaceIpConfigurationattribute), 68
public_ip_address (azure.mgmt.network.networkresourceprovider.PublicIpAddressGetResponseattribute), 75
public_ip_address (azure.mgmt.network.networkresourceprovider.PublicIpAddressPutResponseattribute), 77
public_ip_address (azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayIpConfigurationattribute), 90
public_ip_addresses (azure.mgmt.network.networkresourceprovider.NetworkResourceProviderClientattribute), 71
public_ip_addresses (azure.mgmt.network.networkresourceprovider.PublicIpAddressListResponseattribute), 75
public_ip_allocation_method(azure.mgmt.network.networkresourceprovider.PublicIpAddressattribute), 75
public_keys (azure.mgmt.compute.computemanagement.SshConfigurationattribute), 41
PublicIP (class in azure.servicemanagement.models), 134PublicIpAddress (class in
azure.mgmt.network.networkresourceprovider),74
PublicIpAddressDnsSettings (class inazure.mgmt.network.networkresourceprovider),75
Index 191
Azure SDK for Python Documentation, Release 1.0.3
PublicIpAddressGetResponse (class inazure.mgmt.network.networkresourceprovider),75
PublicIpAddressListResponse (class inazure.mgmt.network.networkresourceprovider),75
PublicIpAddressOperations (class inazure.mgmt.network.networkresourceprovider),75
PublicIpAddressPutResponse (class inazure.mgmt.network.networkresourceprovider),77
PublicIPs (class in azure.servicemanagement.models),134
PublicKey (class in azure.servicemanagement.models),134
PublicKeys (class in azure.servicemanagement.models),134
PublishData (class in azure.servicemanagement.models),134
publisher (azure.mgmt.compute.computemanagement.ImageReferenceattribute), 38
publisher (azure.mgmt.compute.computemanagement.Planattribute), 40
publisher (azure.mgmt.compute.computemanagement.PurchasePlanattribute), 41
publisher (azure.mgmt.compute.computemanagement.VirtualMachineExtensionattribute), 45
publisher (azure.mgmt.resource.resourcemanagement.Planattribute), 101
publisher (azure.mgmt.resource.resourcemanagement.ResourceProviderOperationDisplayPropertiesattribute), 111
publisher_name (azure.mgmt.compute.computemanagement.VirtualMachineExtensionImageListTypesParametersattribute), 46
publisher_name (azure.mgmt.compute.computemanagement.VirtualMachineImageListOffersParametersattribute), 50
PublishProfile (class inazure.servicemanagement.models), 134
purchase_plan (azure.mgmt.compute.computemanagement.VirtualMachineImageattribute), 49
PurchasePlan (class inazure.mgmt.compute.computemanagement),41
Qqueue (azure.mgmt.storage.storagemanagement.Endpoints
attribute), 115Queue (class in azure.servicebus.models), 122QueueDescription (class in
azure.servicemanagement.models), 134Quota (class in azure.servicemanagement.models), 134
Rread_delete_queue_message()
(azure.servicebus.servicebusservice.ServiceBusServicemethod), 126
read_delete_subscription_message()(azure.servicebus.servicebusservice.ServiceBusServicemethod), 127
read_only (azure.mgmt.compute.computemanagement.CachingTypesattribute), 35
read_write (azure.mgmt.compute.computemanagement.CachingTypesattribute), 35
reason (azure.mgmt.storage.storagemanagement.CheckNameAvailabilityResponseattribute), 114
Reason (class in azure.mgmt.storage.storagemanagement),115
reboot_role_instance() (azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 155
rebuild_role_instance() (azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 155
receive_queue_message()(azure.servicebus.servicebusservice.ServiceBusServicemethod), 127
receive_subscription_message()(azure.servicebus.servicebusservice.ServiceBusServicemethod), 127
reference_uri (azure.mgmt.compute.computemanagement.ApiEntityReferenceattribute), 33
regenerate_key() (azure.mgmt.storage.storagemanagement.StorageAccountOperationsmethod), 119
regenerate_storage_account_keys()(azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 155
register() (azure.mgmt.resource.resourcemanagement.ProviderOperationsmethod), 102
registered (azure.mgmt.resource.resourcemanagement.ProviderRegistrationStateattribute), 103
registering (azure.mgmt.resource.resourcemanagement.ProviderRegistrationStateattribute), 103
registering (azure.mgmt.resource.resourcemanagement.ProvisioningStateattribute), 104
registration_state (azure.mgmt.resource.resourcemanagement.Providerattribute), 101
reimage_role_instance() (azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 156
RelayDescription (class inazure.servicemanagement.models), 134
remote_desktop_thumbprint(azure.mgmt.compute.computemanagement.VirtualMachineInstanceViewattribute), 52
replicate_vm_image() (azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 156
request_path (azure.mgmt.network.networkresourceprovider.Probeattribute), 74
RequestFilter (class in azure.mgmt.common.filters), 31ReservedIP (class in azure.servicemanagement.models),
134
192 Index
Azure SDK for Python Documentation, Release 1.0.3
ReservedIPs (class in azure.servicemanagement.models),134
reset() (azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayOperationsmethod), 92
reset_shared_key() (azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayConnectionOperationsmethod), 88
resolving_dns (azure.mgmt.storage.storagemanagement.ProvisioningStateattribute), 115
resource (azure.mgmt.resource.resourcemanagement.ResourceCreateOrUpdateResultattribute), 104
resource (azure.mgmt.resource.resourcemanagement.ResourceGetResultattribute), 104
resource (azure.mgmt.resource.resourcemanagement.ResourceProviderOperationDisplayPropertiesattribute), 111
Resource (class in azure.servicemanagement.models),134
resource_disk_size_in_mb(azure.mgmt.compute.computemanagement.VirtualMachineSizeattribute), 56
resource_group (azure.mgmt.resource.resourcemanagement.ResourceGroupCreateOrUpdateResultattribute), 104
resource_group (azure.mgmt.resource.resourcemanagement.ResourceGroupGetResultattribute), 105
resource_group (azure.mgmt.resource.resourcemanagement.ResourceGroupPatchResultattribute), 107
resource_group_name (azure.mgmt.resource.resourcemanagement.ResourceListParametersattribute), 107
resource_groups (azure.mgmt.resource.resourcemanagement.ResourceGroupListResultattribute), 105
resource_groups (azure.mgmt.resource.resourcemanagement.ResourceManagementClientattribute), 108
resource_name (azure.mgmt.resource.resourcemanagement.BasicDependencyattribute), 95
resource_name (azure.mgmt.resource.resourcemanagement.TargetResourceattribute), 113
resource_provider_operation_details(azure.mgmt.resource.resourcemanagement.ResourceManagementClientattribute), 108
resource_provider_operation_details(azure.mgmt.resource.resourcemanagement.ResourceProviderOperationDetailListResultattribute), 110
resource_provider_operation_display_properties(azure.mgmt.resource.resourcemanagement.ResourceProviderOperationDefinitionattribute), 110
resource_type (azure.mgmt.resource.resourcemanagement.BasicDependencyattribute), 95
resource_type (azure.mgmt.resource.resourcemanagement.ResourceListParametersattribute), 107
resource_type (azure.mgmt.resource.resourcemanagement.TargetResourceattribute), 113
resource_types (azure.mgmt.resource.resourcemanagement.Providerattribute), 101
ResourceBase (class in azure.mgmt.common.arm), 31ResourceBaseExtended (class in
azure.mgmt.common.arm), 31ResourceCreateOrUpdateResult (class in
azure.mgmt.resource.resourcemanagement),104
ResourceExistsResult (class inazure.mgmt.resource.resourcemanagement),104
ResourceExtension (class inazure.servicemanagement.models), 134
ResourceExtensionParameterValue (class inazure.servicemanagement.models), 134
ResourceExtensionParameterValues (class inazure.servicemanagement.models), 134
ResourceExtensionReference (class inazure.servicemanagement.models), 134
ResourceExtensionReferences (class inazure.servicemanagement.models), 134
ResourceExtensions (class inazure.servicemanagement.models), 134
ResourceGetResult (class inazure.mgmt.resource.resourcemanagement),104
ResourceGroup (class inazure.mgmt.resource.resourcemanagement),104
ResourceGroupCreateOrUpdateResult (class inazure.mgmt.resource.resourcemanagement),104
ResourceGroupExistsResult (class inazure.mgmt.resource.resourcemanagement),104
ResourceGroupExtended (class inazure.mgmt.resource.resourcemanagement),105
ResourceGroupGetResult (class inazure.mgmt.resource.resourcemanagement),105
ResourceGroupListParameters (class inazure.mgmt.resource.resourcemanagement),105
ResourceGroupListResult (class inazure.mgmt.resource.resourcemanagement),105
ResourceGroupOperations (class inazure.mgmt.resource.resourcemanagement),105
ResourceGroupPatchResult (class inazure.mgmt.resource.resourcemanagement),107
ResourceId (class in azure.mgmt.network.networkresourceprovider),77
ResourceIdentity (class inazure.mgmt.resource.resourcemanagement),107
Index 193
Azure SDK for Python Documentation, Release 1.0.3
ResourceInstanceView (class inazure.mgmt.compute.computemanagement),41
ResourceListParameters (class inazure.mgmt.resource.resourcemanagement),107
ResourceListResult (class inazure.mgmt.resource.resourcemanagement),107
ResourceManagementClient (class inazure.mgmt.resource.resourcemanagement),107
ResourceManagementError (class inazure.mgmt.resource.resourcemanagement),108
ResourceManagementErrorWithDetails (class inazure.mgmt.resource.resourcemanagement),108
ResourceOperations (class inazure.mgmt.resource.resourcemanagement),108
ResourceProperties (class inazure.mgmt.network.networkresourceprovider),77
ResourceProviderErrorResponse (class inazure.mgmt.network.networkresourceprovider),77
ResourceProviderOperationDefinition (class inazure.mgmt.resource.resourcemanagement),110
ResourceProviderOperationDetailListResult (class inazure.mgmt.resource.resourcemanagement),110
ResourceProviderOperationDetailsOperations (class inazure.mgmt.resource.resourcemanagement),110
ResourceProviderOperationDisplayProperties (class inazure.mgmt.resource.resourcemanagement),110
resources (azure.mgmt.compute.computemanagement.VirtualMachineImageResourceListattribute), 51
resources (azure.mgmt.resource.resourcemanagement.ResourceListResultattribute), 107
resources (azure.mgmt.resource.resourcemanagement.ResourceManagementClientattribute), 108
resources (azure.mgmt.resource.resourcemanagement.ResourcesMoveInfoattribute), 111
Resources (class in azure.servicemanagement.models),135
ResourcesMoveInfo (class inazure.mgmt.resource.resourcemanagement),111
restart() (azure.mgmt.compute.computemanagement.VirtualMachineOperationsmethod), 56
restart_role() (azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 156
restart_site() (azure.servicemanagement.websitemanagementservice.WebsiteManagementServicemethod), 168
RetriableOperationResponse (class inazure.mgmt.network.networkresourceprovider),77
retry_after (azure.mgmt.network.networkresourceprovider.RetriableOperationResponseattribute), 78
retry_after (azure.mgmt.resource.resourcemanagement.LongRunningOperationResponseattribute), 100
retry_after (azure.mgmt.storage.storagemanagement.StorageAccountCreateResponseattribute), 116
reverse_fqdn (azure.mgmt.network.networkresourceprovider.PublicIpAddressDnsSettingsattribute), 75
Role (class in azure.servicemanagement.models), 135RoleInstance (class in azure.servicemanagement.models),
135RoleInstanceList (class in
azure.servicemanagement.models), 135RoleList (class in azure.servicemanagement.models), 135RoleSize (class in azure.servicemanagement.models),
135RoleSizes (class in azure.servicemanagement.models),
135rollback_update_or_upgrade()
(azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 156
routing_weight (azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayConnectionattribute), 85
Rule (class in azure.servicebus.models), 122running (azure.mgmt.resource.resourcemanagement.ProvisioningState
attribute), 104
SSchedulerManagementService (class in
azure.servicemanagement.schedulermanagementservice),137
secondary_endpoints (azure.mgmt.storage.storagemanagement.StorageAccountattribute), 115
secondary_location (azure.mgmt.storage.storagemanagement.StorageAccountattribute), 115
secrets (azure.mgmt.compute.computemanagement.OSProfileattribute), 40
security_rule (azure.mgmt.network.networkresourceprovider.SecurityRuleGetResponseattribute), 79
security_rule (azure.mgmt.network.networkresourceprovider.SecurityRulePutResponseattribute), 81
security_rules (azure.mgmt.network.networkresourceprovider.NetworkResourceProviderClientattribute), 71
security_rules (azure.mgmt.network.networkresourceprovider.NetworkSecurityGroupattribute), 71
security_rules (azure.mgmt.network.networkresourceprovider.SecurityRuleListResponseattribute), 79
194 Index
Azure SDK for Python Documentation, Release 1.0.3
SecurityRule (class inazure.mgmt.network.networkresourceprovider),78
SecurityRuleAccess (class inazure.mgmt.network.networkresourceprovider),78
SecurityRuleDirection (class inazure.mgmt.network.networkresourceprovider),78
SecurityRuleGetResponse (class inazure.mgmt.network.networkresourceprovider),79
SecurityRuleListResponse (class inazure.mgmt.network.networkresourceprovider),79
SecurityRuleOperations (class inazure.mgmt.network.networkresourceprovider),79
SecurityRuleProtocol (class inazure.mgmt.network.networkresourceprovider),81
SecurityRulePutResponse (class inazure.mgmt.network.networkresourceprovider),81
send() (azure.mgmt.common.filters.LogFilter method),31
send() (azure.mgmt.common.filters.RequestFiltermethod), 31
send() (azure.mgmt.common.filters.SigningFiltermethod), 31
send() (azure.mgmt.common.filters.UserAgentFiltermethod), 31
send_event() (azure.servicebus.servicebusservice.ServiceBusServicemethod), 127
send_queue_message() (azure.servicebus.servicebusservice.ServiceBusServicemethod), 127
send_request() (azure.mgmt.common.Service method),32
send_topic_message() (azure.servicebus.servicebusservice.ServiceBusServicemethod), 127
Server (class in azure.servicemanagement.models), 135ServerQuota (class in azure.servicemanagement.models),
135Servers (class in azure.servicemanagement.models), 135Service (class in azure.mgmt.common), 32ServiceBusManagementService (class in
azure.servicemanagement.servicebusmanagementservice),140
ServiceBusNamespace (class inazure.servicemanagement.models), 135
ServiceBusRegion (class inazure.servicemanagement.models), 135
ServiceBusSASAuthentication (class inazure.servicebus.servicebusservice), 123
ServiceBusService (class inazure.servicebus.servicebusservice), 123
ServiceBusWrapTokenAuthentication (class inazure.servicebus.servicebusservice), 128
ServiceManagementService (class inazure.servicemanagement.servicemanagementservice),143
ServiceObjective (class inazure.servicemanagement.models), 135
set_proxy() (azure.servicebus.servicebusservice.ServiceBusServicemethod), 127
set_server_admin_password()(azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementServicemethod), 165
set_shared_key() (azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayConnectionOperationsmethod), 89
setting_name (azure.mgmt.compute.computemanagement.AdditionalUnattendContentattribute), 33
SettingNames (class inazure.mgmt.compute.computemanagement),41
settings (azure.mgmt.compute.computemanagement.VirtualMachineExtensionattribute), 45
share_vm_image() (azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 156
shared_key (azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayConnectionattribute), 85
shutdown_role() (azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 157
shutdown_roles() (azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 157
sign_request() (azure.mgmt.common.SubscriptionCloudCredentialsmethod), 32
sign_request() (azure.servicebus.servicebusservice.ServiceBusSASAuthenticationmethod), 123
sign_request() (azure.servicebus.servicebusservice.ServiceBusWrapTokenAuthenticationmethod), 128
SigningFilter (class in azure.mgmt.common.filters), 31Site (class in azure.servicemanagement.models), 135Sites (class in azure.servicemanagement.models), 135sku (azure.mgmt.compute.computemanagement.ImageReference
attribute), 38skus (azure.mgmt.compute.computemanagement.VirtualMachineImageListDetailsParameters
attribute), 49source_address_prefix (azure.mgmt.network.networkresourceprovider.SecurityRule
attribute), 78source_image (azure.mgmt.compute.computemanagement.Disk
attribute), 37source_image (azure.mgmt.compute.computemanagement.StorageProfile
attribute), 42source_ip (azure.mgmt.network.networkresourceprovider.LoadDistribution
attribute), 65source_ip_protocol (azure.mgmt.network.networkresourceprovider.LoadDistribution
attribute), 65
Index 195
Azure SDK for Python Documentation, Release 1.0.3
source_port_range (azure.mgmt.network.networkresourceprovider.SecurityRuleattribute), 78
source_vault (azure.mgmt.compute.computemanagement.VaultSecretGroupattribute), 43
SourceImageReference (class inazure.mgmt.compute.computemanagement),41
SourceVaultReference (class inazure.mgmt.compute.computemanagement),41
SqlDatabaseManagementService (class inazure.servicemanagement.sqldatabasemanagementservice),163
SSH (class in azure.servicemanagement.models), 135ssh_configuration (azure.mgmt.compute.computemanagement.LinuxConfiguration
attribute), 39SshConfiguration (class in
azure.mgmt.compute.computemanagement),41
SshPublicKey (class inazure.mgmt.compute.computemanagement),41
standard_a0 (azure.mgmt.compute.computemanagement.VirtualMachineSizeTypesattribute), 57
standard_a1 (azure.mgmt.compute.computemanagement.VirtualMachineSizeTypesattribute), 57
standard_a2 (azure.mgmt.compute.computemanagement.VirtualMachineSizeTypesattribute), 57
standard_a3 (azure.mgmt.compute.computemanagement.VirtualMachineSizeTypesattribute), 57
standard_a4 (azure.mgmt.compute.computemanagement.VirtualMachineSizeTypesattribute), 57
standard_a5 (azure.mgmt.compute.computemanagement.VirtualMachineSizeTypesattribute), 57
standard_a6 (azure.mgmt.compute.computemanagement.VirtualMachineSizeTypesattribute), 57
standard_a7 (azure.mgmt.compute.computemanagement.VirtualMachineSizeTypesattribute), 57
standard_a8 (azure.mgmt.compute.computemanagement.VirtualMachineSizeTypesattribute), 57
standard_a9 (azure.mgmt.compute.computemanagement.VirtualMachineSizeTypesattribute), 57
standard_g1 (azure.mgmt.compute.computemanagement.VirtualMachineSizeTypesattribute), 57
standard_g2 (azure.mgmt.compute.computemanagement.VirtualMachineSizeTypesattribute), 57
standard_g3 (azure.mgmt.compute.computemanagement.VirtualMachineSizeTypesattribute), 57
standard_g4 (azure.mgmt.compute.computemanagement.VirtualMachineSizeTypesattribute), 57
standard_g5 (azure.mgmt.compute.computemanagement.VirtualMachineSizeTypesattribute), 58
standard_grs (azure.mgmt.storage.storagemanagement.AccountTypeattribute), 114
standard_lrs (azure.mgmt.storage.storagemanagement.AccountTypeattribute), 114
standard_ragrs (azure.mgmt.storage.storagemanagement.AccountTypeattribute), 114
standard_zrs (azure.mgmt.storage.storagemanagement.AccountTypeattribute), 114
start() (azure.mgmt.compute.computemanagement.VirtualMachineOperationsmethod), 56
start_role() (azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 157
start_roles() (azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 157
start_time (azure.mgmt.compute.computemanagement.ComputeLongRunningOperationResponseattribute), 36
static (azure.mgmt.network.networkresourceprovider.IpAllocationMethodattribute), 62
static_routing (azure.mgmt.network.networkresourceprovider.VpnGatewayTypeattribute), 95
status (azure.mgmt.compute.computemanagement.ComputeLongRunningOperationResponseattribute), 36
status (azure.mgmt.compute.computemanagement.VirtualMachineExtensionHandlerInstanceViewattribute), 45
status (azure.mgmt.network.networkresourceprovider.AzureAsyncOperationResponseattribute), 59
status (azure.mgmt.resource.resourcemanagement.LongRunningOperationResponseattribute), 101
status (azure.mgmt.storage.storagemanagement.StorageAccountCreateResponseattribute), 116
status_code (azure.mgmt.resource.resourcemanagement.DeploymentOperationPropertiesattribute), 97
status_message (azure.mgmt.resource.resourcemanagement.DeploymentOperationPropertiesattribute), 97
status_of_primary (azure.mgmt.storage.storagemanagement.StorageAccountattribute), 116
status_of_secondary (azure.mgmt.storage.storagemanagement.StorageAccountattribute), 116
statuses (azure.mgmt.compute.computemanagement.AvailabilitySetattribute), 34
statuses (azure.mgmt.compute.computemanagement.ResourceInstanceViewattribute), 41
statuses (azure.mgmt.compute.computemanagement.VirtualMachineInstanceViewattribute), 52
StatusLevelTypes (class inazure.mgmt.compute.computemanagement),42
storage_account (azure.mgmt.storage.storagemanagement.StorageAccountCreateResponseattribute), 116
storage_account (azure.mgmt.storage.storagemanagement.StorageAccountGetPropertiesResponseattribute), 116
storage_account (azure.mgmt.storage.storagemanagement.StorageAccountUpdateResponseattribute), 120
storage_account_keys (azure.mgmt.storage.storagemanagement.StorageAccountListKeysResponseattribute), 117
storage_account_keys (azure.mgmt.storage.storagemanagement.StorageAccountRegenerateKeyResponse
196 Index
Azure SDK for Python Documentation, Release 1.0.3
attribute), 119storage_accounts (azure.mgmt.storage.storagemanagement.StorageAccountListResponse
attribute), 117storage_accounts (azure.mgmt.storage.storagemanagement.StorageManagementClient
attribute), 121storage_profile (azure.mgmt.compute.computemanagement.VirtualMachine
attribute), 44StorageAccount (class in
azure.mgmt.storage.storagemanagement),115
StorageAccountCreateParameters (class inazure.mgmt.storage.storagemanagement),116
StorageAccountCreateResponse (class inazure.mgmt.storage.storagemanagement),116
StorageAccountGetPropertiesResponse (class inazure.mgmt.storage.storagemanagement),116
StorageAccountKeys (class inazure.mgmt.storage.storagemanagement),116
StorageAccountListKeysResponse (class inazure.mgmt.storage.storagemanagement),117
StorageAccountListResponse (class inazure.mgmt.storage.storagemanagement),117
StorageAccountOperations (class inazure.mgmt.storage.storagemanagement),117
StorageAccountProperties (class inazure.servicemanagement.models), 135
StorageAccountRegenerateKeyResponse (class inazure.mgmt.storage.storagemanagement), 119
StorageAccountUpdateParameters (class inazure.mgmt.storage.storagemanagement),119
StorageAccountUpdateResponse (class inazure.mgmt.storage.storagemanagement),120
StorageManagementClient (class inazure.mgmt.storage.storagemanagement),120
StorageProfile (class inazure.mgmt.compute.computemanagement),42
StorageService (class inazure.servicemanagement.models), 135
StorageServiceKeys (class inazure.servicemanagement.models), 135
StorageServices (class inazure.servicemanagement.models), 135
StoredCertificateSettings (class in
azure.servicemanagement.models), 135sub_statuses (azure.mgmt.compute.computemanagement.VirtualMachineExtensionInstanceView
attribute), 47subnet (azure.mgmt.network.networkresourceprovider.FrontendIpConfiguration
attribute), 61subnet (azure.mgmt.network.networkresourceprovider.NetworkInterfaceIpConfiguration
attribute), 68subnet (azure.mgmt.network.networkresourceprovider.SubnetGetResponse
attribute), 81subnet (azure.mgmt.network.networkresourceprovider.SubnetPutResponse
attribute), 83subnet (azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayIpConfiguration
attribute), 90Subnet (class in azure.mgmt.network.networkresourceprovider),
81Subnet (class in azure.servicemanagement.models), 136SubnetGetResponse (class in
azure.mgmt.network.networkresourceprovider),81
SubnetListResponse (class inazure.mgmt.network.networkresourceprovider),81
SubnetOperations (class inazure.mgmt.network.networkresourceprovider),81
SubnetPutResponse (class inazure.mgmt.network.networkresourceprovider),83
subnets (azure.mgmt.network.networkresourceprovider.NetworkResourceProviderClientattribute), 71
subnets (azure.mgmt.network.networkresourceprovider.NetworkSecurityGroupattribute), 71
subnets (azure.mgmt.network.networkresourceprovider.SubnetListResponseattribute), 81
subnets (azure.mgmt.network.networkresourceprovider.VirtualNetworkattribute), 85
Subnets (class in azure.servicemanagement.models), 136Subscription (class in azure.servicebus.models), 122Subscription (class in azure.servicemanagement.models),
136subscription_id (azure.mgmt.common.SubscriptionCloudCredentials
attribute), 32SubscriptionCertificate (class in
azure.servicemanagement.models), 136SubscriptionCertificates (class in
azure.servicemanagement.models), 136SubscriptionCloudCredentials (class in
azure.mgmt.common), 32SubscriptionOperation (class in
azure.servicemanagement.models), 136SubscriptionOperationCollection (class in
azure.servicemanagement.models), 136SubscriptionOperations (class in
azure.servicemanagement.models), 136
Index 197
Azure SDK for Python Documentation, Release 1.0.3
SubscriptionOperationStatus (class inazure.servicemanagement.models), 136
Subscriptions (class inazure.servicemanagement.models), 136
Succeeded (azure.mgmt.common.OperationStatus at-tribute), 32
succeeded (azure.mgmt.common.OperationStatus at-tribute), 32
succeeded (azure.mgmt.compute.computemanagement.ComputeOperationStatusattribute), 37
succeeded (azure.mgmt.compute.computemanagement.ProvisioningStateTypesattribute), 41
succeeded (azure.mgmt.network.networkresourceprovider.OperationStatusattribute), 74
succeeded (azure.mgmt.network.networkresourceprovider.ProvisioningStateattribute), 74
succeeded (azure.mgmt.resource.resourcemanagement.ProvisioningStateattribute), 104
succeeded (azure.mgmt.storage.storagemanagement.ProvisioningStateattribute), 115
supports_multiple_extensions(azure.mgmt.compute.computemanagement.VirtualMachineExtensionImageattribute), 46
swap_deployment() (azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 157
Ttable (azure.mgmt.storage.storagemanagement.Endpoints
attribute), 115tag (azure.mgmt.resource.resourcemanagement.TagCreateResult
attribute), 111tag_name (azure.mgmt.resource.resourcemanagement.ResourceGroupListParameters
attribute), 105tag_name (azure.mgmt.resource.resourcemanagement.ResourceListParameters
attribute), 107tag_value (azure.mgmt.resource.resourcemanagement.ResourceGroupListParameters
attribute), 105tag_value (azure.mgmt.resource.resourcemanagement.ResourceListParameters
attribute), 107TagCount (class in azure.mgmt.resource.resourcemanagement),
111TagCreateResult (class in
azure.mgmt.resource.resourcemanagement),111
TagCreateValueResult (class inazure.mgmt.resource.resourcemanagement),111
TagDetails (class in azure.mgmt.resource.resourcemanagement),111
TagOperations (class inazure.mgmt.resource.resourcemanagement),112
tags (azure.mgmt.common.arm.ResourceBase attribute),31
tags (azure.mgmt.resource.resourcemanagement.ResourceGroupattribute), 104
tags (azure.mgmt.resource.resourcemanagement.ResourceManagementClientattribute), 108
tags (azure.mgmt.resource.resourcemanagement.TagsListResultattribute), 113
tags (azure.mgmt.storage.storagemanagement.StorageAccountCreateParametersattribute), 116
tags (azure.mgmt.storage.storagemanagement.StorageAccountUpdateParametersattribute), 120
TagsListResult (class inazure.mgmt.resource.resourcemanagement),113
TagValue (class in azure.mgmt.resource.resourcemanagement),113
target (azure.mgmt.compute.computemanagement.ApiErrorBaseattribute), 33
target (azure.mgmt.network.networkresourceprovider.Errorattribute), 60
target (azure.mgmt.network.networkresourceprovider.ErrorDetailsattribute), 60
target (azure.mgmt.resource.resourcemanagement.ResourceManagementErrorattribute), 108
target_resource (azure.mgmt.resource.resourcemanagement.DeploymentOperationPropertiesattribute), 97
target_resource_group (azure.mgmt.resource.resourcemanagement.ResourcesMoveInfoattribute), 111
TargetResource (class inazure.mgmt.resource.resourcemanagement),113
tcp (azure.mgmt.network.networkresourceprovider.ProbeProtocolattribute), 74
tcp (azure.mgmt.network.networkresourceprovider.SecurityRuleProtocolattribute), 81
tcp (azure.mgmt.network.networkresourceprovider.TransportProtocolattribute), 83
template (azure.mgmt.resource.resourcemanagement.DeploymentPropertiesattribute), 99
template_link (azure.mgmt.resource.resourcemanagement.DeploymentPropertiesattribute), 99
TemplateLink (class inazure.mgmt.resource.resourcemanagement),113
time (azure.mgmt.compute.computemanagement.InstanceViewStatusattribute), 39
time_zone (azure.mgmt.compute.computemanagement.WindowsConfigurationattribute), 58
timeout (azure.servicebus.servicebusservice.ServiceBusServiceattribute), 128
timestamp (azure.mgmt.resource.resourcemanagement.DeploymentOperationPropertiesattribute), 97
timestamp (azure.mgmt.resource.resourcemanagement.DeploymentPropertiesExtendedattribute), 100
top (azure.mgmt.resource.resourcemanagement.DeploymentListParameters
198 Index
Azure SDK for Python Documentation, Release 1.0.3
attribute), 96top (azure.mgmt.resource.resourcemanagement.DeploymentOperationsListParameters
attribute), 99top (azure.mgmt.resource.resourcemanagement.ProviderListParameters
attribute), 101top (azure.mgmt.resource.resourcemanagement.ResourceGroupListParameters
attribute), 105top (azure.mgmt.resource.resourcemanagement.ResourceListParameters
attribute), 107Topic (class in azure.servicebus.models), 122TopicDescription (class in
azure.servicemanagement.models), 136TopLevelResource (class in
azure.mgmt.network.networkresourceprovider),83
tracking_operation_id (azure.mgmt.compute.computemanagement.ComputeLongRunningOperationResponseattribute), 36
TransportProtocol (class inazure.mgmt.network.networkresourceprovider),83
type (azure.mgmt.common.arm.ResourceBaseExtendedattribute), 31
type (azure.mgmt.compute.computemanagement.VirtualMachineExtensionHandlerInstanceViewattribute), 45
type (azure.mgmt.compute.computemanagement.VirtualMachineExtensionImageListVersionsParametersattribute), 46
type (azure.mgmt.resource.resourcemanagement.TagCountattribute), 111
type_handler_version (azure.mgmt.compute.computemanagement.VirtualMachineExtensionattribute), 45
type_handler_version (azure.mgmt.compute.computemanagement.VirtualMachineExtensionHandlerInstanceViewattribute), 45
type_handler_version (azure.mgmt.compute.computemanagement.VirtualMachineExtensionInstanceViewattribute), 47
Uudp (azure.mgmt.network.networkresourceprovider.SecurityRuleProtocol
attribute), 81udp (azure.mgmt.network.networkresourceprovider.TransportProtocol
attribute), 83UnattendComponent (class in
azure.servicemanagement.models), 136UnattendPass (class in
azure.servicemanagement.models), 136unavailable (azure.mgmt.storage.storagemanagement.AccountStatus
attribute), 114unit (azure.mgmt.compute.computemanagement.Usage
attribute), 42unit (azure.mgmt.network.networkresourceprovider.Usage
attribute), 84unlock() (azure.servicebus.models.Message method), 122unlock_queue_message()
(azure.servicebus.servicebusservice.ServiceBusServicemethod), 128
unlock_subscription_message()(azure.servicebus.servicebusservice.ServiceBusServicemethod), 128
unregister() (azure.mgmt.resource.resourcemanagement.ProviderOperationsmethod), 102
unregistering (azure.mgmt.resource.resourcemanagement.ProviderRegistrationStateattribute), 103
unreplicate_vm_image() (azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 158
update() (azure.mgmt.storage.storagemanagement.StorageAccountOperationsmethod), 119
update_affinity_group() (azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 158
update_data_disk() (azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 158
update_database() (azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementServicemethod), 165
update_deployment_status()(azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 158
update_disk() (azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 159
update_dns_server() (azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 159
update_event_hub() (azure.servicebus.servicebusservice.ServiceBusServicemethod), 128
update_firewall_rule() (azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementServicemethod), 165
update_hosted_service() (azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 159
update_os_image() (azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 159
update_os_image_from_image_reference()(azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 160
update_role() (azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 160
update_site() (azure.servicemanagement.websitemanagementservice.WebsiteManagementServicemethod), 168
update_storage_account()(azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 161
update_vm_image() (azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 161
UpdateOperationResponse (class inazure.mgmt.network.networkresourceprovider),83
updating (azure.mgmt.compute.computemanagement.ProvisioningStateTypesattribute), 41
updating (azure.mgmt.network.networkresourceprovider.ProvisioningStateattribute), 74
upgrade_deployment() (azure.servicemanagement.servicemanagementservice.ServiceManagementServicemethod), 162
UpgradeStatus (class in
Index 199
Azure SDK for Python Documentation, Release 1.0.3
azure.servicemanagement.models), 136uri (azure.mgmt.compute.computemanagement.VirtualHardDisk
attribute), 43uri (azure.mgmt.resource.resourcemanagement.ParametersLink
attribute), 101uri (azure.mgmt.resource.resourcemanagement.TemplateLink
attribute), 113usage (azure.mgmt.compute.computemanagement.ComputeManagementClient
attribute), 36Usage (class in azure.mgmt.compute.computemanagement),
42Usage (class in azure.mgmt.network.networkresourceprovider),
84UsageName (class in azure.mgmt.compute.computemanagement),
42UsageName (class in azure.mgmt.network.networkresourceprovider),
84UsageOperations (class in
azure.mgmt.compute.computemanagement),43
UsageOperations (class inazure.mgmt.network.networkresourceprovider),84
usages (azure.mgmt.compute.computemanagement.ListUsagesResponseattribute), 39
usages (azure.mgmt.network.networkresourceprovider.NetworkResourceProviderClientattribute), 71
usages (azure.mgmt.network.networkresourceprovider.UsagesListResponseattribute), 85
UsagesListResponse (class inazure.mgmt.network.networkresourceprovider),84
UsageUnit (class in azure.mgmt.compute.computemanagement),43
UsageUnit (class in azure.mgmt.network.networkresourceprovider),84
use_sub_domain (azure.mgmt.storage.storagemanagement.CustomDomainattribute), 114
UserAgentFilter (class in azure.mgmt.common.filters), 31
Vvalidate() (azure.mgmt.resource.resourcemanagement.DeploymentOperations
method), 98value (azure.mgmt.compute.computemanagement.UsageName
attribute), 43value (azure.mgmt.network.networkresourceprovider.ConnectionSharedKey
attribute), 59value (azure.mgmt.network.networkresourceprovider.ConnectionSharedKeyResponse
attribute), 60value (azure.mgmt.network.networkresourceprovider.UsageName
attribute), 84value (azure.mgmt.resource.resourcemanagement.TagCount
attribute), 111
value (azure.mgmt.resource.resourcemanagement.TagCreateValueResultattribute), 111
value (azure.mgmt.resource.resourcemanagement.TagValueattribute), 113
values (azure.mgmt.resource.resourcemanagement.TagDetailsattribute), 112
Values (class in azure.servicemanagement.models), 136vault_certificates (azure.mgmt.compute.computemanagement.VaultSecretGroup
attribute), 43VaultCertificate (class in
azure.mgmt.compute.computemanagement),43
VaultSecretGroup (class inazure.mgmt.compute.computemanagement),43
version (azure.mgmt.compute.computemanagement.ImageReferenceattribute), 38
version (azure.mgmt.compute.computemanagement.VirtualMachineExtensionImageGetParametersattribute), 46
version (azure.mgmt.compute.computemanagement.VirtualMachineImageGetParametersattribute), 49
virtual_hard_disk (azure.mgmt.compute.computemanagement.Diskattribute), 37
virtual_hard_disk_name_prefix(azure.mgmt.compute.computemanagement.VirtualMachineCaptureParametersattribute), 44
virtual_machine (azure.mgmt.compute.computemanagement.VirtualMachineCreateOrUpdateResponseattribute), 44
virtual_machine (azure.mgmt.compute.computemanagement.VirtualMachineGetResponseattribute), 49
virtual_machine (azure.mgmt.network.networkresourceprovider.NetworkInterfaceattribute), 67
virtual_machine_extension(azure.mgmt.compute.computemanagement.VirtualMachineExtensionCreateOrUpdateResponseattribute), 45
virtual_machine_extension(azure.mgmt.compute.computemanagement.VirtualMachineExtensionGetResponseattribute), 45
virtual_machine_extension_image(azure.mgmt.compute.computemanagement.VirtualMachineExtensionImageGetResponseattribute), 46
virtual_machine_extension_images(azure.mgmt.compute.computemanagement.ComputeManagementClientattribute), 36
virtual_machine_extensions(azure.mgmt.compute.computemanagement.ComputeManagementClientattribute), 36
virtual_machine_image (azure.mgmt.compute.computemanagement.VirtualMachineImageGetResponseattribute), 49
virtual_machine_images (azure.mgmt.compute.computemanagement.ComputeManagementClientattribute), 36
virtual_machine_size (azure.mgmt.compute.computemanagement.HardwareProfileattribute), 38
virtual_machine_sizes (azure.mgmt.compute.computemanagement.ComputeManagementClient
200 Index
Azure SDK for Python Documentation, Release 1.0.3
attribute), 36virtual_machine_sizes (azure.mgmt.compute.computemanagement.VirtualMachineSizeListResponse
attribute), 57virtual_machines (azure.mgmt.compute.computemanagement.ComputeManagementClient
attribute), 37virtual_machines (azure.mgmt.compute.computemanagement.VirtualMachineListResponse
attribute), 52virtual_machines_references
(azure.mgmt.compute.computemanagement.AvailabilitySetattribute), 34
virtual_network (azure.mgmt.network.networkresourceprovider.VirtualNetworkGetResponseattribute), 93
virtual_network (azure.mgmt.network.networkresourceprovider.VirtualNetworkPutResponseattribute), 94
virtual_network_gateway(azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayGetResponseattribute), 90
virtual_network_gateway(azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayPutResponseattribute), 92
virtual_network_gateway1(azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayConnectionattribute), 85
virtual_network_gateway2(azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayConnectionattribute), 86
virtual_network_gateway_connection(azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayConnectionGetResponseattribute), 86
virtual_network_gateway_connection(azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayConnectionPutResponseattribute), 89
virtual_network_gateway_connections(azure.mgmt.network.networkresourceprovider.NetworkResourceProviderClientattribute), 71
virtual_network_gateway_connections(azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayConnectionListResponseattribute), 86
virtual_network_gateways(azure.mgmt.network.networkresourceprovider.NetworkResourceProviderClientattribute), 71
virtual_network_gateways(azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayListResponseattribute), 90
virtual_networks (azure.mgmt.network.networkresourceprovider.NetworkResourceProviderClientattribute), 71
virtual_networks (azure.mgmt.network.networkresourceprovider.VirtualNetworkListResponseattribute), 93
VirtualHardDisk (class inazure.mgmt.compute.computemanagement),43
VirtualIP (class in azure.servicemanagement.models),136
VirtualIPs (class in azure.servicemanagement.models),
136VirtualMachine (class in
azure.mgmt.compute.computemanagement),43
VirtualMachineAgentInstanceView (class inazure.mgmt.compute.computemanagement),44
VirtualMachineCaptureParameters (class inazure.mgmt.compute.computemanagement),44
VirtualMachineCreateOrUpdateResponse (class inazure.mgmt.compute.computemanagement),44
VirtualMachineExtension (class inazure.mgmt.compute.computemanagement),44
VirtualMachineExtensionCreateOrUpdateResponse(class in azure.mgmt.compute.computemanagement),45
VirtualMachineExtensionGetResponse (class inazure.mgmt.compute.computemanagement),45
VirtualMachineExtensionHandlerInstanceView (class inazure.mgmt.compute.computemanagement),45
VirtualMachineExtensionImage (class inazure.mgmt.compute.computemanagement),45
VirtualMachineExtensionImageGetParameters (class inazure.mgmt.compute.computemanagement),46
VirtualMachineExtensionImageGetResponse (class inazure.mgmt.compute.computemanagement),46
VirtualMachineExtensionImageListTypesParameters(class in azure.mgmt.compute.computemanagement),46
VirtualMachineExtensionImageListVersionsParameters(class in azure.mgmt.compute.computemanagement),46
VirtualMachineExtensionImageOperations (class inazure.mgmt.compute.computemanagement),46
VirtualMachineExtensionInstanceView (class inazure.mgmt.compute.computemanagement),47
VirtualMachineExtensionOperations (class inazure.mgmt.compute.computemanagement),47
VirtualMachineGetResponse (class inazure.mgmt.compute.computemanagement),49
VirtualMachineImage (class inazure.mgmt.compute.computemanagement),
Index 201
Azure SDK for Python Documentation, Release 1.0.3
49VirtualMachineImageGetParameters (class in
azure.mgmt.compute.computemanagement),49
VirtualMachineImageGetResponse (class inazure.mgmt.compute.computemanagement),49
VirtualMachineImageListDetailsParameters (class inazure.mgmt.compute.computemanagement),49
VirtualMachineImageListOffersParameters (class inazure.mgmt.compute.computemanagement),49
VirtualMachineImageListParameters (class inazure.mgmt.compute.computemanagement),50
VirtualMachineImageListPublishersParameters (class inazure.mgmt.compute.computemanagement),50
VirtualMachineImageListSkusParameters (class inazure.mgmt.compute.computemanagement),50
VirtualMachineImageOperations (class inazure.mgmt.compute.computemanagement),50
VirtualMachineImageResource (class inazure.mgmt.compute.computemanagement),51
VirtualMachineImageResourceList (class inazure.mgmt.compute.computemanagement),51
VirtualMachineInstanceView (class inazure.mgmt.compute.computemanagement),51
VirtualMachineListResponse (class inazure.mgmt.compute.computemanagement),52
VirtualMachineOperations (class inazure.mgmt.compute.computemanagement),52
VirtualMachineReference (class inazure.mgmt.compute.computemanagement),56
VirtualMachineSize (class inazure.mgmt.compute.computemanagement),56
VirtualMachineSizeListResponse (class inazure.mgmt.compute.computemanagement),56
VirtualMachineSizeOperations (class inazure.mgmt.compute.computemanagement),57
VirtualMachineSizeTypes (class inazure.mgmt.compute.computemanagement),
57VirtualNetwork (class in
azure.mgmt.network.networkresourceprovider),85
VirtualNetworkGateway (class inazure.mgmt.network.networkresourceprovider),85
VirtualNetworkGatewayConnection (class inazure.mgmt.network.networkresourceprovider),85
VirtualNetworkGatewayConnectionGetResponse (classin azure.mgmt.network.networkresourceprovider),86
VirtualNetworkGatewayConnectionListResponse (classin azure.mgmt.network.networkresourceprovider),86
VirtualNetworkGatewayConnectionOperations (class inazure.mgmt.network.networkresourceprovider),86
VirtualNetworkGatewayConnectionPutResponse (classin azure.mgmt.network.networkresourceprovider),89
VirtualNetworkGatewayConnectionType (class inazure.mgmt.network.networkresourceprovider),89
VirtualNetworkGatewayGetResponse (class inazure.mgmt.network.networkresourceprovider),89
VirtualNetworkGatewayIpConfiguration (class inazure.mgmt.network.networkresourceprovider),90
VirtualNetworkGatewayListResponse (class inazure.mgmt.network.networkresourceprovider),90
VirtualNetworkGatewayOperations (class inazure.mgmt.network.networkresourceprovider),90
VirtualNetworkGatewayPutResponse (class inazure.mgmt.network.networkresourceprovider),92
VirtualNetworkGatewaySize (class inazure.mgmt.network.networkresourceprovider),92
VirtualNetworkGetResponse (class inazure.mgmt.network.networkresourceprovider),93
VirtualNetworkListResponse (class inazure.mgmt.network.networkresourceprovider),93
VirtualNetworkOperations (class inazure.mgmt.network.networkresourceprovider),93
VirtualNetworkPutResponse (class inazure.mgmt.network.networkresourceprovider),
202 Index
Azure SDK for Python Documentation, Release 1.0.3
94VirtualNetworkSite (class in
azure.servicemanagement.models), 136VirtualNetworkSites (class in
azure.servicemanagement.models), 136vm_agent (azure.mgmt.compute.computemanagement.VirtualMachineInstanceView
attribute), 52vm_agent_version (azure.mgmt.compute.computemanagement.VirtualMachineAgentInstanceView
attribute), 44vm_scale_set_enabled (azure.mgmt.compute.computemanagement.VirtualMachineExtensionImage
attribute), 46VMImage (class in azure.servicemanagement.models),
136VMImages (class in azure.servicemanagement.models),
136vnet2_vnet (azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayConnectionType
attribute), 89vpn_client (azure.mgmt.network.networkresourceprovider.VirtualNetworkGatewayConnectionType
attribute), 89VpnGatewayType (class in
azure.mgmt.network.networkresourceprovider),95
Wwalk_upgrade_domain() (azure.servicemanagement.servicemanagementservice.ServiceManagementService
method), 163warning (azure.mgmt.compute.computemanagement.StatusLevelTypes
attribute), 42WebsiteManagementService (class in
azure.servicemanagement.websitemanagementservice),166
WebSpace (class in azure.servicemanagement.models),137
WebSpaces (class in azure.servicemanagement.models),137
win_rm_configuration (azure.mgmt.compute.computemanagement.WindowsConfigurationattribute), 58
windows (azure.mgmt.compute.computemanagement.OperatingSystemTypesattribute), 40
windows_configuration (azure.mgmt.compute.computemanagement.OSProfileattribute), 40
WindowsConfiguration (class inazure.mgmt.compute.computemanagement),58
WindowsConfigurationSet (class inazure.servicemanagement.models), 137
WinRM (class in azure.servicemanagement.models), 137WinRMConfiguration (class in
azure.mgmt.compute.computemanagement),58
WinRMListener (class inazure.mgmt.compute.computemanagement),58
with_filter() (azure.servicebus.servicebusservice.ServiceBusServicemethod), 128
Index 203