oucontainer

package
v0.20240315.1103122 Latest Latest
Warning

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

 Go to latest Published: Mar 15, 2024 License: MPL-2.0 Imports: 11 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/aad/2021-05-01/oucontainer Documentation

The oucontainer SDK allows for interaction with the Azure Resource Manager Service aad (API Version 2021-05-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/aad/2021-05-01/oucontainer"

Client Initialization

client := oucontainer.NewOuContainerClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: OuContainerClient.Create

ctx := context.TODO()
id := oucontainer.NewOuContainerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "domainServiceValue", "ouContainerValue")

payload := oucontainer.ContainerAccount{
	// ...
}


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

Example Usage: OuContainerClient.Delete

ctx := context.TODO()
id := oucontainer.NewOuContainerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "domainServiceValue", "ouContainerValue")

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

Example Usage: OuContainerClient.Get

ctx := context.TODO()
id := oucontainer.NewOuContainerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "domainServiceValue", "ouContainerValue")

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: OuContainerClient.List

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

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

Example Usage: OuContainerClient.Update

ctx := context.TODO()
id := oucontainer.NewOuContainerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "domainServiceValue", "ouContainerValue")

payload := oucontainer.ContainerAccount{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ValidateDomainServiceID 

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

ValidateDomainServiceID checks that 'input' can be parsed as a Domain Service ID

func ValidateOuContainerID 

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

ValidateOuContainerID checks that 'input' can be parsed as a Ou Container ID

Types

type ContainerAccount 

type ContainerAccount struct {
	AccountName *string `json:"accountName,omitempty"`
	Password    *string `json:"password,omitempty"`
	Spn         *string `json:"spn,omitempty"`
}

type CreateOperationResponse 

type CreateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *OuContainer
}

type DeleteOperationResponse 

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

type DomainServiceId 

type DomainServiceId struct {
	SubscriptionId    string
	ResourceGroupName string
	DomainServiceName string
}

DomainServiceId is a struct representing the Resource ID for a Domain Service

func NewDomainServiceID 

func NewDomainServiceID(subscriptionId string, resourceGroupName string, domainServiceName string) DomainServiceId

NewDomainServiceID returns a new DomainServiceId struct

func ParseDomainServiceID 

func ParseDomainServiceID(input string) (*DomainServiceId, error)

ParseDomainServiceID parses 'input' into a DomainServiceId

func ParseDomainServiceIDInsensitively 

func ParseDomainServiceIDInsensitively(input string) (*DomainServiceId, error)

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

func (*DomainServiceId) FromParseResult 

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

func (DomainServiceId) ID 

func (id DomainServiceId) ID() string

ID returns the formatted Domain Service ID

func (DomainServiceId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Domain Service ID

func (DomainServiceId) String 

func (id DomainServiceId) String() string

String returns a human-readable description of this Domain Service ID

type GetOperationResponse 

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

type ListCompleteResult 

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []OuContainer
}

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]OuContainer
}

type OuContainer 

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

type OuContainerClient 

type OuContainerClient struct {
	Client *resourcemanager.Client
}

func NewOuContainerClientWithBaseURI 

func NewOuContainerClientWithBaseURI(sdkApi sdkEnv.Api) (*OuContainerClient, error)

func (OuContainerClient) Create 

func (c OuContainerClient) Create(ctx context.Context, id OuContainerId, input ContainerAccount) (result CreateOperationResponse, err error)

Create ...

func (OuContainerClient) CreateThenPoll 

func (c OuContainerClient) CreateThenPoll(ctx context.Context, id OuContainerId, input ContainerAccount) error

CreateThenPoll performs Create then polls until it's completed

func (OuContainerClient) Delete 

func (c OuContainerClient) Delete(ctx context.Context, id OuContainerId) (result DeleteOperationResponse, err error)

Delete ...

func (OuContainerClient) DeleteThenPoll 

func (c OuContainerClient) DeleteThenPoll(ctx context.Context, id OuContainerId) error

DeleteThenPoll performs Delete then polls until it's completed

func (OuContainerClient) Get 

func (c OuContainerClient) Get(ctx context.Context, id OuContainerId) (result GetOperationResponse, err error)

Get ...

func (OuContainerClient) List 

func (c OuContainerClient) List(ctx context.Context, id DomainServiceId) (result ListOperationResponse, err error)

List ...

func (OuContainerClient) ListComplete 

func (c OuContainerClient) ListComplete(ctx context.Context, id DomainServiceId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (OuContainerClient) ListCompleteMatchingPredicate 

func (c OuContainerClient) ListCompleteMatchingPredicate(ctx context.Context, id DomainServiceId, predicate OuContainerOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (OuContainerClient) Update 

func (c OuContainerClient) Update(ctx context.Context, id OuContainerId, input ContainerAccount) (result UpdateOperationResponse, err error)

Update ...

func (OuContainerClient) UpdateThenPoll 

func (c OuContainerClient) UpdateThenPoll(ctx context.Context, id OuContainerId, input ContainerAccount) error

UpdateThenPoll performs Update then polls until it's completed

type OuContainerId 

type OuContainerId struct {
	SubscriptionId    string
	ResourceGroupName string
	DomainServiceName string
	OuContainerName   string
}

OuContainerId is a struct representing the Resource ID for a Ou Container

func NewOuContainerID 

func NewOuContainerID(subscriptionId string, resourceGroupName string, domainServiceName string, ouContainerName string) OuContainerId

NewOuContainerID returns a new OuContainerId struct

func ParseOuContainerID 

func ParseOuContainerID(input string) (*OuContainerId, error)

ParseOuContainerID parses 'input' into a OuContainerId

func ParseOuContainerIDInsensitively 

func ParseOuContainerIDInsensitively(input string) (*OuContainerId, error)

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

func (*OuContainerId) FromParseResult 

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

func (OuContainerId) ID 

func (id OuContainerId) ID() string

ID returns the formatted Ou Container ID

func (OuContainerId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Ou Container ID

func (OuContainerId) String 

func (id OuContainerId) String() string

String returns a human-readable description of this Ou Container ID

type OuContainerOperationPredicate 

type OuContainerOperationPredicate struct {
	Etag     *string
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (OuContainerOperationPredicate) Matches 

func (p OuContainerOperationPredicate) Matches(input OuContainer) bool

type OuContainerProperties 

type OuContainerProperties struct {
	Accounts          *[]ContainerAccount `json:"accounts,omitempty"`
	ContainerId       *string             `json:"containerId,omitempty"`
	DeploymentId      *string             `json:"deploymentId,omitempty"`
	DistinguishedName *string             `json:"distinguishedName,omitempty"`
	DomainName        *string             `json:"domainName,omitempty"`
	ProvisioningState *string             `json:"provisioningState,omitempty"`
	ServiceStatus     *string             `json:"serviceStatus,omitempty"`
	TenantId          *string             `json:"tenantId,omitempty"`
}

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *OuContainer
}

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.