Namespaces interface

Paquet:

@azure/arm-notificationhubs

Interface représentant des espaces de noms.

Méthodes

beginDelete(string, string, NamespacesDeleteOptionalParams)	Supprime un espace de noms existant. Cette opération supprime également tous les notificationHubs associés sous l’espace de noms.
beginDeleteAndWait(string, string, NamespacesDeleteOptionalParams)	Supprime un espace de noms existant. Cette opération supprime également tous les notificationHubs associés sous l’espace de noms.
checkAvailability(CheckAvailabilityParameters, NamespacesCheckAvailabilityOptionalParams)	Vérifie la disponibilité de l’espace de noms de service donné sur tous les abonnements Azure. Cela est utile, car le nom de domaine est créé en fonction du nom de l’espace de noms de service.
createOrUpdate(string, string, NamespaceCreateOrUpdateParameters, NamespacesCreateOrUpdateOptionalParams)	Crée/met à jour un espace de noms de service. Une fois créé, le manifeste de ressource de cet espace de noms est immuable. Cette opération est idempotente.
createOrUpdateAuthorizationRule(string, string, string, SharedAccessAuthorizationRuleCreateOrUpdateParameters, NamespacesCreateOrUpdateAuthorizationRuleOptionalParams)	Crée une règle d’autorisation pour un espace de noms
deleteAuthorizationRule(string, string, string, NamespacesDeleteAuthorizationRuleOptionalParams)	Supprime une règle d’autorisation d’espace de noms
get(string, string, NamespacesGetOptionalParams)	Retourne la description de l’espace de noms spécifié.
getAuthorizationRule(string, string, string, NamespacesGetAuthorizationRuleOptionalParams)	Obtient une règle d’autorisation pour un espace de noms par nom.
list(string, NamespacesListOptionalParams)	Répertorie les espaces de noms disponibles dans un groupe de ressources.
listAll(NamespacesListAllOptionalParams)	Répertorie tous les espaces de noms disponibles dans l’abonnement, quel que soit le groupe de ressources.
listAuthorizationRules(string, string, NamespacesListAuthorizationRulesOptionalParams)	Obtient les règles d’autorisation d’un espace de noms.
listKeys(string, string, string, NamespacesListKeysOptionalParams)	Obtient les chaînes de connexion primaire et secondaire à l’espace de noms
patch(string, string, NamespacePatchParameters, NamespacesPatchOptionalParams)	Corrige l’espace de noms existant
regenerateKeys(string, string, string, PolicykeyResource, NamespacesRegenerateKeysOptionalParams)	Régénère les clés primaires/secondaires dans la règle d’autorisation d’espace de noms

Détails de la méthode

beginDelete(string, string, NamespacesDeleteOptionalParams)

Supprime un espace de noms existant. Cette opération supprime également tous les notificationHubs associés sous l’espace de noms.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources.

namespaceName

string

Nom de l’espace de noms.

options

NamespacesDeleteOptionalParams

Paramètres d’options.

Retours

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

beginDeleteAndWait(string, string, NamespacesDeleteOptionalParams)

Supprime un espace de noms existant. Cette opération supprime également tous les notificationHubs associés sous l’espace de noms.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources.

namespaceName

string

Nom de l’espace de noms.

options

NamespacesDeleteOptionalParams

Paramètres d’options.

Retours

Promise<void>

checkAvailability(CheckAvailabilityParameters, NamespacesCheckAvailabilityOptionalParams)

Vérifie la disponibilité de l’espace de noms de service donné sur tous les abonnements Azure. Cela est utile, car le nom de domaine est créé en fonction du nom de l’espace de noms de service.

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

Paramètres

parameters

CheckAvailabilityParameters

Nom de l’espace de noms.

options

NamespacesCheckAvailabilityOptionalParams

Paramètres d’options.

Retours

Promise<CheckAvailabilityResult>

createOrUpdate(string, string, NamespaceCreateOrUpdateParameters, NamespacesCreateOrUpdateOptionalParams)

Crée/met à jour un espace de noms de service. Une fois créé, le manifeste de ressource de cet espace de noms est immuable. Cette opération est idempotente.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources.

namespaceName

string

Nom de l’espace de noms.

parameters

NamespaceCreateOrUpdateParameters

Paramètres fournis pour créer une ressource d’espace de noms.

options

NamespacesCreateOrUpdateOptionalParams

Paramètres d’options.

Retours

Promise<NamespaceResource>

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

Crée une règle d’autorisation pour un espace de noms

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources.

namespaceName

string

Nom de l’espace de noms.

authorizationRuleName

string

Nom de la règle d’autorisation.

parameters

SharedAccessAuthorizationRuleCreateOrUpdateParameters

Règle d’autorisation d’accès partagé.

options

NamespacesCreateOrUpdateAuthorizationRuleOptionalParams

Paramètres d’options.

Retours

Promise<SharedAccessAuthorizationRuleResource>

deleteAuthorizationRule(string, string, string, NamespacesDeleteAuthorizationRuleOptionalParams)

Supprime une règle d’autorisation d’espace de noms

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources.

namespaceName

string

Nom de l’espace de noms.

authorizationRuleName

string

Nom de la règle d’autorisation.

options

NamespacesDeleteAuthorizationRuleOptionalParams

Paramètres d’options.

Retours

Promise<void>

get(string, string, NamespacesGetOptionalParams)

Retourne la description de l’espace de noms spécifié.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources.

namespaceName

string

Nom de l’espace de noms.

options

NamespacesGetOptionalParams

Paramètres d’options.

Retours

Promise<NamespaceResource>

getAuthorizationRule(string, string, string, NamespacesGetAuthorizationRuleOptionalParams)

Obtient une règle d’autorisation pour un espace de noms par nom.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources.

namespaceName

string

Nom de l’espace de noms

authorizationRuleName

string

Nom de la règle d’autorisation.

options

NamespacesGetAuthorizationRuleOptionalParams

Paramètres d’options.

Retours

Promise<SharedAccessAuthorizationRuleResource>

list(string, NamespacesListOptionalParams)

Répertorie les espaces de noms disponibles dans un groupe de ressources.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Si la valeur resourceGroupName est null, la méthode répertorie tous les espaces de noms dans l’abonnement

options

NamespacesListOptionalParams

Paramètres d’options.

Retours

PagedAsyncIterableIterator<NamespaceResource, NamespaceResource[], PageSettings>

listAll(NamespacesListAllOptionalParams)

Répertorie tous les espaces de noms disponibles dans l’abonnement, quel que soit le groupe de ressources.

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

Paramètres

options

NamespacesListAllOptionalParams

Paramètres d’options.

Retours

PagedAsyncIterableIterator<NamespaceResource, NamespaceResource[], PageSettings>

listAuthorizationRules(string, string, NamespacesListAuthorizationRulesOptionalParams)

Obtient les règles d’autorisation d’un espace de noms.

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources.

namespaceName

string

Nom de l’espace de noms

options

NamespacesListAuthorizationRulesOptionalParams

Paramètres d’options.

Retours

PagedAsyncIterableIterator<SharedAccessAuthorizationRuleResource, SharedAccessAuthorizationRuleResource[], PageSettings>

listKeys(string, string, string, NamespacesListKeysOptionalParams)

Obtient les chaînes de connexion primaire et secondaire à l’espace de noms

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources.

namespaceName

string

Nom de l’espace de noms.

authorizationRuleName

string

Chaîne de connexion de l’espace de noms pour l’autorisationRule spécifiée.

options

NamespacesListKeysOptionalParams

Paramètres d’options.

Retours

Promise<ResourceListKeys>

patch(string, string, NamespacePatchParameters, NamespacesPatchOptionalParams)

Corrige l’espace de noms existant

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources.

namespaceName

string

Nom de l’espace de noms.

parameters

NamespacePatchParameters

Paramètres fournis pour corriger une ressource d’espace de noms.

options

NamespacesPatchOptionalParams

Paramètres d’options.

Retours

Promise<NamespaceResource>

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

Régénère les clés primaires/secondaires dans la règle d’autorisation d’espace de noms

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

Paramètres

resourceGroupName

string

Nom du groupe de ressources.

namespaceName

string

Nom de l’espace de noms.

authorizationRuleName

string

Chaîne de connexion de l’espace de noms pour l’autorisationRule spécifiée.

parameters

PolicykeyResource

Paramètres fournis pour régénérer la clé de règle d’autorisation d’espace de noms.

options

NamespacesRegenerateKeysOptionalParams

Paramètres d’options.

Retours

Promise<ResourceListKeys>