azure-sdk-for-go: github.com/Azure/azure-sdk-for-go/services/cognitiveservices/mgmt/2017-04-18/cognitiveservices Index | Files | Directories

package cognitiveservices

import "github.com/Azure/azure-sdk-for-go/services/cognitiveservices/mgmt/2017-04-18/cognitiveservices"

Package cognitiveservices implements the Azure ARM Cognitiveservices service API version 2017-04-18.

Cognitive Services Management Client

Index

Package Files

accounts.go client.go models.go operations.go resourceskus.go version.go

Constants

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

func UserAgent Uses

func UserAgent() string

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

func Version Uses

func Version() string

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

type Account Uses

type Account struct {
    autorest.Response `json:"-"`
    // Etag - READ-ONLY; Entity Tag
    Etag *string `json:"etag,omitempty"`
    // ID - READ-ONLY; The id of the created account
    ID  *string `json:"id,omitempty"`
    // Kind - The Kind of the resource.
    Kind *string `json:"kind,omitempty"`
    // Location - The location of the resource
    Location *string `json:"location,omitempty"`
    // Name - READ-ONLY; The name of the created account
    Name *string `json:"name,omitempty"`
    // Properties - Properties of Cognitive Services account.
    Properties *AccountProperties `json:"properties,omitempty"`
    // Sku - The SKU of Cognitive Services account.
    Sku *Sku `json:"sku,omitempty"`
    // Tags - Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters.
    Tags map[string]*string `json:"tags"`
    // Type - READ-ONLY; Resource type
    Type *string `json:"type,omitempty"`
}

Account cognitive Services Account is an Azure resource representing the provisioned account, its type, location and SKU.

func (Account) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for Account.

type AccountAPIProperties Uses

type AccountAPIProperties struct {
    // QnaRuntimeEndpoint - (QnAMaker Only) The runtime endpoint of QnAMaker.
    QnaRuntimeEndpoint *string `json:"qnaRuntimeEndpoint,omitempty"`
    // StatisticsEnabled - (Bing Search Only) The flag to enable statistics of Bing Search.
    StatisticsEnabled *bool `json:"statisticsEnabled,omitempty"`
    // EventHubConnectionString - (Personalization Only) The flag to enable statistics of Bing Search.
    EventHubConnectionString *string `json:"eventHubConnectionString,omitempty"`
    // StorageAccountConnectionString - (Personalization Only) The storage account connection string.
    StorageAccountConnectionString *string `json:"storageAccountConnectionString,omitempty"`
}

AccountAPIProperties the api properties for special APIs.

type AccountEnumerateSkusResult Uses

type AccountEnumerateSkusResult struct {
    autorest.Response `json:"-"`
    // Value - READ-ONLY; Gets the list of Cognitive Services accounts and their properties.
    Value *[]ResourceAndSku `json:"value,omitempty"`
}

AccountEnumerateSkusResult the list of cognitive services accounts operation response.

type AccountKeys Uses

type AccountKeys struct {
    autorest.Response `json:"-"`
    // Key1 - Gets the value of key 1.
    Key1 *string `json:"key1,omitempty"`
    // Key2 - Gets the value of key 2.
    Key2 *string `json:"key2,omitempty"`
}

AccountKeys the access keys for the cognitive services account.

type AccountListResult Uses

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

AccountListResult the list of cognitive services accounts operation response.

func (AccountListResult) IsEmpty Uses

func (alr AccountListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type AccountListResultIterator Uses

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

AccountListResultIterator provides access to a complete listing of Account values.

func NewAccountListResultIterator Uses

func NewAccountListResultIterator(page AccountListResultPage) AccountListResultIterator

Creates a new instance of the AccountListResultIterator type.

func (*AccountListResultIterator) Next Uses

func (iter *AccountListResultIterator) 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 (*AccountListResultIterator) NextWithContext Uses

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

func (iter AccountListResultIterator) NotDone() bool

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

func (AccountListResultIterator) Response Uses

func (iter AccountListResultIterator) Response() AccountListResult

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

func (AccountListResultIterator) Value Uses

func (iter AccountListResultIterator) Value() Account

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

type AccountListResultPage Uses

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

AccountListResultPage contains a page of Account values.

func NewAccountListResultPage Uses

func NewAccountListResultPage(getNextPage func(context.Context, AccountListResult) (AccountListResult, error)) AccountListResultPage

Creates a new instance of the AccountListResultPage type.

func (*AccountListResultPage) Next Uses

func (page *AccountListResultPage) 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 (*AccountListResultPage) NextWithContext Uses

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

func (page AccountListResultPage) NotDone() bool

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

func (AccountListResultPage) Response Uses

func (page AccountListResultPage) Response() AccountListResult

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

func (AccountListResultPage) Values Uses

func (page AccountListResultPage) Values() []Account

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

type AccountProperties Uses

type AccountProperties struct {
    // ProvisioningState - READ-ONLY; Gets the status of the cognitive services account at the time the operation was called. Possible values include: 'Creating', 'ResolvingDNS', 'Moving', 'Deleting', 'Succeeded', 'Failed'
    ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
    // Endpoint - READ-ONLY; Endpoint of the created account.
    Endpoint *string `json:"endpoint,omitempty"`
    // InternalID - READ-ONLY; The internal identifier.
    InternalID *string `json:"internalId,omitempty"`
    // CustomSubDomainName - Optional subdomain name used for token-based authentication.
    CustomSubDomainName *string `json:"customSubDomainName,omitempty"`
    // NetworkAcls - A collection of rules governing the accessibility from specific network locations.
    NetworkAcls *NetworkRuleSet `json:"networkAcls,omitempty"`
    // APIProperties - The api properties for special APIs.
    APIProperties *AccountAPIProperties `json:"apiProperties,omitempty"`
}

AccountProperties properties of Cognitive Services account.

type AccountsClient Uses

type AccountsClient struct {
    BaseClient
}

AccountsClient is the cognitive Services Management Client

func NewAccountsClient Uses

func NewAccountsClient(subscriptionID string) AccountsClient

NewAccountsClient creates an instance of the AccountsClient client.

func NewAccountsClientWithBaseURI Uses

func NewAccountsClientWithBaseURI(baseURI string, subscriptionID string) AccountsClient

NewAccountsClientWithBaseURI creates an instance of the AccountsClient client.

func (AccountsClient) Create Uses

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

Create create Cognitive Services Account. Accounts is a resource group wide resource type. It holds the keys for developer to access intelligent APIs. It's also the resource type for billing. Parameters: resourceGroupName - the name of the resource group within the user's subscription. accountName - the name of Cognitive Services account. account - the parameters to provide for the created account.

func (AccountsClient) CreatePreparer Uses

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

CreatePreparer prepares the Create request.

func (AccountsClient) CreateResponder Uses

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

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

func (AccountsClient) CreateSender Uses

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

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

Delete deletes a Cognitive Services account from the resource group. Parameters: resourceGroupName - the name of the resource group within the user's subscription. accountName - the name of Cognitive Services account.

func (AccountsClient) DeletePreparer Uses

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

DeletePreparer prepares the Delete request.

func (AccountsClient) DeleteResponder Uses

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 Uses

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

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

GetProperties returns a Cognitive Services account specified by the parameters. Parameters: resourceGroupName - the name of the resource group within the user's subscription. accountName - the name of Cognitive Services account.

func (AccountsClient) GetPropertiesPreparer Uses

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

GetPropertiesPreparer prepares the GetProperties request.

func (AccountsClient) GetPropertiesResponder Uses

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

GetPropertiesResponder handles the response to the GetProperties request. The method always closes the http.Response Body.

func (AccountsClient) GetPropertiesSender Uses

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

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

func (AccountsClient) GetUsages Uses

func (client AccountsClient) GetUsages(ctx context.Context, resourceGroupName string, accountName string, filter string) (result UsagesResult, err error)

GetUsages get usages for the requested Cognitive Services account Parameters: resourceGroupName - the name of the resource group within the user's subscription. accountName - the name of Cognitive Services account. filter - an OData filter expression that describes a subset of usages to return. The supported parameter is name.value (name of the metric, can have an or of multiple names).

func (AccountsClient) GetUsagesPreparer Uses

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

GetUsagesPreparer prepares the GetUsages request.

func (AccountsClient) GetUsagesResponder Uses

func (client AccountsClient) GetUsagesResponder(resp *http.Response) (result UsagesResult, err error)

GetUsagesResponder handles the response to the GetUsages request. The method always closes the http.Response Body.

func (AccountsClient) GetUsagesSender Uses

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

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

func (AccountsClient) List Uses

func (client AccountsClient) List(ctx context.Context) (result AccountListResultPage, err error)

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

func (AccountsClient) ListByResourceGroup Uses

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

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

func (AccountsClient) ListByResourceGroupComplete Uses

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

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

func (AccountsClient) ListByResourceGroupPreparer Uses

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

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (AccountsClient) ListByResourceGroupResponder Uses

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

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

func (AccountsClient) ListByResourceGroupSender Uses

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) ListComplete Uses

func (client AccountsClient) ListComplete(ctx context.Context) (result AccountListResultIterator, err error)

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

func (AccountsClient) ListKeys Uses

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

ListKeys lists the account keys for the specified Cognitive Services account. Parameters: resourceGroupName - the name of the resource group within the user's subscription. accountName - the name of Cognitive Services account.

func (AccountsClient) ListKeysPreparer Uses

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

ListKeysPreparer prepares the ListKeys request.

func (AccountsClient) ListKeysResponder Uses

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

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

func (AccountsClient) ListKeysSender Uses

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) ListPreparer Uses

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

ListPreparer prepares the List request.

func (AccountsClient) ListResponder Uses

func (client AccountsClient) ListResponder(resp *http.Response) (result AccountListResult, err error)

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

func (AccountsClient) ListSender Uses

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

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

ListSkus list available SKUs for the requested Cognitive Services account Parameters: resourceGroupName - the name of the resource group within the user's subscription. accountName - the name of Cognitive Services account.

func (AccountsClient) ListSkusPreparer Uses

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

ListSkusPreparer prepares the ListSkus request.

func (AccountsClient) ListSkusResponder Uses

func (client AccountsClient) ListSkusResponder(resp *http.Response) (result AccountEnumerateSkusResult, err error)

ListSkusResponder handles the response to the ListSkus request. The method always closes the http.Response Body.

func (AccountsClient) ListSkusSender Uses

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

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

func (AccountsClient) RegenerateKey Uses

func (client AccountsClient) RegenerateKey(ctx context.Context, resourceGroupName string, accountName string, parameters RegenerateKeyParameters) (result AccountKeys, err error)

RegenerateKey regenerates the specified account key for the specified Cognitive Services account. Parameters: resourceGroupName - the name of the resource group within the user's subscription. accountName - the name of Cognitive Services account. parameters - regenerate key parameters.

func (AccountsClient) RegenerateKeyPreparer Uses

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

RegenerateKeyPreparer prepares the RegenerateKey request.

func (AccountsClient) RegenerateKeyResponder Uses

func (client AccountsClient) RegenerateKeyResponder(resp *http.Response) (result AccountKeys, err error)

RegenerateKeyResponder handles the response to the RegenerateKey request. The method always closes the http.Response Body.

func (AccountsClient) RegenerateKeySender Uses

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

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

func (AccountsClient) Update Uses

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

Update updates a Cognitive Services account Parameters: resourceGroupName - the name of the resource group within the user's subscription. accountName - the name of Cognitive Services account. account - the parameters to provide for the created account.

func (AccountsClient) UpdatePreparer Uses

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

UpdatePreparer prepares the Update request.

func (AccountsClient) UpdateResponder Uses

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 Uses

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

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

BaseClient is the base client for Cognitiveservices.

func New Uses

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI Uses

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client.

func (BaseClient) CheckDomainAvailability Uses

func (client BaseClient) CheckDomainAvailability(ctx context.Context, parameters CheckDomainAvailabilityParameter) (result CheckDomainAvailabilityResult, err error)

CheckDomainAvailability check whether a domain is available. Parameters: parameters - check Domain Availability parameter.

func (BaseClient) CheckDomainAvailabilityPreparer Uses

func (client BaseClient) CheckDomainAvailabilityPreparer(ctx context.Context, parameters CheckDomainAvailabilityParameter) (*http.Request, error)

CheckDomainAvailabilityPreparer prepares the CheckDomainAvailability request.

func (BaseClient) CheckDomainAvailabilityResponder Uses

func (client BaseClient) CheckDomainAvailabilityResponder(resp *http.Response) (result CheckDomainAvailabilityResult, err error)

CheckDomainAvailabilityResponder handles the response to the CheckDomainAvailability request. The method always closes the http.Response Body.

func (BaseClient) CheckDomainAvailabilitySender Uses

func (client BaseClient) CheckDomainAvailabilitySender(req *http.Request) (*http.Response, error)

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

func (BaseClient) CheckSkuAvailability Uses

func (client BaseClient) CheckSkuAvailability(ctx context.Context, location string, parameters CheckSkuAvailabilityParameter) (result CheckSkuAvailabilityResultList, err error)

CheckSkuAvailability check available SKUs. Parameters: location - resource location. parameters - check SKU Availability POST body.

func (BaseClient) CheckSkuAvailabilityPreparer Uses

func (client BaseClient) CheckSkuAvailabilityPreparer(ctx context.Context, location string, parameters CheckSkuAvailabilityParameter) (*http.Request, error)

CheckSkuAvailabilityPreparer prepares the CheckSkuAvailability request.

func (BaseClient) CheckSkuAvailabilityResponder Uses

func (client BaseClient) CheckSkuAvailabilityResponder(resp *http.Response) (result CheckSkuAvailabilityResultList, err error)

CheckSkuAvailabilityResponder handles the response to the CheckSkuAvailability request. The method always closes the http.Response Body.

func (BaseClient) CheckSkuAvailabilitySender Uses

func (client BaseClient) CheckSkuAvailabilitySender(req *http.Request) (*http.Response, error)

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

type CheckDomainAvailabilityParameter Uses

type CheckDomainAvailabilityParameter struct {
    // SubdomainName - The subdomain name to use.
    SubdomainName *string `json:"subdomainName,omitempty"`
    // Type - The Type of the resource.
    Type *string `json:"type,omitempty"`
}

CheckDomainAvailabilityParameter check Domain availability parameter.

type CheckDomainAvailabilityResult Uses

type CheckDomainAvailabilityResult struct {
    autorest.Response `json:"-"`
    // IsSubdomainAvailable - Indicates the given SKU is available or not.
    IsSubdomainAvailable *bool `json:"isSubdomainAvailable,omitempty"`
    // Reason - Reason why the SKU is not available.
    Reason *string `json:"reason,omitempty"`
    // SubdomainName - The subdomain name to use.
    SubdomainName *string `json:"subdomainName,omitempty"`
    // Type - The Type of the resource.
    Type *string `json:"type,omitempty"`
}

CheckDomainAvailabilityResult check Domain availability result.

type CheckSkuAvailabilityParameter Uses

type CheckSkuAvailabilityParameter struct {
    // Skus - The SKU of the resource.
    Skus *[]string `json:"skus,omitempty"`
    // Kind - The Kind of the resource.
    Kind *string `json:"kind,omitempty"`
    // Type - The Type of the resource.
    Type *string `json:"type,omitempty"`
}

CheckSkuAvailabilityParameter check SKU availability parameter.

type CheckSkuAvailabilityResult Uses

type CheckSkuAvailabilityResult struct {
    // Kind - The Kind of the resource.
    Kind *string `json:"kind,omitempty"`
    // Type - The Type of the resource.
    Type *string `json:"type,omitempty"`
    // SkuName - The SKU of Cognitive Services account.
    SkuName *string `json:"skuName,omitempty"`
    // SkuAvailable - Indicates the given SKU is available or not.
    SkuAvailable *bool `json:"skuAvailable,omitempty"`
    // Reason - Reason why the SKU is not available.
    Reason *string `json:"reason,omitempty"`
    // Message - Additional error message.
    Message *string `json:"message,omitempty"`
}

CheckSkuAvailabilityResult check SKU availability result.

type CheckSkuAvailabilityResultList Uses

type CheckSkuAvailabilityResultList struct {
    autorest.Response `json:"-"`
    // Value - Check SKU availability result list.
    Value *[]CheckSkuAvailabilityResult `json:"value,omitempty"`
}

CheckSkuAvailabilityResultList check SKU availability result list.

type Error Uses

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

Error cognitive Services error object.

type ErrorBody Uses

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

ErrorBody cognitive Services error body.

type IPRule Uses

type IPRule struct {
    // Value - An IPv4 address range in CIDR notation, such as '124.56.78.91' (simple IP address) or '124.56.78.0/24' (all addresses that start with 124.56.78).
    Value *string `json:"value,omitempty"`
}

IPRule a rule governing the accessibility from a specific ip address or ip range.

type KeyName Uses

type KeyName string

KeyName enumerates the values for key name.

const (
    // Key1 ...
    Key1 KeyName = "Key1"
    // Key2 ...
    Key2 KeyName = "Key2"
)

func PossibleKeyNameValues Uses

func PossibleKeyNameValues() []KeyName

PossibleKeyNameValues returns an array of possible values for the KeyName const type.

type MetricName Uses

type MetricName struct {
    // Value - READ-ONLY; The name of the metric.
    Value *string `json:"value,omitempty"`
    // LocalizedValue - READ-ONLY; The friendly name of the metric.
    LocalizedValue *string `json:"localizedValue,omitempty"`
}

MetricName a metric name.

type NetworkRuleAction Uses

type NetworkRuleAction string

NetworkRuleAction enumerates the values for network rule action.

const (
    // Allow ...
    Allow NetworkRuleAction = "Allow"
    // Deny ...
    Deny NetworkRuleAction = "Deny"
)

func PossibleNetworkRuleActionValues Uses

func PossibleNetworkRuleActionValues() []NetworkRuleAction

PossibleNetworkRuleActionValues returns an array of possible values for the NetworkRuleAction const type.

type NetworkRuleSet Uses

type NetworkRuleSet struct {
    // DefaultAction - The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated. Possible values include: 'Allow', 'Deny'
    DefaultAction NetworkRuleAction `json:"defaultAction,omitempty"`
    // IPRules - The list of IP address rules.
    IPRules *[]IPRule `json:"ipRules,omitempty"`
    // VirtualNetworkRules - The list of virtual network rules.
    VirtualNetworkRules *[]VirtualNetworkRule `json:"virtualNetworkRules,omitempty"`
}

NetworkRuleSet a set of rules governing the network accessibility.

type OperationDisplayInfo Uses

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 Cognitive Services.
    Provider *string `json:"provider,omitempty"`
    // Resource - Resource on which the operation is performed.
    Resource *string `json:"resource,omitempty"`
}

OperationDisplayInfo the operation supported by Cognitive Services.

type OperationEntity Uses

type OperationEntity struct {
    // Name - Operation name: {provider}/{resource}/{operation}.
    Name *string `json:"name,omitempty"`
    // Display - The operation supported by Cognitive Services.
    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 operation supported by Cognitive Services.

type OperationEntityListResult Uses

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 cognitive services accounts operation response.

func (OperationEntityListResult) IsEmpty Uses

func (oelr OperationEntityListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OperationEntityListResultIterator Uses

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

OperationEntityListResultIterator provides access to a complete listing of OperationEntity values.

func NewOperationEntityListResultIterator Uses

func NewOperationEntityListResultIterator(page OperationEntityListResultPage) OperationEntityListResultIterator

Creates a new instance of the OperationEntityListResultIterator type.

func (*OperationEntityListResultIterator) Next Uses

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

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 Uses

func (iter OperationEntityListResultIterator) NotDone() bool

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

func (OperationEntityListResultIterator) Response Uses

func (iter OperationEntityListResultIterator) Response() OperationEntityListResult

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

func (OperationEntityListResultIterator) Value Uses

func (iter OperationEntityListResultIterator) Value() OperationEntity

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

type OperationEntityListResultPage Uses

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

OperationEntityListResultPage contains a page of OperationEntity values.

func NewOperationEntityListResultPage Uses

func NewOperationEntityListResultPage(getNextPage func(context.Context, OperationEntityListResult) (OperationEntityListResult, error)) OperationEntityListResultPage

Creates a new instance of the OperationEntityListResultPage type.

func (*OperationEntityListResultPage) Next Uses

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 Uses

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 Uses

func (page OperationEntityListResultPage) NotDone() bool

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

func (OperationEntityListResultPage) Response Uses

func (page OperationEntityListResultPage) Response() OperationEntityListResult

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

func (OperationEntityListResultPage) Values Uses

func (page OperationEntityListResultPage) Values() []OperationEntity

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

type OperationsClient Uses

type OperationsClient struct {
    BaseClient
}

OperationsClient is the cognitive Services Management Client

func NewOperationsClient Uses

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI Uses

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client.

func (OperationsClient) List Uses

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

List lists all the available Cognitive Services account operations.

func (OperationsClient) ListComplete Uses

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

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

func (OperationsClient) ListPreparer Uses

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

ListPreparer prepares the List request.

func (OperationsClient) ListResponder Uses

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 Uses

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 Uses

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"
    // ResolvingDNS ...
    ResolvingDNS ProvisioningState = "ResolvingDNS"
    // Succeeded ...
    Succeeded ProvisioningState = "Succeeded"
)

func PossibleProvisioningStateValues Uses

func PossibleProvisioningStateValues() []ProvisioningState

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

type QuotaUsageStatus Uses

type QuotaUsageStatus string

QuotaUsageStatus enumerates the values for quota usage status.

const (
    // Blocked ...
    Blocked QuotaUsageStatus = "Blocked"
    // Included ...
    Included QuotaUsageStatus = "Included"
    // InOverage ...
    InOverage QuotaUsageStatus = "InOverage"
    // Unknown ...
    Unknown QuotaUsageStatus = "Unknown"
)

func PossibleQuotaUsageStatusValues Uses

func PossibleQuotaUsageStatusValues() []QuotaUsageStatus

PossibleQuotaUsageStatusValues returns an array of possible values for the QuotaUsageStatus const type.

type RegenerateKeyParameters Uses

type RegenerateKeyParameters struct {
    // KeyName - key name to generate (Key1|Key2). Possible values include: 'Key1', 'Key2'
    KeyName KeyName `json:"keyName,omitempty"`
}

RegenerateKeyParameters regenerate key parameters.

type ResourceAndSku Uses

type ResourceAndSku struct {
    // ResourceType - Resource Namespace and Type
    ResourceType *string `json:"resourceType,omitempty"`
    // Sku - The SKU of Cognitive Services account.
    Sku *Sku `json:"sku,omitempty"`
}

ResourceAndSku cognitive Services resource type and SKU.

type ResourceSku Uses

type ResourceSku struct {
    // ResourceType - READ-ONLY; The type of resource the SKU applies to.
    ResourceType *string `json:"resourceType,omitempty"`
    // Name - READ-ONLY; The name of SKU.
    Name *string `json:"name,omitempty"`
    // Tier - READ-ONLY; Specifies the tier of Cognitive Services account.
    Tier *string `json:"tier,omitempty"`
    // Kind - READ-ONLY; The Kind of resources that are supported in this SKU.
    Kind *string `json:"kind,omitempty"`
    // Locations - READ-ONLY; The set of locations that the SKU is available.
    Locations *[]string `json:"locations,omitempty"`
    // Restrictions - READ-ONLY; The restrictions because of which SKU cannot be used. This is empty if there are no restrictions.
    Restrictions *[]ResourceSkuRestrictions `json:"restrictions,omitempty"`
}

ResourceSku describes an available Cognitive Services SKU.

type ResourceSkuRestrictionInfo Uses

type ResourceSkuRestrictionInfo struct {
    // Locations - READ-ONLY; Locations where the SKU is restricted
    Locations *[]string `json:"locations,omitempty"`
    // Zones - READ-ONLY; List of availability zones where the SKU is restricted.
    Zones *[]string `json:"zones,omitempty"`
}

ResourceSkuRestrictionInfo ...

type ResourceSkuRestrictions Uses

type ResourceSkuRestrictions struct {
    // Type - READ-ONLY; The type of restrictions. Possible values include: 'Location', 'Zone'
    Type ResourceSkuRestrictionsType `json:"type,omitempty"`
    // Values - READ-ONLY; The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted.
    Values *[]string `json:"values,omitempty"`
    // RestrictionInfo - READ-ONLY; The information about the restriction where the SKU cannot be used.
    RestrictionInfo *ResourceSkuRestrictionInfo `json:"restrictionInfo,omitempty"`
    // ReasonCode - READ-ONLY; The reason for restriction. Possible values include: 'QuotaID', 'NotAvailableForSubscription'
    ReasonCode ResourceSkuRestrictionsReasonCode `json:"reasonCode,omitempty"`
}

ResourceSkuRestrictions describes restrictions of a SKU.

type ResourceSkuRestrictionsReasonCode Uses

type ResourceSkuRestrictionsReasonCode string

ResourceSkuRestrictionsReasonCode enumerates the values for resource sku restrictions reason code.

const (
    // NotAvailableForSubscription ...
    NotAvailableForSubscription ResourceSkuRestrictionsReasonCode = "NotAvailableForSubscription"
    // QuotaID ...
    QuotaID ResourceSkuRestrictionsReasonCode = "QuotaId"
)

func PossibleResourceSkuRestrictionsReasonCodeValues Uses

func PossibleResourceSkuRestrictionsReasonCodeValues() []ResourceSkuRestrictionsReasonCode

PossibleResourceSkuRestrictionsReasonCodeValues returns an array of possible values for the ResourceSkuRestrictionsReasonCode const type.

type ResourceSkuRestrictionsType Uses

type ResourceSkuRestrictionsType string

ResourceSkuRestrictionsType enumerates the values for resource sku restrictions type.

const (
    // Location ...
    Location ResourceSkuRestrictionsType = "Location"
    // Zone ...
    Zone ResourceSkuRestrictionsType = "Zone"
)

func PossibleResourceSkuRestrictionsTypeValues Uses

func PossibleResourceSkuRestrictionsTypeValues() []ResourceSkuRestrictionsType

PossibleResourceSkuRestrictionsTypeValues returns an array of possible values for the ResourceSkuRestrictionsType const type.

type ResourceSkusClient Uses

type ResourceSkusClient struct {
    BaseClient
}

ResourceSkusClient is the cognitive Services Management Client

func NewResourceSkusClient Uses

func NewResourceSkusClient(subscriptionID string) ResourceSkusClient

NewResourceSkusClient creates an instance of the ResourceSkusClient client.

func NewResourceSkusClientWithBaseURI Uses

func NewResourceSkusClientWithBaseURI(baseURI string, subscriptionID string) ResourceSkusClient

NewResourceSkusClientWithBaseURI creates an instance of the ResourceSkusClient client.

func (ResourceSkusClient) List Uses

func (client ResourceSkusClient) List(ctx context.Context) (result ResourceSkusResultPage, err error)

List gets the list of Microsoft.CognitiveServices SKUs available for your Subscription.

func (ResourceSkusClient) ListComplete Uses

func (client ResourceSkusClient) ListComplete(ctx context.Context) (result ResourceSkusResultIterator, err error)

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

func (ResourceSkusClient) ListPreparer Uses

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

ListPreparer prepares the List request.

func (ResourceSkusClient) ListResponder Uses

func (client ResourceSkusClient) ListResponder(resp *http.Response) (result ResourceSkusResult, err error)

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

func (ResourceSkusClient) ListSender Uses

func (client ResourceSkusClient) 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 ResourceSkusResult Uses

type ResourceSkusResult struct {
    autorest.Response `json:"-"`
    // Value - The list of skus available for the subscription.
    Value *[]ResourceSku `json:"value,omitempty"`
    // NextLink - The uri to fetch the next page of Skus.
    NextLink *string `json:"nextLink,omitempty"`
}

ResourceSkusResult the Get Skus operation response.

func (ResourceSkusResult) IsEmpty Uses

func (rsr ResourceSkusResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ResourceSkusResultIterator Uses

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

ResourceSkusResultIterator provides access to a complete listing of ResourceSku values.

func NewResourceSkusResultIterator Uses

func NewResourceSkusResultIterator(page ResourceSkusResultPage) ResourceSkusResultIterator

Creates a new instance of the ResourceSkusResultIterator type.

func (*ResourceSkusResultIterator) Next Uses

func (iter *ResourceSkusResultIterator) 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 (*ResourceSkusResultIterator) NextWithContext Uses

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

func (iter ResourceSkusResultIterator) NotDone() bool

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

func (ResourceSkusResultIterator) Response Uses

func (iter ResourceSkusResultIterator) Response() ResourceSkusResult

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

func (ResourceSkusResultIterator) Value Uses

func (iter ResourceSkusResultIterator) Value() ResourceSku

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

type ResourceSkusResultPage Uses

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

ResourceSkusResultPage contains a page of ResourceSku values.

func NewResourceSkusResultPage Uses

func NewResourceSkusResultPage(getNextPage func(context.Context, ResourceSkusResult) (ResourceSkusResult, error)) ResourceSkusResultPage

Creates a new instance of the ResourceSkusResultPage type.

func (*ResourceSkusResultPage) Next Uses

func (page *ResourceSkusResultPage) 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 (*ResourceSkusResultPage) NextWithContext Uses

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

func (page ResourceSkusResultPage) NotDone() bool

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

func (ResourceSkusResultPage) Response Uses

func (page ResourceSkusResultPage) Response() ResourceSkusResult

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

func (ResourceSkusResultPage) Values Uses

func (page ResourceSkusResultPage) Values() []ResourceSku

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

type Sku Uses

type Sku struct {
    // Name - Gets or sets the sku name. Required for account creation, optional for update.
    Name *string `json:"name,omitempty"`
    // Tier - READ-ONLY; Gets the sku tier. This is based on the SKU name. Possible values include: 'Free', 'Standard', 'Premium'
    Tier SkuTier `json:"tier,omitempty"`
}

Sku the SKU of the cognitive services account.

type SkuTier Uses

type SkuTier string

SkuTier enumerates the values for sku tier.

const (
    // Free ...
    Free SkuTier = "Free"
    // Premium ...
    Premium SkuTier = "Premium"
    // Standard ...
    Standard SkuTier = "Standard"
)

func PossibleSkuTierValues Uses

func PossibleSkuTierValues() []SkuTier

PossibleSkuTierValues returns an array of possible values for the SkuTier const type.

type UnitType Uses

type UnitType string

UnitType enumerates the values for unit type.

const (
    // Bytes ...
    Bytes UnitType = "Bytes"
    // BytesPerSecond ...
    BytesPerSecond UnitType = "BytesPerSecond"
    // Count ...
    Count UnitType = "Count"
    // CountPerSecond ...
    CountPerSecond UnitType = "CountPerSecond"
    // Milliseconds ...
    Milliseconds UnitType = "Milliseconds"
    // Percent ...
    Percent UnitType = "Percent"
    // Seconds ...
    Seconds UnitType = "Seconds"
)

func PossibleUnitTypeValues Uses

func PossibleUnitTypeValues() []UnitType

PossibleUnitTypeValues returns an array of possible values for the UnitType const type.

type Usage Uses

type Usage struct {
    // Unit - The unit of the metric. Possible values include: 'Count', 'Bytes', 'Seconds', 'Percent', 'CountPerSecond', 'BytesPerSecond', 'Milliseconds'
    Unit UnitType `json:"unit,omitempty"`
    // Name - READ-ONLY; The name information for the metric.
    Name *MetricName `json:"name,omitempty"`
    // QuotaPeriod - READ-ONLY; The quota period used to summarize the usage values.
    QuotaPeriod *string `json:"quotaPeriod,omitempty"`
    // Limit - READ-ONLY; Maximum value for this metric.
    Limit *float64 `json:"limit,omitempty"`
    // CurrentValue - READ-ONLY; Current value for this metric.
    CurrentValue *float64 `json:"currentValue,omitempty"`
    // NextResetTime - READ-ONLY; Next reset time for current quota.
    NextResetTime *string `json:"nextResetTime,omitempty"`
    // Status - Cognitive Services account quota usage status. Possible values include: 'Included', 'Blocked', 'InOverage', 'Unknown'
    Status QuotaUsageStatus `json:"status,omitempty"`
}

Usage the usage data for a usage request.

type UsagesResult Uses

type UsagesResult struct {
    autorest.Response `json:"-"`
    // Value - READ-ONLY; The list of usages for Cognitive Service account.
    Value *[]Usage `json:"value,omitempty"`
}

UsagesResult the response to a list usage request.

type VirtualNetworkRule Uses

type VirtualNetworkRule struct {
    // ID - Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'.
    ID  *string `json:"id,omitempty"`
    // State - Gets the state of virtual network rule.
    State *string `json:"state,omitempty"`
    // IgnoreMissingVnetServiceEndpoint - Ignore missing vnet service endpoint or not.
    IgnoreMissingVnetServiceEndpoint *bool `json:"ignoreMissingVnetServiceEndpoint,omitempty"`
}

VirtualNetworkRule a rule governing the accessibility from a specific virtual network.

Directories

PathSynopsis
cognitiveservicesapi

Package cognitiveservices imports 9 packages (graph) and is imported by 9 packages. Updated 2019-11-03. Refresh now. Tools for package owners.