Skip to content

Commit 6b2e9c6

Browse files
authored
mgmt append introduction for lite packages (Azure#18044)
* mgmt append introduction for lite packages * remove standalone packages section and reformat existing one * update description of single-service package * restore sample code * update mediaservices
1 parent 92d0aa3 commit 6b2e9c6

File tree

1 file changed

+47
-29
lines changed

1 file changed

+47
-29
lines changed

sdk/resourcemanager/README.md

Lines changed: 47 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ If you are an existing user of the older version of Azure management library for
2323

2424
### Include the package
2525

26+
For your convenience, we have provided a multi-service package that includes some of the most highly used Azure services. We recommend using this package when you are dealing with mutiple services.
27+
2628
[//]: # ({x-version-update-start;com.azure.resourcemanager:azure-resourcemanager;current})
2729
```xml
2830
<dependency>
@@ -33,6 +35,49 @@ If you are an existing user of the older version of Azure management library for
3335
```
3436
[//]: # ({x-version-update-end})
3537

38+
The services available via `azure-resourcemanager` are listed as below:
39+
40+
<details>
41+
<summary> List of services </summary>
42+
43+
- App Services
44+
- Authorization
45+
- CDN
46+
- Compute
47+
- Container Instance
48+
- Container Registry
49+
- Container Services (AKS)
50+
- Cosmos DB
51+
- DNS
52+
- Event Hubs
53+
- Insight (Monitor)
54+
- Key Vault
55+
- Managed Identity
56+
- Network
57+
- Private DNS
58+
- Redis
59+
- Resources
60+
- Service Bus
61+
- Spring Cloud
62+
- SQL
63+
- Storage
64+
- Traffic Manager
65+
</details>
66+
67+
In the case where you are interested in certain service above or the service not included in the multi-service package, you can choose to use the single-service package for each service. Those packages follow the same naming patterns and design principals. For example, the package for Media Services has the following artifact information.
68+
69+
[//]: # ({x-version-update-start;com.azure.resourcemanager:azure-resourcemanager-mediaservices;dependency})
70+
```xml
71+
<dependency>
72+
<groupId>com.azure.resourcemanager</groupId>
73+
<artifactId>azure-resourcemanager-mediaservices</artifactId>
74+
<version>1.0.0-beta.1</version>
75+
</dependency>
76+
```
77+
[//]: # ({x-version-update-end})
78+
79+
See [Single-Service Packages][single_service_packages] for a complete list of single-services packages with the API versions they are consuming.
80+
3681
### Include the recommended packages
3782

3883
Azure Management Libraries require a `TokenCredential` implementation for authentication and an `HttpClient` implementation for HTTP client.
@@ -75,7 +120,7 @@ By default, Azure Active Directory token authentication depends on correct confi
75120

76121
In addition, Azure subscription ID can be configured via environment variable `AZURE_SUBSCRIPTION_ID`.
77122

78-
With above configuration, `azure` client can be authenticated by following code:
123+
With above configuration, the manager class can be authenticated by following code:
79124

80125
<!-- embedme ./azure-resourcemanager/src/samples/java/com/azure/resourcemanager/ReadmeSamples.java#L62-L68 -->
81126
```java
@@ -109,34 +154,6 @@ The key concepts of Azure Management Libraries includes:
109154
- [API design][design]
110155
- [API design (preview)][design_preview]
111156

112-
### Service features
113-
114-
- App Services
115-
- Authorization
116-
- Compute
117-
- Container Services (AKS)
118-
- Cosmos DB
119-
- DNS
120-
- Insight (Monitor)
121-
- Key Vault
122-
- Managed Identity
123-
- Network
124-
- Resources
125-
- Storage
126-
127-
Services in preview
128-
129-
- CDN
130-
- Container Instance
131-
- Container Registry
132-
- Event Hubs
133-
- Private DNS
134-
- Redis
135-
- Service Bus
136-
- Spring Cloud
137-
- SQL
138-
- Traffic Manager
139-
140157
## Examples
141158

142159
### Fluent interface
@@ -355,6 +372,7 @@ For details on contributing to this repository, see the [contributing guide](htt
355372
[azure_core_http_okhttp]: https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/core/azure-core-http-okhttp
356373
[azure_core]: https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/core/azure-core
357374
[logging]: https://github.com/Azure/azure-sdk-for-java/wiki/Logging-with-Azure-SDK
375+
[single_service_packages]: https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/resourcemanager/docs/SINGLE_SERVICE_PACKAGES.md
358376
[authenticate]: https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/resourcemanager/docs/AUTH.md
359377
[sample]: https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/resourcemanager/docs/SAMPLE.md
360378
[design]: https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/resourcemanager/docs/DESIGN.md

0 commit comments

Comments
 (0)