Partner Namespaces - Update

Update a partner namespace.
Asynchronously updates a partner namespace with the specified parameters.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}?api-version=2022-06-15

URI Parameters

Name In Required Type Description
partnerNamespaceName
path True

string

Name of the partner namespace.

resourceGroupName
path True

string

The name of the resource group within the user's subscription.

subscriptionId
path True

string

Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

api-version
query True

string

Version of the API to be used with the client request.

Request Body

Name Type Description
properties.disableLocalAuth

boolean

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.

properties.inboundIpRules

InboundIpRule[]

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

properties.publicNetworkAccess

PublicNetworkAccess

This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring

tags

object

Tags of the Partner Namespace.

Responses

Name Type Description
200 OK

OK

201 Created

PartnerNamespace

Partner namespace update request accepted.

Other Status Codes

*** Error Responses: ***

  • 400 Bad Request.

  • 500 Internal Server Error.

Examples

PartnerNamespaces_Update

Sample request

PATCH https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerNamespaces/examplePartnerNamespaceName1?api-version=2022-06-15

{
  "tags": {
    "tag1": "value1"
  }
}

Sample response

{
  "properties": {
    "provisioningState": "Succeeded",
    "partnerRegistrationFullyQualifiedId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerRegistrations/ContosoCorpAccount1",
    "endpoint": "https://examplePartnerNamespaceName1.centraluseuap-1.eventgrid.azure.net/api/events"
  },
  "location": "Central US EUAP",
  "tags": {
    "key1": "value1"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerNamespaces/examplePartnerNamespaceName1",
  "name": "examplePartnerNamespaceName1",
  "type": "Microsoft.EventGrid/partnerNamespaces"
}

Definitions

Name Description
ConnectionState

ConnectionState information.

createdByType

The type of identity that created the resource.

InboundIpRule
IpActionType

Action to perform based on the match or no match of the IpMask.

PartnerNamespace

EventGrid Partner Namespace.

PartnerNamespaceProvisioningState

Provisioning state of the partner namespace.

PartnerNamespaceUpdateParameters

Properties of the Partner Namespace update.

PartnerTopicRoutingMode

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.

PersistedConnectionStatus

Status of the connection.

PrivateEndpoint

PrivateEndpoint information.

PrivateEndpointConnection
PublicNetworkAccess

This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring

ResourceProvisioningState

Provisioning state of the Private Endpoint Connection.

systemData

Metadata pertaining to creation and last modification of the resource.

ConnectionState

ConnectionState information.

Name Type Description
actionsRequired

string

Actions required (if any).

description

string

Description of the connection state.

status

PersistedConnectionStatus

Status of the connection.

createdByType

The type of identity that created the resource.

Name Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

InboundIpRule

Name Type Description
action

IpActionType

Action to perform based on the match or no match of the IpMask.

ipMask

string

IP Address in CIDR notation e.g., 10.0.0.0/8.

IpActionType

Action to perform based on the match or no match of the IpMask.

Name Type Description
Allow

string

PartnerNamespace

EventGrid Partner Namespace.

Name Type Default value Description
id

string

Fully qualified identifier of the resource.

location

string

Location of the resource.

name

string

Name of the resource.

properties.disableLocalAuth

boolean

False

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.

properties.endpoint

string

Endpoint for the partner namespace.

properties.inboundIpRules

InboundIpRule[]

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

properties.partnerRegistrationFullyQualifiedId

string

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}.

properties.partnerTopicRoutingMode

PartnerTopicRoutingMode

SourceEventAttribute

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.

properties.privateEndpointConnections

PrivateEndpointConnection[]

properties.provisioningState

PartnerNamespaceProvisioningState

Provisioning state of the partner namespace.

properties.publicNetworkAccess

PublicNetworkAccess

Enabled

This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring

systemData

systemData

The system metadata relating to Partner Namespace resource.

tags

object

Tags of the resource.

type

string

Type of the resource.

PartnerNamespaceProvisioningState

Provisioning state of the partner namespace.

Name Type Description
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

PartnerNamespaceUpdateParameters

Properties of the Partner Namespace update.

Name Type Default value Description
properties.disableLocalAuth

boolean

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.

properties.inboundIpRules

InboundIpRule[]

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

properties.publicNetworkAccess

PublicNetworkAccess

Enabled

This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring

tags

object

Tags of the Partner Namespace.

PartnerTopicRoutingMode

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.

Name Type Description
ChannelNameHeader

string

SourceEventAttribute

string

PersistedConnectionStatus

Status of the connection.

Name Type Description
Approved

string

Disconnected

string

Pending

string

Rejected

string

PrivateEndpoint

PrivateEndpoint information.

Name Type Description
id

string

The ARM identifier for Private Endpoint.

PrivateEndpointConnection

Name Type Description
id

string

Fully qualified identifier of the resource.

name

string

Name of the resource.

properties.groupIds

string[]

GroupIds from the private link service resource.

properties.privateEndpoint

PrivateEndpoint

The Private Endpoint resource for this Connection.

properties.privateLinkServiceConnectionState

ConnectionState

Details about the state of the connection.

properties.provisioningState

ResourceProvisioningState

Provisioning state of the Private Endpoint Connection.

type

string

Type of the resource.

PublicNetworkAccess

This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring

Name Type Description
Disabled

string

Enabled

string

ResourceProvisioningState

Provisioning state of the Private Endpoint Connection.

Name Type Description
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

systemData

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string

The timestamp of resource creation (UTC).

createdBy

string

The identity that created the resource.

createdByType

createdByType

The type of identity that created the resource.

lastModifiedAt

string

The timestamp of resource last modification (UTC)

lastModifiedBy

string

The identity that last modified the resource.

lastModifiedByType

createdByType

The type of identity that last modified the resource.