다음을 통해 공유

Namespaces - Get

  • 참조
서비스:
Event Hubs
API 버전:
2024-01-01

지정된 네임스페이스에 대한 설명을 가져옵니다.

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

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
namespaceName
 path True

string

네임스페이스 이름

regex 패턴: ^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$
resourceGroupName
 path True

string

Azure 구독 내 리소스 그룹의 이름입니다.
subscriptionId
 path True

string

Microsoft Azure 구독을 고유하게 식별하는 구독 자격 증명입니다. 구독 ID는 모든 서비스 호출에 대한 URI의 파트를 형성합니다.
api-version
 query True

string

클라이언트 API 버전.

응답

Name 형식 Description
200 OK

EHNamespace

네임스페이스가 성공적으로 반환되었습니다.
Other Status Codes

ErrorResponse

작업이 실패한 이유를 설명하는 Eventhub 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name Description
user_impersonation 사용자 계정 가장

예제

NameSpaceGet

샘플 요청

GET https://management.azure.com/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/namespaces/NamespaceSample?api-version=2024-01-01

샘플 응답

상태 코드:
200 
{
  "sku": {
    "name": "Standard",
    "tier": "Standard",
    "capacity": 1
  },
  "id": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/namespaces/NamespaceSample",
  "name": "NamespaceSample",
  "type": "Microsoft.EventHub/Namespaces",
  "location": "East US",
  "tags": {},
  "identity": {
    "principalId": "PrincipalIdGUID",
    "tenantId": "TenantIdGUID",
    "type": "SystemAssigned, UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud1": {
        "clientId": "ClientIdGUID",
        "principalId": "PrincipalIdGUID"
      },
      "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud2": {
        "clientId": "6a35400f-6ccb-4817-8f1a-ce19ea4523bc",
        "principalId": "ce2d5953-5c15-40ca-9d51-cc3f4a63b0f5"
      }
    }
  },
  "properties": {
    "isAutoInflateEnabled": false,
    "disableLocalAuth": false,
    "maximumThroughputUnits": 0,
    "zoneRedundant": false,
    "minimumTlsVersion": "1.2",
    "encryption": {
      "keySource": "Microsoft.KeyVault",
      "keyVaultProperties": [
        {
          "keyName": "Samplekey",
          "keyVaultUri": "https://sample-keyvault-user.vault-int.azure-int.net",
          "keyVersion": "",
          "identity": {
            "userAssignedIdentity": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud1"
          }
        }
      ],
      "requireInfrastructureEncryption": false
    },
    "privateEndpointConnections": [
      {
        "id": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/namespaces/NamespaceSample/privateEndpointConnections/privateEndpointConnectionName",
        "name": "privateEndpointConnectionName",
        "type": "Microsoft.EventHub/Namespaces/PrivateEndpointConnections",
        "properties": {
          "provisioningState": "Succeeded",
          "privateEndpoint": {
            "id": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.Network/privateEndpoints/NamespaceSample"
          },
          "privateLinkServiceConnectionState": {
            "status": "Approved",
            "description": "Auto-Approved"
          }
        }
      }
    ],
    "provisioningState": "Succeeded",
    "clusterArmId": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/clusters/enc-test",
    "metricId": "MetricGUID:NamespaceSample",
    "createdAt": "2021-01-30T00:28:38.963Z",
    "updatedAt": "2021-01-30T00:30:55.143Z",
    "serviceBusEndpoint": "https://NamespaceSample.servicebus.windows-int.net:443"
  }
}

정의

Name Description
ConnectionState

연결 상태에 대한 세부 정보입니다.
createdByType

리소스를 만든 ID의 형식입니다.
EHNamespace

목록 또는 가져오기 작업의 단일 네임스페이스 항목
EndPointProvisioningState

프라이빗 엔드포인트 연결의 프로비전 상태입니다.
ErrorAdditionalInfo

리소스 관리 오류 추가 정보입니다.
ErrorDetail

오류 세부 정보입니다.
ErrorResponse

오류 응답은 Event Hub 서비스가 들어오는 요청을 처리할 수 없음을 나타냅니다. 그 이유는 오류 메시지에 제공됩니다.
keySource

암호화에 사용할 수 있는 keySource 값을 열거합니다.
KeyVaultProperties

KeyVault의 속성
ManagedServiceIdentityType

관리 서비스 ID의 유형입니다.
PrivateEndpoint

이 연결에 대한 프라이빗 엔드포인트 리소스입니다.
PrivateEndpointConnection

프라이빗 엔드포인트 연결 목록입니다.
PrivateLinkConnectionStatus

연결의 상태입니다.
PublicNetworkAccess

이렇게 하면 공용 네트워크를 통해 트래픽이 허용되는지 여부가 결정됩니다. 기본적으로 사용하도록 설정됩니다.
Sku

sku 리소스의 속성
SkuName

이 SKU의 이름입니다.
SkuTier

이 특정 SKU의 청구 계층입니다.
systemData

리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.
TlsVersion

지원할 클러스터의 최소 TLS 버전(예: '1.2')
UserAssignedIdentity

인식된 사전 값입니다.

ConnectionState

연결 상태에 대한 세부 정보입니다.

Name 형식 Description
description

string

연결 상태에 대한 설명입니다.
status

PrivateLinkConnectionStatus

연결의 상태입니다.

createdByType

리소스를 만든 ID의 형식입니다.

Name 형식 Description
Application

string

Key

string

ManagedIdentity

string

User

string

EHNamespace

목록 또는 가져오기 작업의 단일 네임스페이스 항목

Name 형식 Default value Description
id

string

리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity.principalId

string

KeyVault의 ObjectId
identity.tenantId

string

KeyVault의 TenantId
identity.type

ManagedServiceIdentityType

관리 서비스 ID의 유형입니다.
identity.userAssignedIdentities

<string,  UserAssignedIdentity>

사용자 할당 ID에 대한 속성
location

string

리소스 위치.
name

string

리소스의 이름입니다.
properties.alternateName

string

별칭 및 네임스페이스 이름이 같을 때 지정된 대체 이름입니다.
properties.clusterArmId

string

네임스페이스의 클러스터 ARM ID입니다.
properties.createdAt

string

네임스페이스를 만든 시간입니다.
properties.disableLocalAuth

boolean

이 속성은 Event Hubs 네임스페이스에 대한 SAS 인증을 사용하지 않도록 설정합니다.
properties.encryption.keySource

keySource

Microsoft.KeyVault

암호화에 사용할 수 있는 keySource 값을 열거합니다.
properties.encryption.keyVaultProperties

KeyVaultProperties[]

KeyVault의 속성
properties.encryption.requireInfrastructureEncryption

boolean

인프라 암호화 사용(이중 암호화)
properties.isAutoInflateEnabled

boolean

EventHub 네임스페이스에 AutoInflate를 사용할 수 있는지 여부를 나타내는 값입니다.
properties.kafkaEnabled

boolean

Eventhub 네임스페이스에 대해 Kafka를 사용할 수 있는지 여부를 나타내는 값입니다.
properties.maximumThroughputUnits

integer

AutoInflate를 사용하는 경우 처리량 단위의 상한값은 0~20개 처리량 단위 이내여야 합니다. ( AutoInflateEnabled = true인 경우 '0')
properties.metricId

string

Azure Insights 메트릭에 대한 식별자입니다.
properties.minimumTlsVersion

TlsVersion

지원할 클러스터의 최소 TLS 버전(예: '1.2')
properties.privateEndpointConnections

PrivateEndpointConnection[]

프라이빗 엔드포인트 연결 목록입니다.
properties.provisioningState

string

네임스페이스의 프로비전 상태입니다.
properties.publicNetworkAccess

PublicNetworkAccess

Enabled

이렇게 하면 공용 네트워크를 통해 트래픽이 허용되는지 여부가 결정됩니다. 기본적으로 사용하도록 설정됩니다.
properties.serviceBusEndpoint

string

Service Bus 작업을 수행하는 데 사용할 수 있는 엔드포인트입니다.
properties.status

string

네임스페이스의 상태입니다.
properties.updatedAt

string

네임스페이스가 업데이트된 시간입니다.
properties.zoneRedundant

boolean

이 속성을 사용하도록 설정하면 지원되는 가용성 영역에 표준 Event Hubs 네임스페이스가 만들어집니다.
sku

Sku

sku 리소스의 속성
systemData

systemData

이 리소스와 관련된 시스템 메타 데이터입니다.
tags

object

리소스 태그.
type

string

리소스 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts"

EndPointProvisioningState

프라이빗 엔드포인트 연결의 프로비전 상태입니다.

Name 형식 Description
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

ErrorAdditionalInfo

리소스 관리 오류 추가 정보입니다.

Name 형식 Description
info

object

추가 정보입니다.
type

string

추가 정보 유형입니다.

ErrorDetail

오류 세부 정보입니다.

Name 형식 Description
additionalInfo

ErrorAdditionalInfo[]

오류 추가 정보입니다.
code

string

오류 코드입니다.
details

ErrorDetail[]

오류 세부 정보입니다.
message

string

오류 메시지입니다.
target

string

오류 대상입니다.

ErrorResponse

오류 응답은 Event Hub 서비스가 들어오는 요청을 처리할 수 없음을 나타냅니다. 그 이유는 오류 메시지에 제공됩니다.

Name 형식 Description
error

ErrorDetail

Error 개체.

keySource

암호화에 사용할 수 있는 keySource 값을 열거합니다.

Name 형식 Description
Microsoft.KeyVault

string

KeyVaultProperties

KeyVault의 속성

Name 형식 Description
identity.userAssignedIdentity

string

암호화를 위해 선택된 사용자 ID의 ARM ID
keyName

string

KeyVault의 키 이름
keyVaultUri

string

KeyVault의 URI
keyVersion

string

키 버전

ManagedServiceIdentityType

관리 서비스 ID의 유형입니다.

Name 형식 Description
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

PrivateEndpoint

이 연결에 대한 프라이빗 엔드포인트 리소스입니다.

Name 형식 Description
id

string

프라이빗 엔드포인트에 대한 ARM 식별자입니다.

PrivateEndpointConnection

프라이빗 엔드포인트 연결 목록입니다.

Name 형식 Description
id

string

리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location

string

리소스가 있는 지리적 위치
name

string

리소스의 이름입니다.
properties.privateEndpoint

PrivateEndpoint

이 연결에 대한 프라이빗 엔드포인트 리소스입니다.
properties.privateLinkServiceConnectionState

ConnectionState

연결 상태에 대한 세부 정보입니다.
properties.provisioningState

EndPointProvisioningState

프라이빗 엔드포인트 연결의 프로비전 상태입니다.
systemData

systemData

이 리소스와 관련된 시스템 메타 데이터입니다.
type

string

리소스 형식입니다. 예: "Microsoft.EventHub/Namespaces" 또는 "Microsoft.EventHub/Namespaces/EventHubs"

PrivateLinkConnectionStatus

연결의 상태입니다.

Name 형식 Description
Approved

string

Disconnected

string

Pending

string

Rejected

string

PublicNetworkAccess

이렇게 하면 공용 네트워크를 통해 트래픽이 허용되는지 여부가 결정됩니다. 기본적으로 사용하도록 설정됩니다.

Name 형식 Description
Disabled

string

Enabled

string

SecuredByPerimeter

string

Sku

sku 리소스의 속성

Name 형식 Description
capacity

integer

기본 또는 표준 계층에 대한 Event Hubs 처리량 단위입니다. 여기서 값은 0~20개의 처리량 단위여야 합니다. 프리미엄 계층에 대한 Event Hubs 프리미엄 단위입니다. 여기서 값은 0~10 프리미엄 단위여야 합니다.
name

SkuName

이 SKU의 이름입니다.
tier

SkuTier

이 특정 SKU의 청구 계층입니다.

SkuName

이 SKU의 이름입니다.

Name 형식 Description
Basic

string

Premium

string

Standard

string

SkuTier

이 특정 SKU의 청구 계층입니다.

Name 형식 Description
Basic

string

Premium

string

Standard

string

systemData

리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.

Name 형식 Description
createdAt

string

UTC(리소스 만들기)의 타임스탬프입니다.
createdBy

string

리소스를 만든 ID입니다.
createdByType

createdByType

리소스를 만든 ID의 형식입니다.
lastModifiedAt

string

리소스를 마지막으로 수정한 ID 유형입니다.
lastModifiedBy

string

리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType

createdByType

리소스를 마지막으로 수정한 ID 유형입니다.

TlsVersion

지원할 클러스터의 최소 TLS 버전(예: '1.2')

Name 형식 Description
1.0

string

1.1

string

1.2

string

UserAssignedIdentity

인식된 사전 값입니다.

Name 형식 Description
clientId

string

사용자 할당 ID의 클라이언트 ID
principalId

string

사용자 할당 ID의 보안 주체 ID