ProfilesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:profiles> attribute.

Constructor

ProfilesOperations(*args, **kwargs)

Methods

check_traffic_manager_name_availability_v2	Checks the availability of a Traffic Manager Relative DNS name.
check_traffic_manager_relative_dns_name_availability	Checks the availability of a Traffic Manager Relative DNS name.
create_or_update	Create or update a Traffic Manager profile.
delete	Deletes a Traffic Manager profile.
get	Gets a Traffic Manager profile.
list_by_resource_group	Lists all Traffic Manager profiles within a resource group.
list_by_subscription	Lists all Traffic Manager profiles within a subscription.
update	Update a Traffic Manager profile.

check_traffic_manager_name_availability_v2

Checks the availability of a Traffic Manager Relative DNS name.

check_traffic_manager_name_availability_v2(parameters: _models.CheckTrafficManagerRelativeDnsNameAvailabilityParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.TrafficManagerNameAvailability

Parameters

Name	Description
parameters Required	CheckTrafficManagerRelativeDnsNameAvailabilityParameters or IO The Traffic Manager name parameters supplied to the CheckTrafficManagerNameAvailability operation. Is either a CheckTrafficManagerRelativeDnsNameAvailabilityParameters type or a IO type. Required.

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
TrafficManagerNameAvailability	TrafficManagerNameAvailability or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

check_traffic_manager_relative_dns_name_availability

Checks the availability of a Traffic Manager Relative DNS name.

check_traffic_manager_relative_dns_name_availability(parameters: _models.CheckTrafficManagerRelativeDnsNameAvailabilityParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.TrafficManagerNameAvailability

Parameters

Name	Description
parameters Required	CheckTrafficManagerRelativeDnsNameAvailabilityParameters or IO The Traffic Manager name parameters supplied to the CheckTrafficManagerNameAvailability operation. Is either a CheckTrafficManagerRelativeDnsNameAvailabilityParameters type or a IO type. Required.

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
TrafficManagerNameAvailability	TrafficManagerNameAvailability or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

create_or_update

Create or update a Traffic Manager profile.

create_or_update(resource_group_name: str, profile_name: str, parameters: _models.Profile, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Profile

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
profile_name Required	str The name of the Traffic Manager profile. Required.
parameters Required	Profile or IO The Traffic Manager profile parameters supplied to the CreateOrUpdate operation. Is either a Profile type or a IO type. Required.

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
Profile	Profile or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

delete

Deletes a Traffic Manager profile.

delete(resource_group_name: str, profile_name: str, **kwargs: Any) -> DeleteOperationResult | None

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
profile_name Required	str The name of the Traffic Manager profile to be deleted. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
DeleteOperationResult, None	DeleteOperationResult or None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Gets a Traffic Manager profile.

get(resource_group_name: str, profile_name: str, **kwargs: Any) -> Profile

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
profile_name Required	str The name of the Traffic Manager profile. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
Profile	Profile or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_resource_group

Lists all Traffic Manager profiles within a resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[Profile]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
ItemPaged[Profile]	An iterator like instance of either Profile or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_subscription

Lists all Traffic Manager profiles within a subscription.

list_by_subscription(**kwargs: Any) -> Iterable[Profile]

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
ItemPaged[Profile]	An iterator like instance of either Profile or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

update

Update a Traffic Manager profile.

update(resource_group_name: str, profile_name: str, parameters: _models.Profile, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Profile

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
profile_name Required	str The name of the Traffic Manager profile. Required.
parameters Required	Profile or IO The Traffic Manager profile parameters supplied to the Update operation. Is either a Profile type or a IO type. Required.

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
Profile	Profile or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.trafficmanager.models' from 'C:\\ToolCache\\Python\\3.12.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv245\\Lib\\site-packages\\azure\\mgmt\\trafficmanager\\models\\__init__.py'>

Feedback

Was this page helpful?