Namespaces - Update
更新命名空间。
使用指定的参数异步更新命名空间。
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}?api-version=2025-02-15
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
namespace
|
path | True |
string minLength: 3maxLength: 50 pattern: ^[a-zA-Z0-9-]*$ |
命名空间的名称。 |
resource
|
path | True |
string |
用户订阅中的资源组的名称。 |
subscription
|
path | True |
string |
唯一标识Microsoft Azure 订阅的订阅凭据。 订阅 ID 构成了每个服务调用的 URI 的一部分。 |
api-version
|
query | True |
string |
要用于客户端请求的 API 的版本。 |
请求正文
名称 | 类型 | 说明 |
---|---|---|
identity |
命名空间资源标识信息。 |
|
properties.inboundIpRules |
这可用于限制来自特定 IP 而不是所有 IP 的流量。 注意:仅当启用了 PublicNetworkAccess 时,才会考虑这些内容。 |
|
properties.publicNetworkAccess |
这决定了是否允许通过公用网络流量。 默认情况下,它处于启用状态。 可以通过配置进一步限制为特定 IP |
|
properties.topicSpacesConfiguration |
可更新的主题空间配置属性。 |
|
properties.topicsConfiguration |
可更新的主题配置属性。 |
|
sku |
表示可用的 Sku 定价层。 |
|
tags |
object |
命名空间资源的标记。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
还行 |
|
202 Accepted |
已接受命名空间更新请求。 标头 Location: string |
|
Other Status Codes |
如果请求失败,则返回错误响应。 |
示例
Namespaces_Update
示例请求
示例响应
{
"properties": {
"provisioningState": "Succeeded",
"topicSpacesConfiguration": {
"state": "Enabled",
"routeTopicResourceId": "/subscriptions/8f6b6269-84f2-4d09-9e31-1127efcd1e40/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampleTopic1",
"hostname": "exampleNamespaceName1.westus-1.mqtt.eventgrid-int.azure.net"
}
},
"id": "/subscriptions/8f6b6269-84f2-4d09-9e31-1127efcd1e40/resourceGroups/examplerg/providers/Microsoft.EventGrid/namespaces/exampleNamespaceName1",
"name": "exampleNamespaceName1",
"type": "Microsoft.EventGrid/namespaces",
"location": "westus"
}
Azure-AsyncOperation: https://management.windowsazure.com/subscriptions/8f6b6269-84f2-4d09-9e31-1127efcd1e40/resourceGroups/exampleNamespaceName1/providers/Microsoft.EventGrid/namespaces/exampleNamespaceName1/operationStatus/7B023877-A473-457B-B462-562F97048FB6?api-version=2025-02-15
Location: https://management.windowsazure.com/subscriptions/8f6b6269-84f2-4d09-9e31-1127efcd1e40/resourceGroups/exampleNamespaceName1/providers/Microsoft.EventGrid/namespaces/exampleNamespaceName1/operationResults/7B023877-A473-457B-B462-562F97048FB6?api-version=2025-02-15
Retry-After: 60
{
"properties": {
"provisioningState": "Succeeded",
"topicSpacesConfiguration": {
"state": "Enabled",
"routeTopicResourceId": "/subscriptions/8f6b6269-84f2-4d09-9e31-1127efcd1e40/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampleTopic1",
"hostname": "exampleNamespaceName1.westus-1.mqtt.eventgrid-int.azure.net"
}
},
"location": "West US",
"tags": {
"key1": "value1Updated"
},
"id": "/subscriptions/8f6b6269-84f2-4d09-9e31-1127efcd1e40/resourceGroups/examplerg/providers/Microsoft.EventGrid/namespaces/exampleNamespaceName1",
"name": "exampleNamespaceName1",
"type": "Microsoft.EventGrid/namespaces"
}
定义
ConnectionState
ConnectionState 信息。
名称 | 类型 | 说明 |
---|---|---|
actionsRequired |
string |
需要的作(如果有)。 |
description |
string |
连接状态的说明。 |
status |
连接状态。 |
createdByType
创建资源的标识的类型。
值 | 说明 |
---|---|
Application | |
Key | |
ManagedIdentity | |
User |
CustomDomainConfiguration
允许用户发布到自己的域名的自定义域配置。
名称 | 类型 | 说明 |
---|---|---|
certificateUrl |
string |
用于发布到自定义域的证书的 URL。 我们目前仅支持存储在 Azure Key Vault 中的证书。 虽然证书 URL 可以是以下格式的版本化 URL,https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id}或以下格式的非版本 URL(例如, |
expectedTxtRecordName |
string |
预期的 DNS TXT 记录名称。 事件网格将在自定义域名的 DNS 记录集中检查具有此名称的 TXT 记录,以证明域的所有权。 此 TXT 记录下的值必须包含预期的 TXT 记录值。 |
expectedTxtRecordValue |
string |
预期的 DNS TXT 记录值。 事件网格将在自定义域名的 DNS 记录集中检查具有此值的 TXT 记录,以证明域的所有权。 |
fullyQualifiedDomainName |
string |
自定义域的完全限定域名(FQDN)。 |
identity |
用于访问自定义域证书的标识信息。 此标识信息必须与已在命名空间上设置的标识匹配。 |
|
validationState |
自定义域的验证状态。 这是一个只读属性,最初设置为“挂起”,仅在成功验证域名所有权后,事件网格才会更新为“已批准”。 |
CustomDomainIdentity
用于检索自定义域证书的标识信息。
名称 | 类型 | 说明 |
---|---|---|
type |
使用的托管标识的类型。 可以是“SystemAssigned”或“UserAssigned”。 |
|
userAssignedIdentity |
string |
与资源关联的用户标识。 |
CustomDomainIdentityType
使用的托管标识的类型。 可以是“SystemAssigned”或“UserAssigned”。
值 | 说明 |
---|---|
SystemAssigned | |
UserAssigned |
CustomDomainValidationState
自定义域的验证状态。 这是一个只读属性,最初设置为“挂起”,仅在成功验证域名所有权后,事件网格才会更新为“已批准”。
值 | 说明 |
---|---|
Approved | |
ErrorRetrievingDnsRecord | |
Pending |
DynamicRoutingEnrichment
名称 | 类型 | 说明 |
---|---|---|
key |
string |
动态路由扩充密钥。 |
value |
string |
动态路由扩充值。 |
ErrorAdditionalInfo
资源管理错误附加信息。
名称 | 类型 | 说明 |
---|---|---|
info |
object |
其他信息。 |
type |
string |
其他信息类型。 |
ErrorDetail
错误详细信息。
名称 | 类型 | 说明 |
---|---|---|
additionalInfo |
错误附加信息。 |
|
code |
string |
错误代码。 |
details |
错误详细信息。 |
|
message |
string |
错误消息。 |
target |
string |
错误目标。 |
ErrorResponse
错误响应
名称 | 类型 | 说明 |
---|---|---|
error |
错误对象。 |
IdentityInfo
资源的标识信息。
名称 | 类型 | 说明 |
---|---|---|
principalId |
string |
资源标识的主体 ID。 |
tenantId |
string |
资源的租户 ID。 |
type |
使用的托管标识的类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将删除任何标识。 |
|
userAssignedIdentities |
<string,
User |
与资源关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 此属性当前未使用,并保留以供将来使用。 |
IdentityType
使用的托管标识的类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将删除任何标识。
值 | 说明 |
---|---|
None | |
SystemAssigned | |
SystemAssigned, UserAssigned | |
UserAssigned |
InboundIpRule
名称 | 类型 | 说明 |
---|---|---|
action |
根据匹配项或 IpMask 的匹配项执行的作。 |
|
ipMask |
string |
CIDR 表示法中的 IP 地址,例如 10.0.0.0/8。 |
IpActionType
根据匹配项或 IpMask 的匹配项执行的作。
值 | 说明 |
---|---|
Allow |
Namespace
命名空间资源。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
资源的完全限定标识符。 |
identity |
命名空间资源的标识信息。 |
|
location |
string |
资源的位置。 |
name |
string |
资源的名称。 |
properties.inboundIpRules |
这可用于限制来自特定 IP 而不是所有 IP 的流量。 注意:仅当启用了 PublicNetworkAccess 时,才会考虑这些内容。 |
|
properties.isZoneRedundant |
boolean |
这是一个可选属性,它允许用户指定命名空间资源是否支持区域冗余功能。 如果用户未显式指定此属性,则其默认值取决于以下条件: a。 对于已启用可用性区域的区域 - 默认属性值为 true。 b. 对于启用非可用性区域的区域 - 默认属性值为 false。 指定后,无法更新此属性。 |
properties.minimumTlsVersionAllowed |
允许发布到此命名空间的发布服务器的最低 TLS 版本。 仅支持 TLS 版本 1.2。 |
|
properties.privateEndpointConnections |
专用终结点连接列表。 |
|
properties.provisioningState |
命名空间资源的预配状态。 |
|
properties.publicNetworkAccess |
这决定了是否允许通过公用网络流量。 默认情况下,它处于启用状态。 可以通过配置进一步限制为特定 IP |
|
properties.topicSpacesConfiguration |
命名空间资源的主题空间配置信息 |
|
properties.topicsConfiguration |
命名空间资源的主题配置信息 |
|
sku |
表示可用的 Sku 定价层。 |
|
systemData |
与事件网格资源相关的系统元数据。 |
|
tags |
object |
资源的标记。 |
type |
string |
资源的类型。 |
NamespaceProvisioningState
命名空间资源的预配状态。
值 | 说明 |
---|---|
Canceled | |
CreateFailed | |
Creating | |
DeleteFailed | |
Deleted | |
Deleting | |
Failed | |
Succeeded | |
UpdatedFailed | |
Updating |
NamespaceSku
表示可用的 Sku 定价层。
名称 | 类型 | 说明 |
---|---|---|
capacity |
integer (int32) |
指定定义命名空间容量的吞吐量单位数。 属性默认值为 1,表示 1 个吞吐量单位 = 1MB/s 入口,每个命名空间的出口量为 2MB/秒。 最小容量为 1,允许的最大容量为 20。 |
name |
SKU 的名称。 |
NamespaceUpdateParameters
用于更新命名空间的属性。
名称 | 类型 | 说明 |
---|---|---|
identity |
命名空间资源标识信息。 |
|
properties.inboundIpRules |
这可用于限制来自特定 IP 而不是所有 IP 的流量。 注意:仅当启用了 PublicNetworkAccess 时,才会考虑这些内容。 |
|
properties.publicNetworkAccess |
这决定了是否允许通过公用网络流量。 默认情况下,它处于启用状态。 可以通过配置进一步限制为特定 IP |
|
properties.topicSpacesConfiguration |
可更新的主题空间配置属性。 |
|
properties.topicsConfiguration |
可更新的主题配置属性。 |
|
sku |
表示可用的 Sku 定价层。 |
|
tags |
object |
命名空间资源的标记。 |
PersistedConnectionStatus
连接状态。
值 | 说明 |
---|---|
Approved | |
Disconnected | |
Pending | |
Rejected |
PrivateEndpoint
PrivateEndpoint 信息。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
专用终结点的 ARM 标识符。 |
PrivateEndpointConnection
名称 | 类型 | 说明 |
---|---|---|
id |
string |
资源的完全限定标识符。 |
name |
string |
资源的名称。 |
properties.groupIds |
string[] |
专用链接服务资源的 GroupId。 |
properties.privateEndpoint |
此连接的专用终结点资源。 |
|
properties.privateLinkServiceConnectionState |
有关连接状态的详细信息。 |
|
properties.provisioningState |
专用终结点连接的预配状态。 |
|
type |
string |
资源的类型。 |
PublicNetworkAccess
这决定了是否允许通过公用网络流量。 默认情况下,它处于启用状态。 可以通过配置进一步限制为特定 IP
值 | 说明 |
---|---|
Disabled | |
Enabled |
ResourceProvisioningState
专用终结点连接的预配状态。
值 | 说明 |
---|---|
Canceled | |
Creating | |
Deleting | |
Failed | |
Succeeded | |
Updating |
RoutingEnrichments
名称 | 类型 | 说明 |
---|---|---|
dynamic | ||
static | StaticRoutingEnrichment[]: |
静态路由扩充详细信息。 |
RoutingIdentityInfo
主题空间配置的路由标识信息。
名称 | 类型 | 说明 |
---|---|---|
type |
主题空间配置的路由标识类型。 |
|
userAssignedIdentity |
string |
RoutingIdentityType
主题空间配置的路由标识类型。
值 | 说明 |
---|---|
None | |
SystemAssigned | |
UserAssigned |
SkuName
SKU 的名称。
值 | 说明 |
---|---|
Standard |
StaticStringRoutingEnrichment
名称 | 类型 | 说明 |
---|---|---|
key |
string |
静态路由扩充密钥。 |
value |
string |
字符串类型路由扩充值。 |
valueType |
string:
String |
静态路由扩充值类型。 例如,此属性值可以是“String”。 |
systemData
与创建和上次修改资源相关的元数据。
名称 | 类型 | 说明 |
---|---|---|
createdAt |
string (date-time) |
资源创建时间戳(UTC)。 |
createdBy |
string |
创建资源的标识。 |
createdByType |
创建资源的标识的类型。 |
|
lastModifiedAt |
string (date-time) |
上次修改的资源时间戳(UTC) |
lastModifiedBy |
string |
上次修改资源的标识。 |
lastModifiedByType |
上次修改资源的标识的类型。 |
TlsVersion
允许发布到此域的发布服务器的最低 TLS 版本
值 | 说明 |
---|---|
1.0 | |
1.1 | |
1.2 |
TopicsConfiguration
主题配置的属性。
名称 | 类型 | 说明 |
---|---|---|
customDomains |
命名空间的自定义域配置列表。 |
|
hostname |
string |
主题配置的主机名。 这是一个只读属性。 |
TopicSpacesConfiguration
主题空间配置的属性。
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
customDomains |
命名空间的自定义域配置列表。 |
||
hostname |
string |
主题空间配置的终结点。 这是一个只读属性。 |
|
maximumClientSessionsPerAuthenticationName |
integer (int32) |
每个身份验证名称的最大会话数。 属性默认值为 1。 允许的最小值为 1,允许的最大值为 100。 |
|
maximumSessionExpiryInHours |
integer (int32) |
最大会话到期时间(以小时为单位)。 属性默认值为 1 小时。 允许的最小值为 1 小时,最大允许值为 8 小时。 |
|
routeTopicResourceId |
string |
事件网格主题的完全限定的 Azure 资源 ID,事件将路由到命名空间下的 TopicSpaces。 此属性应采用以下格式“/subscriptions/{subId}/resourcegroups/{resourceGroupName}/providers/microsoft”。EventGrid/topics/{topicName}'。 本主题应位于命名空间所在的同一区域。 |
|
routingEnrichments |
主题空间配置的路由扩充 |
||
routingIdentityInfo |
主题空间配置的路由标识信息。 |
||
state | Disabled |
指示是否为命名空间启用了主题空间配置。 默认值为 Disabled。 |
TopicSpacesConfigurationState
指示是否为命名空间启用了主题空间配置。 默认值为 Disabled。
值 | 说明 |
---|---|
Disabled | |
Enabled |
UpdateTopicsConfigurationInfo
命名空间的主题配置信息的属性。
名称 | 类型 | 说明 |
---|---|---|
customDomains |
主题配置的自定义域信息。 |
UpdateTopicSpacesConfigurationInfo
命名空间的主题空间配置信息的属性。
名称 | 类型 | 说明 |
---|---|---|
customDomains |
主题空间配置的自定义域信息。 |
|
maximumClientSessionsPerAuthenticationName |
integer (int32) |
每个身份验证名称的最大会话数。 属性默认值为 1。 允许的最小值为 1,允许的最大值为 100。 |
maximumSessionExpiryInHours |
integer (int32) |
最大会话到期时间(以小时为单位)。 属性默认值为 1 小时。 允许的最小值为 1 小时,最大允许值为 8 小时。 |
routeTopicResourceId |
string |
此属性用于指定将事件从命名空间下的主题空间配置路由到的自定义主题。 |
routingEnrichments |
主题空间配置的路由扩充。 |
|
routingIdentityInfo |
主题空间配置的路由标识信息。 |
|
state |
指示是否为命名空间启用了主题空间配置。 默认值为 Disabled。 |
UserIdentityProperties
有关用户标识的信息。
名称 | 类型 | 说明 |
---|---|---|
clientId |
string |
用户分配标识的客户端 ID。 |
principalId |
string |
用户分配标识的主体 ID。 |