Microsoft Azure SDK for Python

This is the Microsoft Azure Data Lake Analytics Management Client Library.

Azure Resource Manager (ARM) is the next generation of management APIs that replace the old Azure Service Management (ASM).

This package has been tested with Python 2.7, 3.4, 3.5 and 3.6.

For the older Azure Service Management (ASM) libraries, see azure-servicemanagement-legacy <https://pypi.python.org/pypi/azure-servicemanagement-legacy>__ library.

For a more complete set of Azure libraries, see the azure <https://pypi.python.org/pypi/azure>__ bundle package.

Compatibility

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

You can check the version using pip:

.. code:: shell

pip freeze

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

.. code:: shell

pip uninstall azure

Usage

For code examples, see Data Lake Analytics Management <https://docs.microsoft.com/python/api/overview/azure/data-lake-analytics>__ on docs.microsoft.com.

Provide Feedback

If you encounter any bugs or have suggestions, please file an issue in the Issues <https://github.com/Azure/azure-sdk-for-python/issues>__ section of the project.

.. :changelog:

Release History

0.6.0 (2018-06-15) ++++++++++++++++++

Features

• Catalog_ListTableFragments
• Catalog_PreviewTable
• Catalog_PreviewTablePartition

General breaking changes

The general breaking changes described in 0.5.0 for account now applies to job and catalog as well.

0.5.0 (2018-06-14) ++++++++++++++++++

Features

• Client class can be used as a context manager to keep the underlying HTTP session open for performance

General Breaking changes (account only)

This version uses a next-generation code generator that might introduce breaking changes.

• Model signatures now use only keyword-argument syntax. All positional arguments must be re-written as keyword-arguments. To keep auto-completion in most cases, models are now generated for Python 2 and Python 3. Python 3 uses the "*" syntax for keyword-only arguments.

• Enum types now use the "str" mixin (class AzureEnum(str, Enum)) to improve the behavior when unrecognized enum values are encountered. While this is not a breaking change, the distinctions are important, and are documented here: https://docs.python.org/3/library/enum.html#others At a glance:

  • "is" should not be used at all.
  • "format" will return the string value, where "%s" string formatting will return NameOfEnum.stringvalue. Format syntax should be prefered.

• New Long Running Operation:

  • Return type changes from msrestazure.azure_operation.AzureOperationPoller to msrest.polling.LROPoller. External API is the same.
  • Return type is now always a msrest.polling.LROPoller, regardless of the optional parameters used.
  • The behavior has changed when using raw=True. Instead of returning the initial call result as ClientRawResponse, without polling, now this returns an LROPoller. After polling, the final resource will be returned as a ClientRawResponse.
  • New polling parameter. The default behavior is Polling=True which will poll using ARM algorithm. When Polling=False, the response of the initial call will be returned without polling.
  • polling parameter accepts instances of subclasses of msrest.polling.PollingMethod.
  • add_done_callback will no longer raise if called after polling is finished, but will instead execute the callback right away.

Bugfixes

• Compatibility of the sdist with wheel 0.31.0

0.4.0 (2018-02-12) ++++++++++++++++++

Breaking changes

• The account operations object has been changed from "account" to "accounts"
  • E.g., account.get(...) to accounts.get(...)
• When creating or updating resources (accounts, compute policies, etc.), explicit parameter objects are now required:
  • Account creation:
    • "DataLakeAnalyticsAccount" to "CreateDataLakeAnalyticsAccountParameters"
      • List of "DataLakeStoreInfo" to "AddDataLakeStoreWithAccountParameters"
      • List of "StorageAccountInfo" to "AddStorageAccountWithAccountParameters"
      • List of "FirewallRule" to "CreateFirewallRuleWithAccountParameters"
      • List of "ComputePolicy" to "CreateComputePolicyWithAccountParameters"
  • Account update:
    • "DataLakeAnalyticsUpdateParameters" to "UpdateDataLakeAnalyticsParameters"
      • List of "DataLakeStoreInfo" to "UpdateDataLakeStoreWithAccountParameters"
      • List of "StorageAccountInfo" to "UpdateStorageAccountWithAccountParameters"
      • List of "FirewallRule" to "UpdateFirewallRuleWithAccountParameters"
      • List of "ComputePolicy" to "UpdateComputePolicyWithAccountParameters"
  • Data Lake Store account addition:
    • "DataLakeStoreAccountInfo" to "AddDataLakeStoreParameters"
  • Storage account addition and update:
    • "StorageAccountInfo" to "AddStorageAccountParameters"
    • "StorageAccountInfo" to "UpdateStorageAccountParameters"
  • Compute policy creation and update:
    • "ComputePolicy" to "CreateOrUpdateComputePolicyParameters"
    • "ComputePolicy" to "UpdateComputePolicyParameters"
  • Firewall rule creation and update:
    • "FirewallRule" to "CreateOrUpdateFirewallRuleParameters"
    • "FirewallRule" to "UpdateFirewallRuleParameters"
• When retrieving resources, all the properties are now read-only and the following object names have been changed:
  • Changed "DataLakeStoreAccountInfo" to "DataLakeStoreAccountInformation"
  • Changed "StorageAccountInfo" to "StorageAccountInformation"
• Added paging extension for the returned list for these APIs:
  • Catalog_ListAclsByDatabase
  • Catalog_ListAcls

0.3.0 (2018-01-09) ++++++++++++++++++

Breaking changes

• Changed the ODataQuery parameter type from JobInformation to JobInformationBasic for the Job_List API

• Changed the ODataQuery parameter type from DataLakeAnalyticsAccount to DataLakeAnalyticsAccountBasic for these APIs:

  • Account_List
  • Account_ListByResourceGroup

• For USqlJobProperties, fixed the property name of TotalPauseTime to TotalPausedTime

Notes

• Added more properties to JobStatisticsVertexStage

• Added two more states to DataLakeAnalyticsAccountStatus enum: Undeleting and Canceled

• Added new Account APIs:

  • Account_CheckNameAvailability
  • Location_GetCapability
  • Operation_List

• Added new Catalog APIs:

  • Catalog_ListAclsByDatabase
  • Catalog_ListAcls
  • Catalog_GrantAclToDatabase
  • Catalog_RevokeAclFromDatabase
  • Catalog_GrantAcl
  • Catalog_RevokeAcl

0.2.0 (2017-08-17) ++++++++++++++++++

Breaking changes

• Revised the inheritance structure for objects dealing with job creation, building, and retrieving.

  • NOTE: Only U-SQL is supported in this change; therefore, Hive is not supported.

  • When submitting jobs, change JobInformation objects to CreateJobParameters.

    • When setting the properties for the CreateJobParameters object, be sure to change the USqlJobProperties object to a CreateUSqlJobProperties object.

  • When building jobs, change JobInformation objects to BuildJobParameters objects.

    • When setting the properties for the BuildJobParameters object, be sure to change the USqlJobProperties object to a CreateUSqlJobProperties object.

    • NOTE: The following fields are not a part of the BuildJobParameters object:

      • degreeOfParallelism
      • priority
      • related

  • When getting a list of jobs, the object type that is returned is JobInformationBasic and not JobInformation (more information on the difference is below in the Notes section)

• When getting a list of accounts, the object type that is returned is DataLakeAnalyticsAccountBasic and not DataLakeAnalyticsAccount (more information on the difference is below in the Notes section)

Notes

• When getting a list of jobs, the job information for each job now includes a strict subset of the job information that is returned when getting a single job

  • The following fields are included in the job information when getting a single job but are not included in the job information when getting a list of jobs:

    • errorMessage

    • stateAuditRecords

    • properties

      • runtimeVersion
      • script
      • type

• When getting a list of accounts, the account information for each account now includes a strict subset of the account information that is returned when getting a single account

  • There are two ways to get a list of accounts: List and ListByResource methods

  • The following fields are included in the account information when getting a list of accounts, which is less than the account information retrieved for a single account:

    • provisioningState
    • state
    • creationTime
    • lastModifiedTime
    • endpoint

• When retrieving account information, an account id field called "accountId" is now included.

  • accountId's description: The unique identifier associated with this Data Lake Analytics account.

0.1.6 (2017-06-19) ++++++++++++++++++

• Fixing a regression discovered in 0.1.5. Please update to 0.1.6 to avoid any issues caused by that regression.

0.1.5 (2017-06-07) ++++++++++++++++++

New features

• Support for Compute Policies on accounts. These will limit specific user and groups to certain job parallelism and priority.
• Support for job relationship properties. These can be populated in the related property when submitting a job and can be retrieved with the pipeline and recurrence operation methods.
• Suport for a basic option when listing catalog tables. When set to true, will only return the table name, schema name, database name and version for each table in the list, instead of all table metadata, improving performance when all information is not required.

0.1.4 (2017-04-20) ++++++++++++++++++

New features

• Catalog item get and list support for Packages

• Update to allow listing certain catalog items from within a database (no schema required to list):

  • list_tables_by_database
  • list_table_valued_functions_by_database
  • list_views_by_database
  • list_table_statistics_by_database
  • list_table_statistics_by_database_and_schema

Notes

• This wheel package is now built with the azure wheel extension

0.1.3 (2017-02-13) ++++++++++++++++++

New features

• Add support for firewall rules

  • Add, Update, Get, List and Delete operations
  • Enable/Disable the firewall
  • Allow/Block Azure IPs

• Remove minimum value requirement from DegreeOfParallelism. If a value <= 0 is passed in, it will be defaulted automatically to 1.

• Remove unused ErrorDetails object

0.1.2 (2017-01-09) ++++++++++++++++++

New features

• Added the ability to create and update accounts with usage commitment levels for Data Lake Store and Data Lake Analytics

Bugfixes

• Fixed a bug where three job diagnostic severity types were missing: SevereWarning, UserWarning and Deprecated
• Fixed a bug where UpdateSecret, which is deprecated, was incorrectly indicating that it had a return type. It now properly does not have a return value.

0.1.1 (2016-12-12) ++++++++++++++++++

New features

• Add cascade query parameter to DeleteCredential, which allows the user to indicate if they want to delete all resources dependent on the credential as well as the credential
• Parameters are now optional when adding ADLS accounts to an ADLA account
• Fixed a bug in ADLA where the caller could not create an ADLA account with WASB storage accounts.
• Remove invalid return type from Secret creation in ADLA

Breaking change

• "account_name" parameter is now "name" in account operation

0.1.0 (2016-11-14) ++++++++++++++++++

• Initial Release