org.jclouds.azure.management.features

Interface HostedServiceApi

public interface HostedServiceApi

The Service Management API includes operations for managing the hosted services beneath your subscription.

Author:

Gerald Pereira, Adrian Cole

See Also:

docs, HostedServiceAsyncApi

Method Summary

Methods

Modifier and Type	Method and Description
String	createServiceWithLabelInLocation(String serviceName, String label, String location) The Create Hosted Service operation creates a new hosted service in Windows Azure.
String	createServiceWithLabelInLocation(String serviceName, String label, String location, CreateHostedServiceOptions options) same as createServiceWithLabelInLocation(String, String, String) , except you can specify optional parameters such as extended properties or a description.
String	delete(String serviceName) The Delete Hosted Service operation deletes the specified hosted service from Windows Azure.
String	deleteDeployment(String serviceName, String deploymentName) The Delete Deployment operation deletes the specified deployment from Windows Azure.
HostedService	get(String serviceName) The Get Hosted Service Properties operation retrieves system properties for the specified hosted service.
Deployment	getDeployment(String serviceName, String deploymentName) The Get Deployment operation returns the specified deployment from Windows Azure.
HostedServiceWithDetailedProperties	getDetails(String serviceName) like get(String), except additional data such as status and deployment information is returned.
Set<HostedServiceWithDetailedProperties>	list() The List Hosted Services operation lists the hosted services available under the current subscription.

Method Detail

list

Set<HostedServiceWithDetailedProperties> list()

The List Hosted Services operation lists the hosted services available under the current subscription.

Returns:

the response object

createServiceWithLabelInLocation

String createServiceWithLabelInLocation(String serviceName,
                                      String label,
                                      String location)

The Create Hosted Service operation creates a new hosted service in Windows Azure.

Parameters:

serviceName - A name for the hosted service that is unique within Windows Azure. This name is the DNS prefix name and can be used to access the hosted service. For example: http://ServiceName.cloudapp.net//

label - The name can be used identify the storage account for your tracking purposes. The name can be up to 100 characters in length.

location - The location where the hosted service will be created.

Returns:

the requestId to track this async request progress

See Also:

docs

createServiceWithLabelInLocation

String createServiceWithLabelInLocation(String serviceName,
                                      String label,
                                      String location,
                                      CreateHostedServiceOptions options)

same as createServiceWithLabelInLocation(String, String, String) , except you can specify optional parameters such as extended properties or a description.

Parameters:

options - parameters such as extended properties or a description.

get

HostedService get(String serviceName)

The Get Hosted Service Properties operation retrieves system properties for the specified hosted service. These properties include the service name and service type; the name of the affinity group to which the service belongs, or its location if it is not part of an affinity group.

Parameters:

serviceName - the unique DNS Prefix value in the Windows Azure Management Portal

getDetails

HostedServiceWithDetailedProperties getDetails(String serviceName)

like get(String), except additional data such as status and deployment information is returned.

Parameters:

serviceName - the unique DNS Prefix value in the Windows Azure Management Portal

delete

String delete(String serviceName)

The Delete Hosted Service operation deletes the specified hosted service from Windows Azure.

Parameters:

serviceName - the unique DNS Prefix value in the Windows Azure Management Portal

Returns:

request id or null, if not found

deleteDeployment

String deleteDeployment(String serviceName,
                      String deploymentName)

The Delete Deployment operation deletes the specified deployment from Windows Azure.

Parameters:

serviceName - the unique DNS Prefix value in the Windows Azure Management Portal

deploylentName - the unique DNS Prefix value in the Windows Azure Management Portal

getDeployment

Deployment getDeployment(String serviceName,
                       String deploymentName)

The Get Deployment operation returns the specified deployment from Windows Azure.

Parameters:

serviceName - the unique DNS Prefix value in the Windows Azure Management Portal

deploylentName - the unique DNS Prefix value in the Windows Azure Management Portal