swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector BlockchainMember API
schemes:
- https
tags:
- name: BlockchainMember
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Blockchain/blockchainMembers/{blockchainMemberName}
  : get:
      tags:
      - BlockchainMember
      description: Get details about a blockchain member.
      operationId: microsoftAzureBlockchainmembersGet
      parameters:
      - name: blockchainMemberName
        in: path
        description: Blockchain member name.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupParameter'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/BlockchainMember'
      x-ms-examples:
        BlockchainMembers_Get:
          $ref: ./examples/BlockchainMembers_Get.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Blockchain Blockchainmembers Blockchainmembername
    put:
      tags:
      - BlockchainMember
      description: Create a blockchain member.
      operationId: microsoftAzureBlockchainmembersCreate
      parameters:
      - name: blockchainMemberName
        in: path
        description: Blockchain member name.
        required: true
        type: string
      - name: blockchainMember
        in: body
        description: Payload to create a blockchain member.
        required: false
        schema:
          $ref: '#/definitions/BlockchainMember'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupParameter'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/BlockchainMember'
        '201':
          description: Success
          schema:
            $ref: '#/definitions/BlockchainMember'
      x-ms-long-running-operation: true
      x-ms-examples:
        BlockchainMembers_Create:
          $ref: ./examples/BlockchainMembers_Create.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Blockchain Blockchainmembers Blockchainmembername
    delete:
      tags:
      - BlockchainMember
      description: Delete a blockchain member.
      operationId: microsoftAzureBlockchainmembersDelete
      parameters:
      - name: blockchainMemberName
        in: path
        description: Blockchain member name
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupParameter'
      responses:
        '202':
          description: Success
        '204':
          description: Success
      x-ms-long-running-operation: true
      x-ms-examples:
        BlockchainMembers_Delete:
          $ref: ./examples/BlockchainMembers_Delete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Blockchain Blockchainmembers Blockchainmembername
    patch:
      tags:
      - BlockchainMember
      description: Update a blockchain member.
      operationId: microsoftAzureBlockchainmembersUpdate
      parameters:
      - name: blockchainMemberName
        in: path
        description: Blockchain member name.
        required: true
        type: string
      - name: blockchainMember
        in: body
        description: Payload to update the blockchain member.
        required: false
        schema:
          $ref: '#/definitions/BlockchainMemberUpdate'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupParameter'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/BlockchainMember'
      x-ms-examples:
        BlockchainMembers_Update:
          $ref: ./examples/BlockchainMembers_Update.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Blockchain Blockchainmembers Blockchainmembername
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Blockchain/blockchainMembers:
    get:
      tags:
      - BlockchainMember
      description: Lists the blockchain members for a resource group.
      operationId: microsoftAzureBlockchainmembersList
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupParameter'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/BlockchainMemberCollection'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        BlockchainMembers_List:
          $ref: ./examples/BlockchainMembers_List.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Blockchain Blockchainmembers
  /subscriptions/{subscriptionId}/providers/Microsoft.Blockchain/blockchainMembers:
    get:
      tags:
      - BlockchainMember
      description: Lists the blockchain members for a subscription.
      operationId: microsoftAzureBlockchainmembersListall
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/BlockchainMemberCollection'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        BlockchainMembers_ListAll:
          $ref: ./examples/BlockchainMembers_ListAll.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Blockchain Blockchainmembers
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Blockchain/blockchainMembers/{blockchainMemberName}/consortiumMembers
  : get:
      tags:
      - BlockchainMember
      description: Lists the consortium members for a blockchain member.
      operationId: microsoftAzureBlockchainmembersListconsortiummembers
      parameters:
      - name: blockchainMemberName
        in: path
        description: Blockchain member name.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupParameter'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ConsortiumMemberCollection'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        BlockchainMembers_ListConsortiumMembers:
          $ref: ./examples/BlockchainMembers_ListConsortiumMembers.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Blockchain Blockchainmembers Blockchainmembername Consortiummembers
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Blockchain/blockchainMembers/{blockchainMemberName}/listApiKeys
  : post:
      tags:
      - BlockchainMember
      description: Lists the API keys for a blockchain member.
      operationId: microsoftAzureBlockchainmembersListapikeys
      parameters:
      - name: blockchainMemberName
        in: path
        description: Blockchain member name.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupParameter'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ApiKeyCollection'
      x-ms-examples:
        BlockchainMembers_ListApiKeys:
          $ref: ./examples/BlockchainMembers_ListApiKeys.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Blockchain Blockchainmembers Blockchainmembername Listapikeys
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Blockchain/blockchainMembers/{blockchainMemberName}/regenerateApiKeys
  : post:
      tags:
      - BlockchainMember
      description: Regenerate the API keys for a blockchain member.
      operationId: microsoftAzureBlockchainmembersListregenerateapikeys
      parameters:
      - name: blockchainMemberName
        in: path
        description: Blockchain member name.
        required: true
        type: string
      - name: apiKey
        in: body
        description: api key to be regenerate
        required: false
        schema:
          $ref: '#/definitions/ApiKey'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupParameter'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ApiKeyCollection'
      x-ms-examples:
        BlockchainMembers_ListRegenerateApiKeys:
          $ref: ./examples/BlockchainMembers_ListRegenerateApiKeys.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Blockchain Blockchainmembers Blockchainmembername Regenerateapikeys
definitions:
  BlockchainMemberProperties:
    description: Payload of the blockchain member properties for a blockchain member.
    type: object
    properties:
      protocol:
        description: Gets or sets the blockchain protocol.
        enum:
        - NotSpecified
        - Parity
        - Quorum
        - Corda
        type: string
        x-ms-enum:
          name: BlockchainProtocol
          modelAsString: true
      validatorNodesSku:
        $ref: '#/definitions/BlockchainMemberNodesSku'
        description: Gets or sets the blockchain validator nodes Sku.
      provisioningState:
        description: Gets or sets the blockchain member provision state.
        enum:
        - NotSpecified
        - Updating
        - Deleting
        - Succeeded
        - Failed
        - Stale
        type: string
        readOnly: true
        x-ms-enum:
          name: BlockchainMemberProvisioningState
          modelAsString: true
      dns:
        description: Gets the dns endpoint of the blockchain member.
        type: string
        readOnly: true
      userName:
        description: Gets the auth user name of the blockchain member.
        type: string
        readOnly: true
      password:
        description: Sets the basic auth password of the blockchain member.
        type: string
      consortium:
        description: Gets or sets the consortium for the blockchain member.
        type: string
      consortiumManagementAccountAddress:
        description: Gets the managed consortium management account address.
        type: string
        readOnly: true
      consortiumManagementAccountPassword:
        description: Sets the managed consortium management account password.
        type: string
      consortiumRole:
        description: Gets the role of the member in the consortium.
        type: string
      consortiumMemberDisplayName:
        description: Gets the display name of the member in the consortium.
        type: string
      rootContractAddress:
        description: Gets the Ethereum root contract address of the blockchain.
        type: string
        readOnly: true
      publicKey:
        description: Gets the public key of the blockchain member (default transaction node).
        type: string
        readOnly: true
      firewallRules:
        description: Gets or sets firewall rules
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/FirewallRule'
        x-ms-identifiers:
        - ruleName
  ApiKey:
    description: API key payload which is exposed in the request/response of the resource provider.
    type: object
    properties:
      keyName:
        description: Gets or sets the API key name.
        type: string
      value:
        description: Gets or sets the API key value.
        type: string
  Resource:
    description: The core properties of the resources.
    type: object
    properties:
      id:
        description: Fully qualified resource Id of the resource.
        type: string
        readOnly: true
      name:
        description: The name of the resource.
        type: string
        readOnly: true
      type:
        description: The type of the service - e.g. "Microsoft.Blockchain"
        type: string
        readOnly: true
    x-ms-azure-resource: true
  BlockchainMember:
    description: Payload of the blockchain member which is exposed in the request/response of the resource provider.
    type: object
    allOf:
    - $ref: '#/definitions/TrackedResource'
    properties:
      properties:
        $ref: '#/definitions/BlockchainMemberProperties'
        description: Gets or sets the blockchain member properties.
        x-ms-client-flatten: true
      sku:
        $ref: '#/definitions/Sku'
        description: Gets or sets the blockchain member Sku.
  ConsortiumMemberCollection:
    description: Collection of consortium payload.
    type: object
    properties:
      value:
        description: Gets or sets the collection of consortiums.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/ConsortiumMember'
        x-ms-identifiers:
        - name
      nextLink:
        description: "Gets or sets the URL, that the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use."
        type: string
  BlockchainMemberUpdate:
    description: Update the payload of the blockchain member which is exposed in the request/response of the resource provider.
    type: object
    properties:
      tags:
        description: Tags of the service which is a list of key value pairs that describes the resource.
        type: object
        additionalProperties:
          type: string
        x-ms-mutability:
        - read
        - create
        - update
      properties:
        $ref: '#/definitions/BlockchainMemberPropertiesUpdate'
        description: Gets or sets the blockchain member update properties.
        x-ms-client-flatten: true
  BlockchainMemberPropertiesUpdate:
    description: Update the payload of the blockchain member properties for a blockchain member.
    type: object
    allOf:
    - $ref: '#/definitions/TransactionNodePropertiesUpdate'
    properties:
      consortiumManagementAccountPassword:
        description: Sets the managed consortium management account password.
        type: string
  BlockchainMemberNodesSku:
    description: Payload of the blockchain member nodes Sku for a blockchain member.
    type: object
    properties:
      capacity:
        format: int32
        description: Gets or sets the nodes capacity.
        type: integer
  TrackedResource:
    description: The resource model definition for a top level resource.
    type: object
    allOf:
    - $ref: '#/definitions/Resource'
    properties:
      location:
        description: The GEO location of the blockchain service.
        type: string
        x-ms-mutability:
        - read
        - create
      tags:
        description: Tags of the service which is a list of key value pairs that describes the resource.
        type: object
        additionalProperties:
          type: string
        x-ms-mutability:
        - read
        - create
        - update
  FirewallRule:
    description: Ip range for firewall rules
    type: object
    properties:
      ruleName:
        description: Gets or sets the name of the firewall rules.
        type: string
      startIpAddress:
        description: Gets or sets the start IP address of the firewall rule range.
        type: string
      endIpAddress:
        description: Gets or sets the end IP address of the firewall rule range.
        type: string
  Sku:
    description: Blockchain member Sku in payload
    type: object
    properties:
      name:
        description: Gets or sets Sku name
        type: string
      tier:
        description: Gets or sets Sku tier
        type: string
  BlockchainMemberCollection:
    description: Collection of the blockchain member payload which is exposed in the request/response of the resource provider.
    type: object
    properties:
      value:
        description: Gets or sets the collection of blockchain members.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/BlockchainMember'
      nextLink:
        description: "Gets or sets the URL, that the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use."
        type: string
  TransactionNodePropertiesUpdate:
    description: Update the payload of the transaction node properties in the transaction node payload.
    type: object
    properties:
      password:
        description: Sets the transaction node dns endpoint basic auth password.
        type: string
      firewallRules:
        description: Gets or sets the firewall rules.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/FirewallRule'
        x-ms-identifiers:
        - ruleName
  ConsortiumMember:
    description: Consortium approval
    type: object
    properties:
      name:
        description: Gets the consortium member name.
        type: string
      displayName:
        description: Gets the consortium member display name.
        type: string
      subscriptionId:
        description: Gets the consortium member subscription id.
        type: string
      role:
        description: Gets the consortium member role.
        type: string
      status:
        description: Gets the consortium member status.
        type: string
      joinDate:
        format: date-time
        description: Gets the consortium member join date.
        type: string
      dateModified:
        format: date-time
        description: Gets the consortium member modified date.
        type: string
  ApiKeyCollection:
    description: Collection of the API key payload which is exposed in the response of the resource provider.
    type: object
    properties:
      keys:
        description: Gets or sets the collection of API key.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/ApiKey'
        x-ms-identifiers:
        - keyName
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    description: Client API Version.
    required: true
    type: string
    enum:
    - 2018-06-01-preview
  ResourceGroupParameter:
    name: resourceGroupName
    in: path
    description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    required: true
    type: string
    x-ms-parameter-location: method
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    description: Gets the subscription Id which uniquely identifies the Microsoft Azure subscription. The subscription ID is part of the URI for every service call.
    required: true
    type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'