通过

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

EventHubManagementClient class

Package:
azure-arm-eventhub
Extends

AzureServiceClient

Constructors

EventHubManagementClient(ServiceClientCredentials, string, string, AzureServiceClientOptions)

Initializes a new instance of the EventHubManagementClient class.

Properties

acceptLanguage
apiVersion
consumerGroups
credentials
disasterRecoveryConfigs
eventHubs
generateClientRequestId
longRunningOperationRetryTimeout
namespaces
operations
regions
subscriptionId

Inherited Methods

addUserAgentInfo(any)

Adds custom information to user agent header
getLongRunningOperationResult<TResult>(HttpOperationResponse<TResult>, RequestOptions)
getLongRunningOperationResult<TResult>(HttpOperationResponse<TResult>, RequestOptions, ServiceCallback<TResult>)
getLongRunningOperationResult<TResult>(HttpOperationResponse<TResult>, ServiceCallback<TResult>)
getPackageJsonInfo(string)

Attempts to find package.json for the given azure nodejs package. If found, returns the name and version of the package by reading the package.json If package.json is not found, returns a default value.
sendLongRunningRequest<TResult>(LongRunningUrlBasedRequestPrepareOptions | LongRunningPathTemplateBasedRequestPrepareOptions)
sendLongRunningRequest<TResult>(LongRunningUrlBasedRequestPrepareOptions | LongRunningPathTemplateBasedRequestPrepareOptions, ServiceCallback<TResult>)
sendLongRunningRequestWithHttpOperationResponse<TResult>(LongRunningUrlBasedRequestPrepareOptions | LongRunningPathTemplateBasedRequestPrepareOptions)
sendRequest<TResult>(UrlBasedRequestPrepareOptions | PathTemplateBasedRequestPrepareOptions)
sendRequest<TResult>(UrlBasedRequestPrepareOptions | PathTemplateBasedRequestPrepareOptions, ServiceCallback<TResult>)
sendRequestWithHttpOperationResponse<TResult>(UrlBasedRequestPrepareOptions | PathTemplateBasedRequestPrepareOptions)

Constructor Details

EventHubManagementClient(ServiceClientCredentials, string, string, AzureServiceClientOptions)

Initializes a new instance of the EventHubManagementClient class.

new EventHubManagementClient(credentials: ServiceClientCredentials, subscriptionId: string, baseUri?: string, options?: AzureServiceClientOptions)

Parameters

credentials

ServiceClientCredentials

Credentials needed for the client to connect to Azure.

subscriptionId

string

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

baseUri

string

The base URI of the service.

options

AzureServiceClientOptions

The parameter options

Property Details

acceptLanguage 

acceptLanguage: string

Property Value

string

apiVersion 

apiVersion: string

Property Value

string

consumerGroups 

consumerGroups: ConsumerGroups

Property Value

ConsumerGroups

credentials 

credentials: ServiceClientCredentials

Property Value

ServiceClientCredentials

disasterRecoveryConfigs 

disasterRecoveryConfigs: DisasterRecoveryConfigs

Property Value

DisasterRecoveryConfigs

eventHubs 

eventHubs: EventHubs

Property Value

EventHubs

generateClientRequestId 

generateClientRequestId: boolean

Property Value

boolean

longRunningOperationRetryTimeout 

longRunningOperationRetryTimeout: number

Property Value

number

namespaces 

namespaces: Namespaces

Property Value

Namespaces

operations 

operations: Operations

Property Value

Operations

regions 

regions: Regions

Property Value

Regions

subscriptionId 

subscriptionId: string

Property Value

string

Inherited Method Details

addUserAgentInfo(any)

Adds custom information to user agent header

function addUserAgentInfo(additionalUserAgentInfo: any)

Parameters

additionalUserAgentInfo

any

information to be added to user agent header, as string.

Inherited From AzureServiceClient.addUserAgentInfo

getLongRunningOperationResult<TResult>(HttpOperationResponse<TResult>, RequestOptions) 

function getLongRunningOperationResult<TResult>(resultOfInitialRequest: HttpOperationResponse<TResult>, options?: RequestOptions): Promise<TResult>

Parameters

resultOfInitialRequest

HttpOperationResponse<TResult>

options

RequestOptions

Returns

Promise<TResult>

Inherited From AzureServiceClient.getLongRunningOperationResult

getLongRunningOperationResult<TResult>(HttpOperationResponse<TResult>, RequestOptions, ServiceCallback<TResult>) 

function getLongRunningOperationResult<TResult>(resultOfInitialRequest: HttpOperationResponse<TResult>, options: RequestOptions, callback: ServiceCallback<TResult>)

Parameters

resultOfInitialRequest

HttpOperationResponse<TResult>

options

RequestOptions

callback

ServiceCallback<TResult>

Inherited From AzureServiceClient.getLongRunningOperationResult

getLongRunningOperationResult<TResult>(HttpOperationResponse<TResult>, ServiceCallback<TResult>) 

function getLongRunningOperationResult<TResult>(resultOfInitialRequest: HttpOperationResponse<TResult>, callback: ServiceCallback<TResult>)

Parameters

resultOfInitialRequest

HttpOperationResponse<TResult>

callback

ServiceCallback<TResult>

Inherited From AzureServiceClient.getLongRunningOperationResult

getPackageJsonInfo(string)

Attempts to find package.json for the given azure nodejs package. If found, returns the name and version of the package by reading the package.json If package.json is not found, returns a default value.

function getPackageJsonInfo(managementClientDir: string): { name: string, version: string }

Parameters

managementClientDir

string

pass the directory of the specific azure management client.

Returns

{ name: string, version: string }

packageJsonInfo - "name" and "version" of the desired package.

Inherited From AzureServiceClient.getPackageJsonInfo

sendLongRunningRequest<TResult>(LongRunningUrlBasedRequestPrepareOptions | LongRunningPathTemplateBasedRequestPrepareOptions) 

function sendLongRunningRequest<TResult>(options: LongRunningUrlBasedRequestPrepareOptions | LongRunningPathTemplateBasedRequestPrepareOptions): Promise<TResult>

Parameters

options

LongRunningUrlBasedRequestPrepareOptions | LongRunningPathTemplateBasedRequestPrepareOptions

Returns

Promise<TResult>

Inherited From AzureServiceClient.sendLongRunningRequest

sendLongRunningRequest<TResult>(LongRunningUrlBasedRequestPrepareOptions | LongRunningPathTemplateBasedRequestPrepareOptions, ServiceCallback<TResult>) 

function sendLongRunningRequest<TResult>(options: LongRunningUrlBasedRequestPrepareOptions | LongRunningPathTemplateBasedRequestPrepareOptions, callback: ServiceCallback<TResult>)

Parameters

options

LongRunningUrlBasedRequestPrepareOptions | LongRunningPathTemplateBasedRequestPrepareOptions

callback

ServiceCallback<TResult>

Inherited From AzureServiceClient.sendLongRunningRequest

sendLongRunningRequestWithHttpOperationResponse<TResult>(LongRunningUrlBasedRequestPrepareOptions | LongRunningPathTemplateBasedRequestPrepareOptions) 

function sendLongRunningRequestWithHttpOperationResponse<TResult>(options: LongRunningUrlBasedRequestPrepareOptions | LongRunningPathTemplateBasedRequestPrepareOptions): Promise<HttpOperationResponse<TResult>>

Parameters

options

LongRunningUrlBasedRequestPrepareOptions | LongRunningPathTemplateBasedRequestPrepareOptions

Returns

Promise<HttpOperationResponse<TResult>>

Inherited From AzureServiceClient.sendLongRunningRequestWithHttpOperationResponse

sendRequest<TResult>(UrlBasedRequestPrepareOptions | PathTemplateBasedRequestPrepareOptions) 

function sendRequest<TResult>(options: UrlBasedRequestPrepareOptions | PathTemplateBasedRequestPrepareOptions): Promise<TResult>

Parameters

options

UrlBasedRequestPrepareOptions | PathTemplateBasedRequestPrepareOptions

Returns

Promise<TResult>

Inherited From AzureServiceClient.sendRequest

sendRequest<TResult>(UrlBasedRequestPrepareOptions | PathTemplateBasedRequestPrepareOptions, ServiceCallback<TResult>) 

function sendRequest<TResult>(options: UrlBasedRequestPrepareOptions | PathTemplateBasedRequestPrepareOptions, callback: ServiceCallback<TResult>)

Parameters

options

UrlBasedRequestPrepareOptions | PathTemplateBasedRequestPrepareOptions

callback

ServiceCallback<TResult>

Inherited From AzureServiceClient.sendRequest

sendRequestWithHttpOperationResponse<TResult>(UrlBasedRequestPrepareOptions | PathTemplateBasedRequestPrepareOptions) 

function sendRequestWithHttpOperationResponse<TResult>(options: UrlBasedRequestPrepareOptions | PathTemplateBasedRequestPrepareOptions): Promise<HttpOperationResponse<TResult>>

Parameters

options

UrlBasedRequestPrepareOptions | PathTemplateBasedRequestPrepareOptions

Returns

Promise<HttpOperationResponse<TResult>>

Inherited From AzureServiceClient.sendRequestWithHttpOperationResponse