Partner Namespaces - List By Subscription

Serviço:: Event Grid

Versão API:: 2025-02-15

Liste namespaces de parceiros em uma assinatura do Azure.
Liste todos os namespaces de parceiro em uma assinatura do Azure.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/partnerNamespaces?api-version=2025-02-15

Com parâmetros opcionais:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/partnerNamespaces?api-version=2025-02-15&$filter={$filter}&$top={$top}

Parâmetros URI

Nome	Em	Necessário	Tipo	Descrição
subscriptionId	path	True	string	Credenciais de assinatura que identificam exclusivamente uma assinatura do Microsoft Azure. O ID da assinatura faz parte do URI de cada chamada de serviço.
api-version	query	True	string	Versão da API a ser usada com a solicitação do cliente.
$filter	query		string	A consulta usada para filtrar os resultados da pesquisa usando a sintaxe OData. A filtragem é permitida apenas na propriedade 'name' e com um número limitado de operações OData. Estas operações são: a função «contém», bem como as seguintes operações lógicas: not, e, ou, eq (para igual) e ne (para não igual). Nenhuma operação aritmética é suportada. Segue-se um exemplo de filtro válido: $filter=contains(namE, 'PATTERN') e name ne 'PATTERN-1'. O seguinte não é um exemplo de filtro válido: $filter=location eq 'westus'.
$top	query		integer (int32)	O número de resultados a serem retornados por página para a operação de lista. O intervalo válido para o parâmetro superior é de 1 a 100. Se não for especificado, o número padrão de resultados a serem retornados é de 20 itens por página.

Respostas

Nome	Tipo	Descrição
200 OK	PartnerNamespacesListResult	OK
Other Status Codes	ErrorResponse	Resposta de erro retornada se a solicitação não foi bem-sucedida.

Exemplos

PartnerNamespaces_ListBySubscription

Pedido de exemplo

HTTP

GET https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.EventGrid/partnerNamespaces?api-version=2025-02-15

Resposta de exemplo

Código de estado:: 200

{
  "value": [
    {
      "properties": {
        "provisioningState": "Succeeded",
        "partnerRegistrationFullyQualifiedId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/amh/providers/Microsoft.EventGrid/partnerRegistrations/ContosoCorpAccount1",
        "endpoint": "https://partnernamespace123.centraluseuap-1.eventgrid.azure.net/api/events"
      },
      "location": "Central US EUAP",
      "tags": {
        "key1": "value1",
        "key2": "value2",
        "key3": "value3"
      },
      "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/amh/providers/Microsoft.EventGrid/partnerNamespaces/partnerNamespace123",
      "name": "partnerNamespace123",
      "type": "Microsoft.EventGrid/partnerNamespaces"
    }
  ]
}

Definições

Nome	Descrição
ConnectionState	Informações de ConnectionState.
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
InboundIpRule
IpActionType	Ação a executar com base na correspondência ou não correspondência da IpMask.
PartnerNamespace	Namespace de parceiro EventGrid.
PartnerNamespaceProvisioningState	Estado de provisionamento do namespace do parceiro.
PartnerNamespacesListResult	Resultado da operação Listar Namespaces de Parceiros
PartnerTopicRoutingMode	Isso determina se os eventos publicados nesse namespace de parceiro devem usar o atributo source na carga útil do evento ou usar o nome do canal no cabeçalho ao corresponder ao tópico do parceiro. Se nenhum for especificado, o roteamento do atributo de origem será usado para corresponder ao tópico do parceiro.
PersistedConnectionStatus	Status da conexão.
PrivateEndpoint	Informações do PrivateEndpoint.
PrivateEndpointConnection
PublicNetworkAccess	Isso determina se o tráfego é permitido na rede pública. Por padrão, ele está habilitado. Você pode restringir ainda mais a IPs específicos configurando <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules" />
ResourceProvisioningState	Estado de provisionamento da Private Endpoint Connection.
systemData	Metadados referentes à criação e última modificação do recurso.
TlsVersion	Versão TLS mínima do editor que pode publicar neste domínio

ConnectionState

Objetivo

Informações de ConnectionState.

Nome	Tipo	Descrição
actionsRequired	string	Ações necessárias (se houver).
description	string	Descrição do estado da conexão.
status	PersistedConnectionStatus	Status da conexão.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Descrição
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objetivo

O erro de gerenciamento de recursos informações adicionais.

Nome	Tipo	Descrição
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objetivo

O detalhe do erro.

Nome	Tipo	Descrição
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objetivo

Resposta de erro

Nome	Tipo	Descrição
error	ErrorDetail	O objeto de erro.

InboundIpRule

Objetivo

Nome	Tipo	Descrição
action	IpActionType	Ação a executar com base na correspondência ou não correspondência da IpMask.
ipMask	string	Endereço IP na notação CIDR, por exemplo, 10.0.0.0/8.

IpActionType

Enumeração

Ação a executar com base na correspondência ou não correspondência da IpMask.

Valor	Descrição
Allow

PartnerNamespace

Objetivo

Namespace de parceiro EventGrid.

Nome	Tipo	Valor padrão	Descrição
id	string		Identificador totalmente qualificado do recurso.
location	string		Localização do recurso.
name	string		Nome do recurso.
properties.disableLocalAuth	boolean	False	Este booleano é usado para ativar ou desativar a autenticação local. O valor padrão é false. Quando a propriedade é definida como true, somente o token AAD será usado para autenticar se o usuário tiver permissão para publicar no namespace do parceiro.
properties.endpoint	string		Ponto de extremidade para o namespace do parceiro.
properties.inboundIpRules	InboundIpRule[]		Isso pode ser usado para restringir o tráfego de IPs específicos em vez de todos os IPs. Nota: Estes são considerados apenas se PublicNetworkAccess estiver ativado.
properties.minimumTlsVersionAllowed	TlsVersion		Versão TLS mínima do editor permitida para publicar neste namespace de parceiro
properties.partnerRegistrationFullyQualifiedId	string		O ID ARM totalmente qualificado do registro de parceiro que deve ser associado a esse namespace de parceiro. Isso usa o seguinte formato: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}.
properties.partnerTopicRoutingMode	PartnerTopicRoutingMode	SourceEventAttribute	Isso determina se os eventos publicados nesse namespace de parceiro devem usar o atributo source na carga útil do evento ou usar o nome do canal no cabeçalho ao corresponder ao tópico do parceiro. Se nenhum for especificado, o roteamento do atributo de origem será usado para corresponder ao tópico do parceiro.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Lista de conexões de ponto de extremidade privadas.
properties.provisioningState	PartnerNamespaceProvisioningState		Estado de provisionamento do namespace do parceiro.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Isso determina se o tráfego é permitido na rede pública. Por padrão, ele está habilitado. Você pode restringir ainda mais a IPs específicos configurando <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.PartnerNamespaceProperties.InboundIpRules" />
systemData	systemData		Os metadados do sistema relacionados ao recurso Grade de Eventos.
tags	object		Tags do recurso.
type	string		Tipo de recurso.

PartnerNamespaceProvisioningState

Enumeração

Estado de provisionamento do namespace do parceiro.

Valor	Descrição
Creating
Updating
Deleting
Succeeded
Canceled
Failed

PartnerNamespacesListResult

Objetivo

Resultado da operação Listar Namespaces de Parceiros

Nome	Tipo	Descrição
nextLink	string	Um link para a próxima página de namespaces de parceiros.
value	PartnerNamespace[]	Uma coleção de namespaces de parceiros.

PartnerTopicRoutingMode

Enumeração

Isso determina se os eventos publicados nesse namespace de parceiro devem usar o atributo source na carga útil do evento ou usar o nome do canal no cabeçalho ao corresponder ao tópico do parceiro. Se nenhum for especificado, o roteamento do atributo de origem será usado para corresponder ao tópico do parceiro.

Valor	Descrição
SourceEventAttribute
ChannelNameHeader

PersistedConnectionStatus

Enumeração

Status da conexão.

Valor	Descrição
Pending
Approved
Rejected
Disconnected

PrivateEndpoint

Objetivo

Informações do PrivateEndpoint.

Nome	Tipo	Descrição
id	string	O identificador ARM para Private Endpoint.

PrivateEndpointConnection

Objetivo

Nome	Tipo	Descrição
id	string	Identificador totalmente qualificado do recurso.
name	string	Nome do recurso.
properties.groupIds	string[]	GroupIds do recurso de serviço de link privado.
properties.privateEndpoint	PrivateEndpoint	O recurso Ponto Final Privado para esta Conexão.
properties.privateLinkServiceConnectionState	ConnectionState	Detalhes sobre o estado da conexão.
properties.provisioningState	ResourceProvisioningState	Estado de provisionamento da Private Endpoint Connection.
type	string	Tipo de recurso.

PublicNetworkAccess

Enumeração

Isso determina se o tráfego é permitido na rede pública. Por padrão, ele está habilitado. Você pode restringir ainda mais a IPs específicos configurando <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules" />

Valor	Descrição
Enabled
Disabled

ResourceProvisioningState

Enumeração

Estado de provisionamento da Private Endpoint Connection.

Valor	Descrição
Creating
Updating
Deleting
Succeeded
Canceled
Failed

systemData

Objetivo

Metadados referentes à criação e última modificação do recurso.

Nome	Tipo	Descrição
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

TlsVersion

Enumeração

Versão TLS mínima do editor que pode publicar neste domínio

Valor	Descrição
1.0
1.1
1.2

Partilhar via

Partner Namespaces - List By Subscription

Parâmetros URI

Respostas

Exemplos

PartnerNamespaces_ListBySubscription

Pedido de exemplo

Resposta de exemplo

Definições

ConnectionState

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

InboundIpRule

IpActionType

PartnerNamespace

PartnerNamespaceProvisioningState

PartnerNamespacesListResult

PartnerTopicRoutingMode

PersistedConnectionStatus

PrivateEndpoint

PrivateEndpointConnection

PublicNetworkAccess

ResourceProvisioningState

systemData

TlsVersion