databoundaries

README

github.com/hashicorp/go-azure-sdk/resource-manager/resources/2024-08-01/databoundaries Documentation

The databoundaries SDK allows for interaction with Azure Resource Manager resources (API Version 2024-08-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/resources/2024-08-01/databoundaries"

Client Initialization

client := databoundaries.NewDataBoundariesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DataBoundariesClient.GetScope

ctx := context.TODO()
id := commonids.NewScopeID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group")

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

Example Usage: DataBoundariesClient.GetTenant

ctx := context.TODO()


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

Example Usage: DataBoundariesClient.Put

ctx := context.TODO()

payload := databoundaries.DataBoundaryDefinition{
	// ...
}


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

Documentation

Index

• func PossibleValuesForDataBoundary() []string
• func PossibleValuesForProvisioningState() []string
• type DataBoundariesClient
  • func NewDataBoundariesClientWithBaseURI(sdkApi sdkEnv.Api) (*DataBoundariesClient, error)
  • func (c DataBoundariesClient) GetScope(ctx context.Context, id commonids.ScopeId) (result GetScopeOperationResponse, err error)
  • func (c DataBoundariesClient) GetTenant(ctx context.Context) (result GetTenantOperationResponse, err error)
  • func (c DataBoundariesClient) Put(ctx context.Context, input DataBoundaryDefinition) (result PutOperationResponse, err error)
• type DataBoundary
  • func (s *DataBoundary) UnmarshalJSON(bytes []byte) error
• type DataBoundaryDefinition
• type DataBoundaryProperties
• type GetScopeOperationResponse
• type GetTenantOperationResponse
• type ProvisioningState
  • func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error
• type PutOperationResponse

Functions

func PossibleValuesForDataBoundary

func PossibleValuesForDataBoundary() []string

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

Types

type DataBoundariesClient

type DataBoundariesClient struct {
	Client *resourcemanager.Client
}

func NewDataBoundariesClientWithBaseURI

func NewDataBoundariesClientWithBaseURI(sdkApi sdkEnv.Api) (*DataBoundariesClient, error)

func (DataBoundariesClient) GetScope

func (c DataBoundariesClient) GetScope(ctx context.Context, id commonids.ScopeId) (result GetScopeOperationResponse, err error)

GetScope ...

func (DataBoundariesClient) GetTenant

func (c DataBoundariesClient) GetTenant(ctx context.Context) (result GetTenantOperationResponse, err error)

GetTenant ...

func (DataBoundariesClient) Put

func (c DataBoundariesClient) Put(ctx context.Context, input DataBoundaryDefinition) (result PutOperationResponse, err error)

Put ...

type DataBoundary

type DataBoundary string

const (
	DataBoundaryEU         DataBoundary = "EU"
	DataBoundaryGlobal     DataBoundary = "Global"
	DataBoundaryNotDefined DataBoundary = "NotDefined"
)

func (*DataBoundary) UnmarshalJSON

func (s *DataBoundary) UnmarshalJSON(bytes []byte) error

type DataBoundaryDefinition

type DataBoundaryDefinition struct {
	Id         *string                 `json:"id,omitempty"`
	Name       *string                 `json:"name,omitempty"`
	Properties *DataBoundaryProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData  `json:"systemData,omitempty"`
	Type       *string                 `json:"type,omitempty"`
}

type DataBoundaryProperties

type DataBoundaryProperties struct {
	DataBoundary      *DataBoundary      `json:"dataBoundary,omitempty"`
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty"`
}

type GetScopeOperationResponse

type GetScopeOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DataBoundaryDefinition
}

type GetTenantOperationResponse

type GetTenantOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DataBoundaryDefinition
}

type ProvisioningState

type ProvisioningState string

const (
	ProvisioningStateAccepted  ProvisioningState = "Accepted"
	ProvisioningStateCanceled  ProvisioningState = "Canceled"
	ProvisioningStateCreating  ProvisioningState = "Creating"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateRunning   ProvisioningState = "Running"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
	ProvisioningStateUpdating  ProvisioningState = "Updating"
)

func (*ProvisioningState) UnmarshalJSON

func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error

type PutOperationResponse

type PutOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DataBoundaryDefinition
}