Interface Factories


  • public interface Factories
    Resource collection API of Factories.
    • Method Detail

      • list

        com.azure.core.http.rest.PagedIterable<Factory> list()
        Lists factories under the specified subscription.
        Returns:
        a list of factory resources as paginated response with PagedIterable.
        Throws:
        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.
      • list

        com.azure.core.http.rest.PagedIterable<Factory> list​(com.azure.core.util.Context context)
        Lists factories under the specified subscription.
        Parameters:
        context - The context to associate with this operation.
        Returns:
        a list of factory resources 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.
      • configureFactoryRepo

        Factory configureFactoryRepo​(String locationId,
                                     FactoryRepoUpdate factoryRepoUpdate)
        Updates a factory's repo information.
        Parameters:
        locationId - The location identifier.
        factoryRepoUpdate - Update factory repo request definition.
        Returns:
        factory resource type.
        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.
      • configureFactoryRepoWithResponse

        com.azure.core.http.rest.Response<Factory> configureFactoryRepoWithResponse​(String locationId,
                                                                                    FactoryRepoUpdate factoryRepoUpdate,
                                                                                    com.azure.core.util.Context context)
        Updates a factory's repo information.
        Parameters:
        locationId - The location identifier.
        factoryRepoUpdate - Update factory repo request definition.
        context - The context to associate with this operation.
        Returns:
        factory resource type 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.
      • listByResourceGroup

        com.azure.core.http.rest.PagedIterable<Factory> listByResourceGroup​(String resourceGroupName)
        Lists factories.
        Parameters:
        resourceGroupName - The resource group name.
        Returns:
        a list of factory resources 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.
      • listByResourceGroup

        com.azure.core.http.rest.PagedIterable<Factory> listByResourceGroup​(String resourceGroupName,
                                                                            com.azure.core.util.Context context)
        Lists factories.
        Parameters:
        resourceGroupName - The resource group name.
        context - The context to associate with this operation.
        Returns:
        a list of factory resources 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.
      • getByResourceGroup

        Factory getByResourceGroup​(String resourceGroupName,
                                   String factoryName)
        Gets a factory.
        Parameters:
        resourceGroupName - The resource group name.
        factoryName - The factory name.
        Returns:
        a factory.
        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.
      • getByResourceGroupWithResponse

        com.azure.core.http.rest.Response<Factory> getByResourceGroupWithResponse​(String resourceGroupName,
                                                                                  String factoryName,
                                                                                  String ifNoneMatch,
                                                                                  com.azure.core.util.Context context)
        Gets a factory.
        Parameters:
        resourceGroupName - The resource group name.
        factoryName - The factory name.
        ifNoneMatch - ETag of the factory entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.
        context - The context to associate with this operation.
        Returns:
        a factory 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.
      • deleteByResourceGroup

        void deleteByResourceGroup​(String resourceGroupName,
                                   String factoryName)
        Deletes a factory.
        Parameters:
        resourceGroupName - The resource group name.
        factoryName - The factory name.
        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.
      • deleteWithResponse

        com.azure.core.http.rest.Response<Void> deleteWithResponse​(String resourceGroupName,
                                                                   String factoryName,
                                                                   com.azure.core.util.Context context)
        Deletes a factory.
        Parameters:
        resourceGroupName - The resource group name.
        factoryName - The factory name.
        context - The context to associate with this operation.
        Returns:
        the 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.
      • getGitHubAccessToken

        GitHubAccessTokenResponse getGitHubAccessToken​(String resourceGroupName,
                                                       String factoryName,
                                                       GitHubAccessTokenRequest gitHubAccessTokenRequest)
        Get GitHub Access Token.
        Parameters:
        resourceGroupName - The resource group name.
        factoryName - The factory name.
        gitHubAccessTokenRequest - Get GitHub access token request definition.
        Returns:
        gitHub Access Token.
        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.
      • getGitHubAccessTokenWithResponse

        com.azure.core.http.rest.Response<GitHubAccessTokenResponse> getGitHubAccessTokenWithResponse​(String resourceGroupName,
                                                                                                      String factoryName,
                                                                                                      GitHubAccessTokenRequest gitHubAccessTokenRequest,
                                                                                                      com.azure.core.util.Context context)
        Get GitHub Access Token.
        Parameters:
        resourceGroupName - The resource group name.
        factoryName - The factory name.
        gitHubAccessTokenRequest - Get GitHub access token request definition.
        context - The context to associate with this operation.
        Returns:
        gitHub Access Token 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.
      • getDataPlaneAccess

        AccessPolicyResponse getDataPlaneAccess​(String resourceGroupName,
                                                String factoryName,
                                                UserAccessPolicy policy)
        Get Data Plane access.
        Parameters:
        resourceGroupName - The resource group name.
        factoryName - The factory name.
        policy - Data Plane user access policy definition.
        Returns:
        data Plane access.
        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.
      • getDataPlaneAccessWithResponse

        com.azure.core.http.rest.Response<AccessPolicyResponse> getDataPlaneAccessWithResponse​(String resourceGroupName,
                                                                                               String factoryName,
                                                                                               UserAccessPolicy policy,
                                                                                               com.azure.core.util.Context context)
        Get Data Plane access.
        Parameters:
        resourceGroupName - The resource group name.
        factoryName - The factory name.
        policy - Data Plane user access policy definition.
        context - The context to associate with this operation.
        Returns:
        data Plane access 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.
      • getById

        Factory getById​(String id)
        Gets a factory.
        Parameters:
        id - the resource ID.
        Returns:
        a factory 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.
      • getByIdWithResponse

        com.azure.core.http.rest.Response<Factory> getByIdWithResponse​(String id,
                                                                       String ifNoneMatch,
                                                                       com.azure.core.util.Context context)
        Gets a factory.
        Parameters:
        id - the resource ID.
        ifNoneMatch - ETag of the factory entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.
        context - The context to associate with this operation.
        Returns:
        a factory 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.
      • deleteById

        void deleteById​(String id)
        Deletes a factory.
        Parameters:
        id - the resource ID.
        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.
      • deleteByIdWithResponse

        com.azure.core.http.rest.Response<Void> deleteByIdWithResponse​(String id,
                                                                       com.azure.core.util.Context context)
        Deletes a factory.
        Parameters:
        id - the resource ID.
        context - The context to associate with this operation.
        Returns:
        the 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.
      • define

        Factory.DefinitionStages.Blank define​(String name)
        Begins definition for a new Factory resource.
        Parameters:
        name - resource name.
        Returns:
        the first stage of the new Factory definition.