Namespaces interface
表示命名空间的接口。
方法
方法详细信息
beginDelete(string, string, NamespacesDeleteOptionalParams)
删除现有命名空间。 此作还会删除命名空间下的所有关联 notificationHub。
function beginDelete(resourceGroupName: string, namespaceName: string, options?: NamespacesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>参数
- resourceGroupName
-
string
资源组的名称。
- namespaceName
-
string
命名空间名称。
- options
- NamespacesDeleteOptionalParams
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAndWait(string, string, NamespacesDeleteOptionalParams)
删除现有命名空间。 此作还会删除命名空间下的所有关联 notificationHub。
function beginDeleteAndWait(resourceGroupName: string, namespaceName: string, options?: NamespacesDeleteOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。
- namespaceName
-
string
命名空间名称。
- options
- NamespacesDeleteOptionalParams
选项参数。
返回
Promise<void>
checkAvailability(CheckAvailabilityParameters, NamespacesCheckAvailabilityOptionalParams)
检查所有 Azure 订阅中给定服务命名空间的可用性。 这很有用，因为域名是基于服务命名空间名称创建的。
function checkAvailability(parameters: CheckAvailabilityParameters, options?: NamespacesCheckAvailabilityOptionalParams): Promise<CheckAvailabilityResult>参数
- parameters
- CheckAvailabilityParameters
命名空间名称。
选项参数。
返回
Promise<CheckAvailabilityResult>
createOrUpdate(string, string, NamespaceCreateOrUpdateParameters, NamespacesCreateOrUpdateOptionalParams)
创建/更新服务命名空间。 创建后，此命名空间的资源清单是不可变的。 此作是幂等的。
function createOrUpdate(resourceGroupName: string, namespaceName: string, parameters: NamespaceCreateOrUpdateParameters, options?: NamespacesCreateOrUpdateOptionalParams): Promise<NamespaceResource>参数
- resourceGroupName
-
string
资源组的名称。
- namespaceName
-
string
命名空间名称。
- parameters
- NamespaceCreateOrUpdateParameters
提供用于创建命名空间资源的参数。
选项参数。
返回
Promise<NamespaceResource>
createOrUpdateAuthorizationRule(string, string, string, SharedAccessAuthorizationRuleCreateOrUpdateParameters, NamespacesCreateOrUpdateAuthorizationRuleOptionalParams)
为命名空间创建授权规则
function createOrUpdateAuthorizationRule(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, parameters: SharedAccessAuthorizationRuleCreateOrUpdateParameters, options?: NamespacesCreateOrUpdateAuthorizationRuleOptionalParams): Promise<SharedAccessAuthorizationRuleResource>参数
- resourceGroupName
-
string
资源组的名称。
- namespaceName
-
string
命名空间名称。
- authorizationRuleName
-
string
授权规则名称。
共享访问授权规则。
选项参数。
返回
deleteAuthorizationRule(string, string, string, NamespacesDeleteAuthorizationRuleOptionalParams)
删除命名空间授权规则
function deleteAuthorizationRule(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, options?: NamespacesDeleteAuthorizationRuleOptionalParams): Promise<void>参数
- resourceGroupName
-
string
资源组的名称。
- namespaceName
-
string
命名空间名称。
- authorizationRuleName
-
string
授权规则名称。
选项参数。
返回
Promise<void>
get(string, string, NamespacesGetOptionalParams)
返回指定命名空间的说明。
function get(resourceGroupName: string, namespaceName: string, options?: NamespacesGetOptionalParams): Promise<NamespaceResource>参数
- resourceGroupName
-
string
资源组的名称。
- namespaceName
-
string
命名空间名称。
- options
- NamespacesGetOptionalParams
选项参数。
返回
Promise<NamespaceResource>
getAuthorizationRule(string, string, string, NamespacesGetAuthorizationRuleOptionalParams)
按名称获取命名空间的授权规则。
function getAuthorizationRule(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, options?: NamespacesGetAuthorizationRuleOptionalParams): Promise<SharedAccessAuthorizationRuleResource>参数
- resourceGroupName
-
string
资源组的名称。
- namespaceName
-
string
命名空间名称
- authorizationRuleName
-
string
授权规则名称。
选项参数。
返回
list(string, NamespacesListOptionalParams)
列出 resourceGroup 中的可用命名空间。
function list(resourceGroupName: string, options?: NamespacesListOptionalParams): PagedAsyncIterableIterator<NamespaceResource, NamespaceResource[], PageSettings>参数
- resourceGroupName
-
string
资源组的名称。 如果 resourceGroupName 值为 null，则方法会列出订阅中的所有命名空间
- options
- NamespacesListOptionalParams
选项参数。
返回
listAll(NamespacesListAllOptionalParams)
列出订阅中的所有可用命名空间，而不考虑 resourceGroups。
function listAll(options?: NamespacesListAllOptionalParams): PagedAsyncIterableIterator<NamespaceResource, NamespaceResource[], PageSettings>参数
- options
- NamespacesListAllOptionalParams
选项参数。
返回
listAuthorizationRules(string, string, NamespacesListAuthorizationRulesOptionalParams)
获取命名空间的授权规则。
function listAuthorizationRules(resourceGroupName: string, namespaceName: string, options?: NamespacesListAuthorizationRulesOptionalParams): PagedAsyncIterableIterator<SharedAccessAuthorizationRuleResource, SharedAccessAuthorizationRuleResource[], PageSettings>参数
- resourceGroupName
-
string
资源组的名称。
- namespaceName
-
string
命名空间名称
选项参数。
返回
listKeys(string, string, string, NamespacesListKeysOptionalParams)
获取命名空间的主连接和辅助 ConnectionStrings
function listKeys(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, options?: NamespacesListKeysOptionalParams): Promise<ResourceListKeys>参数
- resourceGroupName
-
string
资源组的名称。
- namespaceName
-
string
命名空间名称。
- authorizationRuleName
-
string
指定 authorizationRule 命名空间的连接字符串。
- options
- NamespacesListKeysOptionalParams
选项参数。
返回
Promise<ResourceListKeys>
patch(string, string, NamespacePatchParameters, NamespacesPatchOptionalParams)
修补现有命名空间
function patch(resourceGroupName: string, namespaceName: string, parameters: NamespacePatchParameters, options?: NamespacesPatchOptionalParams): Promise<NamespaceResource>参数
- resourceGroupName
-
string
资源组的名称。
- namespaceName
-
string
命名空间名称。
- parameters
- NamespacePatchParameters
提供用于修补命名空间资源的参数。
- options
- NamespacesPatchOptionalParams
选项参数。
返回
Promise<NamespaceResource>
regenerateKeys(string, string, string, PolicykeyResource, NamespacesRegenerateKeysOptionalParams)
将主密钥/辅助密钥重新生成到命名空间授权规则
function regenerateKeys(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, parameters: PolicykeyResource, options?: NamespacesRegenerateKeysOptionalParams): Promise<ResourceListKeys>参数
- resourceGroupName
-
string
资源组的名称。
- namespaceName
-
string
命名空间名称。
- authorizationRuleName
-
string
指定 authorizationRule 命名空间的连接字符串。
- parameters
- PolicykeyResource
提供用于重新生成命名空间授权规则密钥的参数。
选项参数。
返回
Promise<ResourceListKeys>