Interface ServicesClient


  • public interface ServicesClient
    An instance of this class provides access to all the operations defined in ServicesClient.
    • Method Detail

      • getByResourceGroup

        ServicesDescriptionInner getByResourceGroup​(String resourceGroupName,
                                                    String resourceName)
        Get the metadata of a service instance.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        resourceName - The name of the service instance.
        Returns:
        the metadata of a service instance.
        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<ServicesDescriptionInner> getByResourceGroupWithResponse​(String resourceGroupName,
                                                                                                   String resourceName,
                                                                                                   com.azure.core.util.Context context)
        Get the metadata of a service instance.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        resourceName - The name of the service instance.
        context - The context to associate with this operation.
        Returns:
        the metadata of a service instance 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.
      • beginCreateOrUpdate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ServicesDescriptionInner>,​ServicesDescriptionInner> beginCreateOrUpdate​(String resourceGroupName,
                                                                                                                                                                          String resourceName,
                                                                                                                                                                          ServicesDescriptionInner serviceDescription)
        Create or update the metadata of a service instance.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        resourceName - The name of the service instance.
        serviceDescription - The service instance metadata.
        Returns:
        the SyncPoller for polling of the description of the service.
        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.
      • beginCreateOrUpdate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ServicesDescriptionInner>,​ServicesDescriptionInner> beginCreateOrUpdate​(String resourceGroupName,
                                                                                                                                                                          String resourceName,
                                                                                                                                                                          ServicesDescriptionInner serviceDescription,
                                                                                                                                                                          com.azure.core.util.Context context)
        Create or update the metadata of a service instance.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        resourceName - The name of the service instance.
        serviceDescription - The service instance metadata.
        context - The context to associate with this operation.
        Returns:
        the SyncPoller for polling of the description of the service.
        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.
      • createOrUpdate

        ServicesDescriptionInner createOrUpdate​(String resourceGroupName,
                                                String resourceName,
                                                ServicesDescriptionInner serviceDescription)
        Create or update the metadata of a service instance.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        resourceName - The name of the service instance.
        serviceDescription - The service instance metadata.
        Returns:
        the description of the service.
        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.
      • createOrUpdate

        ServicesDescriptionInner createOrUpdate​(String resourceGroupName,
                                                String resourceName,
                                                ServicesDescriptionInner serviceDescription,
                                                com.azure.core.util.Context context)
        Create or update the metadata of a service instance.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        resourceName - The name of the service instance.
        serviceDescription - The service instance metadata.
        context - The context to associate with this operation.
        Returns:
        the description of the service.
        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.
      • beginUpdate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ServicesDescriptionInner>,​ServicesDescriptionInner> beginUpdate​(String resourceGroupName,
                                                                                                                                                                  String resourceName,
                                                                                                                                                                  ServicesPatchDescription servicePatchDescription)
        Update the metadata of a service instance.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        resourceName - The name of the service instance.
        servicePatchDescription - The service instance metadata and security metadata.
        Returns:
        the SyncPoller for polling of the description of the service.
        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.
      • beginUpdate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ServicesDescriptionInner>,​ServicesDescriptionInner> beginUpdate​(String resourceGroupName,
                                                                                                                                                                  String resourceName,
                                                                                                                                                                  ServicesPatchDescription servicePatchDescription,
                                                                                                                                                                  com.azure.core.util.Context context)
        Update the metadata of a service instance.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        resourceName - The name of the service instance.
        servicePatchDescription - The service instance metadata and security metadata.
        context - The context to associate with this operation.
        Returns:
        the SyncPoller for polling of the description of the service.
        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.
      • update

        ServicesDescriptionInner update​(String resourceGroupName,
                                        String resourceName,
                                        ServicesPatchDescription servicePatchDescription)
        Update the metadata of a service instance.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        resourceName - The name of the service instance.
        servicePatchDescription - The service instance metadata and security metadata.
        Returns:
        the description of the service.
        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.
      • update

        ServicesDescriptionInner update​(String resourceGroupName,
                                        String resourceName,
                                        ServicesPatchDescription servicePatchDescription,
                                        com.azure.core.util.Context context)
        Update the metadata of a service instance.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        resourceName - The name of the service instance.
        servicePatchDescription - The service instance metadata and security metadata.
        context - The context to associate with this operation.
        Returns:
        the description of the service.
        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.
      • beginDelete

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginDelete​(String resourceGroupName,
                                                                                                                          String resourceName)
        Delete a service instance.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        resourceName - The name of the service instance.
        Returns:
        the SyncPoller for polling of long-running 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.
      • beginDelete

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginDelete​(String resourceGroupName,
                                                                                                                          String resourceName,
                                                                                                                          com.azure.core.util.Context context)
        Delete a service instance.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        resourceName - The name of the service instance.
        context - The context to associate with this operation.
        Returns:
        the SyncPoller for polling of long-running 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.
      • delete

        void delete​(String resourceGroupName,
                    String resourceName)
        Delete a service instance.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        resourceName - The name of the service instance.
        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 resourceName,
                    com.azure.core.util.Context context)
        Delete a service instance.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        resourceName - The name of the service instance.
        context - The context to associate with this 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.
      • list

        com.azure.core.http.rest.PagedIterable<ServicesDescriptionInner> list()
        Get all the service instances in a subscription.
        Returns:
        all the service instances in a subscription 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<ServicesDescriptionInner> list​(com.azure.core.util.Context context)
        Get all the service instances in a subscription.
        Parameters:
        context - The context to associate with this operation.
        Returns:
        all the service instances in a subscription 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<ServicesDescriptionInner> listByResourceGroup​(String resourceGroupName)
        Get all the service instances in a resource group.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        Returns:
        all the service instances in a resource group 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<ServicesDescriptionInner> listByResourceGroup​(String resourceGroupName,
                                                                                             com.azure.core.util.Context context)
        Get all the service instances in a resource group.
        Parameters:
        resourceGroupName - The name of the resource group that contains the service instance.
        context - The context to associate with this operation.
        Returns:
        all the service instances in a resource group 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.
      • checkNameAvailability

        ServicesNameAvailabilityInfoInner checkNameAvailability​(CheckNameAvailabilityParameters checkNameAvailabilityInputs)
        Check if a service instance name is available.
        Parameters:
        checkNameAvailabilityInputs - Set the name parameter in the CheckNameAvailabilityParameters structure to the name of the service instance to check.
        Returns:
        the properties indicating whether a given service name is available.
        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.
      • checkNameAvailabilityWithResponse

        com.azure.core.http.rest.Response<ServicesNameAvailabilityInfoInner> checkNameAvailabilityWithResponse​(CheckNameAvailabilityParameters checkNameAvailabilityInputs,
                                                                                                               com.azure.core.util.Context context)
        Check if a service instance name is available.
        Parameters:
        checkNameAvailabilityInputs - Set the name parameter in the CheckNameAvailabilityParameters structure to the name of the service instance to check.
        context - The context to associate with this operation.
        Returns:
        the properties indicating whether a given service name is available 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.