Package com.azure.resourcemanager.eventgrid.models

Interface PartnerNamespace

public interface PartnerNamespace
An immutable client-side representation of PartnerNamespace.

  • Method Details

    • id

      String id()
      Gets the id property: Fully qualified resource Id for the resource.
      Returns:
      the id value.

    • name

      String name()
      Gets the name property: The name of the resource.
      Returns:
      the name value.

    • type

      String type()
      Gets the type property: The type of the resource.
      Returns:
      the type value.

    • location

      String location()
      Gets the location property: The geo-location where the resource lives.
      Returns:
      the location value.

    • tags

      Map<String,String> tags()
      Gets the tags property: Resource tags.
      Returns:
      the tags value.

    • systemData

      com.azure.core.management.SystemData systemData()
      Gets the systemData property: The system metadata relating to Partner Namespace resource.
      Returns:
      the systemData value.

    • privateEndpointConnections

      List<PrivateEndpointConnection> privateEndpointConnections()
      Gets the privateEndpointConnections property: The privateEndpointConnections property.
      Returns:
      the privateEndpointConnections value.

    • provisioningState

      PartnerNamespaceProvisioningState provisioningState()
      Gets the provisioningState property: Provisioning state of the partner namespace.
      Returns:
      the provisioningState value.

    • partnerRegistrationFullyQualifiedId

      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.

    • endpoint

      String endpoint()
      Gets the endpoint property: Endpoint for the partner namespace.
      Returns:
      the endpoint value.

    • publicNetworkAccess

      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.

    • inboundIpRules

      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.

    • disableLocalAuth

      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 AAD token will be used to authenticate if user is allowed to publish to the partner namespace.
      Returns:
      the disableLocalAuth value.

    • partnerTopicRoutingMode

      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.

    • region

      com.azure.core.management.Region region()
      Gets the region of the resource.
      Returns:
      the region of the resource.

    • regionName

      String regionName()
      Gets the name of the resource region.
      Returns:
      the name of the resource region.

    • resourceGroupName

      String resourceGroupName()
      Gets the name of the resource group.
      Returns:
      the name of the resource group.

    • innerModel

      PartnerNamespaceInner innerModel()
      Gets the inner com.azure.resourcemanager.eventgrid.fluent.models.PartnerNamespaceInner object.
      Returns:
      the inner object.

    • update

      PartnerNamespace.Update update()
      Begins update for the PartnerNamespace resource.
      Returns:
      the stage of resource update.

    • refresh

      PartnerNamespace refresh()
      Refreshes the resource to sync with Azure.
      Returns:
      the refreshed resource.

    • refresh

      PartnerNamespace refresh(com.azure.core.util.Context context)
      Refreshes the resource to sync with Azure.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the refreshed resource.

    • listSharedAccessKeys

      PartnerNamespaceSharedAccessKeys listSharedAccessKeys()
      List the two keys used to publish to a partner namespace.
      Returns:
      shared access keys of the partner namespace.
      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listSharedAccessKeysWithResponse

      com.azure.core.http.rest.Response<PartnerNamespaceSharedAccessKeys> listSharedAccessKeysWithResponse(com.azure.core.util.Context context)
      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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • regenerateKey

      PartnerNamespaceSharedAccessKeys regenerateKey(PartnerNamespaceRegenerateKeyRequest regenerateKeyRequest)
      Regenerate a shared access key for a partner namespace.
      Parameters:
      regenerateKeyRequest - Request body to regenerate key.
      Returns:
      shared access keys of the partner namespace.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • regenerateKeyWithResponse

      com.azure.core.http.rest.Response<PartnerNamespaceSharedAccessKeys> regenerateKeyWithResponse(PartnerNamespaceRegenerateKeyRequest regenerateKeyRequest, com.azure.core.util.Context context)
      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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.