github.com/nathanielks/terraform@v0.6.1-0.20170509030759-13e1a62319dc/website/source/docs/providers/azurerm/r/traffic_manager_profile.html.markdown (about)

     1  ---
     2  layout: "azurerm"
     3  page_title: "Azure Resource Manager: azurerm_traffic_manager_profile"
     4  sidebar_current: "docs-azurerm-resource-network-traffic-manager-profile"
     5  description: |-
     6    Creates a Traffic Manager Profile.
     7  ---
     8  
     9  # azurerm\_traffic\_manager\_profile
    10  
    11  Creates a Traffic Manager Profile to which multiple endpoints can be attached.
    12  
    13  ## Example Usage
    14  
    15  ```hcl
    16  resource "azurerm_traffic_manager_profile" "test" {
    17    name                = "profile1"
    18    resource_group_name = "${azurerm_resource_group.test.name}"
    19    location            = "West US"
    20  
    21    traffic_routing_method = "Weighted"
    22  
    23    dns_config {
    24      relative_name = "profile1"
    25      ttl           = 100
    26    }
    27  
    28    monitor_config {
    29      protocol = "http"
    30      port     = 80
    31      path     = "/"
    32    }
    33  
    34    tags {
    35      environment = "Production"
    36    }
    37  }
    38  ```
    39  
    40  ## Argument Reference
    41  
    42  The following arguments are supported:
    43  
    44  * `name` - (Required) The name of the virtual network. Changing this forces a
    45      new resource to be created.
    46  
    47  * `resource_group_name` - (Required) The name of the resource group in which to
    48      create the virtual network.
    49  
    50  * `profile_status` - (Optional) The status of the profile, can be set to either
    51      `Enabled` or `Disabled`. Defaults to `Enabled`.
    52  
    53  * `traffic_routing_method` - (Required) Specifies the algorithm used to route
    54      traffic, possible values are:
    55      - `Performance`- Traffic is routed via the User's closest Endpoint
    56      - `Weighted` - Traffic is spread across Endpoints proportional to their
    57          `weight` value.
    58      - `Priority` - Traffic is routed to the Endpoint with the lowest
    59          `priority` value.
    60  
    61  * `dns_config` - (Required) This block specifies the DNS configuration of the
    62      Profile, it supports the fields documented below.
    63  
    64  * `monitor_config` - (Required) This block specifies the Endpoint monitoring
    65      configuration for the Profile, it supports the fields documented below.
    66  
    67  * `tags` - (Optional) A mapping of tags to assign to the resource.
    68  
    69  The `dns_config` block supports:
    70  
    71  * `relative_name` - (Required) The relative domain name, this is combined with
    72      the domain name used by Traffic Manager to form the FQDN which is exported
    73      as documented below. Changing this forces a new resource to be created.
    74  
    75  * `ttl` - (Required) The TTL value of the Profile used by Local DNS resolvers
    76      and clients.
    77  
    78  The `monitor_config` block supports:
    79  
    80  * `http` - (Required) The protocol used by the monitoring checks, supported
    81      values are `http` or `https`.
    82  
    83  * `port` - (Required) The port number used by the monitoring checks.
    84  
    85  * `path` - (Required) The path used by the monitoring checks.
    86  
    87  ## Attributes Reference
    88  
    89  The following attributes are exported:
    90  
    91  * `id` - The Traffic Manager Profile id.
    92  * `fqdn` - The FQDN of the created Profile.
    93  
    94  ## Notes
    95  
    96  The Traffic Manager is created with the location `global`.
    97  
    98  ## Import
    99  
   100  Traffic Manager Profiles can be imported using the `resource id`, e.g.
   101  
   102  ```
   103  terraform import azurerm_traffic_manager_profile.testProfile /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Network/trafficManagerProfiles/mytrafficmanagerprofile1
   104  ```