Update docs metadata
This commit is contained in:
azure-sdk
Родитель
c732747a48
Коммит
82e8003a2a
|
|
@ -1,12 +1,12 @@
|
|||
---
|
||||
title: Azure Resource Manager Automanage client library for Java
|
||||
keywords: Azure, java, SDK, API, azure-resourcemanager-automanage, automanage
|
||||
ms.date: 08/10/2022
|
||||
ms.date: 10/10/2024
|
||||
ms.topic: reference
|
||||
ms.devlang: java
|
||||
ms.service: automanage
|
||||
---
|
||||
# Azure Resource Manager Automanage client library for Java - version 1.0.0-beta.1
|
||||
# Azure Resource Manager Automanage client library for Java - version 1.0.0-beta.2
|
||||
|
||||
|
||||
Azure Resource Manager Automanage client library for Java.
|
||||
|
|
@ -41,7 +41,7 @@ Various documentation is available to help you get started
|
|||
<dependency>
|
||||
<groupId>com.azure.resourcemanager</groupId>
|
||||
<artifactId>azure-resourcemanager-automanage</artifactId>
|
||||
<version>1.0.0-beta.1</version>
|
||||
<version>1.0.0-beta.2</version>
|
||||
</dependency>
|
||||
```
|
||||
[//]: # ({x-version-update-end})
|
||||
|
|
@ -50,19 +50,15 @@ Various documentation is available to help you get started
|
|||
|
||||
Azure Management Libraries require a `TokenCredential` implementation for authentication and an `HttpClient` implementation for HTTP client.
|
||||
|
||||
[Azure Identity][azure_identity] package and [Azure Core Netty HTTP][azure_core_http_netty] package provide the default implementation.
|
||||
[Azure Identity][azure_identity] and [Azure Core Netty HTTP][azure_core_http_netty] packages provide the default implementation.
|
||||
|
||||
### Authentication
|
||||
|
||||
By default, Azure Active Directory token authentication depends on correct configure of following environment variables.
|
||||
Microsoft Entra ID token authentication relies on the [credential class][azure_identity_credentials] from [Azure Identity][azure_identity] package.
|
||||
|
||||
- `AZURE_CLIENT_ID` for Azure client ID.
|
||||
- `AZURE_TENANT_ID` for Azure tenant ID.
|
||||
- `AZURE_CLIENT_SECRET` or `AZURE_CLIENT_CERTIFICATE_PATH` for client secret or client certificate.
|
||||
Azure subscription ID can be configured via `AZURE_SUBSCRIPTION_ID` environment variable.
|
||||
|
||||
In addition, Azure subscription ID can be configured via environment variable `AZURE_SUBSCRIPTION_ID`.
|
||||
|
||||
With above configuration, `azure` client can be authenticated by following code:
|
||||
Assuming the use of the `DefaultAzureCredential` credential class, the client can be authenticated using the following code:
|
||||
|
||||
```java
|
||||
AzureProfile profile = new AzureProfile(AzureEnvironment.AZURE);
|
||||
|
|
@ -83,96 +79,8 @@ See [API design][design] for general introduction on design and key concepts on
|
|||
|
||||
## Examples
|
||||
|
||||
[Code snippets and samples](https://github.com/Azure/azure-sdk-for-java/blob/azure-resourcemanager-automanage_1.0.0-beta.1/sdk/automanage/azure-resourcemanager-automanage/SAMPLE.md)
|
||||
[Code snippets and samples](https://github.com/Azure/azure-sdk-for-java/blob/azure-resourcemanager-automanage_1.0.0-beta.2/sdk/automanage/azure-resourcemanager-automanage/SAMPLE.md)
|
||||
|
||||
### Create Custom Configuration Profile
|
||||
|
||||
```java
|
||||
Map<String, String> tags = Map.of("environment", "prod");
|
||||
|
||||
String configuration = "{" +
|
||||
"\"Antimalware/Enable\":false," +
|
||||
"\"AzureSecurityCenter/Enable\":true," +
|
||||
"\"Backup/Enable\":false," +
|
||||
"\"BootDiagnostics/Enable\":true," +
|
||||
"\"ChangeTrackingAndInventory/Enable\":true," +
|
||||
"\"GuestConfiguration/Enable\":true," +
|
||||
"\"LogAnalytics/Enable\":true," +
|
||||
"\"UpdateManagement/Enable\":true," +
|
||||
"\"VMInsights/Enable\":true" +
|
||||
"}";
|
||||
|
||||
client
|
||||
.configurationProfiles()
|
||||
.define("configurationProfileName")
|
||||
.withRegion("East US")
|
||||
.withExistingResourceGroup("resourceGroup")
|
||||
.withTags(tags)
|
||||
.withProperties(
|
||||
new ConfigurationProfileProperties()
|
||||
.withConfiguration(
|
||||
SerializerFactory
|
||||
.createDefaultManagementSerializerAdapter()
|
||||
.deserialize(
|
||||
configuration,
|
||||
Object.class,
|
||||
SerializerEncoding.JSON)))
|
||||
.create();
|
||||
```
|
||||
|
||||
### Delete Custom Configuration Profile by Resource ID
|
||||
|
||||
```java
|
||||
client.configurationProfiles().deleteById("<resource ID>");
|
||||
```
|
||||
|
||||
### Delete Custom Configuration Profile by Resource Group
|
||||
|
||||
```java
|
||||
client.configurationProfiles().deleteByResourceGroup("resourceGroup", "configurationProfileName");
|
||||
```
|
||||
|
||||
### Get Custom Configuration Profile by Resource ID
|
||||
|
||||
```java
|
||||
ConfigurationProfile profile = client.configurationProfiles().getById("<resource ID>");
|
||||
System.out.println(profile.innerModel().properties().configuration());
|
||||
```
|
||||
|
||||
### Create Best Practices Production Profile Assignment
|
||||
|
||||
```java
|
||||
String configProfile = "/providers/Microsoft.Automanage/bestPractices/AzureBestPracticesProduction";
|
||||
client
|
||||
.configurationProfileAssignments()
|
||||
.define("default") // name must be default
|
||||
.withExistingVirtualMachine("resourceGroup", "vmName")
|
||||
.withProperties(
|
||||
new ConfigurationProfileAssignmentProperties()
|
||||
.withConfigurationProfile("configurationProfileName"))
|
||||
.create();
|
||||
```
|
||||
|
||||
### Create Custom Profile Assignment
|
||||
|
||||
```java
|
||||
String configProfile = "/subscriptions/<subscription ID>/resourceGroups/resourceGroup/providers/Microsoft.Automanage/configurationProfiles/configurationProfileName";
|
||||
|
||||
client
|
||||
.configurationProfileAssignments()
|
||||
.define("default") // name must be default
|
||||
.withExistingVirtualMachine("resourceGroup", "vmName")
|
||||
.withProperties(
|
||||
new ConfigurationProfileAssignmentProperties()
|
||||
.withConfigurationProfile("configurationProfileName"))
|
||||
.create();
|
||||
```
|
||||
|
||||
### Get Profile Assignment
|
||||
|
||||
```java
|
||||
ConfigurationProfileAssignment assignment = client.configurationProfileAssignments().get("resourceGroup", "default", "vmName"); // name must be default
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
|
|
@ -180,21 +88,27 @@ ConfigurationProfileAssignment assignment = client.configurationProfileAssignmen
|
|||
|
||||
## Contributing
|
||||
|
||||
For details on contributing to this repository, see the [contributing guide](https://github.com/Azure/azure-sdk-for-java/blob/azure-resourcemanager-automanage_1.0.0-beta.1/CONTRIBUTING.md).
|
||||
For details on contributing to this repository, see the [contributing guide][cg].
|
||||
|
||||
1. Fork it
|
||||
1. Create your feature branch (`git checkout -b my-new-feature`)
|
||||
1. Commit your changes (`git commit -am 'Add some feature'`)
|
||||
1. Push to the branch (`git push origin my-new-feature`)
|
||||
1. Create new Pull Request
|
||||
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit <https://cla.microsoft.com>.
|
||||
|
||||
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repositories using our CLA.
|
||||
|
||||
This project has adopted the [Microsoft Open Source Code of Conduct][coc]. For more information see the [Code of Conduct FAQ][coc_faq] or contact <opencode@microsoft.com> with any additional questions or comments.
|
||||
|
||||
<!-- LINKS -->
|
||||
[survey]: https://microsoft.qualtrics.com/jfe/form/SV_ehN0lIk2FKEBkwd?Q_CHL=DOCS
|
||||
[docs]: https://azure.github.io/azure-sdk-for-java/
|
||||
[jdk]: /java/azure/jdk/
|
||||
[jdk]: https://learn.microsoft.com/azure/developer/java/fundamentals/
|
||||
[azure_subscription]: https://azure.microsoft.com/free/
|
||||
[azure_identity]: https://github.com/Azure/azure-sdk-for-java/blob/azure-resourcemanager-automanage_1.0.0-beta.1/sdk/identity/azure-identity
|
||||
[azure_core_http_netty]: https://github.com/Azure/azure-sdk-for-java/blob/azure-resourcemanager-automanage_1.0.0-beta.1/sdk/core/azure-core-http-netty
|
||||
[authenticate]: https://github.com/Azure/azure-sdk-for-java/blob/azure-resourcemanager-automanage_1.0.0-beta.1/sdk/resourcemanager/docs/AUTH.md
|
||||
[design]: https://github.com/Azure/azure-sdk-for-java/blob/azure-resourcemanager-automanage_1.0.0-beta.1/sdk/resourcemanager/docs/DESIGN.md
|
||||
[azure_identity]: https://github.com/Azure/azure-sdk-for-java/blob/azure-resourcemanager-automanage_1.0.0-beta.2/sdk/identity/azure-identity
|
||||
[azure_identity_credentials]: https://github.com/Azure/azure-sdk-for-java/tree/azure-resourcemanager-automanage_1.0.0-beta.2/sdk/identity/azure-identity#credentials
|
||||
[azure_core_http_netty]: https://github.com/Azure/azure-sdk-for-java/blob/azure-resourcemanager-automanage_1.0.0-beta.2/sdk/core/azure-core-http-netty
|
||||
[authenticate]: https://github.com/Azure/azure-sdk-for-java/blob/azure-resourcemanager-automanage_1.0.0-beta.2/sdk/resourcemanager/docs/AUTH.md
|
||||
[design]: https://github.com/Azure/azure-sdk-for-java/blob/azure-resourcemanager-automanage_1.0.0-beta.2/sdk/resourcemanager/docs/DESIGN.md
|
||||
[cg]: https://github.com/Azure/azure-sdk-for-java/blob/azure-resourcemanager-automanage_1.0.0-beta.2/CONTRIBUTING.md
|
||||
[coc]: https://opensource.microsoft.com/codeofconduct/
|
||||
[coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"Name": "azure-resourcemanager-automanage",
|
||||
"Version": "1.0.0-beta.1",
|
||||
"Version": "1.0.0-beta.2",
|
||||
"DevVersion": null,
|
||||
"DirectoryPath": "sdk/automanage/azure-resourcemanager-automanage",
|
||||
"ServiceDirectory": "automanage",
|
||||
|
|
@ -10,7 +10,9 @@
|
|||
"SdkType": "mgmt",
|
||||
"IsNewSdk": true,
|
||||
"ArtifactName": "azure-resourcemanager-automanage",
|
||||
"ReleaseStatus": "2022-08-09",
|
||||
"ReleaseStatus": "2024-10-10",
|
||||
"IncludedForValidation": false,
|
||||
"AdditionalValidationPackages": null,
|
||||
"Namespaces": [
|
||||
"com.azure.resourcemanager.automanage",
|
||||
"com.azure.resourcemanager.automanage.fluent",
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче