NamespacesOperations interface

Package:

@azure/arm-eventgrid

Interface representing a Namespaces operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
beginRegenerateKey
beginRegenerateKeyAndWait
beginUpdate
beginUpdateAndWait
beginValidateCustomDomainOwnership
beginValidateCustomDomainOwnershipAndWait
createOrUpdate	Asynchronously creates or updates a new namespace with the specified parameters.
delete
get	Get properties of a namespace.
listByResourceGroup	List all the namespaces under a resource group.
listBySubscription	List all the namespaces under an Azure subscription.
listSharedAccessKeys	List the two keys used to publish to a namespace.
regenerateKey	Regenerate a shared access key for a namespace.
update	Asynchronously updates a namespace with the specified parameters.
validateCustomDomainOwnership	Performs ownership validation via checking TXT records for all custom domains in a namespace.

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdate: (resourceGroupName: string, namespaceName: string, namespaceInfo: Namespace, options?: NamespacesCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Namespace>, Namespace>>

Property Value

(resourceGroupName: string, namespaceName: string, namespaceInfo: Namespace, options?: NamespacesCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Namespace>, Namespace>>

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdateAndWait: (resourceGroupName: string, namespaceName: string, namespaceInfo: Namespace, options?: NamespacesCreateOrUpdateOptionalParams) => Promise<Namespace>

Property Value

(resourceGroupName: string, namespaceName: string, namespaceInfo: Namespace, options?: NamespacesCreateOrUpdateOptionalParams) => Promise<Namespace>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, namespaceName: string, options?: NamespacesDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, namespaceName: string, options?: NamespacesDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginRegenerateKey

Warning

This API is now deprecated.

use regenerateKey instead

beginRegenerateKey: (resourceGroupName: string, namespaceName: string, regenerateKeyRequest: NamespaceRegenerateKeyRequest, options?: NamespacesRegenerateKeyOptionalParams) => Promise<SimplePollerLike<OperationState<NamespaceSharedAccessKeys>, NamespaceSharedAccessKeys>>

Property Value

(resourceGroupName: string, namespaceName: string, regenerateKeyRequest: NamespaceRegenerateKeyRequest, options?: NamespacesRegenerateKeyOptionalParams) => Promise<SimplePollerLike<OperationState<NamespaceSharedAccessKeys>, NamespaceSharedAccessKeys>>

beginRegenerateKeyAndWait

Warning

This API is now deprecated.

use regenerateKey instead

beginRegenerateKeyAndWait: (resourceGroupName: string, namespaceName: string, regenerateKeyRequest: NamespaceRegenerateKeyRequest, options?: NamespacesRegenerateKeyOptionalParams) => Promise<NamespaceSharedAccessKeys>

Property Value

(resourceGroupName: string, namespaceName: string, regenerateKeyRequest: NamespaceRegenerateKeyRequest, options?: NamespacesRegenerateKeyOptionalParams) => Promise<NamespaceSharedAccessKeys>

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (resourceGroupName: string, namespaceName: string, namespaceUpdateParameters: NamespaceUpdateParameters, options?: NamespacesUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Namespace>, Namespace>>

Property Value

(resourceGroupName: string, namespaceName: string, namespaceUpdateParameters: NamespaceUpdateParameters, options?: NamespacesUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Namespace>, Namespace>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (resourceGroupName: string, namespaceName: string, namespaceUpdateParameters: NamespaceUpdateParameters, options?: NamespacesUpdateOptionalParams) => Promise<Namespace>

Property Value

(resourceGroupName: string, namespaceName: string, namespaceUpdateParameters: NamespaceUpdateParameters, options?: NamespacesUpdateOptionalParams) => Promise<Namespace>

beginValidateCustomDomainOwnership

Warning

This API is now deprecated.

use validateCustomDomainOwnership instead

beginValidateCustomDomainOwnership: (resourceGroupName: string, namespaceName: string, options?: NamespacesValidateCustomDomainOwnershipOptionalParams) => Promise<SimplePollerLike<OperationState<CustomDomainOwnershipValidationResult>, CustomDomainOwnershipValidationResult>>

Property Value

(resourceGroupName: string, namespaceName: string, options?: NamespacesValidateCustomDomainOwnershipOptionalParams) => Promise<SimplePollerLike<OperationState<CustomDomainOwnershipValidationResult>, CustomDomainOwnershipValidationResult>>

beginValidateCustomDomainOwnershipAndWait

Warning

This API is now deprecated.

use validateCustomDomainOwnership instead

beginValidateCustomDomainOwnershipAndWait: (resourceGroupName: string, namespaceName: string, options?: NamespacesValidateCustomDomainOwnershipOptionalParams) => Promise<CustomDomainOwnershipValidationResult>

Property Value

(resourceGroupName: string, namespaceName: string, options?: NamespacesValidateCustomDomainOwnershipOptionalParams) => Promise<CustomDomainOwnershipValidationResult>

createOrUpdate

Asynchronously creates or updates a new namespace with the specified parameters.

createOrUpdate: (resourceGroupName: string, namespaceName: string, namespaceInfo: Namespace, options?: NamespacesCreateOrUpdateOptionalParams) => PollerLike<OperationState<Namespace>, Namespace>

Property Value

(resourceGroupName: string, namespaceName: string, namespaceInfo: Namespace, options?: NamespacesCreateOrUpdateOptionalParams) => PollerLike<OperationState<Namespace>, Namespace>

delete

delete: (resourceGroupName: string, namespaceName: string, options?: NamespacesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, namespaceName: string, options?: NamespacesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Get properties of a namespace.

get: (resourceGroupName: string, namespaceName: string, options?: NamespacesGetOptionalParams) => Promise<Namespace>

Property Value

(resourceGroupName: string, namespaceName: string, options?: NamespacesGetOptionalParams) => Promise<Namespace>

listByResourceGroup

List all the namespaces under a resource group.

listByResourceGroup: (resourceGroupName: string, options?: NamespacesListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<Namespace, Namespace[], PageSettings>

Property Value

(resourceGroupName: string, options?: NamespacesListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<Namespace, Namespace[], PageSettings>

listBySubscription

List all the namespaces under an Azure subscription.

listBySubscription: (options?: NamespacesListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<Namespace, Namespace[], PageSettings>

Property Value

(options?: NamespacesListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<Namespace, Namespace[], PageSettings>

listSharedAccessKeys

List the two keys used to publish to a namespace.

listSharedAccessKeys: (resourceGroupName: string, namespaceName: string, options?: NamespacesListSharedAccessKeysOptionalParams) => Promise<NamespaceSharedAccessKeys>

Property Value

(resourceGroupName: string, namespaceName: string, options?: NamespacesListSharedAccessKeysOptionalParams) => Promise<NamespaceSharedAccessKeys>

regenerateKey

Regenerate a shared access key for a namespace.

regenerateKey: (resourceGroupName: string, namespaceName: string, regenerateKeyRequest: NamespaceRegenerateKeyRequest, options?: NamespacesRegenerateKeyOptionalParams) => PollerLike<OperationState<NamespaceSharedAccessKeys>, NamespaceSharedAccessKeys>

Property Value

(resourceGroupName: string, namespaceName: string, regenerateKeyRequest: NamespaceRegenerateKeyRequest, options?: NamespacesRegenerateKeyOptionalParams) => PollerLike<OperationState<NamespaceSharedAccessKeys>, NamespaceSharedAccessKeys>

update

Asynchronously updates a namespace with the specified parameters.

update: (resourceGroupName: string, namespaceName: string, namespaceUpdateParameters: NamespaceUpdateParameters, options?: NamespacesUpdateOptionalParams) => PollerLike<OperationState<Namespace>, Namespace>

Property Value

(resourceGroupName: string, namespaceName: string, namespaceUpdateParameters: NamespaceUpdateParameters, options?: NamespacesUpdateOptionalParams) => PollerLike<OperationState<Namespace>, Namespace>

validateCustomDomainOwnership

Performs ownership validation via checking TXT records for all custom domains in a namespace.

validateCustomDomainOwnership: (resourceGroupName: string, namespaceName: string, options?: NamespacesValidateCustomDomainOwnershipOptionalParams) => PollerLike<OperationState<CustomDomainOwnershipValidationResult>, CustomDomainOwnershipValidationResult>

Property Value

(resourceGroupName: string, namespaceName: string, options?: NamespacesValidateCustomDomainOwnershipOptionalParams) => PollerLike<OperationState<CustomDomainOwnershipValidationResult>, CustomDomainOwnershipValidationResult>