github.com/turtlemonvh/terraform@v0.6.9-0.20151204001754-8e40b6b855e8/website/source/docs/providers/azure/index.html.markdown (about)

     1  ---
     2  layout: "azure"
     3  page_title: "Provider: Azure"
     4  sidebar_current: "docs-azure-index"
     5  description: |-
     6    The Azure provider is used to interact with the many resources supported by Azure. The provider needs to be configured with a publish settings file and optionally a subscription ID before it can be used.
     7  ---
     8  
     9  # Azure Provider
    10  
    11  The Azure provider is used to interact with the many resources supported
    12  by Azure. The provider needs to be configured with a [publish settings
    13  file](https://manage.windowsazure.com/publishsettings) and optionally a
    14  subscription ID before it can be used.
    15  
    16  Use the navigation to the left to read about the available resources.
    17  
    18  ## Example Usage
    19  
    20  ```
    21  # Configure the Azure Provider
    22  provider "azure" {
    23    settings_file = "${file("credentials.publishsettings")}"
    24  }
    25  
    26  # Create a web server
    27  resource "azure_instance" "web" {
    28      ...
    29  }
    30  ```
    31  
    32  ## Argument Reference
    33  
    34  The following arguments are supported:
    35  
    36  * `publish_settings` - (Optional) Contents of a valid `publishsettings` file,
    37    used to authenticate with the Azure API. You can download the settings file
    38    here: https://manage.windowsazure.com/publishsettings. You must either
    39    provide publish settings or both a `subscription_id` and `certificate`. It
    40    can also be sourced from the `AZURE_PUBLISH_SETTINGS` environment variable.
    41  
    42  * `subscription_id` - (Optional) The subscription ID to use. If a
    43    `settings_file` is not provided `subscription_id` is required. It can also
    44    be sourced from the `AZURE_SUBSCRIPTION_ID` environment variable.
    45  
    46  * `certificate` - (Optional) The certificate used to authenticate with the
    47    Azure API. If a `settings_file` is not provided `certificate` is required.
    48    It can also be sourced from the `AZURE_CERTIFICATE` environment variable.
    49  
    50  These arguments are supported for backwards compatibility, and may be removed
    51  in a future version:
    52  
    53  * `settings_file` - __Deprecated: please use `publish_settings` instead.__
    54    Path to or contents of a valid `publishsettings` file, used to
    55    authenticate with the Azure API. You can download the settings file here:
    56    https://manage.windowsazure.com/publishsettings. You must either provide
    57    (or source from the `AZURE_SETTINGS_FILE` environment variable) a settings
    58    file or both a `subscription_id` and `certificate`.
    59  
    60  ## Testing:
    61  
    62  The following environment variables must be set for the running of the
    63  acceptance test suite:
    64  
    65  * A valid combination of the above which are required for authentification.
    66  
    67  * `AZURE_STORAGE` - The name of a storage account to be used in tests which
    68    require a storage backend. The storage account needs to be located in
    69    the Western US Azure region.