ProfilesOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
TrafficManagerManagementClient's
<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
CheckTrafficManagerRelativeDnsNameAvailabilityParameters or
IO[bytes]
The request body. Is either a CheckTrafficManagerRelativeDnsNameAvailabilityParameters type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
TrafficManagerNameAvailability. The TrafficManagerNameAvailability is compatible with MutableMapping |
Exceptions
| Type | Description |
|---|---|
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
CheckTrafficManagerRelativeDnsNameAvailabilityParameters or
IO[bytes]
The request body. Is either a CheckTrafficManagerRelativeDnsNameAvailabilityParameters type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
TrafficManagerNameAvailability. The TrafficManagerNameAvailability is compatible with MutableMapping |
Exceptions
| Type | Description |
|---|---|
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
|
The name of the resource group. The name is case insensitive. Required. |
|
profile_name
Required
|
The name of the Traffic Manager profile. Required. |
|
parameters
Required
|
The Traffic Manager profile parameters supplied to the CreateOrUpdate operation. Is either a Profile type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
Profile. The Profile is compatible with MutableMapping |
Exceptions
| Type | Description |
|---|---|
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
|
The name of the resource group. The name is case insensitive. Required. |
|
profile_name
Required
|
The name of the Traffic Manager profile. Required. |
Returns
| Type | Description |
|---|---|
|
DeleteOperationResult or None. The DeleteOperationResult is compatible with MutableMapping |
Exceptions
| Type | Description |
|---|---|
get
Gets a Traffic Manager profile.
get(resource_group_name: str, profile_name: str, **kwargs: Any) -> Profile
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
profile_name
Required
|
The name of the Traffic Manager profile. Required. |
Returns
| Type | Description |
|---|---|
|
Profile. The Profile is compatible with MutableMapping |
Exceptions
| Type | Description |
|---|---|
list_by_resource_group
Lists all Traffic Manager profiles within a resource group.
list_by_resource_group(resource_group_name: str, **kwargs: Any) -> ItemPaged[Profile]
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of Profile |
Exceptions
| Type | Description |
|---|---|
list_by_subscription
Lists all Traffic Manager profiles within a subscription.
list_by_subscription(**kwargs: Any) -> ItemPaged[Profile]
Returns
| Type | Description |
|---|---|
|
An iterator like instance of Profile |
Exceptions
| Type | Description |
|---|---|
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
|
The name of the resource group. The name is case insensitive. Required. |
|
profile_name
Required
|
The name of the Traffic Manager profile. Required. |
|
parameters
Required
|
The Traffic Manager profile parameters supplied to the Update operation. Is either a Profile type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
Profile. The Profile is compatible with MutableMapping |
Exceptions
| Type | Description |
|---|---|