Interface Datastores


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

      • list

        com.azure.core.http.rest.PagedIterable<DatastoreData> list​(String resourceGroupName,
                                                                   String workspaceName)
        List datastores.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - Name of Azure Machine Learning workspace.
        Returns:
        a paginated list of Datastore entities 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.
      • list

        com.azure.core.http.rest.PagedIterable<DatastoreData> list​(String resourceGroupName,
                                                                   String workspaceName,
                                                                   String skip,
                                                                   Integer count,
                                                                   Boolean isDefault,
                                                                   List<String> names,
                                                                   String searchText,
                                                                   String orderBy,
                                                                   Boolean orderByAsc,
                                                                   com.azure.core.util.Context context)
        List datastores.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - Name of Azure Machine Learning workspace.
        skip - Continuation token for pagination.
        count - Maximum number of results to return.
        isDefault - Filter down to the workspace default datastore.
        names - Names of datastores to return.
        searchText - Text to search for in the datastore names.
        orderBy - Order by property (createdtime | modifiedtime | name).
        orderByAsc - Order by property in ascending order.
        context - The context to associate with this operation.
        Returns:
        a paginated list of Datastore entities 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.
      • delete

        void delete​(String resourceGroupName,
                    String workspaceName,
                    String name)
        Delete datastore.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - Name of Azure Machine Learning workspace.
        name - Datastore 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 workspaceName,
                                                                   String name,
                                                                   com.azure.core.util.Context context)
        Delete datastore.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - Name of Azure Machine Learning workspace.
        name - Datastore 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.
      • get

        DatastoreData get​(String resourceGroupName,
                          String workspaceName,
                          String name)
        Get datastore.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - Name of Azure Machine Learning workspace.
        name - Datastore name.
        Returns:
        datastore.
        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<DatastoreData> getWithResponse​(String resourceGroupName,
                                                                         String workspaceName,
                                                                         String name,
                                                                         com.azure.core.util.Context context)
        Get datastore.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - Name of Azure Machine Learning workspace.
        name - Datastore name.
        context - The context to associate with this operation.
        Returns:
        datastore 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.
      • listSecrets

        DatastoreSecrets listSecrets​(String resourceGroupName,
                                     String workspaceName,
                                     String name)
        Get datastore secrets.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - Name of Azure Machine Learning workspace.
        name - Datastore name.
        Returns:
        datastore secrets.
        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.
      • listSecretsWithResponse

        com.azure.core.http.rest.Response<DatastoreSecrets> listSecretsWithResponse​(String resourceGroupName,
                                                                                    String workspaceName,
                                                                                    String name,
                                                                                    com.azure.core.util.Context context)
        Get datastore secrets.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        workspaceName - Name of Azure Machine Learning workspace.
        name - Datastore name.
        context - The context to associate with this operation.
        Returns:
        datastore secrets 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

        DatastoreData getById​(String id)
        Get datastore.
        Parameters:
        id - the resource ID.
        Returns:
        datastore 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<DatastoreData> getByIdWithResponse​(String id,
                                                                             com.azure.core.util.Context context)
        Get datastore.
        Parameters:
        id - the resource ID.
        context - The context to associate with this operation.
        Returns:
        datastore 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)
        Delete datastore.
        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)
        Delete datastore.
        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

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