PartnerDestination Interface

Package:

com.azure.resourcemanager.eventgrid.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-eventgrid:1.3.0-beta.1

public interface PartnerDestination

An immutable client-side representation of PartnerDestination.

Method Summary

Modifier and Type	Method and Description
abstract PartnerDestination	activate() Activate a partner destination.
abstract Response<PartnerDestination>	activateWithResponse(Context context) Activate a partner destination.
abstract PartnerDestinationActivationState	activationState() Gets the activationState property: Activation state of the partner destination.
abstract String	endpointBaseUrl() Gets the endpointBaseUrl property: Endpoint Base URL of the partner destination.
abstract String	endpointServiceContext() Gets the endpointServiceContext property: Endpoint context associated with this partner destination.
abstract OffsetDateTime	expirationTimeIfNotActivatedUtc() Gets the expirationTimeIfNotActivatedUtc property: Expiration time of the partner destination.
abstract String	id() Gets the id property: Fully qualified resource Id for the resource.
abstract PartnerDestinationInner	innerModel() Gets the inner com.azure.resourcemanager.eventgrid.fluent.models.PartnerDestinationInner object.
abstract String	location() Gets the location property: The geo-location where the resource lives.
abstract String	messageForActivation() Gets the messageForActivation property: Context or helpful message that can be used during the approval process.
abstract String	name() Gets the name property: The name of the resource.
abstract UUID	partnerRegistrationImmutableId() Gets the partnerRegistrationImmutableId property: The immutable Id of the corresponding partner registration.
abstract PartnerDestinationProvisioningState	provisioningState() Gets the provisioningState property: Provisioning state of the partner destination.
abstract PartnerDestination	refresh() Refreshes the resource to sync with Azure.
abstract PartnerDestination	refresh(Context context) Refreshes the resource to sync with Azure.
abstract Region	region() Gets the region of the resource.
abstract String	regionName() Gets the name of the resource region.
abstract String	resourceGroupName() Gets the name of the resource group.
abstract SystemData	systemData() Gets the systemData property: The system metadata relating to the Event Grid resource.
abstract Map<String,String>	tags() Gets the tags property: Resource tags.
abstract String	type() Gets the type property: The type of the resource.
abstract Update	update() Begins update for the PartnerDestination resource.

Method Details

activate

public abstract PartnerDestination activate()

Activate a partner destination. Activate a newly created partner destination.

Returns:

event Grid Partner Destination.

activateWithResponse

public abstract Response<PartnerDestination> activateWithResponse(Context context)

Activate a partner destination. Activate a newly created partner destination.

Parameters:

context - The context to associate with this operation.

Returns:

event Grid Partner Destination along with Response<T>.

activationState

public abstract PartnerDestinationActivationState activationState()

Gets the activationState property: Activation state of the partner destination.

Returns:

the activationState value.

endpointBaseUrl

public abstract String endpointBaseUrl()

Gets the endpointBaseUrl property: Endpoint Base URL of the partner destination.

Returns:

the endpointBaseUrl value.

endpointServiceContext

public abstract String endpointServiceContext()

Gets the endpointServiceContext property: Endpoint context associated with this partner destination.

Returns:

the endpointServiceContext value.

expirationTimeIfNotActivatedUtc

public abstract OffsetDateTime expirationTimeIfNotActivatedUtc()

Gets the expirationTimeIfNotActivatedUtc property: Expiration time of the partner destination. If this timer expires and the partner destination was never activated, the partner destination and corresponding channel are deleted.

Returns:

the expirationTimeIfNotActivatedUtc value.

id

public abstract String id()

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

Returns:

the id value.

innerModel

public abstract PartnerDestinationInner innerModel()

Gets the inner com.azure.resourcemanager.eventgrid.fluent.models.PartnerDestinationInner object.

Returns:

the inner object.

location

public abstract String location()

Gets the location property: The geo-location where the resource lives.

Returns:

the location value.

messageForActivation

public abstract String messageForActivation()

Gets the messageForActivation property: Context or helpful message that can be used during the approval process.

Returns:

the messageForActivation value.

name

public abstract String name()

Gets the name property: The name of the resource.

Returns:

the name value.

partnerRegistrationImmutableId

public abstract UUID partnerRegistrationImmutableId()

Gets the partnerRegistrationImmutableId property: The immutable Id of the corresponding partner registration.

Returns:

the partnerRegistrationImmutableId value.

provisioningState

public abstract PartnerDestinationProvisioningState provisioningState()

Gets the provisioningState property: Provisioning state of the partner destination.

Returns:

the provisioningState value.

refresh

public abstract PartnerDestination refresh()

Refreshes the resource to sync with Azure.

Returns:

the refreshed resource.

refresh

public abstract PartnerDestination refresh(Context context)

Refreshes the resource to sync with Azure.

Parameters:

context - The context to associate with this operation.

Returns:

the refreshed resource.

region

public abstract Region region()

Gets the region of the resource.

Returns:

the region of the resource.

regionName

public abstract String regionName()

Gets the name of the resource region.

Returns:

the name of the resource region.

resourceGroupName

public abstract String resourceGroupName()

Gets the name of the resource group.

Returns:

the name of the resource group.

systemData

public abstract SystemData systemData()

Gets the systemData property: The system metadata relating to the Event Grid resource.

Returns:

the systemData value.

tags

public abstract Map<String,String> tags()

Gets the tags property: Resource tags.

Returns:

the tags value.

type

public abstract String type()

Gets the type property: The type of the resource.

Returns:

the type value.

update

public abstract PartnerDestination.Update update()

Begins update for the PartnerDestination resource.

Returns:

the stage of resource update.