Topics interface
トピックを表すインターフェイス。
メソッド
メソッドの詳細
createOrUpdate(string, string, string, SBTopic, TopicsCreateOrUpdateOptionalParams)
指定した名前空間にトピックを作成します。
function createOrUpdate(resourceGroupName: string, namespaceName: string, topicName: string, parameters: SBTopic, options?: TopicsCreateOrUpdateOptionalParams): Promise<SBTopic>
パラメーター
- resourceGroupName
-
string
Azure サブスクリプション内のリソース グループの名前。
- namespaceName
-
string
名前空間名
- topicName
-
string
トピック名。
- parameters
- SBTopic
トピック リソースを作成するために指定されたパラメーター。
オプション パラメーター。
戻り値
Promise<SBTopic>
createOrUpdateAuthorizationRule(string, string, string, string, SBAuthorizationRule, TopicsCreateOrUpdateAuthorizationRuleOptionalParams)
指定したトピックの承認規則を作成します。
function createOrUpdateAuthorizationRule(resourceGroupName: string, namespaceName: string, topicName: string, authorizationRuleName: string, parameters: SBAuthorizationRule, options?: TopicsCreateOrUpdateAuthorizationRuleOptionalParams): Promise<SBAuthorizationRule>
パラメーター
- resourceGroupName
-
string
Azure サブスクリプション内のリソース グループの名前。
- namespaceName
-
string
名前空間名
- topicName
-
string
トピック名。
- authorizationRuleName
-
string
承認規則の名前。
- parameters
- SBAuthorizationRule
共有アクセス承認規則。
オプション パラメーター。
戻り値
Promise<SBAuthorizationRule>
delete(string, string, string, TopicsDeleteOptionalParams)
指定した名前空間とリソース グループからトピックを削除します。
function delete(resourceGroupName: string, namespaceName: string, topicName: string, options?: TopicsDeleteOptionalParams): Promise<void>
パラメーター
- resourceGroupName
-
string
Azure サブスクリプション内のリソース グループの名前。
- namespaceName
-
string
名前空間名
- topicName
-
string
トピック名。
- options
- TopicsDeleteOptionalParams
オプション パラメーター。
戻り値
Promise<void>
deleteAuthorizationRule(string, string, string, string, TopicsDeleteAuthorizationRuleOptionalParams)
トピック承認規則を削除します。
function deleteAuthorizationRule(resourceGroupName: string, namespaceName: string, topicName: string, authorizationRuleName: string, options?: TopicsDeleteAuthorizationRuleOptionalParams): Promise<void>
パラメーター
- resourceGroupName
-
string
Azure サブスクリプション内のリソース グループの名前。
- namespaceName
-
string
名前空間名
- topicName
-
string
トピック名。
- authorizationRuleName
-
string
承認規則の名前。
オプション パラメーター。
戻り値
Promise<void>
get(string, string, string, TopicsGetOptionalParams)
指定したトピックの説明を返します。
function get(resourceGroupName: string, namespaceName: string, topicName: string, options?: TopicsGetOptionalParams): Promise<SBTopic>
パラメーター
- resourceGroupName
-
string
Azure サブスクリプション内のリソース グループの名前。
- namespaceName
-
string
名前空間名
- topicName
-
string
トピック名。
- options
- TopicsGetOptionalParams
オプション パラメーター。
戻り値
Promise<SBTopic>
getAuthorizationRule(string, string, string, string, TopicsGetAuthorizationRuleOptionalParams)
指定した承認規則を返します。
function getAuthorizationRule(resourceGroupName: string, namespaceName: string, topicName: string, authorizationRuleName: string, options?: TopicsGetAuthorizationRuleOptionalParams): Promise<SBAuthorizationRule>
パラメーター
- resourceGroupName
-
string
Azure サブスクリプション内のリソース グループの名前。
- namespaceName
-
string
名前空間名
- topicName
-
string
トピック名。
- authorizationRuleName
-
string
承認規則の名前。
オプション パラメーター。
戻り値
Promise<SBAuthorizationRule>
listAuthorizationRules(string, string, string, TopicsListAuthorizationRulesOptionalParams)
トピックの承認規則を取得します。
function listAuthorizationRules(resourceGroupName: string, namespaceName: string, topicName: string, options?: TopicsListAuthorizationRulesOptionalParams): PagedAsyncIterableIterator<SBAuthorizationRule, SBAuthorizationRule[], PageSettings>
パラメーター
- resourceGroupName
-
string
Azure サブスクリプション内のリソース グループの名前。
- namespaceName
-
string
名前空間名
- topicName
-
string
トピック名。
オプション パラメーター。
戻り値
listByNamespace(string, string, TopicsListByNamespaceOptionalParams)
名前空間内のすべてのトピックを取得します。
function listByNamespace(resourceGroupName: string, namespaceName: string, options?: TopicsListByNamespaceOptionalParams): PagedAsyncIterableIterator<SBTopic, SBTopic[], PageSettings>
パラメーター
- resourceGroupName
-
string
Azure サブスクリプション内のリソース グループの名前。
- namespaceName
-
string
名前空間名
オプション パラメーター。
戻り値
listKeys(string, string, string, string, TopicsListKeysOptionalParams)
トピックのプライマリ接続文字列とセカンダリ接続文字列を取得します。
function listKeys(resourceGroupName: string, namespaceName: string, topicName: string, authorizationRuleName: string, options?: TopicsListKeysOptionalParams): Promise<AccessKeys>
パラメーター
- resourceGroupName
-
string
Azure サブスクリプション内のリソース グループの名前。
- namespaceName
-
string
名前空間名
- topicName
-
string
トピック名。
- authorizationRuleName
-
string
承認規則の名前。
- options
- TopicsListKeysOptionalParams
オプション パラメーター。
戻り値
Promise<AccessKeys>
regenerateKeys(string, string, string, string, RegenerateAccessKeyParameters, TopicsRegenerateKeysOptionalParams)
トピックのプライマリ接続文字列またはセカンダリ接続文字列を再生成します。
function regenerateKeys(resourceGroupName: string, namespaceName: string, topicName: string, authorizationRuleName: string, parameters: RegenerateAccessKeyParameters, options?: TopicsRegenerateKeysOptionalParams): Promise<AccessKeys>
パラメーター
- resourceGroupName
-
string
Azure サブスクリプション内のリソース グループの名前。
- namespaceName
-
string
名前空間名
- topicName
-
string
トピック名。
- authorizationRuleName
-
string
承認規則の名前。
- parameters
- RegenerateAccessKeyParameters
承認規則を再生成するために指定されたパラメーター。
オプション パラメーター。
戻り値
Promise<AccessKeys>