Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jlucaspains/azdiff

A .NET CLI tool for deep Azure resource comparison.
https://github.com/jlucaspains/azdiff

azure devops dotnet

Last synced: 2 months ago
JSON representation

A .NET CLI tool for deep Azure resource comparison.

Host: GitHub
URL: https://github.com/jlucaspains/azdiff
Owner: jlucaspains
License: mit
Created: 2023-11-30T23:34:50.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-10-25T00:28:14.000Z (3 months ago)
Last Synced: 2024-10-26T13:15:12.153Z (3 months ago)
Topics: azure, devops, dotnet
Language: C#
Homepage:
Size: 64.5 KB
Stars: 4
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING
- License: LICENSE

Awesome Lists containing this project

README

# azdiff
`azdiff` is a command-line tool designed to perform deep comparisons between Azure resources.

## Installation
```powershell
dotnet tool install --global lpains.azdiff --prerelease
```

## General usage
Upon installation, access the tool by executing `azdiff` in your terminal. For specific command details, refer to the sections below or utilize the CLI help via `azdiff -h`.

The commands provided typically require a source and a target, generating a distinct `.diff` file for each identified and compared resource.

## azdiff arm
Facilitates the comparison between two ARM template files, analyzing Azure resources present in each file and generating one `.diff` file per resource illustrating the differences between the source and target resources.

```powershell
azdiff arm --sourceFile
--targetFile
[--outputFolder]
[--ignoreType]
[--replaceStringsFile]
[-?, -h, --help]
```

### Examples
Basic usage:
```powershell
azdiff arm --sourceFile .\source.json `
--targetFile .\target.json
```

Advanced usage:
```powershell
azdiff arm --sourceFile .\source.json `
--targetFile .\target.json `
--ignoreType "Microsoft.Web/staticSites/customDomains" `
--ignoreType "Microsoft.Web/staticSites/databaseConnections" `
--replaceStringsFile .\replaceStrings.json
```

Output file (diff_stapp-blog-centralus-001.diff):
```diff
{
"type": "Microsoft.Web/staticSites",
"apiVersion": "2023-01-01",
"name": "stapp-blog-centralus-001",
"location": "Central US",
"sku": {
"name": "Free",
"tier": "Free"
},
"properties": {
"repositoryUrl": "https://github.com/jlucaspains/blog-v2",
- "branch": "v1",
+ "branch": "release/v1",
"stagingEnvironmentPolicy": "Enabled",
"allowConfigFileUpdates": true,
"provider": "GitHub",
"enterpriseGradeCdnStatus": "Disabled"
}
}

```

### Parameters
#### `--sourceFile` (required)

The comparison source json file. It should be an exported ARM template.

#### `--targetFile` (required)

The comparison target json file. It should be an exported ARM template.

#### `--outputFolder`

The folder path for output. Defaults to `diffs`.

#### `--ignoreType`

A list of types to ignore in the ARM comparison. You may use this option multiple times.

#### `--replaceStringsFile`

JSON file containing replacement strings. Example:

```json
[
{
"target": "Name",
"input": "DEV",
"replacement": "env"
}
]
```

The `target` property indicates whether the name (target: Name) property or the whole file (target: Body) will apply replacements. This is particularly useful when dealing with environment comparison (e.g.: DEV vs TEST) where the resource names or parts of its json will differ in a predictable way.

## azdiff rg
Facilitates the comparison between two Azure Resource Groups, analyzing Azure resources present in each resource group and generating one `.diff` file per resource illustrating the differences between the source and target resources.

```powershell
azdiff rg --sourceResourceGroupId
--targetResourceGroupId
[--outputFolder]
[--ignoreType]
[--replaceStringsFile]
[--authenticationMethod]
[-?, -h, --help]
```

### Azure Authentication
The `azdiff rg` uses the DefaultAzureCredential credential provider to authenticate with Azure. It will try a series of authentication methods and use the first successful one or an interactive session if none of the methods succeed.

For more information, see [Authenticate with Azure libraries for .NET](https://learn.microsoft.com/en-us/dotnet/api/overview/azure/identity-readme?view=azure-dotnet).

### Examples
Basic usage:
```powershell
azdiff rg --sourceResourceGroupId /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-dev-001 `
--targetResourceGroupId /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-test-001
```

Advanced usage:
```powershell
azdiff rg --sourceResourceGroupId /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-dev-001 `
--targetResourceGroupId /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-test-001 `
--ignoreType "Microsoft.Web/staticSites/customDomains" `
--ignoreType "Microsoft.Web/staticSites/databaseConnections" `
--replaceStringsFile .\replaceStrings.json
```

```

### Parameters
#### `--sourceResourceGroupId` (required)

The comparison source resource group id.

#### `--targetResourceGroupId` (required)

The comparison target resource group id.

#### `--outputFolder`
The folder path for output. Defaults to `diffs`.

#### `--ignoreType`
A list of types to ignore in the ARM comparison. You may use this option zero to multiple times.

#### `--replaceStringsFile`
JSON file containing replacement strings. Example:

```json
[
{
"target": "Name",
"input": "DEV",
"replacement": "env"
}
]
```

#### `--authenticationMethod`
Authentication method for connecting to Azure Resource Manager. Default value is DefaultAzureCredential.

Valid options are:
1. [DefaultAzureCredential](https://learn.microsoft.com/en-us/dotnet/api/azure.identity.DefaultAzureCredential?view=azure-dotnet)
2. [EnvironmentCredential](https://learn.microsoft.com/en-us/dotnet/api/azure.identity.EnvironmentCredential?view=azure-dotnet)
3. [WorkloadIdentityCredential](https://learn.microsoft.com/en-us/dotnet/api/azure.identity.WorkloadIdentityCredential?view=azure-dotnet)
4. [ManagedIdentityCredential](https://learn.microsoft.com/en-us/dotnet/api/azure.identity.ManagedIdentityCredential?view=azure-dotnet)
5. [SharedTokenCacheCredential](https://learn.microsoft.com/en-us/dotnet/api/azure.identity.SharedTokenCacheCredential?view=azure-dotnet)
6. [VisualStudioCredential](https://learn.microsoft.com/en-us/dotnet/api/azure.identity.VisualStudioCredential?view=azure-dotnet)
7. [VisualStudioCodeCredential](https://learn.microsoft.com/en-us/dotnet/api/azure.identity.VisualStudioCodeCredential?view=azure-dotnet)
8. [AzureCliCredential](https://learn.microsoft.com/en-us/dotnet/api/azure.identity.AzureCliCredential?view=azure-dotnet)
9. [AzurePowerShellCredential](https://learn.microsoft.com/en-us/dotnet/api/azure.identity.AzurePowerShellCredential?view=azure-dotnet)
10. [AzureDeveloperCliCredential](https://learn.microsoft.com/en-us/dotnet/api/azure.identity.AzureDeveloperCliCredential?view=azure-dotnet)
11. [InteractiveBrowserCredential](https://learn.microsoft.com/en-us/dotnet/api/azure.identity.InteractiveBrowserCredential?view=azure-dotnet)