Interface PrivateLinkResourcesClient
public interface PrivateLinkResourcesClient
An instance of this class provides access to all the operations defined in PrivateLinkResourcesClient.
-
Method Summary
Modifier and TypeMethodDescriptionGet properties of a private link resource.com.azure.core.http.rest.Response<PrivateLinkResourceInner>
getWithResponse
(String resourceGroupName, String parentType, String parentName, String privateLinkResourceName, com.azure.core.util.Context context) Get properties of a private link resource.com.azure.core.http.rest.PagedIterable<PrivateLinkResourceInner>
listByResource
(String resourceGroupName, String parentType, String parentName) List all the private link resources under a topic, domain, or partner namespace.com.azure.core.http.rest.PagedIterable<PrivateLinkResourceInner>
listByResource
(String resourceGroupName, String parentType, String parentName, String filter, Integer top, com.azure.core.util.Context context) List all the private link resources under a topic, domain, or partner namespace.
-
Method Details
-
get
PrivateLinkResourceInner get(String resourceGroupName, String parentType, String parentName, String privateLinkResourceName) 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\'.parentName
- The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name).privateLinkResourceName
- The name of private link resource.- Returns:
- properties of a private link resource.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getWithResponse
com.azure.core.http.rest.Response<PrivateLinkResourceInner> getWithResponse(String resourceGroupName, String parentType, String parentName, String privateLinkResourceName, com.azure.core.util.Context context) 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\'.parentName
- The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name).privateLinkResourceName
- The name of private link resource.context
- The context to associate with this operation.- Returns:
- properties of a private link resource along with
Response
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
listByResource
com.azure.core.http.rest.PagedIterable<PrivateLinkResourceInner> listByResource(String resourceGroupName, String parentType, String parentName) List all the private link resources under a topic, domain, or partner 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\'.parentName
- The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name).- Returns:
- result of the List private link resources operation as paginated response with
PagedIterable
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
listByResource
com.azure.core.http.rest.PagedIterable<PrivateLinkResourceInner> listByResource(String resourceGroupName, String parentType, String parentName, String filter, Integer top, com.azure.core.util.Context context) List all the private link resources under a topic, domain, or partner 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\'.parentName
- The name of the parent resource (namely, either, the topic name, domain name, or partner 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
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-