Skip to content

Latest commit

 

History

History
154 lines (108 loc) · 3.76 KB

azure-service-bus.md

File metadata and controls

154 lines (108 loc) · 3.76 KB
Raw

Azure Service Bus Service

Azure Service Bus keep apps and devices connected across private and public clouds. This broker currently publishes a single service and plan for provisioning Azure Service Bus Service.

Create an Azure service bus service

  1. Get the service name and plans
cf marketplace

Sample output:

service                       plans                     description
azureservicebus               default                   Azure Service Bus Service

If you can not find the service name, please use the following command to make the plans public.

cf enable-service-access azureservicebus
  1. Create a service instance
cf create-service azureservicebus $service_plan $service_instance_name

For example:

cf create-service azureservicebus default myservicebus

Additional configuration parameters are supported with the provision request. These parameters are passed in a valid JSON object containing configuration parameters, provided either in-line or in a file. If these parameters are not provided, the broker will create the resources according to Naming Conventions.

cf create-service azureservicebus $service_plan $service_instance_name -c $path_to_parameters

Supported configuration parameters:

{
  "resource_group_name": "<resource-group-name>",
  "namespace_name": "<namespace-name>",
  "location": "<location>",
  "type": "<type>",
  "messaging_tier": "<messaging-tier>"
}
  • type: Possible values are Messaging, EventHub and NotificationHub.
  • messaging-tier: Possible values are Standard.

For example:

cf create-service azureservicebus default myservicebus -c /tmp/config.json

{
  "resource_group_name": "myResourceGroup",
  "namespace_name": "myservicebus",
  "location": "eastus",
  "type": "Messaging",
  "messaging_tier": "Standard"
}
  1. Check the operation status of creating the service instance

The creating operation is asynchronous. You can get the operation status after the creating operation.

cf service $service_instance_name

For example:

cf service myservicebus

More information.

Using the services in your application

Binding

cf bind-service $app_name $service_instance_name

For example:

cf bind-service demoapp myservicebus

Format of Credentials

Verify that the credentials are set as environment variables

cf env $app_name

The credentials have the following format:

"credentials": {
  "namespace_name": "cf-2eac2d52-bfc9-4d0f-af28-c02187689d72",
  "key_name": "KEY-NAME",
  "key_value": "KEY-VALUE",
}

Unbinding

cf unbind-service $app_name $service_instance_name

For example:

cf unbind-service demoapp myservicebus

Delete the service instance

cf delete-service $service_instance_name -f

For example:

cf delete-service myservicebus -f
## Naming Conventions

The following names are used and can be customized with a prefix:

Resource Name is based on Custom Prefix Environment Variable Default Prefix Example Name
Azure Resource Group service instance ID RESOURCE_GROUP_NAME_PREFIX cloud-foundry- cloud-foundry-2eac2d52-bfc9-4d0f-af28-c02187689d72
Azure Namespace service instance ID NAMESPACE_NAME_PREFIX cf cf2eac2d52-bfc9-4d0f-af28-c02187689d72