Validate connection string for hosting server

Validate connection string for hosting server

Method Request URI HTTP Version

POST

serverGroups/{groupName}/hostingServers?Validate=True

HTTP/1.1

Sample XML Request

  Copy Code 
<HostingServer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/windowsazure">
	<AvailableSpaceMB>0</AvailableSpaceMB>
	<ConnectionString>Data Source=servername;User ID=username;Password=password;Asynchronous Processing=True</ConnectionString>
	<Created xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
		<d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
		<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
	</Created>
	<DatabaseCount>0</DatabaseCount>
	<Name>servername</Name>
	<ServerGroups />
	<ServerId i:nil="true" />
	<State i:nil="true" />
	<TotalSpaceMB>0</TotalSpaceMB>
</HostingServer>

Sample XML Response on Success

  Copy Code 
<HostingServer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/windowsazure">
	<AvailableSpaceMB>0</AvailableSpaceMB>
	<ConnectionString>Data Source=servername\sqlexpress;User ID=sa;Password=;Asynchronous Processing=True</ConnectionString>
	<Created xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
		<d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
		<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
	</Created>
	<DatabaseCount>0</DatabaseCount>
	<Name>pt-cspod21\sqlexpress</Name>
	<ServerGroups />
	<ServerId i:nil="true" />
	<State i:nil="true" />
	<TotalSpaceMB>0</TotalSpaceMB>
</HostingServer>

Sample XML Response on Failure

  Copy Code 
<Error xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/windowsazure">
	<Code i:nil="true" />
	<Message>Unable to connect to the hosting server: 'servername'.</Message>
	<Severity i:nil="true" />
	<State i:nil="true" />
</Error>

Validate that database name is valid

Validate that database name is valid

Method Request URI HTTP Version

POST

sqlservers/databases?Validate=True

HTTP/1.1

Sample XML Request

  Copy Code 
<SqlDatabase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/windowsazure">
	<AccountAdminId i:nil="true" />
	<AdminLogon i:nil="true" />
	<Collation i:nil="true" />
	<ConnectionString i:nil="true" />
	<CreationDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
		<d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
		<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
	</CreationDate>
	<Edition i:nil="true" />
	<MaxSizeMB>0</MaxSizeMB>
	<Name>databasename</Name>
	<Password i:nil="true" />
	<Quota i:nil="true" />
	<SelfLink i:nil="true" />
	<SqlServerId i:nil="true" />
	<SqlServerName i:nil="true" />
	<Status i:nil="true" />
	<SubscriptionId i:nil="true" />
</SqlDatabase>

Sample XML Response on Success

  Copy Code 
<SqlDatabase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/windowsazure">
	<AccountAdminId i:nil="true" />
	<AdminLogon i:nil="true" />
	<Collation i:nil="true" />
	<ConnectionString i:nil="true" />
	<CreationDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
		<d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
		<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
	</CreationDate>
	<Edition i:nil="true" />
	<MaxSizeMB>0</MaxSizeMB>
	<Name>databasename</Name>
	<Password i:nil="true" />
	<Quota i:nil="true" />
	<SelfLink i:nil="true" />
	<SqlServerId i:nil="true" />
	<SqlServerName i:nil="true" />
	<Status i:nil="true" />
	<SubscriptionId i:nil="true" />
</SqlDatabase>

Sample XML Response on Failure

  Copy Code 
<Error xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/windowsazure">
	<Code i:nil="true" />
	<Message>The database 'xyzdatabase' already exists. Please specify a different database name.</Message>
	<Severity i:nil="true" />
	<State i:nil="true" />
</Error>

Validate database admin user

Validate database admin user

Method Request URI HTTP Version

POST

sqlservers/databases?Validate=True

HTTP/1.1

Sample XML Request

  Copy Code 
<SqlDatabase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/windowsazure">
	<AccountAdminId i:nil="true" />
	<AdminLogon>admin</AdminLogon>
	<Collation i:nil="true" />
	<ConnectionString i:nil="true" />
	<CreationDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
		<d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
		<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
	</CreationDate>
	<Edition i:nil="true" />
	<MaxSizeMB>0</MaxSizeMB>
	<Name i:nil="true" />
	<Password i:nil="true" />
	<Quota i:nil="true" />
	<SelfLink i:nil="true" />
	<SqlServerId i:nil="true" />
	<SqlServerName i:nil="true" />
	<Status i:nil="true" />
	<SubscriptionId i:nil="true" />
</SqlDatabase>

Sample XML Response on Success

  Copy Code 
<SqlDatabase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/windowsazure">
	<AccountAdminId i:nil="true" />
	<AdminLogon>admin</AdminLogon>
	<Collation i:nil="true" />
	<ConnectionString i:nil="true" />
	<CreationDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
		<d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
		<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
	</CreationDate>
	<Edition i:nil="true" />
	<MaxSizeMB>0</MaxSizeMB>
	<Name i:nil="true" />
	<Password i:nil="true" />
	<Quota i:nil="true" />
	<SelfLink i:nil="true" />
	<SqlServerId i:nil="true" />
	<SqlServerName i:nil="true" />
	<Status i:nil="true" />
	<SubscriptionId i:nil="true" />
</SqlDatabase>

Sample XML Response on Failure

  Copy Code 
<Error xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/windowsazure">
	<Code i:nil="true" />
	<Message>The specified admin logon 'myadminlogon' already exists. Please specify a new logon.</Message>
	<Severity i:nil="true" />
	<State i:nil="true" />
</Error>

Create an event associated with a subscription

Create an event associated with a subscription

Method Request URI HTTP Version

POST

subscriptions/{subscriptionId}/events

HTTP/1.1

Sample XML Request

  Copy Code 
<AzureProvisioningInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.microsoft.com/Azure/ProvisioningAgent/1.0">
	<AccountAdminLiveEmailId>example@contoso.com</AccountAdminLiveEmailId>
	<AccountAdminLivePuid>example@contoso.com</AccountAdminLivePuid>
	<FriendlyName>example-gold</FriendlyName>
	<OfferCategory>example7taqu6o</OfferCategory>
	<ServiceAdminLiveEmailId>example@contoso.com</ServiceAdminLiveEmailId>
	<ServiceAdminLivePuid>example@contoso.com</ServiceAdminLivePuid>
	<SubscriptionId>99404347-ff2a-4739-9a1b-23cabd55da02</SubscriptionId>
</AzureProvisioningInfo>

Sample XML Response

  Copy Code 
<Subscription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/windowsazure">
	<SubscriptionID>99404347-ff2a-4739-9a1b-23cabd55da02</SubscriptionID>
	<SubscriptionName>example-gold</SubscriptionName>
	<SubscriptionStatus>Active</SubscriptionStatus>
	<AccountAdminLiveEmailId>example@contoso.com</AccountAdminLiveEmailId>
	<OfferFriendlyName>example-gold</OfferFriendlyName>
	<OfferCategory>example7taqu6o</OfferCategory>
	<RegisteredServices>webspaces,sqlservers,mysqlservers</RegisteredServices>
	<Created>2012-10-02T20:43:16.15</Created>
</Subscription>

Get details of hosting server, by ID

Get details of hosting server, by ID

Method Request URI HTTP Version

GET

hostingservers/{hostingServerId}

HTTP/1.1

Sample Request

  Copy Code 
Empty

Sample XML Response

  Copy Code 
<HostingServer>
	<AvailableSpaceMB>102400</AvailableSpaceMB>
	<ConnectionString></ConnectionString>
	<Created xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
		<d4p1:DateTime>0001-01-01T00:00:00Z</d4p1:DateTime>
		<d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
	</Created>
	<DatabaseCount>0</DatabaseCount>
	<Name>server1</Name>
	<ServerGroups>
		<SqlServerGroup>
			<GroupId>2n9c</GroupId>
			<GroupName>Default</GroupName>
			<HostingServerCount>1</HostingServerCount>
		</SqlServerGroup>
	</ServerGroups>
	<ServerId>nhw25t</ServerId>
	<State>Active</State>
	<TotalSpaceMB>102400</TotalSpaceMB>
</HostingServer>

Get details of hosting server in a server group, by ID

Get details of hosting server in a server group, by ID

Method Request URI HTTP Version

GET

serverGroups/{groupName}/hostingservers/{hostingServerId}

HTTP/1.1

Sample Request

  Copy Code 
Empty

Sample XML Response

  Copy Code 
<HostingServer>
	<AvailableSpaceMB>102400</AvailableSpaceMB>
	<ConnectionString></ConnectionString>
	<Created xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
		<d4p1:DateTime>0001-01-01T00:00:00Z</d4p1:DateTime>
		<d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
	</Created>
	<DatabaseCount>0</DatabaseCount>
	<Name>server1</Name>
	<ServerGroups>
		<SqlServerGroup>
			<GroupId>2n9c</GroupId>
			<GroupName>Default</GroupName>
			<HostingServerCount>1</HostingServerCount>
		</SqlServerGroup>
	</ServerGroups>
	<ServerId>nhw25t</ServerId>
	<State>Active</State>
	<TotalSpaceMB>102400</TotalSpaceMB>
</HostingServer>

Create a hosting server in a server group

Create a hosting server in a server group

Method Request URI HTTP Version

POST

serverGroups/{groupName}/hostingservers

HTTP/1.1

Sample XML Request

  Copy Code 
<HostingServer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/windowsazure">
	<AvailableSpaceMB>0</AvailableSpaceMB>
	<ConnectionString i:nil="true" />
	<Created xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
		<d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
		<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
	</Created>
	<DatabaseCount>0</DatabaseCount>
	<Name i:nil="true" />
	<ServerGroups>
		<SqlServerGroup>
			<GroupId>29vd29</GroupId>
			<GroupName i:nil="true" />
			<HostingServerCount>0</HostingServerCount>
		</SqlServerGroup>
	</ServerGroups>
	<ServerId>d79evq</ServerId>
	<State i:nil="true" />
	<TotalSpaceMB>0</TotalSpaceMB>
</HostingServer>

Sample XML Response

  Copy Code 
<HostingServer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/windowsazure">
	<AvailableSpaceMB>0</AvailableSpaceMB>
	<ConnectionString i:nil="true" />
	<Created xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
		<d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
		<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
	</Created>
	<DatabaseCount>0</DatabaseCount>
	<Name i:nil="true" />
	<ServerGroups>
		<SqlServerGroup>
			<GroupId>29vd29</GroupId>
			<GroupName i:nil="true" />
			<HostingServerCount>0</HostingServerCount>
		</SqlServerGroup>
	</ServerGroups>
	<ServerId>d79evq</ServerId>
	<State i:nil="true" />
	<TotalSpaceMB>0</TotalSpaceMB>
</HostingServer>

Update a feature of a hosting server in a server group

Update a feature of a hosting server in a server group

Method Request URI HTTP Version

PUT

serverGroups/{groupName}/hostingservers/{serverId}

HTTP/1.1

Sample XML Request

  Copy Code 
<HostingServer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/windowsazure">
	<AvailableSpaceMB>0</AvailableSpaceMB>
	<ConnectionString i:nil="true" />
	<Created xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
		<d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
		<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
	</Created>
	<DatabaseCount>0</DatabaseCount>
	<Name i:nil="true" />
	<ServerGroups>
		<SqlServerGroup>
			<GroupId>29vd29</GroupId>
			<GroupName i:nil="true" />
			<HostingServerCount>0</HostingServerCount>
		</SqlServerGroup>
	</ServerGroups>
	<ServerId>d79evq</ServerId>
	<State i:nil="true" />
	<TotalSpaceMB>0</TotalSpaceMB>
</HostingServer>

Sample XML Response

  Copy Code 
<HostingServer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/windowsazure">
	<AvailableSpaceMB>0</AvailableSpaceMB>
	<ConnectionString i:nil="true" />
	<Created xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
		<d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
		<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
	</Created>
	<DatabaseCount>0</DatabaseCount>
	<Name i:nil="true" />
	<ServerGroups>
		<SqlServerGroup>
			<GroupId>29vd29</GroupId>
			<GroupName i:nil="true" />
			<HostingServerCount>0</HostingServerCount>
		</SqlServerGroup>
	</ServerGroups>
	<ServerId>d79evq</ServerId>
	<State i:nil="true" />
	<TotalSpaceMB>0</TotalSpaceMB>
</HostingServer>

Delete a hosting server from a server group

Delete a hosting server from a server group

Method Request URI HTTP Version

DELETE

serverGroups/{groupName}/hostingservers/{serverId}

HTTP/1.1

Sample Request

  Copy Code 
Empty

Sample Response

  Copy Code 
Empty

Get all metrics associated with a hosting server

Get all metrics associated with a hosting Server

Method Request URI HTTP Version

GET

hostingServers/{id}/Metrics/DatabaseCount?startTime={start-time}&endTime={end-time} (request #1), hostingServers/{id}/Metrics/TotalAllottedSpace?startTime={start-time}&endTime={end-time} (request #2)

HTTP/1.1

Sample Request #1

  Copy Code 
Empty

Sample XML Response #1

  Copy Code 
<ResourceMetricResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/windowsazure">
	<Code i:nil="true" />
	<Data>
		<EndTime>2012-09-28T01:00:00</EndTime>
		<MetricAvailabilities />
		<Name>DatabaseCount</Name>
		<PrimaryAggregationType>Total</PrimaryAggregationType>
		<StartTime>2012-09-27T01:00:00</StartTime>
		<TimeGrain>PT1H</TimeGrain>
		<Unit>Count</Unit>
		<Units>Count</Units>
		<Values>
			<MetricSample>
				<Count>1</Count>
				<Maximum>1</Maximum>
				<Minimum>1</Minimum>
				<TimeCreated>2012-09-28T01:00:00</TimeCreated>
				<Total>1</Total>
			</MetricSample>
			<MetricSample>
				<Count>1</Count>
				<Maximum>0</Maximum>
				<Minimum>0</Minimum>
				<TimeCreated>2012-09-27T01:00:00</TimeCreated>
				<Total>0</Total>
			</MetricSample>
		</Values>
	</Data>
	<Message i:nil="true" />
</ResourceMetricResponse>

Sample Request #2

  Copy Code 
Empty

Sample XML Response #2

  Copy Code 
<ResourceMetricResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/windowsazure">
	<Code i:nil="true" />
	<Data>
		<EndTime>2012-09-28T01:00:00</EndTime>
		<MetricAvailabilities />
		<Name>TotalAllottedSpace</Name>
		<PrimaryAggregationType>Total</PrimaryAggregationType>
		<StartTime>2012-09-27T01:00:00</StartTime>
		<TimeGrain>PT1H</TimeGrain>
		<Unit>Count</Unit>
		<Units>Count</Units>
		<Values>
			<MetricSample>
				<Count>1</Count>
				<Maximum>1024</Maximum>
				<Minimum>1024</Minimum>
				<TimeCreated>2012-09-28T01:00:00</TimeCreated>
				<Total>1024</Total>
			</MetricSample>
			<MetricSample>
				<Count>1</Count>
				<Maximum>0</Maximum>
				<Minimum>0</Minimum>
				<TimeCreated>2012-09-27T01:00:00</TimeCreated>
				<Total>0</Total>
			</MetricSample>
		</Values>
	</Data>
	<Message i:nil="true" />
</ResourceMetricResponse>

Get a list of all database offers

Get a list of all database offers

Method Request URI HTTP Version

GET

offers

HTTP/1.1

Sample Request

  Copy Code 
Empty

Sample Response

  Copy Code 
[
	{
		"Name": "goldh7mjozoj",
		"DisplayName": "gold",
		"OfferAdvertisement": {
			"TenantDisplayName": "gold",
			"Description": null,
			"PriceDescription": null,
			"InvitationCode": null,
			"ServiceAdvertisements": []
	},
		"State": 1,
		"SubscriptionCount": 1,
		"ServiceOffers": [
			{
				"OfferName": null,
				"ServiceName": "webspaces",
				"ServiceOfferSettings": [],
				"IsConfigured": null,
				"ServiceDisplayName": "Web Site Cloud"
		},
			{
				"OfferName": null,
				"ServiceName": "sqlservers",
				"ServiceOfferSettings": [],
				"IsConfigured": null,
				"ServiceDisplayName": "SQL Server"
		}
		],
		"AllowMultipleSignupsPerAccount": false,
		"FanoutState": 0,
		"FanoutErrors": null
}
]

Get details of specified database offer by ID

Get details of specified database offer by ID

Method Request URI HTTP Version

GET

offers/{id}

HTTP/1.1

Sample Request

  Copy Code 
Empty

Sample Response

  Copy Code 
{
	"Name": "newh7mnqqwe",
	"DisplayName": "new",
	"OfferAdvertisement": {
		"TenantDisplayName": "new",
		"Description": null,
		"PriceDescription": null,
		"InvitationCode": null,
		"ServiceAdvertisements": []
},
	"State": 0,
	"SubscriptionCount": 0,
	"ServiceOffers": [
		{
			"OfferName": "newh7mnqqwe",
			"ServiceName": "sqlservers",
			"ServiceOfferSettings": [
				{
					"Key": "editions",
					"Value": "[{\"displayName\":\"Default\",\"groupName\":\"Default\",\"resourceCount\":\"10\",\"resourceMaxSize\":\"1024\",\"offerEditionId\":\"1\",\"groupType\":\"Shared\"}]"
			}
			],
			"IsConfigured": true,
			"ServiceDisplayName": "SQL Server"
	}
	],
	"AllowMultipleSignupsPerAccount": false,
	"FanoutState": 0,
	"FanoutErrors": null
}

Create a database server offer in plans

Create a database server offer in plans

Method Request URI HTTP Version

POST

offers

HTTP/1.1

Sample XML Request

  Copy Code 
<Offer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/windowsazure">
	<Name>newh7mnqqwe</Name>
	<DisplayName>new</DisplayName>
	<OfferAdvertisement>
		<TenantDisplayName>new</TenantDisplayName>
		<ServiceAdvertisements />
	</OfferAdvertisement>
	<ServiceOffers>
		<ServiceOffer>
			<OfferName>newh7mnqqwe</OfferName>
			<ServiceName>sqlservers</ServiceName>
			<ServiceOfferSettings />
		</ServiceOffer>
	</ServiceOffers>
	<FanoutState>InSync</FanoutState>
</Offer>

Sample XML Response

  Copy Code 
<Offer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/windowsazure">
	<Name>newh7mnqqwe</Name>
	<DisplayName>new</DisplayName>
	<OfferAdvertisement>
		<TenantDisplayName>new</TenantDisplayName>
		<ServiceAdvertisements />
	</OfferAdvertisement>
	<ServiceOffers>
		<ServiceOffer>
			<OfferName>newh7mnqqwe</OfferName>
			<ServiceName>sqlservers</ServiceName>
			<ServiceOfferSettings />
		</ServiceOffer>
	</ServiceOffers>
	<FanoutState>InSync</FanoutState>
</Offer>

Update a database server offer in plans

Update a database server offer in plans

Method Request URI HTTP Version

PUT

offers/{id}

HTTP/1.1

Sample XML Request

  Copy Code 
<Offer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/windowsazure">
	<Name>newh7mnqqwe</Name>
	<DisplayName>new</DisplayName>
	<OfferAdvertisement>
		<TenantDisplayName>new</TenantDisplayName>
		<ServiceAdvertisements />
	</OfferAdvertisement>
	<State>Public</State>
	<ServiceOffers>
		<ServiceOffer>
			<OfferName>newh7mnqqwe</OfferName>
			<ServiceName>sqlservers</ServiceName>
			<ServiceOfferSettings />
		</ServiceOffer>
	</ServiceOffers>
	<FanoutState>InSync</FanoutState>
</Offer>

Sample XML Response

  Copy Code 
<Offer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/windowsazure">
	<Name>newh7mnqqwe</Name>
	<DisplayName>new</DisplayName>
	<OfferAdvertisement>
		<TenantDisplayName>new</TenantDisplayName>
		<ServiceAdvertisements />
	</OfferAdvertisement>
	<State>Public</State>
	<ServiceOffers>
		<ServiceOffer>
			<OfferName>newh7mnqqwe</OfferName>
			<ServiceName>sqlservers</ServiceName>
			<ServiceOfferSettings />
		</ServiceOffer>
	</ServiceOffers>
	<FanoutState>OutOfSync</FanoutState>
</Offer>

Delete a database server offer

Delete a database server offer

Method Request URI HTTP Version

DELETE

offers/{id}

HTTP/1.1

Sample Request

  Copy Code 
Empty

Sample Response

  Copy Code 
Empty

Get list of all server groups

Get a list of all server groups

Method Request URI HTTP Version

GET

servergroups

HTTP/1.1

Sample Request

  Copy Code 
Empty

Sample XML Response

  Copy Code 
<HostingServers xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/windowsazure">
	<HostingServer>
		<AvailableSpaceMB>102400</AvailableSpaceMB>
		<ConnectionString></ConnectionString>
		<Created xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
			<d3p1:DateTime>0001-01-01T00:00:00Z</d3p1:DateTime>
			<d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
		</Created>
		<DatabaseCount>0</DatabaseCount>
		<Name>server1</Name>
		<ServerGroups>
			<SqlServerGroup>
				<GroupId>2n9c</GroupId>
				<GroupName>Default</GroupName>
				<HostingServerCount>1</HostingServerCount>
			</SqlServerGroup>
		</ServerGroups>
		<ServerId>nhw25t</ServerId>
		<State>Active</State>
		<TotalSpaceMB>102400</TotalSpaceMB>
	</HostingServer>
</HostingServers>

Get a server group by ID

Get a server group by ID

Method Request URI HTTP Version

GET

servergroups/{id}

HTTP/1.1

Sample Request

  Copy Code 
Empty

Sample XML Response

  Copy Code 
<HostingServer>
	<AvailableSpaceMB>102400</AvailableSpaceMB>
	<ConnectionString></ConnectionString>
	<Created xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
		<d3p1:DateTime>0001-01-01T00:00:00Z</d3p1:DateTime>
		<d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
	</Created>
	<DatabaseCount>0</DatabaseCount>
	<Name>server1</Name>
	<ServerGroups>
		<SqlServerGroup>
			<GroupId>2n9c</GroupId>
			<GroupName>Default</GroupName>
			<HostingServerCount>1</HostingServerCount>
		</SqlServerGroup>
	</ServerGroups>
	<ServerId>nhw25t</ServerId>
	<State>Active</State>
	<TotalSpaceMB>102400</TotalSpaceMB>
</HostingServer>

Create a server group

Create a server group

Method Request URI HTTP Version

POST

servergroups

HTTP/1.1

Sample XML Request

  Copy Code 
<HostingServer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/windowsazure">
	<AvailableSpaceMB>0</AvailableSpaceMB>
	<ConnectionString i:nil="true" />
	<Created xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
		<d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
		<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
	</Created>
	<DatabaseCount>0</DatabaseCount>
	<Name i:nil="true" />
	<ServerGroups>
		<SqlServerGroup>
			<GroupId>29vd29</GroupId>
			<GroupName i:nil="true" />
			<HostingServerCount>0</HostingServerCount>
		</SqlServerGroup>
	</ServerGroups>
	<ServerId>nhw25t</ServerId>
	<State i:nil="true" />
	<TotalSpaceMB>0</TotalSpaceMB>
</HostingServer>

Sample XML Response

  Copy Code 
<HostingServer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/windowsazure">
	<AvailableSpaceMB>0</AvailableSpaceMB>
	<ConnectionString i:nil="true" />
	<Created xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
		<d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
		<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
	</Created>
	<DatabaseCount>0</DatabaseCount>
	<Name i:nil="true" />
	<ServerGroups>
		<SqlServerGroup>
			<GroupId>29vd29</GroupId>
			<GroupName i:nil="true" />
			<HostingServerCount>0</HostingServerCount>
		</SqlServerGroup>
	</ServerGroups>
	<ServerId>nhw25t</ServerId>
	<State i:nil="true" />
	<TotalSpaceMB>0</TotalSpaceMB>
</HostingServer>

Delete a server group

Delete a server group

Method Request URI HTTP Version

DELETE

servergroups/{id}

HTTP/1.1

Sample Request

  Copy Code 
Empty

Sample Response

  Copy Code 
Empty

Get list of all databases created under a subscription

Get list of all databases created under a subscription

Method Request URI HTTP Version

GET

subscriptions/{subscriptionId}/databases?skip={number-of-initial-elements-to-skip}&take={number-of-elements-to-include}

HTTP/1.1

Sample Request

  Copy Code 
Empty

Sample Response

  Copy Code 
<Databases xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/windowsazure" />

Get details of a database created under a subscription, by ID

Get details of a database created under a subscription, by ID

Method Request URI HTTP Version

GET

subscriptions/{subscriptionId}/databases/{databaseId}

HTTP/1.1

Sample Request

  Copy Code 
Empty

Sample Response

  Copy Code 
<SqlDatabase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/windowsazure">
	<AccountAdminId i:nil="true" />
	<AdminLogon>admin01</AdminLogon>
	<Collation>SQL_Latin1_General_CP1_CI_AS</Collation>
	<ConnectionString i:nil="true" />
	<CreationDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
		<d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
		<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
	</CreationDate>
	<Edition>Default</Edition>
	<MaxSizeMB>1024</MaxSizeMB>
	<Name>mydb01</Name>
	<Password>Password123</Password>
	<Quota i:nil="true" />
	<SelfLink i:nil="true" />
	<SqlServerId i:nil="true" />
	<SqlServerName i:nil="true" />
	<Status>1</Status>
	<SubscriptionId>04bd379b-c5d0-4dd7-bf39-b097a882daf9</SubscriptionId>
</SqlDatabase>

Create a database to a subscription

Create a database to a subscription

Method Request URI HTTP Version

POST

subscriptions/{subscriptionId}/databases

HTTP/1.1

Sample XML Request

  Copy Code 
<SqlDatabase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/windowsazure">
	<AccountAdminId i:nil="true" />
	<AdminLogon>admin01</AdminLogon>
	<Collation>SQL_Latin1_General_CP1_CI_AS</Collation>
	<ConnectionString i:nil="true" />
	<CreationDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
		<d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
		<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
	</CreationDate>
	<Edition>Default</Edition>
	<MaxSizeMB>1024</MaxSizeMB>
	<Name>mydb01</Name>
	<Password>Password123</Password>
	<Quota i:nil="true" />
	<SelfLink i:nil="true" />
	<SqlServerId i:nil="true" />
	<SqlServerName i:nil="true" />
	<Status>1</Status>
	<SubscriptionId>04bd379b-c5d0-4dd7-bf39-b097a882daf9</SubscriptionId>
</SqlDatabase>

Sample XML Response

  Copy Code 
<SqlDatabase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/windowsazure">
	<AccountAdminId i:nil="true" />
	<AdminLogon>admin01d5c1l</AdminLogon>
	<Collation>SQL_Latin1_General_CP1_CI_AS</Collation>
	<ConnectionString>Data Source=server1;Initial Catalog=mydb01eqv1x;User ID=admin01d5c1l;Password=&lt;&lt;Your-DB-password-here&gt;&gt;;Asynchronous Processing=True</ConnectionString>
	<CreationDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
		<d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
		<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
	</CreationDate>
	<Edition>Default</Edition>
	<MaxSizeMB>1024</MaxSizeMB>
	<Name>mydb01eqv1x</Name>
	<Password>Password123</Password>
	<Quota i:nil="true" />
	<SelfLink i:nil="true" />
	<SqlServerId i:nil="true" />
	<SqlServerName>server1</SqlServerName>
	<Status>1</Status>
	<SubscriptionId>04bd379b-c5d0-4dd7-bf39-b097a882daf9</SubscriptionId>
</SqlDatabase>

Delete a database from a subscription

Delete a database from a subscription

Method Request URI HTTP Version

DELETE

subscriptions/{subscriptionId}/databases/{id}

HTTP/1.1

Sample Request

  Copy Code 
Empty

Sample Response

  Copy Code 
Empty

Update a database created under a subscription

Update a database created under a subscription

Method Request URI HTTP Version

PUT

subscriptions/{subscriptionId}/databases/{id}

HTTP/1.1

Sample XML Request

  Copy Code 
<SqlDatabase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/windowsazure">
	<AccountAdminId i:nil="true" />
	<AdminLogon>admin01d5c1l</AdminLogon>
	<Collation>SQL_Latin1_General_CP1_CI_AS</Collation>
	<ConnectionString>Data Source=server1;Initial Catalog=mydb01eqv1x;User ID=admin01d5c1l;Password=&lt;&lt;Your-DB-password-here&gt;&gt;;Asynchronous Processing=True</ConnectionString>
	<CreationDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
		<d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
		<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
	</CreationDate>
	<Edition>Default</Edition>
	<MaxSizeMB>1024</MaxSizeMB>
	<Name>mydb01eqv1x</Name>
	<Password>Password123</Password>
	<Quota>1024</Quota>
	<SelfLink i:nil="true" />
	<SqlServerId>nhw25t</SqlServerId>
	<SqlServerName>server1</SqlServerName>
	<Status>1</Status>
	<SubscriptionId>04bd379b-c5d0-4dd7-bf39-b097a882daf9</SubscriptionId>
</SqlDatabase>

Sample XML Response

  Copy Code 
<SqlDatabase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/windowsazure">
	<AccountAdminId i:nil="true" />
	<AdminLogon>admin01d5c1l</AdminLogon>
	<Collation>SQL_Latin1_General_CP1_CI_AS</Collation>
	<ConnectionString>Data Source=server1;Initial Catalog=mydb01eqv1x;User ID=admin01d5c1l;Password=&lt;&lt;Your-DB-password-here&gt;&gt;;Asynchronous Processing=True</ConnectionString>
	<CreationDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
		<d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
		<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
	</CreationDate>
	<Edition>Default</Edition>
	<MaxSizeMB>1024</MaxSizeMB>
	<Name>mydb01eqv1x</Name>
	<Password>Password123</Password>
	<Quota>1024</Quota>
	<SelfLink i:nil="true" />
	<SqlServerId>nhw25t</SqlServerId>
	<SqlServerName>server1</SqlServerName>
	<Status>1</Status>
	<SubscriptionId>04bd379b-c5d0-4dd7-bf39-b097a882daf9</SubscriptionId>
</SqlDatabase>

Get a list of databases that have been created under a hosting server

Get a list of databases that have been created under a hosting server

Method Request URI HTTP Version

GET

hostingservers/{serverId}/databases

HTTP/1.1

Sample Request

  Copy Code 
Empty

Sample XML Response (Admin)

  Copy Code 
<QueryResultOfSqlDatabaseV8bMqAjG xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/windowsazure">
	<filteredTotalCount>1</filteredTotalCount>
	<items>
		<SqlDatabase>
			<AccountAdminId>example@contoso.com</AccountAdminId>
			<AdminLogon>admin01d5c1l</AdminLogon>
			<Collation>SQL_Latin1_General_CP1_CI_AS</Collation>
			<ConnectionString>Data Source=server1;Initial Catalog=mydb01eqv1x;User ID=admin01d5c1l;Password=&lt;&lt;Your-DB-password-here&gt;&gt;;Asynchronous Processing=True</ConnectionString>
			<CreationDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
				<d4p1:DateTime>0001-01-01T00:00:00Z</d4p1:DateTime>
				<d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
			</CreationDate>
			<Edition>Default</Edition>
			<MaxSizeMB>1024</MaxSizeMB>
			<Name>mydb01eqv1x</Name>
			<Password></Password>
			<Quota>1024</Quota>
			<SelfLink i:nil="true" />
			<SqlServerId>nhw25t</SqlServerId>
			<SqlServerName>server1</SqlServerName>
			<Status>1</Status>
			<SubscriptionId>04bd379b-c5d0-4dd7-bf39-b097a882daf9</SubscriptionId>
		</SqlDatabase>
	</items>
	<totalCount>1</totalCount>
</QueryResultOfSqlDatabaseV8bMqAjG>

Sample XML Response (Tenant)

  Copy Code 
<Databases xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/windowsazure" />

Get a list of all the subscriptions

Get a list of all the subscriptions

Method Request URI HTTP Version

GET

subscriptions

HTTP/1.1

Sample Request

  Copy Code 
Empty

Sample JSON Response

  Copy Code 
[
	{
		"SubscriptionID": "04bd379b-c5d0-4dd7-bf39-b097a882daf9",
		"SubscriptionName": "gold",
		"SubscriptionStatus": "Active",
		"AccountAdminLiveEmailId": "example@contoso.com",
		"ServiceAdminLiveEmailId": null,
		"Features": null,
		"OfferFriendlyName": "gold",
		"OfferCategory": "goldh7mjozoj",
		"RegisteredServices": "webspaces,sqlservers",
		"Created": "2012-09-28T00:58:20.783",
		"FanoutState": 0,
		"FanoutErrors": []
}
]

Get a subscription by ID

Get a subscription by ID

Method Request URI HTTP Version

GET

subscriptions/{id}

HTTP/1.1

Sample Request

  Copy Code 
Empty

Sample JSON Response

  Copy Code 
{
	"SubscriptionID": "04bd379b-c5d0-4dd7-bf39-b097a882daf9",
	"SubscriptionName": "gold",
	"SubscriptionStatus": "Active",
	"AccountAdminLiveEmailId": "example@contoso.com",
	"ServiceAdminLiveEmailId": null,
	"Features": null,
	"OfferFriendlyName": "gold",
	"OfferCategory": "goldh7mjozoj",
	"RegisteredServices": "webspaces,sqlservers",
	"Created": "2012-09-28T00:58:20.783",
	"FanoutState": 0,
	"FanoutErrors": []
}

Get usage data from database extension

Get usage data from database extension

Method Request URI HTTP Version

GET

usage?lastId={last-ID}&batchsize={number-of-elements-to-return}

HTTP/1.1

Sample Request

  Copy Code 
Empty

Sample Response

  Copy Code 
[
	{
		"EventId": "1",
		"StartTime": "2012-09-20T15:41:38-07:00",
		"EndTime": "2012-09-20T16:20:19-07:00",
		"ServiceType": "Default",
		"SubscriptionId": "8642a09d-f584-48a9-b0a5-9be3805d84f4",
		"Properties": null,
		"Resources": {
			"Count": "1",
			"TotalAllottedSpace": "1024"
	}
},
	{
		"EventId": "2",
		"StartTime": "2012-09-20T16:20:19-07:00",
		"EndTime": "2012-09-20T19:58:06-07:00",
		"ServiceType": "Default",
		"SubscriptionId": "8642a09d-f584-48a9-b0a5-9be3805d84f4",
		"Properties": null,
		"Resources": {
			"Count": "2",
			"TotalAllottedSpace": "2048"
	}
},
	{
		"EventId": "3",
		"StartTime": "2012-09-20T19:58:06-07:00",
		"EndTime": "2012-09-20T19:58:06-07:00",
		"ServiceType": "Default",
		"SubscriptionId": "8642a09d-f584-48a9-b0a5-9be3805d84f4",
		"Properties": null,
		"Resources": {
			"Count": "1",
			"TotalAllottedSpace": "1024"
	}
},
	{
		"EventId": "4",
		"StartTime": "2012-09-20T13:48:56-07:00",
		"EndTime": "2012-09-22T00:00:00-07:00",
		"ServiceType": "Default",
		"SubscriptionId": "f4ebb474-3aad-4836-bea4-fb398f271541",
		"Properties": null,
		"Resources": {
			"Count": "1",
			"TotalAllottedSpace": "1024"
	}
},
	{
		"EventId": "5",
		"StartTime": "2012-09-20T19:58:06-07:00",
		"EndTime": "2012-09-22T00:00:00-07:00",
		"ServiceType": "Default",
		"SubscriptionId": "8642a09d-f584-48a9-b0a5-9be3805d84f4",
		"Properties": null,
		"Resources": {
			"Count": "0",
			"TotalAllottedSpace": "0"
	}
},
	{
		"EventId": "6",
		"StartTime": "2012-09-21T17:25:58-07:00",
		"EndTime": "2012-09-22T00:00:00-07:00",
		"ServiceType": "Default",
		"SubscriptionId": "4e60b699-5741-4f82-b9a6-a2149a34ddd3",
		"Properties": null,
		"Resources": {
			"Count": "1",
			"TotalAllottedSpace": "1024"
	}
},
	{
		"EventId": "7",
		"StartTime": "2012-09-22T00:00:00-07:00",
		"EndTime": "2012-09-23T00:00:00-07:00",
		"ServiceType": "Default",
		"SubscriptionId": "f4ebb474-3aad-4836-bea4-fb398f271541",
		"Properties": null,
		"Resources": {
			"Count": "1",
			"TotalAllottedSpace": "1024"
	}
},
	{
		"EventId": "8",
		"StartTime": "2012-09-22T00:00:00-07:00",
		"EndTime": "2012-09-23T00:00:00-07:00",
		"ServiceType": "Default",
		"SubscriptionId": "8642a09d-f584-48a9-b0a5-9be3805d84f4",
		"Properties": null,
		"Resources": {
			"Count": "0",
			"TotalAllottedSpace": "0"
	}
},
	{
		"EventId": "9",
		"StartTime": "2012-09-22T00:00:00-07:00",
		"EndTime": "2012-09-23T00:00:00-07:00",
		"ServiceType": "Default",
		"SubscriptionId": "4e60b699-5741-4f82-b9a6-a2149a34ddd3",
		"Properties": null,
		"Resources": {
			"Count": "1",
			"TotalAllottedSpace": "1024"
	}
},
	{
		"EventId": "10",
		"StartTime": "2012-09-23T00:00:00-07:00",
		"EndTime": "2012-09-24T00:00:00-07:00",
		"ServiceType": "Default",
		"SubscriptionId": "f4ebb474-3aad-4836-bea4-fb398f271541",
		"Properties": null,
		"Resources": {
			"Count": "1",
			"TotalAllottedSpace": "1024"
	}
}
]