armcognitiveservices

package module
v0.2.0 Latest Latest
Warning

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

 Go to latest Published: Nov 1, 2021 License: MIT Imports: 15 Imported by: 11

README

Azure Cognitive Services Module for Go

PkgGoDev

The armcognitiveservices module provides operations for working with Azure Cognitive Services.

Source code

Getting started

Prerequisites

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure Cognitive Services module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cognitiveservices/armcognitiveservices

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure Cognitive Services. The azidentity module provides facilities for various ways of authenticating with Azure including client/secret, certificate, managed identity, and more.

cred, err := azidentity.NewDefaultAzureCredential(nil)

For more information on authentication, please see the documentation for azidentity at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity.

Clients

Azure Cognitive Services modules consist of one or more clients. A client groups a set of related APIs, providing access to its functionality within the specified subscription. Create one or more clients to access the APIs you require using your credential.

client := armcognitiveservices.NewResourceSKUsClient(<subscription ID>, cred, nil)

You can use ClientOptions in package github.com/Azure/azure-sdk-for-go/sdk/azcore/arm to set endpoint to connect with public and sovereign clouds as well as Azure Stack. For more information, please see the documentation for azcore at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azcore.

options = arm.ClientOptions{
    Host: arm.AzureChina,
}
client := armcognitiveservices.NewResourceSKUsClient(<subscription ID>, cred, &options)

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the Cognitive Services label.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type APIKeys 

type APIKeys struct {
	// Gets the value of key 1.
	Key1 *string `json:"key1,omitempty"`

	// Gets the value of key 2.
	Key2 *string `json:"key2,omitempty"`
}

APIKeys - The access keys for the cognitive services account.

type APIProperties 

type APIProperties struct {
	// (Metrics Advisor Only) The Azure AD Client Id (Application Id).
	AADClientID *string `json:"aadClientId,omitempty"`

	// (Metrics Advisor Only) The Azure AD Tenant Id.
	AADTenantID *string `json:"aadTenantId,omitempty"`

	// OPTIONAL; Contains additional key/value pairs not defined in the schema.
	AdditionalProperties map[string]map[string]interface{}

	// (Personalization Only) The flag to enable statistics of Bing Search.
	EventHubConnectionString *string `json:"eventHubConnectionString,omitempty"`

	// (QnAMaker Only) The Azure Search endpoint id of QnAMaker.
	QnaAzureSearchEndpointID *string `json:"qnaAzureSearchEndpointId,omitempty"`

	// (QnAMaker Only) The Azure Search endpoint key of QnAMaker.
	QnaAzureSearchEndpointKey *string `json:"qnaAzureSearchEndpointKey,omitempty"`

	// (QnAMaker Only) The runtime endpoint of QnAMaker.
	QnaRuntimeEndpoint *string `json:"qnaRuntimeEndpoint,omitempty"`

	// (Bing Search Only) The flag to enable statistics of Bing Search.
	StatisticsEnabled *bool `json:"statisticsEnabled,omitempty"`

	// (Personalization Only) The storage account connection string.
	StorageAccountConnectionString *string `json:"storageAccountConnectionString,omitempty"`

	// (Metrics Advisor Only) The super user of Metrics Advisor.
	SuperUser *string `json:"superUser,omitempty"`

	// (Metrics Advisor Only) The website name of Metrics Advisor.
	WebsiteName *string `json:"websiteName,omitempty"`
}

APIProperties - The api properties for special APIs.

func (APIProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type APIProperties.

func (*APIProperties) UnmarshalJSON 

func (a *APIProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type APIProperties.

type Account 

type Account struct {
	AzureEntityResource
	// Identity for the resource.
	Identity *Identity `json:"identity,omitempty"`

	// The Kind of the resource.
	Kind *string `json:"kind,omitempty"`

	// The geo-location where the resource lives
	Location *string `json:"location,omitempty"`

	// Properties of Cognitive Services account.
	Properties *AccountProperties `json:"properties,omitempty"`

	// The resource model definition representing SKU
	SKU *SKU `json:"sku,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`
}

Account - Cognitive Services account is an Azure resource representing the provisioned account, it's type, location and SKU.

func (Account) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Account.

type AccountListResult 

type AccountListResult struct {
	// The link used to get the next page of accounts.
	NextLink *string `json:"nextLink,omitempty"`

	// READ-ONLY; Gets the list of Cognitive Services accounts and their properties.
	Value []*Account `json:"value,omitempty" azure:"ro"`
}

AccountListResult - The list of cognitive services accounts operation response.

func (AccountListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AccountListResult.

type AccountProperties 

type AccountProperties struct {
	// The api properties for special APIs.
	APIProperties   *APIProperties `json:"apiProperties,omitempty"`
	AllowedFqdnList []*string      `json:"allowedFqdnList,omitempty"`

	// Optional subdomain name used for token-based authentication.
	CustomSubDomainName *string `json:"customSubDomainName,omitempty"`
	DisableLocalAuth    *bool   `json:"disableLocalAuth,omitempty"`

	// The encryption properties for this resource.
	Encryption *Encryption `json:"encryption,omitempty"`

	// Resource migration token.
	MigrationToken *string `json:"migrationToken,omitempty"`

	// A collection of rules governing the accessibility from specific network locations.
	NetworkACLs *NetworkRuleSet `json:"networkAcls,omitempty"`

	// Whether or not public endpoint access is allowed for this account. Value is optional but if passed in, must be 'Enabled' or 'Disabled'
	PublicNetworkAccess           *PublicNetworkAccess `json:"publicNetworkAccess,omitempty"`
	Restore                       *bool                `json:"restore,omitempty"`
	RestrictOutboundNetworkAccess *bool                `json:"restrictOutboundNetworkAccess,omitempty"`

	// The storage accounts for this resource.
	UserOwnedStorage []*UserOwnedStorage `json:"userOwnedStorage,omitempty"`

	// READ-ONLY; The call rate limit Cognitive Services account.
	CallRateLimit *CallRateLimit `json:"callRateLimit,omitempty" azure:"ro"`

	// READ-ONLY; Gets the capabilities of the cognitive services account. Each item indicates the capability of a specific feature. The values are read-only
	// and for reference only.
	Capabilities []*SKUCapability `json:"capabilities,omitempty" azure:"ro"`

	// READ-ONLY; Gets the date of cognitive services account creation.
	DateCreated *string `json:"dateCreated,omitempty" azure:"ro"`

	// READ-ONLY; Endpoint of the created account.
	Endpoint *string `json:"endpoint,omitempty" azure:"ro"`

	// READ-ONLY; Dictionary of
	Endpoints map[string]*string `json:"endpoints,omitempty" azure:"ro"`

	// READ-ONLY; The internal identifier (deprecated, do not use this property).
	InternalID *string `json:"internalId,omitempty" azure:"ro"`

	// READ-ONLY; If the resource is migrated from an existing key.
	IsMigrated *bool `json:"isMigrated,omitempty" azure:"ro"`

	// READ-ONLY; The private endpoint connection associated with the Cognitive Services account.
	PrivateEndpointConnections []*PrivateEndpointConnection `json:"privateEndpointConnections,omitempty" azure:"ro"`

	// READ-ONLY; Gets the status of the cognitive services account at the time the operation was called.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY
	QuotaLimit *QuotaLimit `json:"quotaLimit,omitempty" azure:"ro"`

	// READ-ONLY; Sku change info of account.
	SKUChangeInfo *SKUChangeInfo `json:"skuChangeInfo,omitempty" azure:"ro"`
}

AccountProperties - Properties of Cognitive Services account.

func (AccountProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AccountProperties.

type AccountSKU 

type AccountSKU struct {
	// Resource Namespace and Type
	ResourceType *string `json:"resourceType,omitempty"`

	// The SKU of Cognitive Services account.
	SKU *SKU `json:"sku,omitempty"`
}

AccountSKU - Cognitive Services resource type and SKU.

type AccountSKUListResult 

type AccountSKUListResult struct {
	// Gets the list of Cognitive Services accounts and their properties.
	Value []*AccountSKU `json:"value,omitempty"`
}

AccountSKUListResult - The list of cognitive services accounts operation response.

func (AccountSKUListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AccountSKUListResult.

type AccountsBeginCreateOptions 

type AccountsBeginCreateOptions struct {
}

AccountsBeginCreateOptions contains the optional parameters for the Accounts.BeginCreate method.

type AccountsBeginDeleteOptions 

type AccountsBeginDeleteOptions struct {
}

AccountsBeginDeleteOptions contains the optional parameters for the Accounts.BeginDelete method.

type AccountsBeginUpdateOptions 

type AccountsBeginUpdateOptions struct {
}

AccountsBeginUpdateOptions contains the optional parameters for the Accounts.BeginUpdate method.

type AccountsClient 

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

AccountsClient contains the methods for the Accounts group. Don't use this type directly, use NewAccountsClient() instead.

func NewAccountsClient 

func NewAccountsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *AccountsClient

NewAccountsClient creates a new instance of AccountsClient with the specified values.

func (*AccountsClient) BeginCreate 

func (client *AccountsClient) BeginCreate(ctx context.Context, resourceGroupName string, accountName string, account Account, options *AccountsBeginCreateOptions) (AccountsCreatePollerResponse, error)

BeginCreate - 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. If the operation fails it returns the *ErrorResponse error type.

func (*AccountsClient) BeginDelete 

func (client *AccountsClient) BeginDelete(ctx context.Context, resourceGroupName string, accountName string, options *AccountsBeginDeleteOptions) (AccountsDeletePollerResponse, error)

BeginDelete - Deletes a Cognitive Services account from the resource group. If the operation fails it returns the *ErrorResponse error type.

func (*AccountsClient) BeginUpdate 

func (client *AccountsClient) BeginUpdate(ctx context.Context, resourceGroupName string, accountName string, account Account, options *AccountsBeginUpdateOptions) (AccountsUpdatePollerResponse, error)

BeginUpdate - Updates a Cognitive Services account If the operation fails it returns the *ErrorResponse error type.

func (*AccountsClient) Get 

func (client *AccountsClient) Get(ctx context.Context, resourceGroupName string, accountName string, options *AccountsGetOptions) (AccountsGetResponse, error)

Get - Returns a Cognitive Services account specified by the parameters. If the operation fails it returns the *ErrorResponse error type.

func (*AccountsClient) List 

func (client *AccountsClient) List(options *AccountsListOptions) *AccountsListPager

List - Returns all the resources of a particular type belonging to a subscription. If the operation fails it returns the *ErrorResponse error type.

func (*AccountsClient) ListByResourceGroup 

func (client *AccountsClient) ListByResourceGroup(resourceGroupName string, options *AccountsListByResourceGroupOptions) *AccountsListByResourceGroupPager

ListByResourceGroup - Returns all the resources of a particular type belonging to a resource group If the operation fails it returns the *ErrorResponse error type.

func (*AccountsClient) ListKeys 

func (client *AccountsClient) ListKeys(ctx context.Context, resourceGroupName string, accountName string, options *AccountsListKeysOptions) (AccountsListKeysResponse, error)

ListKeys - Lists the account keys for the specified Cognitive Services account. If the operation fails it returns the *ErrorResponse error type.

func (*AccountsClient) ListSKUs 

func (client *AccountsClient) ListSKUs(ctx context.Context, resourceGroupName string, accountName string, options *AccountsListSKUsOptions) (AccountsListSKUsResponse, error)

ListSKUs - List available SKUs for the requested Cognitive Services account If the operation fails it returns the *ErrorResponse error type.

func (*AccountsClient) ListUsages 

func (client *AccountsClient) ListUsages(ctx context.Context, resourceGroupName string, accountName string, options *AccountsListUsagesOptions) (AccountsListUsagesResponse, error)

ListUsages - Get usages for the requested Cognitive Services account If the operation fails it returns the *ErrorResponse error type.

func (*AccountsClient) RegenerateKey 

func (client *AccountsClient) RegenerateKey(ctx context.Context, resourceGroupName string, accountName string, parameters RegenerateKeyParameters, options *AccountsRegenerateKeyOptions) (AccountsRegenerateKeyResponse, error)

RegenerateKey - Regenerates the specified account key for the specified Cognitive Services account. If the operation fails it returns the *ErrorResponse error type.

type AccountsCreatePoller 

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

AccountsCreatePoller provides polling facilities until the operation reaches a terminal state.

func (*AccountsCreatePoller) Done 

func (p *AccountsCreatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*AccountsCreatePoller) FinalResponse 

func (p *AccountsCreatePoller) FinalResponse(ctx context.Context) (AccountsCreateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final AccountsCreateResponse will be returned.

func (*AccountsCreatePoller) Poll 

func (p *AccountsCreatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*AccountsCreatePoller) ResumeToken 

func (p *AccountsCreatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type AccountsCreatePollerResponse 

type AccountsCreatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *AccountsCreatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

AccountsCreatePollerResponse contains the response from method Accounts.Create.

func (AccountsCreatePollerResponse) PollUntilDone 

func (l AccountsCreatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (AccountsCreateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*AccountsCreatePollerResponse) Resume 

func (l *AccountsCreatePollerResponse) Resume(ctx context.Context, client *AccountsClient, token string) error

Resume rehydrates a AccountsCreatePollerResponse from the provided client and resume token.

type AccountsCreateResponse 

type AccountsCreateResponse struct {
	AccountsCreateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

AccountsCreateResponse contains the response from method Accounts.Create.

type AccountsCreateResult 

type AccountsCreateResult struct {
	Account
}

AccountsCreateResult contains the result from method Accounts.Create.

type AccountsDeletePoller 

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

AccountsDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*AccountsDeletePoller) Done 

func (p *AccountsDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*AccountsDeletePoller) FinalResponse 

func (p *AccountsDeletePoller) FinalResponse(ctx context.Context) (AccountsDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final AccountsDeleteResponse will be returned.

func (*AccountsDeletePoller) Poll 

func (p *AccountsDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*AccountsDeletePoller) ResumeToken 

func (p *AccountsDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type AccountsDeletePollerResponse 

type AccountsDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *AccountsDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

AccountsDeletePollerResponse contains the response from method Accounts.Delete.

func (AccountsDeletePollerResponse) PollUntilDone 

func (l AccountsDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (AccountsDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*AccountsDeletePollerResponse) Resume 

func (l *AccountsDeletePollerResponse) Resume(ctx context.Context, client *AccountsClient, token string) error

Resume rehydrates a AccountsDeletePollerResponse from the provided client and resume token.

type AccountsDeleteResponse 

type AccountsDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

AccountsDeleteResponse contains the response from method Accounts.Delete.

type AccountsGetOptions 

type AccountsGetOptions struct {
}

AccountsGetOptions contains the optional parameters for the Accounts.Get method.

type AccountsGetResponse 

type AccountsGetResponse struct {
	AccountsGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

AccountsGetResponse contains the response from method Accounts.Get.

type AccountsGetResult 

type AccountsGetResult struct {
	Account
}

AccountsGetResult contains the result from method Accounts.Get.

type AccountsListByResourceGroupOptions 

type AccountsListByResourceGroupOptions struct {
}

AccountsListByResourceGroupOptions contains the optional parameters for the Accounts.ListByResourceGroup method.

type AccountsListByResourceGroupPager 

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

AccountsListByResourceGroupPager provides operations for iterating over paged responses.

func (*AccountsListByResourceGroupPager) Err 

func (p *AccountsListByResourceGroupPager) Err() error

Err returns the last error encountered while paging.

func (*AccountsListByResourceGroupPager) NextPage 

func (p *AccountsListByResourceGroupPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*AccountsListByResourceGroupPager) PageResponse 

func (p *AccountsListByResourceGroupPager) PageResponse() AccountsListByResourceGroupResponse

PageResponse returns the current AccountsListByResourceGroupResponse page.

type AccountsListByResourceGroupResponse 

type AccountsListByResourceGroupResponse struct {
	AccountsListByResourceGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

AccountsListByResourceGroupResponse contains the response from method Accounts.ListByResourceGroup.

type AccountsListByResourceGroupResult 

type AccountsListByResourceGroupResult struct {
	AccountListResult
}

AccountsListByResourceGroupResult contains the result from method Accounts.ListByResourceGroup.

type AccountsListKeysOptions 

type AccountsListKeysOptions struct {
}

AccountsListKeysOptions contains the optional parameters for the Accounts.ListKeys method.

type AccountsListKeysResponse 

type AccountsListKeysResponse struct {
	AccountsListKeysResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

AccountsListKeysResponse contains the response from method Accounts.ListKeys.

type AccountsListKeysResult 

type AccountsListKeysResult struct {
	APIKeys
}

AccountsListKeysResult contains the result from method Accounts.ListKeys.

type AccountsListOptions 

type AccountsListOptions struct {
}

AccountsListOptions contains the optional parameters for the Accounts.List method.

type AccountsListPager 

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

AccountsListPager provides operations for iterating over paged responses.

func (*AccountsListPager) Err 

func (p *AccountsListPager) Err() error

Err returns the last error encountered while paging.

func (*AccountsListPager) NextPage 

func (p *AccountsListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*AccountsListPager) PageResponse 

func (p *AccountsListPager) PageResponse() AccountsListResponse

PageResponse returns the current AccountsListResponse page.

type AccountsListResponse 

type AccountsListResponse struct {
	AccountsListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

AccountsListResponse contains the response from method Accounts.List.

type AccountsListResult 

type AccountsListResult struct {
	AccountListResult
}

AccountsListResult contains the result from method Accounts.List.

type AccountsListSKUsOptions 

type AccountsListSKUsOptions struct {
}

AccountsListSKUsOptions contains the optional parameters for the Accounts.ListSKUs method.

type AccountsListSKUsResponse 

type AccountsListSKUsResponse struct {
	AccountsListSKUsResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

AccountsListSKUsResponse contains the response from method Accounts.ListSKUs.

type AccountsListSKUsResult 

type AccountsListSKUsResult struct {
	AccountSKUListResult
}

AccountsListSKUsResult contains the result from method Accounts.ListSKUs.

type AccountsListUsagesOptions 

type AccountsListUsagesOptions struct {
	// 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).
	Filter *string
}

AccountsListUsagesOptions contains the optional parameters for the Accounts.ListUsages method.

type AccountsListUsagesResponse 

type AccountsListUsagesResponse struct {
	AccountsListUsagesResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

AccountsListUsagesResponse contains the response from method Accounts.ListUsages.

type AccountsListUsagesResult 

type AccountsListUsagesResult struct {
	UsageListResult
}

AccountsListUsagesResult contains the result from method Accounts.ListUsages.

type AccountsRegenerateKeyOptions 

type AccountsRegenerateKeyOptions struct {
}

AccountsRegenerateKeyOptions contains the optional parameters for the Accounts.RegenerateKey method.

type AccountsRegenerateKeyResponse 

type AccountsRegenerateKeyResponse struct {
	AccountsRegenerateKeyResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

AccountsRegenerateKeyResponse contains the response from method Accounts.RegenerateKey.

type AccountsRegenerateKeyResult 

type AccountsRegenerateKeyResult struct {
	APIKeys
}

AccountsRegenerateKeyResult contains the result from method Accounts.RegenerateKey.

type AccountsUpdatePoller 

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

AccountsUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*AccountsUpdatePoller) Done 

func (p *AccountsUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*AccountsUpdatePoller) FinalResponse 

func (p *AccountsUpdatePoller) FinalResponse(ctx context.Context) (AccountsUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final AccountsUpdateResponse will be returned.

func (*AccountsUpdatePoller) Poll 

func (p *AccountsUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*AccountsUpdatePoller) ResumeToken 

func (p *AccountsUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type AccountsUpdatePollerResponse 

type AccountsUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *AccountsUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

AccountsUpdatePollerResponse contains the response from method Accounts.Update.

func (AccountsUpdatePollerResponse) PollUntilDone 

func (l AccountsUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (AccountsUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*AccountsUpdatePollerResponse) Resume 

func (l *AccountsUpdatePollerResponse) Resume(ctx context.Context, client *AccountsClient, token string) error

Resume rehydrates a AccountsUpdatePollerResponse from the provided client and resume token.

type AccountsUpdateResponse 

type AccountsUpdateResponse struct {
	AccountsUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

AccountsUpdateResponse contains the response from method Accounts.Update.

type AccountsUpdateResult 

type AccountsUpdateResult struct {
	Account
}

AccountsUpdateResult contains the result from method Accounts.Update.

type ActionType 

type ActionType string

ActionType - Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. 

const (
	ActionTypeInternal ActionType = "Internal"
)

func PossibleActionTypeValues 

func PossibleActionTypeValues() []ActionType

PossibleActionTypeValues returns the possible values for the ActionType const type.

func (ActionType) ToPtr 

func (c ActionType) ToPtr() *ActionType

ToPtr returns a *ActionType pointing to the current value.

type AzureEntityResource 

type AzureEntityResource struct {
	Resource
	// READ-ONLY; Resource Etag.
	Etag *string `json:"etag,omitempty" azure:"ro"`
}

AzureEntityResource - The resource model definition for an Azure Resource Manager resource with an etag.

func (AzureEntityResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AzureEntityResource.

type CallRateLimit 

type CallRateLimit struct {
	// The count value of Call Rate Limit.
	Count *float32 `json:"count,omitempty"`

	// The renewal period in seconds of Call Rate Limit.
	RenewalPeriod *float32          `json:"renewalPeriod,omitempty"`
	Rules         []*ThrottlingRule `json:"rules,omitempty"`
}

CallRateLimit - The call rate limit Cognitive Services account.

func (CallRateLimit) MarshalJSON 

func (c CallRateLimit) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CallRateLimit.

type CheckDomainAvailabilityParameter 

type CheckDomainAvailabilityParameter struct {
	// REQUIRED; The subdomain name to use.
	SubdomainName *string `json:"subdomainName,omitempty"`

	// REQUIRED; The Type of the resource.
	Type *string `json:"type,omitempty"`
}

CheckDomainAvailabilityParameter - Check Domain availability parameter.

type CheckSKUAvailabilityParameter 

type CheckSKUAvailabilityParameter struct {
	// REQUIRED; The Kind of the resource.
	Kind *string `json:"kind,omitempty"`

	// REQUIRED; The SKU of the resource.
	SKUs []*string `json:"skus,omitempty"`

	// REQUIRED; The Type of the resource.
	Type *string `json:"type,omitempty"`
}

CheckSKUAvailabilityParameter - Check SKU availability parameter.

func (CheckSKUAvailabilityParameter) MarshalJSON 

func (c CheckSKUAvailabilityParameter) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CheckSKUAvailabilityParameter.

type CognitiveServicesManagementClient 

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

CognitiveServicesManagementClient contains the methods for the CognitiveServicesManagementClient group. Don't use this type directly, use NewCognitiveServicesManagementClient() instead.

func NewCognitiveServicesManagementClient 

func NewCognitiveServicesManagementClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *CognitiveServicesManagementClient

NewCognitiveServicesManagementClient creates a new instance of CognitiveServicesManagementClient with the specified values.

func (*CognitiveServicesManagementClient) CheckDomainAvailability 

func (client *CognitiveServicesManagementClient) CheckDomainAvailability(ctx context.Context, parameters CheckDomainAvailabilityParameter, options *CognitiveServicesManagementClientCheckDomainAvailabilityOptions) (CognitiveServicesManagementClientCheckDomainAvailabilityResponse, error)

CheckDomainAvailability - Check whether a domain is available. If the operation fails it returns the *ErrorResponse error type.

func (*CognitiveServicesManagementClient) CheckSKUAvailability 

func (client *CognitiveServicesManagementClient) CheckSKUAvailability(ctx context.Context, location string, parameters CheckSKUAvailabilityParameter, options *CognitiveServicesManagementClientCheckSKUAvailabilityOptions) (CognitiveServicesManagementClientCheckSKUAvailabilityResponse, error)

CheckSKUAvailability - Check available SKUs. If the operation fails it returns the *ErrorResponse error type.

type CognitiveServicesManagementClientCheckDomainAvailabilityOptions 

type CognitiveServicesManagementClientCheckDomainAvailabilityOptions struct {
}

CognitiveServicesManagementClientCheckDomainAvailabilityOptions contains the optional parameters for the CognitiveServicesManagementClient.CheckDomainAvailability method.

type CognitiveServicesManagementClientCheckDomainAvailabilityResponse 

type CognitiveServicesManagementClientCheckDomainAvailabilityResponse struct {
	CognitiveServicesManagementClientCheckDomainAvailabilityResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

CognitiveServicesManagementClientCheckDomainAvailabilityResponse contains the response from method CognitiveServicesManagementClient.CheckDomainAvailability.

type CognitiveServicesManagementClientCheckDomainAvailabilityResult 

type CognitiveServicesManagementClientCheckDomainAvailabilityResult struct {
	DomainAvailability
}

CognitiveServicesManagementClientCheckDomainAvailabilityResult contains the result from method CognitiveServicesManagementClient.CheckDomainAvailability.

type CognitiveServicesManagementClientCheckSKUAvailabilityOptions 

type CognitiveServicesManagementClientCheckSKUAvailabilityOptions struct {
}

CognitiveServicesManagementClientCheckSKUAvailabilityOptions contains the optional parameters for the CognitiveServicesManagementClient.CheckSKUAvailability method.

type CognitiveServicesManagementClientCheckSKUAvailabilityResponse 

type CognitiveServicesManagementClientCheckSKUAvailabilityResponse struct {
	CognitiveServicesManagementClientCheckSKUAvailabilityResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

CognitiveServicesManagementClientCheckSKUAvailabilityResponse contains the response from method CognitiveServicesManagementClient.CheckSKUAvailability.

type CognitiveServicesManagementClientCheckSKUAvailabilityResult 

type CognitiveServicesManagementClientCheckSKUAvailabilityResult struct {
	SKUAvailabilityListResult
}

CognitiveServicesManagementClientCheckSKUAvailabilityResult contains the result from method CognitiveServicesManagementClient.CheckSKUAvailability.

type CreatedByType 

type CreatedByType string

CreatedByType - The type of identity that created the resource. 

const (
	CreatedByTypeApplication     CreatedByType = "Application"
	CreatedByTypeKey             CreatedByType = "Key"
	CreatedByTypeManagedIdentity CreatedByType = "ManagedIdentity"
	CreatedByTypeUser            CreatedByType = "User"
)

func PossibleCreatedByTypeValues 

func PossibleCreatedByTypeValues() []CreatedByType

PossibleCreatedByTypeValues returns the possible values for the CreatedByType const type.

func (CreatedByType) ToPtr 

func (c CreatedByType) ToPtr() *CreatedByType

ToPtr returns a *CreatedByType pointing to the current value.

type DeletedAccountsBeginPurgeOptions 

type DeletedAccountsBeginPurgeOptions struct {
}

DeletedAccountsBeginPurgeOptions contains the optional parameters for the DeletedAccounts.BeginPurge method.

type DeletedAccountsClient 

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

DeletedAccountsClient contains the methods for the DeletedAccounts group. Don't use this type directly, use NewDeletedAccountsClient() instead.

func NewDeletedAccountsClient 

func NewDeletedAccountsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *DeletedAccountsClient

NewDeletedAccountsClient creates a new instance of DeletedAccountsClient with the specified values.

func (*DeletedAccountsClient) BeginPurge 

func (client *DeletedAccountsClient) BeginPurge(ctx context.Context, location string, resourceGroupName string, accountName string, options *DeletedAccountsBeginPurgeOptions) (DeletedAccountsPurgePollerResponse, error)

BeginPurge - Deletes a Cognitive Services account from the resource group. If the operation fails it returns the *ErrorResponse error type.

func (*DeletedAccountsClient) Get 

func (client *DeletedAccountsClient) Get(ctx context.Context, location string, resourceGroupName string, accountName string, options *DeletedAccountsGetOptions) (DeletedAccountsGetResponse, error)

Get - Returns a Cognitive Services account specified by the parameters. If the operation fails it returns the *ErrorResponse error type.

func (*DeletedAccountsClient) List 

func (client *DeletedAccountsClient) List(options *DeletedAccountsListOptions) *DeletedAccountsListPager

List - Returns all the resources of a particular type belonging to a subscription. If the operation fails it returns the *ErrorResponse error type.

type DeletedAccountsGetOptions 

type DeletedAccountsGetOptions struct {
}

DeletedAccountsGetOptions contains the optional parameters for the DeletedAccounts.Get method.

type DeletedAccountsGetResponse 

type DeletedAccountsGetResponse struct {
	DeletedAccountsGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeletedAccountsGetResponse contains the response from method DeletedAccounts.Get.

type DeletedAccountsGetResult 

type DeletedAccountsGetResult struct {
	Account
}

DeletedAccountsGetResult contains the result from method DeletedAccounts.Get.

type DeletedAccountsListOptions 

type DeletedAccountsListOptions struct {
}

DeletedAccountsListOptions contains the optional parameters for the DeletedAccounts.List method.

type DeletedAccountsListPager 

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

DeletedAccountsListPager provides operations for iterating over paged responses.

func (*DeletedAccountsListPager) Err 

func (p *DeletedAccountsListPager) Err() error

Err returns the last error encountered while paging.

func (*DeletedAccountsListPager) NextPage 

func (p *DeletedAccountsListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*DeletedAccountsListPager) PageResponse 

func (p *DeletedAccountsListPager) PageResponse() DeletedAccountsListResponse

PageResponse returns the current DeletedAccountsListResponse page.

type DeletedAccountsListResponse 

type DeletedAccountsListResponse struct {
	DeletedAccountsListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeletedAccountsListResponse contains the response from method DeletedAccounts.List.

type DeletedAccountsListResult 

type DeletedAccountsListResult struct {
	AccountListResult
}

DeletedAccountsListResult contains the result from method DeletedAccounts.List.

type DeletedAccountsPurgePoller 

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

DeletedAccountsPurgePoller provides polling facilities until the operation reaches a terminal state.

func (*DeletedAccountsPurgePoller) Done 

func (p *DeletedAccountsPurgePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*DeletedAccountsPurgePoller) FinalResponse 

func (p *DeletedAccountsPurgePoller) FinalResponse(ctx context.Context) (DeletedAccountsPurgeResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final DeletedAccountsPurgeResponse will be returned.

func (*DeletedAccountsPurgePoller) Poll 

func (p *DeletedAccountsPurgePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*DeletedAccountsPurgePoller) ResumeToken 

func (p *DeletedAccountsPurgePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type DeletedAccountsPurgePollerResponse 

type DeletedAccountsPurgePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *DeletedAccountsPurgePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeletedAccountsPurgePollerResponse contains the response from method DeletedAccounts.Purge.

func (DeletedAccountsPurgePollerResponse) PollUntilDone 

func (l DeletedAccountsPurgePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (DeletedAccountsPurgeResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*DeletedAccountsPurgePollerResponse) Resume 

func (l *DeletedAccountsPurgePollerResponse) Resume(ctx context.Context, client *DeletedAccountsClient, token string) error

Resume rehydrates a DeletedAccountsPurgePollerResponse from the provided client and resume token.

type DeletedAccountsPurgeResponse 

type DeletedAccountsPurgeResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

DeletedAccountsPurgeResponse contains the response from method DeletedAccounts.Purge.

type DomainAvailability 

type DomainAvailability struct {
	// Indicates the given SKU is available or not.
	IsSubdomainAvailable *bool `json:"isSubdomainAvailable,omitempty"`

	// Reason why the SKU is not available.
	Reason *string `json:"reason,omitempty"`

	// The subdomain name to use.
	SubdomainName *string `json:"subdomainName,omitempty"`

	// The Type of the resource.
	Type *string `json:"type,omitempty"`
}

DomainAvailability - Domain availability.

type Encryption 

type Encryption struct {
	// Enumerates the possible value of keySource for Encryption
	KeySource *KeySource `json:"keySource,omitempty"`

	// Properties of KeyVault
	KeyVaultProperties *KeyVaultProperties `json:"keyVaultProperties,omitempty"`
}

Encryption - Properties to configure Encryption

type ErrorAdditionalInfo 

type ErrorAdditionalInfo struct {
	// READ-ONLY; The additional info.
	Info map[string]interface{} `json:"info,omitempty" azure:"ro"`

	// READ-ONLY; The additional info type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ErrorAdditionalInfo - The resource management error additional info.

type ErrorDetail 

type ErrorDetail struct {
	// READ-ONLY; The error additional info.
	AdditionalInfo []*ErrorAdditionalInfo `json:"additionalInfo,omitempty" azure:"ro"`

	// READ-ONLY; The error code.
	Code *string `json:"code,omitempty" azure:"ro"`

	// READ-ONLY; The error details.
	Details []*ErrorDetail `json:"details,omitempty" azure:"ro"`

	// READ-ONLY; The error message.
	Message *string `json:"message,omitempty" azure:"ro"`

	// READ-ONLY; The error target.
	Target *string `json:"target,omitempty" azure:"ro"`
}

ErrorDetail - The error detail.

func (ErrorDetail) MarshalJSON 

func (e ErrorDetail) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ErrorDetail.

type ErrorResponse 

type ErrorResponse struct {

	// The error object.
	InnerError *ErrorDetail `json:"error,omitempty"`
	// contains filtered or unexported fields
}

ErrorResponse - Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). Implements the error and azcore.HTTPResponse interfaces.

func (ErrorResponse) Error 

func (e ErrorResponse) Error() string

Error implements the error interface for type ErrorResponse. The contents of the error text are not contractual and subject to change.

type IPRule 

type IPRule struct {
	// REQUIRED; 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 {
	// The identity type.
	Type *ResourceIdentityType `json:"type,omitempty"`

	// 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,omitempty"`

	// READ-ONLY; The principal ID of resource identity.
	PrincipalID *string `json:"principalId,omitempty" azure:"ro"`

	// READ-ONLY; The tenant ID of resource.
	TenantID *string `json:"tenantId,omitempty" azure:"ro"`
}

Identity for the resource.

func (Identity) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Identity.

type KeyName 

type KeyName string

KeyName - key name to generate (Key1|Key2) 

const (
	KeyNameKey1 KeyName = "Key1"
	KeyNameKey2 KeyName = "Key2"
)

func PossibleKeyNameValues 

func PossibleKeyNameValues() []KeyName

PossibleKeyNameValues returns the possible values for the KeyName const type.

func (KeyName) ToPtr 

func (c KeyName) ToPtr() *KeyName

ToPtr returns a *KeyName pointing to the current value.

type KeySource 

type KeySource string

KeySource - Enumerates the possible value of keySource for Encryption 

const (
	KeySourceMicrosoftCognitiveServices KeySource = "Microsoft.CognitiveServices"
	KeySourceMicrosoftKeyVault          KeySource = "Microsoft.KeyVault"
)

func PossibleKeySourceValues 

func PossibleKeySourceValues() []KeySource

PossibleKeySourceValues returns the possible values for the KeySource const type.

func (KeySource) ToPtr 

func (c KeySource) ToPtr() *KeySource

ToPtr returns a *KeySource pointing to the current value.

type KeyVaultProperties 

type KeyVaultProperties struct {
	IdentityClientID *string `json:"identityClientId,omitempty"`

	// Name of the Key from KeyVault
	KeyName *string `json:"keyName,omitempty"`

	// Uri of KeyVault
	KeyVaultURI *string `json:"keyVaultUri,omitempty"`

	// Version of the Key from KeyVault
	KeyVersion *string `json:"keyVersion,omitempty"`
}

KeyVaultProperties - Properties to configure keyVault Properties

type MetricName 

type MetricName struct {
	// The friendly name of the metric.
	LocalizedValue *string `json:"localizedValue,omitempty"`

	// The name of the metric.
	Value *string `json:"value,omitempty"`
}

MetricName - A metric name.

type NetworkRuleAction 

type NetworkRuleAction string

NetworkRuleAction - The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated. 

const (
	NetworkRuleActionAllow NetworkRuleAction = "Allow"
	NetworkRuleActionDeny  NetworkRuleAction = "Deny"
)

func PossibleNetworkRuleActionValues 

func PossibleNetworkRuleActionValues() []NetworkRuleAction

PossibleNetworkRuleActionValues returns the possible values for the NetworkRuleAction const type.

func (NetworkRuleAction) ToPtr 

func (c NetworkRuleAction) ToPtr() *NetworkRuleAction

ToPtr returns a *NetworkRuleAction pointing to the current value.

type NetworkRuleSet 

type NetworkRuleSet struct {
	// The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated.
	DefaultAction *NetworkRuleAction `json:"defaultAction,omitempty"`

	// The list of IP address rules.
	IPRules []*IPRule `json:"ipRules,omitempty"`

	// The list of virtual network rules.
	VirtualNetworkRules []*VirtualNetworkRule `json:"virtualNetworkRules,omitempty"`
}

NetworkRuleSet - A set of rules governing the network accessibility.

func (NetworkRuleSet) MarshalJSON 

func (n NetworkRuleSet) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NetworkRuleSet.

type Operation 

type Operation struct {
	// Localized display information for this particular operation.
	Display *OperationDisplay `json:"display,omitempty"`

	// READ-ONLY; Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
	ActionType *ActionType `json:"actionType,omitempty" azure:"ro"`

	// READ-ONLY; Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations.
	IsDataAction *bool `json:"isDataAction,omitempty" azure:"ro"`

	// READ-ONLY; The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action"
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
	Origin *Origin `json:"origin,omitempty" azure:"ro"`
}

Operation - Details of a REST API operation, returned from the Resource Provider Operations API

type OperationDisplay 

type OperationDisplay struct {
	// READ-ONLY; The short, localized friendly description of the operation; suitable for tool tips and detailed views.
	Description *string `json:"description,omitempty" azure:"ro"`

	// READ-ONLY; The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual
	// Machine".
	Operation *string `json:"operation,omitempty" azure:"ro"`

	// READ-ONLY; The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute".
	Provider *string `json:"provider,omitempty" azure:"ro"`

	// READ-ONLY; The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections".
	Resource *string `json:"resource,omitempty" azure:"ro"`
}

OperationDisplay - Localized display information for this particular operation.

type OperationListResult 

type OperationListResult struct {
	// READ-ONLY; URL to get the next set of operation list results (if there are any).
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; List of operations supported by the resource provider
	Value []*Operation `json:"value,omitempty" azure:"ro"`
}

OperationListResult - A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.

func (OperationListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type OperationListResult.

type OperationsClient 

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

OperationsClient contains the methods for the Operations group. Don't use this type directly, use NewOperationsClient() instead.

func NewOperationsClient 

func NewOperationsClient(credential azcore.TokenCredential, options *arm.ClientOptions) *OperationsClient

NewOperationsClient creates a new instance of OperationsClient with the specified values.

func (*OperationsClient) List 

func (client *OperationsClient) List(options *OperationsListOptions) *OperationsListPager

List - Lists all the available Cognitive Services account operations. If the operation fails it returns the *ErrorResponse error type.

type OperationsListOptions 

type OperationsListOptions struct {
}

OperationsListOptions contains the optional parameters for the Operations.List method.

type OperationsListPager 

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

OperationsListPager provides operations for iterating over paged responses.

func (*OperationsListPager) Err 

func (p *OperationsListPager) Err() error

Err returns the last error encountered while paging.

func (*OperationsListPager) NextPage 

func (p *OperationsListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*OperationsListPager) PageResponse 

func (p *OperationsListPager) PageResponse() OperationsListResponse

PageResponse returns the current OperationsListResponse page.

type OperationsListResponse 

type OperationsListResponse struct {
	OperationsListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

OperationsListResponse contains the response from method Operations.List.

type OperationsListResult 

type OperationsListResult struct {
	OperationListResult
}

OperationsListResult contains the result from method Operations.List.

type Origin 

type Origin string

Origin - The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" 

const (
	OriginSystem     Origin = "system"
	OriginUser       Origin = "user"
	OriginUserSystem Origin = "user,system"
)

func PossibleOriginValues 

func PossibleOriginValues() []Origin

PossibleOriginValues returns the possible values for the Origin const type.

func (Origin) ToPtr 

func (c Origin) ToPtr() *Origin

ToPtr returns a *Origin pointing to the current value.

type PrivateEndpoint 

type PrivateEndpoint struct {
	// READ-ONLY; The ARM identifier for Private Endpoint
	ID *string `json:"id,omitempty" azure:"ro"`
}

PrivateEndpoint - The Private Endpoint resource.

type PrivateEndpointConnection 

type PrivateEndpointConnection struct {
	AzureEntityResource
	// The location of the private endpoint connection
	Location *string `json:"location,omitempty"`

	// Resource properties.
	Properties *PrivateEndpointConnectionProperties `json:"properties,omitempty"`

	// READ-ONLY; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`
}

PrivateEndpointConnection - The Private Endpoint Connection resource.

func (PrivateEndpointConnection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnection.

type PrivateEndpointConnectionListResult 

type PrivateEndpointConnectionListResult struct {
	// Array of private endpoint connections
	Value []*PrivateEndpointConnection `json:"value,omitempty"`
}

PrivateEndpointConnectionListResult - A list of private endpoint connections

func (PrivateEndpointConnectionListResult) MarshalJSON 

func (p PrivateEndpointConnectionListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnectionListResult.

type PrivateEndpointConnectionProperties 

type PrivateEndpointConnectionProperties struct {
	// REQUIRED; A collection of information about the state of the connection between service consumer and provider.
	PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionState `json:"privateLinkServiceConnectionState,omitempty"`

	// The private link resource group ids.
	GroupIDs []*string `json:"groupIds,omitempty"`

	// The resource of private end point.
	PrivateEndpoint *PrivateEndpoint `json:"privateEndpoint,omitempty"`

	// READ-ONLY; The provisioning state of the private endpoint connection resource.
	ProvisioningState *PrivateEndpointConnectionProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

PrivateEndpointConnectionProperties - Properties of the PrivateEndpointConnectProperties.

func (PrivateEndpointConnectionProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnectionProperties.

type PrivateEndpointConnectionProvisioningState 

type PrivateEndpointConnectionProvisioningState string

PrivateEndpointConnectionProvisioningState - The current provisioning state. 

const (
	PrivateEndpointConnectionProvisioningStateCreating  PrivateEndpointConnectionProvisioningState = "Creating"
	PrivateEndpointConnectionProvisioningStateDeleting  PrivateEndpointConnectionProvisioningState = "Deleting"
	PrivateEndpointConnectionProvisioningStateFailed    PrivateEndpointConnectionProvisioningState = "Failed"
	PrivateEndpointConnectionProvisioningStateSucceeded PrivateEndpointConnectionProvisioningState = "Succeeded"
)

func PossiblePrivateEndpointConnectionProvisioningStateValues 

func PossiblePrivateEndpointConnectionProvisioningStateValues() []PrivateEndpointConnectionProvisioningState

PossiblePrivateEndpointConnectionProvisioningStateValues returns the possible values for the PrivateEndpointConnectionProvisioningState const type.

func (PrivateEndpointConnectionProvisioningState) ToPtr 

func (c PrivateEndpointConnectionProvisioningState) ToPtr() *PrivateEndpointConnectionProvisioningState

ToPtr returns a *PrivateEndpointConnectionProvisioningState pointing to the current value.

type PrivateEndpointConnectionsBeginCreateOrUpdateOptions 

type PrivateEndpointConnectionsBeginCreateOrUpdateOptions struct {
}

PrivateEndpointConnectionsBeginCreateOrUpdateOptions contains the optional parameters for the PrivateEndpointConnections.BeginCreateOrUpdate method.

type PrivateEndpointConnectionsBeginDeleteOptions 

type PrivateEndpointConnectionsBeginDeleteOptions struct {
}

PrivateEndpointConnectionsBeginDeleteOptions contains the optional parameters for the PrivateEndpointConnections.BeginDelete method.

type PrivateEndpointConnectionsClient 

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

PrivateEndpointConnectionsClient contains the methods for the PrivateEndpointConnections group. Don't use this type directly, use NewPrivateEndpointConnectionsClient() instead.

func NewPrivateEndpointConnectionsClient 

func NewPrivateEndpointConnectionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *PrivateEndpointConnectionsClient

NewPrivateEndpointConnectionsClient creates a new instance of PrivateEndpointConnectionsClient with the specified values.

func (*PrivateEndpointConnectionsClient) BeginCreateOrUpdate 

func (client *PrivateEndpointConnectionsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, accountName string, privateEndpointConnectionName string, properties PrivateEndpointConnection, options *PrivateEndpointConnectionsBeginCreateOrUpdateOptions) (PrivateEndpointConnectionsCreateOrUpdatePollerResponse, error)

BeginCreateOrUpdate - Update the state of specified private endpoint connection associated with the Cognitive Services account. If the operation fails it returns the *ErrorResponse error type.

func (*PrivateEndpointConnectionsClient) BeginDelete 

func (client *PrivateEndpointConnectionsClient) BeginDelete(ctx context.Context, resourceGroupName string, accountName string, privateEndpointConnectionName string, options *PrivateEndpointConnectionsBeginDeleteOptions) (PrivateEndpointConnectionsDeletePollerResponse, error)

BeginDelete - Deletes the specified private endpoint connection associated with the Cognitive Services account. If the operation fails it returns the *ErrorResponse error type.

func (*PrivateEndpointConnectionsClient) Get 

func (client *PrivateEndpointConnectionsClient) Get(ctx context.Context, resourceGroupName string, accountName string, privateEndpointConnectionName string, options *PrivateEndpointConnectionsGetOptions) (PrivateEndpointConnectionsGetResponse, error)

Get - Gets the specified private endpoint connection associated with the Cognitive Services account. If the operation fails it returns the *ErrorResponse error type.

func (*PrivateEndpointConnectionsClient) List 

func (client *PrivateEndpointConnectionsClient) List(ctx context.Context, resourceGroupName string, accountName string, options *PrivateEndpointConnectionsListOptions) (PrivateEndpointConnectionsListResponse, error)

List - Gets the private endpoint connections associated with the Cognitive Services account. If the operation fails it returns the *ErrorResponse error type.

type PrivateEndpointConnectionsCreateOrUpdatePoller 

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

PrivateEndpointConnectionsCreateOrUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*PrivateEndpointConnectionsCreateOrUpdatePoller) Done 

func (p *PrivateEndpointConnectionsCreateOrUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*PrivateEndpointConnectionsCreateOrUpdatePoller) FinalResponse 

func (p *PrivateEndpointConnectionsCreateOrUpdatePoller) FinalResponse(ctx context.Context) (PrivateEndpointConnectionsCreateOrUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final PrivateEndpointConnectionsCreateOrUpdateResponse will be returned.

func (*PrivateEndpointConnectionsCreateOrUpdatePoller) Poll 

func (p *PrivateEndpointConnectionsCreateOrUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*PrivateEndpointConnectionsCreateOrUpdatePoller) ResumeToken 

func (p *PrivateEndpointConnectionsCreateOrUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type PrivateEndpointConnectionsCreateOrUpdatePollerResponse 

type PrivateEndpointConnectionsCreateOrUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *PrivateEndpointConnectionsCreateOrUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateEndpointConnectionsCreateOrUpdatePollerResponse contains the response from method PrivateEndpointConnections.CreateOrUpdate.

func (PrivateEndpointConnectionsCreateOrUpdatePollerResponse) PollUntilDone 

func (l PrivateEndpointConnectionsCreateOrUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (PrivateEndpointConnectionsCreateOrUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*PrivateEndpointConnectionsCreateOrUpdatePollerResponse) Resume 

func (l *PrivateEndpointConnectionsCreateOrUpdatePollerResponse) Resume(ctx context.Context, client *PrivateEndpointConnectionsClient, token string) error

Resume rehydrates a PrivateEndpointConnectionsCreateOrUpdatePollerResponse from the provided client and resume token.

type PrivateEndpointConnectionsCreateOrUpdateResponse 

type PrivateEndpointConnectionsCreateOrUpdateResponse struct {
	PrivateEndpointConnectionsCreateOrUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateEndpointConnectionsCreateOrUpdateResponse contains the response from method PrivateEndpointConnections.CreateOrUpdate.

type PrivateEndpointConnectionsCreateOrUpdateResult 

type PrivateEndpointConnectionsCreateOrUpdateResult struct {
	PrivateEndpointConnection
}

PrivateEndpointConnectionsCreateOrUpdateResult contains the result from method PrivateEndpointConnections.CreateOrUpdate.

type PrivateEndpointConnectionsDeletePoller 

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

PrivateEndpointConnectionsDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*PrivateEndpointConnectionsDeletePoller) Done 

func (p *PrivateEndpointConnectionsDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*PrivateEndpointConnectionsDeletePoller) FinalResponse 

func (p *PrivateEndpointConnectionsDeletePoller) FinalResponse(ctx context.Context) (PrivateEndpointConnectionsDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final PrivateEndpointConnectionsDeleteResponse will be returned.

func (*PrivateEndpointConnectionsDeletePoller) Poll 

func (p *PrivateEndpointConnectionsDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*PrivateEndpointConnectionsDeletePoller) ResumeToken 

func (p *PrivateEndpointConnectionsDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type PrivateEndpointConnectionsDeletePollerResponse 

type PrivateEndpointConnectionsDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *PrivateEndpointConnectionsDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateEndpointConnectionsDeletePollerResponse contains the response from method PrivateEndpointConnections.Delete.

func (PrivateEndpointConnectionsDeletePollerResponse) PollUntilDone 

func (l PrivateEndpointConnectionsDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (PrivateEndpointConnectionsDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*PrivateEndpointConnectionsDeletePollerResponse) Resume 

func (l *PrivateEndpointConnectionsDeletePollerResponse) Resume(ctx context.Context, client *PrivateEndpointConnectionsClient, token string) error

Resume rehydrates a PrivateEndpointConnectionsDeletePollerResponse from the provided client and resume token.

type PrivateEndpointConnectionsDeleteResponse 

type PrivateEndpointConnectionsDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateEndpointConnectionsDeleteResponse contains the response from method PrivateEndpointConnections.Delete.

type PrivateEndpointConnectionsGetOptions 

type PrivateEndpointConnectionsGetOptions struct {
}

PrivateEndpointConnectionsGetOptions contains the optional parameters for the PrivateEndpointConnections.Get method.

type PrivateEndpointConnectionsGetResponse 

type PrivateEndpointConnectionsGetResponse struct {
	PrivateEndpointConnectionsGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateEndpointConnectionsGetResponse contains the response from method PrivateEndpointConnections.Get.

type PrivateEndpointConnectionsGetResult 

type PrivateEndpointConnectionsGetResult struct {
	PrivateEndpointConnection
}

PrivateEndpointConnectionsGetResult contains the result from method PrivateEndpointConnections.Get.

type PrivateEndpointConnectionsListOptions 

type PrivateEndpointConnectionsListOptions struct {
}

PrivateEndpointConnectionsListOptions contains the optional parameters for the PrivateEndpointConnections.List method.

type PrivateEndpointConnectionsListResponse 

type PrivateEndpointConnectionsListResponse struct {
	PrivateEndpointConnectionsListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateEndpointConnectionsListResponse contains the response from method PrivateEndpointConnections.List.

type PrivateEndpointConnectionsListResult 

type PrivateEndpointConnectionsListResult struct {
	PrivateEndpointConnectionListResult
}

PrivateEndpointConnectionsListResult contains the result from method PrivateEndpointConnections.List.

type PrivateEndpointServiceConnectionStatus 

type PrivateEndpointServiceConnectionStatus string

PrivateEndpointServiceConnectionStatus - The private endpoint connection status. 

const (
	PrivateEndpointServiceConnectionStatusApproved PrivateEndpointServiceConnectionStatus = "Approved"
	PrivateEndpointServiceConnectionStatusPending  PrivateEndpointServiceConnectionStatus = "Pending"
	PrivateEndpointServiceConnectionStatusRejected PrivateEndpointServiceConnectionStatus = "Rejected"
)

func PossiblePrivateEndpointServiceConnectionStatusValues 

func PossiblePrivateEndpointServiceConnectionStatusValues() []PrivateEndpointServiceConnectionStatus

PossiblePrivateEndpointServiceConnectionStatusValues returns the possible values for the PrivateEndpointServiceConnectionStatus const type.

func (PrivateEndpointServiceConnectionStatus) ToPtr 

func (c PrivateEndpointServiceConnectionStatus) ToPtr() *PrivateEndpointServiceConnectionStatus

ToPtr returns a *PrivateEndpointServiceConnectionStatus pointing to the current value.

type PrivateLinkResource 

type PrivateLinkResource struct {
	Resource
	// Resource properties.
	Properties *PrivateLinkResourceProperties `json:"properties,omitempty"`
}

PrivateLinkResource - A private link resource

func (PrivateLinkResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResource.

type PrivateLinkResourceListResult 

type PrivateLinkResourceListResult struct {
	// Array of private link resources
	Value []*PrivateLinkResource `json:"value,omitempty"`
}

PrivateLinkResourceListResult - A list of private link resources

func (PrivateLinkResourceListResult) MarshalJSON 

func (p PrivateLinkResourceListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResourceListResult.

type PrivateLinkResourceProperties 

type PrivateLinkResourceProperties struct {
	// The private link resource Private link DNS zone name.
	RequiredZoneNames []*string `json:"requiredZoneNames,omitempty"`

	// READ-ONLY; The private link resource display name.
	DisplayName *string `json:"displayName,omitempty" azure:"ro"`

	// READ-ONLY; The private link resource group id.
	GroupID *string `json:"groupId,omitempty" azure:"ro"`

	// READ-ONLY; The private link resource required member names.
	RequiredMembers []*string `json:"requiredMembers,omitempty" azure:"ro"`
}

PrivateLinkResourceProperties - Properties of a private link resource.

func (PrivateLinkResourceProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResourceProperties.

type PrivateLinkResourcesClient 

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

PrivateLinkResourcesClient contains the methods for the PrivateLinkResources group. Don't use this type directly, use NewPrivateLinkResourcesClient() instead.

func NewPrivateLinkResourcesClient 

func NewPrivateLinkResourcesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *PrivateLinkResourcesClient

NewPrivateLinkResourcesClient creates a new instance of PrivateLinkResourcesClient with the specified values.

func (*PrivateLinkResourcesClient) List 

func (client *PrivateLinkResourcesClient) List(ctx context.Context, resourceGroupName string, accountName string, options *PrivateLinkResourcesListOptions) (PrivateLinkResourcesListResponse, error)

List - Gets the private link resources that need to be created for a Cognitive Services account. If the operation fails it returns the *ErrorResponse error type.

type PrivateLinkResourcesListOptions 

type PrivateLinkResourcesListOptions struct {
}

PrivateLinkResourcesListOptions contains the optional parameters for the PrivateLinkResources.List method.

type PrivateLinkResourcesListResponse 

type PrivateLinkResourcesListResponse struct {
	PrivateLinkResourcesListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateLinkResourcesListResponse contains the response from method PrivateLinkResources.List.

type PrivateLinkResourcesListResult 

type PrivateLinkResourcesListResult struct {
	PrivateLinkResourceListResult
}

PrivateLinkResourcesListResult contains the result from method PrivateLinkResources.List.

type PrivateLinkServiceConnectionState 

type PrivateLinkServiceConnectionState struct {
	// A message indicating if changes on the service provider require any updates on the consumer.
	ActionsRequired *string `json:"actionsRequired,omitempty"`

	// The reason for approval/rejection of the connection.
	Description *string `json:"description,omitempty"`

	// Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
	Status *PrivateEndpointServiceConnectionStatus `json:"status,omitempty"`
}

PrivateLinkServiceConnectionState - A collection of information about the state of the connection between service consumer and provider.

type ProvisioningState 

type ProvisioningState string

ProvisioningState - Gets the status of the cognitive services account at the time the operation was called. 

const (
	ProvisioningStateAccepted     ProvisioningState = "Accepted"
	ProvisioningStateCreating     ProvisioningState = "Creating"
	ProvisioningStateDeleting     ProvisioningState = "Deleting"
	ProvisioningStateFailed       ProvisioningState = "Failed"
	ProvisioningStateMoving       ProvisioningState = "Moving"
	ProvisioningStateResolvingDNS ProvisioningState = "ResolvingDNS"
	ProvisioningStateSucceeded    ProvisioningState = "Succeeded"
)

func PossibleProvisioningStateValues 

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns the possible values for the ProvisioningState const type.

func (ProvisioningState) ToPtr 

func (c ProvisioningState) ToPtr() *ProvisioningState

ToPtr returns a *ProvisioningState pointing to the current value.

type PublicNetworkAccess 

type PublicNetworkAccess string

PublicNetworkAccess - Whether or not public endpoint access is allowed for this account. Value is optional but if passed in, must be 'Enabled' or 'Disabled' 

const (
	PublicNetworkAccessDisabled PublicNetworkAccess = "Disabled"
	PublicNetworkAccessEnabled  PublicNetworkAccess = "Enabled"
)

func PossiblePublicNetworkAccessValues 

func PossiblePublicNetworkAccessValues() []PublicNetworkAccess

PossiblePublicNetworkAccessValues returns the possible values for the PublicNetworkAccess const type.

func (PublicNetworkAccess) ToPtr 

func (c PublicNetworkAccess) ToPtr() *PublicNetworkAccess

ToPtr returns a *PublicNetworkAccess pointing to the current value.

type QuotaLimit 

type QuotaLimit struct {
	Count         *float32          `json:"count,omitempty"`
	RenewalPeriod *float32          `json:"renewalPeriod,omitempty"`
	Rules         []*ThrottlingRule `json:"rules,omitempty"`
}

func (QuotaLimit) MarshalJSON 

func (q QuotaLimit) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type QuotaLimit.

type QuotaUsageStatus 

type QuotaUsageStatus string

QuotaUsageStatus - Cognitive Services account quota usage status. 

const (
	QuotaUsageStatusBlocked   QuotaUsageStatus = "Blocked"
	QuotaUsageStatusInOverage QuotaUsageStatus = "InOverage"
	QuotaUsageStatusIncluded  QuotaUsageStatus = "Included"
	QuotaUsageStatusUnknown   QuotaUsageStatus = "Unknown"
)

func PossibleQuotaUsageStatusValues 

func PossibleQuotaUsageStatusValues() []QuotaUsageStatus

PossibleQuotaUsageStatusValues returns the possible values for the QuotaUsageStatus const type.

func (QuotaUsageStatus) ToPtr 

func (c QuotaUsageStatus) ToPtr() *QuotaUsageStatus

ToPtr returns a *QuotaUsageStatus pointing to the current value.

type RegenerateKeyParameters 

type RegenerateKeyParameters struct {
	// REQUIRED; key name to generate (Key1|Key2)
	KeyName *KeyName `json:"keyName,omitempty"`
}

RegenerateKeyParameters - Regenerate key parameters.

type RequestMatchPattern 

type RequestMatchPattern struct {
	Method *string `json:"method,omitempty"`
	Path   *string `json:"path,omitempty"`
}

type Resource 

type Resource struct {
	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

Resource - Common fields that are returned in the response for all Azure Resource Manager resources

func (Resource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Resource.

type ResourceIdentityType 

type ResourceIdentityType string

ResourceIdentityType - The identity type. 

const (
	ResourceIdentityTypeNone                       ResourceIdentityType = "None"
	ResourceIdentityTypeSystemAssigned             ResourceIdentityType = "SystemAssigned"
	ResourceIdentityTypeUserAssigned               ResourceIdentityType = "UserAssigned"
	ResourceIdentityTypeSystemAssignedUserAssigned ResourceIdentityType = "SystemAssigned, UserAssigned"
)

func PossibleResourceIdentityTypeValues 

func PossibleResourceIdentityTypeValues() []ResourceIdentityType

PossibleResourceIdentityTypeValues returns the possible values for the ResourceIdentityType const type.

func (ResourceIdentityType) ToPtr 

func (c ResourceIdentityType) ToPtr() *ResourceIdentityType

ToPtr returns a *ResourceIdentityType pointing to the current value.

type ResourceSKU 

type ResourceSKU struct {
	// The Kind of resources that are supported in this SKU.
	Kind *string `json:"kind,omitempty"`

	// The set of locations that the SKU is available.
	Locations []*string `json:"locations,omitempty"`

	// The name of SKU.
	Name *string `json:"name,omitempty"`

	// The type of resource the SKU applies to.
	ResourceType *string `json:"resourceType,omitempty"`

	// The restrictions because of which SKU cannot be used. This is empty if there are no restrictions.
	Restrictions []*ResourceSKURestrictions `json:"restrictions,omitempty"`

	// Specifies the tier of Cognitive Services account.
	Tier *string `json:"tier,omitempty"`
}

ResourceSKU - Describes an available Cognitive Services SKU.

func (ResourceSKU) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ResourceSKU.

type ResourceSKUListResult 

type ResourceSKUListResult struct {
	// REQUIRED; The list of skus available for the subscription.
	Value []*ResourceSKU `json:"value,omitempty"`

	// The uri to fetch the next page of Skus.
	NextLink *string `json:"nextLink,omitempty"`
}

ResourceSKUListResult - The Get Skus operation response.

func (ResourceSKUListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ResourceSKUListResult.

type ResourceSKURestrictionInfo 

type ResourceSKURestrictionInfo struct {
	// Locations where the SKU is restricted
	Locations []*string `json:"locations,omitempty"`

	// List of availability zones where the SKU is restricted.
	Zones []*string `json:"zones,omitempty"`
}

func (ResourceSKURestrictionInfo) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ResourceSKURestrictionInfo.

type ResourceSKURestrictions 

type ResourceSKURestrictions struct {
	// The reason for restriction.
	ReasonCode *ResourceSKURestrictionsReasonCode `json:"reasonCode,omitempty"`

	// The information about the restriction where the SKU cannot be used.
	RestrictionInfo *ResourceSKURestrictionInfo `json:"restrictionInfo,omitempty"`

	// The type of restrictions.
	Type *ResourceSKURestrictionsType `json:"type,omitempty"`

	// 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"`
}

ResourceSKURestrictions - Describes restrictions of a SKU.

func (ResourceSKURestrictions) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ResourceSKURestrictions.

type ResourceSKURestrictionsReasonCode 

type ResourceSKURestrictionsReasonCode string

ResourceSKURestrictionsReasonCode - The reason for restriction. 

const (
	ResourceSKURestrictionsReasonCodeNotAvailableForSubscription ResourceSKURestrictionsReasonCode = "NotAvailableForSubscription"
	ResourceSKURestrictionsReasonCodeQuotaID                     ResourceSKURestrictionsReasonCode = "QuotaId"
)

func PossibleResourceSKURestrictionsReasonCodeValues 

func PossibleResourceSKURestrictionsReasonCodeValues() []ResourceSKURestrictionsReasonCode

PossibleResourceSKURestrictionsReasonCodeValues returns the possible values for the ResourceSKURestrictionsReasonCode const type.

func (ResourceSKURestrictionsReasonCode) ToPtr 

func (c ResourceSKURestrictionsReasonCode) ToPtr() *ResourceSKURestrictionsReasonCode

ToPtr returns a *ResourceSKURestrictionsReasonCode pointing to the current value.

type ResourceSKURestrictionsType 

type ResourceSKURestrictionsType string

ResourceSKURestrictionsType - The type of restrictions. 

const (
	ResourceSKURestrictionsTypeLocation ResourceSKURestrictionsType = "Location"
	ResourceSKURestrictionsTypeZone     ResourceSKURestrictionsType = "Zone"
)

func PossibleResourceSKURestrictionsTypeValues 

func PossibleResourceSKURestrictionsTypeValues() []ResourceSKURestrictionsType

PossibleResourceSKURestrictionsTypeValues returns the possible values for the ResourceSKURestrictionsType const type.

func (ResourceSKURestrictionsType) ToPtr 

func (c ResourceSKURestrictionsType) ToPtr() *ResourceSKURestrictionsType

ToPtr returns a *ResourceSKURestrictionsType pointing to the current value.

type ResourceSKUsClient 

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

ResourceSKUsClient contains the methods for the ResourceSKUs group. Don't use this type directly, use NewResourceSKUsClient() instead.

func NewResourceSKUsClient 

func NewResourceSKUsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ResourceSKUsClient

NewResourceSKUsClient creates a new instance of ResourceSKUsClient with the specified values.

func (*ResourceSKUsClient) List 

func (client *ResourceSKUsClient) List(options *ResourceSKUsListOptions) *ResourceSKUsListPager

List - Gets the list of Microsoft.CognitiveServices SKUs available for your Subscription. If the operation fails it returns the *ErrorResponse error type.

type ResourceSKUsListOptions 

type ResourceSKUsListOptions struct {
}

ResourceSKUsListOptions contains the optional parameters for the ResourceSKUs.List method.

type ResourceSKUsListPager 

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

ResourceSKUsListPager provides operations for iterating over paged responses.

func (*ResourceSKUsListPager) Err 

func (p *ResourceSKUsListPager) Err() error

Err returns the last error encountered while paging.

func (*ResourceSKUsListPager) NextPage 

func (p *ResourceSKUsListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*ResourceSKUsListPager) PageResponse 

func (p *ResourceSKUsListPager) PageResponse() ResourceSKUsListResponse

PageResponse returns the current ResourceSKUsListResponse page.

type ResourceSKUsListResponse 

type ResourceSKUsListResponse struct {
	ResourceSKUsListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ResourceSKUsListResponse contains the response from method ResourceSKUs.List.

type ResourceSKUsListResult 

type ResourceSKUsListResult struct {
	ResourceSKUListResult
}

ResourceSKUsListResult contains the result from method ResourceSKUs.List.

type SKU 

type SKU struct {
	// REQUIRED; The name of the SKU. Ex - P3. It is typically a letter+number code
	Name *string `json:"name,omitempty"`

	// If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
	Capacity *int32 `json:"capacity,omitempty"`

	// If the service has different generations of hardware, for the same SKU, then that can be captured here.
	Family *string `json:"family,omitempty"`

	// The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
	Size *string `json:"size,omitempty"`

	// This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
	Tier *SKUTier `json:"tier,omitempty"`
}

SKU - The resource model definition representing SKU

type SKUAvailability 

type SKUAvailability struct {
	// The Kind of the resource.
	Kind *string `json:"kind,omitempty"`

	// Additional error message.
	Message *string `json:"message,omitempty"`

	// Reason why the SKU is not available.
	Reason *string `json:"reason,omitempty"`

	// Indicates the given SKU is available or not.
	SKUAvailable *bool `json:"skuAvailable,omitempty"`

	// The SKU of Cognitive Services account.
	SKUName *string `json:"skuName,omitempty"`

	// The Type of the resource.
	Type *string `json:"type,omitempty"`
}

SKUAvailability - SKU availability.

type SKUAvailabilityListResult 

type SKUAvailabilityListResult struct {
	// Check SKU availability result list.
	Value []*SKUAvailability `json:"value,omitempty"`
}

SKUAvailabilityListResult - Check SKU availability result list.

func (SKUAvailabilityListResult) MarshalJSON 

func (s SKUAvailabilityListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SKUAvailabilityListResult.

type SKUCapability 

type SKUCapability struct {
	// The name of the SkuCapability.
	Name *string `json:"name,omitempty"`

	// The value of the SkuCapability.
	Value *string `json:"value,omitempty"`
}

SKUCapability - SkuCapability indicates the capability of a certain feature.

type SKUChangeInfo 

type SKUChangeInfo struct {
	// Gets the count of downgrades.
	CountOfDowngrades *float32 `json:"countOfDowngrades,omitempty"`

	// Gets the count of upgrades after downgrades.
	CountOfUpgradesAfterDowngrades *float32 `json:"countOfUpgradesAfterDowngrades,omitempty"`

	// Gets the last change date.
	LastChangeDate *string `json:"lastChangeDate,omitempty"`
}

SKUChangeInfo - Sku change info of account.

type SKUTier 

type SKUTier string

SKUTier - This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. 

const (
	SKUTierBasic      SKUTier = "Basic"
	SKUTierEnterprise SKUTier = "Enterprise"
	SKUTierFree       SKUTier = "Free"
	SKUTierPremium    SKUTier = "Premium"
	SKUTierStandard   SKUTier = "Standard"
)

func PossibleSKUTierValues 

func PossibleSKUTierValues() []SKUTier

PossibleSKUTierValues returns the possible values for the SKUTier const type.

func (SKUTier) ToPtr 

func (c SKUTier) ToPtr() *SKUTier

ToPtr returns a *SKUTier pointing to the current value.

type SystemData 

type SystemData struct {
	// The timestamp of resource creation (UTC).
	CreatedAt *time.Time `json:"createdAt,omitempty"`

	// The identity that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// The type of identity that created the resource.
	CreatedByType *CreatedByType `json:"createdByType,omitempty"`

	// The timestamp of resource last modification (UTC)
	LastModifiedAt *time.Time `json:"lastModifiedAt,omitempty"`

	// The identity that last modified the resource.
	LastModifiedBy *string `json:"lastModifiedBy,omitempty"`

	// The type of identity that last modified the resource.
	LastModifiedByType *CreatedByType `json:"lastModifiedByType,omitempty"`
}

SystemData - Metadata pertaining to creation and last modification of the resource.

func (SystemData) MarshalJSON 

func (s SystemData) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SystemData.

func (*SystemData) UnmarshalJSON 

func (s *SystemData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SystemData.

type ThrottlingRule 

type ThrottlingRule struct {
	Count                    *float32               `json:"count,omitempty"`
	DynamicThrottlingEnabled *bool                  `json:"dynamicThrottlingEnabled,omitempty"`
	Key                      *string                `json:"key,omitempty"`
	MatchPatterns            []*RequestMatchPattern `json:"matchPatterns,omitempty"`
	MinCount                 *float32               `json:"minCount,omitempty"`
	RenewalPeriod            *float32               `json:"renewalPeriod,omitempty"`
}

func (ThrottlingRule) MarshalJSON 

func (t ThrottlingRule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ThrottlingRule.

type UnitType 

type UnitType string

UnitType - The unit of the metric. 

const (
	UnitTypeBytes          UnitType = "Bytes"
	UnitTypeBytesPerSecond UnitType = "BytesPerSecond"
	UnitTypeCount          UnitType = "Count"
	UnitTypeCountPerSecond UnitType = "CountPerSecond"
	UnitTypeMilliseconds   UnitType = "Milliseconds"
	UnitTypePercent        UnitType = "Percent"
	UnitTypeSeconds        UnitType = "Seconds"
)

func PossibleUnitTypeValues 

func PossibleUnitTypeValues() []UnitType

PossibleUnitTypeValues returns the possible values for the UnitType const type.

func (UnitType) ToPtr 

func (c UnitType) ToPtr() *UnitType

ToPtr returns a *UnitType pointing to the current value.

type Usage 

type Usage struct {
	// Current value for this metric.
	CurrentValue *float64 `json:"currentValue,omitempty"`

	// Maximum value for this metric.
	Limit *float64 `json:"limit,omitempty"`

	// The name information for the metric.
	Name *MetricName `json:"name,omitempty"`

	// Next reset time for current quota.
	NextResetTime *string `json:"nextResetTime,omitempty"`

	// The quota period used to summarize the usage values.
	QuotaPeriod *string `json:"quotaPeriod,omitempty"`

	// Cognitive Services account quota usage status.
	Status *QuotaUsageStatus `json:"status,omitempty"`

	// The unit of the metric.
	Unit *UnitType `json:"unit,omitempty"`
}

Usage - The usage data for a usage request.

type UsageListResult 

type UsageListResult struct {
	// The list of usages for Cognitive Service account.
	Value []*Usage `json:"value,omitempty"`
}

UsageListResult - The response to a list usage request.

func (UsageListResult) MarshalJSON 

func (u UsageListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UsageListResult.

type UserAssignedIdentity 

type UserAssignedIdentity struct {
	// READ-ONLY; Client App Id associated with this identity.
	ClientID *string `json:"clientId,omitempty" azure:"ro"`

	// READ-ONLY; Azure Active Directory principal ID associated with this Identity.
	PrincipalID *string `json:"principalId,omitempty" azure:"ro"`
}

UserAssignedIdentity - User-assigned managed identity.

type UserOwnedStorage 

type UserOwnedStorage struct {
	IdentityClientID *string `json:"identityClientId,omitempty"`

	// 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 {
	// REQUIRED; 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"`

	// Ignore missing vnet service endpoint or not.
	IgnoreMissingVnetServiceEndpoint *bool `json:"ignoreMissingVnetServiceEndpoint,omitempty"`

	// Gets the state of virtual network rule.
	State *string `json:"state,omitempty"`
}

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.