https://github.com/defra/ffc-azure-service-bus-scripts
Scripts to support Service Bus administration
https://github.com/defra/ffc-azure-service-bus-scripts
Last synced: 3 months ago
JSON representation
Scripts to support Service Bus administration
- Host: GitHub
- URL: https://github.com/defra/ffc-azure-service-bus-scripts
- Owner: DEFRA
- License: other
- Created: 2022-01-12T13:15:50.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-19T15:10:08.000Z (over 1 year ago)
- Last Synced: 2025-03-02T06:28:21.722Z (over 1 year ago)
- Size: 88.9 KB
- Stars: 2
- Watchers: 9
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Azure Service Bus Scripts
Scripts to support Azure Service Bus administration
## Prerequisites
- [Azure CLI](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli)
- [yq](https://github.com/mikefarah/yq) for creating full service entities
- user has already signed into target Azure tenant and subscription
- user has sufficient permissions to manage Azure Service Bus entities
### How to sign in to a specific tenant and subscription
1. Using Azure CLI, run `az login` specifying the target tenant name
`az login --tenant .onmicrosoft.com`
1. Run `az account set` specifying the target subscription name
`az account set --subscription `
1. The scripts require the target Service Bus namespace and the Resource Group it is in. The namespace name and resource group name can be found in the Azure Portal.
All scripts include a help section that can be viewed by passing the `-h` or `--help` argument to the script.
## Services
Create or delete all Azure Service Bus entities for a service.
A service must have created a `.yaml` configuration file in `services/config`.
Example `.yaml`:
```yaml
topics:
- name: ffc-demo-payment
subscriptions:
- ffc-demo-payment-payment
- ffc-demo-payment-payment-core
- name: ffc-demo-schedule
subscriptions:
- ffc-demo-schedule-payment
- ffc-demo-schedule-payment-core
queues:
- name: ffc-demo-claim
- name: ffc-demo-calculation
```
For session enabled queues, the `sessions: true` property can be included.
Example:
```yaml
queues:
- name: ffc-demo-claim
sessions: true
```
### [Create](services/create)
#### Arguments
- `-g`, `--resource-group` - Service Bus Resource Group
- `-n`, `--namespace-name` - Service Bus Namespace
- `-s`, `--service` - service name
- `-d`, `--developer` - suffix to be appended to each entity (optional)
- `-x`, `--no-developer-subscriptions` - do not apply suffix to subscriptions (optional)
- `-h`, `--help`
Example:
`./services/create -s ffc-demo -n myNamespace -g myResourceGroup`
Example with developer suffix:
`./services/create -s ffc-demo -n myNamespace -g myResourceGroup -d jw`
Example with environment suffix for Topic but not Subscription:
`./services/create -s ffc-demo -n myNamespace -g myResourceGroup -d snd -x`
### [Delete](services/delete)
#### Arguments
- `-g`, `--resource-group` - Service Bus Resource Group
- `-n`, `--namespace-name` - Service Bus Namespace
- `-s`, `--service` - service name
- `-d`, `--developer` - suffix to be appended to each entity (optional)
- `-h`, `--help`
Example:
`./services/delete -s ffc-demo -n myNamespace -g myResourceGroup`
Example with developer suffix:
`./services/delete -s ffc-demo -n myNamespace -g myResourceGroup -d jw`
## Queues
### [List](queues/list)
List all queues.
#### Arguments
- `-g`, `--resource-group` - Service Bus Resource Group
- `-n`, `--namespace-name` - Service Bus Namespace
- `-h`, `--help`
Example:
`./queues/list -n myNamespace -g myResourceGroup`
### [Create](queues/create)
Bulk create queues from file.
Example file content:
```
test-entity1
test-entity2
```
#### Arguments
- `-g`, `--resource-group` - Service Bus Resource Group
- `-n`, `--namespace-name` - Service Bus Namespace
- `-f`, `--file` - filename containing entity names
- `-h`, `--help`
Example:
`./queues/create -n myNamespace -g myResourceGroup -f example.txt`
### [Delete](queues/delete)
Bulk delete queues from file.
Example file content:
```
test-entity1
test-entity2
```
#### Arguments
- `-g`, `--resource-group` - Service Bus Resource Group
- `-n`, `--namespace-name` - Service Bus Namespace
- `-f`, `--file` - filename containing entity names
- `-h`, `--help`
Example:
`./queues/delete -n myNamespace -g myResourceGroup -f example.txt`
## Topics
### [List](topics/list)
List all topics.
#### Arguments
- `-g`, `--resource-group` - Service Bus Resource Group
- `-n`, `--namespace-name` - Service Bus Namespace
- `-h`, `--help`
Example:
`./topics/list -n myNamespace -g myResourceGroup`
### [Create](topics/create)
Bulk create topics from file.
Example file content:
```
test-entity1
test-entity2
```
#### Arguments
- `-g`, `--resource-group` - Service Bus Resource Group
- `-n`, `--namespace-name` - Service Bus Namespace
- `-f`, `--file` - filename containing entity names
- `-h`, `--help`
Example:
`./topics/create -n myNamespace -g myResourceGroup -f example.txt`
### [Delete](topics/delete)
Bulk delete from file.
Example file content:
```
test-entity1
test-entity2
```
#### Arguments
- `-g`, `--resource-group` - Service Bus Resource Group
- `-n`, `--namespace-name` - Service Bus Namespace
- `-f`, `--file` - filename containing entity names
- `-h`, `--help`
Example:
`./topics/delete -n myNamespace -g myResourceGroup -f example.txt`