你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Namespaces - Get

获取命名空间。
获取命名空间的属性。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}?api-version=2024-06-01-preview

URI 参数

名称 必需 类型 说明
namespaceName
path True

string

命名空间的名称。

正则表达式模式: ^[a-zA-Z0-9-]*$

resourceGroupName
path True

string

用户订阅中的资源组的名称。

subscriptionId
path True

string

唯一标识 Microsoft Azure 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。

api-version
query True

string

要与客户端请求一起使用的 API 的版本。

响应

名称 类型 说明
200 OK

Namespace

确定

Other Status Codes

ErrorResponse

如果请求失败,则返回错误响应。

示例

Namespaces_Get

示例请求

GET https://management.azure.com/subscriptions/8f6b6269-84f2-4d09-9e31-1127efcd1e40/resourceGroups/examplerg/providers/Microsoft.EventGrid/namespaces/exampleNamespaceName1?api-version=2024-06-01-preview

示例响应

{
  "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": "value1",
    "key2": "value2",
    "key3": "value3"
  },
  "id": "/subscriptions/8f6b6269-84f2-4d09-9e31-1127efcd1e40/resourceGroups/examplerg/providers/Microsoft.EventGrid/namespaces/exampleNamespaceName1",
  "name": "exampleNamespaceName1",
  "type": "Microsoft.EventGrid/namespaces"
}

定义

名称 说明
AlternativeAuthenticationNameSource

与命名空间资源的客户端身份验证设置相关的备用身份验证名称源。

ClientAuthenticationSettings

命名空间资源的客户端身份验证设置。

ConnectionState

ConnectionState 信息。

createdByType

创建资源的标识类型。

CustomDomainConfiguration

允许用户发布到自己的域名的自定义域配置。

CustomDomainIdentity

用于检索自定义域证书的标识信息。

CustomDomainIdentityType

使用的托管标识的类型。 可以是“SystemAssigned”或“UserAssigned”。

CustomDomainValidationState

自定义域的验证状态。 这是一个只读属性,最初设置为“Pending”,并且仅在成功验证域名所有权后,事件网格才会更新为“已批准”。

CustomJwtAuthenticationManagedIdentity

用于检索用于自定义 JWT 身份验证的证书的标识信息。

CustomJwtAuthenticationManagedIdentityType

使用的托管标识的类型。 可以是“SystemAssigned”或“UserAssigned”。

CustomJwtAuthenticationSettings

命名空间资源的自定义 JWT 身份验证设置。

DynamicRoutingEnrichment
ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

IdentityInfo

资源的标识信息。

IdentityType

使用的托管标识的类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将删除任何标识。

InboundIpRule
IpActionType

要基于 IpMask 的匹配项或不匹配项执行的操作。

IssuerCertificateInfo

有关用于令牌验证的证书的信息。

Namespace

命名空间资源。

NamespaceProvisioningState

命名空间资源的预配状态。

NamespaceSku

表示可用的 SKU 定价层。

PersistedConnectionStatus

连接的状态。

PrivateEndpoint

PrivateEndpoint 信息。

PrivateEndpointConnection
PublicNetworkAccess

这确定是否允许通过公用网络流量。 默认情况下,它处于启用状态。 可以通过配置进一步限制为特定 IP

ResourceProvisioningState

专用终结点连接的预配状态。

RoutingEnrichments
RoutingIdentityInfo

主题空间配置的路由标识信息。

RoutingIdentityType

主题空间配置的路由标识类型。

SkuName

SKU 的名称。

StaticStringRoutingEnrichment
systemData

与资源的创建和上次修改相关的元数据。

TlsVersion

允许发布到此域的发布者的最低 TLS 版本

TopicsConfiguration

Topics 配置的属性。

TopicSpacesConfiguration

主题空间配置的属性。

TopicSpacesConfigurationState

指示是否为命名空间启用了主题空间配置。 默认值为 Disabled。

UserIdentityProperties

有关用户标识的信息。

AlternativeAuthenticationNameSource

与命名空间资源的客户端身份验证设置相关的备用身份验证名称源。

名称 类型 说明
ClientCertificateDns

string

ClientCertificateEmail

string

ClientCertificateIp

string

ClientCertificateSubject

string

ClientCertificateUri

string

ClientAuthenticationSettings

命名空间资源的客户端身份验证设置。

名称 类型 说明
alternativeAuthenticationNameSources

AlternativeAuthenticationNameSource[]

与命名空间资源的客户端身份验证设置相关的备用身份验证名称源。

customJwtAuthentication

CustomJwtAuthenticationSettings

命名空间资源的自定义 JWT 身份验证设置。

ConnectionState

ConnectionState 信息。

名称 类型 说明
actionsRequired

string

如果有任何) ,则 (所需的操作。

description

string

连接状态的说明。

status

PersistedConnectionStatus

连接的状态。

createdByType

创建资源的标识类型。

名称 类型 说明
Application

string

Key

string

ManagedIdentity

string

User

string

CustomDomainConfiguration

允许用户发布到自己的域名的自定义域配置。

名称 类型 说明
certificateUrl

string

用于发布到自定义域的证书的 URL。 目前,我们仅支持存储在 Azure 密钥保管库 中的证书。 虽然证书 URL 可以是以下格式 https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id} 的版本化 URL,也可以是以下格式 (的未版本化 URL, https://contosovault.vault.azure.net/certificates/contosocert例如 ,我们仅支持 ((例如 https://contosovault.vault.azure.net/certificates/contosocert ,) )

expectedTxtRecordName

string

预期的 DNS TXT 记录名称。 事件网格将在自定义域名的 DNS 记录集中为具有此名称的 TXT 记录检查,以证明对域的所有权。 此 TXT 记录下的值必须包含预期的 TXT 记录值。

expectedTxtRecordValue

string

预期的 DNS TXT 记录值。 事件网格将在自定义域名的 DNS 记录集中为具有此值的 TXT 记录检查,以证明对域的所有权。

fullyQualifiedDomainName

string

自定义域的完全限定域名 (FQDN) 。

identity

CustomDomainIdentity

用于访问自定义域证书的标识信息。 此标识信息必须与已在命名空间上设置的标识匹配。

validationState

CustomDomainValidationState

自定义域的验证状态。 这是一个只读属性,最初设置为“Pending”,并且仅在成功验证域名所有权后,事件网格才会更新为“已批准”。

CustomDomainIdentity

用于检索自定义域证书的标识信息。

名称 类型 说明
type

CustomDomainIdentityType

使用的托管标识的类型。 可以是“SystemAssigned”或“UserAssigned”。

userAssignedIdentity

string

与资源关联的用户标识。

CustomDomainIdentityType

使用的托管标识的类型。 可以是“SystemAssigned”或“UserAssigned”。

名称 类型 说明
SystemAssigned

string

UserAssigned

string

CustomDomainValidationState

自定义域的验证状态。 这是一个只读属性,最初设置为“Pending”,并且仅在成功验证域名所有权后,事件网格才会更新为“已批准”。

名称 类型 说明
Approved

string

ErrorRetrievingDnsRecord

string

Pending

string

CustomJwtAuthenticationManagedIdentity

用于检索用于自定义 JWT 身份验证的证书的标识信息。

名称 类型 说明
type

CustomJwtAuthenticationManagedIdentityType

使用的托管标识的类型。 可以是“SystemAssigned”或“UserAssigned”。

userAssignedIdentity

string

与资源关联的用户标识。

CustomJwtAuthenticationManagedIdentityType

使用的托管标识的类型。 可以是“SystemAssigned”或“UserAssigned”。

名称 类型 说明
SystemAssigned

string

UserAssigned

string

CustomJwtAuthenticationSettings

命名空间资源的自定义 JWT 身份验证设置。

名称 类型 说明
issuerCertificates

IssuerCertificateInfo[]

有关用于令牌验证的证书的信息。 我们目前最多支持 2 个证书。

tokenIssuer

string

预期的 JWT 令牌颁发者。

DynamicRoutingEnrichment

名称 类型 说明
key

string

动态路由扩充密钥。

value

string

动态路由扩充值。

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

IdentityInfo

资源的标识信息。

名称 类型 说明
principalId

string

资源标识的主体 ID。

tenantId

string

资源的租户 ID。

type

IdentityType

使用的托管标识的类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将删除任何标识。

userAssignedIdentities

<string,  UserIdentityProperties>

与资源关联的用户标识列表。 用户标识字典密钥引用将是 ARM 资源 ID,格式为:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 此属性当前未使用,并保留以供将来使用。

IdentityType

使用的托管标识的类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将删除任何标识。

名称 类型 说明
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

InboundIpRule

名称 类型 说明
action

IpActionType

要基于 IpMask 的匹配项或不匹配项执行的操作。

ipMask

string

CIDR 表示法中的 IP 地址,例如 10.0.0.0/8。

IpActionType

要基于 IpMask 的匹配项或不匹配项执行的操作。

名称 类型 说明
Allow

string

IssuerCertificateInfo

有关用于令牌验证的证书的信息。

名称 类型 说明
certificateUrl

string

格式的 https://keyvaultname.vault.azure.net/certificates/certificateName/certificateVersion Keyvault 证书 URL。

identity

CustomJwtAuthenticationManagedIdentity

将用于访问证书的标识。

Namespace

命名空间资源。

名称 类型 说明
id

string

资源的完全限定标识符。

identity

IdentityInfo

命名空间资源的标识信息。

location

string

资源的位置。

name

string

资源的名称。

properties.inboundIpRules

InboundIpRule[]

这可用于限制来自特定 IP 而不是所有 IP 的流量。 注意:仅当启用了 PublicNetworkAccess 时,才会考虑这些项。

properties.isZoneRedundant

boolean

这是一个可选属性,它允许用户指定命名空间资源是否支持区域冗余功能。 如果用户未显式指定此属性,则其默认值取决于以下条件:a。 对于已启用可用性区域区域 - 默认属性值为 true。 b. 对于未启用可用性区域的区域 - 默认属性值为 false。 指定后,无法更新此属性。

properties.minimumTlsVersionAllowed

TlsVersion

允许发布到此命名空间的发布服务器的最低 TLS 版本。 仅支持 TLS 版本 1.2。

properties.privateEndpointConnections

PrivateEndpointConnection[]

专用终结点连接列表。

properties.provisioningState

NamespaceProvisioningState

命名空间资源的预配状态。

properties.publicNetworkAccess

PublicNetworkAccess

这确定是否允许通过公用网络流量。 默认情况下,它处于启用状态。 可以通过配置进一步限制为特定 IP

properties.topicSpacesConfiguration

TopicSpacesConfiguration

命名空间资源的主题空间配置信息

properties.topicsConfiguration

TopicsConfiguration

Topics命名空间资源的配置信息

sku

NamespaceSku

表示可用的 SKU 定价层。

systemData

systemData

与命名空间资源相关的系统元数据。

tags

object

资源的标记。

type

string

资源的类型。

NamespaceProvisioningState

命名空间资源的预配状态。

名称 类型 说明
Canceled

string

CreateFailed

string

Creating

string

DeleteFailed

string

Deleted

string

Deleting

string

Failed

string

Succeeded

string

UpdatedFailed

string

Updating

string

NamespaceSku

表示可用的 SKU 定价层。

名称 类型 说明
capacity

integer

指定定义命名空间容量的吞吐量单位数。 属性默认值为 1,表示每个命名空间有 1 个吞吐量单位 = 1MB/s 入口和 2MB/秒出口。 最小容量为 1,最大允许容量为 20。

name

SkuName

SKU 的名称。

PersistedConnectionStatus

连接的状态。

名称 类型 说明
Approved

string

Disconnected

string

Pending

string

Rejected

string

PrivateEndpoint

PrivateEndpoint 信息。

名称 类型 说明
id

string

专用终结点的 ARM 标识符。

PrivateEndpointConnection

名称 类型 说明
id

string

资源的完全限定标识符。

name

string

资源的名称。

properties.groupIds

string[]

专用链接服务资源的 GroupIds。

properties.privateEndpoint

PrivateEndpoint

此连接的专用终结点资源。

properties.privateLinkServiceConnectionState

ConnectionState

有关连接状态的详细信息。

properties.provisioningState

ResourceProvisioningState

专用终结点连接的预配状态。

type

string

资源的类型。

PublicNetworkAccess

这确定是否允许通过公用网络流量。 默认情况下,它处于启用状态。 可以通过配置进一步限制为特定 IP

名称 类型 说明
Disabled

string

Enabled

string

SecuredByPerimeter

string

ResourceProvisioningState

专用终结点连接的预配状态。

名称 类型 说明
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

RoutingEnrichments

名称 类型 说明
dynamic

DynamicRoutingEnrichment[]

static StaticRoutingEnrichment[]:

StaticStringRoutingEnrichment[]

静态路由扩充详细信息。

RoutingIdentityInfo

主题空间配置的路由标识信息。

名称 类型 说明
type

RoutingIdentityType

主题空间配置的路由标识类型。

userAssignedIdentity

string

RoutingIdentityType

主题空间配置的路由标识类型。

名称 类型 说明
None

string

SystemAssigned

string

UserAssigned

string

SkuName

SKU 的名称。

名称 类型 说明
Standard

string

StaticStringRoutingEnrichment

名称 类型 说明
key

string

静态路由扩充密钥。

value

string

字符串类型路由扩充值。

valueType string:

String

静态路由扩充值类型。 例如,此属性值可以是“String”。

systemData

与资源的创建和上次修改相关的元数据。

名称 类型 说明
createdAt

string

资源的创建时间戳 (UTC) 。

createdBy

string

创建资源的标识。

createdByType

createdByType

创建资源的标识类型。

lastModifiedAt

string

资源上次修改的时间戳 (UTC)

lastModifiedBy

string

上次修改资源的标识。

lastModifiedByType

createdByType

上次修改资源的标识类型。

TlsVersion

允许发布到此域的发布者的最低 TLS 版本

名称 类型 说明
1.0

string

1.1

string

1.2

string

TopicsConfiguration

Topics 配置的属性。

名称 类型 说明
customDomains

CustomDomainConfiguration[]

命名空间的自定义域配置列表。

hostname

string

主题配置的主机名。 这是只读属性。

TopicSpacesConfiguration

主题空间配置的属性。

名称 类型 默认值 说明
clientAuthentication

ClientAuthenticationSettings

主题空间配置的客户端身份验证设置。

customDomains

CustomDomainConfiguration[]

命名空间的自定义域配置列表。

hostname

string

主题空间配置的终结点。 这是只读属性。

maximumClientSessionsPerAuthenticationName

integer

每个身份验证名称的最大会话数。 属性默认值为 1。 最小允许值为 1,最大允许值为 100。

maximumSessionExpiryInHours

integer

最大会话过期时间(以小时为单位)。 属性默认值为 1 小时。 允许的最小值为 1 小时,最大允许值为 8 小时。

routeTopicResourceId

string

事件网格主题的完全限定 Azure 资源 ID,事件将从命名空间下的 TopicSpaces 路由到该主题。 此属性应采用以下格式'/subscriptions/{subId}/resourcegroups/{resourceGroupName}/providers/microsoft。EventGrid/topics/{topicName}。 本主题应位于命名空间所在的同一区域中。

routingEnrichments

RoutingEnrichments

主题空间配置的路由扩充

routingIdentityInfo

RoutingIdentityInfo

主题空间配置的路由标识信息。

state

TopicSpacesConfigurationState

Disabled

指示是否为命名空间启用了主题空间配置。 默认值为 Disabled。

TopicSpacesConfigurationState

指示是否为命名空间启用了主题空间配置。 默认值为 Disabled。

名称 类型 说明
Disabled

string

Enabled

string

UserIdentityProperties

有关用户标识的信息。

名称 类型 说明
clientId

string

用户分配标识的客户端 ID。

principalId

string

用户分配的标识的主体 ID。