Documentation ¶
Overview ¶
Package cognitiveservices implements the Azure ARM Cognitiveservices service API version 2017-04-18.
Cognitive Services Management Client
Index ¶
- Constants
- func UserAgent() string
- func Version() string
- type Account
- type AccountAPIProperties
- type AccountEnumerateSkusResult
- type AccountKeys
- type AccountListResult
- type AccountListResultIterator
- func (iter *AccountListResultIterator) Next() error
- func (iter *AccountListResultIterator) NextWithContext(ctx context.Context) (err error)
- func (iter AccountListResultIterator) NotDone() bool
- func (iter AccountListResultIterator) Response() AccountListResult
- func (iter AccountListResultIterator) Value() Account
- type AccountListResultPage
- type AccountProperties
- type AccountsClient
- func (client AccountsClient) Create(ctx context.Context, resourceGroupName string, accountName string, ...) (result Account, err error)
- func (client AccountsClient) CreatePreparer(ctx context.Context, resourceGroupName string, accountName string, ...) (*http.Request, error)
- func (client AccountsClient) CreateResponder(resp *http.Response) (result Account, err error)
- func (client AccountsClient) CreateSender(req *http.Request) (*http.Response, error)
- func (client AccountsClient) Delete(ctx context.Context, resourceGroupName string, accountName string) (result autorest.Response, err error)
- func (client AccountsClient) DeletePreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
- func (client AccountsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
- func (client AccountsClient) DeleteSender(req *http.Request) (*http.Response, error)
- func (client AccountsClient) GetProperties(ctx context.Context, resourceGroupName string, accountName string) (result Account, err error)
- func (client AccountsClient) GetPropertiesPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
- func (client AccountsClient) GetPropertiesResponder(resp *http.Response) (result Account, err error)
- func (client AccountsClient) GetPropertiesSender(req *http.Request) (*http.Response, error)
- func (client AccountsClient) GetUsages(ctx context.Context, resourceGroupName string, accountName string, ...) (result UsagesResult, err error)
- func (client AccountsClient) GetUsagesPreparer(ctx context.Context, resourceGroupName string, accountName string, ...) (*http.Request, error)
- func (client AccountsClient) GetUsagesResponder(resp *http.Response) (result UsagesResult, err error)
- func (client AccountsClient) GetUsagesSender(req *http.Request) (*http.Response, error)
- func (client AccountsClient) List(ctx context.Context) (result AccountListResultPage, err error)
- func (client AccountsClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result AccountListResultPage, err error)
- func (client AccountsClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result AccountListResultIterator, err error)
- func (client AccountsClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
- func (client AccountsClient) ListByResourceGroupResponder(resp *http.Response) (result AccountListResult, err error)
- func (client AccountsClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
- func (client AccountsClient) ListComplete(ctx context.Context) (result AccountListResultIterator, err error)
- func (client AccountsClient) ListKeys(ctx context.Context, resourceGroupName string, accountName string) (result AccountKeys, err error)
- func (client AccountsClient) ListKeysPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
- func (client AccountsClient) ListKeysResponder(resp *http.Response) (result AccountKeys, err error)
- func (client AccountsClient) ListKeysSender(req *http.Request) (*http.Response, error)
- func (client AccountsClient) ListPreparer(ctx context.Context) (*http.Request, error)
- func (client AccountsClient) ListResponder(resp *http.Response) (result AccountListResult, err error)
- func (client AccountsClient) ListSender(req *http.Request) (*http.Response, error)
- func (client AccountsClient) ListSkus(ctx context.Context, resourceGroupName string, accountName string) (result AccountEnumerateSkusResult, err error)
- func (client AccountsClient) ListSkusPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
- func (client AccountsClient) ListSkusResponder(resp *http.Response) (result AccountEnumerateSkusResult, err error)
- func (client AccountsClient) ListSkusSender(req *http.Request) (*http.Response, error)
- func (client AccountsClient) RegenerateKey(ctx context.Context, resourceGroupName string, accountName string, ...) (result AccountKeys, err error)
- func (client AccountsClient) RegenerateKeyPreparer(ctx context.Context, resourceGroupName string, accountName string, ...) (*http.Request, error)
- func (client AccountsClient) RegenerateKeyResponder(resp *http.Response) (result AccountKeys, err error)
- func (client AccountsClient) RegenerateKeySender(req *http.Request) (*http.Response, error)
- func (client AccountsClient) Update(ctx context.Context, resourceGroupName string, accountName string, ...) (result Account, err error)
- func (client AccountsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, ...) (*http.Request, error)
- func (client AccountsClient) UpdateResponder(resp *http.Response) (result Account, err error)
- func (client AccountsClient) UpdateSender(req *http.Request) (*http.Response, error)
- type BaseClient
- func (client BaseClient) CheckDomainAvailability(ctx context.Context, parameters CheckDomainAvailabilityParameter) (result CheckDomainAvailabilityResult, err error)
- func (client BaseClient) CheckDomainAvailabilityPreparer(ctx context.Context, parameters CheckDomainAvailabilityParameter) (*http.Request, error)
- func (client BaseClient) CheckDomainAvailabilityResponder(resp *http.Response) (result CheckDomainAvailabilityResult, err error)
- func (client BaseClient) CheckDomainAvailabilitySender(req *http.Request) (*http.Response, error)
- func (client BaseClient) CheckSkuAvailability(ctx context.Context, location string, parameters CheckSkuAvailabilityParameter) (result CheckSkuAvailabilityResultList, err error)
- func (client BaseClient) CheckSkuAvailabilityPreparer(ctx context.Context, location string, parameters CheckSkuAvailabilityParameter) (*http.Request, error)
- func (client BaseClient) CheckSkuAvailabilityResponder(resp *http.Response) (result CheckSkuAvailabilityResultList, err error)
- func (client BaseClient) CheckSkuAvailabilitySender(req *http.Request) (*http.Response, error)
- type CheckDomainAvailabilityParameter
- type CheckDomainAvailabilityResult
- type CheckSkuAvailabilityParameter
- type CheckSkuAvailabilityResult
- type CheckSkuAvailabilityResultList
- type Encryption
- type Error
- type ErrorBody
- type IPRule
- type Identity
- type IdentityType
- type KeyName
- type KeySource
- type KeyVaultProperties
- type MetricName
- type NetworkRuleAction
- type NetworkRuleSet
- type OperationDisplayInfo
- type OperationEntity
- type OperationEntityListResult
- type OperationEntityListResultIterator
- func (iter *OperationEntityListResultIterator) Next() error
- func (iter *OperationEntityListResultIterator) NextWithContext(ctx context.Context) (err error)
- func (iter OperationEntityListResultIterator) NotDone() bool
- func (iter OperationEntityListResultIterator) Response() OperationEntityListResult
- func (iter OperationEntityListResultIterator) Value() OperationEntity
- type OperationEntityListResultPage
- func (page *OperationEntityListResultPage) Next() error
- func (page *OperationEntityListResultPage) NextWithContext(ctx context.Context) (err error)
- func (page OperationEntityListResultPage) NotDone() bool
- func (page OperationEntityListResultPage) Response() OperationEntityListResult
- func (page OperationEntityListResultPage) Values() []OperationEntity
- type OperationsClient
- func (client OperationsClient) List(ctx context.Context) (result OperationEntityListResultPage, err error)
- func (client OperationsClient) ListComplete(ctx context.Context) (result OperationEntityListResultIterator, err error)
- func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)
- func (client OperationsClient) ListResponder(resp *http.Response) (result OperationEntityListResult, err error)
- func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)
- type ProvisioningState
- type QuotaUsageStatus
- type RegenerateKeyParameters
- type ResourceAndSku
- type ResourceSku
- type ResourceSkuRestrictionInfo
- type ResourceSkuRestrictions
- type ResourceSkuRestrictionsReasonCode
- type ResourceSkuRestrictionsType
- type ResourceSkusClient
- func (client ResourceSkusClient) List(ctx context.Context) (result ResourceSkusResultPage, err error)
- func (client ResourceSkusClient) ListComplete(ctx context.Context) (result ResourceSkusResultIterator, err error)
- func (client ResourceSkusClient) ListPreparer(ctx context.Context) (*http.Request, error)
- func (client ResourceSkusClient) ListResponder(resp *http.Response) (result ResourceSkusResult, err error)
- func (client ResourceSkusClient) ListSender(req *http.Request) (*http.Response, error)
- type ResourceSkusResult
- type ResourceSkusResultIterator
- func (iter *ResourceSkusResultIterator) Next() error
- func (iter *ResourceSkusResultIterator) NextWithContext(ctx context.Context) (err error)
- func (iter ResourceSkusResultIterator) NotDone() bool
- func (iter ResourceSkusResultIterator) Response() ResourceSkusResult
- func (iter ResourceSkusResultIterator) Value() ResourceSku
- type ResourceSkusResultPage
- func (page *ResourceSkusResultPage) Next() error
- func (page *ResourceSkusResultPage) NextWithContext(ctx context.Context) (err error)
- func (page ResourceSkusResultPage) NotDone() bool
- func (page ResourceSkusResultPage) Response() ResourceSkusResult
- func (page ResourceSkusResultPage) Values() []ResourceSku
- type Sku
- type SkuTier
- type UnitType
- type Usage
- type UsagesResult
- type UserAssignedIdentity
- type UserOwnedStorage
- type VirtualNetworkRule
Constants ¶
const (
// DefaultBaseURI is the default URI used for the service Cognitiveservices
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 Account ¶
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"` // Identity - The identity of Cognitive Services account. Identity *Identity `json:"identity,omitempty"` }
Account cognitive Services Account is an Azure resource representing the provisioned account, its type, location and SKU.
func (Account) MarshalJSON ¶
MarshalJSON is the custom marshaler for Account.
type AccountAPIProperties ¶
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 ¶
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 ¶
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 ¶
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 ¶
func (alr AccountListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type AccountListResultIterator ¶
type AccountListResultIterator struct {
// contains filtered or unexported fields
}
AccountListResultIterator provides access to a complete listing of Account values.
func NewAccountListResultIterator ¶
func NewAccountListResultIterator(page AccountListResultPage) AccountListResultIterator
Creates a new instance of the AccountListResultIterator type.
func (*AccountListResultIterator) Next ¶
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 ¶
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 ¶
func (iter AccountListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (AccountListResultIterator) Response ¶
func (iter AccountListResultIterator) Response() AccountListResult
Response returns the raw server response from the last page request.
func (AccountListResultIterator) Value ¶
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 ¶
type AccountListResultPage struct {
// contains filtered or unexported fields
}
AccountListResultPage contains a page of Account values.
func NewAccountListResultPage ¶
func NewAccountListResultPage(getNextPage func(context.Context, AccountListResult) (AccountListResult, error)) AccountListResultPage
Creates a new instance of the AccountListResultPage type.
func (*AccountListResultPage) Next ¶
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 ¶
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 ¶
func (page AccountListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (AccountListResultPage) Response ¶
func (page AccountListResultPage) Response() AccountListResult
Response returns the raw server response from the last page request.
func (AccountListResultPage) Values ¶
func (page AccountListResultPage) Values() []Account
Values returns the slice of values for the current page or nil if there are no values.
type AccountProperties ¶
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"` // Encryption - The encryption properties for this resource. Encryption *Encryption `json:"encryption,omitempty"` // UserOwnedStorage - The storage accounts for this resource. UserOwnedStorage *[]UserOwnedStorage `json:"userOwnedStorage,omitempty"` // APIProperties - The api properties for special APIs. APIProperties *AccountAPIProperties `json:"apiProperties,omitempty"` }
AccountProperties properties of Cognitive Services account.
type AccountsClient ¶
type AccountsClient struct {
BaseClient
}
AccountsClient is the cognitive Services 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) Create ¶
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 ¶
func (client AccountsClient) CreatePreparer(ctx context.Context, resourceGroupName string, accountName string, account Account) (*http.Request, error)
CreatePreparer prepares the Create request.
func (AccountsClient) CreateResponder ¶
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 ¶
CreateSender sends the Create 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 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 ¶
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 ¶
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (AccountsClient) GetProperties ¶
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 ¶
func (client AccountsClient) GetPropertiesPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
GetPropertiesPreparer prepares the GetProperties request.
func (AccountsClient) GetPropertiesResponder ¶
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 ¶
GetPropertiesSender sends the GetProperties request. The method will close the http.Response Body if it receives an error.
func (AccountsClient) GetUsages ¶
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 ¶
func (client AccountsClient) GetUsagesPreparer(ctx context.Context, resourceGroupName string, accountName string, filter string) (*http.Request, error)
GetUsagesPreparer prepares the GetUsages request.
func (AccountsClient) GetUsagesResponder ¶
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 ¶
GetUsagesSender sends the GetUsages request. The method will close the http.Response Body if it receives an error.
func (AccountsClient) List ¶
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 ¶
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 ¶
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 ¶
func (client AccountsClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (AccountsClient) ListByResourceGroupResponder ¶
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 ¶
ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.
func (AccountsClient) ListComplete ¶
func (client AccountsClient) ListComplete(ctx context.Context) (result AccountListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (AccountsClient) ListKeys ¶
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 ¶
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 AccountKeys, err error)
ListKeysResponder handles the response to the ListKeys request. The method always closes the http.Response Body.
func (AccountsClient) ListKeysSender ¶
ListKeysSender sends the ListKeys request. The method will close the http.Response Body if it receives an error.
func (AccountsClient) ListPreparer ¶
ListPreparer prepares the List request.
func (AccountsClient) ListResponder ¶
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 ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
func (AccountsClient) ListSkus ¶
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 ¶
func (client AccountsClient) ListSkusPreparer(ctx context.Context, resourceGroupName string, accountName string) (*http.Request, error)
ListSkusPreparer prepares the ListSkus request.
func (AccountsClient) ListSkusResponder ¶
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 ¶
ListSkusSender sends the ListSkus request. The method will close the http.Response Body if it receives an error.
func (AccountsClient) RegenerateKey ¶
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 ¶
func (client AccountsClient) RegenerateKeyPreparer(ctx context.Context, resourceGroupName string, accountName string, parameters RegenerateKeyParameters) (*http.Request, error)
RegenerateKeyPreparer prepares the RegenerateKey request.
func (AccountsClient) RegenerateKeyResponder ¶
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 ¶
RegenerateKeySender sends the RegenerateKey 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, 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 ¶
func (client AccountsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, accountName string, account Account) (*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 ¶
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
type BaseClient ¶
BaseClient is the base client for Cognitiveservices.
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).
func (BaseClient) CheckDomainAvailability ¶
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 ¶
func (client BaseClient) CheckDomainAvailabilityPreparer(ctx context.Context, parameters CheckDomainAvailabilityParameter) (*http.Request, error)
CheckDomainAvailabilityPreparer prepares the CheckDomainAvailability request.
func (BaseClient) CheckDomainAvailabilityResponder ¶
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 ¶
CheckDomainAvailabilitySender sends the CheckDomainAvailability request. The method will close the http.Response Body if it receives an error.
func (BaseClient) CheckSkuAvailability ¶
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 ¶
func (client BaseClient) CheckSkuAvailabilityPreparer(ctx context.Context, location string, parameters CheckSkuAvailabilityParameter) (*http.Request, error)
CheckSkuAvailabilityPreparer prepares the CheckSkuAvailability request.
func (BaseClient) CheckSkuAvailabilityResponder ¶
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 ¶
CheckSkuAvailabilitySender sends the CheckSkuAvailability request. The method will close the http.Response Body if it receives an error.
type CheckDomainAvailabilityParameter ¶
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 ¶
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 ¶
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 ¶
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 ¶
type CheckSkuAvailabilityResultList struct { autorest.Response `json:"-"` // Value - Check SKU availability result list. Value *[]CheckSkuAvailabilityResult `json:"value,omitempty"` }
CheckSkuAvailabilityResultList check SKU availability result list.
type Encryption ¶
type Encryption struct { // KeyVaultProperties - Properties of KeyVault KeyVaultProperties *KeyVaultProperties `json:"keyVaultProperties,omitempty"` // KeySource - Enumerates the possible value of keySource for Encryption. Possible values include: 'MicrosoftCognitiveServices', 'MicrosoftKeyVault' KeySource KeySource `json:"keySource,omitempty"` }
Encryption properties to configure Encryption
type Error ¶
type Error struct { // Error - The error body. Error *ErrorBody `json:"error,omitempty"` }
Error cognitive Services error object.
type ErrorBody ¶
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 ¶
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 Identity ¶
type Identity struct { // Type - Type of managed service identity. Possible values include: 'None', 'SystemAssigned', 'UserAssigned' Type IdentityType `json:"type,omitempty"` // TenantID - READ-ONLY; Tenant of managed service identity. TenantID *string `json:"tenantId,omitempty"` // PrincipalID - READ-ONLY; Principal Id of managed service identity. PrincipalID *string `json:"principalId,omitempty"` // UserAssignedIdentities - The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} UserAssignedIdentities map[string]*UserAssignedIdentity `json:"userAssignedIdentities"` }
Identity managed service identity.
func (Identity) MarshalJSON ¶
MarshalJSON is the custom marshaler for Identity.
type IdentityType ¶
type IdentityType string
IdentityType enumerates the values for identity type.
const ( // None ... None IdentityType = "None" // SystemAssigned ... SystemAssigned IdentityType = "SystemAssigned" // UserAssigned ... UserAssigned IdentityType = "UserAssigned" )
func PossibleIdentityTypeValues ¶
func PossibleIdentityTypeValues() []IdentityType
PossibleIdentityTypeValues returns an array of possible values for the IdentityType const type.
type KeyName ¶
type KeyName string
KeyName enumerates the values for key name.
func PossibleKeyNameValues ¶
func PossibleKeyNameValues() []KeyName
PossibleKeyNameValues returns an array of possible values for the KeyName const type.
type KeySource ¶
type KeySource string
KeySource enumerates the values for key source.
func PossibleKeySourceValues ¶
func PossibleKeySourceValues() []KeySource
PossibleKeySourceValues returns an array of possible values for the KeySource const type.
type KeyVaultProperties ¶
type KeyVaultProperties struct { // KeyName - Name of the Key from KeyVault KeyName *string `json:"keyName,omitempty"` // KeyVersion - Version of the Key from KeyVault KeyVersion *string `json:"keyVersion,omitempty"` // KeyVaultURI - Uri of KeyVault KeyVaultURI *string `json:"keyVaultUri,omitempty"` }
KeyVaultProperties properties to configure keyVault Properties
type MetricName ¶
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 ¶
type NetworkRuleAction string
NetworkRuleAction enumerates the values for network rule action.
const ( // Allow ... Allow NetworkRuleAction = "Allow" // Deny ... Deny NetworkRuleAction = "Deny" )
func PossibleNetworkRuleActionValues ¶
func PossibleNetworkRuleActionValues() []NetworkRuleAction
PossibleNetworkRuleActionValues returns an array of possible values for the NetworkRuleAction const type.
type NetworkRuleSet ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
func (iter OperationEntityListResultIterator) Response() OperationEntityListResult
Response returns the raw server response from the last page request.
func (OperationEntityListResultIterator) Value ¶
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 ¶
type OperationEntityListResultPage struct {
// contains filtered or unexported fields
}
OperationEntityListResultPage contains a page of OperationEntity values.
func NewOperationEntityListResultPage ¶
func NewOperationEntityListResultPage(getNextPage func(context.Context, OperationEntityListResult) (OperationEntityListResult, error)) OperationEntityListResultPage
Creates a new instance of the OperationEntityListResultPage type.
func (*OperationEntityListResultPage) Next ¶
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 ¶
func (page OperationEntityListResultPage) Response() OperationEntityListResult
Response returns the raw server response from the last page request.
func (OperationEntityListResultPage) Values ¶
func (page OperationEntityListResultPage) Values() []OperationEntity
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 cognitive Services 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 OperationEntityListResultPage, err error)
List lists all the available Cognitive Services account 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 ¶
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 ¶
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" // Moving ... Moving ProvisioningState = "Moving" // ResolvingDNS ... ResolvingDNS ProvisioningState = "ResolvingDNS" // Succeeded ... Succeeded ProvisioningState = "Succeeded" )
func PossibleProvisioningStateValues ¶
func PossibleProvisioningStateValues() []ProvisioningState
PossibleProvisioningStateValues returns an array of possible values for the ProvisioningState const type.
type QuotaUsageStatus ¶
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 ¶
func PossibleQuotaUsageStatusValues() []QuotaUsageStatus
PossibleQuotaUsageStatusValues returns an array of possible values for the QuotaUsageStatus const type.
type RegenerateKeyParameters ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
type ResourceSkuRestrictionsReasonCode string
ResourceSkuRestrictionsReasonCode enumerates the values for resource sku restrictions reason code.
const ( // NotAvailableForSubscription ... NotAvailableForSubscription ResourceSkuRestrictionsReasonCode = "NotAvailableForSubscription" // QuotaID ... QuotaID ResourceSkuRestrictionsReasonCode = "QuotaId" )
func PossibleResourceSkuRestrictionsReasonCodeValues ¶
func PossibleResourceSkuRestrictionsReasonCodeValues() []ResourceSkuRestrictionsReasonCode
PossibleResourceSkuRestrictionsReasonCodeValues returns an array of possible values for the ResourceSkuRestrictionsReasonCode const type.
type ResourceSkuRestrictionsType ¶
type ResourceSkuRestrictionsType string
ResourceSkuRestrictionsType enumerates the values for resource sku restrictions type.
const ( // Location ... Location ResourceSkuRestrictionsType = "Location" // Zone ... Zone ResourceSkuRestrictionsType = "Zone" )
func PossibleResourceSkuRestrictionsTypeValues ¶
func PossibleResourceSkuRestrictionsTypeValues() []ResourceSkuRestrictionsType
PossibleResourceSkuRestrictionsTypeValues returns an array of possible values for the ResourceSkuRestrictionsType const type.
type ResourceSkusClient ¶
type ResourceSkusClient struct {
BaseClient
}
ResourceSkusClient is the cognitive Services Management Client
func NewResourceSkusClient ¶
func NewResourceSkusClient(subscriptionID string) ResourceSkusClient
NewResourceSkusClient creates an instance of the ResourceSkusClient client.
func NewResourceSkusClientWithBaseURI ¶
func NewResourceSkusClientWithBaseURI(baseURI string, subscriptionID string) ResourceSkusClient
NewResourceSkusClientWithBaseURI creates an instance of the ResourceSkusClient 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 (ResourceSkusClient) List ¶
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 ¶
func (client ResourceSkusClient) ListComplete(ctx context.Context) (result ResourceSkusResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (ResourceSkusClient) ListPreparer ¶
ListPreparer prepares the List request.
func (ResourceSkusClient) ListResponder ¶
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 ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type ResourceSkusResult ¶
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 ¶
func (rsr ResourceSkusResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type ResourceSkusResultIterator ¶
type ResourceSkusResultIterator struct {
// contains filtered or unexported fields
}
ResourceSkusResultIterator provides access to a complete listing of ResourceSku values.
func NewResourceSkusResultIterator ¶
func NewResourceSkusResultIterator(page ResourceSkusResultPage) ResourceSkusResultIterator
Creates a new instance of the ResourceSkusResultIterator type.
func (*ResourceSkusResultIterator) Next ¶
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 ¶
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 ¶
func (iter ResourceSkusResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (ResourceSkusResultIterator) Response ¶
func (iter ResourceSkusResultIterator) Response() ResourceSkusResult
Response returns the raw server response from the last page request.
func (ResourceSkusResultIterator) Value ¶
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 ¶
type ResourceSkusResultPage struct {
// contains filtered or unexported fields
}
ResourceSkusResultPage contains a page of ResourceSku values.
func NewResourceSkusResultPage ¶
func NewResourceSkusResultPage(getNextPage func(context.Context, ResourceSkusResult) (ResourceSkusResult, error)) ResourceSkusResultPage
Creates a new instance of the ResourceSkusResultPage type.
func (*ResourceSkusResultPage) Next ¶
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 ¶
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 ¶
func (page ResourceSkusResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (ResourceSkusResultPage) Response ¶
func (page ResourceSkusResultPage) Response() ResourceSkusResult
Response returns the raw server response from the last page request.
func (ResourceSkusResultPage) Values ¶
func (page ResourceSkusResultPage) Values() []ResourceSku
Values returns the slice of values for the current page or nil if there are no values.
type Sku ¶
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 ¶
type SkuTier string
SkuTier enumerates the values for sku tier.
func PossibleSkuTierValues ¶
func PossibleSkuTierValues() []SkuTier
PossibleSkuTierValues returns an array of possible values for the SkuTier const type.
type UnitType ¶
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 ¶
func PossibleUnitTypeValues() []UnitType
PossibleUnitTypeValues returns an array of possible values for the UnitType const type.
type Usage ¶
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 ¶
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 UserAssignedIdentity ¶
type UserAssignedIdentity struct { // PrincipalID - Azure Active Directory principal ID associated with this Identity. PrincipalID *string `json:"principalId,omitempty"` // ClientID - Client App Id associated with this identity. ClientID *string `json:"clientId,omitempty"` }
UserAssignedIdentity user-assigned managed identity.
type UserOwnedStorage ¶
type UserOwnedStorage struct { // ResourceID - Full resource id of a Microsoft.Storage resource. ResourceID *string `json:"resourceId,omitempty"` }
UserOwnedStorage the user owned storage for Cognitive Services account.
type VirtualNetworkRule ¶
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.