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 ¶
- func ValidateDomainServiceID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateOuContainerID(input interface{}, key string) (warnings []string, errors []error)
- type ContainerAccount
- type CreateOperationResponse
- type DeleteOperationResponse
- type DomainServiceId
- type GetOperationResponse
- type ListCompleteResult
- type ListOperationResponse
- type OuContainer
- type OuContainerClient
- func (c OuContainerClient) Create(ctx context.Context, id OuContainerId, input ContainerAccount) (result CreateOperationResponse, err error)
- func (c OuContainerClient) CreateThenPoll(ctx context.Context, id OuContainerId, input ContainerAccount) error
- func (c OuContainerClient) Delete(ctx context.Context, id OuContainerId) (result DeleteOperationResponse, err error)
- func (c OuContainerClient) DeleteThenPoll(ctx context.Context, id OuContainerId) error
- func (c OuContainerClient) Get(ctx context.Context, id OuContainerId) (result GetOperationResponse, err error)
- func (c OuContainerClient) List(ctx context.Context, id DomainServiceId) (resp ListOperationResponse, err error)
- func (c OuContainerClient) ListComplete(ctx context.Context, id DomainServiceId) (ListCompleteResult, error)
- func (c OuContainerClient) ListCompleteMatchingPredicate(ctx context.Context, id DomainServiceId, ...) (resp ListCompleteResult, err error)
- func (c OuContainerClient) Update(ctx context.Context, id OuContainerId, input ContainerAccount) (result UpdateOperationResponse, err error)
- func (c OuContainerClient) UpdateThenPoll(ctx context.Context, id OuContainerId, input ContainerAccount) error
- type OuContainerId
- type OuContainerOperationPredicate
- type OuContainerProperties
- type UpdateOperationResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ValidateDomainServiceID ¶
ValidateDomainServiceID checks that 'input' can be parsed as a Domain Service ID
func ValidateOuContainerID ¶
ValidateOuContainerID checks that 'input' can be parsed as a Ou Container ID
Types ¶
type ContainerAccount ¶
type CreateOperationResponse ¶
type CreateOperationResponse struct { Poller polling.LongRunningPoller HttpResponse *http.Response }
type DeleteOperationResponse ¶
type DeleteOperationResponse struct { Poller polling.LongRunningPoller HttpResponse *http.Response }
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) 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 Model *OuContainer }
type ListCompleteResult ¶
type ListCompleteResult struct {
Items []OuContainer
}
type ListOperationResponse ¶
type ListOperationResponse struct { HttpResponse *http.Response Model *[]OuContainer // contains filtered or unexported fields }
func (ListOperationResponse) HasMore ¶
func (r ListOperationResponse) HasMore() bool
func (ListOperationResponse) LoadMore ¶
func (r ListOperationResponse) LoadMore(ctx context.Context) (resp ListOperationResponse, err error)
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 ¶
func NewOuContainerClientWithBaseURI ¶
func NewOuContainerClientWithBaseURI(endpoint string) OuContainerClient
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) (resp ListOperationResponse, err error)
List ...
func (OuContainerClient) ListComplete ¶
func (c OuContainerClient) ListComplete(ctx context.Context, id DomainServiceId) (ListCompleteResult, error)
ListComplete retrieves all of the results into a single object
func (OuContainerClient) ListCompleteMatchingPredicate ¶
func (c OuContainerClient) ListCompleteMatchingPredicate(ctx context.Context, id DomainServiceId, predicate OuContainerOperationPredicate) (resp ListCompleteResult, err error)
ListCompleteMatchingPredicate retrieves all of the results and then applied 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) 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 polling.LongRunningPoller HttpResponse *http.Response }