Queues interface
キューを表すインターフェイス。
メソッド
メソッドの詳細
createOrUpdate(string, string, string, SBQueue, QueuesCreateOrUpdateOptionalParams)
Service Bus キューを作成または更新します。 この操作はべき等です。
function createOrUpdate(resourceGroupName: string, namespaceName: string, queueName: string, parameters: SBQueue, options?: QueuesCreateOrUpdateOptionalParams): Promise<SBQueue>
パラメーター
- resourceGroupName
-
string
Azure サブスクリプション内のリソース グループの名前。
- namespaceName
-
string
名前空間名
- queueName
-
string
キュー名。
- parameters
- SBQueue
キュー リソースを作成または更新するために指定されたパラメーター。
オプション パラメーター。
戻り値
Promise<SBQueue>
createOrUpdateAuthorizationRule(string, string, string, string, SBAuthorizationRule, QueuesCreateOrUpdateAuthorizationRuleOptionalParams)
キューの承認規則を作成します。
function createOrUpdateAuthorizationRule(resourceGroupName: string, namespaceName: string, queueName: string, authorizationRuleName: string, parameters: SBAuthorizationRule, options?: QueuesCreateOrUpdateAuthorizationRuleOptionalParams): Promise<SBAuthorizationRule>
パラメーター
- resourceGroupName
-
string
Azure サブスクリプション内のリソース グループの名前。
- namespaceName
-
string
名前空間名
- queueName
-
string
キュー名。
- authorizationRuleName
-
string
承認規則の名前。
- parameters
- SBAuthorizationRule
共有アクセス承認規則。
オプション パラメーター。
戻り値
Promise<SBAuthorizationRule>
delete(string, string, string, QueuesDeleteOptionalParams)
リソース グループ内の指定した名前空間からキューを削除します。
function delete(resourceGroupName: string, namespaceName: string, queueName: string, options?: QueuesDeleteOptionalParams): Promise<void>
パラメーター
- resourceGroupName
-
string
Azure サブスクリプション内のリソース グループの名前。
- namespaceName
-
string
名前空間名
- queueName
-
string
キュー名。
- options
- QueuesDeleteOptionalParams
オプション パラメーター。
戻り値
Promise<void>
deleteAuthorizationRule(string, string, string, string, QueuesDeleteAuthorizationRuleOptionalParams)
キュー承認規則を削除します。
function deleteAuthorizationRule(resourceGroupName: string, namespaceName: string, queueName: string, authorizationRuleName: string, options?: QueuesDeleteAuthorizationRuleOptionalParams): Promise<void>
パラメーター
- resourceGroupName
-
string
Azure サブスクリプション内のリソース グループの名前。
- namespaceName
-
string
名前空間名
- queueName
-
string
キュー名。
- authorizationRuleName
-
string
承認規則の名前。
オプション パラメーター。
戻り値
Promise<void>
get(string, string, string, QueuesGetOptionalParams)
指定したキューの説明を返します。
function get(resourceGroupName: string, namespaceName: string, queueName: string, options?: QueuesGetOptionalParams): Promise<SBQueue>
パラメーター
- resourceGroupName
-
string
Azure サブスクリプション内のリソース グループの名前。
- namespaceName
-
string
名前空間名
- queueName
-
string
キュー名。
- options
- QueuesGetOptionalParams
オプション パラメーター。
戻り値
Promise<SBQueue>
getAuthorizationRule(string, string, string, string, QueuesGetAuthorizationRuleOptionalParams)
ルール名でキューの承認規則を取得します。
function getAuthorizationRule(resourceGroupName: string, namespaceName: string, queueName: string, authorizationRuleName: string, options?: QueuesGetAuthorizationRuleOptionalParams): Promise<SBAuthorizationRule>
パラメーター
- resourceGroupName
-
string
Azure サブスクリプション内のリソース グループの名前。
- namespaceName
-
string
名前空間名
- queueName
-
string
キュー名。
- authorizationRuleName
-
string
承認規則の名前。
オプション パラメーター。
戻り値
Promise<SBAuthorizationRule>
listAuthorizationRules(string, string, string, QueuesListAuthorizationRulesOptionalParams)
キューのすべての承認規則を取得します。
function listAuthorizationRules(resourceGroupName: string, namespaceName: string, queueName: string, options?: QueuesListAuthorizationRulesOptionalParams): PagedAsyncIterableIterator<SBAuthorizationRule, SBAuthorizationRule[], PageSettings>
パラメーター
- resourceGroupName
-
string
Azure サブスクリプション内のリソース グループの名前。
- namespaceName
-
string
名前空間名
- queueName
-
string
キュー名。
オプション パラメーター。
戻り値
listByNamespace(string, string, QueuesListByNamespaceOptionalParams)
名前空間内のキューを取得します。
function listByNamespace(resourceGroupName: string, namespaceName: string, options?: QueuesListByNamespaceOptionalParams): PagedAsyncIterableIterator<SBQueue, SBQueue[], PageSettings>
パラメーター
- resourceGroupName
-
string
Azure サブスクリプション内のリソース グループの名前。
- namespaceName
-
string
名前空間名
オプション パラメーター。
戻り値
listKeys(string, string, string, string, QueuesListKeysOptionalParams)
キューへのプライマリ接続文字列とセカンダリ接続文字列。
function listKeys(resourceGroupName: string, namespaceName: string, queueName: string, authorizationRuleName: string, options?: QueuesListKeysOptionalParams): Promise<AccessKeys>
パラメーター
- resourceGroupName
-
string
Azure サブスクリプション内のリソース グループの名前。
- namespaceName
-
string
名前空間名
- queueName
-
string
キュー名。
- authorizationRuleName
-
string
承認規則の名前。
- options
- QueuesListKeysOptionalParams
オプション パラメーター。
戻り値
Promise<AccessKeys>
regenerateKeys(string, string, string, string, RegenerateAccessKeyParameters, QueuesRegenerateKeysOptionalParams)
キューへのプライマリ接続文字列またはセカンダリ接続文字列を再生成します。
function regenerateKeys(resourceGroupName: string, namespaceName: string, queueName: string, authorizationRuleName: string, parameters: RegenerateAccessKeyParameters, options?: QueuesRegenerateKeysOptionalParams): Promise<AccessKeys>
パラメーター
- resourceGroupName
-
string
Azure サブスクリプション内のリソース グループの名前。
- namespaceName
-
string
名前空間名
- queueName
-
string
キュー名。
- authorizationRuleName
-
string
承認規則の名前。
- parameters
- RegenerateAccessKeyParameters
承認規則を再生成するために指定されたパラメーター。
オプション パラメーター。
戻り値
Promise<AccessKeys>