Microsoft.Blockchain blockchainMembers

Bicep resource definition

The blockchainMembers 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.Blockchain/blockchainMembers resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Blockchain/blockchainMembers@2018-06-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    name: 'string'
    tier: 'string'
  }
  properties: {
    consortium: 'string'
    consortiumManagementAccountPassword: 'string'
    consortiumMemberDisplayName: 'string'
    consortiumRole: 'string'
    firewallRules: [
      {
        endIpAddress: 'string'
        ruleName: 'string'
        startIpAddress: 'string'
      }
    ]
    password: 'string'
    protocol: 'string'
    validatorNodesSku: {
      capacity: int
    }
  }
}

Property values

blockchainMembers

Name Description Value
name The resource name string (required)

Character limit: 2-20

Valid characters:
Lowercase letters and numbers.

Start with lowercase letter.

Resource name must be unique across Azure.
location The GEO location of the blockchain service. string
tags Tags of the service which is a list of key value pairs that describes the resource. Dictionary of tag names and values. See Tags in templates
sku Gets or sets the blockchain member Sku. Sku
properties Gets or sets the blockchain member properties. BlockchainMemberProperties

BlockchainMemberProperties

Name Description Value
consortium Gets or sets the consortium for the blockchain member. string
consortiumManagementAccountPassword Sets the managed consortium management account password. string
consortiumMemberDisplayName Gets the display name of the member in the consortium. string
consortiumRole Gets the role of the member in the consortium. string
firewallRules Gets or sets firewall rules FirewallRule[]
password Sets the basic auth password of the blockchain member. string
protocol Gets or sets the blockchain protocol. 'Corda'
'NotSpecified'
'Parity'
'Quorum'
validatorNodesSku Gets or sets the blockchain validator nodes Sku. BlockchainMemberNodesSku

FirewallRule

Name Description Value
endIpAddress Gets or sets the end IP address of the firewall rule range. string
ruleName Gets or sets the name of the firewall rules. string
startIpAddress Gets or sets the start IP address of the firewall rule range. string

BlockchainMemberNodesSku

Name Description Value
capacity Gets or sets the nodes capacity. int

Sku

Name Description Value
name Gets or sets Sku name string
tier Gets or sets Sku tier string

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Blockchain Service

Deploy to Azure
This template deploys a Azure Blockchain Service, that currently provides support for the Ethereum Quorum ledger using the IBFT consensus mechanism.

ARM template resource definition

The blockchainMembers 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.Blockchain/blockchainMembers resource, add the following JSON to your template.

{
  "type": "Microsoft.Blockchain/blockchainMembers",
  "apiVersion": "2018-06-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "name": "string",
    "tier": "string"
  },
  "properties": {
    "consortium": "string",
    "consortiumManagementAccountPassword": "string",
    "consortiumMemberDisplayName": "string",
    "consortiumRole": "string",
    "firewallRules": [
      {
        "endIpAddress": "string",
        "ruleName": "string",
        "startIpAddress": "string"
      }
    ],
    "password": "string",
    "protocol": "string",
    "validatorNodesSku": {
      "capacity": "int"
    }
  }
}

Property values

blockchainMembers

Name Description Value
type The resource type 'Microsoft.Blockchain/blockchainMembers'
apiVersion The resource api version '2018-06-01-preview'
name The resource name string (required)

Character limit: 2-20

Valid characters:
Lowercase letters and numbers.

Start with lowercase letter.

Resource name must be unique across Azure.
location The GEO location of the blockchain service. string
tags Tags of the service which is a list of key value pairs that describes the resource. Dictionary of tag names and values. See Tags in templates
sku Gets or sets the blockchain member Sku. Sku
properties Gets or sets the blockchain member properties. BlockchainMemberProperties

BlockchainMemberProperties

Name Description Value
consortium Gets or sets the consortium for the blockchain member. string
consortiumManagementAccountPassword Sets the managed consortium management account password. string
consortiumMemberDisplayName Gets the display name of the member in the consortium. string
consortiumRole Gets the role of the member in the consortium. string
firewallRules Gets or sets firewall rules FirewallRule[]
password Sets the basic auth password of the blockchain member. string
protocol Gets or sets the blockchain protocol. 'Corda'
'NotSpecified'
'Parity'
'Quorum'
validatorNodesSku Gets or sets the blockchain validator nodes Sku. BlockchainMemberNodesSku

FirewallRule

Name Description Value
endIpAddress Gets or sets the end IP address of the firewall rule range. string
ruleName Gets or sets the name of the firewall rules. string
startIpAddress Gets or sets the start IP address of the firewall rule range. string

BlockchainMemberNodesSku

Name Description Value
capacity Gets or sets the nodes capacity. int

Sku

Name Description Value
name Gets or sets Sku name string
tier Gets or sets Sku tier string

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Blockchain Service

Deploy to Azure
This template deploys a Azure Blockchain Service, that currently provides support for the Ethereum Quorum ledger using the IBFT consensus mechanism.

Terraform (AzAPI provider) resource definition

The blockchainMembers 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.Blockchain/blockchainMembers resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Blockchain/blockchainMembers@2018-06-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      consortium = "string"
      consortiumManagementAccountPassword = "string"
      consortiumMemberDisplayName = "string"
      consortiumRole = "string"
      firewallRules = [
        {
          endIpAddress = "string"
          ruleName = "string"
          startIpAddress = "string"
        }
      ]
      password = "string"
      protocol = "string"
      validatorNodesSku = {
        capacity = int
      }
    }
    sku = {
      name = "string"
      tier = "string"
    }
  })
}

Property values

blockchainMembers

Name Description Value
type The resource type "Microsoft.Blockchain/blockchainMembers@2018-06-01-preview"
name The resource name string (required)

Character limit: 2-20

Valid characters:
Lowercase letters and numbers.

Start with lowercase letter.

Resource name must be unique across Azure.
location The GEO location of the blockchain service. string
parent_id To deploy to a resource group, use the ID of that resource group. string (required)
tags Tags of the service which is a list of key value pairs that describes the resource. Dictionary of tag names and values.
sku Gets or sets the blockchain member Sku. Sku
properties Gets or sets the blockchain member properties. BlockchainMemberProperties

BlockchainMemberProperties

Name Description Value
consortium Gets or sets the consortium for the blockchain member. string
consortiumManagementAccountPassword Sets the managed consortium management account password. string
consortiumMemberDisplayName Gets the display name of the member in the consortium. string
consortiumRole Gets the role of the member in the consortium. string
firewallRules Gets or sets firewall rules FirewallRule[]
password Sets the basic auth password of the blockchain member. string
protocol Gets or sets the blockchain protocol. "Corda"
"NotSpecified"
"Parity"
"Quorum"
validatorNodesSku Gets or sets the blockchain validator nodes Sku. BlockchainMemberNodesSku

FirewallRule

Name Description Value
endIpAddress Gets or sets the end IP address of the firewall rule range. string
ruleName Gets or sets the name of the firewall rules. string
startIpAddress Gets or sets the start IP address of the firewall rule range. string

BlockchainMemberNodesSku

Name Description Value
capacity Gets or sets the nodes capacity. int

Sku

Name Description Value
name Gets or sets Sku name string
tier Gets or sets Sku tier string