aad

package
v20.2.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Sep 19, 2018 License: Apache-2.0 Imports: 8 Imported by: 135

Documentation

Overview

Package aad implements the Azure ARM Aad service API version 2017-01-01.

The AAD Domain Services API.

Index

Constants

View Source 
const (
	// DefaultBaseURI is the default URI used for the service Aad
	DefaultBaseURI = "https://management.azure.com"
)

Variables

This section is empty.

Functions

func UserAgent 

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version 

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type BaseClient 

type BaseClient struct {
	autorest.Client
	BaseURI        string
	SubscriptionID string
}

BaseClient is the base client for Aad.

func New 

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client.

type DomainService 

type DomainService struct {
	autorest.Response `json:"-"`
	// DomainServiceProperties - Domain service properties
	*DomainServiceProperties `json:"properties,omitempty"`
	// ID - Resource Id
	ID *string `json:"id,omitempty"`
	// Name - Resource name
	Name *string `json:"name,omitempty"`
	// Type - Resource type
	Type *string `json:"type,omitempty"`
	// Location - Resource location
	Location *string `json:"location,omitempty"`
	// Tags - Resource tags
	Tags map[string]*string `json:"tags"`
	// Etag - Resource etag
	Etag *string `json:"etag,omitempty"`
}

DomainService domain service.

func (DomainService) MarshalJSON 

func (ds DomainService) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DomainService.

func (*DomainService) UnmarshalJSON 

func (ds *DomainService) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for DomainService struct.

type DomainServiceListResult 

type DomainServiceListResult struct {
	autorest.Response `json:"-"`
	// Value - the list of domain services.
	Value *[]DomainService `json:"value,omitempty"`
}

DomainServiceListResult the response from the List Domain Services operation.

type DomainServiceOperationsClient 

type DomainServiceOperationsClient struct {
	BaseClient
}

DomainServiceOperationsClient is the the AAD Domain Services API.

func NewDomainServiceOperationsClient 

func NewDomainServiceOperationsClient(subscriptionID string) DomainServiceOperationsClient

NewDomainServiceOperationsClient creates an instance of the DomainServiceOperationsClient client.

func NewDomainServiceOperationsClientWithBaseURI 

func NewDomainServiceOperationsClientWithBaseURI(baseURI string, subscriptionID string) DomainServiceOperationsClient

NewDomainServiceOperationsClientWithBaseURI creates an instance of the DomainServiceOperationsClient client.

func (DomainServiceOperationsClient) List 

func (client DomainServiceOperationsClient) List(ctx context.Context) (result OperationEntityListResult, err error)

List lists all the available Domain Services operations.

func (DomainServiceOperationsClient) ListPreparer 

func (client DomainServiceOperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (DomainServiceOperationsClient) ListResponder 

func (client DomainServiceOperationsClient) ListResponder(resp *http.Response) (result OperationEntityListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (DomainServiceOperationsClient) ListSender 

func (client DomainServiceOperationsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type DomainServicePatchProperties 

type DomainServicePatchProperties struct {
	// LdapsSettings - Secure LDAP Settings
	LdapsSettings *LdapsSettings `json:"ldapsSettings,omitempty"`
}

DomainServicePatchProperties update Properties of the Domain Service.

type DomainServiceProperties 

type DomainServiceProperties struct {
	// TenantID - Azure Active Directory tenant id
	TenantID *string `json:"tenantId,omitempty"`
	// DomainName - The name of the Azure domain that the user would like to deploy Domain Services to.
	DomainName *string `json:"domainName,omitempty"`
	// VnetSiteID - Virtual network site id
	VnetSiteID *string `json:"vnetSiteId,omitempty"`
	// SubnetID - The name of the virtual network that Domain Services will be deployed on. The id of the subnet that Domain Services will be deployed on. /virtualNetwork/vnetName/subnets/subnetName.
	SubnetID *string `json:"subnetId,omitempty"`
	// LdapsSettings - Secure LDAP Settings
	LdapsSettings *LdapsSettings `json:"ldapsSettings,omitempty"`
	// DomainControllerIPAddress - List of Domain Controller IP Address
	DomainControllerIPAddress *[]string `json:"domainControllerIpAddress,omitempty"`
	// ServiceStatus - Status of Domain Service instance
	ServiceStatus *string `json:"serviceStatus,omitempty"`
	// ProvisioningState - the current deployment or provisioning state, which only appears in the response.
	ProvisioningState *string `json:"provisioningState,omitempty"`
}

DomainServiceProperties properties of the Domain Service.

type DomainServicesClient 

type DomainServicesClient struct {
	BaseClient
}

DomainServicesClient is the the AAD Domain Services API.

func NewDomainServicesClient 

func NewDomainServicesClient(subscriptionID string) DomainServicesClient

NewDomainServicesClient creates an instance of the DomainServicesClient client.

func NewDomainServicesClientWithBaseURI 

func NewDomainServicesClientWithBaseURI(baseURI string, subscriptionID string) DomainServicesClient

NewDomainServicesClientWithBaseURI creates an instance of the DomainServicesClient client.

func (DomainServicesClient) CreateOrUpdate 

func (client DomainServicesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, domainServiceName string, properties DomainServiceProperties) (result DomainServicesCreateOrUpdateFuture, err error)

CreateOrUpdate the Create Domain Service operation creates a new domain service with the specified parameters. If the specific service already exists, then any patchable properties will be updated and any immutable properties will remain unchanged. Parameters: resourceGroupName - the name of the resource group within the user's subscription. The name is case insensitive. domainServiceName - the name of the domain service in the specified subscription and resource group. properties - properties supplied to the Create or Update a Domain Service operation.

func (DomainServicesClient) CreateOrUpdatePreparer 

func (client DomainServicesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, domainServiceName string, properties DomainServiceProperties) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (DomainServicesClient) CreateOrUpdateResponder 

func (client DomainServicesClient) CreateOrUpdateResponder(resp *http.Response) (result DomainService, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (DomainServicesClient) CreateOrUpdateSender 

func (client DomainServicesClient) CreateOrUpdateSender(req *http.Request) (future DomainServicesCreateOrUpdateFuture, err error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (DomainServicesClient) Delete 

func (client DomainServicesClient) Delete(ctx context.Context, resourceGroupName string, domainServiceName string) (result DomainServicesDeleteFuture, err error)

Delete the Delete Domain Service operation deletes an existing Domain Service. Parameters: resourceGroupName - the name of the resource group within the user's subscription. The name is case insensitive. domainServiceName - the name of the domain service in the specified subscription and resource group.

func (DomainServicesClient) DeletePreparer 

func (client DomainServicesClient) DeletePreparer(ctx context.Context, resourceGroupName string, domainServiceName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (DomainServicesClient) DeleteResponder 

func (client DomainServicesClient) DeleteResponder(resp *http.Response) (result DomainService, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (DomainServicesClient) DeleteSender 

func (client DomainServicesClient) DeleteSender(req *http.Request) (future DomainServicesDeleteFuture, err error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (DomainServicesClient) Get 

func (client DomainServicesClient) Get(ctx context.Context, resourceGroupName string, domainServiceName string) (result DomainService, err error)

Get the Get Domain Service operation retrieves a json representation of the Domain Service. Parameters: resourceGroupName - the name of the resource group within the user's subscription. The name is case insensitive. domainServiceName - the name of the domain service in the specified subscription and resource group.

func (DomainServicesClient) GetPreparer 

func (client DomainServicesClient) GetPreparer(ctx context.Context, resourceGroupName string, domainServiceName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (DomainServicesClient) GetResponder 

func (client DomainServicesClient) GetResponder(resp *http.Response) (result DomainService, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (DomainServicesClient) GetSender 

func (client DomainServicesClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (DomainServicesClient) List 

func (client DomainServicesClient) List(ctx context.Context) (result DomainServiceListResult, err error)

List the List Domain Services in Subscription operation lists all the domain services available under the given subscription (and across all resource groups within that subscription).

func (DomainServicesClient) ListByResourceGroup 

func (client DomainServicesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result DomainServiceListResult, err error)

ListByResourceGroup the List Domain Services in Resource Group operation lists all the domain services available under the given resource group. Parameters: resourceGroupName - the name of the resource group within the user's subscription. The name is case insensitive.

func (DomainServicesClient) ListByResourceGroupPreparer 

func (client DomainServicesClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (DomainServicesClient) ListByResourceGroupResponder 

func (client DomainServicesClient) ListByResourceGroupResponder(resp *http.Response) (result DomainServiceListResult, err error)

ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.

func (DomainServicesClient) ListByResourceGroupSender 

func (client DomainServicesClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)

ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.

func (DomainServicesClient) ListPreparer 

func (client DomainServicesClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (DomainServicesClient) ListResponder 

func (client DomainServicesClient) ListResponder(resp *http.Response) (result DomainServiceListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (DomainServicesClient) ListSender 

func (client DomainServicesClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (DomainServicesClient) Update 

func (client DomainServicesClient) Update(ctx context.Context, resourceGroupName string, domainServiceName string, properties DomainServicePatchProperties) (result DomainServicesUpdateFuture, err error)

Update the Update Domain Service operation can be used to update the existing deployment. The update call only supports the properties listed in the PATCH body. Parameters: resourceGroupName - the name of the resource group within the user's subscription. The name is case insensitive. domainServiceName - the name of the domain service in the specified subscription and resource group. properties - properties supplied to the Update a Domain Service operation.

func (DomainServicesClient) UpdatePreparer 

func (client DomainServicesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, domainServiceName string, properties DomainServicePatchProperties) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (DomainServicesClient) UpdateResponder 

func (client DomainServicesClient) UpdateResponder(resp *http.Response) (result DomainService, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (DomainServicesClient) UpdateSender 

func (client DomainServicesClient) UpdateSender(req *http.Request) (future DomainServicesUpdateFuture, err error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type DomainServicesCreateOrUpdateFuture 

type DomainServicesCreateOrUpdateFuture struct {
	azure.Future
}

DomainServicesCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*DomainServicesCreateOrUpdateFuture) Result 

func (future *DomainServicesCreateOrUpdateFuture) Result(client DomainServicesClient) (ds DomainService, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type DomainServicesDeleteFuture 

type DomainServicesDeleteFuture struct {
	azure.Future
}

DomainServicesDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*DomainServicesDeleteFuture) Result 

func (future *DomainServicesDeleteFuture) Result(client DomainServicesClient) (ds DomainService, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type DomainServicesUpdateFuture 

type DomainServicesUpdateFuture struct {
	azure.Future
}

DomainServicesUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*DomainServicesUpdateFuture) Result 

func (future *DomainServicesUpdateFuture) Result(client DomainServicesClient) (ds DomainService, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type ExternalAccess 

type ExternalAccess string

ExternalAccess enumerates the values for external access. 

const (
	// Disabled ...
	Disabled ExternalAccess = "Disabled"
	// Enabled ...
	Enabled ExternalAccess = "Enabled"
)

func PossibleExternalAccessValues 

func PossibleExternalAccessValues() []ExternalAccess

PossibleExternalAccessValues returns an array of possible values for the ExternalAccess const type.

type Ldaps 

type Ldaps string

Ldaps enumerates the values for ldaps. 

const (
	// LdapsDisabled ...
	LdapsDisabled Ldaps = "Disabled"
	// LdapsEnabled ...
	LdapsEnabled Ldaps = "Enabled"
)

func PossibleLdapsValues 

func PossibleLdapsValues() []Ldaps

PossibleLdapsValues returns an array of possible values for the Ldaps const type.

type LdapsSettings 

type LdapsSettings struct {
	// Ldaps - A flag to determine whether or not Secure LDAP is enabled or disabled. Possible values include: 'LdapsEnabled', 'LdapsDisabled'
	Ldaps Ldaps `json:"ldaps,omitempty"`
	// PfxCertificate - The certificate required to configure Secure LDAP. The parameter passed here should be a base64encoded representation of the certificate pfx file.
	PfxCertificate *string `json:"pfxCertificate,omitempty"`
	// PfxCertificatePassword - The password to decrypt the provided Secure LDAP certificate pfx file.
	PfxCertificatePassword *string `json:"pfxCertificatePassword,omitempty"`
	// PublicCertificate - Public certificate used to configure secure ldap.
	PublicCertificate *string `json:"publicCertificate,omitempty"`
	// CertificateThumbprint - Thumbprint of configure ldaps certificate.
	CertificateThumbprint *string `json:"certificateThumbprint,omitempty"`
	// CertificateNotAfter - NotAfter DateTime of configure ldaps certificate.
	CertificateNotAfter *date.Time `json:"certificateNotAfter,omitempty"`
	// ExternalAccess - A flag to determine whether or not Secure LDAP access over the internet is enabled or disabled. Possible values include: 'Enabled', 'Disabled'
	ExternalAccess ExternalAccess `json:"externalAccess,omitempty"`
	// ExternalAccessIPAddress - External access ip address.
	ExternalAccessIPAddress *string `json:"externalAccessIpAddress,omitempty"`
}

LdapsSettings secure LDAP Settings

type OperationDisplayInfo 

type OperationDisplayInfo struct {
	// Description - The description of the operation.
	Description *string `json:"description,omitempty"`
	// Operation - The action that users can perform, based on their permission level.
	Operation *string `json:"operation,omitempty"`
	// Provider - Service provider: Domain Services.
	Provider *string `json:"provider,omitempty"`
	// Resource - Resource on which the operation is performed.
	Resource *string `json:"resource,omitempty"`
}

OperationDisplayInfo the operation supported by Domain Services.

type OperationEntity 

type OperationEntity struct {
	// Name - Operation name: {provider}/{resource}/{operation}.
	Name *string `json:"name,omitempty"`
	// Display - The operation supported by Domain Services.
	Display *OperationDisplayInfo `json:"display,omitempty"`
	// Origin - The origin of the operation.
	Origin *string `json:"origin,omitempty"`
}

OperationEntity the operation supported by Domain Services.

type OperationEntityListResult 

type OperationEntityListResult struct {
	autorest.Response `json:"-"`
	// Value - The list of operations.
	Value *[]OperationEntity `json:"value,omitempty"`
}

OperationEntityListResult the list of domain service operation response.

type Resource 

type Resource struct {
	// ID - Resource Id
	ID *string `json:"id,omitempty"`
	// Name - Resource name
	Name *string `json:"name,omitempty"`
	// Type - Resource type
	Type *string `json:"type,omitempty"`
	// Location - Resource location
	Location *string `json:"location,omitempty"`
	// Tags - Resource tags
	Tags map[string]*string `json:"tags"`
	// Etag - Resource etag
	Etag *string `json:"etag,omitempty"`
}

Resource the Resource model definition.

func (Resource) MarshalJSON 

func (r Resource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Resource.

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.