bicepclient

README

github.com/hashicorp/go-azure-sdk/resource-manager/resources/2023-11-01/bicepclient Documentation

The bicepclient SDK allows for interaction with the Azure Resource Manager Service resources (API Version 2023-11-01).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-sdk/resource-manager/resources/2023-11-01/bicepclient"

Client Initialization

client := bicepclient.NewBicepClientClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: BicepClientClient.DecompileBicep

ctx := context.TODO()
id := bicepclient.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

payload := bicepclient.DecompileOperationRequest{
	// ...
}


read, err := client.DecompileBicep(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Documentation

Index

• type BicepClientClient
  • func NewBicepClientClientWithBaseURI(sdkApi sdkEnv.Api) (*BicepClientClient, error)
  • func (c BicepClientClient) DecompileBicep(ctx context.Context, id commonids.SubscriptionId, ...) (result DecompileBicepOperationResponse, err error)
• type DecompileBicepOperationResponse
• type DecompileOperationRequest
• type DecompileOperationSuccessResponse
• type FileDefinition

Types

type BicepClientClient

type BicepClientClient struct {
	Client *resourcemanager.Client
}

func NewBicepClientClientWithBaseURI

func NewBicepClientClientWithBaseURI(sdkApi sdkEnv.Api) (*BicepClientClient, error)

func (BicepClientClient) DecompileBicep

func (c BicepClientClient) DecompileBicep(ctx context.Context, id commonids.SubscriptionId, input DecompileOperationRequest) (result DecompileBicepOperationResponse, err error)

DecompileBicep ...

type DecompileBicepOperationResponse

type DecompileBicepOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DecompileOperationSuccessResponse
}

type DecompileOperationRequest

type DecompileOperationRequest struct {
	Template string `json:"template"`
}

type DecompileOperationSuccessResponse

type DecompileOperationSuccessResponse struct {
	EntryPoint string           `json:"entryPoint"`
	Files      []FileDefinition `json:"files"`
}

type FileDefinition

type FileDefinition struct {
	Contents *string `json:"contents,omitempty"`
	Path     *string `json:"path,omitempty"`
}