PrivateLinkResources Interface

Package:

com.azure.resourcemanager.eventgrid.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-eventgrid:1.2.0

public interface PrivateLinkResources

Resource collection API of PrivateLinkResources.

Method Summary

Modifier and Type	Method and Description
abstract PrivateLinkResource	get(String resourceGroupName, String parentType, String parentName, String privateLinkResourceName) Get a private link resource.
abstract Response<PrivateLinkResource>	getWithResponse(String resourceGroupName, String parentType, String parentName, String privateLinkResourceName, Context context) Get a private link resource.
abstract PagedIterable<PrivateLinkResource>	listByResource(String resourceGroupName, String parentType, String parentName) List private link resources under specific topic, domain, or partner namespace or namespace.
abstract PagedIterable<PrivateLinkResource>	listByResource(String resourceGroupName, String parentType, String parentName, String filter, Integer top, Context context) List private link resources under specific topic, domain, or partner namespace or namespace.

Method Details

get

public abstract PrivateLinkResource get(String resourceGroupName, String parentType, String parentName, String privateLinkResourceName)

Get a private link resource. Get properties of a private link resource.

Parameters:

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

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

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

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

Returns:

properties of a private link resource.

getWithResponse

public abstract Response<PrivateLinkResource> getWithResponse(String resourceGroupName, String parentType, String parentName, String privateLinkResourceName, Context context)

Get a private link resource. Get properties of a private link resource.

Parameters:

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

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

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

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

context - The context to associate with this operation.

Returns:

properties of a private link resource along with Response<T>.

listByResource

public abstract PagedIterable<PrivateLinkResource> listByResource(String resourceGroupName, String parentType, String parentName)

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

Parameters:

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

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

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

Returns:

result of the List private link resources operation as paginated response with PagedIterable<T>.

listByResource

public abstract PagedIterable<PrivateLinkResource> listByResource(String resourceGroupName, String parentType, String parentName, String filter, Integer top, Context context)

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

Parameters:

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

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

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

filter - The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'.

top - The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page.

context - The context to associate with this operation.

Returns:

result of the List private link resources operation as paginated response with PagedIterable<T>.