PrivateLinkResources interface

Package:

@azure/arm-eventgrid

Interface representing a PrivateLinkResources.

Methods

get(string, string, string, string, PrivateLinkResourcesGetOptionalParams)	Get properties of a private link resource.
listByResource(string, string, string, PrivateLinkResourcesListByResourceOptionalParams)	List all the private link resources under a topic, domain, or partner namespace or namespace.

Method Details

get(string, string, string, string, PrivateLinkResourcesGetOptionalParams)

Get properties of a private link resource.

function get(resourceGroupName: string, parentType: string, parentName: string, privateLinkResourceName: string, options?: PrivateLinkResourcesGetOptionalParams): Promise<PrivateLinkResource>

Parameters

resourceGroupName

string

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

parentType

string

The type of the parent resource. This can be either 'topics', 'domains', or 'partnerNamespaces' or 'namespaces'.

parentName

string

The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name or namespace name).

privateLinkResourceName

string

The name of private link resource will be either topic, domain, partnerNamespace or namespace.

options

PrivateLinkResourcesGetOptionalParams

The options parameters.

Returns

Promise<PrivateLinkResource>

listByResource(string, string, string, PrivateLinkResourcesListByResourceOptionalParams)

List all the private link resources under a topic, domain, or partner namespace or namespace.

function listByResource(resourceGroupName: string, parentType: string, parentName: string, options?: PrivateLinkResourcesListByResourceOptionalParams): PagedAsyncIterableIterator<PrivateLinkResource, PrivateLinkResource[], PageSettings>

Parameters

resourceGroupName

string

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

parentType

string

The type of the parent resource. This can be either 'topics', 'domains', or 'partnerNamespaces' or 'namespaces'.

parentName

string

The name of the parent resource (namely, either, the topic name, domain name, or partner namespace or namespace name).

options

PrivateLinkResourcesListByResourceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PrivateLinkResource, PrivateLinkResource[], PageSettings>