Endpoints interface

Package:

@azure/arm-hybridconnectivity

Interface representing a Endpoints.

Methods

createOrUpdate(string, string, EndpointResource, EndpointsCreateOrUpdateOptionalParams)	Create or update the endpoint to the target resource.
delete(string, string, EndpointsDeleteOptionalParams)	Deletes the endpoint access to the target resource.
get(string, string, EndpointsGetOptionalParams)	Gets the endpoint to the resource.
list(string, EndpointsListOptionalParams)	List of endpoints to the target resource.
listCredentials(string, string, EndpointsListCredentialsOptionalParams)	Gets the endpoint access credentials to the resource.
listIngressGatewayCredentials(string, string, EndpointsListIngressGatewayCredentialsOptionalParams)	Gets the ingress gateway endpoint credentials
listManagedProxyDetails(string, string, ManagedProxyRequest, EndpointsListManagedProxyDetailsOptionalParams)	Fetches the managed proxy details
update(string, string, EndpointResource, EndpointsUpdateOptionalParams)	Update the endpoint to the target resource.

Method Details

createOrUpdate(string, string, EndpointResource, EndpointsCreateOrUpdateOptionalParams)

Create or update the endpoint to the target resource.

function createOrUpdate(resourceUri: string, endpointName: string, endpointResource: EndpointResource, options?: EndpointsCreateOrUpdateOptionalParams): Promise<EndpointResource>

Parameters

resourceUri

string

The fully qualified Azure Resource manager identifier of the resource to be connected.

endpointName

string

The endpoint name.

endpointResource

EndpointResource

Endpoint details

options

EndpointsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<EndpointResource>

delete(string, string, EndpointsDeleteOptionalParams)

Deletes the endpoint access to the target resource.

function delete(resourceUri: string, endpointName: string, options?: EndpointsDeleteOptionalParams): Promise<void>

Parameters

resourceUri

string

The fully qualified Azure Resource manager identifier of the resource to be connected.

endpointName

string

The endpoint name.

options

EndpointsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, EndpointsGetOptionalParams)

Gets the endpoint to the resource.

function get(resourceUri: string, endpointName: string, options?: EndpointsGetOptionalParams): Promise<EndpointResource>

Parameters

resourceUri

string

The fully qualified Azure Resource manager identifier of the resource to be connected.

endpointName

string

The endpoint name.

options

EndpointsGetOptionalParams

The options parameters.

Returns

Promise<EndpointResource>

list(string, EndpointsListOptionalParams)

List of endpoints to the target resource.

function list(resourceUri: string, options?: EndpointsListOptionalParams): PagedAsyncIterableIterator<EndpointResource, EndpointResource[], PageSettings>

Parameters

resourceUri

string

The fully qualified Azure Resource manager identifier of the resource to be connected.

options

EndpointsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<EndpointResource, EndpointResource[], PageSettings>

listCredentials(string, string, EndpointsListCredentialsOptionalParams)

Gets the endpoint access credentials to the resource.

function listCredentials(resourceUri: string, endpointName: string, options?: EndpointsListCredentialsOptionalParams): Promise<EndpointAccessResource>

Parameters

resourceUri

string

The fully qualified Azure Resource manager identifier of the resource to be connected.

endpointName

string

The endpoint name.

options

EndpointsListCredentialsOptionalParams

The options parameters.

Returns

Promise<EndpointAccessResource>

listIngressGatewayCredentials(string, string, EndpointsListIngressGatewayCredentialsOptionalParams)

Gets the ingress gateway endpoint credentials

function listIngressGatewayCredentials(resourceUri: string, endpointName: string, options?: EndpointsListIngressGatewayCredentialsOptionalParams): Promise<IngressGatewayResource>

Parameters

resourceUri

string

The fully qualified Azure Resource manager identifier of the resource to be connected.

endpointName

string

The endpoint name.

options

EndpointsListIngressGatewayCredentialsOptionalParams

The options parameters.

Returns

Promise<IngressGatewayResource>

listManagedProxyDetails(string, string, ManagedProxyRequest, EndpointsListManagedProxyDetailsOptionalParams)

Fetches the managed proxy details

function listManagedProxyDetails(resourceUri: string, endpointName: string, managedProxyRequest: ManagedProxyRequest, options?: EndpointsListManagedProxyDetailsOptionalParams): Promise<ManagedProxyResource>

Parameters

resourceUri

string

The fully qualified Azure Resource manager identifier of the resource to be connected.

endpointName

string

The endpoint name.

managedProxyRequest

ManagedProxyRequest

Object of type ManagedProxyRequest

options

EndpointsListManagedProxyDetailsOptionalParams

The options parameters.

Returns

Promise<ManagedProxyResource>

update(string, string, EndpointResource, EndpointsUpdateOptionalParams)

Update the endpoint to the target resource.

function update(resourceUri: string, endpointName: string, endpointResource: EndpointResource, options?: EndpointsUpdateOptionalParams): Promise<EndpointResource>

Parameters

resourceUri

string

The fully qualified Azure Resource manager identifier of the resource to be connected.

endpointName

string

The endpoint name.

endpointResource

EndpointResource

Endpoint details

options

EndpointsUpdateOptionalParams

The options parameters.

Returns

Promise<EndpointResource>