Package com.azure.resourcemanager.imagebuilder.models

Interface VirtualMachineImageTemplates

  • public interface VirtualMachineImageTemplates
    Resource collection API of VirtualMachineImageTemplates.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void cancel​(String resourceGroupName, String imageTemplateName)
      Cancel the long running image build based on the image template.
      void cancel​(String resourceGroupName, String imageTemplateName, com.azure.core.util.Context context)
      Cancel the long running image build based on the image template.
      ImageTemplate.DefinitionStages.Blank define​(String name)
      Begins definition for a new ImageTemplate resource.
      void delete​(String resourceGroupName, String imageTemplateName, com.azure.core.util.Context context)
      Delete a virtual machine image template.
      void deleteById​(String id)
      Delete a virtual machine image template.
      void deleteByIdWithResponse​(String id, com.azure.core.util.Context context)
      Delete a virtual machine image template.
      void deleteByResourceGroup​(String resourceGroupName, String imageTemplateName)
      Delete a virtual machine image template.
      ImageTemplate getById​(String id)
      Get information about a virtual machine image template.
      com.azure.core.http.rest.Response<ImageTemplate> getByIdWithResponse​(String id, com.azure.core.util.Context context)
      Get information about a virtual machine image template.
      ImageTemplate getByResourceGroup​(String resourceGroupName, String imageTemplateName)
      Get information about a virtual machine image template.
      com.azure.core.http.rest.Response<ImageTemplate> getByResourceGroupWithResponse​(String resourceGroupName, String imageTemplateName, com.azure.core.util.Context context)
      Get information about a virtual machine image template.
      RunOutput getRunOutput​(String resourceGroupName, String imageTemplateName, String runOutputName)
      Get the specified run output for the specified image template resource.
      com.azure.core.http.rest.Response<RunOutput> getRunOutputWithResponse​(String resourceGroupName, String imageTemplateName, String runOutputName, com.azure.core.util.Context context)
      Get the specified run output for the specified image template resource.
      com.azure.core.http.rest.PagedIterable<ImageTemplate> list()
      Gets information about the VM image templates associated with the subscription.
      com.azure.core.http.rest.PagedIterable<ImageTemplate> list​(com.azure.core.util.Context context)
      Gets information about the VM image templates associated with the subscription.
      com.azure.core.http.rest.PagedIterable<ImageTemplate> listByResourceGroup​(String resourceGroupName)
      Gets information about the VM image templates associated with the specified resource group.
      com.azure.core.http.rest.PagedIterable<ImageTemplate> listByResourceGroup​(String resourceGroupName, com.azure.core.util.Context context)
      Gets information about the VM image templates associated with the specified resource group.
      com.azure.core.http.rest.PagedIterable<RunOutput> listRunOutputs​(String resourceGroupName, String imageTemplateName)
      List all run outputs for the specified Image Template resource.
      com.azure.core.http.rest.PagedIterable<RunOutput> listRunOutputs​(String resourceGroupName, String imageTemplateName, com.azure.core.util.Context context)
      List all run outputs for the specified Image Template resource.
      void run​(String resourceGroupName, String imageTemplateName)
      Create artifacts from a existing image template.
      void run​(String resourceGroupName, String imageTemplateName, com.azure.core.util.Context context)
      Create artifacts from a existing image template.

    • Method Detail

      • list

        com.azure.core.http.rest.PagedIterable<ImageTemplate> list()
        Gets information about the VM image templates associated with the subscription.
        Returns:
        information about the VM image templates associated with the 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<ImageTemplate> list​(com.azure.core.util.Context context)
        Gets information about the VM image templates associated with the subscription.
        Parameters:
        context - The context to associate with this operation.
        Returns:
        information about the VM image templates associated with the 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<ImageTemplate> listByResourceGroup​(String resourceGroupName)
        Gets information about the VM image templates associated with the specified resource group.
        Parameters:
        resourceGroupName - The name of the resource group.
        Returns:
        information about the VM image templates associated with the specified 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<ImageTemplate> listByResourceGroup​(String resourceGroupName,
                                                                          com.azure.core.util.Context context)
        Gets information about the VM image templates associated with the specified resource group.
        Parameters:
        resourceGroupName - The name of the resource group.
        context - The context to associate with this operation.
        Returns:
        information about the VM image templates associated with the specified 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.

      • getByResourceGroup

        ImageTemplate getByResourceGroup​(String resourceGroupName,
                                 String imageTemplateName)
        Get information about a virtual machine image template.
        Parameters:
        resourceGroupName - The name of the resource group.
        imageTemplateName - The name of the image Template.
        Returns:
        information about a virtual machine image template.
        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<ImageTemplate> getByResourceGroupWithResponse​(String resourceGroupName,
                                                                                String imageTemplateName,
                                                                                com.azure.core.util.Context context)
        Get information about a virtual machine image template.
        Parameters:
        resourceGroupName - The name of the resource group.
        imageTemplateName - The name of the image Template.
        context - The context to associate with this operation.
        Returns:
        information about a virtual machine image template 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 imageTemplateName)
        Delete a virtual machine image template.
        Parameters:
        resourceGroupName - The name of the resource group.
        imageTemplateName - The name of the image Template.
        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 imageTemplateName,
            com.azure.core.util.Context context)
        Delete a virtual machine image template.
        Parameters:
        resourceGroupName - The name of the resource group.
        imageTemplateName - The name of the image Template.
        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.

      • run

        void run​(String resourceGroupName,
         String imageTemplateName)
        Create artifacts from a existing image template.
        Parameters:
        resourceGroupName - The name of the resource group.
        imageTemplateName - The name of the image Template.
        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.

      • run

        void run​(String resourceGroupName,
         String imageTemplateName,
         com.azure.core.util.Context context)
        Create artifacts from a existing image template.
        Parameters:
        resourceGroupName - The name of the resource group.
        imageTemplateName - The name of the image Template.
        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.

      • cancel

        void cancel​(String resourceGroupName,
            String imageTemplateName)
        Cancel the long running image build based on the image template.
        Parameters:
        resourceGroupName - The name of the resource group.
        imageTemplateName - The name of the image Template.
        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.

      • cancel

        void cancel​(String resourceGroupName,
            String imageTemplateName,
            com.azure.core.util.Context context)
        Cancel the long running image build based on the image template.
        Parameters:
        resourceGroupName - The name of the resource group.
        imageTemplateName - The name of the image Template.
        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.

      • listRunOutputs

        com.azure.core.http.rest.PagedIterable<RunOutput> listRunOutputs​(String resourceGroupName,
                                                                 String imageTemplateName)
        List all run outputs for the specified Image Template resource.
        Parameters:
        resourceGroupName - The name of the resource group.
        imageTemplateName - The name of the image Template.
        Returns:
        the result of List run outputs 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.

      • listRunOutputs

        com.azure.core.http.rest.PagedIterable<RunOutput> listRunOutputs​(String resourceGroupName,
                                                                 String imageTemplateName,
                                                                 com.azure.core.util.Context context)
        List all run outputs for the specified Image Template resource.
        Parameters:
        resourceGroupName - The name of the resource group.
        imageTemplateName - The name of the image Template.
        context - The context to associate with this operation.
        Returns:
        the result of List run outputs 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.

      • getRunOutput

        RunOutput getRunOutput​(String resourceGroupName,
                       String imageTemplateName,
                       String runOutputName)
        Get the specified run output for the specified image template resource.
        Parameters:
        resourceGroupName - The name of the resource group.
        imageTemplateName - The name of the image Template.
        runOutputName - The name of the run output.
        Returns:
        the specified run output for the specified image template 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.

      • getRunOutputWithResponse

        com.azure.core.http.rest.Response<RunOutput> getRunOutputWithResponse​(String resourceGroupName,
                                                                      String imageTemplateName,
                                                                      String runOutputName,
                                                                      com.azure.core.util.Context context)
        Get the specified run output for the specified image template resource.
        Parameters:
        resourceGroupName - The name of the resource group.
        imageTemplateName - The name of the image Template.
        runOutputName - The name of the run output.
        context - The context to associate with this operation.
        Returns:
        the specified run output for the specified image template 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.

      • getById

        ImageTemplate getById​(String id)
        Get information about a virtual machine image template.
        Parameters:
        id - the resource ID.
        Returns:
        information about a virtual machine image template 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<ImageTemplate> getByIdWithResponse​(String id,
                                                                     com.azure.core.util.Context context)
        Get information about a virtual machine image template.
        Parameters:
        id - the resource ID.
        context - The context to associate with this operation.
        Returns:
        information about a virtual machine image template 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 a virtual machine image template.
        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

        void deleteByIdWithResponse​(String id,
                            com.azure.core.util.Context context)
        Delete a virtual machine image template.
        Parameters:
        id - the resource ID.
        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.

      • define

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