Package com.azure.resourcemanager.eventgrid.models

Interface PrivateLinkResources

  • public interface PrivateLinkResources
    Resource collection API of PrivateLinkResources.

    • Method Detail

      • get

        PrivateLinkResource 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\' or \'domains\'.
        parentName - The name of the parent resource (namely, either, the topic name or domain 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<PrivateLinkResource> 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\' or \'domains\'.
        parentName - The name of the parent resource (namely, either, the topic name or domain 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<PrivateLinkResource> listByResource​(String resourceGroupName,
                                                                           String parentType,
                                                                           String parentName)
        List all the private link resources under a topic or domain.
        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\' or \'domains\'.
        parentName - The name of the parent resource (namely, either, the topic name or domain name).
        Returns:
        result of the List private link resources operation.
        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<PrivateLinkResource> 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 or domain.
        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\' or \'domains\'.
        parentName - The name of the parent resource (namely, either, the topic name or domain 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.
        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.