aad

package
v57.4.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Sep 23, 2021 License: MIT Imports: 7 Imported by: 0

Documentation

Overview

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

Azure Active Directory Client.

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
}

BaseClient is the base client for Aad.

func New 

func New() BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

type Category 

type Category string

Category enumerates the values for category. 

const (
	// AuditLogs ...
	AuditLogs Category = "AuditLogs"
	// SignInLogs ...
	SignInLogs Category = "SignInLogs"
)

func PossibleCategoryValues 

func PossibleCategoryValues() []Category

PossibleCategoryValues returns an array of possible values for the Category const type.

type CategoryType 

type CategoryType string

CategoryType enumerates the values for category type. 

const (
	// Logs ...
	Logs CategoryType = "Logs"
)

func PossibleCategoryTypeValues 

func PossibleCategoryTypeValues() []CategoryType

PossibleCategoryTypeValues returns an array of possible values for the CategoryType const type.

type DiagnosticSettings 

type DiagnosticSettings struct {
	// StorageAccountID - The resource ID of the storage account to which you would like to send Diagnostic Logs.
	StorageAccountID *string `json:"storageAccountId,omitempty"`
	// ServiceBusRuleID - The service bus rule Id of the diagnostic setting. This is here to maintain backwards compatibility.
	ServiceBusRuleID *string `json:"serviceBusRuleId,omitempty"`
	// WorkspaceID - The workspace ID (resource ID of a Log Analytics workspace) for a Log Analytics workspace to which you would like to send Diagnostic Logs. Example: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2
	WorkspaceID *string `json:"workspaceId,omitempty"`
	// EventHubAuthorizationRuleID - The resource Id for the event hub authorization rule.
	EventHubAuthorizationRuleID *string `json:"eventHubAuthorizationRuleId,omitempty"`
	// EventHubName - The name of the event hub. If none is specified, the default event hub will be selected.
	EventHubName *string `json:"eventHubName,omitempty"`
	// Logs - The list of logs settings.
	Logs *[]LogSettings `json:"logs,omitempty"`
}

DiagnosticSettings the diagnostic settings.

type DiagnosticSettingsCategory 

type DiagnosticSettingsCategory struct {
	// CategoryType - The type of the diagnostic settings category. Possible values include: 'Logs'
	CategoryType CategoryType `json:"categoryType,omitempty"`
}

DiagnosticSettingsCategory the diagnostic settings Category.

type DiagnosticSettingsCategoryClient 

type DiagnosticSettingsCategoryClient struct {
	BaseClient
}

DiagnosticSettingsCategoryClient is the azure Active Directory Client.

func NewDiagnosticSettingsCategoryClient 

func NewDiagnosticSettingsCategoryClient() DiagnosticSettingsCategoryClient

NewDiagnosticSettingsCategoryClient creates an instance of the DiagnosticSettingsCategoryClient client.

func NewDiagnosticSettingsCategoryClientWithBaseURI 

func NewDiagnosticSettingsCategoryClientWithBaseURI(baseURI string) DiagnosticSettingsCategoryClient

NewDiagnosticSettingsCategoryClientWithBaseURI creates an instance of the DiagnosticSettingsCategoryClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (DiagnosticSettingsCategoryClient) List 

func (client DiagnosticSettingsCategoryClient) List(ctx context.Context) (result DiagnosticSettingsCategoryResourceCollection, err error)

List lists the diagnostic settings categories for AadIam.

func (DiagnosticSettingsCategoryClient) ListPreparer 

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

ListPreparer prepares the List request.

func (DiagnosticSettingsCategoryClient) ListResponder 

func (client DiagnosticSettingsCategoryClient) ListResponder(resp *http.Response) (result DiagnosticSettingsCategoryResourceCollection, err error)

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

func (DiagnosticSettingsCategoryClient) ListSender 

func (client DiagnosticSettingsCategoryClient) 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 DiagnosticSettingsCategoryResource 

type DiagnosticSettingsCategoryResource struct {
	// DiagnosticSettingsCategory - The properties of a Diagnostic Settings Category.
	*DiagnosticSettingsCategory `json:"properties,omitempty"`
	// ID - READ-ONLY; Azure resource Id
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Azure resource name
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Azure resource type
	Type *string `json:"type,omitempty"`
}

DiagnosticSettingsCategoryResource the diagnostic settings category resource.

func (DiagnosticSettingsCategoryResource) MarshalJSON 

func (dscr DiagnosticSettingsCategoryResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DiagnosticSettingsCategoryResource.

func (*DiagnosticSettingsCategoryResource) UnmarshalJSON 

func (dscr *DiagnosticSettingsCategoryResource) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for DiagnosticSettingsCategoryResource struct.

type DiagnosticSettingsCategoryResourceCollection 

type DiagnosticSettingsCategoryResourceCollection struct {
	autorest.Response `json:"-"`
	// Value - The collection of diagnostic settings category resources.
	Value *[]DiagnosticSettingsCategoryResource `json:"value,omitempty"`
}

DiagnosticSettingsCategoryResourceCollection represents a collection of diagnostic setting category resources.

type DiagnosticSettingsClient 

type DiagnosticSettingsClient struct {
	BaseClient
}

DiagnosticSettingsClient is the azure Active Directory Client.

func NewDiagnosticSettingsClient 

func NewDiagnosticSettingsClient() DiagnosticSettingsClient

NewDiagnosticSettingsClient creates an instance of the DiagnosticSettingsClient client.

func NewDiagnosticSettingsClientWithBaseURI 

func NewDiagnosticSettingsClientWithBaseURI(baseURI string) DiagnosticSettingsClient

NewDiagnosticSettingsClientWithBaseURI creates an instance of the DiagnosticSettingsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (DiagnosticSettingsClient) CreateOrUpdate 

func (client DiagnosticSettingsClient) CreateOrUpdate(ctx context.Context, parameters DiagnosticSettingsResource, name string) (result DiagnosticSettingsResource, err error)

CreateOrUpdate creates or updates diagnostic settings for AadIam. Parameters: parameters - parameters supplied to the operation. name - the name of the diagnostic setting.

func (DiagnosticSettingsClient) CreateOrUpdatePreparer 

func (client DiagnosticSettingsClient) CreateOrUpdatePreparer(ctx context.Context, parameters DiagnosticSettingsResource, name string) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (DiagnosticSettingsClient) CreateOrUpdateResponder 

func (client DiagnosticSettingsClient) CreateOrUpdateResponder(resp *http.Response) (result DiagnosticSettingsResource, err error)

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

func (DiagnosticSettingsClient) CreateOrUpdateSender 

func (client DiagnosticSettingsClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)

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

func (DiagnosticSettingsClient) Delete 

func (client DiagnosticSettingsClient) Delete(ctx context.Context, name string) (result autorest.Response, err error)

Delete deletes existing diagnostic setting for AadIam. Parameters: name - the name of the diagnostic setting.

func (DiagnosticSettingsClient) DeletePreparer 

func (client DiagnosticSettingsClient) DeletePreparer(ctx context.Context, name string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (DiagnosticSettingsClient) DeleteResponder 

func (client DiagnosticSettingsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

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

func (DiagnosticSettingsClient) DeleteSender 

func (client DiagnosticSettingsClient) DeleteSender(req *http.Request) (*http.Response, error)

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

func (DiagnosticSettingsClient) Get 

func (client DiagnosticSettingsClient) Get(ctx context.Context, name string) (result DiagnosticSettingsResource, err error)

Get gets the active diagnostic setting for AadIam. Parameters: name - the name of the diagnostic setting.

func (DiagnosticSettingsClient) GetPreparer 

func (client DiagnosticSettingsClient) GetPreparer(ctx context.Context, name string) (*http.Request, error)

GetPreparer prepares the Get request.

func (DiagnosticSettingsClient) GetResponder 

func (client DiagnosticSettingsClient) GetResponder(resp *http.Response) (result DiagnosticSettingsResource, err error)

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

func (DiagnosticSettingsClient) GetSender 

func (client DiagnosticSettingsClient) 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 (DiagnosticSettingsClient) List 

func (client DiagnosticSettingsClient) List(ctx context.Context) (result DiagnosticSettingsResourceCollection, err error)

List gets the active diagnostic settings list for AadIam.

func (DiagnosticSettingsClient) ListPreparer 

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

ListPreparer prepares the List request.

func (DiagnosticSettingsClient) ListResponder 

func (client DiagnosticSettingsClient) ListResponder(resp *http.Response) (result DiagnosticSettingsResourceCollection, err error)

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

func (DiagnosticSettingsClient) ListSender 

func (client DiagnosticSettingsClient) 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 DiagnosticSettingsResource 

type DiagnosticSettingsResource struct {
	autorest.Response `json:"-"`
	// DiagnosticSettings - Properties of a Diagnostic Settings Resource.
	*DiagnosticSettings `json:"properties,omitempty"`
	// ID - READ-ONLY; Azure resource Id
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Azure resource name
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Azure resource type
	Type *string `json:"type,omitempty"`
}

DiagnosticSettingsResource the diagnostic setting resource.

func (DiagnosticSettingsResource) MarshalJSON 

func (dsr DiagnosticSettingsResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DiagnosticSettingsResource.

func (*DiagnosticSettingsResource) UnmarshalJSON 

func (dsr *DiagnosticSettingsResource) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for DiagnosticSettingsResource struct.

type DiagnosticSettingsResourceCollection 

type DiagnosticSettingsResourceCollection struct {
	autorest.Response `json:"-"`
	// Value - The collection of diagnostic settings resources.
	Value *[]DiagnosticSettingsResource `json:"value,omitempty"`
}

DiagnosticSettingsResourceCollection represents a collection of alert rule resources.

type Display 

type Display struct {
	// Publisher - The publisher. The localized friendly form of the resource publisher name.
	Publisher *string `json:"publisher,omitempty"`
	// Provider - The provider. The localized friendly form of the resource provider name – it is expected to also include the publisher/company responsible. It should use Title Casing and begin with "Microsoft" for 1st party services. e.g. "Microsoft Monitoring Insights" or "Microsoft Compute."
	Provider *string `json:"provider,omitempty"`
	// Resource - The resource. The localized friendly form of the resource related to this action/operation – it should match the public documentation for the resource provider. It should use Title Casing. This value should be unique for a particular URL type (e.g. nested types should *not* reuse their parent’s display.resource field). e.g. "Virtual Machines" or "Scheduler Job Collections", or "Virtual Machine VM Sizes" or "Scheduler Jobs"
	Resource *string `json:"resource,omitempty"`
	// Operation - The operation. The localized friendly name for the operation, as it should be shown to the user. It should be concise (to fit in drop downs) but clear (i.e. self-documenting). It should use Title Casing. Prescriptive guidance: Read Create or Update Delete 'ActionName'
	Operation *string `json:"operation,omitempty"`
	// Description - The description. The localized friendly description for the operation, as it should be shown to the user. It should be thorough, yet concise – it will be used in tool tips and detailed views. Prescriptive guidance for namespaces: Read any 'display.provider' resource Create or Update any 'display.provider' resource Delete any 'display.provider' resource Perform any other action on any 'display.provider' resource Prescriptive guidance for namespaces: Read any 'display.resource' Create or Update any 'display.resource' Delete any 'display.resource' 'ActionName' any 'display.resources'
	Description *string `json:"description,omitempty"`
}

Display contains the localized display information for this particular operation / action. These value will be used by several clients for (1) custom role definitions for RBAC; (2) complex query filters for the event service; and (3) audit history / records for management operations.

type ErrorDefinition 

type ErrorDefinition struct {
	// Code - READ-ONLY; Service specific error code which serves as the substatus for the HTTP error code.
	Code *string `json:"code,omitempty"`
	// Message - READ-ONLY; Description of the error.
	Message *string `json:"message,omitempty"`
	// Details - READ-ONLY; Internal error details.
	Details *[]ErrorDefinition `json:"details,omitempty"`
}

ErrorDefinition error definition.

func (ErrorDefinition) MarshalJSON 

func (ed ErrorDefinition) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ErrorDefinition.

type ErrorResponse 

type ErrorResponse struct {
	// Error - The error details.
	Error *ErrorDefinition `json:"error,omitempty"`
}

ErrorResponse error response.

type LogSettings 

type LogSettings struct {
	// Category - Name of a Diagnostic Log category for a resource type this setting is applied to. To obtain the list of Diagnostic Log categories for a resource, first perform a GET diagnostic settings operation. Possible values include: 'AuditLogs', 'SignInLogs'
	Category Category `json:"category,omitempty"`
	// Enabled - A value indicating whether this log is enabled.
	Enabled *bool `json:"enabled,omitempty"`
	// RetentionPolicy - The retention policy for this log.
	RetentionPolicy *RetentionPolicy `json:"retentionPolicy,omitempty"`
}

LogSettings part of MultiTenantDiagnosticSettings. Specifies the settings for a particular log.

type OperationsClient 

type OperationsClient struct {
	BaseClient
}

OperationsClient is the azure Active Directory Client.

func NewOperationsClient 

func NewOperationsClient() OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI 

func NewOperationsClientWithBaseURI(baseURI string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (OperationsClient) List 

func (client OperationsClient) List(ctx context.Context) (result OperationsDiscoveryCollection, err error)

List operation to return the list of available operations.

func (OperationsClient) ListPreparer 

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

ListPreparer prepares the List request.

func (OperationsClient) ListResponder 

func (client OperationsClient) ListResponder(resp *http.Response) (result OperationsDiscoveryCollection, err error)

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

func (OperationsClient) ListSender 

func (client OperationsClient) 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 OperationsDiscovery 

type OperationsDiscovery struct {
	// Name - Name of the API. The name of the operation being performed on this particular object. It should match the action name that appears in RBAC / the event service. Examples of operations include: * Microsoft.Compute/virtualMachine/capture/action * Microsoft.Compute/virtualMachine/restart/action * Microsoft.Compute/virtualMachine/write * Microsoft.Compute/virtualMachine/read * Microsoft.Compute/virtualMachine/delete Each action should include, in order: (1) Resource Provider Namespace (2) Type hierarchy for which the action applies (e.g. server/databases for a SQL Azure database) (3) Read, Write, Action or Delete indicating which type applies. If it is a PUT/PATCH on a collection or named value, Write should be used. If it is a GET, Read should be used. If it is a DELETE, Delete should be used. If it is a POST, Action should be used.
	Name *string `json:"name,omitempty"`
	// Display - Object type
	Display *Display `json:"display,omitempty"`
	// Origin - Origin. The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX. Default value is "user,system"
	Origin *string `json:"origin,omitempty"`
	// Properties - Properties. Reserved for future use.
	Properties interface{} `json:"properties,omitempty"`
}

OperationsDiscovery operations discovery class.

type OperationsDiscoveryCollection 

type OperationsDiscoveryCollection struct {
	autorest.Response `json:"-"`
	// Value - The ClientDiscovery details.
	Value *[]OperationsDiscovery `json:"value,omitempty"`
}

OperationsDiscoveryCollection collection of ClientDiscovery details.

type ProxyOnlyResource 

type ProxyOnlyResource struct {
	// ID - READ-ONLY; Azure resource Id
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Azure resource name
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Azure resource type
	Type *string `json:"type,omitempty"`
}

ProxyOnlyResource a proxy only azure resource object.

func (ProxyOnlyResource) MarshalJSON 

func (por ProxyOnlyResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ProxyOnlyResource.

type RetentionPolicy 

type RetentionPolicy struct {
	// Enabled - A value indicating whether the retention policy is enabled.
	Enabled *bool `json:"enabled,omitempty"`
	// Days - The number of days for the retention in days. A value of 0 will retain the events indefinitely.
	Days *int32 `json:"days,omitempty"`
}

RetentionPolicy specifies the retention policy for the log.

Source Files

View all Source files

Directories

Path Synopsis

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.