armblockchain

package module
v0.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 17, 2022 License: MIT Imports: 16 Imported by: 2

README

Azure Blockchain Module for Go

PkgGoDev

The armblockchain module provides operations for working with Azure Blockchain.

Source code

Getting started

Prerequisites

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure Blockchain module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/blockchain/armblockchain

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure Blockchain. The azidentity module provides facilities for various ways of authenticating with Azure including client/secret, certificate, managed identity, and more.

cred, err := azidentity.NewDefaultAzureCredential(nil)

For more information on authentication, please see the documentation for azidentity at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity.

Clients

Azure Blockchain modules consist of one or more clients. A client groups a set of related APIs, providing access to its functionality within the specified subscription. Create one or more clients to access the APIs you require using your credential.

client, err := armblockchain.NewMembersClient(<subscription ID>, cred, nil)

You can use ClientOptions in package github.com/Azure/azure-sdk-for-go/sdk/azcore/arm to set endpoint to connect with public and sovereign clouds as well as Azure Stack. For more information, please see the documentation for azcore at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azcore.

options := arm.ClientOptions {
    ClientOptions: azcore.ClientOptions {
        Cloud: cloud.AzureChina,
    },
}
client, err := armblockchain.NewMembersClient(<subscription ID>, cred, &options)

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the Blockchain label.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type APIKey 

type APIKey struct {
	// Gets or sets the API key name.
	KeyName *string `json:"keyName,omitempty"`

	// Gets or sets the API key value.
	Value *string `json:"value,omitempty"`
}

APIKey - API key payload which is exposed in the request/response of the resource provider.

type APIKeyCollection 

type APIKeyCollection struct {
	// Gets or sets the collection of API key.
	Keys []*APIKey `json:"keys,omitempty"`
}

APIKeyCollection - Collection of the API key payload which is exposed in the response of the resource provider.

type BlockchainMemberProvisioningState 

type BlockchainMemberProvisioningState string

BlockchainMemberProvisioningState - Gets or sets the blockchain member provision state. 

const (
	BlockchainMemberProvisioningStateDeleting     BlockchainMemberProvisioningState = "Deleting"
	BlockchainMemberProvisioningStateFailed       BlockchainMemberProvisioningState = "Failed"
	BlockchainMemberProvisioningStateNotSpecified BlockchainMemberProvisioningState = "NotSpecified"
	BlockchainMemberProvisioningStateStale        BlockchainMemberProvisioningState = "Stale"
	BlockchainMemberProvisioningStateSucceeded    BlockchainMemberProvisioningState = "Succeeded"
	BlockchainMemberProvisioningStateUpdating     BlockchainMemberProvisioningState = "Updating"
)

func PossibleBlockchainMemberProvisioningStateValues 

func PossibleBlockchainMemberProvisioningStateValues() []BlockchainMemberProvisioningState

PossibleBlockchainMemberProvisioningStateValues returns the possible values for the BlockchainMemberProvisioningState const type.

type BlockchainProtocol 

type BlockchainProtocol string

BlockchainProtocol - Gets or sets the blockchain protocol. 

const (
	BlockchainProtocolCorda        BlockchainProtocol = "Corda"
	BlockchainProtocolNotSpecified BlockchainProtocol = "NotSpecified"
	BlockchainProtocolParity       BlockchainProtocol = "Parity"
	BlockchainProtocolQuorum       BlockchainProtocol = "Quorum"
)

func PossibleBlockchainProtocolValues 

func PossibleBlockchainProtocolValues() []BlockchainProtocol

PossibleBlockchainProtocolValues returns the possible values for the BlockchainProtocol const type.

type Consortium 

type Consortium struct {
	// Gets or sets the blockchain member name.
	Name *string `json:"name,omitempty"`

	// Gets or sets the protocol for the consortium.
	Protocol *BlockchainProtocol `json:"protocol,omitempty"`
}

Consortium payload

type ConsortiumCollection 

type ConsortiumCollection struct {
	// Gets or sets the collection of consortiums.
	Value []*Consortium `json:"value,omitempty"`
}

ConsortiumCollection - Collection of the consortium payload.

type ConsortiumMember 

type ConsortiumMember struct {
	// Gets the consortium member modified date.
	DateModified *time.Time `json:"dateModified,omitempty"`

	// Gets the consortium member display name.
	DisplayName *string `json:"displayName,omitempty"`

	// Gets the consortium member join date.
	JoinDate *time.Time `json:"joinDate,omitempty"`

	// Gets the consortium member name.
	Name *string `json:"name,omitempty"`

	// Gets the consortium member role.
	Role *string `json:"role,omitempty"`

	// Gets the consortium member status.
	Status *string `json:"status,omitempty"`

	// Gets the consortium member subscription id.
	SubscriptionID *string `json:"subscriptionId,omitempty"`
}

ConsortiumMember - Consortium approval

func (*ConsortiumMember) UnmarshalJSON 

func (c *ConsortiumMember) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConsortiumMember.

type ConsortiumMemberCollection 

type ConsortiumMemberCollection struct {
	// Gets or sets the URL, that the client should use to fetch the next page (per server side paging). It's null for now, added
	// for future use.
	NextLink *string `json:"nextLink,omitempty"`

	// Gets or sets the collection of consortiums.
	Value []*ConsortiumMember `json:"value,omitempty"`
}

ConsortiumMemberCollection - Collection of consortium payload.

type FirewallRule 

type FirewallRule struct {
	// Gets or sets the end IP address of the firewall rule range.
	EndIPAddress *string `json:"endIpAddress,omitempty"`

	// Gets or sets the name of the firewall rules.
	RuleName *string `json:"ruleName,omitempty"`

	// Gets or sets the start IP address of the firewall rule range.
	StartIPAddress *string `json:"startIpAddress,omitempty"`
}

FirewallRule - Ip range for firewall rules

type LocationsClient 

type LocationsClient struct {
	// contains filtered or unexported fields
}

LocationsClient contains the methods for the Locations group. Don't use this type directly, use NewLocationsClient() instead.

func NewLocationsClient 

func NewLocationsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*LocationsClient, error)

NewLocationsClient creates a new instance of LocationsClient with the specified values. subscriptionID - Gets the subscription Id which uniquely identifies the Microsoft Azure subscription. The subscription ID is part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*LocationsClient) CheckNameAvailability 

func (client *LocationsClient) CheckNameAvailability(ctx context.Context, locationName string, options *LocationsClientCheckNameAvailabilityOptions) (LocationsClientCheckNameAvailabilityResponse, error)

CheckNameAvailability - To check whether a resource name is available. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2018-06-01-preview locationName - Location Name. options - LocationsClientCheckNameAvailabilityOptions contains the optional parameters for the LocationsClient.CheckNameAvailability method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/blockchain/resource-manager/Microsoft.Blockchain/preview/2018-06-01-preview/examples/Locations_CheckNameAvailability.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/blockchain/armblockchain"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armblockchain.NewLocationsClient("51766542-3ed7-4a72-a187-0c8ab644ddab", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.CheckNameAvailability(ctx,
		"southeastasia",
		&armblockchain.LocationsClientCheckNameAvailabilityOptions{NameAvailabilityRequest: &armblockchain.NameAvailabilityRequest{
			Name: to.Ptr("contosemember1"),
			Type: to.Ptr("Microsoft.Blockchain/blockchainMembers"),
		},
		})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*LocationsClient) ListConsortiums 

func (client *LocationsClient) ListConsortiums(ctx context.Context, locationName string, options *LocationsClientListConsortiumsOptions) (LocationsClientListConsortiumsResponse, error)

ListConsortiums - Lists the available consortiums for a subscription. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2018-06-01-preview locationName - Location Name. options - LocationsClientListConsortiumsOptions contains the optional parameters for the LocationsClient.ListConsortiums method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/blockchain/resource-manager/Microsoft.Blockchain/preview/2018-06-01-preview/examples/Locations_ListConsortiums.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/blockchain/armblockchain"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armblockchain.NewLocationsClient("51766542-3ed7-4a72-a187-0c8ab644ddab", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.ListConsortiums(ctx,
		"southeastasia",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

type LocationsClientCheckNameAvailabilityOptions added in v0.2.0 

type LocationsClientCheckNameAvailabilityOptions struct {
	// Name availability request payload.
	NameAvailabilityRequest *NameAvailabilityRequest
}

LocationsClientCheckNameAvailabilityOptions contains the optional parameters for the LocationsClient.CheckNameAvailability method.

type LocationsClientCheckNameAvailabilityResponse added in v0.2.0 

type LocationsClientCheckNameAvailabilityResponse struct {
	NameAvailability
}

LocationsClientCheckNameAvailabilityResponse contains the response from method LocationsClient.CheckNameAvailability.

type LocationsClientListConsortiumsOptions added in v0.2.0 

type LocationsClientListConsortiumsOptions struct {
}

LocationsClientListConsortiumsOptions contains the optional parameters for the LocationsClient.ListConsortiums method.

type LocationsClientListConsortiumsResponse added in v0.2.0 

type LocationsClientListConsortiumsResponse struct {
	ConsortiumCollection
}

LocationsClientListConsortiumsResponse contains the response from method LocationsClient.ListConsortiums.

type Member added in v0.2.0 

type Member struct {
	// The GEO location of the blockchain service.
	Location *string `json:"location,omitempty"`

	// Gets or sets the blockchain member properties.
	Properties *MemberProperties `json:"properties,omitempty"`

	// Gets or sets the blockchain member Sku.
	SKU *SKU `json:"sku,omitempty"`

	// Tags of the service which is a list of key value pairs that describes the resource.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified resource Id of the resource.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the service - e.g. "Microsoft.Blockchain"
	Type *string `json:"type,omitempty" azure:"ro"`
}

Member - Payload of the blockchain member which is exposed in the request/response of the resource provider.

func (Member) MarshalJSON added in v0.2.0 

func (m Member) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Member.

type MemberCollection added in v0.2.0 

type MemberCollection struct {
	// Gets or sets the URL, that the client should use to fetch the next page (per server side paging). It's null for now, added
	// for future use.
	NextLink *string `json:"nextLink,omitempty"`

	// Gets or sets the collection of blockchain members.
	Value []*Member `json:"value,omitempty"`
}

MemberCollection - Collection of the blockchain member payload which is exposed in the request/response of the resource provider.

type MemberNodesSKU added in v0.2.0 

type MemberNodesSKU struct {
	// Gets or sets the nodes capacity.
	Capacity *int32 `json:"capacity,omitempty"`
}

MemberNodesSKU - Payload of the blockchain member nodes Sku for a blockchain member.

type MemberOperationResultsClient added in v0.2.0 

type MemberOperationResultsClient struct {
	// contains filtered or unexported fields
}

MemberOperationResultsClient contains the methods for the BlockchainMemberOperationResults group. Don't use this type directly, use NewMemberOperationResultsClient() instead.

func NewMemberOperationResultsClient added in v0.2.0 

func NewMemberOperationResultsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*MemberOperationResultsClient, error)

NewMemberOperationResultsClient creates a new instance of MemberOperationResultsClient with the specified values. subscriptionID - Gets the subscription Id which uniquely identifies the Microsoft Azure subscription. The subscription ID is part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*MemberOperationResultsClient) Get added in v0.2.0 

func (client *MemberOperationResultsClient) Get(ctx context.Context, locationName string, operationID string, options *MemberOperationResultsClientGetOptions) (MemberOperationResultsClientGetResponse, error)

Get - Get Async operation result. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2018-06-01-preview locationName - Location name. operationID - Operation Id. options - MemberOperationResultsClientGetOptions contains the optional parameters for the MemberOperationResultsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/blockchain/resource-manager/Microsoft.Blockchain/preview/2018-06-01-preview/examples/BlockchainMemberOperationResults_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/blockchain/armblockchain"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armblockchain.NewMemberOperationResultsClient("51766542-3ed7-4a72-a187-0c8ab644ddab", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"southeastasia",
		"12f4b309-01e3-4fcf-bc0b-1cc034ca03f8",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

type MemberOperationResultsClientGetOptions added in v0.2.0 

type MemberOperationResultsClientGetOptions struct {
}

MemberOperationResultsClientGetOptions contains the optional parameters for the MemberOperationResultsClient.Get method.

type MemberOperationResultsClientGetResponse added in v0.2.0 

type MemberOperationResultsClientGetResponse struct {
	OperationResult
}

MemberOperationResultsClientGetResponse contains the response from method MemberOperationResultsClient.Get.

type MemberProperties added in v0.2.0 

type MemberProperties struct {
	// Gets or sets the consortium for the blockchain member.
	Consortium *string `json:"consortium,omitempty"`

	// Sets the managed consortium management account password.
	ConsortiumManagementAccountPassword *string `json:"consortiumManagementAccountPassword,omitempty"`

	// Gets the display name of the member in the consortium.
	ConsortiumMemberDisplayName *string `json:"consortiumMemberDisplayName,omitempty"`

	// Gets the role of the member in the consortium.
	ConsortiumRole *string `json:"consortiumRole,omitempty"`

	// Gets or sets firewall rules
	FirewallRules []*FirewallRule `json:"firewallRules,omitempty"`

	// Sets the basic auth password of the blockchain member.
	Password *string `json:"password,omitempty"`

	// Gets or sets the blockchain protocol.
	Protocol *BlockchainProtocol `json:"protocol,omitempty"`

	// Gets or sets the blockchain validator nodes Sku.
	ValidatorNodesSKU *MemberNodesSKU `json:"validatorNodesSku,omitempty"`

	// READ-ONLY; Gets the managed consortium management account address.
	ConsortiumManagementAccountAddress *string `json:"consortiumManagementAccountAddress,omitempty" azure:"ro"`

	// READ-ONLY; Gets the dns endpoint of the blockchain member.
	DNS *string `json:"dns,omitempty" azure:"ro"`

	// READ-ONLY; Gets or sets the blockchain member provision state.
	ProvisioningState *BlockchainMemberProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; Gets the public key of the blockchain member (default transaction node).
	PublicKey *string `json:"publicKey,omitempty" azure:"ro"`

	// READ-ONLY; Gets the Ethereum root contract address of the blockchain.
	RootContractAddress *string `json:"rootContractAddress,omitempty" azure:"ro"`

	// READ-ONLY; Gets the auth user name of the blockchain member.
	UserName *string `json:"userName,omitempty" azure:"ro"`
}

MemberProperties - Payload of the blockchain member properties for a blockchain member.

func (MemberProperties) MarshalJSON added in v0.2.0 

func (m MemberProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MemberProperties.

type MemberPropertiesUpdate added in v0.2.0 

type MemberPropertiesUpdate struct {
	// Sets the managed consortium management account password.
	ConsortiumManagementAccountPassword *string `json:"consortiumManagementAccountPassword,omitempty"`

	// Gets or sets the firewall rules.
	FirewallRules []*FirewallRule `json:"firewallRules,omitempty"`

	// Sets the transaction node dns endpoint basic auth password.
	Password *string `json:"password,omitempty"`
}

MemberPropertiesUpdate - Update the payload of the blockchain member properties for a blockchain member.

func (MemberPropertiesUpdate) MarshalJSON added in v0.2.0 

func (m MemberPropertiesUpdate) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MemberPropertiesUpdate.

type MemberUpdate added in v0.2.0 

type MemberUpdate struct {
	// Gets or sets the blockchain member update properties.
	Properties *MemberPropertiesUpdate `json:"properties,omitempty"`

	// Tags of the service which is a list of key value pairs that describes the resource.
	Tags map[string]*string `json:"tags,omitempty"`
}

MemberUpdate - Update the payload of the blockchain member which is exposed in the request/response of the resource provider.

func (MemberUpdate) MarshalJSON added in v0.2.0 

func (m MemberUpdate) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MemberUpdate.

type MembersClient added in v0.2.0 

type MembersClient struct {
	// contains filtered or unexported fields
}

MembersClient contains the methods for the BlockchainMembers group. Don't use this type directly, use NewMembersClient() instead.

func NewMembersClient added in v0.2.0 

func NewMembersClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*MembersClient, error)

NewMembersClient creates a new instance of MembersClient with the specified values. subscriptionID - Gets the subscription Id which uniquely identifies the Microsoft Azure subscription. The subscription ID is part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*MembersClient) BeginCreate added in v0.2.0 

func (client *MembersClient) BeginCreate(ctx context.Context, blockchainMemberName string, resourceGroupName string, options *MembersClientBeginCreateOptions) (*runtime.Poller[MembersClientCreateResponse], error)

BeginCreate - Create a blockchain member. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2018-06-01-preview blockchainMemberName - Blockchain member name. resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. options - MembersClientBeginCreateOptions contains the optional parameters for the MembersClient.BeginCreate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/blockchain/resource-manager/Microsoft.Blockchain/preview/2018-06-01-preview/examples/BlockchainMembers_Create.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/blockchain/armblockchain"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armblockchain.NewMembersClient("51766542-3ed7-4a72-a187-0c8ab644ddab", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginCreate(ctx,
		"contosemember1",
		"mygroup",
		&armblockchain.MembersClientBeginCreateOptions{BlockchainMember: &armblockchain.Member{
			Location: to.Ptr("southeastasia"),
			Properties: &armblockchain.MemberProperties{
				Consortium:                          to.Ptr("ContoseConsortium"),
				ConsortiumManagementAccountPassword: to.Ptr("<consortiumManagementAccountPassword>"),
				Password:                            to.Ptr("<password>"),
				ValidatorNodesSKU: &armblockchain.MemberNodesSKU{
					Capacity: to.Ptr[int32](2),
				},
				Protocol: to.Ptr(armblockchain.BlockchainProtocolQuorum),
			},
		},
		})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*MembersClient) BeginDelete added in v0.2.0 

func (client *MembersClient) BeginDelete(ctx context.Context, blockchainMemberName string, resourceGroupName string, options *MembersClientBeginDeleteOptions) (*runtime.Poller[MembersClientDeleteResponse], error)

BeginDelete - Delete a blockchain member. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2018-06-01-preview blockchainMemberName - Blockchain member name resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. options - MembersClientBeginDeleteOptions contains the optional parameters for the MembersClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/blockchain/resource-manager/Microsoft.Blockchain/preview/2018-06-01-preview/examples/BlockchainMembers_Delete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/blockchain/armblockchain"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armblockchain.NewMembersClient("51766542-3ed7-4a72-a187-0c8ab644ddab", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginDelete(ctx,
		"contosemember1",
		"mygroup",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*MembersClient) Get added in v0.2.0 

func (client *MembersClient) Get(ctx context.Context, blockchainMemberName string, resourceGroupName string, options *MembersClientGetOptions) (MembersClientGetResponse, error)

Get - Get details about a blockchain member. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2018-06-01-preview blockchainMemberName - Blockchain member name. resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. options - MembersClientGetOptions contains the optional parameters for the MembersClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/blockchain/resource-manager/Microsoft.Blockchain/preview/2018-06-01-preview/examples/BlockchainMembers_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/blockchain/armblockchain"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armblockchain.NewMembersClient("51766542-3ed7-4a72-a187-0c8ab644ddab", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"contosemember1",
		"mygroup",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*MembersClient) ListAPIKeys added in v0.2.0 

func (client *MembersClient) ListAPIKeys(ctx context.Context, blockchainMemberName string, resourceGroupName string, options *MembersClientListAPIKeysOptions) (MembersClientListAPIKeysResponse, error)

ListAPIKeys - Lists the API keys for a blockchain member. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2018-06-01-preview blockchainMemberName - Blockchain member name. resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. options - MembersClientListAPIKeysOptions contains the optional parameters for the MembersClient.ListAPIKeys method.

func (*MembersClient) ListRegenerateAPIKeys added in v0.2.0 

func (client *MembersClient) ListRegenerateAPIKeys(ctx context.Context, blockchainMemberName string, resourceGroupName string, options *MembersClientListRegenerateAPIKeysOptions) (MembersClientListRegenerateAPIKeysResponse, error)

ListRegenerateAPIKeys - Regenerate the API keys for a blockchain member. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2018-06-01-preview blockchainMemberName - Blockchain member name. resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. options - MembersClientListRegenerateAPIKeysOptions contains the optional parameters for the MembersClient.ListRegenerateAPIKeys method.

func (*MembersClient) NewListAllPager added in v0.4.0 

func (client *MembersClient) NewListAllPager(options *MembersClientListAllOptions) *runtime.Pager[MembersClientListAllResponse]

NewListAllPager - Lists the blockchain members for a subscription. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2018-06-01-preview options - MembersClientListAllOptions contains the optional parameters for the MembersClient.ListAll method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/blockchain/resource-manager/Microsoft.Blockchain/preview/2018-06-01-preview/examples/BlockchainMembers_ListAll.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/blockchain/armblockchain"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armblockchain.NewMembersClient("51766542-3ed7-4a72-a187-0c8ab644ddab", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListAllPager(nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*MembersClient) NewListConsortiumMembersPager added in v0.4.0 

func (client *MembersClient) NewListConsortiumMembersPager(blockchainMemberName string, resourceGroupName string, options *MembersClientListConsortiumMembersOptions) *runtime.Pager[MembersClientListConsortiumMembersResponse]

NewListConsortiumMembersPager - Lists the consortium members for a blockchain member. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2018-06-01-preview blockchainMemberName - Blockchain member name. resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. options - MembersClientListConsortiumMembersOptions contains the optional parameters for the MembersClient.ListConsortiumMembers method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/blockchain/resource-manager/Microsoft.Blockchain/preview/2018-06-01-preview/examples/BlockchainMembers_ListConsortiumMembers.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/blockchain/armblockchain"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armblockchain.NewMembersClient("51766542-3ed7-4a72-a187-0c8ab644ddab", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListConsortiumMembersPager("contosemember1",
		"mygroup",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*MembersClient) NewListPager added in v0.4.0 

func (client *MembersClient) NewListPager(resourceGroupName string, options *MembersClientListOptions) *runtime.Pager[MembersClientListResponse]

NewListPager - Lists the blockchain members for a resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2018-06-01-preview resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. options - MembersClientListOptions contains the optional parameters for the MembersClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/blockchain/resource-manager/Microsoft.Blockchain/preview/2018-06-01-preview/examples/BlockchainMembers_List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/blockchain/armblockchain"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armblockchain.NewMembersClient("51766542-3ed7-4a72-a187-0c8ab644ddab", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListPager("mygroup",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*MembersClient) Update added in v0.2.0 

func (client *MembersClient) Update(ctx context.Context, blockchainMemberName string, resourceGroupName string, options *MembersClientUpdateOptions) (MembersClientUpdateResponse, error)

Update - Update a blockchain member. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2018-06-01-preview blockchainMemberName - Blockchain member name. resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. options - MembersClientUpdateOptions contains the optional parameters for the MembersClient.Update method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/blockchain/resource-manager/Microsoft.Blockchain/preview/2018-06-01-preview/examples/BlockchainMembers_Update.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/blockchain/armblockchain"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armblockchain.NewMembersClient("51766542-3ed7-4a72-a187-0c8ab644ddab", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Update(ctx,
		"ContoseMember1",
		"mygroup",
		&armblockchain.MembersClientUpdateOptions{BlockchainMember: &armblockchain.MemberUpdate{
			Properties: &armblockchain.MemberPropertiesUpdate{
				Password:                            to.Ptr("<password>"),
				ConsortiumManagementAccountPassword: to.Ptr("<consortiumManagementAccountPassword>"),
			},
		},
		})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

type MembersClientBeginCreateOptions added in v0.2.0 

type MembersClientBeginCreateOptions struct {
	// Payload to create a blockchain member.
	BlockchainMember *Member
	// Resumes the LRO from the provided token.
	ResumeToken string
}

MembersClientBeginCreateOptions contains the optional parameters for the MembersClient.BeginCreate method.

type MembersClientBeginDeleteOptions added in v0.2.0 

type MembersClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

MembersClientBeginDeleteOptions contains the optional parameters for the MembersClient.BeginDelete method.

type MembersClientCreateResponse added in v0.2.0 

type MembersClientCreateResponse struct {
	Member
}

MembersClientCreateResponse contains the response from method MembersClient.Create.

type MembersClientDeleteResponse added in v0.2.0 

type MembersClientDeleteResponse struct {
}

MembersClientDeleteResponse contains the response from method MembersClient.Delete.

type MembersClientGetOptions added in v0.2.0 

type MembersClientGetOptions struct {
}

MembersClientGetOptions contains the optional parameters for the MembersClient.Get method.

type MembersClientGetResponse added in v0.2.0 

type MembersClientGetResponse struct {
	Member
}

MembersClientGetResponse contains the response from method MembersClient.Get.

type MembersClientListAPIKeysOptions added in v0.2.0 

type MembersClientListAPIKeysOptions struct {
}

MembersClientListAPIKeysOptions contains the optional parameters for the MembersClient.ListAPIKeys method.

type MembersClientListAPIKeysResponse added in v0.2.0 

type MembersClientListAPIKeysResponse struct {
	APIKeyCollection
}

MembersClientListAPIKeysResponse contains the response from method MembersClient.ListAPIKeys.

type MembersClientListAllOptions added in v0.2.0 

type MembersClientListAllOptions struct {
}

MembersClientListAllOptions contains the optional parameters for the MembersClient.ListAll method.

type MembersClientListAllResponse added in v0.2.0 

type MembersClientListAllResponse struct {
	MemberCollection
}

MembersClientListAllResponse contains the response from method MembersClient.ListAll.

type MembersClientListConsortiumMembersOptions added in v0.2.0 

type MembersClientListConsortiumMembersOptions struct {
}

MembersClientListConsortiumMembersOptions contains the optional parameters for the MembersClient.ListConsortiumMembers method.

type MembersClientListConsortiumMembersResponse added in v0.2.0 

type MembersClientListConsortiumMembersResponse struct {
	ConsortiumMemberCollection
}

MembersClientListConsortiumMembersResponse contains the response from method MembersClient.ListConsortiumMembers.

type MembersClientListOptions added in v0.2.0 

type MembersClientListOptions struct {
}

MembersClientListOptions contains the optional parameters for the MembersClient.List method.

type MembersClientListRegenerateAPIKeysOptions added in v0.2.0 

type MembersClientListRegenerateAPIKeysOptions struct {
	// api key to be regenerate
	APIKey *APIKey
}

MembersClientListRegenerateAPIKeysOptions contains the optional parameters for the MembersClient.ListRegenerateAPIKeys method.

type MembersClientListRegenerateAPIKeysResponse added in v0.2.0 

type MembersClientListRegenerateAPIKeysResponse struct {
	APIKeyCollection
}

MembersClientListRegenerateAPIKeysResponse contains the response from method MembersClient.ListRegenerateAPIKeys.

type MembersClientListResponse added in v0.2.0 

type MembersClientListResponse struct {
	MemberCollection
}

MembersClientListResponse contains the response from method MembersClient.List.

type MembersClientUpdateOptions added in v0.2.0 

type MembersClientUpdateOptions struct {
	// Payload to update the blockchain member.
	BlockchainMember *MemberUpdate
}

MembersClientUpdateOptions contains the optional parameters for the MembersClient.Update method.

type MembersClientUpdateResponse added in v0.2.0 

type MembersClientUpdateResponse struct {
	Member
}

MembersClientUpdateResponse contains the response from method MembersClient.Update.

type NameAvailability 

type NameAvailability struct {
	// Gets or sets the message.
	Message *string `json:"message,omitempty"`

	// Gets or sets the value indicating whether the name is available.
	NameAvailable *bool `json:"nameAvailable,omitempty"`

	// Gets or sets the name availability reason.
	Reason *NameAvailabilityReason `json:"reason,omitempty"`
}

NameAvailability - Name availability payload which is exposed in the response of the resource provider.

type NameAvailabilityReason 

type NameAvailabilityReason string

NameAvailabilityReason - Gets or sets the name availability reason. 

const (
	NameAvailabilityReasonAlreadyExists NameAvailabilityReason = "AlreadyExists"
	NameAvailabilityReasonInvalid       NameAvailabilityReason = "Invalid"
	NameAvailabilityReasonNotSpecified  NameAvailabilityReason = "NotSpecified"
)

func PossibleNameAvailabilityReasonValues 

func PossibleNameAvailabilityReasonValues() []NameAvailabilityReason

PossibleNameAvailabilityReasonValues returns the possible values for the NameAvailabilityReason const type.

type NameAvailabilityRequest 

type NameAvailabilityRequest struct {
	// Gets or sets the name to check.
	Name *string `json:"name,omitempty"`

	// Gets or sets the type of the resource to check.
	Type *string `json:"type,omitempty"`
}

NameAvailabilityRequest - Name availability request payload which is exposed in the request of the resource provider.

type NodeProvisioningState 

type NodeProvisioningState string

NodeProvisioningState - Gets or sets the blockchain member provision state. 

const (
	NodeProvisioningStateDeleting     NodeProvisioningState = "Deleting"
	NodeProvisioningStateFailed       NodeProvisioningState = "Failed"
	NodeProvisioningStateNotSpecified NodeProvisioningState = "NotSpecified"
	NodeProvisioningStateSucceeded    NodeProvisioningState = "Succeeded"
	NodeProvisioningStateUpdating     NodeProvisioningState = "Updating"
)

func PossibleNodeProvisioningStateValues 

func PossibleNodeProvisioningStateValues() []NodeProvisioningState

PossibleNodeProvisioningStateValues returns the possible values for the NodeProvisioningState const type.

type OperationResult 

type OperationResult struct {
	// Gets or sets the operation end time.
	EndTime *time.Time `json:"endTime,omitempty"`

	// Gets or sets the operation name.
	Name *string `json:"name,omitempty"`

	// Gets or sets the operation start time.
	StartTime *time.Time `json:"startTime,omitempty"`
}

OperationResult - Operation result payload which is exposed in the response of the resource provider.

func (*OperationResult) UnmarshalJSON 

func (o *OperationResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationResult.

type OperationsClient 

type OperationsClient struct {
	// contains filtered or unexported fields
}

OperationsClient contains the methods for the Operations group. Don't use this type directly, use NewOperationsClient() instead.

func NewOperationsClient 

func NewOperationsClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*OperationsClient, error)

NewOperationsClient creates a new instance of OperationsClient with the specified values. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*OperationsClient) NewListPager added in v0.4.0 

func (client *OperationsClient) NewListPager(options *OperationsClientListOptions) *runtime.Pager[OperationsClientListResponse]

NewListPager - Lists the available operations of Microsoft.Blockchain resource provider. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2018-06-01-preview options - OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/blockchain/resource-manager/Microsoft.Blockchain/preview/2018-06-01-preview/examples/Operations_List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/blockchain/armblockchain"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armblockchain.NewOperationsClient(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListPager(nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

type OperationsClientListOptions added in v0.2.0 

type OperationsClientListOptions struct {
}

OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

type OperationsClientListResponse added in v0.2.0 

type OperationsClientListResponse struct {
	ResourceProviderOperationCollection
}

OperationsClientListResponse contains the response from method OperationsClient.List.

type Resource 

type Resource struct {
	// READ-ONLY; Fully qualified resource Id of the resource.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the service - e.g. "Microsoft.Blockchain"
	Type *string `json:"type,omitempty" azure:"ro"`
}

Resource - The core properties of the resources.

type ResourceProviderOperation 

type ResourceProviderOperation struct {
	// Gets or sets operation display
	Display *ResourceProviderOperationDisplay `json:"display,omitempty"`

	// Gets or sets a value indicating whether the operation is a data action or not.
	IsDataAction *bool `json:"isDataAction,omitempty"`

	// Gets or sets the operation name.
	Name *string `json:"name,omitempty"`

	// Gets or sets the origin.
	Origin *string `json:"origin,omitempty"`
}

ResourceProviderOperation - Operation payload which is exposed in the response of the resource provider.

type ResourceProviderOperationCollection 

type ResourceProviderOperationCollection struct {
	// Gets or sets the URL, that the client should use to fetch the next page (per server side paging). It's null for now, added
	// for future use.
	NextLink *string `json:"nextLink,omitempty"`

	// Gets or sets the collection of operations.
	Value []*ResourceProviderOperation `json:"value,omitempty"`
}

ResourceProviderOperationCollection - Collection of operation payload which is exposed in the response of the resource provider.

type ResourceProviderOperationDisplay 

type ResourceProviderOperationDisplay struct {
	// Gets or sets the description of the provider for display purposes.
	Description *string `json:"description,omitempty"`

	// Gets or sets the name of the operation for display purposes.
	Operation *string `json:"operation,omitempty"`

	// Gets or sets the name of the provider for display purposes.
	Provider *string `json:"provider,omitempty"`

	// Gets or sets the name of the resource type for display purposes.
	Resource *string `json:"resource,omitempty"`
}

ResourceProviderOperationDisplay - Operation display payload which is exposed in the response of the resource provider.

type ResourceTypeSKU 

type ResourceTypeSKU struct {
	// Gets or sets the resource type
	ResourceType *string `json:"resourceType,omitempty"`

	// Gets or sets the Skus
	SKUs []*SKUSetting `json:"skus,omitempty"`
}

ResourceTypeSKU - Resource type Sku.

type ResourceTypeSKUCollection 

type ResourceTypeSKUCollection struct {
	// Gets or sets the collection of resource type Sku.
	Value []*ResourceTypeSKU `json:"value,omitempty"`
}

ResourceTypeSKUCollection - Collection of the resource type Sku.

type SKU 

type SKU struct {
	// Gets or sets Sku name
	Name *string `json:"name,omitempty"`

	// Gets or sets Sku tier
	Tier *string `json:"tier,omitempty"`
}

SKU - Blockchain member Sku in payload

type SKUSetting 

type SKUSetting struct {
	// Gets or sets the locations.
	Locations []*string `json:"locations,omitempty"`

	// Gets or sets the Sku name.
	Name *string `json:"name,omitempty"`

	// Gets or sets the required features.
	RequiredFeatures []*string `json:"requiredFeatures,omitempty"`

	// Gets or sets the Sku tier.
	Tier *string `json:"tier,omitempty"`
}

SKUSetting - Sku Setting.

type SKUsClient 

type SKUsClient struct {
	// contains filtered or unexported fields
}

SKUsClient contains the methods for the SKUs group. Don't use this type directly, use NewSKUsClient() instead.

func NewSKUsClient 

func NewSKUsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SKUsClient, error)

NewSKUsClient creates a new instance of SKUsClient with the specified values. subscriptionID - Gets the subscription Id which uniquely identifies the Microsoft Azure subscription. The subscription ID is part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*SKUsClient) List 

func (client *SKUsClient) List(ctx context.Context, options *SKUsClientListOptions) (SKUsClientListResponse, error)

List - Lists the Skus of the resource type. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2018-06-01-preview options - SKUsClientListOptions contains the optional parameters for the SKUsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/blockchain/resource-manager/Microsoft.Blockchain/preview/2018-06-01-preview/examples/Skus_List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/blockchain/armblockchain"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armblockchain.NewSKUsClient("51766542-3ed7-4a72-a187-0c8ab644ddab", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.List(ctx,
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

type SKUsClientListOptions added in v0.2.0 

type SKUsClientListOptions struct {
}

SKUsClientListOptions contains the optional parameters for the SKUsClient.List method.

type SKUsClientListResponse added in v0.2.0 

type SKUsClientListResponse struct {
	ResourceTypeSKUCollection
}

SKUsClientListResponse contains the response from method SKUsClient.List.

type TrackedResource 

type TrackedResource struct {
	// The GEO location of the blockchain service.
	Location *string `json:"location,omitempty"`

	// Tags of the service which is a list of key value pairs that describes the resource.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified resource Id of the resource.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the service - e.g. "Microsoft.Blockchain"
	Type *string `json:"type,omitempty" azure:"ro"`
}

TrackedResource - The resource model definition for a top level resource.

func (TrackedResource) MarshalJSON 

func (t TrackedResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TrackedResource.

type TransactionNode 

type TransactionNode struct {
	// Gets or sets the transaction node location.
	Location *string `json:"location,omitempty"`

	// Gets or sets the blockchain member properties.
	Properties *TransactionNodeProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource Id of the resource.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the service - e.g. "Microsoft.Blockchain"
	Type *string `json:"type,omitempty" azure:"ro"`
}

TransactionNode - Payload of the transaction node which is the request/response of the resource provider.

type TransactionNodeCollection 

type TransactionNodeCollection struct {
	// Gets or sets the URL, that the client should use to fetch the next page (per server side paging). It's null for now, added
	// for future use.
	NextLink *string `json:"nextLink,omitempty"`

	// Gets or sets the collection of transaction nodes.
	Value []*TransactionNode `json:"value,omitempty"`
}

TransactionNodeCollection - Collection of transaction node payload which is exposed in the request/response of the resource provider.

type TransactionNodeProperties 

type TransactionNodeProperties struct {
	// Gets or sets the firewall rules.
	FirewallRules []*FirewallRule `json:"firewallRules,omitempty"`

	// Sets the transaction node dns endpoint basic auth password.
	Password *string `json:"password,omitempty"`

	// READ-ONLY; Gets or sets the transaction node dns endpoint.
	DNS *string `json:"dns,omitempty" azure:"ro"`

	// READ-ONLY; Gets or sets the blockchain member provision state.
	ProvisioningState *NodeProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; Gets or sets the transaction node public key.
	PublicKey *string `json:"publicKey,omitempty" azure:"ro"`

	// READ-ONLY; Gets or sets the transaction node dns endpoint basic auth user name.
	UserName *string `json:"userName,omitempty" azure:"ro"`
}

TransactionNodeProperties - Payload of transaction node properties payload in the transaction node payload.

func (TransactionNodeProperties) MarshalJSON 

func (t TransactionNodeProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TransactionNodeProperties.

type TransactionNodePropertiesUpdate 

type TransactionNodePropertiesUpdate struct {
	// Gets or sets the firewall rules.
	FirewallRules []*FirewallRule `json:"firewallRules,omitempty"`

	// Sets the transaction node dns endpoint basic auth password.
	Password *string `json:"password,omitempty"`
}

TransactionNodePropertiesUpdate - Update the payload of the transaction node properties in the transaction node payload.

func (TransactionNodePropertiesUpdate) MarshalJSON 

func (t TransactionNodePropertiesUpdate) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TransactionNodePropertiesUpdate.

type TransactionNodeUpdate 

type TransactionNodeUpdate struct {
	// Gets or sets the transaction node update properties.
	Properties *TransactionNodePropertiesUpdate `json:"properties,omitempty"`
}

TransactionNodeUpdate - Update the transaction node payload which is exposed in the request/response of the resource provider.

func (TransactionNodeUpdate) MarshalJSON 

func (t TransactionNodeUpdate) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TransactionNodeUpdate.

type TransactionNodesClient 

type TransactionNodesClient struct {
	// contains filtered or unexported fields
}

TransactionNodesClient contains the methods for the TransactionNodes group. Don't use this type directly, use NewTransactionNodesClient() instead.

func NewTransactionNodesClient 

func NewTransactionNodesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*TransactionNodesClient, error)

NewTransactionNodesClient creates a new instance of TransactionNodesClient with the specified values. subscriptionID - Gets the subscription Id which uniquely identifies the Microsoft Azure subscription. The subscription ID is part of the URI for every service call. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*TransactionNodesClient) BeginCreate 

func (client *TransactionNodesClient) BeginCreate(ctx context.Context, blockchainMemberName string, transactionNodeName string, resourceGroupName string, options *TransactionNodesClientBeginCreateOptions) (*runtime.Poller[TransactionNodesClientCreateResponse], error)

BeginCreate - Create or update the transaction node. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2018-06-01-preview blockchainMemberName - Blockchain member name. transactionNodeName - Transaction node name. resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. options - TransactionNodesClientBeginCreateOptions contains the optional parameters for the TransactionNodesClient.BeginCreate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/blockchain/resource-manager/Microsoft.Blockchain/preview/2018-06-01-preview/examples/TransactionNodes_Create.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/blockchain/armblockchain"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armblockchain.NewTransactionNodesClient("51766542-3ed7-4a72-a187-0c8ab644ddab", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginCreate(ctx,
		"contosemember1",
		"txnode2",
		"mygroup",
		&armblockchain.TransactionNodesClientBeginCreateOptions{TransactionNode: &armblockchain.TransactionNode{
			Location: to.Ptr("southeastasia"),
			Properties: &armblockchain.TransactionNodeProperties{
				Password: to.Ptr("<password>"),
			},
		},
		})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*TransactionNodesClient) BeginDelete 

func (client *TransactionNodesClient) BeginDelete(ctx context.Context, blockchainMemberName string, transactionNodeName string, resourceGroupName string, options *TransactionNodesClientBeginDeleteOptions) (*runtime.Poller[TransactionNodesClientDeleteResponse], error)

BeginDelete - Delete the transaction node. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2018-06-01-preview blockchainMemberName - Blockchain member name. transactionNodeName - Transaction node name. resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. options - TransactionNodesClientBeginDeleteOptions contains the optional parameters for the TransactionNodesClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/blockchain/resource-manager/Microsoft.Blockchain/preview/2018-06-01-preview/examples/TransactionNodes_Delete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/blockchain/armblockchain"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armblockchain.NewTransactionNodesClient("51766542-3ed7-4a72-a187-0c8ab644ddab", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginDelete(ctx,
		"contosemember1",
		"txNode2",
		"mygroup",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

Output:

func (*TransactionNodesClient) Get 

func (client *TransactionNodesClient) Get(ctx context.Context, blockchainMemberName string, transactionNodeName string, resourceGroupName string, options *TransactionNodesClientGetOptions) (TransactionNodesClientGetResponse, error)

Get - Get the details of the transaction node. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2018-06-01-preview blockchainMemberName - Blockchain member name. transactionNodeName - Transaction node name. resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. options - TransactionNodesClientGetOptions contains the optional parameters for the TransactionNodesClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/blockchain/resource-manager/Microsoft.Blockchain/preview/2018-06-01-preview/examples/TransactionNodes_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/blockchain/armblockchain"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armblockchain.NewTransactionNodesClient("51766542-3ed7-4a72-a187-0c8ab644ddab", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"contosemember1",
		"txnode2",
		"mygroup",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

func (*TransactionNodesClient) ListAPIKeys 

func (client *TransactionNodesClient) ListAPIKeys(ctx context.Context, blockchainMemberName string, transactionNodeName string, resourceGroupName string, options *TransactionNodesClientListAPIKeysOptions) (TransactionNodesClientListAPIKeysResponse, error)

ListAPIKeys - List the API keys for the transaction node. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2018-06-01-preview blockchainMemberName - Blockchain member name. transactionNodeName - Transaction node name. resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. options - TransactionNodesClientListAPIKeysOptions contains the optional parameters for the TransactionNodesClient.ListAPIKeys method.

func (*TransactionNodesClient) ListRegenerateAPIKeys 

func (client *TransactionNodesClient) ListRegenerateAPIKeys(ctx context.Context, blockchainMemberName string, transactionNodeName string, resourceGroupName string, options *TransactionNodesClientListRegenerateAPIKeysOptions) (TransactionNodesClientListRegenerateAPIKeysResponse, error)

ListRegenerateAPIKeys - Regenerate the API keys for the blockchain member. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2018-06-01-preview blockchainMemberName - Blockchain member name. transactionNodeName - Transaction node name. resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. options - TransactionNodesClientListRegenerateAPIKeysOptions contains the optional parameters for the TransactionNodesClient.ListRegenerateAPIKeys method.

func (*TransactionNodesClient) NewListPager added in v0.4.0 

func (client *TransactionNodesClient) NewListPager(blockchainMemberName string, resourceGroupName string, options *TransactionNodesClientListOptions) *runtime.Pager[TransactionNodesClientListResponse]

NewListPager - Lists the transaction nodes for a blockchain member. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2018-06-01-preview blockchainMemberName - Blockchain member name. resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. options - TransactionNodesClientListOptions contains the optional parameters for the TransactionNodesClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/blockchain/resource-manager/Microsoft.Blockchain/preview/2018-06-01-preview/examples/TransactionNodes_List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/blockchain/armblockchain"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armblockchain.NewTransactionNodesClient("51766542-3ed7-4a72-a187-0c8ab644ddab", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListPager("contosemember1",
		"mygroup",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Output:

func (*TransactionNodesClient) Update 

func (client *TransactionNodesClient) Update(ctx context.Context, blockchainMemberName string, transactionNodeName string, resourceGroupName string, options *TransactionNodesClientUpdateOptions) (TransactionNodesClientUpdateResponse, error)

Update - Update the transaction node. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2018-06-01-preview blockchainMemberName - Blockchain member name. transactionNodeName - Transaction node name. resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. options - TransactionNodesClientUpdateOptions contains the optional parameters for the TransactionNodesClient.Update method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/blockchain/resource-manager/Microsoft.Blockchain/preview/2018-06-01-preview/examples/TransactionNodes_Update.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/blockchain/armblockchain"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armblockchain.NewTransactionNodesClient("51766542-3ed7-4a72-a187-0c8ab644ddab", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Update(ctx,
		"contosemember1",
		"txnode2",
		"mygroup",
		&armblockchain.TransactionNodesClientUpdateOptions{TransactionNode: &armblockchain.TransactionNodeUpdate{
			Properties: &armblockchain.TransactionNodePropertiesUpdate{
				Password: to.Ptr("<password>"),
			},
		},
		})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Output:

type TransactionNodesClientBeginCreateOptions added in v0.2.0 

type TransactionNodesClientBeginCreateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
	// Payload to create the transaction node.
	TransactionNode *TransactionNode
}

TransactionNodesClientBeginCreateOptions contains the optional parameters for the TransactionNodesClient.BeginCreate method.

type TransactionNodesClientBeginDeleteOptions added in v0.2.0 

type TransactionNodesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

TransactionNodesClientBeginDeleteOptions contains the optional parameters for the TransactionNodesClient.BeginDelete method.

type TransactionNodesClientCreateResponse added in v0.2.0 

type TransactionNodesClientCreateResponse struct {
	TransactionNode
}

TransactionNodesClientCreateResponse contains the response from method TransactionNodesClient.Create.

type TransactionNodesClientDeleteResponse added in v0.2.0 

type TransactionNodesClientDeleteResponse struct {
}

TransactionNodesClientDeleteResponse contains the response from method TransactionNodesClient.Delete.

type TransactionNodesClientGetOptions added in v0.2.0 

type TransactionNodesClientGetOptions struct {
}

TransactionNodesClientGetOptions contains the optional parameters for the TransactionNodesClient.Get method.

type TransactionNodesClientGetResponse added in v0.2.0 

type TransactionNodesClientGetResponse struct {
	TransactionNode
}

TransactionNodesClientGetResponse contains the response from method TransactionNodesClient.Get.

type TransactionNodesClientListAPIKeysOptions added in v0.2.0 

type TransactionNodesClientListAPIKeysOptions struct {
}

TransactionNodesClientListAPIKeysOptions contains the optional parameters for the TransactionNodesClient.ListAPIKeys method.

type TransactionNodesClientListAPIKeysResponse added in v0.2.0 

type TransactionNodesClientListAPIKeysResponse struct {
	APIKeyCollection
}

TransactionNodesClientListAPIKeysResponse contains the response from method TransactionNodesClient.ListAPIKeys.

type TransactionNodesClientListOptions added in v0.2.0 

type TransactionNodesClientListOptions struct {
}

TransactionNodesClientListOptions contains the optional parameters for the TransactionNodesClient.List method.

type TransactionNodesClientListRegenerateAPIKeysOptions added in v0.2.0 

type TransactionNodesClientListRegenerateAPIKeysOptions struct {
	// api key to be regenerated
	APIKey *APIKey
}

TransactionNodesClientListRegenerateAPIKeysOptions contains the optional parameters for the TransactionNodesClient.ListRegenerateAPIKeys method.

type TransactionNodesClientListRegenerateAPIKeysResponse added in v0.2.0 

type TransactionNodesClientListRegenerateAPIKeysResponse struct {
	APIKeyCollection
}

TransactionNodesClientListRegenerateAPIKeysResponse contains the response from method TransactionNodesClient.ListRegenerateAPIKeys.

type TransactionNodesClientListResponse added in v0.2.0 

type TransactionNodesClientListResponse struct {
	TransactionNodeCollection
}

TransactionNodesClientListResponse contains the response from method TransactionNodesClient.List.

type TransactionNodesClientUpdateOptions added in v0.2.0 

type TransactionNodesClientUpdateOptions struct {
	// Payload to create the transaction node.
	TransactionNode *TransactionNodeUpdate
}

TransactionNodesClientUpdateOptions contains the optional parameters for the TransactionNodesClient.Update method.

type TransactionNodesClientUpdateResponse added in v0.2.0 

type TransactionNodesClientUpdateResponse struct {
	TransactionNode
}

TransactionNodesClientUpdateResponse contains the response from method TransactionNodesClient.Update.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.