EventHubs interface
EventHubs を表すインターフェイス。
メソッド
メソッドの詳細
createOrUpdate(string, string, string, Eventhub, EventHubsCreateOrUpdateOptionalParams)
名前空間内の入れ子になったリソースとして新しいイベント ハブを作成または更新します。
function createOrUpdate(resourceGroupName: string, namespaceName: string, eventHubName: string, parameters: Eventhub, options?: EventHubsCreateOrUpdateOptionalParams): Promise<Eventhub>
パラメーター
- resourceGroupName
-
string
Azure サブスクリプション内のリソース グループの名前。
- namespaceName
-
string
名前空間名
- eventHubName
-
string
イベント ハブ名
- parameters
- Eventhub
イベント ハブ リソースを作成するために指定されたパラメーター。
options パラメーター。
戻り値
Promise<Eventhub>
createOrUpdateAuthorizationRule(string, string, string, string, AuthorizationRule, EventHubsCreateOrUpdateAuthorizationRuleOptionalParams)
指定したイベント ハブの AuthorizationRule を作成または更新します。 AuthorizationRule の作成/更新が有効になるには数秒かかります。
function createOrUpdateAuthorizationRule(resourceGroupName: string, namespaceName: string, eventHubName: string, authorizationRuleName: string, parameters: AuthorizationRule, options?: EventHubsCreateOrUpdateAuthorizationRuleOptionalParams): Promise<AuthorizationRule>
パラメーター
- resourceGroupName
-
string
Azure サブスクリプション内のリソース グループの名前。
- namespaceName
-
string
名前空間名
- eventHubName
-
string
イベント ハブ名
- authorizationRuleName
-
string
承認規則の名前。
- parameters
- AuthorizationRule
共有アクセス AuthorizationRule。
options パラメーター。
戻り値
Promise<AuthorizationRule>
delete(string, string, string, EventHubsDeleteOptionalParams)
指定した名前空間とリソース グループからイベント ハブを削除します。
function delete(resourceGroupName: string, namespaceName: string, eventHubName: string, options?: EventHubsDeleteOptionalParams): Promise<void>
パラメーター
- resourceGroupName
-
string
Azure サブスクリプション内のリソース グループの名前。
- namespaceName
-
string
名前空間名
- eventHubName
-
string
イベント ハブ名
- options
- EventHubsDeleteOptionalParams
options パラメーター。
戻り値
Promise<void>
deleteAuthorizationRule(string, string, string, string, EventHubsDeleteAuthorizationRuleOptionalParams)
イベント ハブの AuthorizationRule を削除します。
function deleteAuthorizationRule(resourceGroupName: string, namespaceName: string, eventHubName: string, authorizationRuleName: string, options?: EventHubsDeleteAuthorizationRuleOptionalParams): Promise<void>
パラメーター
- resourceGroupName
-
string
Azure サブスクリプション内のリソース グループの名前。
- namespaceName
-
string
名前空間名
- eventHubName
-
string
イベント ハブ名
- authorizationRuleName
-
string
承認規則の名前。
options パラメーター。
戻り値
Promise<void>
get(string, string, string, EventHubsGetOptionalParams)
指定したイベント ハブの Event Hubs の説明を取得します。
function get(resourceGroupName: string, namespaceName: string, eventHubName: string, options?: EventHubsGetOptionalParams): Promise<Eventhub>
パラメーター
- resourceGroupName
-
string
Azure サブスクリプション内のリソース グループの名前。
- namespaceName
-
string
名前空間名
- eventHubName
-
string
イベント ハブ名
- options
- EventHubsGetOptionalParams
options パラメーター。
戻り値
Promise<Eventhub>
getAuthorizationRule(string, string, string, string, EventHubsGetAuthorizationRuleOptionalParams)
ルール名でイベント ハブの AuthorizationRule を取得します。
function getAuthorizationRule(resourceGroupName: string, namespaceName: string, eventHubName: string, authorizationRuleName: string, options?: EventHubsGetAuthorizationRuleOptionalParams): Promise<AuthorizationRule>
パラメーター
- resourceGroupName
-
string
Azure サブスクリプション内のリソース グループの名前。
- namespaceName
-
string
名前空間名
- eventHubName
-
string
イベント ハブ名
- authorizationRuleName
-
string
承認規則の名前。
options パラメーター。
戻り値
Promise<AuthorizationRule>
listAuthorizationRules(string, string, string, EventHubsListAuthorizationRulesOptionalParams)
イベント ハブの承認規則を取得します。
function listAuthorizationRules(resourceGroupName: string, namespaceName: string, eventHubName: string, options?: EventHubsListAuthorizationRulesOptionalParams): PagedAsyncIterableIterator<AuthorizationRule, AuthorizationRule[], PageSettings>
パラメーター
- resourceGroupName
-
string
Azure サブスクリプション内のリソース グループの名前。
- namespaceName
-
string
名前空間名
- eventHubName
-
string
イベント ハブ名
options パラメーター。
戻り値
listByNamespace(string, string, EventHubsListByNamespaceOptionalParams)
名前空間内のすべての Event Hubs を取得します。
function listByNamespace(resourceGroupName: string, namespaceName: string, options?: EventHubsListByNamespaceOptionalParams): PagedAsyncIterableIterator<Eventhub, Eventhub[], PageSettings>
パラメーター
- resourceGroupName
-
string
Azure サブスクリプション内のリソース グループの名前。
- namespaceName
-
string
名前空間名
options パラメーター。
戻り値
listKeys(string, string, string, string, EventHubsListKeysOptionalParams)
イベント ハブの ACS 接続文字列と SAS 接続文字列を取得します。
function listKeys(resourceGroupName: string, namespaceName: string, eventHubName: string, authorizationRuleName: string, options?: EventHubsListKeysOptionalParams): Promise<AccessKeys>
パラメーター
- resourceGroupName
-
string
Azure サブスクリプション内のリソース グループの名前。
- namespaceName
-
string
名前空間名
- eventHubName
-
string
イベント ハブ名
- authorizationRuleName
-
string
承認規則の名前。
- options
- EventHubsListKeysOptionalParams
options パラメーター。
戻り値
Promise<AccessKeys>
regenerateKeys(string, string, string, string, RegenerateAccessKeyParameters, EventHubsRegenerateKeysOptionalParams)
イベント ハブの ACS 接続文字列と SAS 接続文字列を再生成します。
function regenerateKeys(resourceGroupName: string, namespaceName: string, eventHubName: string, authorizationRuleName: string, parameters: RegenerateAccessKeyParameters, options?: EventHubsRegenerateKeysOptionalParams): Promise<AccessKeys>
パラメーター
- resourceGroupName
-
string
Azure サブスクリプション内のリソース グループの名前。
- namespaceName
-
string
名前空間名
- eventHubName
-
string
イベント ハブ名
- authorizationRuleName
-
string
承認規則の名前。
- parameters
- RegenerateAccessKeyParameters
AuthorizationRule キー (PrimaryKey/SecondaryKey) を再生成するために指定されたパラメーター。
options パラメーター。
戻り値
Promise<AccessKeys>