@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 6.49 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Class representing a Traffic Manager profile.
*
* Uses Azure REST API version 2022-04-01.
*
* Other available API versions: 2015-11-01, 2017-03-01, 2017-05-01, 2018-02-01, 2018-03-01, 2018-04-01, 2018-08-01, 2022-04-01-preview, 2024-04-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native trafficmanager [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class Profile extends pulumi.CustomResource {
/**
* Get an existing Profile resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Profile;
/**
* Returns true if the given object is an instance of Profile. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Profile;
/**
* The list of allowed endpoint record types.
*/
readonly allowedEndpointRecordTypes: pulumi.Output<string[] | undefined>;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* The DNS settings of the Traffic Manager profile.
*/
readonly dnsConfig: pulumi.Output<outputs.trafficmanager.DnsConfigResponse | undefined>;
/**
* The list of endpoints in the Traffic Manager profile.
*/
readonly endpoints: pulumi.Output<outputs.trafficmanager.EndpointResponse[] | undefined>;
/**
* The Azure Region where the resource lives
*/
readonly location: pulumi.Output<string | undefined>;
/**
* Maximum number of endpoints to be returned for MultiValue routing type.
*/
readonly maxReturn: pulumi.Output<number | undefined>;
/**
* The endpoint monitoring settings of the Traffic Manager profile.
*/
readonly monitorConfig: pulumi.Output<outputs.trafficmanager.MonitorConfigResponse | undefined>;
/**
* The name of the resource
*/
readonly name: pulumi.Output<string | undefined>;
/**
* The status of the Traffic Manager profile.
*/
readonly profileStatus: pulumi.Output<string | undefined>;
/**
* Resource tags.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* The traffic routing method of the Traffic Manager profile.
*/
readonly trafficRoutingMethod: pulumi.Output<string | undefined>;
/**
* 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.
*/
readonly trafficViewEnrollmentStatus: pulumi.Output<string | undefined>;
/**
* The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.
*/
readonly type: pulumi.Output<string | undefined>;
/**
* Create a Profile resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: ProfileArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Profile resource.
*/
export interface ProfileArgs {
/**
* The list of allowed endpoint record types.
*/
allowedEndpointRecordTypes?: pulumi.Input<pulumi.Input<string | enums.trafficmanager.AllowedEndpointRecordType>[]>;
/**
* The DNS settings of the Traffic Manager profile.
*/
dnsConfig?: pulumi.Input<inputs.trafficmanager.DnsConfigArgs>;
/**
* The list of endpoints in the Traffic Manager profile.
* These are also available as standalone resources. Do not mix inline and standalone resource as they will conflict with each other, leading to resources deletion.
*/
endpoints?: pulumi.Input<pulumi.Input<inputs.trafficmanager.EndpointArgs>[]>;
/**
* Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
*/
id?: pulumi.Input<string>;
/**
* The Azure Region where the resource lives
*/
location?: pulumi.Input<string>;
/**
* Maximum number of endpoints to be returned for MultiValue routing type.
*/
maxReturn?: pulumi.Input<number>;
/**
* The endpoint monitoring settings of the Traffic Manager profile.
*/
monitorConfig?: pulumi.Input<inputs.trafficmanager.MonitorConfigArgs>;
/**
* The name of the resource
*/
name?: pulumi.Input<string>;
/**
* The name of the Traffic Manager profile.
*/
profileName?: pulumi.Input<string>;
/**
* The status of the Traffic Manager profile.
*/
profileStatus?: pulumi.Input<string | enums.trafficmanager.ProfileStatus>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* Resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The traffic routing method of the Traffic Manager profile.
*/
trafficRoutingMethod?: pulumi.Input<string | enums.trafficmanager.TrafficRoutingMethod>;
/**
* 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.
*/
trafficViewEnrollmentStatus?: pulumi.Input<string | enums.trafficmanager.TrafficViewEnrollmentStatus>;
/**
* The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.
*/
type?: pulumi.Input<string>;
}