organizations

package
v0.20240920.1135249 Latest Latest
Warning

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

 Go to latest Published: Sep 20, 2024 License: MPL-2.0 Imports: 14 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/informatica/2024-05-08/organizations Documentation

The organizations SDK allows for interaction with Azure Resource Manager informatica (API Version 2024-05-08).

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/informatica/2024-05-08/organizations"

Client Initialization

client := organizations.NewOrganizationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: OrganizationsClient.CreateOrUpdate

ctx := context.TODO()
id := organizations.NewOrganizationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "organizationName")

payload := organizations.InformaticaOrganizationResource{
	// ...
}


if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: OrganizationsClient.Delete

ctx := context.TODO()
id := organizations.NewOrganizationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "organizationName")

if err := client.DeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: OrganizationsClient.Get

ctx := context.TODO()
id := organizations.NewOrganizationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "organizationName")

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

Example Usage: OrganizationsClient.GetAllServerlessRuntimes

ctx := context.TODO()
id := organizations.NewOrganizationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "organizationName")

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

Example Usage: OrganizationsClient.GetServerlessMetadata

ctx := context.TODO()
id := organizations.NewOrganizationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "organizationName")

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

Example Usage: OrganizationsClient.ListByResourceGroup

ctx := context.TODO()
id := commonids.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group")

// alternatively `client.ListByResourceGroup(ctx, id)` can be used to do batched pagination
items, err := client.ListByResourceGroupComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: OrganizationsClient.ListBySubscription

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

// alternatively `client.ListBySubscription(ctx, id)` can be used to do batched pagination
items, err := client.ListBySubscriptionComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: OrganizationsClient.Update

ctx := context.TODO()
id := organizations.NewOrganizationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "organizationName")

payload := organizations.InformaticaOrganizationResourceUpdate{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForPlatformType 

func PossibleValuesForPlatformType() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func PossibleValuesForRuntimeType 

func PossibleValuesForRuntimeType() []string

func ValidateOrganizationID 

func ValidateOrganizationID(input interface{}, key string) (warnings []string, errors []error)

ValidateOrganizationID checks that 'input' can be parsed as a Organization ID

Types

type ApplicationConfigs 

type ApplicationConfigs struct {
	Customized   string `json:"customized"`
	DefaultValue string `json:"defaultValue"`
	Name         string `json:"name"`
	Platform     string `json:"platform"`
	Type         string `json:"type"`
	Value        string `json:"value"`
}

type ApplicationTypeMetadata 

type ApplicationTypeMetadata struct {
	Name  *string `json:"name,omitempty"`
	Value *string `json:"value,omitempty"`
}

type CdiConfigProps 

type CdiConfigProps struct {
	ApplicationConfigs []ApplicationConfigs `json:"applicationConfigs"`
	EngineName         string               `json:"engineName"`
	EngineVersion      string               `json:"engineVersion"`
}

type CompanyDetails 

type CompanyDetails struct {
	Business          *string `json:"business,omitempty"`
	CompanyName       *string `json:"companyName,omitempty"`
	Country           *string `json:"country,omitempty"`
	Domain            *string `json:"domain,omitempty"`
	NumberOfEmployees *int64  `json:"numberOfEmployees,omitempty"`
	OfficeAddress     *string `json:"officeAddress,omitempty"`
}

type CompanyDetailsUpdate 

type CompanyDetailsUpdate struct {
	Business          *string `json:"business,omitempty"`
	CompanyName       *string `json:"companyName,omitempty"`
	Country           *string `json:"country,omitempty"`
	Domain            *string `json:"domain,omitempty"`
	NumberOfEmployees *int64  `json:"numberOfEmployees,omitempty"`
	OfficeAddress     *string `json:"officeAddress,omitempty"`
}

type ComputeUnitsMetadata 

type ComputeUnitsMetadata struct {
	Name  *string   `json:"name,omitempty"`
	Value *[]string `json:"value,omitempty"`
}

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *InformaticaOrganizationResource
}

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetAllServerlessRuntimesOperationResponse 

type GetAllServerlessRuntimesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *InformaticaServerlessRuntimeResourceList
}

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *InformaticaOrganizationResource
}

type GetServerlessMetadataOperationResponse 

type GetServerlessMetadataOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ServerlessMetadataResponse
}

type InfaRuntimeResourceFetchMetaData 

type InfaRuntimeResourceFetchMetaData struct {
	CreatedBy                  string                              `json:"createdBy"`
	CreatedTime                string                              `json:"createdTime"`
	Description                *string                             `json:"description,omitempty"`
	Id                         string                              `json:"id"`
	Name                       string                              `json:"name"`
	ServerlessConfigProperties InfaServerlessFetchConfigProperties `json:"serverlessConfigProperties"`
	Status                     string                              `json:"status"`
	StatusLocalized            string                              `json:"statusLocalized"`
	StatusMessage              string                              `json:"statusMessage"`
	Type                       RuntimeType                         `json:"type"`
	UpdatedBy                  string                              `json:"updatedBy"`
	UpdatedTime                string                              `json:"updatedTime"`
}

type InfaServerlessFetchConfigProperties 

type InfaServerlessFetchConfigProperties struct {
	AdvancedCustomProperties  *string `json:"advancedCustomProperties,omitempty"`
	ApplicationType           *string `json:"applicationType,omitempty"`
	ComputeUnits              *string `json:"computeUnits,omitempty"`
	ExecutionTimeout          *string `json:"executionTimeout,omitempty"`
	Platform                  *string `json:"platform,omitempty"`
	Region                    *string `json:"region,omitempty"`
	ResourceGroupName         *string `json:"resourceGroupName,omitempty"`
	ServerlessArmResourceId   *string `json:"serverlessArmResourceId,omitempty"`
	Subnet                    *string `json:"subnet,omitempty"`
	SubscriptionId            *string `json:"subscriptionId,omitempty"`
	SupplementaryFileLocation *string `json:"supplementaryFileLocation,omitempty"`
	Tags                      *string `json:"tags,omitempty"`
	TenantId                  *string `json:"tenantId,omitempty"`
	Vnet                      *string `json:"vnet,omitempty"`
}

type InformaticaOrganizationResource 

type InformaticaOrganizationResource struct {
	Id         *string                 `json:"id,omitempty"`
	Location   string                  `json:"location"`
	Name       *string                 `json:"name,omitempty"`
	Properties *OrganizationProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData  `json:"systemData,omitempty"`
	Tags       *map[string]string      `json:"tags,omitempty"`
	Type       *string                 `json:"type,omitempty"`
}

type InformaticaOrganizationResourceOperationPredicate 

type InformaticaOrganizationResourceOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (InformaticaOrganizationResourceOperationPredicate) Matches 

func (p InformaticaOrganizationResourceOperationPredicate) Matches(input InformaticaOrganizationResource) bool

type InformaticaOrganizationResourceUpdate 

type InformaticaOrganizationResourceUpdate struct {
	Properties *OrganizationPropertiesCustomUpdate `json:"properties,omitempty"`
	Tags       *map[string]string                  `json:"tags,omitempty"`
}

type InformaticaProperties 

type InformaticaProperties struct {
	InformaticaRegion *string `json:"informaticaRegion,omitempty"`
	OrganizationId    *string `json:"organizationId,omitempty"`
	OrganizationName  *string `json:"organizationName,omitempty"`
	SingleSignOnUrl   *string `json:"singleSignOnUrl,omitempty"`
}

type InformaticaServerlessRuntimeResourceList 

type InformaticaServerlessRuntimeResourceList struct {
	InformaticaRuntimeResources []InfaRuntimeResourceFetchMetaData `json:"informaticaRuntimeResources"`
}

type LinkOrganization 

type LinkOrganization struct {
	Token *string `json:"token,omitempty"`
}

type ListByResourceGroupCompleteResult 

type ListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []InformaticaOrganizationResource
}

type ListByResourceGroupCustomPager 

type ListByResourceGroupCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByResourceGroupCustomPager) NextPageLink() *odata.Link

type ListByResourceGroupOperationResponse 

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]InformaticaOrganizationResource
}

type ListBySubscriptionCompleteResult 

type ListBySubscriptionCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []InformaticaOrganizationResource
}

type ListBySubscriptionCustomPager 

type ListBySubscriptionCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListBySubscriptionCustomPager) NextPageLink() *odata.Link

type ListBySubscriptionOperationResponse 

type ListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]InformaticaOrganizationResource
}

type MarketplaceDetails 

type MarketplaceDetails struct {
	MarketplaceSubscriptionId *string      `json:"marketplaceSubscriptionId,omitempty"`
	OfferDetails              OfferDetails `json:"offerDetails"`
}

type MarketplaceDetailsUpdate 

type MarketplaceDetailsUpdate struct {
	MarketplaceSubscriptionId *string             `json:"marketplaceSubscriptionId,omitempty"`
	OfferDetails              *OfferDetailsUpdate `json:"offerDetails,omitempty"`
}

type OfferDetails 

type OfferDetails struct {
	OfferId     string  `json:"offerId"`
	PlanId      string  `json:"planId"`
	PlanName    string  `json:"planName"`
	PublisherId string  `json:"publisherId"`
	TermId      string  `json:"termId"`
	TermUnit    *string `json:"termUnit,omitempty"`
}

type OfferDetailsUpdate 

type OfferDetailsUpdate struct {
	OfferId     *string `json:"offerId,omitempty"`
	PlanId      *string `json:"planId,omitempty"`
	PlanName    *string `json:"planName,omitempty"`
	PublisherId *string `json:"publisherId,omitempty"`
	TermId      *string `json:"termId,omitempty"`
	TermUnit    *string `json:"termUnit,omitempty"`
}

type OrganizationId 

type OrganizationId struct {
	SubscriptionId    string
	ResourceGroupName string
	OrganizationName  string
}

OrganizationId is a struct representing the Resource ID for a Organization

func NewOrganizationID 

func NewOrganizationID(subscriptionId string, resourceGroupName string, organizationName string) OrganizationId

NewOrganizationID returns a new OrganizationId struct

func ParseOrganizationID 

func ParseOrganizationID(input string) (*OrganizationId, error)

ParseOrganizationID parses 'input' into a OrganizationId

func ParseOrganizationIDInsensitively 

func ParseOrganizationIDInsensitively(input string) (*OrganizationId, error)

ParseOrganizationIDInsensitively parses 'input' case-insensitively into a OrganizationId note: this method should only be used for API response data and not user input

func (*OrganizationId) FromParseResult 

func (id *OrganizationId) FromParseResult(input resourceids.ParseResult) error

func (OrganizationId) ID 

func (id OrganizationId) ID() string

ID returns the formatted Organization ID

func (OrganizationId) Segments 

func (id OrganizationId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Organization ID

func (OrganizationId) String 

func (id OrganizationId) String() string

String returns a human-readable description of this Organization ID

type OrganizationProperties 

type OrganizationProperties struct {
	CompanyDetails        *CompanyDetails        `json:"companyDetails,omitempty"`
	InformaticaProperties *InformaticaProperties `json:"informaticaProperties,omitempty"`
	LinkOrganization      *LinkOrganization      `json:"linkOrganization,omitempty"`
	MarketplaceDetails    *MarketplaceDetails    `json:"marketplaceDetails,omitempty"`
	ProvisioningState     *ProvisioningState     `json:"provisioningState,omitempty"`
	UserDetails           *UserDetails           `json:"userDetails,omitempty"`
}

type OrganizationPropertiesCustomUpdate 

type OrganizationPropertiesCustomUpdate struct {
	CompanyDetails                    *CompanyDetailsUpdate                  `json:"companyDetails,omitempty"`
	ExistingResourceId                *string                                `json:"existingResourceId,omitempty"`
	InformaticaOrganizationProperties *InformaticaOrganizationResourceUpdate `json:"informaticaOrganizationProperties,omitempty"`
	MarketplaceDetails                *MarketplaceDetailsUpdate              `json:"marketplaceDetails,omitempty"`
	UserDetails                       *UserDetailsUpdate                     `json:"userDetails,omitempty"`
}

type OrganizationsClient 

type OrganizationsClient struct {
	Client *resourcemanager.Client
}

func NewOrganizationsClientWithBaseURI 

func NewOrganizationsClientWithBaseURI(sdkApi sdkEnv.Api) (*OrganizationsClient, error)

func (OrganizationsClient) CreateOrUpdate 

func (c OrganizationsClient) CreateOrUpdate(ctx context.Context, id OrganizationId, input InformaticaOrganizationResource) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (OrganizationsClient) CreateOrUpdateThenPoll 

func (c OrganizationsClient) CreateOrUpdateThenPoll(ctx context.Context, id OrganizationId, input InformaticaOrganizationResource) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (OrganizationsClient) Delete 

func (c OrganizationsClient) Delete(ctx context.Context, id OrganizationId) (result DeleteOperationResponse, err error)

Delete ...

func (OrganizationsClient) DeleteThenPoll 

func (c OrganizationsClient) DeleteThenPoll(ctx context.Context, id OrganizationId) error

DeleteThenPoll performs Delete then polls until it's completed

func (OrganizationsClient) Get 

func (c OrganizationsClient) Get(ctx context.Context, id OrganizationId) (result GetOperationResponse, err error)

Get ...

func (OrganizationsClient) GetAllServerlessRuntimes 

func (c OrganizationsClient) GetAllServerlessRuntimes(ctx context.Context, id OrganizationId) (result GetAllServerlessRuntimesOperationResponse, err error)

GetAllServerlessRuntimes ...

func (OrganizationsClient) GetServerlessMetadata 

func (c OrganizationsClient) GetServerlessMetadata(ctx context.Context, id OrganizationId) (result GetServerlessMetadataOperationResponse, err error)

GetServerlessMetadata ...

func (OrganizationsClient) ListByResourceGroup 

func (c OrganizationsClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)

ListByResourceGroup ...

func (OrganizationsClient) ListByResourceGroupComplete 

func (c OrganizationsClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ListByResourceGroupCompleteResult, error)

ListByResourceGroupComplete retrieves all the results into a single object

func (OrganizationsClient) ListByResourceGroupCompleteMatchingPredicate 

func (c OrganizationsClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate InformaticaOrganizationResourceOperationPredicate) (result ListByResourceGroupCompleteResult, err error)

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (OrganizationsClient) ListBySubscription 

func (c OrganizationsClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId) (result ListBySubscriptionOperationResponse, err error)

ListBySubscription ...

func (OrganizationsClient) ListBySubscriptionComplete 

func (c OrganizationsClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (ListBySubscriptionCompleteResult, error)

ListBySubscriptionComplete retrieves all the results into a single object

func (OrganizationsClient) ListBySubscriptionCompleteMatchingPredicate 

func (c OrganizationsClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate InformaticaOrganizationResourceOperationPredicate) (result ListBySubscriptionCompleteResult, err error)

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (OrganizationsClient) Update 

func (c OrganizationsClient) Update(ctx context.Context, id OrganizationId, input InformaticaOrganizationResourceUpdate) (result UpdateOperationResponse, err error)

Update ...

type PlatformType 

type PlatformType string
const (
	PlatformTypeAZURE PlatformType = "AZURE"
)

func (*PlatformType) UnmarshalJSON 

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

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateAccepted     ProvisioningState = "Accepted"
	ProvisioningStateCanceled     ProvisioningState = "Canceled"
	ProvisioningStateCreating     ProvisioningState = "Creating"
	ProvisioningStateDeleted      ProvisioningState = "Deleted"
	ProvisioningStateDeleting     ProvisioningState = "Deleting"
	ProvisioningStateFailed       ProvisioningState = "Failed"
	ProvisioningStateNotSpecified ProvisioningState = "NotSpecified"
	ProvisioningStateSucceeded    ProvisioningState = "Succeeded"
	ProvisioningStateUpdating     ProvisioningState = "Updating"
)

func (*ProvisioningState) UnmarshalJSON 

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

type RegionsMetadata 

type RegionsMetadata struct {
	Id   *string `json:"id,omitempty"`
	Name *string `json:"name,omitempty"`
}

type RuntimeType 

type RuntimeType string
const (
	RuntimeTypeSERVERLESS RuntimeType = "SERVERLESS"
)

func (*RuntimeType) UnmarshalJSON 

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

type ServerlessConfigProperties 

type ServerlessConfigProperties struct {
	ApplicationTypes *[]ApplicationTypeMetadata `json:"applicationTypes,omitempty"`
	ComputeUnits     *[]ComputeUnitsMetadata    `json:"computeUnits,omitempty"`
	ExecutionTimeout *string                    `json:"executionTimeout,omitempty"`
	Platform         *PlatformType              `json:"platform,omitempty"`
	Regions          *[]RegionsMetadata         `json:"regions,omitempty"`
}

type ServerlessMetadataResponse 

type ServerlessMetadataResponse struct {
	ServerlessConfigProperties        *ServerlessConfigProperties        `json:"serverlessConfigProperties,omitempty"`
	ServerlessRuntimeConfigProperties *ServerlessRuntimeConfigProperties `json:"serverlessRuntimeConfigProperties,omitempty"`
	Type                              *RuntimeType                       `json:"type,omitempty"`
}

type ServerlessRuntimeConfigProperties 

type ServerlessRuntimeConfigProperties struct {
	CdiConfigProps  *[]CdiConfigProps `json:"cdiConfigProps,omitempty"`
	CdieConfigProps *[]CdiConfigProps `json:"cdieConfigProps,omitempty"`
}

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *InformaticaOrganizationResource
}

type UserDetails 

type UserDetails struct {
	EmailAddress *string `json:"emailAddress,omitempty"`
	FirstName    *string `json:"firstName,omitempty"`
	LastName     *string `json:"lastName,omitempty"`
	PhoneNumber  *string `json:"phoneNumber,omitempty"`
	Upn          *string `json:"upn,omitempty"`
}

type UserDetailsUpdate 

type UserDetailsUpdate struct {
	EmailAddress *string `json:"emailAddress,omitempty"`
	FirstName    *string `json:"firstName,omitempty"`
	LastName     *string `json:"lastName,omitempty"`
	PhoneNumber  *string `json:"phoneNumber,omitempty"`
	Upn          *string `json:"upn,omitempty"`
}

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.