Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion sdk/devspaces/azure-resourcemanager-devspaces/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# Release History

## 1.0.0-beta.2 (Unreleased)
## 1.0.0-beta.1 (2023-01-16)

- Azure Resource Manager DevSpaces client library for Java. This package contains Microsoft Azure SDK for DevSpaces Management SDK. Dev Spaces Client. Package tag package-2019-04-01. For documentation on how to use this package, please see [Azure Management Libraries for Java](https://aka.ms/azsdk/java/mgmt).

## 1.0.0-beta.1 (2021-04-15)

Expand Down
28 changes: 17 additions & 11 deletions sdk/devspaces/azure-resourcemanager-devspaces/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Various documentation is available to help you get started
<dependency>
<groupId>com.azure.resourcemanager</groupId>
<artifactId>azure-resourcemanager-devspaces</artifactId>
<version>1.0.0-beta.1</version>
<version>1.0.0-beta.2</version>
</dependency>
```
[//]: # ({x-version-update-end})
Expand All @@ -41,19 +41,19 @@ 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.
By default, Azure Active Directory token authentication depends on correct configuration of the following environment variables.

- `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.

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

With above configuration, `azure` client can be authenticated by following code:
With above configuration, `azure` client can be authenticated using the following code:

```java
AzureProfile profile = new AzureProfile(AzureEnvironment.AZURE);
Expand All @@ -74,19 +74,22 @@ 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/main/sdk/devspaces/azure-resourcemanager-devspaces/SAMPLE.md)


## Troubleshooting

## Next steps

## Contributing

For details on contributing to this repository, see the [contributing guide](https://github.com/Azure/azure-sdk-for-java/blob/main/CONTRIBUTING.md).
For details on contributing to this repository, see the [contributing guide][cg].

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.

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 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
Expand All @@ -97,3 +100,6 @@ For details on contributing to this repository, see the [contributing guide](htt
[azure_core_http_netty]: https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/core/azure-core-http-netty
[authenticate]: https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/resourcemanager/docs/AUTH.md
[design]: https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/resourcemanager/docs/DESIGN.md
[cg]: https://github.com/Azure/azure-sdk-for-java/blob/main/CONTRIBUTING.md
[coc]: https://opensource.microsoft.com/codeofconduct/
[coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/
244 changes: 244 additions & 0 deletions sdk/devspaces/azure-resourcemanager-devspaces/SAMPLE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,244 @@
# Code snippets and samples


## ContainerHostMappings

- [GetContainerHostMapping](#containerhostmappings_getcontainerhostmapping)

## Controllers

- [Create](#controllers_create)
- [Delete](#controllers_delete)
- [GetByResourceGroup](#controllers_getbyresourcegroup)
- [List](#controllers_list)
- [ListByResourceGroup](#controllers_listbyresourcegroup)
- [ListConnectionDetails](#controllers_listconnectiondetails)
- [Update](#controllers_update)
### ContainerHostMappings_GetContainerHostMapping

```java
import com.azure.resourcemanager.devspaces.fluent.models.ContainerHostMappingInner;

/** Samples for ContainerHostMappings GetContainerHostMapping. */
public final class ContainerHostMappingsGetContainerHostMappingSamples {
/*
* x-ms-original-file: specification/devspaces/resource-manager/Microsoft.DevSpaces/stable/2019-04-01/examples/ContainerHostMappingsGetContainerHostMapping_example.json
*/
/**
* Sample code: ContainerHostMappingsGetContainerHostMapping.
*
* @param manager Entry point to DevSpacesManager.
*/
public static void containerHostMappingsGetContainerHostMapping(
com.azure.resourcemanager.devspaces.DevSpacesManager manager) {
manager
.containerHostMappings()
.getContainerHostMappingWithResponse(
"myResourceGroup",
"eastus",
new ContainerHostMappingInner()
.withContainerHostResourceId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/managedClusters/myCluster"),
com.azure.core.util.Context.NONE);
}
}
```

### Controllers_Create

```java
import com.azure.resourcemanager.devspaces.models.Sku;
import com.azure.resourcemanager.devspaces.models.SkuName;
import com.azure.resourcemanager.devspaces.models.SkuTier;
import java.util.HashMap;
import java.util.Map;

/** Samples for Controllers Create. */
public final class ControllersCreateSamples {
/*
* x-ms-original-file: specification/devspaces/resource-manager/Microsoft.DevSpaces/stable/2019-04-01/examples/ControllersCreate_example.json
*/
/**
* Sample code: ControllersCreate.
*
* @param manager Entry point to DevSpacesManager.
*/
public static void controllersCreate(com.azure.resourcemanager.devspaces.DevSpacesManager manager) {
manager
.controllers()
.define("myControllerResource")
.withRegion("eastus")
.withExistingResourceGroup("myResourceGroup")
.withSku(new Sku().withName(SkuName.S1).withTier(SkuTier.STANDARD))
.withTargetContainerHostResourceId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/managedClusters/myCluster")
.withTargetContainerHostCredentialsBase64("QmFzZTY0IEVuY29kZWQgVmFsdWUK")
.withTags(mapOf())
.create();
}

@SuppressWarnings("unchecked")
private static <T> Map<String, T> mapOf(Object... inputs) {
Map<String, T> map = new HashMap<>();
for (int i = 0; i < inputs.length; i += 2) {
String key = (String) inputs[i];
T value = (T) inputs[i + 1];
map.put(key, value);
}
return map;
}
}
```

### Controllers_Delete

```java
/** Samples for Controllers Delete. */
public final class ControllersDeleteSamples {
/*
* x-ms-original-file: specification/devspaces/resource-manager/Microsoft.DevSpaces/stable/2019-04-01/examples/ControllersDelete_example.json
*/
/**
* Sample code: ControllersDelete.
*
* @param manager Entry point to DevSpacesManager.
*/
public static void controllersDelete(com.azure.resourcemanager.devspaces.DevSpacesManager manager) {
manager.controllers().delete("myResourceGroup", "myControllerResource", com.azure.core.util.Context.NONE);
}
}
```

### Controllers_GetByResourceGroup

```java
/** Samples for Controllers GetByResourceGroup. */
public final class ControllersGetByResourceGroupSamples {
/*
* x-ms-original-file: specification/devspaces/resource-manager/Microsoft.DevSpaces/stable/2019-04-01/examples/ControllersGet_example.json
*/
/**
* Sample code: ControllersGet.
*
* @param manager Entry point to DevSpacesManager.
*/
public static void controllersGet(com.azure.resourcemanager.devspaces.DevSpacesManager manager) {
manager
.controllers()
.getByResourceGroupWithResponse(
"myResourceGroup", "myControllerResource", com.azure.core.util.Context.NONE);
}
}
```

### Controllers_List

```java
/** Samples for Controllers List. */
public final class ControllersListSamples {
/*
* x-ms-original-file: specification/devspaces/resource-manager/Microsoft.DevSpaces/stable/2019-04-01/examples/ControllersList_example.json
*/
/**
* Sample code: ControllersList.
*
* @param manager Entry point to DevSpacesManager.
*/
public static void controllersList(com.azure.resourcemanager.devspaces.DevSpacesManager manager) {
manager.controllers().list(com.azure.core.util.Context.NONE);
}
}
```

### Controllers_ListByResourceGroup

```java
/** Samples for Controllers ListByResourceGroup. */
public final class ControllersListByResourceGroupSamples {
/*
* x-ms-original-file: specification/devspaces/resource-manager/Microsoft.DevSpaces/stable/2019-04-01/examples/ControllersListByResourceGroup_example.json
*/
/**
* Sample code: ControllersListByResourceGroup.
*
* @param manager Entry point to DevSpacesManager.
*/
public static void controllersListByResourceGroup(com.azure.resourcemanager.devspaces.DevSpacesManager manager) {
manager.controllers().listByResourceGroup("myResourceGroup", com.azure.core.util.Context.NONE);
}
}
```

### Controllers_ListConnectionDetails

```java
import com.azure.resourcemanager.devspaces.models.ListConnectionDetailsParameters;

/** Samples for Controllers ListConnectionDetails. */
public final class ControllersListConnectionDetailsSamples {
/*
* x-ms-original-file: specification/devspaces/resource-manager/Microsoft.DevSpaces/stable/2019-04-01/examples/ControllersListConnectionDetails_example.json
*/
/**
* Sample code: ControllersListConnectionDetails.
*
* @param manager Entry point to DevSpacesManager.
*/
public static void controllersListConnectionDetails(com.azure.resourcemanager.devspaces.DevSpacesManager manager) {
manager
.controllers()
.listConnectionDetailsWithResponse(
"myResourceGroup",
"myControllerResource",
new ListConnectionDetailsParameters()
.withTargetContainerHostResourceId(
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/managedClusters/myCluster"),
com.azure.core.util.Context.NONE);
}
}
```

### Controllers_Update

```java
import com.azure.resourcemanager.devspaces.models.Controller;
import java.util.HashMap;
import java.util.Map;

/** Samples for Controllers Update. */
public final class ControllersUpdateSamples {
/*
* x-ms-original-file: specification/devspaces/resource-manager/Microsoft.DevSpaces/stable/2019-04-01/examples/ControllersUpdate_example.json
*/
/**
* Sample code: ControllersUpdate.
*
* @param manager Entry point to DevSpacesManager.
*/
public static void controllersUpdate(com.azure.resourcemanager.devspaces.DevSpacesManager manager) {
Controller resource =
manager
.controllers()
.getByResourceGroupWithResponse(
"myResourceGroup", "myControllerResource", com.azure.core.util.Context.NONE)
.getValue();
resource
.update()
.withTags(mapOf("key", "value"))
.withTargetContainerHostCredentialsBase64("QmFzZTY0IEVuY29kZWQgVmFsdWUK")
.apply();
}

@SuppressWarnings("unchecked")
private static <T> Map<String, T> mapOf(Object... inputs) {
Map<String, T> map = new HashMap<>();
for (int i = 0; i < inputs.length; i += 2) {
String key = (String) inputs[i];
T value = (T) inputs[i + 1];
map.put(key, value);
}
return map;
}
}
```

Loading