Package version:

Interface Endpoints

Interface representing a Endpoints.

Hierarchy

Endpoints

Index

Methods

createOrUpdate delete get update

Methods

createOrUpdate

createOrUpdate(resourceGroupName: string, profileName: string, endpointType: EndpointType, endpointName: string, parameters: Endpoint, options?: EndpointsCreateOrUpdateOptionalParams): Promise<Endpoint>
Create or update a Traffic Manager endpoint.
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- profileName: string
  
  The name of the Traffic Manager profile.
- endpointType: EndpointType
  
  The type of the Traffic Manager endpoint to be created or updated.
- endpointName: string
  
  The name of the Traffic Manager endpoint to be created or updated.
- parameters: Endpoint
  
  The Traffic Manager endpoint parameters supplied to the CreateOrUpdate operation.
- Optional options: EndpointsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<Endpoint>
- Defined in operationsInterfaces/endpoints.ts:65

delete

delete(resourceGroupName: string, profileName: string, endpointType: EndpointType, endpointName: string, options?: EndpointsDeleteOptionalParams): Promise<DeleteOperationResult>
Deletes a Traffic Manager endpoint.
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- profileName: string
  
  The name of the Traffic Manager profile.
- endpointType: EndpointType
  
  The type of the Traffic Manager endpoint to be deleted.
- endpointName: string
  
  The name of the Traffic Manager endpoint to be deleted.
- Optional options: EndpointsDeleteOptionalParams
  
  The options parameters.
Returns Promise<DeleteOperationResult>
- Defined in operationsInterfaces/endpoints.ts:81

get

get(resourceGroupName: string, profileName: string, endpointType: EndpointType, endpointName: string, options?: EndpointsGetOptionalParams): Promise<Endpoint>
Gets a Traffic Manager endpoint.
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- profileName: string
  
  The name of the Traffic Manager profile.
- endpointType: EndpointType
  
  The type of the Traffic Manager endpoint.
- endpointName: string
  
  The name of the Traffic Manager endpoint.
- Optional options: EndpointsGetOptionalParams
  
  The options parameters.
Returns Promise<Endpoint>
- Defined in operationsInterfaces/endpoints.ts:49

update

update(resourceGroupName: string, profileName: string, endpointType: EndpointType, endpointName: string, parameters: Endpoint, options?: EndpointsUpdateOptionalParams): Promise<Endpoint>
Update a Traffic Manager endpoint.
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- profileName: string
  
  The name of the Traffic Manager profile.
- endpointType: EndpointType
  
  The type of the Traffic Manager endpoint to be updated.
- endpointName: string
  
  The name of the Traffic Manager endpoint to be updated.
- parameters: Endpoint
  
  The Traffic Manager endpoint parameters supplied to the Update operation.
- Optional options: EndpointsUpdateOptionalParams
  
  The options parameters.
Returns Promise<Endpoint>
- Defined in operationsInterfaces/endpoints.ts:33

Interface Endpoints

Hierarchy

Index

Methods

Methods

createOrUpdate

Parameters

resourceGroupName: string

profileName: string

endpointType: EndpointType

endpointName: string

parameters: Endpoint

Optional options: EndpointsCreateOrUpdateOptionalParams

Returns Promise<Endpoint>

delete

Parameters

resourceGroupName: string

profileName: string

endpointType: EndpointType

endpointName: string

Optional options: EndpointsDeleteOptionalParams

Returns Promise<DeleteOperationResult>

get

Parameters

resourceGroupName: string

profileName: string

endpointType: EndpointType

endpointName: string

Optional options: EndpointsGetOptionalParams

Returns Promise<Endpoint>

update

Parameters

resourceGroupName: string

profileName: string

endpointType: EndpointType

endpointName: string

parameters: Endpoint

Optional options: EndpointsUpdateOptionalParams

Returns Promise<Endpoint>

Settings

Member Visibility

Theme

`Optional` options: EndpointsCreateOrUpdateOptionalParams

`Optional` options: EndpointsDeleteOptionalParams

`Optional` options: EndpointsGetOptionalParams

`Optional` options: EndpointsUpdateOptionalParams