BackendContract Interface

Package:

com.azure.resourcemanager.apimanagement.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-apimanagement:1.0.0-beta.4

public interface BackendContract

An immutable client-side representation of BackendContract.

Method Summary

Modifier and Type	Method and Description
abstract BackendCredentialsContract	credentials() Gets the credentials property: Backend Credentials Contract Properties.
abstract String	description() Gets the description property: Backend Description.
abstract String	id() Gets the id property: Fully qualified resource Id for the resource.
abstract BackendContractInner	innerModel() Gets the inner com.azure.resourcemanager.apimanagement.fluent.models.BackendContractInner object.
abstract String	name() Gets the name property: The name of the resource.
abstract BackendProperties	properties() Gets the properties property: Backend Properties contract.
abstract BackendProtocol	protocol() Gets the protocol property: Backend communication protocol.
abstract BackendProxyContract	proxy() Gets the proxy property: Backend gateway Contract Properties.
abstract void	reconnect() Notifies the API Management gateway to create a new connection to the backend after the specified timeout.
abstract Response<Void>	reconnectWithResponse(BackendReconnectContract parameters, Context context) Notifies the API Management gateway to create a new connection to the backend after the specified timeout.
abstract BackendContract	refresh() Refreshes the resource to sync with Azure.
abstract BackendContract	refresh(Context context) Refreshes the resource to sync with Azure.
abstract String	resourceGroupName() Gets the name of the resource group.
abstract String	resourceId() Gets the resourceId property: Management Uri of the Resource in External System.
abstract String	title() Gets the title property: Backend Title.
abstract BackendTlsProperties	tls() Gets the tls property: Backend TLS Properties.
abstract String	type() Gets the type property: The type of the resource.
abstract Update	update() Begins update for the BackendContract resource.
abstract String	url() Gets the url property: Runtime Url of the Backend.

Method Details

credentials

public abstract BackendCredentialsContract credentials()

Gets the credentials property: Backend Credentials Contract Properties.

Returns:

the credentials value.

description

public abstract String description()

Gets the description property: Backend Description.

Returns:

the description value.

id

public abstract String id()

Gets the id property: Fully qualified resource Id for the resource.

Returns:

the id value.

innerModel

public abstract BackendContractInner innerModel()

Gets the inner com.azure.resourcemanager.apimanagement.fluent.models.BackendContractInner object.

Returns:

the inner object.

name

public abstract String name()

Gets the name property: The name of the resource.

Returns:

the name value.

properties

public abstract BackendProperties properties()

Gets the properties property: Backend Properties contract.

Returns:

the properties value.

protocol

public abstract BackendProtocol protocol()

Gets the protocol property: Backend communication protocol.

Returns:

the protocol value.

proxy

public abstract BackendProxyContract proxy()

Gets the proxy property: Backend gateway Contract Properties.

Returns:

the proxy value.

reconnect

public abstract void reconnect()

Notifies the API Management gateway to create a new connection to the backend after the specified timeout. If no timeout was specified, timeout of 2 minutes is used.

reconnectWithResponse

public abstract Response reconnectWithResponse(BackendReconnectContract parameters, Context context)

Notifies the API Management gateway to create a new connection to the backend after the specified timeout. If no timeout was specified, timeout of 2 minutes is used.

Parameters:

parameters - Reconnect request parameters.

context - The context to associate with this operation.

Returns:

the Response<T>.

refresh

public abstract BackendContract refresh()

Refreshes the resource to sync with Azure.

Returns:

the refreshed resource.

refresh

public abstract BackendContract refresh(Context context)

Refreshes the resource to sync with Azure.

Parameters:

context - The context to associate with this operation.

Returns:

the refreshed resource.

resourceGroupName

public abstract String resourceGroupName()

Gets the name of the resource group.

Returns:

the name of the resource group.

resourceId

public abstract String resourceId()

Gets the resourceId property: Management Uri of the Resource in External System. This URL can be the Arm Resource Id of Logic Apps, Function Apps or API Apps.

Returns:

the resourceId value.

title

public abstract String title()

Gets the title property: Backend Title.

Returns:

the title value.

tls

public abstract BackendTlsProperties tls()

Gets the tls property: Backend TLS Properties.

Returns:

the tls value.

type

public abstract String type()

Gets the type property: The type of the resource.

Returns:

the type value.

update

public abstract BackendContract.Update update()

Begins update for the BackendContract resource.

Returns:

the stage of resource update.

url

public abstract String url()

Gets the url property: Runtime Url of the Backend.

Returns:

the url value.