@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 3.86 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Gets 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 function getProfile(args: GetProfileArgs, opts?: pulumi.InvokeOptions): Promise<GetProfileResult>;
export interface GetProfileArgs {
/**
* The name of the Traffic Manager profile.
*/
profileName: string;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: string;
}
/**
* Class representing a Traffic Manager profile.
*/
export interface GetProfileResult {
/**
* The list of allowed endpoint record types.
*/
readonly allowedEndpointRecordTypes?: string[];
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* The DNS settings of the Traffic Manager profile.
*/
readonly dnsConfig?: outputs.trafficmanager.DnsConfigResponse;
/**
* The list of endpoints in the Traffic Manager profile.
*/
readonly endpoints?: outputs.trafficmanager.EndpointResponse[];
/**
* Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
*/
readonly id?: string;
/**
* The Azure Region where the resource lives
*/
readonly location?: string;
/**
* Maximum number of endpoints to be returned for MultiValue routing type.
*/
readonly maxReturn?: number;
/**
* The endpoint monitoring settings of the Traffic Manager profile.
*/
readonly monitorConfig?: outputs.trafficmanager.MonitorConfigResponse;
/**
* The name of the resource
*/
readonly name?: string;
/**
* The status of the Traffic Manager profile.
*/
readonly profileStatus?: string;
/**
* Resource tags.
*/
readonly tags?: {
[key: string]: string;
};
/**
* The traffic routing method of the Traffic Manager profile.
*/
readonly trafficRoutingMethod?: string;
/**
* 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?: string;
/**
* The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.
*/
readonly type?: string;
}
/**
* Gets 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 function getProfileOutput(args: GetProfileOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetProfileResult>;
export interface GetProfileOutputArgs {
/**
* The name of the Traffic Manager profile.
*/
profileName: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
}