PartnerNamespaces interface

Package:

@azure/arm-eventgrid

Interface representing a PartnerNamespaces.

Methods

beginCreateOrUpdate(string, string, PartnerNamespace, PartnerNamespacesCreateOrUpdateOptionalParams)	Asynchronously creates a new partner namespace with the specified parameters.
beginCreateOrUpdateAndWait(string, string, PartnerNamespace, PartnerNamespacesCreateOrUpdateOptionalParams)	Asynchronously creates a new partner namespace with the specified parameters.
beginDelete(string, string, PartnerNamespacesDeleteOptionalParams)	Delete existing partner namespace.
beginDeleteAndWait(string, string, PartnerNamespacesDeleteOptionalParams)	Delete existing partner namespace.
beginUpdate(string, string, PartnerNamespaceUpdateParameters, PartnerNamespacesUpdateOptionalParams)	Asynchronously updates a partner namespace with the specified parameters.
beginUpdateAndWait(string, string, PartnerNamespaceUpdateParameters, PartnerNamespacesUpdateOptionalParams)	Asynchronously updates a partner namespace with the specified parameters.
get(string, string, PartnerNamespacesGetOptionalParams)	Get properties of a partner namespace.
listByResourceGroup(string, PartnerNamespacesListByResourceGroupOptionalParams)	List all the partner namespaces under a resource group.
listBySubscription(PartnerNamespacesListBySubscriptionOptionalParams)	List all the partner namespaces under an Azure subscription.
listSharedAccessKeys(string, string, PartnerNamespacesListSharedAccessKeysOptionalParams)	List the two keys used to publish to a partner namespace.
regenerateKey(string, string, PartnerNamespaceRegenerateKeyRequest, PartnerNamespacesRegenerateKeyOptionalParams)	Regenerate a shared access key for a partner namespace.

Method Details

beginCreateOrUpdate(string, string, PartnerNamespace, PartnerNamespacesCreateOrUpdateOptionalParams)

Asynchronously creates a new partner namespace with the specified parameters.

function beginCreateOrUpdate(resourceGroupName: string, partnerNamespaceName: string, partnerNamespaceInfo: PartnerNamespace, options?: PartnerNamespacesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<PartnerNamespace>, PartnerNamespace>>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

partnerNamespaceName

string

Name of the partner namespace.

partnerNamespaceInfo

PartnerNamespace

PartnerNamespace information.

options

PartnerNamespacesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<PollOperationState<PartnerNamespace>, PartnerNamespace>>

beginCreateOrUpdateAndWait(string, string, PartnerNamespace, PartnerNamespacesCreateOrUpdateOptionalParams)

Asynchronously creates a new partner namespace with the specified parameters.

function beginCreateOrUpdateAndWait(resourceGroupName: string, partnerNamespaceName: string, partnerNamespaceInfo: PartnerNamespace, options?: PartnerNamespacesCreateOrUpdateOptionalParams): Promise<PartnerNamespace>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

partnerNamespaceName

string

Name of the partner namespace.

partnerNamespaceInfo

PartnerNamespace

PartnerNamespace information.

options

PartnerNamespacesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PartnerNamespace>

beginDelete(string, string, PartnerNamespacesDeleteOptionalParams)

Delete existing partner namespace.

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

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

partnerNamespaceName

string

Name of the partner namespace.

options

PartnerNamespacesDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait(string, string, PartnerNamespacesDeleteOptionalParams)

Delete existing partner namespace.

function beginDeleteAndWait(resourceGroupName: string, partnerNamespaceName: string, options?: PartnerNamespacesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

partnerNamespaceName

string

Name of the partner namespace.

options

PartnerNamespacesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, PartnerNamespaceUpdateParameters, PartnerNamespacesUpdateOptionalParams)

Asynchronously updates a partner namespace with the specified parameters.

function beginUpdate(resourceGroupName: string, partnerNamespaceName: string, partnerNamespaceUpdateParameters: PartnerNamespaceUpdateParameters, options?: PartnerNamespacesUpdateOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

partnerNamespaceName

string

Name of the partner namespace.

partnerNamespaceUpdateParameters

PartnerNamespaceUpdateParameters

Partner namespace update information.

options

PartnerNamespacesUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<PollOperationState<void>, void>>

beginUpdateAndWait(string, string, PartnerNamespaceUpdateParameters, PartnerNamespacesUpdateOptionalParams)

Asynchronously updates a partner namespace with the specified parameters.

function beginUpdateAndWait(resourceGroupName: string, partnerNamespaceName: string, partnerNamespaceUpdateParameters: PartnerNamespaceUpdateParameters, options?: PartnerNamespacesUpdateOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

partnerNamespaceName

string

Name of the partner namespace.

partnerNamespaceUpdateParameters

PartnerNamespaceUpdateParameters

Partner namespace update information.

options

PartnerNamespacesUpdateOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, PartnerNamespacesGetOptionalParams)

Get properties of a partner namespace.

function get(resourceGroupName: string, partnerNamespaceName: string, options?: PartnerNamespacesGetOptionalParams): Promise<PartnerNamespace>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

partnerNamespaceName

string

Name of the partner namespace.

options

PartnerNamespacesGetOptionalParams

The options parameters.

Returns

Promise<PartnerNamespace>

listByResourceGroup(string, PartnerNamespacesListByResourceGroupOptionalParams)

List all the partner namespaces under a resource group.

function listByResourceGroup(resourceGroupName: string, options?: PartnerNamespacesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<PartnerNamespace, PartnerNamespace[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

options

PartnerNamespacesListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PartnerNamespace, PartnerNamespace[], PageSettings>

listBySubscription(PartnerNamespacesListBySubscriptionOptionalParams)

List all the partner namespaces under an Azure subscription.

function listBySubscription(options?: PartnerNamespacesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<PartnerNamespace, PartnerNamespace[], PageSettings>

Parameters

options

PartnerNamespacesListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PartnerNamespace, PartnerNamespace[], PageSettings>

listSharedAccessKeys(string, string, PartnerNamespacesListSharedAccessKeysOptionalParams)

List the two keys used to publish to a partner namespace.

function listSharedAccessKeys(resourceGroupName: string, partnerNamespaceName: string, options?: PartnerNamespacesListSharedAccessKeysOptionalParams): Promise<PartnerNamespaceSharedAccessKeys>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

partnerNamespaceName

string

Name of the partner namespace.

options

PartnerNamespacesListSharedAccessKeysOptionalParams

The options parameters.

Returns

Promise<PartnerNamespaceSharedAccessKeys>

regenerateKey(string, string, PartnerNamespaceRegenerateKeyRequest, PartnerNamespacesRegenerateKeyOptionalParams)

Regenerate a shared access key for a partner namespace.

function regenerateKey(resourceGroupName: string, partnerNamespaceName: string, regenerateKeyRequest: PartnerNamespaceRegenerateKeyRequest, options?: PartnerNamespacesRegenerateKeyOptionalParams): Promise<PartnerNamespaceSharedAccessKeys>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription.

partnerNamespaceName

string

Name of the partner namespace.

regenerateKeyRequest

PartnerNamespaceRegenerateKeyRequest

Request body to regenerate key.

options

PartnerNamespacesRegenerateKeyOptionalParams

The options parameters.

Returns

Promise<PartnerNamespaceSharedAccessKeys>