PartnerNamespace Interface

Package:

com.azure.resourcemanager.eventgrid.models

Maven Artifact:

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

public interface PartnerNamespace

An immutable client-side representation of PartnerNamespace.

Method Summary

Modifier and Type	Method and Description
abstract Boolean	disableLocalAuth() Gets the disableLocalAuth property: This boolean is used to enable or disable local auth.
abstract String	endpoint() Gets the endpoint property: Endpoint for the partner namespace.
abstract String	id() Gets the id property: Fully qualified resource Id for the resource.
abstract List<InboundIpRule>	inboundIpRules() Gets the inboundIpRules property: This can be used to restrict traffic from specific IPs instead of all IPs.
abstract PartnerNamespaceInner	innerModel() Gets the inner com.azure.resourcemanager.eventgrid.fluent.models.PartnerNamespaceInner object.
abstract PartnerNamespaceSharedAccessKeys	listSharedAccessKeys() List keys for a partner namespace.
abstract Response<PartnerNamespaceSharedAccessKeys>	listSharedAccessKeysWithResponse(Context context) List keys for a partner namespace.
abstract String	location() Gets the location property: The geo-location where the resource lives.
abstract TlsVersion	minimumTlsVersionAllowed() Gets the minimumTlsVersionAllowed property: Minimum TLS version of the publisher allowed to publish to this partner namespace.
abstract String	name() Gets the name property: The name of the resource.
abstract String	partnerRegistrationFullyQualifiedId() Gets the partnerRegistrationFullyQualifiedId property: The fully qualified ARM Id of the partner registration that should be associated with this partner namespace.
abstract PartnerTopicRoutingMode	partnerTopicRoutingMode() Gets the partnerTopicRoutingMode property: This determines if events published to this partner namespace should use the source attribute in the event payload or use the channel name in the header when matching to the partner topic.
abstract List<PrivateEndpointConnection>	privateEndpointConnections() Gets the privateEndpointConnections property: List of private endpoint connections.
abstract PartnerNamespaceProvisioningState	provisioningState() Gets the provisioningState property: Provisioning state of the partner namespace.
abstract PublicNetworkAccess	publicNetworkAccess() Gets the publicNetworkAccess property: This determines if traffic is allowed over public network.
abstract PartnerNamespace	refresh() Refreshes the resource to sync with Azure.
abstract PartnerNamespace	refresh(Context context) Refreshes the resource to sync with Azure.
abstract PartnerNamespaceSharedAccessKeys	regenerateKey(PartnerNamespaceRegenerateKeyRequest regenerateKeyRequest) Regenerate key for a partner namespace.
abstract Response<PartnerNamespaceSharedAccessKeys>	regenerateKeyWithResponse(PartnerNamespaceRegenerateKeyRequest regenerateKeyRequest, Context context) Regenerate key for a partner namespace.
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 PartnerNamespace resource.

Method Details

disableLocalAuth

public abstract Boolean disableLocalAuth()

Gets the disableLocalAuth property: This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only Microsoft Entra ID token will be used to authenticate if user is allowed to publish to the partner namespace.

Returns:

the disableLocalAuth value.

endpoint

public abstract String endpoint()

Gets the endpoint property: Endpoint for the partner namespace.

Returns:

the endpoint value.

id

public abstract String id()

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

Returns:

the id value.

inboundIpRules

public abstract List<InboundIpRule> inboundIpRules()

Gets the inboundIpRules property: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.

Returns:

the inboundIpRules value.

innerModel

public abstract PartnerNamespaceInner innerModel()

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

Returns:

the inner object.

listSharedAccessKeys

public abstract PartnerNamespaceSharedAccessKeys listSharedAccessKeys()

List keys for a partner namespace. List the two keys used to publish to a partner namespace.

Returns:

shared access keys of the partner namespace.

listSharedAccessKeysWithResponse

public abstract Response<PartnerNamespaceSharedAccessKeys> listSharedAccessKeysWithResponse(Context context)

List keys for a partner namespace. List the two keys used to publish to a partner namespace.

Parameters:

context - The context to associate with this operation.

Returns:

shared access keys of the partner namespace along with Response<T>.

location

public abstract String location()

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

Returns:

the location value.

minimumTlsVersionAllowed

public abstract TlsVersion minimumTlsVersionAllowed()

Gets the minimumTlsVersionAllowed property: Minimum TLS version of the publisher allowed to publish to this partner namespace.

Returns:

the minimumTlsVersionAllowed value.

name

public abstract String name()

Gets the name property: The name of the resource.

Returns:

the name value.

partnerRegistrationFullyQualifiedId

public abstract String partnerRegistrationFullyQualifiedId()

Gets the partnerRegistrationFullyQualifiedId property: The fully qualified ARM Id of the partner registration that should be associated with this partner namespace. This takes the following format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}.

Returns:

the partnerRegistrationFullyQualifiedId value.

partnerTopicRoutingMode

public abstract PartnerTopicRoutingMode partnerTopicRoutingMode()

Gets the partnerTopicRoutingMode property: This determines if events published to this partner namespace should use the source attribute in the event payload or use the channel name in the header when matching to the partner topic. If none is specified, source attribute routing will be used to match the partner topic.

Returns:

the partnerTopicRoutingMode value.

privateEndpointConnections

public abstract List<PrivateEndpointConnection> privateEndpointConnections()

Gets the privateEndpointConnections property: List of private endpoint connections.

Returns:

the privateEndpointConnections value.

provisioningState

public abstract PartnerNamespaceProvisioningState provisioningState()

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

Returns:

the provisioningState value.

publicNetworkAccess

public abstract PublicNetworkAccess publicNetworkAccess()

Gets the publicNetworkAccess property: This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.PartnerNamespaceProperties.InboundIpRules" />.

Returns:

the publicNetworkAccess value.

refresh

public abstract PartnerNamespace refresh()

Refreshes the resource to sync with Azure.

Returns:

the refreshed resource.

refresh

public abstract PartnerNamespace refresh(Context context)

Refreshes the resource to sync with Azure.

Parameters:

context - The context to associate with this operation.

Returns:

the refreshed resource.

regenerateKey

public abstract PartnerNamespaceSharedAccessKeys regenerateKey(PartnerNamespaceRegenerateKeyRequest regenerateKeyRequest)

Regenerate key for a partner namespace. Regenerate a shared access key for a partner namespace.

Parameters:

regenerateKeyRequest - Request body to regenerate key.

Returns:

shared access keys of the partner namespace.

regenerateKeyWithResponse

public abstract Response<PartnerNamespaceSharedAccessKeys> regenerateKeyWithResponse(PartnerNamespaceRegenerateKeyRequest regenerateKeyRequest, Context context)

Regenerate key for a partner namespace. Regenerate a shared access key for a partner namespace.

Parameters:

regenerateKeyRequest - Request body to regenerate key.

context - The context to associate with this operation.

Returns:

shared access keys of the partner namespace along with Response<T>.

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 PartnerNamespace.Update update()

Begins update for the PartnerNamespace resource.

Returns:

the stage of resource update.