network.azure.com/v1api20220401
network.azure.com/v1api20220401
Package v1api20220401 contains API Schema definitions for the network v1api20220401 API group
APIVersion
(string
alias)
Value | Description |
---|---|
"2022-04-01" |
AllowedEndpointRecordType
(string
alias)
(Appears on:Trafficmanagerprofile_Spec)
The allowed type DNS record types for this profile.
Value | Description |
---|---|
"Any" |
|
"DomainName" |
|
"IPv4Address" |
|
"IPv6Address" |
AllowedEndpointRecordType_ARM
(string
alias)
(Appears on:ProfileProperties_ARM)
The allowed type DNS record types for this profile.
Value | Description |
---|---|
"Any" |
|
"DomainName" |
|
"IPv4Address" |
|
"IPv6Address" |
AllowedEndpointRecordType_STATUS
(string
alias)
(Appears on:Trafficmanagerprofile_STATUS)
The allowed type DNS record types for this profile.
Value | Description |
---|---|
"Any" |
|
"DomainName" |
|
"IPv4Address" |
|
"IPv6Address" |
AllowedEndpointRecordType_STATUS_ARM
(string
alias)
(Appears on:ProfileProperties_STATUS_ARM)
The allowed type DNS record types for this profile.
Value | Description |
---|---|
"Any" |
|
"DomainName" |
|
"IPv4Address" |
|
"IPv6Address" |
DnsConfig
(Appears on:Trafficmanagerprofile_Spec)
Class containing DNS settings in a Traffic Manager profile.
Field | Description |
---|---|
relativeName string |
RelativeName: The relative DNS name provided by this Traffic Manager profile. This value is combined with the DNS domain name used by Azure Traffic Manager to form the fully-qualified domain name (FQDN) of the profile. |
ttl int |
Ttl: The DNS Time-To-Live (TTL), in seconds. This informs the local DNS resolvers and DNS clients how long to cache DNS responses provided by this Traffic Manager profile. |
DnsConfig_ARM
(Appears on:ProfileProperties_ARM)
Class containing DNS settings in a Traffic Manager profile.
Field | Description |
---|---|
relativeName string |
RelativeName: The relative DNS name provided by this Traffic Manager profile. This value is combined with the DNS domain name used by Azure Traffic Manager to form the fully-qualified domain name (FQDN) of the profile. |
ttl int |
Ttl: The DNS Time-To-Live (TTL), in seconds. This informs the local DNS resolvers and DNS clients how long to cache DNS responses provided by this Traffic Manager profile. |
DnsConfig_STATUS
(Appears on:Trafficmanagerprofile_STATUS)
Class containing DNS settings in a Traffic Manager profile.
Field | Description |
---|---|
fqdn string |
Fqdn: The fully-qualified domain name (FQDN) of the Traffic Manager profile. This is formed from the concatenation of the RelativeName with the DNS domain used by Azure Traffic Manager. |
relativeName string |
RelativeName: The relative DNS name provided by this Traffic Manager profile. This value is combined with the DNS domain name used by Azure Traffic Manager to form the fully-qualified domain name (FQDN) of the profile. |
ttl int |
Ttl: The DNS Time-To-Live (TTL), in seconds. This informs the local DNS resolvers and DNS clients how long to cache DNS responses provided by this Traffic Manager profile. |
DnsConfig_STATUS_ARM
(Appears on:ProfileProperties_STATUS_ARM)
Class containing DNS settings in a Traffic Manager profile.
Field | Description |
---|---|
fqdn string |
Fqdn: The fully-qualified domain name (FQDN) of the Traffic Manager profile. This is formed from the concatenation of the RelativeName with the DNS domain used by Azure Traffic Manager. |
relativeName string |
RelativeName: The relative DNS name provided by this Traffic Manager profile. This value is combined with the DNS domain name used by Azure Traffic Manager to form the fully-qualified domain name (FQDN) of the profile. |
ttl int |
Ttl: The DNS Time-To-Live (TTL), in seconds. This informs the local DNS resolvers and DNS clients how long to cache DNS responses provided by this Traffic Manager profile. |
EndpointProperties_ARM
(Appears on:Trafficmanagerprofiles_AzureEndpoint_Spec_ARM, Trafficmanagerprofiles_ExternalEndpoint_Spec_ARM, Trafficmanagerprofiles_NestedEndpoint_Spec_ARM)
Class representing a Traffic Manager endpoint properties.
Field | Description |
---|---|
alwaysServe EndpointProperties_AlwaysServe_ARM |
AlwaysServe: If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method. |
customHeaders []EndpointProperties_CustomHeaders_ARM |
CustomHeaders: List of custom headers. |
endpointLocation string |
EndpointLocation: Specifies the location of the external or nested endpoints when using the ‘Performance’ traffic routing method. |
endpointMonitorStatus EndpointProperties_EndpointMonitorStatus_ARM |
EndpointMonitorStatus: The monitoring status of the endpoint. |
endpointStatus EndpointProperties_EndpointStatus_ARM |
EndpointStatus: The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. |
geoMapping []string |
GeoMapping: The list of countries/regions mapped to this endpoint when using the ‘Geographic’ traffic routing method. Please consult Traffic Manager Geographic documentation for a full list of accepted values. |
minChildEndpoints int |
MinChildEndpoints: The minimum number of endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type ‘NestedEndpoints’. |
minChildEndpointsIPv4 int |
MinChildEndpointsIPv4: The minimum number of IPv4 (DNS record type A) endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type ‘NestedEndpoints’. |
minChildEndpointsIPv6 int |
MinChildEndpointsIPv6: The minimum number of IPv6 (DNS record type AAAA) endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type ‘NestedEndpoints’. |
priority int |
Priority: The priority of this endpoint when using the ‘Priority’ traffic routing method. Possible values are from 1 to 1000, lower values represent higher priority. This is an optional parameter. If specified, it must be specified on all endpoints, and no two endpoints can share the same priority value. |
subnets []EndpointProperties_Subnets_ARM |
Subnets: The list of subnets, IP addresses, and/or address ranges mapped to this endpoint when using the ‘Subnet’ traffic routing method. An empty list will match all ranges not covered by other endpoints. |
target string |
Target: The fully-qualified DNS name or IP address of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint. |
targetResourceId string |
|
weight int |
Weight: The weight of this endpoint when using the ‘Weighted’ traffic routing method. Possible values are from 1 to 1000. |
EndpointProperties_AlwaysServe
(string
alias)
(Appears on:Trafficmanagerprofiles_AzureEndpoint_Spec, Trafficmanagerprofiles_ExternalEndpoint_Spec, Trafficmanagerprofiles_NestedEndpoint_Spec)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
EndpointProperties_AlwaysServe_ARM
(string
alias)
(Appears on:EndpointProperties_ARM)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
EndpointProperties_AlwaysServe_STATUS
(string
alias)
(Appears on:Trafficmanagerprofiles_AzureEndpoint_STATUS, Trafficmanagerprofiles_ExternalEndpoint_STATUS, Trafficmanagerprofiles_NestedEndpoint_STATUS)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
EndpointProperties_AlwaysServe_STATUS_ARM
(string
alias)
(Appears on:EndpointProperties_STATUS_ARM)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
EndpointProperties_CustomHeaders
(Appears on:Trafficmanagerprofiles_AzureEndpoint_Spec, Trafficmanagerprofiles_ExternalEndpoint_Spec, Trafficmanagerprofiles_NestedEndpoint_Spec)
Field | Description |
---|---|
name string |
Name: Header name. |
value string |
Value: Header value. |
EndpointProperties_CustomHeaders_ARM
(Appears on:EndpointProperties_ARM)
Field | Description |
---|---|
name string |
Name: Header name. |
value string |
Value: Header value. |
EndpointProperties_CustomHeaders_STATUS
(Appears on:Trafficmanagerprofiles_AzureEndpoint_STATUS, Trafficmanagerprofiles_ExternalEndpoint_STATUS, Trafficmanagerprofiles_NestedEndpoint_STATUS)
Field | Description |
---|---|
name string |
Name: Header name. |
value string |
Value: Header value. |
EndpointProperties_CustomHeaders_STATUS_ARM
(Appears on:EndpointProperties_STATUS_ARM)
Field | Description |
---|---|
name string |
Name: Header name. |
value string |
Value: Header value. |
EndpointProperties_EndpointMonitorStatus
(string
alias)
(Appears on:Trafficmanagerprofiles_AzureEndpoint_Spec, Trafficmanagerprofiles_ExternalEndpoint_Spec, Trafficmanagerprofiles_NestedEndpoint_Spec)
Value | Description |
---|---|
"CheckingEndpoint" |
|
"Degraded" |
|
"Disabled" |
|
"Inactive" |
|
"Online" |
|
"Stopped" |
|
"Unmonitored" |
EndpointProperties_EndpointMonitorStatus_ARM
(string
alias)
(Appears on:EndpointProperties_ARM)
Value | Description |
---|---|
"CheckingEndpoint" |
|
"Degraded" |
|
"Disabled" |
|
"Inactive" |
|
"Online" |
|
"Stopped" |
|
"Unmonitored" |
EndpointProperties_EndpointMonitorStatus_STATUS
(string
alias)
(Appears on:Trafficmanagerprofiles_AzureEndpoint_STATUS, Trafficmanagerprofiles_ExternalEndpoint_STATUS, Trafficmanagerprofiles_NestedEndpoint_STATUS)
Value | Description |
---|---|
"CheckingEndpoint" |
|
"Degraded" |
|
"Disabled" |
|
"Inactive" |
|
"Online" |
|
"Stopped" |
|
"Unmonitored" |
EndpointProperties_EndpointMonitorStatus_STATUS_ARM
(string
alias)
(Appears on:EndpointProperties_STATUS_ARM)
Value | Description |
---|---|
"CheckingEndpoint" |
|
"Degraded" |
|
"Disabled" |
|
"Inactive" |
|
"Online" |
|
"Stopped" |
|
"Unmonitored" |
EndpointProperties_EndpointStatus
(string
alias)
(Appears on:Trafficmanagerprofiles_AzureEndpoint_Spec, Trafficmanagerprofiles_ExternalEndpoint_Spec, Trafficmanagerprofiles_NestedEndpoint_Spec)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
EndpointProperties_EndpointStatus_ARM
(string
alias)
(Appears on:EndpointProperties_ARM)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
EndpointProperties_EndpointStatus_STATUS
(string
alias)
(Appears on:Trafficmanagerprofiles_AzureEndpoint_STATUS, Trafficmanagerprofiles_ExternalEndpoint_STATUS, Trafficmanagerprofiles_NestedEndpoint_STATUS)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
EndpointProperties_EndpointStatus_STATUS_ARM
(string
alias)
(Appears on:EndpointProperties_STATUS_ARM)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
EndpointProperties_STATUS_ARM
(Appears on:Trafficmanagerprofiles_AzureEndpoint_STATUS_ARM, Trafficmanagerprofiles_ExternalEndpoint_STATUS_ARM, Trafficmanagerprofiles_NestedEndpoint_STATUS_ARM)
Class representing a Traffic Manager endpoint properties.
Field | Description |
---|---|
alwaysServe EndpointProperties_AlwaysServe_STATUS_ARM |
AlwaysServe: If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method. |
customHeaders []EndpointProperties_CustomHeaders_STATUS_ARM |
CustomHeaders: List of custom headers. |
endpointLocation string |
EndpointLocation: Specifies the location of the external or nested endpoints when using the ‘Performance’ traffic routing method. |
endpointMonitorStatus EndpointProperties_EndpointMonitorStatus_STATUS_ARM |
EndpointMonitorStatus: The monitoring status of the endpoint. |
endpointStatus EndpointProperties_EndpointStatus_STATUS_ARM |
EndpointStatus: The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. |
geoMapping []string |
GeoMapping: The list of countries/regions mapped to this endpoint when using the ‘Geographic’ traffic routing method. Please consult Traffic Manager Geographic documentation for a full list of accepted values. |
minChildEndpoints int |
MinChildEndpoints: The minimum number of endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type ‘NestedEndpoints’. |
minChildEndpointsIPv4 int |
MinChildEndpointsIPv4: The minimum number of IPv4 (DNS record type A) endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type ‘NestedEndpoints’. |
minChildEndpointsIPv6 int |
MinChildEndpointsIPv6: The minimum number of IPv6 (DNS record type AAAA) endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type ‘NestedEndpoints’. |
priority int |
Priority: The priority of this endpoint when using the ‘Priority’ traffic routing method. Possible values are from 1 to 1000, lower values represent higher priority. This is an optional parameter. If specified, it must be specified on all endpoints, and no two endpoints can share the same priority value. |
subnets []EndpointProperties_Subnets_STATUS_ARM |
Subnets: The list of subnets, IP addresses, and/or address ranges mapped to this endpoint when using the ‘Subnet’ traffic routing method. An empty list will match all ranges not covered by other endpoints. |
target string |
Target: The fully-qualified DNS name or IP address of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint. |
targetResourceId string |
TargetResourceId: The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type ‘ExternalEndpoints’. |
weight int |
Weight: The weight of this endpoint when using the ‘Weighted’ traffic routing method. Possible values are from 1 to 1000. |
EndpointProperties_Subnets
(Appears on:Trafficmanagerprofiles_AzureEndpoint_Spec, Trafficmanagerprofiles_ExternalEndpoint_Spec, Trafficmanagerprofiles_NestedEndpoint_Spec)
Field | Description |
---|---|
first string |
First: First address in the subnet. |
last string |
Last: Last address in the subnet. |
scope int |
Scope: Block size (number of leading bits in the subnet mask). |
EndpointProperties_Subnets_ARM
(Appears on:EndpointProperties_ARM)
Field | Description |
---|---|
first string |
First: First address in the subnet. |
last string |
Last: Last address in the subnet. |
scope int |
Scope: Block size (number of leading bits in the subnet mask). |
EndpointProperties_Subnets_STATUS
(Appears on:Trafficmanagerprofiles_AzureEndpoint_STATUS, Trafficmanagerprofiles_ExternalEndpoint_STATUS, Trafficmanagerprofiles_NestedEndpoint_STATUS)
Field | Description |
---|---|
first string |
First: First address in the subnet. |
last string |
Last: Last address in the subnet. |
scope int |
Scope: Block size (number of leading bits in the subnet mask). |
EndpointProperties_Subnets_STATUS_ARM
(Appears on:EndpointProperties_STATUS_ARM)
Field | Description |
---|---|
first string |
First: First address in the subnet. |
last string |
Last: Last address in the subnet. |
scope int |
Scope: Block size (number of leading bits in the subnet mask). |
Endpoint_STATUS
(Appears on:Trafficmanagerprofile_STATUS)
Class representing a Traffic Manager endpoint.
Field | Description |
---|---|
id string |
Id: Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}p> |
Endpoint_STATUS_ARM
(Appears on:ProfileProperties_STATUS_ARM)
Class representing a Traffic Manager endpoint.
Field | Description |
---|---|
id string |
Id: Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}p> |
MonitorConfig
(Appears on:Trafficmanagerprofile_Spec)
Class containing endpoint monitoring settings in a Traffic Manager profile.
Field | Description |
---|---|
customHeaders []MonitorConfig_CustomHeaders |
CustomHeaders: List of custom headers. |
expectedStatusCodeRanges []MonitorConfig_ExpectedStatusCodeRanges |
ExpectedStatusCodeRanges: List of expected status code ranges. |
intervalInSeconds int |
IntervalInSeconds: The monitor interval for endpoints in this profile. This is the interval at which Traffic Manager will check the health of each endpoint in this profile. |
path string |
Path: The path relative to the endpoint domain name used to probe for endpoint health. |
port int |
Port: The TCP port used to probe for endpoint health. |
profileMonitorStatus MonitorConfig_ProfileMonitorStatus |
ProfileMonitorStatus: The profile-level monitoring status of the Traffic Manager profile. |
protocol MonitorConfig_Protocol |
Protocol: The protocol (HTTP, HTTPS or TCP) used to probe for endpoint health. |
timeoutInSeconds int |
TimeoutInSeconds: The monitor timeout for endpoints in this profile. This is the time that Traffic Manager allows endpoints in this profile to response to the health check. |
toleratedNumberOfFailures int |
ToleratedNumberOfFailures: The number of consecutive failed health check that Traffic Manager tolerates before declaring an endpoint in this profile Degraded after the next failed health check. |
MonitorConfig_ARM
(Appears on:ProfileProperties_ARM)
Class containing endpoint monitoring settings in a Traffic Manager profile.
Field | Description |
---|---|
customHeaders []MonitorConfig_CustomHeaders_ARM |
CustomHeaders: List of custom headers. |
expectedStatusCodeRanges []MonitorConfig_ExpectedStatusCodeRanges_ARM |
ExpectedStatusCodeRanges: List of expected status code ranges. |
intervalInSeconds int |
IntervalInSeconds: The monitor interval for endpoints in this profile. This is the interval at which Traffic Manager will check the health of each endpoint in this profile. |
path string |
Path: The path relative to the endpoint domain name used to probe for endpoint health. |
port int |
Port: The TCP port used to probe for endpoint health. |
profileMonitorStatus MonitorConfig_ProfileMonitorStatus_ARM |
ProfileMonitorStatus: The profile-level monitoring status of the Traffic Manager profile. |
protocol MonitorConfig_Protocol_ARM |
Protocol: The protocol (HTTP, HTTPS or TCP) used to probe for endpoint health. |
timeoutInSeconds int |
TimeoutInSeconds: The monitor timeout for endpoints in this profile. This is the time that Traffic Manager allows endpoints in this profile to response to the health check. |
toleratedNumberOfFailures int |
ToleratedNumberOfFailures: The number of consecutive failed health check that Traffic Manager tolerates before declaring an endpoint in this profile Degraded after the next failed health check. |
MonitorConfig_CustomHeaders
(Appears on:MonitorConfig)
Field | Description |
---|---|
name string |
Name: Header name. |
value string |
Value: Header value. |
MonitorConfig_CustomHeaders_ARM
(Appears on:MonitorConfig_ARM)
Field | Description |
---|---|
name string |
Name: Header name. |
value string |
Value: Header value. |
MonitorConfig_CustomHeaders_STATUS
(Appears on:MonitorConfig_STATUS)
Field | Description |
---|---|
name string |
Name: Header name. |
value string |
Value: Header value. |
MonitorConfig_CustomHeaders_STATUS_ARM
(Appears on:MonitorConfig_STATUS_ARM)
Field | Description |
---|---|
name string |
Name: Header name. |
value string |
Value: Header value. |
MonitorConfig_ExpectedStatusCodeRanges
(Appears on:MonitorConfig)
Field | Description |
---|---|
max int |
Max: Max status code. |
min int |
Min: Min status code. |
MonitorConfig_ExpectedStatusCodeRanges_ARM
(Appears on:MonitorConfig_ARM)
Field | Description |
---|---|
max int |
Max: Max status code. |
min int |
Min: Min status code. |
MonitorConfig_ExpectedStatusCodeRanges_STATUS
(Appears on:MonitorConfig_STATUS)
Field | Description |
---|---|
max int |
Max: Max status code. |
min int |
Min: Min status code. |
MonitorConfig_ExpectedStatusCodeRanges_STATUS_ARM
(Appears on:MonitorConfig_STATUS_ARM)
Field | Description |
---|---|
max int |
Max: Max status code. |
min int |
Min: Min status code. |
MonitorConfig_ProfileMonitorStatus
(string
alias)
(Appears on:MonitorConfig)
Value | Description |
---|---|
"CheckingEndpoints" |
|
"Degraded" |
|
"Disabled" |
|
"Inactive" |
|
"Online" |
MonitorConfig_ProfileMonitorStatus_ARM
(string
alias)
(Appears on:MonitorConfig_ARM)
Value | Description |
---|---|
"CheckingEndpoints" |
|
"Degraded" |
|
"Disabled" |
|
"Inactive" |
|
"Online" |
MonitorConfig_ProfileMonitorStatus_STATUS
(string
alias)
(Appears on:MonitorConfig_STATUS)
Value | Description |
---|---|
"CheckingEndpoints" |
|
"Degraded" |
|
"Disabled" |
|
"Inactive" |
|
"Online" |
MonitorConfig_ProfileMonitorStatus_STATUS_ARM
(string
alias)
(Appears on:MonitorConfig_STATUS_ARM)
Value | Description |
---|---|
"CheckingEndpoints" |
|
"Degraded" |
|
"Disabled" |
|
"Inactive" |
|
"Online" |
MonitorConfig_Protocol
(string
alias)
(Appears on:MonitorConfig)
Value | Description |
---|---|
"HTTP" |
|
"HTTPS" |
|
"TCP" |
MonitorConfig_Protocol_ARM
(string
alias)
(Appears on:MonitorConfig_ARM)
Value | Description |
---|---|
"HTTP" |
|
"HTTPS" |
|
"TCP" |
MonitorConfig_Protocol_STATUS
(string
alias)
(Appears on:MonitorConfig_STATUS)
Value | Description |
---|---|
"HTTP" |
|
"HTTPS" |
|
"TCP" |
MonitorConfig_Protocol_STATUS_ARM
(string
alias)
(Appears on:MonitorConfig_STATUS_ARM)
Value | Description |
---|---|
"HTTP" |
|
"HTTPS" |
|
"TCP" |
MonitorConfig_STATUS
(Appears on:Trafficmanagerprofile_STATUS)
Class containing endpoint monitoring settings in a Traffic Manager profile.
Field | Description |
---|---|
customHeaders []MonitorConfig_CustomHeaders_STATUS |
CustomHeaders: List of custom headers. |
expectedStatusCodeRanges []MonitorConfig_ExpectedStatusCodeRanges_STATUS |
ExpectedStatusCodeRanges: List of expected status code ranges. |
intervalInSeconds int |
IntervalInSeconds: The monitor interval for endpoints in this profile. This is the interval at which Traffic Manager will check the health of each endpoint in this profile. |
path string |
Path: The path relative to the endpoint domain name used to probe for endpoint health. |
port int |
Port: The TCP port used to probe for endpoint health. |
profileMonitorStatus MonitorConfig_ProfileMonitorStatus_STATUS |
ProfileMonitorStatus: The profile-level monitoring status of the Traffic Manager profile. |
protocol MonitorConfig_Protocol_STATUS |
Protocol: The protocol (HTTP, HTTPS or TCP) used to probe for endpoint health. |
timeoutInSeconds int |
TimeoutInSeconds: The monitor timeout for endpoints in this profile. This is the time that Traffic Manager allows endpoints in this profile to response to the health check. |
toleratedNumberOfFailures int |
ToleratedNumberOfFailures: The number of consecutive failed health check that Traffic Manager tolerates before declaring an endpoint in this profile Degraded after the next failed health check. |
MonitorConfig_STATUS_ARM
(Appears on:ProfileProperties_STATUS_ARM)
Class containing endpoint monitoring settings in a Traffic Manager profile.
Field | Description |
---|---|
customHeaders []MonitorConfig_CustomHeaders_STATUS_ARM |
CustomHeaders: List of custom headers. |
expectedStatusCodeRanges []MonitorConfig_ExpectedStatusCodeRanges_STATUS_ARM |
ExpectedStatusCodeRanges: List of expected status code ranges. |
intervalInSeconds int |
IntervalInSeconds: The monitor interval for endpoints in this profile. This is the interval at which Traffic Manager will check the health of each endpoint in this profile. |
path string |
Path: The path relative to the endpoint domain name used to probe for endpoint health. |
port int |
Port: The TCP port used to probe for endpoint health. |
profileMonitorStatus MonitorConfig_ProfileMonitorStatus_STATUS_ARM |
ProfileMonitorStatus: The profile-level monitoring status of the Traffic Manager profile. |
protocol MonitorConfig_Protocol_STATUS_ARM |
Protocol: The protocol (HTTP, HTTPS or TCP) used to probe for endpoint health. |
timeoutInSeconds int |
TimeoutInSeconds: The monitor timeout for endpoints in this profile. This is the time that Traffic Manager allows endpoints in this profile to response to the health check. |
toleratedNumberOfFailures int |
ToleratedNumberOfFailures: The number of consecutive failed health check that Traffic Manager tolerates before declaring an endpoint in this profile Degraded after the next failed health check. |
ProfileProperties_ARM
(Appears on:Trafficmanagerprofile_Spec_ARM)
Class representing the Traffic Manager profile properties.
Field | Description |
---|---|
allowedEndpointRecordTypes []AllowedEndpointRecordType_ARM |
AllowedEndpointRecordTypes: The list of allowed endpoint record types. |
dnsConfig DnsConfig_ARM |
DnsConfig: The DNS settings of the Traffic Manager profile. |
maxReturn int |
MaxReturn: Maximum number of endpoints to be returned for MultiValue routing type. |
monitorConfig MonitorConfig_ARM |
MonitorConfig: The endpoint monitoring settings of the Traffic Manager profile. |
profileStatus ProfileProperties_ProfileStatus_ARM |
ProfileStatus: The status of the Traffic Manager profile. |
trafficRoutingMethod ProfileProperties_TrafficRoutingMethod_ARM |
TrafficRoutingMethod: The traffic routing method of the Traffic Manager profile. |
trafficViewEnrollmentStatus ProfileProperties_TrafficViewEnrollmentStatus_ARM |
TrafficViewEnrollmentStatus: Indicates whether Traffic View is ‘Enabled’ or ‘Disabled’ for the Traffic Manager profile. Null, indicates ‘Disabled’. Enabling this feature will increase the cost of the Traffic Manage profile. |
ProfileProperties_ProfileStatus
(string
alias)
(Appears on:Trafficmanagerprofile_Spec)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
ProfileProperties_ProfileStatus_ARM
(string
alias)
(Appears on:ProfileProperties_ARM)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
ProfileProperties_ProfileStatus_STATUS
(string
alias)
(Appears on:Trafficmanagerprofile_STATUS)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
ProfileProperties_ProfileStatus_STATUS_ARM
(string
alias)
(Appears on:ProfileProperties_STATUS_ARM)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
ProfileProperties_STATUS_ARM
(Appears on:Trafficmanagerprofile_STATUS_ARM)
Class representing the Traffic Manager profile properties.
Field | Description |
---|---|
allowedEndpointRecordTypes []AllowedEndpointRecordType_STATUS_ARM |
AllowedEndpointRecordTypes: The list of allowed endpoint record types. |
dnsConfig DnsConfig_STATUS_ARM |
DnsConfig: The DNS settings of the Traffic Manager profile. |
endpoints []Endpoint_STATUS_ARM |
Endpoints: The list of endpoints in the Traffic Manager profile. |
maxReturn int |
MaxReturn: Maximum number of endpoints to be returned for MultiValue routing type. |
monitorConfig MonitorConfig_STATUS_ARM |
MonitorConfig: The endpoint monitoring settings of the Traffic Manager profile. |
profileStatus ProfileProperties_ProfileStatus_STATUS_ARM |
ProfileStatus: The status of the Traffic Manager profile. |
trafficRoutingMethod ProfileProperties_TrafficRoutingMethod_STATUS_ARM |
TrafficRoutingMethod: The traffic routing method of the Traffic Manager profile. |
trafficViewEnrollmentStatus ProfileProperties_TrafficViewEnrollmentStatus_STATUS_ARM |
TrafficViewEnrollmentStatus: Indicates whether Traffic View is ‘Enabled’ or ‘Disabled’ for the Traffic Manager profile. Null, indicates ‘Disabled’. Enabling this feature will increase the cost of the Traffic Manage profile. |
ProfileProperties_TrafficRoutingMethod
(string
alias)
(Appears on:Trafficmanagerprofile_Spec)
Value | Description |
---|---|
"Geographic" |
|
"MultiValue" |
|
"Performance" |
|
"Priority" |
|
"Subnet" |
|
"Weighted" |
ProfileProperties_TrafficRoutingMethod_ARM
(string
alias)
(Appears on:ProfileProperties_ARM)
Value | Description |
---|---|
"Geographic" |
|
"MultiValue" |
|
"Performance" |
|
"Priority" |
|
"Subnet" |
|
"Weighted" |
ProfileProperties_TrafficRoutingMethod_STATUS
(string
alias)
(Appears on:Trafficmanagerprofile_STATUS)
Value | Description |
---|---|
"Geographic" |
|
"MultiValue" |
|
"Performance" |
|
"Priority" |
|
"Subnet" |
|
"Weighted" |
ProfileProperties_TrafficRoutingMethod_STATUS_ARM
(string
alias)
(Appears on:ProfileProperties_STATUS_ARM)
Value | Description |
---|---|
"Geographic" |
|
"MultiValue" |
|
"Performance" |
|
"Priority" |
|
"Subnet" |
|
"Weighted" |
ProfileProperties_TrafficViewEnrollmentStatus
(string
alias)
(Appears on:Trafficmanagerprofile_Spec)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
ProfileProperties_TrafficViewEnrollmentStatus_ARM
(string
alias)
(Appears on:ProfileProperties_ARM)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
ProfileProperties_TrafficViewEnrollmentStatus_STATUS
(string
alias)
(Appears on:Trafficmanagerprofile_STATUS)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
ProfileProperties_TrafficViewEnrollmentStatus_STATUS_ARM
(string
alias)
(Appears on:ProfileProperties_STATUS_ARM)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
TrafficManagerProfile
Generator information: - Generated from: /trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/trafficmanager.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}p>
Field | Description | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||
spec Trafficmanagerprofile_Spec |
|
||||||||||||||||||||||||||
status Trafficmanagerprofile_STATUS |
TrafficManagerProfileOperatorConfigMaps
(Appears on:TrafficManagerProfileOperatorSpec)
Field | Description |
---|---|
dnsConfigFqdn genruntime.ConfigMapDestination |
DnsConfigFqdn: indicates where the DnsConfigFqdn config map should be placed. If omitted, no config map will be created. |
TrafficManagerProfileOperatorSpec
(Appears on:Trafficmanagerprofile_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMaps TrafficManagerProfileOperatorConfigMaps |
ConfigMaps: configures where to place operator written ConfigMaps. |
TrafficManagerProfilesAzureEndpoint
Generator information: - Generated from: /trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/trafficmanager.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}/AzureEndpoints/{endpointName}p>
Field | Description | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||||||||||
spec Trafficmanagerprofiles_AzureEndpoint_Spec |
|
||||||||||||||||||||||||||||||||||
status Trafficmanagerprofiles_AzureEndpoint_STATUS |
TrafficManagerProfilesExternalEndpoint
Generator information: - Generated from: /trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/trafficmanager.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}/ExternalEndpoints/{endpointName}p>
Field | Description | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||||||||||
spec Trafficmanagerprofiles_ExternalEndpoint_Spec |
|
||||||||||||||||||||||||||||||||||
status Trafficmanagerprofiles_ExternalEndpoint_STATUS |
TrafficManagerProfilesNestedEndpoint
Generator information: - Generated from: /trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/trafficmanager.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}/NestedEndpoints/{endpointName}p>
Field | Description | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||||||||||
spec Trafficmanagerprofiles_NestedEndpoint_Spec |
|
||||||||||||||||||||||||||||||||||
status Trafficmanagerprofiles_NestedEndpoint_STATUS |
Trafficmanagerprofile_STATUS
(Appears on:TrafficManagerProfile)
Field | Description |
---|---|
allowedEndpointRecordTypes []AllowedEndpointRecordType_STATUS |
AllowedEndpointRecordTypes: The list of allowed endpoint record types. |
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
dnsConfig DnsConfig_STATUS |
DnsConfig: The DNS settings of the Traffic Manager profile. |
endpoints []Endpoint_STATUS |
Endpoints: The list of endpoints in the Traffic Manager profile. |
id string |
Id: Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}p> |
location string |
Location: The Azure Region where the resource lives |
maxReturn int |
MaxReturn: Maximum number of endpoints to be returned for MultiValue routing type. |
monitorConfig MonitorConfig_STATUS |
MonitorConfig: The endpoint monitoring settings of the Traffic Manager profile. |
name string |
Name: The name of the resource |
profileStatus ProfileProperties_ProfileStatus_STATUS |
ProfileStatus: The status of the Traffic Manager profile. |
tags map[string]string |
Tags: Resource tags. |
trafficRoutingMethod ProfileProperties_TrafficRoutingMethod_STATUS |
TrafficRoutingMethod: The traffic routing method of the Traffic Manager profile. |
trafficViewEnrollmentStatus ProfileProperties_TrafficViewEnrollmentStatus_STATUS |
TrafficViewEnrollmentStatus: Indicates whether Traffic View is ‘Enabled’ or ‘Disabled’ for the Traffic Manager profile. Null, indicates ‘Disabled’. Enabling this feature will increase the cost of the Traffic Manage profile. |
type string |
Type: The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles. |
Trafficmanagerprofile_STATUS_ARM
Field | Description |
---|---|
id string |
Id: Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}p> |
location string |
Location: The Azure Region where the resource lives |
name string |
Name: The name of the resource |
properties ProfileProperties_STATUS_ARM |
Properties: The properties of the Traffic Manager profile. |
tags map[string]string |
Tags: Resource tags. |
type string |
Type: The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles. |
Trafficmanagerprofile_Spec
(Appears on:TrafficManagerProfile)
Field | Description |
---|---|
allowedEndpointRecordTypes []AllowedEndpointRecordType |
AllowedEndpointRecordTypes: The list of allowed endpoint record types. |
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
dnsConfig DnsConfig |
DnsConfig: The DNS settings of the Traffic Manager profile. |
location string |
Location: The Azure Region where the resource lives |
maxReturn int |
MaxReturn: Maximum number of endpoints to be returned for MultiValue routing type. |
monitorConfig MonitorConfig |
MonitorConfig: The endpoint monitoring settings of the Traffic Manager profile. |
operatorSpec TrafficManagerProfileOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource |
profileStatus ProfileProperties_ProfileStatus |
ProfileStatus: The status of the Traffic Manager profile. |
tags map[string]string |
Tags: Resource tags. |
trafficRoutingMethod ProfileProperties_TrafficRoutingMethod |
TrafficRoutingMethod: The traffic routing method of the Traffic Manager profile. |
trafficViewEnrollmentStatus ProfileProperties_TrafficViewEnrollmentStatus |
TrafficViewEnrollmentStatus: Indicates whether Traffic View is ‘Enabled’ or ‘Disabled’ for the Traffic Manager profile. Null, indicates ‘Disabled’. Enabling this feature will increase the cost of the Traffic Manage profile. |
type string |
Type: The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles. |
Trafficmanagerprofile_Spec_ARM
Field | Description |
---|---|
location string |
Location: The Azure Region where the resource lives |
name string |
Name: The name of the resource |
properties ProfileProperties_ARM |
Properties: The properties of the Traffic Manager profile. |
tags map[string]string |
Tags: Resource tags. |
type string |
Type: The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles. |
Trafficmanagerprofiles_AzureEndpoint_STATUS
(Appears on:TrafficManagerProfilesAzureEndpoint)
Field | Description |
---|---|
alwaysServe EndpointProperties_AlwaysServe_STATUS |
AlwaysServe: If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method. |
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
customHeaders []EndpointProperties_CustomHeaders_STATUS |
CustomHeaders: List of custom headers. |
endpointLocation string |
EndpointLocation: Specifies the location of the external or nested endpoints when using the ‘Performance’ traffic routing method. |
endpointMonitorStatus EndpointProperties_EndpointMonitorStatus_STATUS |
EndpointMonitorStatus: The monitoring status of the endpoint. |
endpointStatus EndpointProperties_EndpointStatus_STATUS |
EndpointStatus: The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. |
geoMapping []string |
GeoMapping: The list of countries/regions mapped to this endpoint when using the ‘Geographic’ traffic routing method. Please consult Traffic Manager Geographic documentation for a full list of accepted values. |
id string |
Id: Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}p> |
minChildEndpoints int |
MinChildEndpoints: The minimum number of endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type ‘NestedEndpoints’. |
minChildEndpointsIPv4 int |
MinChildEndpointsIPv4: The minimum number of IPv4 (DNS record type A) endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type ‘NestedEndpoints’. |
minChildEndpointsIPv6 int |
MinChildEndpointsIPv6: The minimum number of IPv6 (DNS record type AAAA) endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type ‘NestedEndpoints’. |
name string |
Name: The name of the resource |
priority int |
Priority: The priority of this endpoint when using the ‘Priority’ traffic routing method. Possible values are from 1 to 1000, lower values represent higher priority. This is an optional parameter. If specified, it must be specified on all endpoints, and no two endpoints can share the same priority value. |
subnets []EndpointProperties_Subnets_STATUS |
Subnets: The list of subnets, IP addresses, and/or address ranges mapped to this endpoint when using the ‘Subnet’ traffic routing method. An empty list will match all ranges not covered by other endpoints. |
target string |
Target: The fully-qualified DNS name or IP address of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint. |
targetResourceId string |
TargetResourceId: The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type ‘ExternalEndpoints’. |
type string |
Type: The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles. |
weight int |
Weight: The weight of this endpoint when using the ‘Weighted’ traffic routing method. Possible values are from 1 to 1000. |
Trafficmanagerprofiles_AzureEndpoint_STATUS_ARM
Field | Description |
---|---|
id string |
Id: Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}p> |
name string |
Name: The name of the resource |
properties EndpointProperties_STATUS_ARM |
Properties: The properties of the Traffic Manager endpoint. |
type string |
Type: The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles. |
Trafficmanagerprofiles_AzureEndpoint_Spec
(Appears on:TrafficManagerProfilesAzureEndpoint)
Field | Description |
---|---|
alwaysServe EndpointProperties_AlwaysServe |
AlwaysServe: If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method. |
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
customHeaders []EndpointProperties_CustomHeaders |
CustomHeaders: List of custom headers. |
endpointLocation string |
EndpointLocation: Specifies the location of the external or nested endpoints when using the ‘Performance’ traffic routing method. |
endpointMonitorStatus EndpointProperties_EndpointMonitorStatus |
EndpointMonitorStatus: The monitoring status of the endpoint. |
endpointStatus EndpointProperties_EndpointStatus |
EndpointStatus: The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. |
geoMapping []string |
GeoMapping: The list of countries/regions mapped to this endpoint when using the ‘Geographic’ traffic routing method. Please consult Traffic Manager Geographic documentation for a full list of accepted values. |
minChildEndpoints int |
MinChildEndpoints: The minimum number of endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type ‘NestedEndpoints’. |
minChildEndpointsIPv4 int |
MinChildEndpointsIPv4: The minimum number of IPv4 (DNS record type A) endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type ‘NestedEndpoints’. |
minChildEndpointsIPv6 int |
MinChildEndpointsIPv6: The minimum number of IPv6 (DNS record type AAAA) endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type ‘NestedEndpoints’. |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a network.azure.com/TrafficManagerProfile resource |
priority int |
Priority: The priority of this endpoint when using the ‘Priority’ traffic routing method. Possible values are from 1 to 1000, lower values represent higher priority. This is an optional parameter. If specified, it must be specified on all endpoints, and no two endpoints can share the same priority value. |
subnets []EndpointProperties_Subnets |
Subnets: The list of subnets, IP addresses, and/or address ranges mapped to this endpoint when using the ‘Subnet’ traffic routing method. An empty list will match all ranges not covered by other endpoints. |
target string |
Target: The fully-qualified DNS name or IP address of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint. |
targetResourceReference genruntime.ResourceReference |
TargetResourceReference: The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type ‘ExternalEndpoints’. |
type string |
Type: The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles. |
weight int |
Weight: The weight of this endpoint when using the ‘Weighted’ traffic routing method. Possible values are from 1 to 1000. |
Trafficmanagerprofiles_AzureEndpoint_Spec_ARM
Field | Description |
---|---|
name string |
Name: The name of the resource |
properties EndpointProperties_ARM |
Properties: The properties of the Traffic Manager endpoint. |
type string |
Type: The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles. |
Trafficmanagerprofiles_ExternalEndpoint_STATUS
(Appears on:TrafficManagerProfilesExternalEndpoint)
Field | Description |
---|---|
alwaysServe EndpointProperties_AlwaysServe_STATUS |
AlwaysServe: If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method. |
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
customHeaders []EndpointProperties_CustomHeaders_STATUS |
CustomHeaders: List of custom headers. |
endpointLocation string |
EndpointLocation: Specifies the location of the external or nested endpoints when using the ‘Performance’ traffic routing method. |
endpointMonitorStatus EndpointProperties_EndpointMonitorStatus_STATUS |
EndpointMonitorStatus: The monitoring status of the endpoint. |
endpointStatus EndpointProperties_EndpointStatus_STATUS |
EndpointStatus: The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. |
geoMapping []string |
GeoMapping: The list of countries/regions mapped to this endpoint when using the ‘Geographic’ traffic routing method. Please consult Traffic Manager Geographic documentation for a full list of accepted values. |
id string |
Id: Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}p> |
minChildEndpoints int |
MinChildEndpoints: The minimum number of endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type ‘NestedEndpoints’. |
minChildEndpointsIPv4 int |
MinChildEndpointsIPv4: The minimum number of IPv4 (DNS record type A) endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type ‘NestedEndpoints’. |
minChildEndpointsIPv6 int |
MinChildEndpointsIPv6: The minimum number of IPv6 (DNS record type AAAA) endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type ‘NestedEndpoints’. |
name string |
Name: The name of the resource |
priority int |
Priority: The priority of this endpoint when using the ‘Priority’ traffic routing method. Possible values are from 1 to 1000, lower values represent higher priority. This is an optional parameter. If specified, it must be specified on all endpoints, and no two endpoints can share the same priority value. |
subnets []EndpointProperties_Subnets_STATUS |
Subnets: The list of subnets, IP addresses, and/or address ranges mapped to this endpoint when using the ‘Subnet’ traffic routing method. An empty list will match all ranges not covered by other endpoints. |
target string |
Target: The fully-qualified DNS name or IP address of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint. |
targetResourceId string |
TargetResourceId: The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type ‘ExternalEndpoints’. |
type string |
Type: The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles. |
weight int |
Weight: The weight of this endpoint when using the ‘Weighted’ traffic routing method. Possible values are from 1 to 1000. |
Trafficmanagerprofiles_ExternalEndpoint_STATUS_ARM
Field | Description |
---|---|
id string |
Id: Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}p> |
name string |
Name: The name of the resource |
properties EndpointProperties_STATUS_ARM |
Properties: The properties of the Traffic Manager endpoint. |
type string |
Type: The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles. |
Trafficmanagerprofiles_ExternalEndpoint_Spec
(Appears on:TrafficManagerProfilesExternalEndpoint)
Field | Description |
---|---|
alwaysServe EndpointProperties_AlwaysServe |
AlwaysServe: If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method. |
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
customHeaders []EndpointProperties_CustomHeaders |
CustomHeaders: List of custom headers. |
endpointLocation string |
EndpointLocation: Specifies the location of the external or nested endpoints when using the ‘Performance’ traffic routing method. |
endpointMonitorStatus EndpointProperties_EndpointMonitorStatus |
EndpointMonitorStatus: The monitoring status of the endpoint. |
endpointStatus EndpointProperties_EndpointStatus |
EndpointStatus: The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. |
geoMapping []string |
GeoMapping: The list of countries/regions mapped to this endpoint when using the ‘Geographic’ traffic routing method. Please consult Traffic Manager Geographic documentation for a full list of accepted values. |
minChildEndpoints int |
MinChildEndpoints: The minimum number of endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type ‘NestedEndpoints’. |
minChildEndpointsIPv4 int |
MinChildEndpointsIPv4: The minimum number of IPv4 (DNS record type A) endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type ‘NestedEndpoints’. |
minChildEndpointsIPv6 int |
MinChildEndpointsIPv6: The minimum number of IPv6 (DNS record type AAAA) endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type ‘NestedEndpoints’. |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a network.azure.com/TrafficManagerProfile resource |
priority int |
Priority: The priority of this endpoint when using the ‘Priority’ traffic routing method. Possible values are from 1 to 1000, lower values represent higher priority. This is an optional parameter. If specified, it must be specified on all endpoints, and no two endpoints can share the same priority value. |
subnets []EndpointProperties_Subnets |
Subnets: The list of subnets, IP addresses, and/or address ranges mapped to this endpoint when using the ‘Subnet’ traffic routing method. An empty list will match all ranges not covered by other endpoints. |
target string |
Target: The fully-qualified DNS name or IP address of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint. |
targetResourceReference genruntime.ResourceReference |
TargetResourceReference: The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type ‘ExternalEndpoints’. |
type string |
Type: The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles. |
weight int |
Weight: The weight of this endpoint when using the ‘Weighted’ traffic routing method. Possible values are from 1 to 1000. |
Trafficmanagerprofiles_ExternalEndpoint_Spec_ARM
Field | Description |
---|---|
name string |
Name: The name of the resource |
properties EndpointProperties_ARM |
Properties: The properties of the Traffic Manager endpoint. |
type string |
Type: The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles. |
Trafficmanagerprofiles_NestedEndpoint_STATUS
(Appears on:TrafficManagerProfilesNestedEndpoint)
Field | Description |
---|---|
alwaysServe EndpointProperties_AlwaysServe_STATUS |
AlwaysServe: If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method. |
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
customHeaders []EndpointProperties_CustomHeaders_STATUS |
CustomHeaders: List of custom headers. |
endpointLocation string |
EndpointLocation: Specifies the location of the external or nested endpoints when using the ‘Performance’ traffic routing method. |
endpointMonitorStatus EndpointProperties_EndpointMonitorStatus_STATUS |
EndpointMonitorStatus: The monitoring status of the endpoint. |
endpointStatus EndpointProperties_EndpointStatus_STATUS |
EndpointStatus: The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. |
geoMapping []string |
GeoMapping: The list of countries/regions mapped to this endpoint when using the ‘Geographic’ traffic routing method. Please consult Traffic Manager Geographic documentation for a full list of accepted values. |
id string |
Id: Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}p> |
minChildEndpoints int |
MinChildEndpoints: The minimum number of endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type ‘NestedEndpoints’. |
minChildEndpointsIPv4 int |
MinChildEndpointsIPv4: The minimum number of IPv4 (DNS record type A) endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type ‘NestedEndpoints’. |
minChildEndpointsIPv6 int |
MinChildEndpointsIPv6: The minimum number of IPv6 (DNS record type AAAA) endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type ‘NestedEndpoints’. |
name string |
Name: The name of the resource |
priority int |
Priority: The priority of this endpoint when using the ‘Priority’ traffic routing method. Possible values are from 1 to 1000, lower values represent higher priority. This is an optional parameter. If specified, it must be specified on all endpoints, and no two endpoints can share the same priority value. |
subnets []EndpointProperties_Subnets_STATUS |
Subnets: The list of subnets, IP addresses, and/or address ranges mapped to this endpoint when using the ‘Subnet’ traffic routing method. An empty list will match all ranges not covered by other endpoints. |
target string |
Target: The fully-qualified DNS name or IP address of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint. |
targetResourceId string |
TargetResourceId: The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type ‘ExternalEndpoints’. |
type string |
Type: The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles. |
weight int |
Weight: The weight of this endpoint when using the ‘Weighted’ traffic routing method. Possible values are from 1 to 1000. |
Trafficmanagerprofiles_NestedEndpoint_STATUS_ARM
Field | Description |
---|---|
id string |
Id: Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}p> |
name string |
Name: The name of the resource |
properties EndpointProperties_STATUS_ARM |
Properties: The properties of the Traffic Manager endpoint. |
type string |
Type: The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles. |
Trafficmanagerprofiles_NestedEndpoint_Spec
(Appears on:TrafficManagerProfilesNestedEndpoint)
Field | Description |
---|---|
alwaysServe EndpointProperties_AlwaysServe |
AlwaysServe: If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method. |
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
customHeaders []EndpointProperties_CustomHeaders |
CustomHeaders: List of custom headers. |
endpointLocation string |
EndpointLocation: Specifies the location of the external or nested endpoints when using the ‘Performance’ traffic routing method. |
endpointMonitorStatus EndpointProperties_EndpointMonitorStatus |
EndpointMonitorStatus: The monitoring status of the endpoint. |
endpointStatus EndpointProperties_EndpointStatus |
EndpointStatus: The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. |
geoMapping []string |
GeoMapping: The list of countries/regions mapped to this endpoint when using the ‘Geographic’ traffic routing method. Please consult Traffic Manager Geographic documentation for a full list of accepted values. |
minChildEndpoints int |
MinChildEndpoints: The minimum number of endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type ‘NestedEndpoints’. |
minChildEndpointsIPv4 int |
MinChildEndpointsIPv4: The minimum number of IPv4 (DNS record type A) endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type ‘NestedEndpoints’. |
minChildEndpointsIPv6 int |
MinChildEndpointsIPv6: The minimum number of IPv6 (DNS record type AAAA) endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type ‘NestedEndpoints’. |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a network.azure.com/TrafficManagerProfile resource |
priority int |
Priority: The priority of this endpoint when using the ‘Priority’ traffic routing method. Possible values are from 1 to 1000, lower values represent higher priority. This is an optional parameter. If specified, it must be specified on all endpoints, and no two endpoints can share the same priority value. |
subnets []EndpointProperties_Subnets |
Subnets: The list of subnets, IP addresses, and/or address ranges mapped to this endpoint when using the ‘Subnet’ traffic routing method. An empty list will match all ranges not covered by other endpoints. |
target string |
Target: The fully-qualified DNS name or IP address of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint. |
targetResourceReference genruntime.ResourceReference |
TargetResourceReference: The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type ‘ExternalEndpoints’. |
type string |
Type: The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles. |
weight int |
Weight: The weight of this endpoint when using the ‘Weighted’ traffic routing method. Possible values are from 1 to 1000. |
Trafficmanagerprofiles_NestedEndpoint_Spec_ARM
Field | Description |
---|---|
name string |
Name: The name of the resource |
properties EndpointProperties_ARM |
Properties: The properties of the Traffic Manager endpoint. |
type string |
Type: The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles. |