Documentation

Overview

Package enterpriseknowledgegraphservice implements the Azure ARM Enterpriseknowledgegraphservice service API version 2018-12-03.

Azure Enterprise Knowledge Graph Service is a platform for creating knowledge graphs at scale.

Index

Constants

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

Variables

This section is empty.

Functions

func UserAgent

func UserAgent() string

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

func Version

func Version() string

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

Types

type BaseClient

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

BaseClient is the base client for Enterpriseknowledgegraphservice.

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 EnterpriseKnowledgeGraph

type EnterpriseKnowledgeGraph struct {
	autorest.Response `json:"-"`
	// Properties - The set of properties specific to EnterpriseKnowledgeGraph resource
	Properties *EnterpriseKnowledgeGraphProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; Specifies the resource ID.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Specifies the name of the resource.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Specifies the type of the resource.
	Type *string `json:"type,omitempty"`
	// Location - Specifies the location of the resource.
	Location *string `json:"location,omitempty"`
	// Tags - Contains resource tags defined as key/value pairs.
	Tags map[string]*string `json:"tags"`
	// Sku - Gets or sets the SKU of the resource.
	Sku *Sku `json:"sku,omitempty"`
}

EnterpriseKnowledgeGraph enterpriseKnowledgeGraph resource definition

func (EnterpriseKnowledgeGraph) MarshalJSON

func (ekg EnterpriseKnowledgeGraph) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for EnterpriseKnowledgeGraph.

type EnterpriseKnowledgeGraphClient

type EnterpriseKnowledgeGraphClient struct {
	BaseClient
}

EnterpriseKnowledgeGraphClient is the azure Enterprise Knowledge Graph Service is a platform for creating knowledge graphs at scale.

func NewEnterpriseKnowledgeGraphClient

func NewEnterpriseKnowledgeGraphClient(subscriptionID string) EnterpriseKnowledgeGraphClient

NewEnterpriseKnowledgeGraphClient creates an instance of the EnterpriseKnowledgeGraphClient client.

func NewEnterpriseKnowledgeGraphClientWithBaseURI

func NewEnterpriseKnowledgeGraphClientWithBaseURI(baseURI string, subscriptionID string) EnterpriseKnowledgeGraphClient

NewEnterpriseKnowledgeGraphClientWithBaseURI creates an instance of the EnterpriseKnowledgeGraphClient 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 (EnterpriseKnowledgeGraphClient) Create

func (client EnterpriseKnowledgeGraphClient) Create(ctx context.Context, resourceGroupName string, resourceName string, parameters EnterpriseKnowledgeGraph) (result EnterpriseKnowledgeGraph, err error)

Create creates a EnterpriseKnowledgeGraph Service. EnterpriseKnowledgeGraph Service is a resource group wide resource type. Parameters: resourceGroupName - the name of the EnterpriseKnowledgeGraph resource group in the user subscription. resourceName - the name of the EnterpriseKnowledgeGraph resource. parameters - the parameters to provide for the created EnterpriseKnowledgeGraph.

func (EnterpriseKnowledgeGraphClient) CreatePreparer

func (client EnterpriseKnowledgeGraphClient) CreatePreparer(ctx context.Context, resourceGroupName string, resourceName string, parameters EnterpriseKnowledgeGraph) (*http.Request, error)

CreatePreparer prepares the Create request.

func (EnterpriseKnowledgeGraphClient) CreateResponder

func (client EnterpriseKnowledgeGraphClient) CreateResponder(resp *http.Response) (result EnterpriseKnowledgeGraph, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (EnterpriseKnowledgeGraphClient) CreateSender

func (client EnterpriseKnowledgeGraphClient) CreateSender(req *http.Request) (*http.Response, error)

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

func (EnterpriseKnowledgeGraphClient) Delete

func (client EnterpriseKnowledgeGraphClient) Delete(ctx context.Context, resourceGroupName string, resourceName string) (result autorest.Response, err error)

Delete deletes a EnterpriseKnowledgeGraph Service from the resource group. Parameters: resourceGroupName - the name of the EnterpriseKnowledgeGraph resource group in the user subscription. resourceName - the name of the EnterpriseKnowledgeGraph resource.

func (EnterpriseKnowledgeGraphClient) DeletePreparer

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

DeletePreparer prepares the Delete request.

func (EnterpriseKnowledgeGraphClient) DeleteResponder

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

func (client EnterpriseKnowledgeGraphClient) 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 (EnterpriseKnowledgeGraphClient) Get

func (client EnterpriseKnowledgeGraphClient) Get(ctx context.Context, resourceGroupName string, resourceName string) (result EnterpriseKnowledgeGraph, err error)

Get returns a EnterpriseKnowledgeGraph service specified by the parameters. Parameters: resourceGroupName - the name of the EnterpriseKnowledgeGraph resource group in the user subscription. resourceName - the name of the EnterpriseKnowledgeGraph resource.

func (EnterpriseKnowledgeGraphClient) GetPreparer

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

GetPreparer prepares the Get request.

func (EnterpriseKnowledgeGraphClient) GetResponder

func (client EnterpriseKnowledgeGraphClient) GetResponder(resp *http.Response) (result EnterpriseKnowledgeGraph, err error)

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

func (EnterpriseKnowledgeGraphClient) GetSender

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

List returns all the resources of a particular type belonging to a subscription.

func (EnterpriseKnowledgeGraphClient) ListByResourceGroup

func (client EnterpriseKnowledgeGraphClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result EnterpriseKnowledgeGraphResponseListPage, err error)

ListByResourceGroup returns all the resources of a particular type belonging to a resource group Parameters: resourceGroupName - the name of the EnterpriseKnowledgeGraph resource group in the user subscription.

func (EnterpriseKnowledgeGraphClient) ListByResourceGroupComplete

func (client EnterpriseKnowledgeGraphClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result EnterpriseKnowledgeGraphResponseListIterator, err error)

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

func (EnterpriseKnowledgeGraphClient) ListByResourceGroupPreparer

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

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (EnterpriseKnowledgeGraphClient) ListByResourceGroupResponder

func (client EnterpriseKnowledgeGraphClient) ListByResourceGroupResponder(resp *http.Response) (result EnterpriseKnowledgeGraphResponseList, err error)

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

func (EnterpriseKnowledgeGraphClient) ListByResourceGroupSender

func (client EnterpriseKnowledgeGraphClient) 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 (EnterpriseKnowledgeGraphClient) ListComplete

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

func (EnterpriseKnowledgeGraphClient) ListPreparer

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

ListPreparer prepares the List request.

func (EnterpriseKnowledgeGraphClient) ListResponder

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

func (EnterpriseKnowledgeGraphClient) ListSender

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

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

func (EnterpriseKnowledgeGraphClient) Update

func (client EnterpriseKnowledgeGraphClient) Update(ctx context.Context, resourceGroupName string, resourceName string, parameters EnterpriseKnowledgeGraph) (result EnterpriseKnowledgeGraph, err error)

Update updates a EnterpriseKnowledgeGraph Service Parameters: resourceGroupName - the name of the EnterpriseKnowledgeGraph resource group in the user subscription. resourceName - the name of the EnterpriseKnowledgeGraph resource. parameters - the parameters to provide for the created EnterpriseKnowledgeGraph.

func (EnterpriseKnowledgeGraphClient) UpdatePreparer

func (client EnterpriseKnowledgeGraphClient) UpdatePreparer(ctx context.Context, resourceGroupName string, resourceName string, parameters EnterpriseKnowledgeGraph) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (EnterpriseKnowledgeGraphClient) UpdateResponder

func (client EnterpriseKnowledgeGraphClient) UpdateResponder(resp *http.Response) (result EnterpriseKnowledgeGraph, err error)

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

func (EnterpriseKnowledgeGraphClient) UpdateSender

func (client EnterpriseKnowledgeGraphClient) UpdateSender(req *http.Request) (*http.Response, error)

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

type EnterpriseKnowledgeGraphProperties

type EnterpriseKnowledgeGraphProperties struct {
	// Description - The description of the EnterpriseKnowledgeGraph
	Description *string `json:"description,omitempty"`
	// Metadata - Specifies the metadata  of the resource.
	Metadata interface{} `json:"metadata,omitempty"`
	// ProvisioningState - The state of EnterpriseKnowledgeGraph provisioning. Possible values include: 'Creating', 'Deleting', 'Failed', 'Succeeded'
	ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
}

EnterpriseKnowledgeGraphProperties the parameters to provide for the EnterpriseKnowledgeGraph.

type EnterpriseKnowledgeGraphResponseList

type EnterpriseKnowledgeGraphResponseList struct {
	autorest.Response `json:"-"`
	// NextLink - The link used to get the next page of EnterpriseKnowledgeGraph service resources.
	NextLink *string `json:"nextLink,omitempty"`
	// Value - READ-ONLY; Gets the list of EnterpriseKnowledgeGraph service results and their properties.
	Value *[]EnterpriseKnowledgeGraph `json:"value,omitempty"`
}

EnterpriseKnowledgeGraphResponseList the list of EnterpriseKnowledgeGraph service operation response.

func (EnterpriseKnowledgeGraphResponseList) IsEmpty

IsEmpty returns true if the ListResult contains no values.

func (EnterpriseKnowledgeGraphResponseList) MarshalJSON

func (ekgrl EnterpriseKnowledgeGraphResponseList) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for EnterpriseKnowledgeGraphResponseList.

type EnterpriseKnowledgeGraphResponseListIterator

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

EnterpriseKnowledgeGraphResponseListIterator provides access to a complete listing of EnterpriseKnowledgeGraph values.

func NewEnterpriseKnowledgeGraphResponseListIterator

func NewEnterpriseKnowledgeGraphResponseListIterator(page EnterpriseKnowledgeGraphResponseListPage) EnterpriseKnowledgeGraphResponseListIterator

Creates a new instance of the EnterpriseKnowledgeGraphResponseListIterator type.

func (*EnterpriseKnowledgeGraphResponseListIterator) Next deprecated

This method has been deprecated.

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 (*EnterpriseKnowledgeGraphResponseListIterator) NextWithContext

func (iter *EnterpriseKnowledgeGraphResponseListIterator) 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 (EnterpriseKnowledgeGraphResponseListIterator) NotDone

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

func (EnterpriseKnowledgeGraphResponseListIterator) Response

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

func (EnterpriseKnowledgeGraphResponseListIterator) Value

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

type EnterpriseKnowledgeGraphResponseListPage

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

EnterpriseKnowledgeGraphResponseListPage contains a page of EnterpriseKnowledgeGraph values.

func NewEnterpriseKnowledgeGraphResponseListPage

Creates a new instance of the EnterpriseKnowledgeGraphResponseListPage type.

func (*EnterpriseKnowledgeGraphResponseListPage) Next deprecated

This method has been deprecated.

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 (*EnterpriseKnowledgeGraphResponseListPage) NextWithContext

func (page *EnterpriseKnowledgeGraphResponseListPage) 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 (EnterpriseKnowledgeGraphResponseListPage) NotDone

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

func (EnterpriseKnowledgeGraphResponseListPage) Response

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

func (EnterpriseKnowledgeGraphResponseListPage) Values

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

type Error

type Error struct {
	// Error - The error body.
	Error *ErrorBody `json:"error,omitempty"`
}

Error enterpriseKnowledgeGraph Service error object.

type ErrorBody

type ErrorBody struct {
	// Code - error code
	Code *string `json:"code,omitempty"`
	// Message - error message
	Message *string `json:"message,omitempty"`
}

ErrorBody enterpriseKnowledgeGraph Service error body.

type OperationDisplayInfo

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

OperationDisplayInfo the operation supported by EnterpriseKnowledgeGraph Service Management.

type OperationEntity

type OperationEntity struct {
	// Name - Operation name: {provider}/{resource}/{operation}.
	Name *string `json:"name,omitempty"`
	// Display - The operation supported by EnterpriseKnowledgeGraph Service Management.
	Display *OperationDisplayInfo `json:"display,omitempty"`
	// Origin - The origin of the operation.
	Origin *string `json:"origin,omitempty"`
	// Properties - Additional properties.
	Properties interface{} `json:"properties,omitempty"`
}

OperationEntity the operations supported by EnterpriseKnowledgeGraph Service Management.

type OperationEntityListResult

type OperationEntityListResult struct {
	autorest.Response `json:"-"`
	// NextLink - The link used to get the next page of operations.
	NextLink *string `json:"nextLink,omitempty"`
	// Value - The list of operations.
	Value *[]OperationEntity `json:"value,omitempty"`
}

OperationEntityListResult the list of EnterpriseKnowledgeGraph service operation response.

func (OperationEntityListResult) IsEmpty

func (oelr OperationEntityListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OperationEntityListResultIterator

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

OperationEntityListResultIterator provides access to a complete listing of OperationEntity values.

func NewOperationEntityListResultIterator

func NewOperationEntityListResultIterator(page OperationEntityListResultPage) OperationEntityListResultIterator

Creates a new instance of the OperationEntityListResultIterator type.

func (*OperationEntityListResultIterator) Next deprecated

This method has been deprecated.

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 (*OperationEntityListResultIterator) NextWithContext

func (iter *OperationEntityListResultIterator) 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 (OperationEntityListResultIterator) NotDone

func (iter OperationEntityListResultIterator) NotDone() bool

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

func (OperationEntityListResultIterator) Response

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

func (OperationEntityListResultIterator) Value

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

type OperationEntityListResultPage

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

OperationEntityListResultPage contains a page of OperationEntity values.

func NewOperationEntityListResultPage

Creates a new instance of the OperationEntityListResultPage type.

func (*OperationEntityListResultPage) Next deprecated

This method has been deprecated.
func (page *OperationEntityListResultPage) 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 (*OperationEntityListResultPage) NextWithContext

func (page *OperationEntityListResultPage) 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 (OperationEntityListResultPage) NotDone

func (page OperationEntityListResultPage) NotDone() bool

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

func (OperationEntityListResultPage) Response

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

func (OperationEntityListResultPage) Values

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

type OperationsClient

type OperationsClient struct {
	BaseClient
}

OperationsClient is the azure Enterprise Knowledge Graph Service is a platform for creating knowledge graphs at scale.

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 OperationEntityListResultPage, err error)

List lists all the available EnterpriseKnowledgeGraph services operations.

func (OperationsClient) ListComplete

func (client OperationsClient) ListComplete(ctx context.Context) (result OperationEntityListResultIterator, 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 OperationEntityListResult, 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 ProvisioningState

type ProvisioningState string

ProvisioningState enumerates the values for provisioning state.

const (
	// Creating ...
	Creating ProvisioningState = "Creating"
	// Deleting ...
	Deleting ProvisioningState = "Deleting"
	// Failed ...
	Failed ProvisioningState = "Failed"
	// Succeeded ...
	Succeeded ProvisioningState = "Succeeded"
)

func PossibleProvisioningStateValues

func PossibleProvisioningStateValues() []ProvisioningState

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

type Resource

type Resource struct {
	// ID - READ-ONLY; Specifies the resource ID.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Specifies the name of the resource.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Specifies the type of the resource.
	Type *string `json:"type,omitempty"`
	// Location - Specifies the location of the resource.
	Location *string `json:"location,omitempty"`
	// Tags - Contains resource tags defined as key/value pairs.
	Tags map[string]*string `json:"tags"`
	// Sku - Gets or sets the SKU of the resource.
	Sku *Sku `json:"sku,omitempty"`
}

Resource azure resource

func (Resource) MarshalJSON

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

MarshalJSON is the custom marshaler for Resource.

type Sku

type Sku struct {
	// Name - The sku name. Possible values include: 'F0', 'S1'
	Name SkuName `json:"name,omitempty"`
}

Sku the SKU of the EnterpriseKnowledgeGraph service account.

type SkuName

type SkuName string

SkuName enumerates the values for sku name.

const (
	// F0 ...
	F0 SkuName = "F0"
	// S1 ...
	S1 SkuName = "S1"
)

func PossibleSkuNameValues

func PossibleSkuNameValues() []SkuName

PossibleSkuNameValues returns an array of possible values for the SkuName const type.

Directories

Path Synopsis