domainservices

package
v0.20240524.1090207 Latest Latest
Warning

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

 Go to latest Published: May 24, 2024 License: MPL-2.0 Imports: 16 Imported by: 1

README

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

The domainservices 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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/aad/2021-05-01/domainservices"

Client Initialization

client := domainservices.NewDomainServicesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DomainServicesClient.CreateOrUpdate

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

payload := domainservices.DomainService{
	// ...
}


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

Example Usage: DomainServicesClient.Delete

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

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

Example Usage: DomainServicesClient.Get

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

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

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

// 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: DomainServicesClient.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: DomainServicesClient.Update

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

payload := domainservices.DomainService{
	// ...
}


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 PossibleValuesForExternalAccess 

func PossibleValuesForExternalAccess() []string

func PossibleValuesForFilteredSync 

func PossibleValuesForFilteredSync() []string

func PossibleValuesForKerberosArmoring 

func PossibleValuesForKerberosArmoring() []string

func PossibleValuesForKerberosRc4Encryption 

func PossibleValuesForKerberosRc4Encryption() []string

func PossibleValuesForLdaps 

func PossibleValuesForLdaps() []string

func PossibleValuesForNotifyDcAdmins 

func PossibleValuesForNotifyDcAdmins() []string

func PossibleValuesForNotifyGlobalAdmins 

func PossibleValuesForNotifyGlobalAdmins() []string

func PossibleValuesForNtlmV1 

func PossibleValuesForNtlmV1() []string

func PossibleValuesForStatus 

func PossibleValuesForStatus() []string

func PossibleValuesForSyncKerberosPasswords 

func PossibleValuesForSyncKerberosPasswords() []string

func PossibleValuesForSyncNtlmPasswords 

func PossibleValuesForSyncNtlmPasswords() []string

func PossibleValuesForSyncOnPremPasswords 

func PossibleValuesForSyncOnPremPasswords() []string

func PossibleValuesForTlsV1 

func PossibleValuesForTlsV1() []string

func ValidateDomainServiceID 

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

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

Types

type ConfigDiagnostics 

type ConfigDiagnostics struct {
	LastExecuted     *string                             `json:"lastExecuted,omitempty"`
	ValidatorResults *[]ConfigDiagnosticsValidatorResult `json:"validatorResults,omitempty"`
}

type ConfigDiagnosticsValidatorResult 

type ConfigDiagnosticsValidatorResult struct {
	Issues                      *[]ConfigDiagnosticsValidatorResultIssue `json:"issues,omitempty"`
	ReplicaSetSubnetDisplayName *string                                  `json:"replicaSetSubnetDisplayName,omitempty"`
	Status                      *Status                                  `json:"status,omitempty"`
	ValidatorId                 *string                                  `json:"validatorId,omitempty"`
}

type ConfigDiagnosticsValidatorResultIssue 

type ConfigDiagnosticsValidatorResultIssue struct {
	DescriptionParams *[]string `json:"descriptionParams,omitempty"`
	Id                *string   `json:"id,omitempty"`
}

type CreateOrUpdateOperationResponse 

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

type DeleteOperationResponse 

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

type DomainSecuritySettings 

type DomainSecuritySettings struct {
	KerberosArmoring      *KerberosArmoring      `json:"kerberosArmoring,omitempty"`
	KerberosRc4Encryption *KerberosRc4Encryption `json:"kerberosRc4Encryption,omitempty"`
	NtlmV1                *NtlmV1                `json:"ntlmV1,omitempty"`
	SyncKerberosPasswords *SyncKerberosPasswords `json:"syncKerberosPasswords,omitempty"`
	SyncNtlmPasswords     *SyncNtlmPasswords     `json:"syncNtlmPasswords,omitempty"`
	SyncOnPremPasswords   *SyncOnPremPasswords   `json:"syncOnPremPasswords,omitempty"`
	TlsV1                 *TlsV1                 `json:"tlsV1,omitempty"`
}

type DomainService 

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

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 DomainServiceOperationPredicate 

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

func (DomainServiceOperationPredicate) Matches 

func (p DomainServiceOperationPredicate) Matches(input DomainService) bool

type DomainServiceProperties 

type DomainServiceProperties struct {
	ConfigDiagnostics       *ConfigDiagnostics      `json:"configDiagnostics,omitempty"`
	DeploymentId            *string                 `json:"deploymentId,omitempty"`
	DomainConfigurationType *string                 `json:"domainConfigurationType,omitempty"`
	DomainName              *string                 `json:"domainName,omitempty"`
	DomainSecuritySettings  *DomainSecuritySettings `json:"domainSecuritySettings,omitempty"`
	FilteredSync            *FilteredSync           `json:"filteredSync,omitempty"`
	LdapsSettings           *LdapsSettings          `json:"ldapsSettings,omitempty"`
	MigrationProperties     *MigrationProperties    `json:"migrationProperties,omitempty"`
	NotificationSettings    *NotificationSettings   `json:"notificationSettings,omitempty"`
	ProvisioningState       *string                 `json:"provisioningState,omitempty"`
	ReplicaSets             *[]ReplicaSet           `json:"replicaSets,omitempty"`
	ResourceForestSettings  *ResourceForestSettings `json:"resourceForestSettings,omitempty"`
	Sku                     *string                 `json:"sku,omitempty"`
	SyncOwner               *string                 `json:"syncOwner,omitempty"`
	TenantId                *string                 `json:"tenantId,omitempty"`
	Version                 *int64                  `json:"version,omitempty"`
}

type DomainServicesClient 

type DomainServicesClient struct {
	Client *resourcemanager.Client
}

func NewDomainServicesClientWithBaseURI 

func NewDomainServicesClientWithBaseURI(sdkApi sdkEnv.Api) (*DomainServicesClient, error)

func (DomainServicesClient) CreateOrUpdate 

func (c DomainServicesClient) CreateOrUpdate(ctx context.Context, id DomainServiceId, input DomainService) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (DomainServicesClient) CreateOrUpdateThenPoll 

func (c DomainServicesClient) CreateOrUpdateThenPoll(ctx context.Context, id DomainServiceId, input DomainService) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (DomainServicesClient) Delete 

func (c DomainServicesClient) Delete(ctx context.Context, id DomainServiceId) (result DeleteOperationResponse, err error)

Delete ...

func (DomainServicesClient) DeleteThenPoll 

func (c DomainServicesClient) DeleteThenPoll(ctx context.Context, id DomainServiceId) error

DeleteThenPoll performs Delete then polls until it's completed

func (DomainServicesClient) Get 

func (c DomainServicesClient) Get(ctx context.Context, id DomainServiceId) (result GetOperationResponse, err error)

Get ...

func (DomainServicesClient) List 

func (c DomainServicesClient) List(ctx context.Context, id commonids.SubscriptionId) (result ListOperationResponse, err error)

List ...

func (DomainServicesClient) ListByResourceGroup 

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

ListByResourceGroup ...

func (DomainServicesClient) ListByResourceGroupComplete 

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

ListByResourceGroupComplete retrieves all the results into a single object

func (DomainServicesClient) ListByResourceGroupCompleteMatchingPredicate 

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

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DomainServicesClient) ListComplete 

func (c DomainServicesClient) ListComplete(ctx context.Context, id commonids.SubscriptionId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (DomainServicesClient) ListCompleteMatchingPredicate 

func (c DomainServicesClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate DomainServiceOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (DomainServicesClient) Update 

func (c DomainServicesClient) Update(ctx context.Context, id DomainServiceId, input DomainService) (result UpdateOperationResponse, err error)

Update ...

func (DomainServicesClient) UpdateThenPoll 

func (c DomainServicesClient) UpdateThenPoll(ctx context.Context, id DomainServiceId, input DomainService) error

UpdateThenPoll performs Update then polls until it's completed

type ExternalAccess 

type ExternalAccess string
const (
	ExternalAccessDisabled ExternalAccess = "Disabled"
	ExternalAccessEnabled  ExternalAccess = "Enabled"
)

func (*ExternalAccess) UnmarshalJSON 

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

type FilteredSync 

type FilteredSync string
const (
	FilteredSyncDisabled FilteredSync = "Disabled"
	FilteredSyncEnabled  FilteredSync = "Enabled"
)

func (*FilteredSync) UnmarshalJSON 

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

type ForestTrust 

type ForestTrust struct {
	FriendlyName      *string `json:"friendlyName,omitempty"`
	RemoteDnsIPs      *string `json:"remoteDnsIps,omitempty"`
	TrustDirection    *string `json:"trustDirection,omitempty"`
	TrustPassword     *string `json:"trustPassword,omitempty"`
	TrustedDomainFqdn *string `json:"trustedDomainFqdn,omitempty"`
}

type GetOperationResponse 

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

type HealthAlert 

type HealthAlert struct {
	Id            *string `json:"id,omitempty"`
	Issue         *string `json:"issue,omitempty"`
	LastDetected  *string `json:"lastDetected,omitempty"`
	Name          *string `json:"name,omitempty"`
	Raised        *string `json:"raised,omitempty"`
	ResolutionUri *string `json:"resolutionUri,omitempty"`
	Severity      *string `json:"severity,omitempty"`
}

func (*HealthAlert) GetLastDetectedAsTime 

func (o *HealthAlert) GetLastDetectedAsTime() (*time.Time, error)

func (*HealthAlert) GetRaisedAsTime 

func (o *HealthAlert) GetRaisedAsTime() (*time.Time, error)

func (*HealthAlert) SetLastDetectedAsTime 

func (o *HealthAlert) SetLastDetectedAsTime(input time.Time)

func (*HealthAlert) SetRaisedAsTime 

func (o *HealthAlert) SetRaisedAsTime(input time.Time)

type HealthMonitor 

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

type KerberosArmoring 

type KerberosArmoring string
const (
	KerberosArmoringDisabled KerberosArmoring = "Disabled"
	KerberosArmoringEnabled  KerberosArmoring = "Enabled"
)

func (*KerberosArmoring) UnmarshalJSON 

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

type KerberosRc4Encryption 

type KerberosRc4Encryption string
const (
	KerberosRc4EncryptionDisabled KerberosRc4Encryption = "Disabled"
	KerberosRc4EncryptionEnabled  KerberosRc4Encryption = "Enabled"
)

func (*KerberosRc4Encryption) UnmarshalJSON 

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

type Ldaps 

type Ldaps string
const (
	LdapsDisabled Ldaps = "Disabled"
	LdapsEnabled  Ldaps = "Enabled"
)

func (*Ldaps) UnmarshalJSON 

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

type LdapsSettings 

type LdapsSettings struct {
	CertificateNotAfter    *string         `json:"certificateNotAfter,omitempty"`
	CertificateThumbprint  *string         `json:"certificateThumbprint,omitempty"`
	ExternalAccess         *ExternalAccess `json:"externalAccess,omitempty"`
	Ldaps                  *Ldaps          `json:"ldaps,omitempty"`
	PfxCertificate         *string         `json:"pfxCertificate,omitempty"`
	PfxCertificatePassword *string         `json:"pfxCertificatePassword,omitempty"`
	PublicCertificate      *string         `json:"publicCertificate,omitempty"`
}

func (*LdapsSettings) GetCertificateNotAfterAsTime 

func (o *LdapsSettings) GetCertificateNotAfterAsTime() (*time.Time, error)

func (*LdapsSettings) SetCertificateNotAfterAsTime 

func (o *LdapsSettings) SetCertificateNotAfterAsTime(input time.Time)

type ListByResourceGroupCompleteResult 

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

type ListByResourceGroupOperationResponse 

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

type ListCompleteResult 

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

type ListOperationResponse 

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

type MigrationProgress 

type MigrationProgress struct {
	CompletionPercentage *float64 `json:"completionPercentage,omitempty"`
	ProgressMessage      *string  `json:"progressMessage,omitempty"`
}

type MigrationProperties 

type MigrationProperties struct {
	MigrationProgress *MigrationProgress `json:"migrationProgress,omitempty"`
	OldSubnetId       *string            `json:"oldSubnetId,omitempty"`
	OldVnetSiteId     *string            `json:"oldVnetSiteId,omitempty"`
}

type NotificationSettings 

type NotificationSettings struct {
	AdditionalRecipients *[]string           `json:"additionalRecipients,omitempty"`
	NotifyDcAdmins       *NotifyDcAdmins     `json:"notifyDcAdmins,omitempty"`
	NotifyGlobalAdmins   *NotifyGlobalAdmins `json:"notifyGlobalAdmins,omitempty"`
}

type NotifyDcAdmins 

type NotifyDcAdmins string
const (
	NotifyDcAdminsDisabled NotifyDcAdmins = "Disabled"
	NotifyDcAdminsEnabled  NotifyDcAdmins = "Enabled"
)

func (*NotifyDcAdmins) UnmarshalJSON 

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

type NotifyGlobalAdmins 

type NotifyGlobalAdmins string
const (
	NotifyGlobalAdminsDisabled NotifyGlobalAdmins = "Disabled"
	NotifyGlobalAdminsEnabled  NotifyGlobalAdmins = "Enabled"
)

func (*NotifyGlobalAdmins) UnmarshalJSON 

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

type NtlmV1 

type NtlmV1 string
const (
	NtlmV1Disabled NtlmV1 = "Disabled"
	NtlmV1Enabled  NtlmV1 = "Enabled"
)

func (*NtlmV1) UnmarshalJSON 

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

type ReplicaSet 

type ReplicaSet struct {
	DomainControllerIPAddress *[]string        `json:"domainControllerIpAddress,omitempty"`
	ExternalAccessIPAddress   *string          `json:"externalAccessIpAddress,omitempty"`
	HealthAlerts              *[]HealthAlert   `json:"healthAlerts,omitempty"`
	HealthLastEvaluated       *string          `json:"healthLastEvaluated,omitempty"`
	HealthMonitors            *[]HealthMonitor `json:"healthMonitors,omitempty"`
	Location                  *string          `json:"location,omitempty"`
	ReplicaSetId              *string          `json:"replicaSetId,omitempty"`
	ServiceStatus             *string          `json:"serviceStatus,omitempty"`
	SubnetId                  *string          `json:"subnetId,omitempty"`
	VnetSiteId                *string          `json:"vnetSiteId,omitempty"`
}

type ResourceForestSettings 

type ResourceForestSettings struct {
	ResourceForest *string        `json:"resourceForest,omitempty"`
	Settings       *[]ForestTrust `json:"settings,omitempty"`
}

type Status 

type Status string
const (
	StatusFailure Status = "Failure"
	StatusNone    Status = "None"
	StatusOK      Status = "OK"
	StatusRunning Status = "Running"
	StatusSkipped Status = "Skipped"
	StatusWarning Status = "Warning"
)

func (*Status) UnmarshalJSON 

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

type SyncKerberosPasswords 

type SyncKerberosPasswords string
const (
	SyncKerberosPasswordsDisabled SyncKerberosPasswords = "Disabled"
	SyncKerberosPasswordsEnabled  SyncKerberosPasswords = "Enabled"
)

func (*SyncKerberosPasswords) UnmarshalJSON 

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

type SyncNtlmPasswords 

type SyncNtlmPasswords string
const (
	SyncNtlmPasswordsDisabled SyncNtlmPasswords = "Disabled"
	SyncNtlmPasswordsEnabled  SyncNtlmPasswords = "Enabled"
)

func (*SyncNtlmPasswords) UnmarshalJSON 

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

type SyncOnPremPasswords 

type SyncOnPremPasswords string
const (
	SyncOnPremPasswordsDisabled SyncOnPremPasswords = "Disabled"
	SyncOnPremPasswordsEnabled  SyncOnPremPasswords = "Enabled"
)

func (*SyncOnPremPasswords) UnmarshalJSON 

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

type TlsV1 

type TlsV1 string
const (
	TlsV1Disabled TlsV1 = "Disabled"
	TlsV1Enabled  TlsV1 = "Enabled"
)

func (*TlsV1) UnmarshalJSON 

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

type UpdateOperationResponse 

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

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.