Cloud.Service.Azure.Traffic.Manager.Endpoint

JSON Example

{
    "account": "string",
    "count": 0,
    "endpoint_location": "string",
    "endpoint_monitor_status": "string",
    "endpoint_status": "string",
    "geo_mappings": [
        "string"
    ],
    "min_child_endpoints": 0,
    "name": "string",
    "priority": 0,
    "profile_name": "string",
    "resource_group_name": "string",
    "target": "string",
    "target_resource_id": "string",
    "type": "string",
    "weight": 0
}

string

account

Required

(Required) The name of the Microsoft Azure cloud account to use for this resource

integer

count

Optional

The number of resource instances to be created.

string

endpoint_location

Optional

Azure location of the endpoint. If the type is nestedEndpoints or externalEndpoints, must specify for profiles using the performance routing method. For azureEndpoints, the value is taken from the location of the Azure target resource.

string

endpoint_monitor_status

Optional

The Endpoint Monitor Status property for this resource

string

endpoint_status

Optional

Whether the endpoint is enabled or disabled. Default is Enabled.

array of string

geo_mappings

Optional

List of geographic regions used to distribute traffic, such as WORLD, UK, or DE, with no endpoints sharing the same location.

integer

min_child_endpoints

Optional

Minimum number of online endpoints in the child profile in order for the parent profile to direct traffic to any of the endpoints in the child profile. Only applies to nestedEndpoints. Default is 1.

string

name

Required

(Required) Azure Traffic Manager endpoint name. Changing the name deletes the existing resource and creates a new one.

integer

priority

Optional

Endpoint priority for receiving traffic. Must specify for profiles using the priority traffic routing method. Supports values from 1 to 1000 with no endpoints sharing the same value. If omitted, the value is computed from the order of endpoint creation.

string

profile_name

Required

(Required) Traffic Manager profile to attach when creating the Traffic Manager endpoint.

string

resource_group_name

Required

(Required) Azure resource group in which to create the Traffic Manager endpoint.

string

target

Optional

FQDN of the target. Required for externalEndpoints. For other types, the target is computed.

string

target_resource_id

Optional

Unique identifier of an Azure resource to target. Required for type azureEndpoints and nestedEndpoints.

string

type

Required

(Required) Traffic Manager endpoint type: azureEndpoints, externalEndpoints, or nestedEndpoints.

integer

weight

Optional

Amount of traffic to direct to the endpoint. Must specify for profiles using the weighted traffic routing method. Supports values from 1 to 1000.