Namespaces interface

Paquete:

@azure/arm-notificationhubs

Interfaz que representa un espacio de nombres.

Métodos

beginDelete(string, string, NamespacesDeleteOptionalParams)	Elimina un espacio de nombres existente. Esta operación también quita todos los notificationHub asociados en el espacio de nombres.
beginDeleteAndWait(string, string, NamespacesDeleteOptionalParams)	Elimina un espacio de nombres existente. Esta operación también quita todos los notificationHub asociados en el espacio de nombres.
checkAvailability(CheckAvailabilityParameters, NamespacesCheckAvailabilityOptionalParams)	Comprueba la disponibilidad del espacio de nombres de servicio determinado en todas las suscripciones de Azure. Esto resulta útil porque el nombre de dominio se crea en función del nombre del espacio de nombres del servicio.
createOrUpdate(string, string, NamespaceCreateOrUpdateParameters, NamespacesCreateOrUpdateOptionalParams)	Crea o actualiza un espacio de nombres de servicio. Una vez creado, el manifiesto de recursos de este espacio de nombres es inmutable. Esta operación es idempotente.
createOrUpdateAuthorizationRule(string, string, string, SharedAccessAuthorizationRuleCreateOrUpdateParameters, NamespacesCreateOrUpdateAuthorizationRuleOptionalParams)	Crea una regla de autorización para un espacio de nombres.
deleteAuthorizationRule(string, string, string, NamespacesDeleteAuthorizationRuleOptionalParams)	Elimina una regla de autorización de espacio de nombres.
get(string, string, NamespacesGetOptionalParams)	Devuelve la descripción del espacio de nombres especificado.
getAuthorizationRule(string, string, string, NamespacesGetAuthorizationRuleOptionalParams)	Obtiene una regla de autorización para un espacio de nombres por nombre.
list(string, NamespacesListOptionalParams)	Enumera los espacios de nombres disponibles dentro de un resourceGroup.
listAll(NamespacesListAllOptionalParams)	Enumera todos los espacios de nombres disponibles dentro de la suscripción independientemente de resourceGroups.
listAuthorizationRules(string, string, NamespacesListAuthorizationRulesOptionalParams)	Obtiene las reglas de autorización de un espacio de nombres.
listKeys(string, string, string, NamespacesListKeysOptionalParams)	Obtiene connectionStrings principal y secundario al espacio de nombres.
patch(string, string, NamespacePatchParameters, NamespacesPatchOptionalParams)	Parches del espacio de nombres existente
regenerateKeys(string, string, string, PolicykeyResource, NamespacesRegenerateKeysOptionalParams)	Regenera las claves principales o secundarias en la regla de autorización del espacio de nombres.

Detalles del método

beginDelete(string, string, NamespacesDeleteOptionalParams)

Elimina un espacio de nombres existente. Esta operación también quita todos los notificationHub asociados en el espacio de nombres.

function beginDelete(resourceGroupName: string, namespaceName: string, options?: NamespacesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos.

namespaceName

string

Nombre del espacio de nombres.

options

NamespacesDeleteOptionalParams

Parámetros de opciones.

Devoluciones

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, NamespacesDeleteOptionalParams)

Elimina un espacio de nombres existente. Esta operación también quita todos los notificationHub asociados en el espacio de nombres.

function beginDeleteAndWait(resourceGroupName: string, namespaceName: string, options?: NamespacesDeleteOptionalParams): Promise<void>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos.

namespaceName

string

Nombre del espacio de nombres.

options

NamespacesDeleteOptionalParams

Parámetros de opciones.

Devoluciones

Promise<void>

checkAvailability(CheckAvailabilityParameters, NamespacesCheckAvailabilityOptionalParams)

Comprueba la disponibilidad del espacio de nombres de servicio determinado en todas las suscripciones de Azure. Esto resulta útil porque el nombre de dominio se crea en función del nombre del espacio de nombres del servicio.

function checkAvailability(parameters: CheckAvailabilityParameters, options?: NamespacesCheckAvailabilityOptionalParams): Promise<CheckAvailabilityResult>

Parámetros

parameters

CheckAvailabilityParameters

Nombre del espacio de nombres.

options

NamespacesCheckAvailabilityOptionalParams

Parámetros de opciones.

Devoluciones

Promise<CheckAvailabilityResult>

createOrUpdate(string, string, NamespaceCreateOrUpdateParameters, NamespacesCreateOrUpdateOptionalParams)

Crea o actualiza un espacio de nombres de servicio. Una vez creado, el manifiesto de recursos de este espacio de nombres es inmutable. Esta operación es idempotente.

function createOrUpdate(resourceGroupName: string, namespaceName: string, parameters: NamespaceCreateOrUpdateParameters, options?: NamespacesCreateOrUpdateOptionalParams): Promise<NamespaceResource>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos.

namespaceName

string

Nombre del espacio de nombres.

parameters

NamespaceCreateOrUpdateParameters

Parámetros proporcionados para crear un recurso de espacio de nombres.

options

NamespacesCreateOrUpdateOptionalParams

Parámetros de opciones.

Devoluciones

Promise<NamespaceResource>

createOrUpdateAuthorizationRule(string, string, string, SharedAccessAuthorizationRuleCreateOrUpdateParameters, NamespacesCreateOrUpdateAuthorizationRuleOptionalParams)

Crea una regla de autorización para un espacio de nombres.

function createOrUpdateAuthorizationRule(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, parameters: SharedAccessAuthorizationRuleCreateOrUpdateParameters, options?: NamespacesCreateOrUpdateAuthorizationRuleOptionalParams): Promise<SharedAccessAuthorizationRuleResource>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos.

namespaceName

string

Nombre del espacio de nombres.

authorizationRuleName

string

Nombre de la regla de autorización.

parameters

SharedAccessAuthorizationRuleCreateOrUpdateParameters

Regla de autorización de acceso compartido.

options

NamespacesCreateOrUpdateAuthorizationRuleOptionalParams

Parámetros de opciones.

Devoluciones

Promise<SharedAccessAuthorizationRuleResource>

deleteAuthorizationRule(string, string, string, NamespacesDeleteAuthorizationRuleOptionalParams)

Elimina una regla de autorización de espacio de nombres.

function deleteAuthorizationRule(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, options?: NamespacesDeleteAuthorizationRuleOptionalParams): Promise<void>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos.

namespaceName

string

Nombre del espacio de nombres.

authorizationRuleName

string

Nombre de la regla de autorización.

options

NamespacesDeleteAuthorizationRuleOptionalParams

Parámetros de opciones.

Devoluciones

Promise<void>

get(string, string, NamespacesGetOptionalParams)

Devuelve la descripción del espacio de nombres especificado.

function get(resourceGroupName: string, namespaceName: string, options?: NamespacesGetOptionalParams): Promise<NamespaceResource>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos.

namespaceName

string

Nombre del espacio de nombres.

options

NamespacesGetOptionalParams

Parámetros de opciones.

Devoluciones

Promise<NamespaceResource>

getAuthorizationRule(string, string, string, NamespacesGetAuthorizationRuleOptionalParams)

Obtiene una regla de autorización para un espacio de nombres por nombre.

function getAuthorizationRule(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, options?: NamespacesGetAuthorizationRuleOptionalParams): Promise<SharedAccessAuthorizationRuleResource>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos.

namespaceName

string

Nombre del espacio de nombres

authorizationRuleName

string

Nombre de la regla de autorización.

options

NamespacesGetAuthorizationRuleOptionalParams

Parámetros de opciones.

Devoluciones

Promise<SharedAccessAuthorizationRuleResource>

list(string, NamespacesListOptionalParams)

Enumera los espacios de nombres disponibles dentro de un resourceGroup.

function list(resourceGroupName: string, options?: NamespacesListOptionalParams): PagedAsyncIterableIterator<NamespaceResource, NamespaceResource[], PageSettings>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. Si el valor resourceGroupName es NULL, el método enumera todos los espacios de nombres de la suscripción.

options

NamespacesListOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<NamespaceResource, NamespaceResource[], PageSettings>

listAll(NamespacesListAllOptionalParams)

Enumera todos los espacios de nombres disponibles dentro de la suscripción independientemente de resourceGroups.

function listAll(options?: NamespacesListAllOptionalParams): PagedAsyncIterableIterator<NamespaceResource, NamespaceResource[], PageSettings>

Parámetros

options

NamespacesListAllOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<NamespaceResource, NamespaceResource[], PageSettings>

listAuthorizationRules(string, string, NamespacesListAuthorizationRulesOptionalParams)

Obtiene las reglas de autorización de un espacio de nombres.

function listAuthorizationRules(resourceGroupName: string, namespaceName: string, options?: NamespacesListAuthorizationRulesOptionalParams): PagedAsyncIterableIterator<SharedAccessAuthorizationRuleResource, SharedAccessAuthorizationRuleResource[], PageSettings>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos.

namespaceName

string

Nombre del espacio de nombres

options

NamespacesListAuthorizationRulesOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<SharedAccessAuthorizationRuleResource, SharedAccessAuthorizationRuleResource[], PageSettings>

listKeys(string, string, string, NamespacesListKeysOptionalParams)

Obtiene connectionStrings principal y secundario al espacio de nombres.

function listKeys(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, options?: NamespacesListKeysOptionalParams): Promise<ResourceListKeys>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos.

namespaceName

string

Nombre del espacio de nombres.

authorizationRuleName

string

Cadena de conexión del espacio de nombres para la authorizationRule especificada.

options

NamespacesListKeysOptionalParams

Parámetros de opciones.

Devoluciones

Promise<ResourceListKeys>

patch(string, string, NamespacePatchParameters, NamespacesPatchOptionalParams)

Parches del espacio de nombres existente

function patch(resourceGroupName: string, namespaceName: string, parameters: NamespacePatchParameters, options?: NamespacesPatchOptionalParams): Promise<NamespaceResource>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos.

namespaceName

string

Nombre del espacio de nombres.

parameters

NamespacePatchParameters

Parámetros proporcionados para aplicar revisiones a un recurso de espacio de nombres.

options

NamespacesPatchOptionalParams

Parámetros de opciones.

Devoluciones

Promise<NamespaceResource>

regenerateKeys(string, string, string, PolicykeyResource, NamespacesRegenerateKeysOptionalParams)

Regenera las claves principales o secundarias en la regla de autorización del espacio de nombres.

function regenerateKeys(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, parameters: PolicykeyResource, options?: NamespacesRegenerateKeysOptionalParams): Promise<ResourceListKeys>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos.

namespaceName

string

Nombre del espacio de nombres.

authorizationRuleName

string

Cadena de conexión del espacio de nombres para la authorizationRule especificada.

parameters

PolicykeyResource

Parámetros proporcionados para volver a generar la clave de regla de autorización del espacio de nombres.

options

NamespacesRegenerateKeysOptionalParams

Parámetros de opciones.

Devoluciones

Promise<ResourceListKeys>