com.microsoft.windowsazure.management.compute

Interface ExtensionImageOperations

All Known Implementing Classes:

ExtensionImageOperationsImpl

public interface ExtensionImageOperations

The Service Management API includes operations for managing the service and virtual machine extension images in your publisher subscription.

Method Summary

Methods

Modifier and Type	Method and Description
OperationResponse	beginRegistering(ExtensionImageRegisterParameters parameters) Register a new extension.
Future<OperationResponse>	beginRegisteringAsync(ExtensionImageRegisterParameters parameters) Register a new extension.
OperationResponse	beginUnregistering(String providerNamespace, String type, String version) Unregister a version of an extension that was previously registered using either the Register Extension or Update Extension APIs.
Future<OperationResponse>	beginUnregisteringAsync(String providerNamespace, String type, String version) Unregister a version of an extension that was previously registered using either the Register Extension or Update Extension APIs.
OperationResponse	beginUpdating(ExtensionImageUpdateParameters parameters) Update a new extension.
Future<OperationResponse>	beginUpdatingAsync(ExtensionImageUpdateParameters parameters) Update a new extension.
OperationStatusResponse	register(ExtensionImageRegisterParameters parameters) Register a new extension.
Future<OperationStatusResponse>	registerAsync(ExtensionImageRegisterParameters parameters) Register a new extension.
OperationStatusResponse	unregister(String providerNamespace, String type, String version) Unregister a version of an extension that was previously registered using either the Register Extension or Update Extension APIs.
Future<OperationStatusResponse>	unregisterAsync(String providerNamespace, String type, String version) Unregister a version of an extension that was previously registered using either the Register Extension or Update Extension APIs.
OperationStatusResponse	update(ExtensionImageUpdateParameters parameters) Update a new extension.
Future<OperationStatusResponse>	updateAsync(ExtensionImageUpdateParameters parameters) Update a new extension.

Method Detail

beginRegistering

OperationResponse beginRegistering(ExtensionImageRegisterParameters parameters)
                                   throws ParserConfigurationException,
                                          SAXException,
                                          TransformerException,
                                          IOException,
                                          ServiceException

Register a new extension. An extension is identified by the combination of its ProviderNamespace and Type (case-sensitive string). It is not allowed to register an extension with the same identity (i.e. combination of ProviderNamespace and Type) of an already-registered extension. To register new version of an existing extension, the Update Extension API should be used.

Parameters:

parameters - Required. Parameters supplied to the Register Virtual Machine Extension Image operation.

Returns:

A standard service response including an HTTP status code and request ID.

Throws:

ParserConfigurationException - Thrown if there was an error configuring the parser for the response body.

SAXException - Thrown if there was an error parsing the response body.

TransformerException - Thrown if there was an error creating the DOM transformer.

IOException - Signals that an I/O exception of some sort has occurred. This class is the general class of exceptions produced by failed or interrupted I/O operations.

ServiceException - Thrown if an unexpected response is found.

beginRegisteringAsync

Future<OperationResponse> beginRegisteringAsync(ExtensionImageRegisterParameters parameters)

Register a new extension. An extension is identified by the combination of its ProviderNamespace and Type (case-sensitive string). It is not allowed to register an extension with the same identity (i.e. combination of ProviderNamespace and Type) of an already-registered extension. To register new version of an existing extension, the Update Extension API should be used.

Parameters:

parameters - Required. Parameters supplied to the Register Virtual Machine Extension Image operation.

Returns:

A standard service response including an HTTP status code and request ID.

beginUnregistering

OperationResponse beginUnregistering(String providerNamespace,
                                   String type,
                                   String version)
                                     throws IOException,
                                            ServiceException

Unregister a version of an extension that was previously registered using either the Register Extension or Update Extension APIs. An extension version is identified by the combination of its ProviderNamespace, Type and Version which are specified when registering the extension. Unregistering is only allowed for internal extensions, that is, the extensions for which the IsInternalExtension field is set to 'true' during registration or during an update. There is a quota (15) on the number of extensions that can be registered per subscription. If your subscription runs out of quota, you will wither need to unregister some of the internal extensions or contact Azure (same email used to become a publisher) to increase the quota.

Parameters:

providerNamespace - Required. The provider namespace of the extension image to unregister.

type - Required. The type of the extension image to unregister.

version - Required. The version of the extension image to unregister.

Returns:

A standard service response including an HTTP status code and request ID.

Throws:

IOException - Signals that an I/O exception of some sort has occurred. This class is the general class of exceptions produced by failed or interrupted I/O operations.

ServiceException - Thrown if an unexpected response is found.

beginUnregisteringAsync

Future<OperationResponse> beginUnregisteringAsync(String providerNamespace,
                                                String type,
                                                String version)

Unregister a version of an extension that was previously registered using either the Register Extension or Update Extension APIs. An extension version is identified by the combination of its ProviderNamespace, Type and Version which are specified when registering the extension. Unregistering is only allowed for internal extensions, that is, the extensions for which the IsInternalExtension field is set to 'true' during registration or during an update. There is a quota (15) on the number of extensions that can be registered per subscription. If your subscription runs out of quota, you will wither need to unregister some of the internal extensions or contact Azure (same email used to become a publisher) to increase the quota.

Parameters:

providerNamespace - Required. The provider namespace of the extension image to unregister.

type - Required. The type of the extension image to unregister.

version - Required. The version of the extension image to unregister.

Returns:

A standard service response including an HTTP status code and request ID.

beginUpdating

OperationResponse beginUpdating(ExtensionImageUpdateParameters parameters)
                                throws ParserConfigurationException,
                                       SAXException,
                                       TransformerException,
                                       IOException,
                                       ServiceException

Update a new extension. It is allowed to update an extension which had already been registered with the same identity (i.e. combination of ProviderNamespace and Type) but with different version. It will fail if the extension to update has an identity that has not been registered before, or there is already an extension with the same identity and same version.

Parameters:

parameters - Required. Parameters supplied to the Update Virtual Machine Extension Image operation.

Returns:

A standard service response including an HTTP status code and request ID.

Throws:

ParserConfigurationException - Thrown if there was an error configuring the parser for the response body.

SAXException - Thrown if there was an error parsing the response body.

TransformerException - Thrown if there was an error creating the DOM transformer.

IOException - Signals that an I/O exception of some sort has occurred. This class is the general class of exceptions produced by failed or interrupted I/O operations.

ServiceException - Thrown if an unexpected response is found.

beginUpdatingAsync

Future<OperationResponse> beginUpdatingAsync(ExtensionImageUpdateParameters parameters)

Update a new extension. It is allowed to update an extension which had already been registered with the same identity (i.e. combination of ProviderNamespace and Type) but with different version. It will fail if the extension to update has an identity that has not been registered before, or there is already an extension with the same identity and same version.

Parameters:

parameters - Required. Parameters supplied to the Update Virtual Machine Extension Image operation.

Returns:

A standard service response including an HTTP status code and request ID.

register

OperationStatusResponse register(ExtensionImageRegisterParameters parameters)
                                 throws InterruptedException,
                                        ExecutionException,
                                        ServiceException,
                                        IOException

Register a new extension. An extension is identified by the combination of its ProviderNamespace and Type (case-sensitive string). It is not allowed to register an extension with the same identity (i.e. combination of ProviderNamespace and Type) of an already-registered extension. To register new version of an existing extension, the Update Extension API should be used.

Parameters:

parameters - Required. Parameters supplied to the Register Virtual Machine Extension Image operation.

Returns:

The response body contains the status of the specified asynchronous operation, indicating whether it has succeeded, is inprogress, or has failed. Note that this status is distinct from the HTTP status code returned for the Get Operation Status operation itself. If the asynchronous operation succeeded, the response body includes the HTTP status code for the successful request. If the asynchronous operation failed, the response body includes the HTTP status code for the failed request and error information regarding the failure.

Throws:

InterruptedException - Thrown when a thread is waiting, sleeping, or otherwise occupied, and the thread is interrupted, either before or during the activity. Occasionally a method may wish to test whether the current thread has been interrupted, and if so, to immediately throw this exception. The following code can be used to achieve this effect:

ExecutionException - Thrown when attempting to retrieve the result of a task that aborted by throwing an exception. This exception can be inspected using the Throwable.getCause() method.

ServiceException - Thrown if the server returned an error for the request.

IOException - Thrown if there was an error setting up tracing for the request.

registerAsync

Future<OperationStatusResponse> registerAsync(ExtensionImageRegisterParameters parameters)

Register a new extension. An extension is identified by the combination of its ProviderNamespace and Type (case-sensitive string). It is not allowed to register an extension with the same identity (i.e. combination of ProviderNamespace and Type) of an already-registered extension. To register new version of an existing extension, the Update Extension API should be used.

Parameters:

parameters - Required. Parameters supplied to the Register Virtual Machine Extension Image operation.

Returns:

The response body contains the status of the specified asynchronous operation, indicating whether it has succeeded, is inprogress, or has failed. Note that this status is distinct from the HTTP status code returned for the Get Operation Status operation itself. If the asynchronous operation succeeded, the response body includes the HTTP status code for the successful request. If the asynchronous operation failed, the response body includes the HTTP status code for the failed request and error information regarding the failure.

unregister

OperationStatusResponse unregister(String providerNamespace,
                                 String type,
                                 String version)
                                   throws InterruptedException,
                                          ExecutionException,
                                          ServiceException,
                                          IOException

Unregister a version of an extension that was previously registered using either the Register Extension or Update Extension APIs. An extension version is identified by the combination of its ProviderNamespace, Type and Version which are specified when registering the extension. Unregistering is only allowed for internal extensions, that is, the extensions for which the IsInternalExtension field is set to 'true' during registration or during an update. There is a quota (15) on the number of extensions that can be registered per subscription. If your subscription runs out of quota, you will wither need to unregister some of the internal extensions or contact Azure (same email used to become a publisher) to increase the quota.

Parameters:

providerNamespace - Required. The provider namespace of the extension image to unregister.

type - Required. The type of the extension image to unregister.

version - Required. The version of the extension image to unregister.

Returns:

The response body contains the status of the specified asynchronous operation, indicating whether it has succeeded, is inprogress, or has failed. Note that this status is distinct from the HTTP status code returned for the Get Operation Status operation itself. If the asynchronous operation succeeded, the response body includes the HTTP status code for the successful request. If the asynchronous operation failed, the response body includes the HTTP status code for the failed request and error information regarding the failure.

Throws:

InterruptedException - Thrown when a thread is waiting, sleeping, or otherwise occupied, and the thread is interrupted, either before or during the activity. Occasionally a method may wish to test whether the current thread has been interrupted, and if so, to immediately throw this exception. The following code can be used to achieve this effect:

ExecutionException - Thrown when attempting to retrieve the result of a task that aborted by throwing an exception. This exception can be inspected using the Throwable.getCause() method.

ServiceException - Thrown if the server returned an error for the request.

IOException - Thrown if there was an error setting up tracing for the request.

unregisterAsync

Future<OperationStatusResponse> unregisterAsync(String providerNamespace,
                                              String type,
                                              String version)

Unregister a version of an extension that was previously registered using either the Register Extension or Update Extension APIs. An extension version is identified by the combination of its ProviderNamespace, Type and Version which are specified when registering the extension. Unregistering is only allowed for internal extensions, that is, the extensions for which the IsInternalExtension field is set to 'true' during registration or during an update. There is a quota (15) on the number of extensions that can be registered per subscription. If your subscription runs out of quota, you will wither need to unregister some of the internal extensions or contact Azure (same email used to become a publisher) to increase the quota.

Parameters:

providerNamespace - Required. The provider namespace of the extension image to unregister.

type - Required. The type of the extension image to unregister.

version - Required. The version of the extension image to unregister.

Returns:

The response body contains the status of the specified asynchronous operation, indicating whether it has succeeded, is inprogress, or has failed. Note that this status is distinct from the HTTP status code returned for the Get Operation Status operation itself. If the asynchronous operation succeeded, the response body includes the HTTP status code for the successful request. If the asynchronous operation failed, the response body includes the HTTP status code for the failed request and error information regarding the failure.

update

OperationStatusResponse update(ExtensionImageUpdateParameters parameters)
                               throws InterruptedException,
                                      ExecutionException,
                                      ServiceException,
                                      IOException,
                                      ParserConfigurationException,
                                      SAXException,
                                      TransformerException,
                                      URISyntaxException

Update a new extension. It is allowed to update an extension which had already been registered with the same identity (i.e. combination of ProviderNamespace and Type) but with different version. It will fail if the extension to update has an identity that has not been registered before, or there is already an extension with the same identity and same version.

Parameters:

parameters - Required. Parameters supplied to the Update Virtual Machine Extension Image operation.

Returns:

The response body contains the status of the specified asynchronous operation, indicating whether it has succeeded, is inprogress, or has failed. Note that this status is distinct from the HTTP status code returned for the Get Operation Status operation itself. If the asynchronous operation succeeded, the response body includes the HTTP status code for the successful request. If the asynchronous operation failed, the response body includes the HTTP status code for the failed request and error information regarding the failure.

Throws:

InterruptedException - Thrown when a thread is waiting, sleeping, or otherwise occupied, and the thread is interrupted, either before or during the activity. Occasionally a method may wish to test whether the current thread has been interrupted, and if so, to immediately throw this exception. The following code can be used to achieve this effect:

ExecutionException - Thrown when attempting to retrieve the result of a task that aborted by throwing an exception. This exception can be inspected using the Throwable.getCause() method.

ServiceException - Thrown if the server returned an error for the request.

IOException - Thrown if there was an error setting up tracing for the request.

ParserConfigurationException - Thrown if there was an error configuring the parser for the response body.

SAXException - Thrown if there was an error parsing the response body.

TransformerException - Thrown if there was an error creating the DOM transformer.

ServiceException - Thrown if an unexpected response is found.

URISyntaxException - Thrown if there was an error parsing a URI in the response.

updateAsync

Future<OperationStatusResponse> updateAsync(ExtensionImageUpdateParameters parameters)

Update a new extension. It is allowed to update an extension which had already been registered with the same identity (i.e. combination of ProviderNamespace and Type) but with different version. It will fail if the extension to update has an identity that has not been registered before, or there is already an extension with the same identity and same version.

Parameters:

parameters - Required. Parameters supplied to the Update Virtual Machine Extension Image operation.

Returns:

The response body contains the status of the specified asynchronous operation, indicating whether it has succeeded, is inprogress, or has failed. Note that this status is distinct from the HTTP status code returned for the Get Operation Status operation itself. If the asynchronous operation succeeded, the response body includes the HTTP status code for the successful request. If the asynchronous operation failed, the response body includes the HTTP status code for the failed request and error information regarding the failure.