Namespace Interface

Package:

com.azure.resourcemanager.eventgrid.models

Maven Artifact:

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

public interface Namespace

An immutable client-side representation of Namespace.

Method Summary

Modifier and Type	Method and Description
abstract String	id() Gets the id property: Fully qualified resource Id for the resource.
abstract IdentityInfo	identity() Gets the identity property: Identity information for the Namespace resource.
abstract List<InboundIpRule>	inboundIpRules() Gets the inboundIpRules property: This can be used to restrict traffic from specific IPs instead of all IPs.
abstract NamespaceInner	innerModel() Gets the inner com.azure.resourcemanager.eventgrid.fluent.models.NamespaceInner object.
abstract Boolean	isZoneRedundant() Gets the isZoneRedundant property: This is an optional property and it allows the user to specify if the namespace resource supports zone-redundancy capability or not.
abstract NamespaceSharedAccessKeys	listSharedAccessKeys() List keys for a namespace.
abstract Response<NamespaceSharedAccessKeys>	listSharedAccessKeysWithResponse(Context context) List keys for a 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 namespace.
abstract String	name() Gets the name property: The name of the resource.
abstract List<PrivateEndpointConnection>	privateEndpointConnections() Gets the privateEndpointConnections property: List of private endpoint connections.
abstract NamespaceProvisioningState	provisioningState() Gets the provisioningState property: Provisioning state of the namespace resource.
abstract PublicNetworkAccess	publicNetworkAccess() Gets the publicNetworkAccess property: This determines if traffic is allowed over public network.
abstract Namespace	refresh() Refreshes the resource to sync with Azure.
abstract Namespace	refresh(Context context) Refreshes the resource to sync with Azure.
abstract NamespaceSharedAccessKeys	regenerateKey(NamespaceRegenerateKeyRequest regenerateKeyRequest) Regenerate key for a namespace.
abstract NamespaceSharedAccessKeys	regenerateKey(NamespaceRegenerateKeyRequest regenerateKeyRequest, Context context) Regenerate key for a 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 NamespaceSku	sku() Gets the sku property: Represents available Sku pricing tiers.
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 TopicsConfiguration	topicsConfiguration() Gets the topicsConfiguration property: Topics configuration information for the namespace resource.
abstract TopicSpacesConfiguration	topicSpacesConfiguration() Gets the topicSpacesConfiguration property: Topic spaces configuration information for the namespace resource.
abstract String	type() Gets the type property: The type of the resource.
abstract Update	update() Begins update for the Namespace resource.
abstract CustomDomainOwnershipValidationResult	validateCustomDomainOwnership() Validate ownership for all custom domains in a namespace.
abstract CustomDomainOwnershipValidationResult	validateCustomDomainOwnership(Context context) Validate ownership for all custom domains in a namespace.

Method Details

id

public abstract String id()

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

Returns:

the id value.

identity

public abstract IdentityInfo identity()

Gets the identity property: Identity information for the Namespace resource.

Returns:

the identity 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 NamespaceInner innerModel()

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

Returns:

the inner object.

isZoneRedundant

public abstract Boolean isZoneRedundant()

Gets the isZoneRedundant property: This is an optional property and it allows the user to specify if the namespace resource supports zone-redundancy capability or not. If this property is not specified explicitly by the user, its default value depends on the following conditions: a. For Availability Zones enabled regions - The default property value would be true. b. For non-Availability Zones enabled regions - The default property value would be false. Once specified, this property cannot be updated.

Returns:

the isZoneRedundant value.

listSharedAccessKeys

public abstract NamespaceSharedAccessKeys listSharedAccessKeys()

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

Returns:

shared access keys of the Namespace.

listSharedAccessKeysWithResponse

public abstract Response<NamespaceSharedAccessKeys> listSharedAccessKeysWithResponse(Context context)

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

Parameters:

context - The context to associate with this operation.

Returns:

shared access keys of the 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 namespace. Only TLS version 1.2 is supported.

Returns:

the minimumTlsVersionAllowed value.

name

public abstract String name()

Gets the name property: The name of the resource.

Returns:

the name value.

privateEndpointConnections

public abstract List<PrivateEndpointConnection> privateEndpointConnections()

Gets the privateEndpointConnections property: List of private endpoint connections.

Returns:

the privateEndpointConnections value.

provisioningState

public abstract NamespaceProvisioningState provisioningState()

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

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.PubSub.NamespaceProperties.InboundIpRules" />.

Returns:

the publicNetworkAccess value.

refresh

public abstract Namespace refresh()

Refreshes the resource to sync with Azure.

Returns:

the refreshed resource.

refresh

public abstract Namespace 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 NamespaceSharedAccessKeys regenerateKey(NamespaceRegenerateKeyRequest regenerateKeyRequest)

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

Parameters:

regenerateKeyRequest - Request body to regenerate key.

Returns:

shared access keys of the Namespace.

regenerateKey

public abstract NamespaceSharedAccessKeys regenerateKey(NamespaceRegenerateKeyRequest regenerateKeyRequest, Context context)

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

Parameters:

regenerateKeyRequest - Request body to regenerate key.

context - The context to associate with this operation.

Returns:

shared access keys of the Namespace.

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.

sku

public abstract NamespaceSku sku()

Gets the sku property: Represents available Sku pricing tiers.

Returns:

the sku value.

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.

topicsConfiguration

public abstract TopicsConfiguration topicsConfiguration()

Gets the topicsConfiguration property: Topics configuration information for the namespace resource.

Returns:

the topicsConfiguration value.

topicSpacesConfiguration

public abstract TopicSpacesConfiguration topicSpacesConfiguration()

Gets the topicSpacesConfiguration property: Topic spaces configuration information for the namespace resource.

Returns:

the topicSpacesConfiguration value.

type

public abstract String type()

Gets the type property: The type of the resource.

Returns:

the type value.

update

public abstract Namespace.Update update()

Begins update for the Namespace resource.

Returns:

the stage of resource update.

validateCustomDomainOwnership

public abstract CustomDomainOwnershipValidationResult validateCustomDomainOwnership()

Validate ownership for all custom domains in a namespace. Performs ownership validation via checking TXT records for all custom domains in a namespace.

Returns:

namespace custom domain ownership validation result.

validateCustomDomainOwnership

public abstract CustomDomainOwnershipValidationResult validateCustomDomainOwnership(Context context)

Validate ownership for all custom domains in a namespace. Performs ownership validation via checking TXT records for all custom domains in a namespace.

Parameters:

context - The context to associate with this operation.

Returns:

namespace custom domain ownership validation result.