forked from Azure/azure-sdk-for-java
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
CodeGen from PR 16902 in Azure/azure-rest-api-specs
Track2 modify readme.go.md 4 (Azure#16902) * Track2 modify readme.go.md 4 * devops
- Loading branch information
SDKAuto
committed
Nov 30, 2021
1 parent
8474a1d
commit 8c3038c
Showing
65 changed files
with
6,988 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# Release History | ||
|
||
## 1.0.0-beta.1 (2021-11-30) | ||
|
||
- Azure Resource Manager devops client library for Java. This package contains Microsoft Azure SDK for devops Management SDK. Azure DevOps Resource Provider. Package tag package-2019-07-01-preview. For documentation on how to use this package, please see [Azure Management Libraries for Java](https://aka.ms/azsdk/java/mgmt). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,102 @@ | ||
# Azure Resource Manager devops client library for Java | ||
|
||
Azure Resource Manager devops client library for Java. | ||
|
||
This package contains Microsoft Azure SDK for devops Management SDK. Azure DevOps Resource Provider. Package tag package-2019-07-01-preview. For documentation on how to use this package, please see [Azure Management Libraries for Java](https://aka.ms/azsdk/java/mgmt). | ||
|
||
## We'd love to hear your feedback | ||
|
||
We're always working on improving our products and the way we communicate with our users. So we'd love to learn what's working and how we can do better. | ||
|
||
If you haven't already, please take a few minutes to [complete this short survey][survey] we have put together. | ||
|
||
Thank you in advance for your collaboration. We really appreciate your time! | ||
|
||
## Documentation | ||
|
||
Various documentation is available to help you get started | ||
|
||
- [API reference documentation][docs] | ||
|
||
## Getting started | ||
|
||
### Prerequisites | ||
|
||
- [Java Development Kit (JDK)][jdk] with version 8 or above | ||
- [Azure Subscription][azure_subscription] | ||
|
||
### Adding the package to your product | ||
|
||
[//]: # ({x-version-update-start;com.azure.resourcemanager:azure-resourcemanager-devops;current}) | ||
```xml | ||
<dependency> | ||
<groupId>com.azure.resourcemanager</groupId> | ||
<artifactId>azure-resourcemanager-devops</artifactId> | ||
<version>1.0.0-beta.1</version> | ||
</dependency> | ||
``` | ||
[//]: # ({x-version-update-end}) | ||
|
||
### Include the recommended packages | ||
|
||
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. | ||
|
||
### Authentication | ||
|
||
By default, Azure Active Directory token authentication depends on correct configure of 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`. | ||
|
||
With above configuration, `azure` client can be authenticated by following code: | ||
|
||
```java | ||
AzureProfile profile = new AzureProfile(AzureEnvironment.AZURE); | ||
TokenCredential credential = new DefaultAzureCredentialBuilder() | ||
.authorityHost(profile.getEnvironment().getActiveDirectoryEndpoint()) | ||
.build(); | ||
DevopsManager manager = DevopsManager | ||
.authenticate(credential, profile); | ||
``` | ||
|
||
The sample code assumes global Azure. Please change `AzureEnvironment.AZURE` variable if otherwise. | ||
|
||
See [Authentication][authenticate] for more options. | ||
|
||
## Key concepts | ||
|
||
See [API design][design] for general introduction on design and key concepts on Azure Management Libraries. | ||
|
||
## Examples | ||
|
||
[Code snippets and samples](https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/devops/azure-resourcemanager-devops/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). | ||
|
||
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 | ||
|
||
<!-- LINKS --> | ||
[survey]: https://microsoft.qualtrics.com/jfe/form/SV_ehN0lIk2FKEBkwd?Q_CHL=DOCS | ||
[docs]: https://azure.github.io/azure-sdk-for-java/ | ||
[jdk]: https://docs.microsoft.com/java/azure/jdk/ | ||
[azure_subscription]: https://azure.microsoft.com/free/ | ||
[azure_identity]: https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/identity/azure-identity | ||
[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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,257 @@ | ||
# Code snippets and samples | ||
|
||
|
||
## Operations | ||
|
||
- [List](#operations_list) | ||
|
||
## PipelineTemplateDefinitions | ||
|
||
- [List](#pipelinetemplatedefinitions_list) | ||
|
||
## Pipelines | ||
|
||
- [CreateOrUpdate](#pipelines_createorupdate) | ||
- [Delete](#pipelines_delete) | ||
- [GetByResourceGroup](#pipelines_getbyresourcegroup) | ||
- [List](#pipelines_list) | ||
- [ListByResourceGroup](#pipelines_listbyresourcegroup) | ||
- [Update](#pipelines_update) | ||
### Operations_List | ||
|
||
```java | ||
import com.azure.core.util.Context; | ||
|
||
/** Samples for Operations List. */ | ||
public final class OperationsListSamples { | ||
/* | ||
* x-ms-original-file: specification/devops/resource-manager/Microsoft.DevOps/preview/2019-07-01-preview/examples/ListOperations.json | ||
*/ | ||
/** | ||
* Sample code: Get a list of operations supported by Microsoft.DevOps resource provider. | ||
* | ||
* @param manager Entry point to DevopsManager. | ||
*/ | ||
public static void getAListOfOperationsSupportedByMicrosoftDevOpsResourceProvider( | ||
com.azure.resourcemanager.devops.DevopsManager manager) { | ||
manager.operations().list(Context.NONE); | ||
} | ||
} | ||
``` | ||
|
||
### PipelineTemplateDefinitions_List | ||
|
||
```java | ||
import com.azure.core.util.Context; | ||
|
||
/** Samples for PipelineTemplateDefinitions List. */ | ||
public final class PipelineTemplateDefinitionsListSamples { | ||
/* | ||
* x-ms-original-file: specification/devops/resource-manager/Microsoft.DevOps/preview/2019-07-01-preview/examples/ListPipelineTemplateDefinitions.json | ||
*/ | ||
/** | ||
* Sample code: Get the list of pipeline template definitions. | ||
* | ||
* @param manager Entry point to DevopsManager. | ||
*/ | ||
public static void getTheListOfPipelineTemplateDefinitions(com.azure.resourcemanager.devops.DevopsManager manager) { | ||
manager.pipelineTemplateDefinitions().list(Context.NONE); | ||
} | ||
} | ||
``` | ||
|
||
### Pipelines_CreateOrUpdate | ||
|
||
```java | ||
import com.azure.resourcemanager.devops.models.BootstrapConfiguration; | ||
import com.azure.resourcemanager.devops.models.OrganizationReference; | ||
import com.azure.resourcemanager.devops.models.PipelineTemplate; | ||
import com.azure.resourcemanager.devops.models.ProjectReference; | ||
import java.util.HashMap; | ||
import java.util.Map; | ||
|
||
/** Samples for Pipelines CreateOrUpdate. */ | ||
public final class PipelinesCreateOrUpdateSamples { | ||
/* | ||
* x-ms-original-file: specification/devops/resource-manager/Microsoft.DevOps/preview/2019-07-01-preview/examples/CreateAzurePipeline-Sample-AspNet-WindowsWebApp.json | ||
*/ | ||
/** | ||
* Sample code: Create an Azure pipeline to deploy a sample ASP.Net application to Azure web-app. | ||
* | ||
* @param manager Entry point to DevopsManager. | ||
*/ | ||
public static void createAnAzurePipelineToDeployASampleASPNetApplicationToAzureWebApp( | ||
com.azure.resourcemanager.devops.DevopsManager manager) { | ||
manager | ||
.pipelines() | ||
.define("myAspNetWebAppPipeline") | ||
.withRegion("South India") | ||
.withExistingResourceGroup("myAspNetWebAppPipeline-rg") | ||
.withOrganization(new OrganizationReference().withName("myAspNetWebAppPipeline-org")) | ||
.withProject(new ProjectReference().withName("myAspNetWebAppPipeline-project")) | ||
.withBootstrapConfiguration( | ||
new BootstrapConfiguration() | ||
.withTemplate( | ||
new PipelineTemplate() | ||
.withId("ms.vss-continuous-delivery-pipeline-templates.aspnet-windowswebapp") | ||
.withParameters( | ||
mapOf( | ||
"appInsightLocation", | ||
"South India", | ||
"appServicePlan", | ||
"S1 Standard", | ||
"azureAuth", | ||
"{\"scheme\":\"ServicePrincipal\",\"parameters\":{\"tenantid\":\"{subscriptionTenantId}\",\"objectid\":\"{appObjectId}\",\"serviceprincipalid\":\"{appId}\",\"serviceprincipalkey\":\"{appSecret}\"}}", | ||
"location", | ||
"South India", | ||
"resourceGroup", | ||
"myAspNetWebAppPipeline-rg", | ||
"subscriptionId", | ||
"{subscriptionId}", | ||
"webAppName", | ||
"myAspNetWebApp")))) | ||
.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; | ||
} | ||
} | ||
``` | ||
|
||
### Pipelines_Delete | ||
|
||
```java | ||
import com.azure.core.util.Context; | ||
|
||
/** Samples for Pipelines Delete. */ | ||
public final class PipelinesDeleteSamples { | ||
/* | ||
* x-ms-original-file: specification/devops/resource-manager/Microsoft.DevOps/preview/2019-07-01-preview/examples/DeleteAzurePipeline.json | ||
*/ | ||
/** | ||
* Sample code: Get an existing Azure pipeline. | ||
* | ||
* @param manager Entry point to DevopsManager. | ||
*/ | ||
public static void getAnExistingAzurePipeline(com.azure.resourcemanager.devops.DevopsManager manager) { | ||
manager.pipelines().deleteWithResponse("myAspNetWebAppPipeline-rg", "myAspNetWebAppPipeline", Context.NONE); | ||
} | ||
} | ||
``` | ||
|
||
### Pipelines_GetByResourceGroup | ||
|
||
```java | ||
import com.azure.core.util.Context; | ||
|
||
/** Samples for Pipelines GetByResourceGroup. */ | ||
public final class PipelinesGetByResourceGroupSamples { | ||
/* | ||
* x-ms-original-file: specification/devops/resource-manager/Microsoft.DevOps/preview/2019-07-01-preview/examples/GetAzurePipeline.json | ||
*/ | ||
/** | ||
* Sample code: Get an existing Azure pipeline. | ||
* | ||
* @param manager Entry point to DevopsManager. | ||
*/ | ||
public static void getAnExistingAzurePipeline(com.azure.resourcemanager.devops.DevopsManager manager) { | ||
manager | ||
.pipelines() | ||
.getByResourceGroupWithResponse("myAspNetWebAppPipeline-rg", "myAspNetWebAppPipeline", Context.NONE); | ||
} | ||
} | ||
``` | ||
|
||
### Pipelines_List | ||
|
||
```java | ||
import com.azure.core.util.Context; | ||
|
||
/** Samples for Pipelines List. */ | ||
public final class PipelinesListSamples { | ||
/* | ||
* x-ms-original-file: specification/devops/resource-manager/Microsoft.DevOps/preview/2019-07-01-preview/examples/ListAzurePipelinesBySubscription.json | ||
*/ | ||
/** | ||
* Sample code: List all Azure pipelines under the specified subscription. | ||
* | ||
* @param manager Entry point to DevopsManager. | ||
*/ | ||
public static void listAllAzurePipelinesUnderTheSpecifiedSubscription( | ||
com.azure.resourcemanager.devops.DevopsManager manager) { | ||
manager.pipelines().list(Context.NONE); | ||
} | ||
} | ||
``` | ||
|
||
### Pipelines_ListByResourceGroup | ||
|
||
```java | ||
import com.azure.core.util.Context; | ||
|
||
/** Samples for Pipelines ListByResourceGroup. */ | ||
public final class PipelinesListByResourceGroupSamples { | ||
/* | ||
* x-ms-original-file: specification/devops/resource-manager/Microsoft.DevOps/preview/2019-07-01-preview/examples/ListAzurePipelinesByResourceGroup.json | ||
*/ | ||
/** | ||
* Sample code: List all Azure Pipelines under the specified resource group. | ||
* | ||
* @param manager Entry point to DevopsManager. | ||
*/ | ||
public static void listAllAzurePipelinesUnderTheSpecifiedResourceGroup( | ||
com.azure.resourcemanager.devops.DevopsManager manager) { | ||
manager.pipelines().listByResourceGroup("myAspNetWebAppPipeline-rg", Context.NONE); | ||
} | ||
} | ||
``` | ||
|
||
### Pipelines_Update | ||
|
||
```java | ||
import com.azure.core.util.Context; | ||
import com.azure.resourcemanager.devops.models.Pipeline; | ||
import java.util.HashMap; | ||
import java.util.Map; | ||
|
||
/** Samples for Pipelines Update. */ | ||
public final class PipelinesUpdateSamples { | ||
/* | ||
* x-ms-original-file: specification/devops/resource-manager/Microsoft.DevOps/preview/2019-07-01-preview/examples/UpdateAzurePipeline.json | ||
*/ | ||
/** | ||
* Sample code: Get an existing Azure pipeline. | ||
* | ||
* @param manager Entry point to DevopsManager. | ||
*/ | ||
public static void getAnExistingAzurePipeline(com.azure.resourcemanager.devops.DevopsManager manager) { | ||
Pipeline resource = | ||
manager | ||
.pipelines() | ||
.getByResourceGroupWithResponse("myAspNetWebAppPipeline-rg", "myAspNetWebAppPipeline", Context.NONE) | ||
.getValue(); | ||
resource.update().withTags(mapOf("tagKey", "tagvalue")).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; | ||
} | ||
} | ||
``` | ||
|
Oops, something went wrong.