Share via

Microsoft.Web sites/hybridConnectionNamespaces/relays 2020-09-01

  • Article

Bicep resource definition

The sites/hybridConnectionNamespaces/relays resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Web/sites/hybridConnectionNamespaces/relays resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Web/sites/hybridConnectionNamespaces/relays@2020-09-01' = {
  kind: 'string'
  name: 'string'
  properties: {
    hostname: 'string'
    port: int
    relayArmUri: 'string'
    relayName: 'string'
    sendKeyName: 'string'
    sendKeyValue: 'string'
    serviceBusNamespace: 'string'
    serviceBusSuffix: 'string'
  }
}

Property values

HybridConnectionProperties

Name Description Value
hostname The hostname of the endpoint. string
port The port of the endpoint. int
relayArmUri The ARM URI to the Service Bus relay. string
relayName The name of the Service Bus relay. string
sendKeyName The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus. string
sendKeyValue The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned
normally, use the POST /listKeys API instead.		 string
serviceBusNamespace The name of the Service Bus namespace. string
serviceBusSuffix The suffix for the service bus endpoint. By default this is .servicebus.windows.net string

Microsoft.Web/sites/hybridConnectionNamespaces/relays

Name Description Value
kind Kind of resource. string
name The resource name string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: sites/hybridConnectionNamespaces
properties HybridConnection resource specific properties HybridConnectionProperties

ARM template resource definition

The sites/hybridConnectionNamespaces/relays resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Web/sites/hybridConnectionNamespaces/relays resource, add the following JSON to your template.

{
  "type": "Microsoft.Web/sites/hybridConnectionNamespaces/relays",
  "apiVersion": "2020-09-01",
  "name": "string",
  "kind": "string",
  "properties": {
    "hostname": "string",
    "port": "int",
    "relayArmUri": "string",
    "relayName": "string",
    "sendKeyName": "string",
    "sendKeyValue": "string",
    "serviceBusNamespace": "string",
    "serviceBusSuffix": "string"
  }
}

Property values

HybridConnectionProperties

Name Description Value
hostname The hostname of the endpoint. string
port The port of the endpoint. int
relayArmUri The ARM URI to the Service Bus relay. string
relayName The name of the Service Bus relay. string
sendKeyName The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus. string
sendKeyValue The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned
normally, use the POST /listKeys API instead.		 string
serviceBusNamespace The name of the Service Bus namespace. string
serviceBusSuffix The suffix for the service bus endpoint. By default this is .servicebus.windows.net string

Microsoft.Web/sites/hybridConnectionNamespaces/relays

Name Description Value
apiVersion The api version '2020-09-01'
kind Kind of resource. string
name The resource name string (required)
properties HybridConnection resource specific properties HybridConnectionProperties
type The resource type 'Microsoft.Web/sites/hybridConnectionNamespaces/relays'

Terraform (AzAPI provider) resource definition

The sites/hybridConnectionNamespaces/relays resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Web/sites/hybridConnectionNamespaces/relays resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/sites/hybridConnectionNamespaces/relays@2020-09-01"
  name = "string"
  kind = "string"
  body = jsonencode({
    properties = {
      hostname = "string"
      port = int
      relayArmUri = "string"
      relayName = "string"
      sendKeyName = "string"
      sendKeyValue = "string"
      serviceBusNamespace = "string"
      serviceBusSuffix = "string"
    }
  })
}

Property values

HybridConnectionProperties

Name Description Value
hostname The hostname of the endpoint. string
port The port of the endpoint. int
relayArmUri The ARM URI to the Service Bus relay. string
relayName The name of the Service Bus relay. string
sendKeyName The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus. string
sendKeyValue The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned
normally, use the POST /listKeys API instead.		 string
serviceBusNamespace The name of the Service Bus namespace. string
serviceBusSuffix The suffix for the service bus endpoint. By default this is .servicebus.windows.net string

Microsoft.Web/sites/hybridConnectionNamespaces/relays

Name Description Value
kind Kind of resource. string
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: sites/hybridConnectionNamespaces
properties HybridConnection resource specific properties HybridConnectionProperties
type The resource type "Microsoft.Web/sites/hybridConnectionNamespaces/relays@2020-09-01"