purview

package
v63.1.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Apr 5, 2022 License: MIT Imports: 10 Imported by: 0

Documentation

Overview

Package purview implements the Azure ARM Purview service API version 2020-12-01-preview.

Creates a Microsoft.Purview management client.

Index

Constants

View Source 
const (
	// DefaultBaseURI is the default URI used for the service Purview
	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 AccessKeys 

type AccessKeys struct {
	autorest.Response `json:"-"`
	// AtlasKafkaPrimaryEndpoint - Gets or sets the primary connection string.
	AtlasKafkaPrimaryEndpoint *string `json:"atlasKafkaPrimaryEndpoint,omitempty"`
	// AtlasKafkaSecondaryEndpoint - Gets or sets the secondary connection string.
	AtlasKafkaSecondaryEndpoint *string `json:"atlasKafkaSecondaryEndpoint,omitempty"`
}

AccessKeys the Account access keys.

type Account 

type Account struct {
	autorest.Response `json:"-"`
	// AccountProperties - Gets or sets the properties.
	*AccountProperties `json:"properties,omitempty"`
	// Sku - Gets or sets the Sku.
	Sku *AccountSku `json:"sku,omitempty"`
	// ID - READ-ONLY; Gets or sets the identifier.
	ID *string `json:"id,omitempty"`
	// Identity - Identity Info on the tracked resource
	Identity *Identity `json:"identity,omitempty"`
	// Location - Gets or sets the location.
	Location *string `json:"location,omitempty"`
	// Name - READ-ONLY; Gets or sets the name.
	Name *string `json:"name,omitempty"`
	// Tags - Tags on the azure resource.
	Tags map[string]*string `json:"tags"`
	// Type - READ-ONLY; Gets or sets the type.
	Type *string `json:"type,omitempty"`
}

Account account resource

func (Account) MarshalJSON 

func (a Account) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Account.

func (*Account) UnmarshalJSON 

func (a *Account) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Account struct.

type AccountEndpoints 

type AccountEndpoints struct {
	// Catalog - READ-ONLY; Gets the catalog endpoint.
	Catalog *string `json:"catalog,omitempty"`
	// Guardian - READ-ONLY; Gets the guardian endpoint.
	Guardian *string `json:"guardian,omitempty"`
	// Scan - READ-ONLY; Gets the scan endpoint.
	Scan *string `json:"scan,omitempty"`
}

AccountEndpoints the account endpoints

func (AccountEndpoints) MarshalJSON 

func (ae AccountEndpoints) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AccountEndpoints.

type AccountList 

type AccountList struct {
	autorest.Response `json:"-"`
	// Count - Total item count.
	Count *int64 `json:"count,omitempty"`
	// NextLink - The Url of next result page.
	NextLink *string `json:"nextLink,omitempty"`
	// Value - Collection of items of type results.
	Value *[]Account `json:"value,omitempty"`
}

AccountList paged list of account resources

func (AccountList) IsEmpty 

func (al AccountList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type AccountListIterator 

type AccountListIterator struct {
	// contains filtered or unexported fields
}

AccountListIterator provides access to a complete listing of Account values.

func NewAccountListIterator 

func NewAccountListIterator(page AccountListPage) AccountListIterator

Creates a new instance of the AccountListIterator type.

func (*AccountListIterator) Next 

func (iter *AccountListIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*AccountListIterator) NextWithContext 

func (iter *AccountListIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (AccountListIterator) NotDone 

func (iter AccountListIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (AccountListIterator) Response 

func (iter AccountListIterator) Response() AccountList

Response returns the raw server response from the last page request.

func (AccountListIterator) Value 

func (iter AccountListIterator) Value() Account

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type AccountListPage 

type AccountListPage struct {
	// contains filtered or unexported fields
}

AccountListPage contains a page of Account values.

func NewAccountListPage 

func NewAccountListPage(cur AccountList, getNextPage func(context.Context, AccountList) (AccountList, error)) AccountListPage

Creates a new instance of the AccountListPage type.

func (*AccountListPage) Next 

func (page *AccountListPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*AccountListPage) NextWithContext 

func (page *AccountListPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (AccountListPage) NotDone 

func (page AccountListPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (AccountListPage) Response 

func (page AccountListPage) Response() AccountList

Response returns the raw server response from the last page request.

func (AccountListPage) Values 

func (page AccountListPage) Values() []Account

Values returns the slice of values for the current page or nil if there are no values.

type AccountProperties 

type AccountProperties struct {
	// CloudConnectors - Cloud connectors.
	// External cloud identifier used as part of scanning configuration.
	CloudConnectors *CloudConnectors `json:"cloudConnectors,omitempty"`
	// CreatedAt - READ-ONLY; Gets the time at which the entity was created.
	CreatedAt *date.Time `json:"createdAt,omitempty"`
	// CreatedBy - READ-ONLY; Gets the creator of the entity.
	CreatedBy *string `json:"createdBy,omitempty"`
	// CreatedByObjectID - READ-ONLY; Gets the creators of the entity's object id.
	CreatedByObjectID *string `json:"createdByObjectId,omitempty"`
	// Endpoints - READ-ONLY; The URIs that are the public endpoints of the account.
	Endpoints *AccountPropertiesEndpoints `json:"endpoints,omitempty"`
	// FriendlyName - READ-ONLY; Gets or sets the friendly name.
	FriendlyName *string `json:"friendlyName,omitempty"`
	// ManagedResources - READ-ONLY; Gets the resource identifiers of the managed resources.
	ManagedResources *AccountPropertiesManagedResources `json:"managedResources,omitempty"`
	// PrivateEndpointConnections - READ-ONLY; Gets the private endpoint connections information.
	PrivateEndpointConnections *[]PrivateEndpointConnection `json:"privateEndpointConnections,omitempty"`
	// ProvisioningState - READ-ONLY; Gets or sets the state of the provisioning. Possible values include: 'Unknown', 'Creating', 'Moving', 'Deleting', 'SoftDeleting', 'SoftDeleted', 'Failed', 'Succeeded'
	ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
	// PublicNetworkAccess - Gets or sets the public network access. Possible values include: 'NotSpecified', 'Enabled', 'Disabled'
	PublicNetworkAccess PublicNetworkAccess `json:"publicNetworkAccess,omitempty"`
}

AccountProperties the account properties

func (AccountProperties) MarshalJSON 

func (ap AccountProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AccountProperties.

type AccountPropertiesEndpoints 

type AccountPropertiesEndpoints struct {
	// Catalog - READ-ONLY; Gets the catalog endpoint.
	Catalog *string `json:"catalog,omitempty"`
	// Guardian - READ-ONLY; Gets the guardian endpoint.
	Guardian *string `json:"guardian,omitempty"`
	// Scan - READ-ONLY; Gets the scan endpoint.
	Scan *string `json:"scan,omitempty"`
}

AccountPropertiesEndpoints the URIs that are the public endpoints of the account.

func (AccountPropertiesEndpoints) MarshalJSON 

func (ap AccountPropertiesEndpoints) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AccountPropertiesEndpoints.

type AccountPropertiesManagedResources 

type AccountPropertiesManagedResources struct {
	// EventHubNamespace - READ-ONLY; Gets the managed event hub namespace resource identifier.
	EventHubNamespace *string `json:"eventHubNamespace,omitempty"`
	// ResourceGroup - READ-ONLY; Gets the managed resource group resource identifier. This resource group will host resource dependencies for the account.
	ResourceGroup *string `json:"resourceGroup,omitempty"`
	// StorageAccount - READ-ONLY; Gets the managed storage account resource identifier.
	StorageAccount *string `json:"storageAccount,omitempty"`
}

AccountPropertiesManagedResources gets the resource identifiers of the managed resources.

func (AccountPropertiesManagedResources) MarshalJSON 

func (apR AccountPropertiesManagedResources) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AccountPropertiesManagedResources.

type AccountSku 

type AccountSku struct {
	// Capacity - Gets or sets the sku capacity. Possible values include: 4, 16
	Capacity *int32 `json:"capacity,omitempty"`
	// Name - Gets or sets the sku name. Possible values include: 'Standard'
	Name Name `json:"name,omitempty"`
}

AccountSku the Sku

type AccountUpdateParameters 

type AccountUpdateParameters struct {
	// AccountProperties - The account properties.
	*AccountProperties `json:"properties,omitempty"`
	// Tags - Tags on the azure resource.
	Tags map[string]*string `json:"tags"`
}

AccountUpdateParameters the account update properties.

func (AccountUpdateParameters) MarshalJSON 

func (aup AccountUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AccountUpdateParameters.

func (*AccountUpdateParameters) UnmarshalJSON 

func (aup *AccountUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for AccountUpdateParameters struct.

type AccountsClient 

type AccountsClient struct {
	BaseClient
}

AccountsClient is the creates a Microsoft.Purview management client.

func NewAccountsClient 

func NewAccountsClient(subscriptionID string) AccountsClient

NewAccountsClient creates an instance of the AccountsClient client.

func NewAccountsClientWithBaseURI 

func NewAccountsClientWithBaseURI(baseURI string, subscriptionID string) AccountsClient

NewAccountsClientWithBaseURI creates an instance of the AccountsClient 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 (AccountsClient) CheckNameAvailability 

func (client AccountsClient) CheckNameAvailability(ctx context.Context, checkNameAvailabilityRequest CheckNameAvailabilityRequest) (result CheckNameAvailabilityResult, err error)

CheckNameAvailability checks if account name is available. Parameters: checkNameAvailabilityRequest - the check name availability request.

func (AccountsClient) CheckNameAvailabilityPreparer 

func (client AccountsClient) CheckNameAvailabilityPreparer(ctx context.Context, checkNameAvailabilityRequest CheckNameAvailabilityRequest) (*http.Request, error)

CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.

func (AccountsClient) CheckNameAvailabilityResponder 

func (client AccountsClient) CheckNameAvailabilityResponder(resp *http.Response) (result CheckNameAvailabilityResult, err error)

CheckNameAvailabilityResponder handles the response to the CheckNameAvailability request. The method always closes the http.Response Body.

func (AccountsClient) CheckNameAvailabilitySender 

func (client AccountsClient) CheckNameAvailabilitySender(req *http.Request) (*http.Response, error)

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

func (AccountsClient) CreateOrUpdate 

func (client AccountsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, accountName string, account Account) (result AccountsCreateOrUpdateFuture, err error)

CreateOrUpdate creates or updates an account Parameters: resourceGroupName - the resource group name. accountName - the name of the account. account - the account.

func (AccountsClient) CreateOrUpdatePreparer 

func (client AccountsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, account Account) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (AccountsClient) CreateOrUpdateResponder 

func (client AccountsClient) CreateOrUpdateResponder(resp *http.Response) (result Account, err error)

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

func (AccountsClient) CreateOrUpdateSender 

func (client AccountsClient) CreateOrUpdateSender(req *http.Request) (future AccountsCreateOrUpdateFuture, err error)

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

func (AccountsClient) Delete 

func (client AccountsClient) Delete(ctx context.Context, resourceGroupName string, accountName string) (result AccountsDeleteFuture, err error)

Delete deletes an account resource Parameters: resourceGroupName - the resource group name. accountName - the name of the account.

func (AccountsClient) DeletePreparer 

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

DeletePreparer prepares the Delete request.

func (AccountsClient) DeleteResponder 

func (client AccountsClient) 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 (AccountsClient) DeleteSender 

func (client AccountsClient) DeleteSender(req *http.Request) (future AccountsDeleteFuture, err error)

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

func (AccountsClient) Get 

func (client AccountsClient) Get(ctx context.Context, resourceGroupName string, accountName string) (result Account, err error)

Get get an account Parameters: resourceGroupName - the resource group name. accountName - the name of the account.

func (AccountsClient) GetPreparer 

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

GetPreparer prepares the Get request.

func (AccountsClient) GetResponder 

func (client AccountsClient) GetResponder(resp *http.Response) (result Account, err error)

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

func (AccountsClient) GetSender 

func (client AccountsClient) 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 (AccountsClient) ListByResourceGroup 

func (client AccountsClient) ListByResourceGroup(ctx context.Context, resourceGroupName string, skipToken string) (result AccountListPage, err error)

ListByResourceGroup list accounts in ResourceGroup Parameters: resourceGroupName - the resource group name. skipToken - the skip token.

func (AccountsClient) ListByResourceGroupComplete 

func (client AccountsClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string, skipToken string) (result AccountListIterator, err error)

ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.

func (AccountsClient) ListByResourceGroupPreparer 

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

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (AccountsClient) ListByResourceGroupResponder 

func (client AccountsClient) ListByResourceGroupResponder(resp *http.Response) (result AccountList, err error)

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

func (AccountsClient) ListByResourceGroupSender 

func (client AccountsClient) 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 (AccountsClient) ListBySubscription 

func (client AccountsClient) ListBySubscription(ctx context.Context, skipToken string) (result AccountListPage, err error)

ListBySubscription list accounts in Subscription Parameters: skipToken - the skip token.

func (AccountsClient) ListBySubscriptionComplete 

func (client AccountsClient) ListBySubscriptionComplete(ctx context.Context, skipToken string) (result AccountListIterator, err error)

ListBySubscriptionComplete enumerates all values, automatically crossing page boundaries as required.

func (AccountsClient) ListBySubscriptionPreparer 

func (client AccountsClient) ListBySubscriptionPreparer(ctx context.Context, skipToken string) (*http.Request, error)

ListBySubscriptionPreparer prepares the ListBySubscription request.

func (AccountsClient) ListBySubscriptionResponder 

func (client AccountsClient) ListBySubscriptionResponder(resp *http.Response) (result AccountList, err error)

ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.

func (AccountsClient) ListBySubscriptionSender 

func (client AccountsClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)

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

func (AccountsClient) ListKeys 

func (client AccountsClient) ListKeys(ctx context.Context, resourceGroupName string, accountName string) (result AccessKeys, err error)

ListKeys list the authorization keys associated with this account. Parameters: resourceGroupName - the resource group name. accountName - the name of the account.

func (AccountsClient) ListKeysPreparer 

func (client AccountsClient) ListKeysPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)

ListKeysPreparer prepares the ListKeys request.

func (AccountsClient) ListKeysResponder 

func (client AccountsClient) ListKeysResponder(resp *http.Response) (result AccessKeys, err error)

ListKeysResponder handles the response to the ListKeys request. The method always closes the http.Response Body.

func (AccountsClient) ListKeysSender 

func (client AccountsClient) ListKeysSender(req *http.Request) (*http.Response, error)

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

func (AccountsClient) Update 

func (client AccountsClient) Update(ctx context.Context, resourceGroupName string, accountName string, accountUpdateParameters AccountUpdateParameters) (result AccountsUpdateFuture, err error)

Update updates an account Parameters: resourceGroupName - the resource group name. accountName - the name of the account. accountUpdateParameters - the account update parameters.

func (AccountsClient) UpdatePreparer 

func (client AccountsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, accountUpdateParameters AccountUpdateParameters) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (AccountsClient) UpdateResponder 

func (client AccountsClient) UpdateResponder(resp *http.Response) (result Account, err error)

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

func (AccountsClient) UpdateSender 

func (client AccountsClient) UpdateSender(req *http.Request) (future AccountsUpdateFuture, err error)

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

type AccountsCreateOrUpdateFuture 

type AccountsCreateOrUpdateFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(AccountsClient) (Account, error)
}

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

func (*AccountsCreateOrUpdateFuture) UnmarshalJSON 

func (future *AccountsCreateOrUpdateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type AccountsDeleteFuture 

type AccountsDeleteFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(AccountsClient) (autorest.Response, error)
}

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

func (*AccountsDeleteFuture) UnmarshalJSON 

func (future *AccountsDeleteFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type AccountsUpdateFuture 

type AccountsUpdateFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(AccountsClient) (Account, error)
}

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

func (*AccountsUpdateFuture) UnmarshalJSON 

func (future *AccountsUpdateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type BaseClient 

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

BaseClient is the base client for Purview.

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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

type CheckNameAvailabilityRequest 

type CheckNameAvailabilityRequest struct {
	// Name - Resource name to verify for availability
	Name *string `json:"name,omitempty"`
	// Type - Fully qualified resource type which includes provider namespace
	Type *string `json:"type,omitempty"`
}

CheckNameAvailabilityRequest the request payload for CheckNameAvailability API

type CheckNameAvailabilityResult 

type CheckNameAvailabilityResult struct {
	autorest.Response `json:"-"`
	// Message - Error message
	Message *string `json:"message,omitempty"`
	// NameAvailable - Indicates if name is valid and available.
	NameAvailable *bool `json:"nameAvailable,omitempty"`
	// Reason - The reason the name is not available. Possible values include: 'Invalid', 'AlreadyExists'
	Reason Reason `json:"reason,omitempty"`
}

CheckNameAvailabilityResult the response payload for CheckNameAvailability API

type CloudConnectors 

type CloudConnectors struct {
	// AwsExternalID - READ-ONLY; AWS external identifier.
	// Configured in AWS to allow use of the role arn used for scanning
	AwsExternalID *string `json:"awsExternalId,omitempty"`
}

CloudConnectors properties for configuring third party cloud connections.

func (CloudConnectors) MarshalJSON 

func (cc CloudConnectors) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CloudConnectors.

type DefaultAccountPayload 

type DefaultAccountPayload struct {
	autorest.Response `json:"-"`
	// AccountName - The name of the account that is set as the default.
	AccountName *string `json:"accountName,omitempty"`
	// ResourceGroupName - The resource group name of the account that is set as the default.
	ResourceGroupName *string `json:"resourceGroupName,omitempty"`
	// Scope - The scope object ID. For example, sub ID or tenant ID.
	Scope *string `json:"scope,omitempty"`
	// ScopeTenantID - The scope tenant in which the default account is set.
	ScopeTenantID *string `json:"scopeTenantId,omitempty"`
	// ScopeType - The scope where the default account is set. Possible values include: 'Tenant', 'Subscription'
	ScopeType ScopeType `json:"scopeType,omitempty"`
	// SubscriptionID - The subscription ID of the account that is set as the default.
	SubscriptionID *string `json:"subscriptionId,omitempty"`
}

DefaultAccountPayload payload to get and set the default account in the given scope

type DefaultAccountsClient 

type DefaultAccountsClient struct {
	BaseClient
}

DefaultAccountsClient is the creates a Microsoft.Purview management client.

func NewDefaultAccountsClient 

func NewDefaultAccountsClient(subscriptionID string) DefaultAccountsClient

NewDefaultAccountsClient creates an instance of the DefaultAccountsClient client.

func NewDefaultAccountsClientWithBaseURI 

func NewDefaultAccountsClientWithBaseURI(baseURI string, subscriptionID string) DefaultAccountsClient

NewDefaultAccountsClientWithBaseURI creates an instance of the DefaultAccountsClient 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 (DefaultAccountsClient) Get 

func (client DefaultAccountsClient) Get(ctx context.Context, scopeTenantID uuid.UUID, scopeType ScopeType, scope string) (result DefaultAccountPayload, err error)

Get get the default account for the scope. Parameters: scopeTenantID - the tenant ID. scopeType - the scope for the default account. scope - the Id of the scope object, for example if the scope is "Subscription" then it is the ID of that subscription.

func (DefaultAccountsClient) GetPreparer 

func (client DefaultAccountsClient) GetPreparer(ctx context.Context, scopeTenantID uuid.UUID, scopeType ScopeType, scope string) (*http.Request, error)

GetPreparer prepares the Get request.

func (DefaultAccountsClient) GetResponder 

func (client DefaultAccountsClient) GetResponder(resp *http.Response) (result DefaultAccountPayload, err error)

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

func (DefaultAccountsClient) GetSender 

func (client DefaultAccountsClient) 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 (DefaultAccountsClient) Remove 

func (client DefaultAccountsClient) Remove(ctx context.Context, scopeTenantID uuid.UUID, scopeType ScopeType, scope string) (result autorest.Response, err error)

Remove remove the default account from the scope. Parameters: scopeTenantID - the tenant ID. scopeType - the scope for the default account. scope - the Id of the scope object, for example if the scope is "Subscription" then it is the ID of that subscription.

func (DefaultAccountsClient) RemovePreparer 

func (client DefaultAccountsClient) RemovePreparer(ctx context.Context, scopeTenantID uuid.UUID, scopeType ScopeType, scope string) (*http.Request, error)

RemovePreparer prepares the Remove request.

func (DefaultAccountsClient) RemoveResponder 

func (client DefaultAccountsClient) RemoveResponder(resp *http.Response) (result autorest.Response, err error)

RemoveResponder handles the response to the Remove request. The method always closes the http.Response Body.

func (DefaultAccountsClient) RemoveSender 

func (client DefaultAccountsClient) RemoveSender(req *http.Request) (*http.Response, error)

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

func (DefaultAccountsClient) Set 

func (client DefaultAccountsClient) Set(ctx context.Context, defaultAccountPayload DefaultAccountPayload) (result DefaultAccountPayload, err error)

Set set the default account for the scope. Parameters: defaultAccountPayload - the payload containing the default account information and the scope.

func (DefaultAccountsClient) SetPreparer 

func (client DefaultAccountsClient) SetPreparer(ctx context.Context, defaultAccountPayload DefaultAccountPayload) (*http.Request, error)

SetPreparer prepares the Set request.

func (DefaultAccountsClient) SetResponder 

func (client DefaultAccountsClient) SetResponder(resp *http.Response) (result DefaultAccountPayload, err error)

SetResponder handles the response to the Set request. The method always closes the http.Response Body.

func (DefaultAccountsClient) SetSender 

func (client DefaultAccountsClient) SetSender(req *http.Request) (*http.Response, error)

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

type DeletedAccount 

type DeletedAccount struct {
	// DeletedAccountProperties - READ-ONLY; Gets or sets the properties.
	*DeletedAccountProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; Gets or sets the identifier.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Gets or sets the name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Gets or sets the type.
	Type *string `json:"type,omitempty"`
}

DeletedAccount soft Deleted Account resource

func (DeletedAccount) MarshalJSON 

func (da DeletedAccount) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DeletedAccount.

func (*DeletedAccount) UnmarshalJSON 

func (da *DeletedAccount) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for DeletedAccount struct.

type DeletedAccountList 

type DeletedAccountList struct {
	// Count - Total item count.
	Count *int64 `json:"count,omitempty"`
	// NextLink - The Url of next result page.
	NextLink *string `json:"nextLink,omitempty"`
	// Value - Collection of items of type results.
	Value *[]DeletedAccount `json:"value,omitempty"`
}

DeletedAccountList paged list of soft deleted account resources

type DeletedAccountProperties 

type DeletedAccountProperties struct {
	// AccountID - READ-ONLY; Gets the account identifier associated with resource.
	AccountID *string `json:"accountId,omitempty"`
	// DeletedBy - READ-ONLY; Gets the user identifier that deleted resource.
	DeletedBy *string `json:"deletedBy,omitempty"`
	// DeletionDate - READ-ONLY; Gets the time at which the resource was soft deleted.
	DeletionDate *date.Time `json:"deletionDate,omitempty"`
	// Location - READ-ONLY; Gets the resource location.
	Location *string `json:"location,omitempty"`
	// ScheduledPurgeDate - READ-ONLY; Gets the scheduled purge datetime.
	ScheduledPurgeDate *date.Time `json:"scheduledPurgeDate,omitempty"`
	// Tags - READ-ONLY; Gets the account tags.
	Tags map[string]*string `json:"tags"`
}

DeletedAccountProperties gets or sets the properties.

func (DeletedAccountProperties) MarshalJSON 

func (da DeletedAccountProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DeletedAccountProperties.

type DeletedAccountPropertiesModel 

type DeletedAccountPropertiesModel struct {
	// AccountID - READ-ONLY; Gets the account identifier associated with resource.
	AccountID *string `json:"accountId,omitempty"`
	// DeletedBy - READ-ONLY; Gets the user identifier that deleted resource.
	DeletedBy *string `json:"deletedBy,omitempty"`
	// DeletionDate - READ-ONLY; Gets the time at which the resource was soft deleted.
	DeletionDate *date.Time `json:"deletionDate,omitempty"`
	// Location - READ-ONLY; Gets the resource location.
	Location *string `json:"location,omitempty"`
	// ScheduledPurgeDate - READ-ONLY; Gets the scheduled purge datetime.
	ScheduledPurgeDate *date.Time `json:"scheduledPurgeDate,omitempty"`
	// Tags - READ-ONLY; Gets the account tags.
	Tags map[string]*string `json:"tags"`
}

DeletedAccountPropertiesModel the soft deleted account properties

func (DeletedAccountPropertiesModel) MarshalJSON 

func (dapm DeletedAccountPropertiesModel) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DeletedAccountPropertiesModel.

type DimensionProperties 

type DimensionProperties struct {
	// DisplayName - localized display name of the dimension to customer
	DisplayName *string `json:"displayName,omitempty"`
	// Name - dimension name
	Name *string `json:"name,omitempty"`
	// ToBeExportedForCustomer - flag indicating whether this dimension should be included to the customer in Azure Monitor logs (aka Shoebox)
	ToBeExportedForCustomer *bool `json:"toBeExportedForCustomer,omitempty"`
}

DimensionProperties properties for dimension

type ErrorModel 

type ErrorModel struct {
	// Code - READ-ONLY; Gets or sets the code.
	Code *string `json:"code,omitempty"`
	// Details - READ-ONLY; Gets or sets the details.
	Details *[]ErrorModel `json:"details,omitempty"`
	// Message - READ-ONLY; Gets or sets the messages.
	Message *string `json:"message,omitempty"`
	// Target - READ-ONLY; Gets or sets the target.
	Target *string `json:"target,omitempty"`
}

ErrorModel default error model

func (ErrorModel) MarshalJSON 

func (em ErrorModel) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ErrorModel.

type ErrorResponseModel 

type ErrorResponseModel struct {
	// Error - READ-ONLY; Gets or sets the error.
	Error *ErrorResponseModelError `json:"error,omitempty"`
}

ErrorResponseModel default error response model

func (ErrorResponseModel) MarshalJSON 

func (erm ErrorResponseModel) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ErrorResponseModel.

type ErrorResponseModelError 

type ErrorResponseModelError struct {
	// Code - READ-ONLY; Gets or sets the code.
	Code *string `json:"code,omitempty"`
	// Details - READ-ONLY; Gets or sets the details.
	Details *[]ErrorModel `json:"details,omitempty"`
	// Message - READ-ONLY; Gets or sets the messages.
	Message *string `json:"message,omitempty"`
	// Target - READ-ONLY; Gets or sets the target.
	Target *string `json:"target,omitempty"`
}

ErrorResponseModelError gets or sets the error.

func (ErrorResponseModelError) MarshalJSON 

func (erm ErrorResponseModelError) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ErrorResponseModelError.

type Identity 

type Identity struct {
	// PrincipalID - READ-ONLY; Service principal object Id
	PrincipalID *string `json:"principalId,omitempty"`
	// TenantID - READ-ONLY; Tenant Id
	TenantID *string `json:"tenantId,omitempty"`
	// Type - Identity Type. Possible values include: 'SystemAssigned'
	Type Type `json:"type,omitempty"`
}

Identity the Managed Identity of the resource

func (Identity) MarshalJSON 

func (i Identity) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Identity.

type ManagedResources 

type ManagedResources struct {
	// EventHubNamespace - READ-ONLY; Gets the managed event hub namespace resource identifier.
	EventHubNamespace *string `json:"eventHubNamespace,omitempty"`
	// ResourceGroup - READ-ONLY; Gets the managed resource group resource identifier. This resource group will host resource dependencies for the account.
	ResourceGroup *string `json:"resourceGroup,omitempty"`
	// StorageAccount - READ-ONLY; Gets the managed storage account resource identifier.
	StorageAccount *string `json:"storageAccount,omitempty"`
}

ManagedResources the managed resources in customer subscription.

func (ManagedResources) MarshalJSON 

func (mr ManagedResources) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ManagedResources.

type Name 

type Name string

Name enumerates the values for name. 

const (
	// Standard ...
	Standard Name = "Standard"
)

func PossibleNameValues 

func PossibleNameValues() []Name

PossibleNameValues returns an array of possible values for the Name const type.

type Operation 

type Operation struct {
	// Display - Properties on the operation
	Display *OperationDisplay `json:"display,omitempty"`
	// IsDataAction - Whether operation is a data action
	IsDataAction *bool `json:"isDataAction,omitempty"`
	// Name - Operation name for display purposes
	Name *string `json:"name,omitempty"`
	// Origin - origin of the operation
	Origin *string `json:"origin,omitempty"`
	// OperationProperties - properties for the operation meta info
	*OperationProperties `json:"properties,omitempty"`
}

Operation operation resource

func (Operation) MarshalJSON 

func (o Operation) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Operation.

func (*Operation) UnmarshalJSON 

func (o *Operation) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Operation struct.

type OperationDisplay 

type OperationDisplay struct {
	// Description - Description of the operation for display purposes
	Description *string `json:"description,omitempty"`
	// Operation - Name of the operation for display purposes
	Operation *string `json:"operation,omitempty"`
	// Provider - Name of the provider for display purposes
	Provider *string `json:"provider,omitempty"`
	// Resource - Name of the resource type for display purposes
	Resource *string `json:"resource,omitempty"`
}

OperationDisplay the response model for get operation properties

type OperationList 

type OperationList struct {
	autorest.Response `json:"-"`
	// Count - Total item count.
	Count *int64 `json:"count,omitempty"`
	// NextLink - The Url of next result page.
	NextLink *string `json:"nextLink,omitempty"`
	// Value - Collection of items of type results.
	Value *[]Operation `json:"value,omitempty"`
}

OperationList paged list of operation resources

func (OperationList) IsEmpty 

func (ol OperationList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OperationListIterator 

type OperationListIterator struct {
	// contains filtered or unexported fields
}

OperationListIterator provides access to a complete listing of Operation values.

func NewOperationListIterator 

func NewOperationListIterator(page OperationListPage) OperationListIterator

Creates a new instance of the OperationListIterator type.

func (*OperationListIterator) Next 

func (iter *OperationListIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*OperationListIterator) NextWithContext 

func (iter *OperationListIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (OperationListIterator) NotDone 

func (iter OperationListIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (OperationListIterator) Response 

func (iter OperationListIterator) Response() OperationList

Response returns the raw server response from the last page request.

func (OperationListIterator) Value 

func (iter OperationListIterator) Value() Operation

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type OperationListPage 

type OperationListPage struct {
	// contains filtered or unexported fields
}

OperationListPage contains a page of Operation values.

func NewOperationListPage 

func NewOperationListPage(cur OperationList, getNextPage func(context.Context, OperationList) (OperationList, error)) OperationListPage

Creates a new instance of the OperationListPage type.

func (*OperationListPage) Next 

func (page *OperationListPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*OperationListPage) NextWithContext 

func (page *OperationListPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (OperationListPage) NotDone 

func (page OperationListPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (OperationListPage) Response 

func (page OperationListPage) Response() OperationList

Response returns the raw server response from the last page request.

func (OperationListPage) Values 

func (page OperationListPage) Values() []Operation

Values returns the slice of values for the current page or nil if there are no values.

type OperationMetaLogSpecification 

type OperationMetaLogSpecification struct {
	// BlobDuration - blob duration of the log
	BlobDuration *string `json:"blobDuration,omitempty"`
	// DisplayName - localized name of the log category
	DisplayName *string `json:"displayName,omitempty"`
	// Name - name of the log category
	Name *string `json:"name,omitempty"`
}

OperationMetaLogSpecification log specifications for operation api

type OperationMetaMetricSpecification 

type OperationMetaMetricSpecification struct {
	// AggregationType - aggregation type of metric
	AggregationType *string `json:"aggregationType,omitempty"`
	// Dimensions - properties for dimension
	Dimensions *[]DimensionProperties `json:"dimensions,omitempty"`
	// DisplayDescription - description of the metric
	DisplayDescription *string `json:"displayDescription,omitempty"`
	// DisplayName - localized name of the metric
	DisplayName *string `json:"displayName,omitempty"`
	// EnableRegionalMdmAccount - enable regional mdm account
	EnableRegionalMdmAccount *string `json:"enableRegionalMdmAccount,omitempty"`
	// InternalMetricName - internal metric name
	InternalMetricName *string `json:"internalMetricName,omitempty"`
	// Name - name of the metric
	Name *string `json:"name,omitempty"`
	// ResourceIDDimensionNameOverride - dimension name use to replace resource id if specified
	ResourceIDDimensionNameOverride *string `json:"resourceIdDimensionNameOverride,omitempty"`
	// SourceMdmNamespace - Metric namespace.
	// Only set the namespace if different from the default value,
	// leaving it empty makes it use the value from the ARM manifest.
	SourceMdmNamespace *string `json:"sourceMdmNamespace,omitempty"`
	// SupportedAggregationTypes - supported aggregation types
	SupportedAggregationTypes *[]string `json:"supportedAggregationTypes,omitempty"`
	// SupportedTimeGrainTypes - supported time grain types
	SupportedTimeGrainTypes *[]string `json:"supportedTimeGrainTypes,omitempty"`
	// Unit - units for the metric
	Unit *string `json:"unit,omitempty"`
}

OperationMetaMetricSpecification metric specifications for the operation

type OperationMetaServiceSpecification 

type OperationMetaServiceSpecification struct {
	// LogSpecifications - log specifications for the operation
	LogSpecifications *[]OperationMetaLogSpecification `json:"logSpecifications,omitempty"`
	// MetricSpecifications - metric specifications for the operation
	MetricSpecifications *[]OperationMetaMetricSpecification `json:"metricSpecifications,omitempty"`
}

OperationMetaServiceSpecification the operation meta service specification

type OperationProperties 

type OperationProperties struct {
	// ServiceSpecification - meta service specification
	ServiceSpecification *OperationMetaServiceSpecification `json:"serviceSpecification,omitempty"`
}

OperationProperties properties on meta info

type OperationsClient 

type OperationsClient struct {
	BaseClient
}

OperationsClient is the creates a Microsoft.Purview management client.

func NewOperationsClient 

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI 

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID 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 OperationListPage, err error)

List list of available operations

func (OperationsClient) ListComplete 

func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

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 OperationList, 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 PrivateEndpoint 

type PrivateEndpoint struct {
	// ID - The private endpoint identifier.
	ID *string `json:"id,omitempty"`
}

PrivateEndpoint a private endpoint class.

type PrivateEndpointConnection 

type PrivateEndpointConnection struct {
	autorest.Response `json:"-"`
	// PrivateEndpointConnectionProperties - The connection identifier.
	*PrivateEndpointConnectionProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; Gets or sets the identifier.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Gets or sets the name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Gets or sets the type.
	Type *string `json:"type,omitempty"`
}

PrivateEndpointConnection a private endpoint connection class.

func (PrivateEndpointConnection) MarshalJSON 

func (pec PrivateEndpointConnection) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PrivateEndpointConnection.

func (*PrivateEndpointConnection) UnmarshalJSON 

func (pec *PrivateEndpointConnection) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for PrivateEndpointConnection struct.

type PrivateEndpointConnectionList 

type PrivateEndpointConnectionList struct {
	autorest.Response `json:"-"`
	// Count - Total item count.
	Count *int64 `json:"count,omitempty"`
	// NextLink - The Url of next result page.
	NextLink *string `json:"nextLink,omitempty"`
	// Value - Collection of items of type results.
	Value *[]PrivateEndpointConnection `json:"value,omitempty"`
}

PrivateEndpointConnectionList paged list of private endpoint connections

func (PrivateEndpointConnectionList) IsEmpty 

func (pecl PrivateEndpointConnectionList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type PrivateEndpointConnectionListIterator 

type PrivateEndpointConnectionListIterator struct {
	// contains filtered or unexported fields
}

PrivateEndpointConnectionListIterator provides access to a complete listing of PrivateEndpointConnection values.

func NewPrivateEndpointConnectionListIterator 

func NewPrivateEndpointConnectionListIterator(page PrivateEndpointConnectionListPage) PrivateEndpointConnectionListIterator

Creates a new instance of the PrivateEndpointConnectionListIterator type.

func (*PrivateEndpointConnectionListIterator) Next 

func (iter *PrivateEndpointConnectionListIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*PrivateEndpointConnectionListIterator) NextWithContext 

func (iter *PrivateEndpointConnectionListIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (PrivateEndpointConnectionListIterator) NotDone 

func (iter PrivateEndpointConnectionListIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (PrivateEndpointConnectionListIterator) Response 

func (iter PrivateEndpointConnectionListIterator) Response() PrivateEndpointConnectionList

Response returns the raw server response from the last page request.

func (PrivateEndpointConnectionListIterator) Value 

func (iter PrivateEndpointConnectionListIterator) Value() PrivateEndpointConnection

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type PrivateEndpointConnectionListPage 

type PrivateEndpointConnectionListPage struct {
	// contains filtered or unexported fields
}

PrivateEndpointConnectionListPage contains a page of PrivateEndpointConnection values.

func NewPrivateEndpointConnectionListPage 

func NewPrivateEndpointConnectionListPage(cur PrivateEndpointConnectionList, getNextPage func(context.Context, PrivateEndpointConnectionList) (PrivateEndpointConnectionList, error)) PrivateEndpointConnectionListPage

Creates a new instance of the PrivateEndpointConnectionListPage type.

func (*PrivateEndpointConnectionListPage) Next 

func (page *PrivateEndpointConnectionListPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*PrivateEndpointConnectionListPage) NextWithContext 

func (page *PrivateEndpointConnectionListPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (PrivateEndpointConnectionListPage) NotDone 

func (page PrivateEndpointConnectionListPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (PrivateEndpointConnectionListPage) Response 

func (page PrivateEndpointConnectionListPage) Response() PrivateEndpointConnectionList

Response returns the raw server response from the last page request.

func (PrivateEndpointConnectionListPage) Values 

func (page PrivateEndpointConnectionListPage) Values() []PrivateEndpointConnection

Values returns the slice of values for the current page or nil if there are no values.

type PrivateEndpointConnectionProperties 

type PrivateEndpointConnectionProperties struct {
	// PrivateEndpoint - The private endpoint information.
	PrivateEndpoint *PrivateEndpoint `json:"privateEndpoint,omitempty"`
	// PrivateLinkServiceConnectionState - The private link service connection state.
	PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionState `json:"privateLinkServiceConnectionState,omitempty"`
	// ProvisioningState - READ-ONLY; The provisioning state.
	ProvisioningState *string `json:"provisioningState,omitempty"`
}

PrivateEndpointConnectionProperties a private endpoint connection properties class.

func (PrivateEndpointConnectionProperties) MarshalJSON 

func (pecp PrivateEndpointConnectionProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PrivateEndpointConnectionProperties.

type PrivateEndpointConnectionsClient 

type PrivateEndpointConnectionsClient struct {
	BaseClient
}

PrivateEndpointConnectionsClient is the creates a Microsoft.Purview management client.

func NewPrivateEndpointConnectionsClient 

func NewPrivateEndpointConnectionsClient(subscriptionID string) PrivateEndpointConnectionsClient

NewPrivateEndpointConnectionsClient creates an instance of the PrivateEndpointConnectionsClient client.

func NewPrivateEndpointConnectionsClientWithBaseURI 

func NewPrivateEndpointConnectionsClientWithBaseURI(baseURI string, subscriptionID string) PrivateEndpointConnectionsClient

NewPrivateEndpointConnectionsClientWithBaseURI creates an instance of the PrivateEndpointConnectionsClient 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 (PrivateEndpointConnectionsClient) CreateOrUpdate 

func (client PrivateEndpointConnectionsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, accountName string, privateEndpointConnectionName string, request PrivateEndpointConnection) (result PrivateEndpointConnection, err error)

CreateOrUpdate create or update a private endpoint connection Parameters: resourceGroupName - the resource group name. accountName - the name of the account. privateEndpointConnectionName - name of the private endpoint connection. request - the request.

func (PrivateEndpointConnectionsClient) CreateOrUpdatePreparer 

func (client PrivateEndpointConnectionsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, privateEndpointConnectionName string, request PrivateEndpointConnection) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (PrivateEndpointConnectionsClient) CreateOrUpdateResponder 

func (client PrivateEndpointConnectionsClient) CreateOrUpdateResponder(resp *http.Response) (result PrivateEndpointConnection, err error)

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

func (PrivateEndpointConnectionsClient) CreateOrUpdateSender 

func (client PrivateEndpointConnectionsClient) 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 (PrivateEndpointConnectionsClient) Delete 

func (client PrivateEndpointConnectionsClient) Delete(ctx context.Context, resourceGroupName string, accountName string, privateEndpointConnectionName string) (result PrivateEndpointConnectionsDeleteFuture, err error)

Delete delete a private endpoint connection Parameters: resourceGroupName - the resource group name. accountName - the name of the account. privateEndpointConnectionName - name of the private endpoint connection.

func (PrivateEndpointConnectionsClient) DeletePreparer 

func (client PrivateEndpointConnectionsClient) DeletePreparer(ctx context.Context, resourceGroupName string, accountName string, privateEndpointConnectionName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (PrivateEndpointConnectionsClient) DeleteResponder 

func (client PrivateEndpointConnectionsClient) 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 (PrivateEndpointConnectionsClient) DeleteSender 

func (client PrivateEndpointConnectionsClient) DeleteSender(req *http.Request) (future PrivateEndpointConnectionsDeleteFuture, err error)

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

func (PrivateEndpointConnectionsClient) Get 

func (client PrivateEndpointConnectionsClient) Get(ctx context.Context, resourceGroupName string, accountName string, privateEndpointConnectionName string) (result PrivateEndpointConnection, err error)

Get get a private endpoint connection Parameters: resourceGroupName - the resource group name. accountName - the name of the account. privateEndpointConnectionName - name of the private endpoint connection.

func (PrivateEndpointConnectionsClient) GetPreparer 

func (client PrivateEndpointConnectionsClient) GetPreparer(ctx context.Context, resourceGroupName string, accountName string, privateEndpointConnectionName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (PrivateEndpointConnectionsClient) GetResponder 

func (client PrivateEndpointConnectionsClient) GetResponder(resp *http.Response) (result PrivateEndpointConnection, err error)

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

func (PrivateEndpointConnectionsClient) GetSender 

func (client PrivateEndpointConnectionsClient) 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 (PrivateEndpointConnectionsClient) ListByAccount 

func (client PrivateEndpointConnectionsClient) ListByAccount(ctx context.Context, resourceGroupName string, accountName string, skipToken string) (result PrivateEndpointConnectionListPage, err error)

ListByAccount get private endpoint connections for account Parameters: resourceGroupName - the resource group name. accountName - the name of the account. skipToken - the skip token.

func (PrivateEndpointConnectionsClient) ListByAccountComplete 

func (client PrivateEndpointConnectionsClient) ListByAccountComplete(ctx context.Context, resourceGroupName string, accountName string, skipToken string) (result PrivateEndpointConnectionListIterator, err error)

ListByAccountComplete enumerates all values, automatically crossing page boundaries as required.

func (PrivateEndpointConnectionsClient) ListByAccountPreparer 

func (client PrivateEndpointConnectionsClient) ListByAccountPreparer(ctx context.Context, resourceGroupName string, accountName string, skipToken string) (*http.Request, error)

ListByAccountPreparer prepares the ListByAccount request.

func (PrivateEndpointConnectionsClient) ListByAccountResponder 

func (client PrivateEndpointConnectionsClient) ListByAccountResponder(resp *http.Response) (result PrivateEndpointConnectionList, err error)

ListByAccountResponder handles the response to the ListByAccount request. The method always closes the http.Response Body.

func (PrivateEndpointConnectionsClient) ListByAccountSender 

func (client PrivateEndpointConnectionsClient) ListByAccountSender(req *http.Request) (*http.Response, error)

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

type PrivateEndpointConnectionsDeleteFuture 

type PrivateEndpointConnectionsDeleteFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(PrivateEndpointConnectionsClient) (autorest.Response, error)
}

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

func (*PrivateEndpointConnectionsDeleteFuture) UnmarshalJSON 

func (future *PrivateEndpointConnectionsDeleteFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type PrivateLinkResource 

type PrivateLinkResource struct {
	autorest.Response `json:"-"`
	// PrivateLinkResourceProperties - READ-ONLY; The private link resource properties.
	*PrivateLinkResourceProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; Gets or sets the identifier.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Gets or sets the name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Gets or sets the type.
	Type *string `json:"type,omitempty"`
}

PrivateLinkResource a privately linkable resource.

func (PrivateLinkResource) MarshalJSON 

func (plr PrivateLinkResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PrivateLinkResource.

func (*PrivateLinkResource) UnmarshalJSON 

func (plr *PrivateLinkResource) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for PrivateLinkResource struct.

type PrivateLinkResourceList 

type PrivateLinkResourceList struct {
	autorest.Response `json:"-"`
	// Count - Total item count.
	Count *int64 `json:"count,omitempty"`
	// NextLink - The Url of next result page.
	NextLink *string `json:"nextLink,omitempty"`
	// Value - Collection of items of type results.
	Value *[]PrivateLinkResource `json:"value,omitempty"`
}

PrivateLinkResourceList paged list of private link resources

func (PrivateLinkResourceList) IsEmpty 

func (plrl PrivateLinkResourceList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type PrivateLinkResourceListIterator 

type PrivateLinkResourceListIterator struct {
	// contains filtered or unexported fields
}

PrivateLinkResourceListIterator provides access to a complete listing of PrivateLinkResource values.

func NewPrivateLinkResourceListIterator 

func NewPrivateLinkResourceListIterator(page PrivateLinkResourceListPage) PrivateLinkResourceListIterator

Creates a new instance of the PrivateLinkResourceListIterator type.

func (*PrivateLinkResourceListIterator) Next 

func (iter *PrivateLinkResourceListIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*PrivateLinkResourceListIterator) NextWithContext 

func (iter *PrivateLinkResourceListIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (PrivateLinkResourceListIterator) NotDone 

func (iter PrivateLinkResourceListIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (PrivateLinkResourceListIterator) Response 

func (iter PrivateLinkResourceListIterator) Response() PrivateLinkResourceList

Response returns the raw server response from the last page request.

func (PrivateLinkResourceListIterator) Value 

func (iter PrivateLinkResourceListIterator) Value() PrivateLinkResource

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type PrivateLinkResourceListPage 

type PrivateLinkResourceListPage struct {
	// contains filtered or unexported fields
}

PrivateLinkResourceListPage contains a page of PrivateLinkResource values.

func NewPrivateLinkResourceListPage 

func NewPrivateLinkResourceListPage(cur PrivateLinkResourceList, getNextPage func(context.Context, PrivateLinkResourceList) (PrivateLinkResourceList, error)) PrivateLinkResourceListPage

Creates a new instance of the PrivateLinkResourceListPage type.

func (*PrivateLinkResourceListPage) Next 

func (page *PrivateLinkResourceListPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*PrivateLinkResourceListPage) NextWithContext 

func (page *PrivateLinkResourceListPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (PrivateLinkResourceListPage) NotDone 

func (page PrivateLinkResourceListPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (PrivateLinkResourceListPage) Response 

func (page PrivateLinkResourceListPage) Response() PrivateLinkResourceList

Response returns the raw server response from the last page request.

func (PrivateLinkResourceListPage) Values 

func (page PrivateLinkResourceListPage) Values() []PrivateLinkResource

Values returns the slice of values for the current page or nil if there are no values.

type PrivateLinkResourceProperties 

type PrivateLinkResourceProperties struct {
	// GroupID - READ-ONLY; The private link resource group identifier.
	GroupID *string `json:"groupId,omitempty"`
	// RequiredMembers - READ-ONLY; This translates to how many Private IPs should be created for each privately linkable resource.
	RequiredMembers *[]string `json:"requiredMembers,omitempty"`
	// RequiredZoneNames - READ-ONLY; The required zone names for private link resource.
	RequiredZoneNames *[]string `json:"requiredZoneNames,omitempty"`
}

PrivateLinkResourceProperties a privately linkable resource properties.

func (PrivateLinkResourceProperties) MarshalJSON 

func (plrp PrivateLinkResourceProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PrivateLinkResourceProperties.

type PrivateLinkResourcesClient 

type PrivateLinkResourcesClient struct {
	BaseClient
}

PrivateLinkResourcesClient is the creates a Microsoft.Purview management client.

func NewPrivateLinkResourcesClient 

func NewPrivateLinkResourcesClient(subscriptionID string) PrivateLinkResourcesClient

NewPrivateLinkResourcesClient creates an instance of the PrivateLinkResourcesClient client.

func NewPrivateLinkResourcesClientWithBaseURI 

func NewPrivateLinkResourcesClientWithBaseURI(baseURI string, subscriptionID string) PrivateLinkResourcesClient

NewPrivateLinkResourcesClientWithBaseURI creates an instance of the PrivateLinkResourcesClient 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 (PrivateLinkResourcesClient) GetByGroupID 

func (client PrivateLinkResourcesClient) GetByGroupID(ctx context.Context, resourceGroupName string, accountName string, groupID string) (result PrivateLinkResource, err error)

GetByGroupID gets a privately linkable resources for an account with given group identifier Parameters: resourceGroupName - the resource group name. accountName - the name of the account. groupID - the group identifier.

func (PrivateLinkResourcesClient) GetByGroupIDPreparer 

func (client PrivateLinkResourcesClient) GetByGroupIDPreparer(ctx context.Context, resourceGroupName string, accountName string, groupID string) (*http.Request, error)

GetByGroupIDPreparer prepares the GetByGroupID request.

func (PrivateLinkResourcesClient) GetByGroupIDResponder 

func (client PrivateLinkResourcesClient) GetByGroupIDResponder(resp *http.Response) (result PrivateLinkResource, err error)

GetByGroupIDResponder handles the response to the GetByGroupID request. The method always closes the http.Response Body.

func (PrivateLinkResourcesClient) GetByGroupIDSender 

func (client PrivateLinkResourcesClient) GetByGroupIDSender(req *http.Request) (*http.Response, error)

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

func (PrivateLinkResourcesClient) ListByAccount 

func (client PrivateLinkResourcesClient) ListByAccount(ctx context.Context, resourceGroupName string, accountName string) (result PrivateLinkResourceListPage, err error)

ListByAccount gets a list of privately linkable resources for an account Parameters: resourceGroupName - the resource group name. accountName - the name of the account.

func (PrivateLinkResourcesClient) ListByAccountComplete 

func (client PrivateLinkResourcesClient) ListByAccountComplete(ctx context.Context, resourceGroupName string, accountName string) (result PrivateLinkResourceListIterator, err error)

ListByAccountComplete enumerates all values, automatically crossing page boundaries as required.

func (PrivateLinkResourcesClient) ListByAccountPreparer 

func (client PrivateLinkResourcesClient) ListByAccountPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)

ListByAccountPreparer prepares the ListByAccount request.

func (PrivateLinkResourcesClient) ListByAccountResponder 

func (client PrivateLinkResourcesClient) ListByAccountResponder(resp *http.Response) (result PrivateLinkResourceList, err error)

ListByAccountResponder handles the response to the ListByAccount request. The method always closes the http.Response Body.

func (PrivateLinkResourcesClient) ListByAccountSender 

func (client PrivateLinkResourcesClient) ListByAccountSender(req *http.Request) (*http.Response, error)

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

type PrivateLinkServiceConnectionState 

type PrivateLinkServiceConnectionState struct {
	// ActionsRequired - The required actions.
	ActionsRequired *string `json:"actionsRequired,omitempty"`
	// Description - The description.
	Description *string `json:"description,omitempty"`
	// Status - The status. Possible values include: 'StatusUnknown', 'StatusPending', 'StatusApproved', 'StatusRejected', 'StatusDisconnected'
	Status Status `json:"status,omitempty"`
}

PrivateLinkServiceConnectionState the private link service connection state.

type ProvisioningState 

type ProvisioningState string

ProvisioningState enumerates the values for provisioning state. 

const (
	// Creating ...
	Creating ProvisioningState = "Creating"
	// Deleting ...
	Deleting ProvisioningState = "Deleting"
	// Failed ...
	Failed ProvisioningState = "Failed"
	// Moving ...
	Moving ProvisioningState = "Moving"
	// SoftDeleted ...
	SoftDeleted ProvisioningState = "SoftDeleted"
	// SoftDeleting ...
	SoftDeleting ProvisioningState = "SoftDeleting"
	// Succeeded ...
	Succeeded ProvisioningState = "Succeeded"
	// Unknown ...
	Unknown ProvisioningState = "Unknown"
)

func PossibleProvisioningStateValues 

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns an array of possible values for the ProvisioningState const type.

type ProxyResource 

type ProxyResource struct {
	// ID - READ-ONLY; Gets or sets the identifier.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Gets or sets the name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Gets or sets the type.
	Type *string `json:"type,omitempty"`
}

ProxyResource proxy Azure Resource

func (ProxyResource) MarshalJSON 

func (pr ProxyResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ProxyResource.

type PublicNetworkAccess 

type PublicNetworkAccess string

PublicNetworkAccess enumerates the values for public network access. 

const (
	// Disabled ...
	Disabled PublicNetworkAccess = "Disabled"
	// Enabled ...
	Enabled PublicNetworkAccess = "Enabled"
	// NotSpecified ...
	NotSpecified PublicNetworkAccess = "NotSpecified"
)

func PossiblePublicNetworkAccessValues 

func PossiblePublicNetworkAccessValues() []PublicNetworkAccess

PossiblePublicNetworkAccessValues returns an array of possible values for the PublicNetworkAccess const type.

type Reason 

type Reason string

Reason enumerates the values for reason. 

const (
	// AlreadyExists ...
	AlreadyExists Reason = "AlreadyExists"
	// Invalid ...
	Invalid Reason = "Invalid"
)

func PossibleReasonValues 

func PossibleReasonValues() []Reason

PossibleReasonValues returns an array of possible values for the Reason const type.

type ScopeType 

type ScopeType string

ScopeType enumerates the values for scope type. 

const (
	// Subscription ...
	Subscription ScopeType = "Subscription"
	// Tenant ...
	Tenant ScopeType = "Tenant"
)

func PossibleScopeTypeValues 

func PossibleScopeTypeValues() []ScopeType

PossibleScopeTypeValues returns an array of possible values for the ScopeType const type.

type Status 

type Status string

Status enumerates the values for status. 

const (
	// StatusApproved ...
	StatusApproved Status = "Approved"
	// StatusDisconnected ...
	StatusDisconnected Status = "Disconnected"
	// StatusPending ...
	StatusPending Status = "Pending"
	// StatusRejected ...
	StatusRejected Status = "Rejected"
	// StatusUnknown ...
	StatusUnknown Status = "Unknown"
)

func PossibleStatusValues 

func PossibleStatusValues() []Status

PossibleStatusValues returns an array of possible values for the Status const type.

type TrackedResource 

type TrackedResource struct {
	// ID - READ-ONLY; Gets or sets the identifier.
	ID *string `json:"id,omitempty"`
	// Identity - Identity Info on the tracked resource
	Identity *Identity `json:"identity,omitempty"`
	// Location - Gets or sets the location.
	Location *string `json:"location,omitempty"`
	// Name - READ-ONLY; Gets or sets the name.
	Name *string `json:"name,omitempty"`
	// Tags - Tags on the azure resource.
	Tags map[string]*string `json:"tags"`
	// Type - READ-ONLY; Gets or sets the type.
	Type *string `json:"type,omitempty"`
}

TrackedResource azure ARM Tracked Resource

func (TrackedResource) MarshalJSON 

func (tr TrackedResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TrackedResource.

type Type 

type Type string

Type enumerates the values for type. 

const (
	// SystemAssigned ...
	SystemAssigned Type = "SystemAssigned"
)

func PossibleTypeValues 

func PossibleTypeValues() []Type

PossibleTypeValues returns an array of possible values for the Type const type.

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.