Skip to content

Commit 3dc1bd3

Browse files
devigneddevigned
committed
Update README.md
1 parent 1d5e7f7 commit 3dc1bd3

File tree

1 file changed

+25
-173
lines changed

1 file changed

+25
-173
lines changed

‎README.md

Lines changed: 25 additions & 173 deletions
Original file line numberDiff line numberDiff line change
@@ -1,190 +1,42 @@
11
#Microsoft Azure SDK for Java
22

3-
This project provides a client library in Java that makes it easy to consume Microsoft Azure services. For documentation please see the [Microsoft Azure Java Developer Center](http://azure.microsoft.com/en-us/develop/java/).
4-
5-
6-
#Features
7-
8-
9-
* Service Bus
10-
* Queues
11-
* Create/Read/Update/Delete queues
12-
* Send/Receive/Unlock/Delete messages
13-
* Renew message lock
14-
* Message forwarding
15-
* Topics
16-
* Create/Read/Update/Delete topics
17-
* Create/Read/Update/Delete subscriptions
18-
* Create/Read/Update/Delete rules
19-
* Send/Receive/Unlock/Delete messages
20-
* Renew message lock
21-
* Message forwarding
22-
* Media Services
23-
* Create/Read/Update/Delete access policies
24-
* Create/Read/Update/Delete asset files
25-
* Create/Read/Update/Delete assets
26-
* Create/Read/Delete asset delivery policies
27-
* Create/Read/Update/Delete/Rebind content keys
28-
* Create/Read/Delete content keys authorization policies/options
29-
* Create/Read/Update/Cancel/Delete jobs
30-
* Add/Get job notifications
31-
* Create/Read/Update/Delete notification endpoints
32-
* Create/Start/Scale/Stop/Delete streaming endpoints
33-
* Get/Update encoding reserved units
34-
* Get storage accounts
35-
* Serialize/Deserialize/GetTestToken [TokenRestriction](https://msdn.microsoft.com/en-us/library/azure/dn783467.aspx#code-snippet-4) Templates
36-
* Serialize/Deserialize [PlayReadyLicenseResponse](https://azure.microsoft.com/en-us/documentation/articles/media-services-playready-license-template-overview/#_schema) Templates
37-
* Service Management
38-
* Management
39-
* Create/Delete/Get/List/Update affinity group
40-
* List ___location
41-
* Create/Delete/Get/List management certificate
42-
* List role size
43-
* Get/List subscription
44-
* Register/Unregister resource
45-
* Compute Management
46-
* ChangeConfiguration/Delete/Reboot/Reimage/Swap/Update/Upgrade deployment
47-
* AddExtension/Delete/CheckNameAvailability/Create/Delete/Get/GetDetailed/GetExtension/List/ListAvailableExtension/Update hosted service operations
48-
* List/ListFamilies operating system
49-
* Create/Delete/Get/List service certificate
50-
* Create/Delete/Get/List/Update data disk or disk
51-
* List/ListVersions virtual machine extension
52-
* Capture/Create/Delete/Restart/Shutdown/Start/Update/Start/Update/UpdateLoadBalancedEndpointSet virtual machine
53-
* Create/Delete/Get/List/Update virtual machine OS image
54-
* Delete/List virtual machine image
55-
* Websites Management
56-
* Create/Delete/Get/List/Update server farm
57-
* Create/Delete/DeleteRepository/GeneratePassword/Get/GetConfiguration/GetHistoricalUsageMetrics/GetInstanceIds/GetPublishProfile/GetRepository/GetUsageMetrics/isHostnameAvailable/Restart/SwapSlots/SyncRepository/Update/UpdateConfiguration of Azure web sites
58-
* CreatePublishingUser/Get/List/ListGeoRegions/ListPublishingUser/ListWebSites of web space
59-
* Network Management
60-
* Create/Delete/Get/List client root certificate
61-
* Connect/Disconnect/Testing/Create/Delete/Failover/ResetSharedKey gateway operations
62-
* SetConfiguration/GetConfiguration/Get/List network
63-
* Create/Delete/Get/List reserved IP operations
64-
* Check static IP operations
65-
* Storage Management
66-
* Create/CheckNameAvailability/Delete/Get/GetAsync/GetKeys/List/RegenerateKeys/Update Azure storage account
67-
* Sql Database Management
68-
* Export/GetStatus/Import database
69-
* Get/List database operation's operation
70-
* Create/Delete/Get/GetAsync/GetEventLogs/List/Update database operations
71-
* Create/Delete/Get/List/Update firewall rule
72-
* ChangeAdministratorPassword/Create/Delete/List server operations
73-
* Get/List service objective
74-
* Service Runtime
75-
* Retrieve information about the state of your Azure Compute instances
76-
* Storage
77-
* The Azure Storage SDK for Java is maintained in a separate repository. You can find the Azure Storage SDK for Java at [https://github.com/Azure/azure-storage-java](https://github.com/Azure/azure-storage-java).
78-
* Key Vault
79-
* Create/Update/Delete/Get/List keys.
80-
* Create/Update/Delete/Get/List secrets.
3+
This project provides a client library in Java that makes it easy to consume Microsoft Azure services. For documentation please see the [JavaDocs](http://azure.github.io/azure-sdk-for-java). For a list of libraries and how they are organized, please see the [Azure SDK for Java Features Wiki page] (https://github.com/Azure/azure-sdk-for-java/wiki/Azure-SDK-for-Java-Features).
814

825
#Getting Started
6+
You will need Java v1.6+. If you would like to develop on the SDK, you will also need maven.
837

84-
##Download
85-
###Option 1: Via Git
86-
87-
To get the source code of the SDK via git just type:
88-
89-
git clone git://github.com/Azure/azure-sdk-for-java.git
90-
cd ./azure-sdk-for-java/
91-
mvn compile
8+
##Via Maven
9+
Maven distributed jars are the recommended way of getting started with the Azure Java SDK. You can add these dependencies to many of the Java dependency managment tools (Maven, Gradle, Ivy...) and ensure that your project will contain all the Azure dependencies as well as the dependencies of the Azure Java SDK. A list of the artifacts are in the [Azure SDK for Java Features Wiki page] (https://github.com/Azure/azure-sdk-for-java/wiki/Azure-SDK-for-Java-Features).
9210

93-
###Option 2: Via Maven
94-
95-
To get the binaries of this library as distributed by Microsoft, ready for use
96-
within your project you can also have them installed by the Java package manager Maven.
97-
98-
```xml
99-
<dependency>
100-
<groupId>com.microsoft.azure</groupId>
101-
<artifactId>azure-management</artifactId>
102-
<version>0.6.0</version>
103-
</dependency>
104-
```
105-
```xml
106-
<dependency>
107-
<groupId>com.microsoft.azure</groupId>
108-
<artifactId>azure-management-compute</artifactId>
109-
<version>0.6.0</version>
110-
</dependency>
111-
```
112-
```xml
113-
<dependency>
114-
<groupId>com.microsoft.azure</groupId>
115-
<artifactId>azure-management-network</artifactId>
116-
<version>0.6.0</version>
117-
</dependency>
118-
```
119-
```xml
120-
<dependency>
121-
<groupId>com.microsoft.azure</groupId>
122-
<artifactId>azure-management-sql</artifactId>
123-
<version>0.6.0</version>
124-
</dependency>
125-
```
126-
```xml
127-
<dependency>
128-
<groupId>com.microsoft.azure</groupId>
129-
<artifactId>azure-management-storage</artifactId>
130-
<version>0.6.0</version>
131-
</dependency>
132-
```
133-
```xml
134-
<dependency>
135-
<groupId>com.microsoft.azure</groupId>
136-
<artifactId>azure-management-websites</artifactId>
137-
<version>0.6.0</version>
138-
</dependency>
139-
```
140-
```xml
141-
<dependency>
142-
<groupId>com.microsoft.azure</groupId>
143-
<artifactId>azure-media</artifactId>
144-
<version>0.6.0</version>
145-
</dependency>
146-
```
147-
```xml
148-
<dependency>
149-
<groupId>com.microsoft.azure</groupId>
150-
<artifactId>azure-servicebus</artifactId>
151-
<version>0.6.0</version>
152-
</dependency>
153-
```
154-
```xml
155-
<dependency>
156-
<groupId>com.microsoft.azure</groupId>
157-
<artifactId>azure-serviceruntime</artifactId>
158-
<version>0.6.0</version>
159-
</dependency>
11+
##Via Git
12+
If using package management is not your thing, then you can grab the sdk directly from source using git. To get the source code of the SDK via git just type:
13+
```bash
14+
git clone https://github.com/Azure/azure-sdk-for-java.git
15+
cd ./azure-sdk-for-java/
16016
```
16117

162-
##Minimum Requirements
18+
## Azure Resource Manager Usage
19+
### Authentication
20+
The first step to using the SDK is authentication and permissioning. For people unfamilar with Azure this may be one of the more difficult concepts. For a reference on setting up a service principal from the command line see [Authenticating a service principal with Azure Resource Manager](http://aka.ms/cli-service-principal) or [Unattended Authentication](http://aka.ms/auth-unattended). For a more robust explanation of authentication in Azure, see [Developer’s guide to auth with Azure Resource Manager API](http://aka.ms/arm-auth-dev-guide).
16321

164-
* Java 1.6
165-
* (Optional) Maven
22+
After creating the service principal, you should have three pieces of information, a client id (GUID), client secret (string) and tenant id (GUID) or ___domain name (string).
16623

24+
### Getting Started Samples
25+
We have a collection of getting started samples which will show you how to [deploy templates](https://github.com/Azure/azure-sdk-for-java/blob/master/azure-mgmt-samples/src/main/java/com/microsoft/azure/samples/templatedeployments/CreateTemplateDeploymentExample.java#L19-L95), [create virtual machines](https://github.com/Azure/azure-sdk-for-java/blob/master/azure-mgmt-samples/src/main/java/com/microsoft/azure/samples/compute/CreateVMExample.java#L37-L99) and [simply authenticate](https://github.com/Azure/azure-sdk-for-java/blob/master/azure-mgmt-samples/src/main/java/com/microsoft/azure/samples/authentication/ServicePrincipalExample.java#L104-L139). There are also a handful of utilities and helpers you will find useful in the azure-mgmt-utilities.
16726

168-
##Usage
27+
## Need some help?
28+
If you encounter any bugs with the SDK please file an issue via [Issues](https://github.com/Azure/azure-sdk-for-java/issues) or checkout [StackOverflow for Azure Java SDK](http://stackoverflow.com/questions/tagged/azure-java-sdk).
16929

170-
To use this SDK to call Microsoft Azure services, you need to first create an
171-
account. To host your Java code in Microsoft Azure, you additionally need to download
172-
the full Microsoft Azure SDK for Java - which includes packaging, emulation, and
173-
deployment tools.
30+
#Contribute Code
17431

32+
If you would like to become an active contributor to this project please follow the instructions provided in [Microsoft Azure Projects Contribution Guidelines](http://azure.github.io/guidelines.html).
17533

176-
#Need Help?
177-
178-
Be sure to check out the Microsoft Azure [Developer Forums on Stack Overflow](http://go.microsoft.com/fwlink/?LinkId=234489) if you have trouble with the provided code.
179-
180-
#Contribute Code or Provide Feedback
181-
182-
If you would like to become an active contributor to this project please follow the instructions provided in [Microsoft Azure Projects Contribution Guidelines](http://azure.github.com/guidelines.html).
183-
184-
If you encounter any bugs with the library please file an issue in the [Issues](https://github.com/Azure/azure-sdk-for-java/issues) section of the project.
34+
1. Fork it
35+
2. Create your feature branch (`git checkout -b my-new-feature`)
36+
3. Commit your changes (`git commit -am 'Add some feature'`)
37+
4. Push to the branch (`git push origin my-new-feature`)
38+
5. Create new Pull Request
18539

18640
#Learn More
187-
188-
* [Microsoft Azure Java Developer Center](http://azure.microsoft.com/en-us/develop/java/)
189-
* [JavaDocs](http://dl.windowsazure.com/javadoc/)
41+
* [JavaDocs](http://azure.github.io/azure-sdk-for-java)
19042

0 commit comments

Comments
 (0)