cognitiveservicesaccounts

package
v0.20230508.1101604 Latest Latest
Warning

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

 Go to latest Published: May 8, 2023 License: MPL-2.0 Imports: 15 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/cognitive/2021-04-30/cognitiveservicesaccounts Documentation

The cognitiveservicesaccounts SDK allows for interaction with the Azure Resource Manager Service cognitive (API Version 2021-04-30).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-sdk/resource-manager/cognitive/2021-04-30/cognitiveservicesaccounts"

Client Initialization

client := cognitiveservicesaccounts.NewCognitiveServicesAccountsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: CognitiveServicesAccountsClient.AccountsCreate

ctx := context.TODO()
id := cognitiveservicesaccounts.NewAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue")

payload := cognitiveservicesaccounts.Account{
	// ...
}


if err := client.AccountsCreateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: CognitiveServicesAccountsClient.AccountsDelete

ctx := context.TODO()
id := cognitiveservicesaccounts.NewAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue")

if err := client.AccountsDeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: CognitiveServicesAccountsClient.AccountsGet

ctx := context.TODO()
id := cognitiveservicesaccounts.NewAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue")

read, err := client.AccountsGet(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: CognitiveServicesAccountsClient.AccountsList

ctx := context.TODO()
id := cognitiveservicesaccounts.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

// alternatively `client.AccountsList(ctx, id)` can be used to do batched pagination
items, err := client.AccountsListComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: CognitiveServicesAccountsClient.AccountsListByResourceGroup

ctx := context.TODO()
id := cognitiveservicesaccounts.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group")

// alternatively `client.AccountsListByResourceGroup(ctx, id)` can be used to do batched pagination
items, err := client.AccountsListByResourceGroupComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: CognitiveServicesAccountsClient.AccountsListKeys

ctx := context.TODO()
id := cognitiveservicesaccounts.NewAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue")

read, err := client.AccountsListKeys(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: CognitiveServicesAccountsClient.AccountsListSkus

ctx := context.TODO()
id := cognitiveservicesaccounts.NewAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue")

read, err := client.AccountsListSkus(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: CognitiveServicesAccountsClient.AccountsListUsages

ctx := context.TODO()
id := cognitiveservicesaccounts.NewAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue")

read, err := client.AccountsListUsages(ctx, id, cognitiveservicesaccounts.DefaultAccountsListUsagesOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: CognitiveServicesAccountsClient.AccountsRegenerateKey

ctx := context.TODO()
id := cognitiveservicesaccounts.NewAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue")

payload := cognitiveservicesaccounts.RegenerateKeyParameters{
	// ...
}


read, err := client.AccountsRegenerateKey(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: CognitiveServicesAccountsClient.AccountsUpdate

ctx := context.TODO()
id := cognitiveservicesaccounts.NewAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountValue")

payload := cognitiveservicesaccounts.Account{
	// ...
}


if err := client.AccountsUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: CognitiveServicesAccountsClient.CheckDomainAvailability

ctx := context.TODO()
id := cognitiveservicesaccounts.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

payload := cognitiveservicesaccounts.CheckDomainAvailabilityParameter{
	// ...
}


read, err := client.CheckDomainAvailability(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: CognitiveServicesAccountsClient.CheckSkuAvailability

ctx := context.TODO()
id := cognitiveservicesaccounts.NewLocationID("12345678-1234-9876-4563-123456789012", "locationValue")

payload := cognitiveservicesaccounts.CheckSkuAvailabilityParameter{
	// ...
}


read, err := client.CheckSkuAvailability(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: CognitiveServicesAccountsClient.DeletedAccountsGet

ctx := context.TODO()
id := cognitiveservicesaccounts.NewDeletedAccountID("12345678-1234-9876-4563-123456789012", "locationValue", "example-resource-group", "deletedAccountValue")

read, err := client.DeletedAccountsGet(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: CognitiveServicesAccountsClient.DeletedAccountsList

ctx := context.TODO()
id := cognitiveservicesaccounts.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

// alternatively `client.DeletedAccountsList(ctx, id)` can be used to do batched pagination
items, err := client.DeletedAccountsListComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: CognitiveServicesAccountsClient.DeletedAccountsPurge

ctx := context.TODO()
id := cognitiveservicesaccounts.NewDeletedAccountID("12345678-1234-9876-4563-123456789012", "locationValue", "example-resource-group", "deletedAccountValue")

if err := client.DeletedAccountsPurgeThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: CognitiveServicesAccountsClient.ResourceSkusList

ctx := context.TODO()
id := cognitiveservicesaccounts.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

// alternatively `client.ResourceSkusList(ctx, id)` can be used to do batched pagination
items, err := client.ResourceSkusListComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForKeyName 

func PossibleValuesForKeyName() []string

func PossibleValuesForKeySource 

func PossibleValuesForKeySource() []string

func PossibleValuesForNetworkRuleAction 

func PossibleValuesForNetworkRuleAction() []string

func PossibleValuesForPrivateEndpointConnectionProvisioningState 

func PossibleValuesForPrivateEndpointConnectionProvisioningState() []string

func PossibleValuesForPrivateEndpointServiceConnectionStatus 

func PossibleValuesForPrivateEndpointServiceConnectionStatus() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func PossibleValuesForPublicNetworkAccess 

func PossibleValuesForPublicNetworkAccess() []string

func PossibleValuesForQuotaUsageStatus 

func PossibleValuesForQuotaUsageStatus() []string

func PossibleValuesForResourceSkuRestrictionsReasonCode 

func PossibleValuesForResourceSkuRestrictionsReasonCode() []string

func PossibleValuesForResourceSkuRestrictionsType 

func PossibleValuesForResourceSkuRestrictionsType() []string

func PossibleValuesForSkuTier 

func PossibleValuesForSkuTier() []string

func PossibleValuesForUnitType 

func PossibleValuesForUnitType() []string

func ValidateAccountID 

func ValidateAccountID(input interface{}, key string) (warnings []string, errors []error)

ValidateAccountID checks that 'input' can be parsed as a Account ID

func ValidateDeletedAccountID 

func ValidateDeletedAccountID(input interface{}, key string) (warnings []string, errors []error)

ValidateDeletedAccountID checks that 'input' can be parsed as a Deleted Account ID

func ValidateLocationID 

func ValidateLocationID(input interface{}, key string) (warnings []string, errors []error)

ValidateLocationID checks that 'input' can be parsed as a Location ID

Types

type Account 

type Account struct {
	Etag       *string                            `json:"etag,omitempty"`
	Id         *string                            `json:"id,omitempty"`
	Identity   *identity.SystemAndUserAssignedMap `json:"identity,omitempty"`
	Kind       *string                            `json:"kind,omitempty"`
	Location   *string                            `json:"location,omitempty"`
	Name       *string                            `json:"name,omitempty"`
	Properties *AccountProperties                 `json:"properties,omitempty"`
	Sku        *Sku                               `json:"sku,omitempty"`
	SystemData *systemdata.SystemData             `json:"systemData,omitempty"`
	Tags       *map[string]string                 `json:"tags,omitempty"`
	Type       *string                            `json:"type,omitempty"`
}

type AccountId 

type AccountId struct {
	SubscriptionId    string
	ResourceGroupName string
	AccountName       string
}

AccountId is a struct representing the Resource ID for a Account

func NewAccountID 

func NewAccountID(subscriptionId string, resourceGroupName string, accountName string) AccountId

NewAccountID returns a new AccountId struct

func ParseAccountID 

func ParseAccountID(input string) (*AccountId, error)

ParseAccountID parses 'input' into a AccountId

func ParseAccountIDInsensitively 

func ParseAccountIDInsensitively(input string) (*AccountId, error)

ParseAccountIDInsensitively parses 'input' case-insensitively into a AccountId note: this method should only be used for API response data and not user input

func (AccountId) ID 

func (id AccountId) ID() string

ID returns the formatted Account ID

func (AccountId) Segments 

func (id AccountId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Account ID

func (AccountId) String 

func (id AccountId) String() string

String returns a human-readable description of this Account ID

type AccountOperationPredicate 

type AccountOperationPredicate struct {
	Etag     *string
	Id       *string
	Kind     *string
	Location *string
	Name     *string
	Type     *string
}

func (AccountOperationPredicate) Matches 

func (p AccountOperationPredicate) Matches(input Account) bool

type AccountProperties 

type AccountProperties struct {
	AllowedFqdnList               *[]string                    `json:"allowedFqdnList,omitempty"`
	ApiProperties                 *ApiProperties               `json:"apiProperties,omitempty"`
	CallRateLimit                 *CallRateLimit               `json:"callRateLimit,omitempty"`
	Capabilities                  *[]SkuCapability             `json:"capabilities,omitempty"`
	CustomSubDomainName           *string                      `json:"customSubDomainName,omitempty"`
	DateCreated                   *string                      `json:"dateCreated,omitempty"`
	DisableLocalAuth              *bool                        `json:"disableLocalAuth,omitempty"`
	Encryption                    *Encryption                  `json:"encryption,omitempty"`
	Endpoint                      *string                      `json:"endpoint,omitempty"`
	Endpoints                     *map[string]string           `json:"endpoints,omitempty"`
	InternalId                    *string                      `json:"internalId,omitempty"`
	IsMigrated                    *bool                        `json:"isMigrated,omitempty"`
	MigrationToken                *string                      `json:"migrationToken,omitempty"`
	NetworkAcls                   *NetworkRuleSet              `json:"networkAcls,omitempty"`
	PrivateEndpointConnections    *[]PrivateEndpointConnection `json:"privateEndpointConnections,omitempty"`
	ProvisioningState             *ProvisioningState           `json:"provisioningState,omitempty"`
	PublicNetworkAccess           *PublicNetworkAccess         `json:"publicNetworkAccess,omitempty"`
	QuotaLimit                    *QuotaLimit                  `json:"quotaLimit,omitempty"`
	Restore                       *bool                        `json:"restore,omitempty"`
	RestrictOutboundNetworkAccess *bool                        `json:"restrictOutboundNetworkAccess,omitempty"`
	SkuChangeInfo                 *SkuChangeInfo               `json:"skuChangeInfo,omitempty"`
	UserOwnedStorage              *[]UserOwnedStorage          `json:"userOwnedStorage,omitempty"`
}

type AccountSku 

type AccountSku struct {
	ResourceType *string `json:"resourceType,omitempty"`
	Sku          *Sku    `json:"sku,omitempty"`
}

type AccountSkuListResult 

type AccountSkuListResult struct {
	Value *[]AccountSku `json:"value,omitempty"`
}

type AccountsCreateOperationResponse 

type AccountsCreateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type AccountsDeleteOperationResponse 

type AccountsDeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type AccountsGetOperationResponse 

type AccountsGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Account
}

type AccountsListByResourceGroupCompleteResult 

type AccountsListByResourceGroupCompleteResult struct {
	Items []Account
}

type AccountsListByResourceGroupOperationResponse 

type AccountsListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Account
}

type AccountsListCompleteResult 

type AccountsListCompleteResult struct {
	Items []Account
}

type AccountsListKeysOperationResponse 

type AccountsListKeysOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ApiKeys
}

type AccountsListOperationResponse 

type AccountsListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Account
}

type AccountsListSkusOperationResponse 

type AccountsListSkusOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AccountSkuListResult
}

type AccountsListUsagesOperationOptions 

type AccountsListUsagesOperationOptions struct {
	Filter *string
}

func DefaultAccountsListUsagesOperationOptions 

func DefaultAccountsListUsagesOperationOptions() AccountsListUsagesOperationOptions

func (AccountsListUsagesOperationOptions) ToHeaders added in v0.20230503.1093249 

func (o AccountsListUsagesOperationOptions) ToHeaders() *client.Headers

func (AccountsListUsagesOperationOptions) ToOData added in v0.20230503.1093249 

func (o AccountsListUsagesOperationOptions) ToOData() *odata.Query

func (AccountsListUsagesOperationOptions) ToQuery added in v0.20230503.1093249 

func (o AccountsListUsagesOperationOptions) ToQuery() *client.QueryParams

type AccountsListUsagesOperationResponse 

type AccountsListUsagesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *UsageListResult
}

type AccountsRegenerateKeyOperationResponse 

type AccountsRegenerateKeyOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ApiKeys
}

type AccountsUpdateOperationResponse 

type AccountsUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type ApiKeys 

type ApiKeys struct {
	Key1 *string `json:"key1,omitempty"`
	Key2 *string `json:"key2,omitempty"`
}

type ApiProperties 

type ApiProperties struct {
	AadClientId                    *string `json:"aadClientId,omitempty"`
	AadTenantId                    *string `json:"aadTenantId,omitempty"`
	EventHubConnectionString       *string `json:"eventHubConnectionString,omitempty"`
	QnaAzureSearchEndpointId       *string `json:"qnaAzureSearchEndpointId,omitempty"`
	QnaAzureSearchEndpointKey      *string `json:"qnaAzureSearchEndpointKey,omitempty"`
	QnaRuntimeEndpoint             *string `json:"qnaRuntimeEndpoint,omitempty"`
	StatisticsEnabled              *bool   `json:"statisticsEnabled,omitempty"`
	StorageAccountConnectionString *string `json:"storageAccountConnectionString,omitempty"`
	SuperUser                      *string `json:"superUser,omitempty"`
	WebsiteName                    *string `json:"websiteName,omitempty"`
}

type CallRateLimit 

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

type CheckDomainAvailabilityOperationResponse 

type CheckDomainAvailabilityOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DomainAvailability
}

type CheckDomainAvailabilityParameter 

type CheckDomainAvailabilityParameter struct {
	SubdomainName string `json:"subdomainName"`
	Type          string `json:"type"`
}

type CheckSkuAvailabilityOperationResponse 

type CheckSkuAvailabilityOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SkuAvailabilityListResult
}

type CheckSkuAvailabilityParameter 

type CheckSkuAvailabilityParameter struct {
	Kind string   `json:"kind"`
	Skus []string `json:"skus"`
	Type string   `json:"type"`
}

type CognitiveServicesAccountsClient 

type CognitiveServicesAccountsClient struct {
	Client *resourcemanager.Client
}

func NewCognitiveServicesAccountsClientWithBaseURI 

func NewCognitiveServicesAccountsClientWithBaseURI(api environments.Api) (*CognitiveServicesAccountsClient, error)

func (CognitiveServicesAccountsClient) AccountsCreate 

func (c CognitiveServicesAccountsClient) AccountsCreate(ctx context.Context, id AccountId, input Account) (result AccountsCreateOperationResponse, err error)

AccountsCreate ...

func (CognitiveServicesAccountsClient) AccountsCreateThenPoll 

func (c CognitiveServicesAccountsClient) AccountsCreateThenPoll(ctx context.Context, id AccountId, input Account) error

AccountsCreateThenPoll performs AccountsCreate then polls until it's completed

func (CognitiveServicesAccountsClient) AccountsDelete 

func (c CognitiveServicesAccountsClient) AccountsDelete(ctx context.Context, id AccountId) (result AccountsDeleteOperationResponse, err error)

AccountsDelete ...

func (CognitiveServicesAccountsClient) AccountsDeleteThenPoll 

func (c CognitiveServicesAccountsClient) AccountsDeleteThenPoll(ctx context.Context, id AccountId) error

AccountsDeleteThenPoll performs AccountsDelete then polls until it's completed

func (CognitiveServicesAccountsClient) AccountsGet 

func (c CognitiveServicesAccountsClient) AccountsGet(ctx context.Context, id AccountId) (result AccountsGetOperationResponse, err error)

AccountsGet ...

func (CognitiveServicesAccountsClient) AccountsList 

func (c CognitiveServicesAccountsClient) AccountsList(ctx context.Context, id commonids.SubscriptionId) (result AccountsListOperationResponse, err error)

AccountsList ...

func (CognitiveServicesAccountsClient) AccountsListByResourceGroup 

func (c CognitiveServicesAccountsClient) AccountsListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result AccountsListByResourceGroupOperationResponse, err error)

AccountsListByResourceGroup ...

func (CognitiveServicesAccountsClient) AccountsListByResourceGroupComplete 

func (c CognitiveServicesAccountsClient) AccountsListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (AccountsListByResourceGroupCompleteResult, error)

AccountsListByResourceGroupComplete retrieves all the results into a single object

func (CognitiveServicesAccountsClient) AccountsListByResourceGroupCompleteMatchingPredicate 

func (c CognitiveServicesAccountsClient) AccountsListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate AccountOperationPredicate) (result AccountsListByResourceGroupCompleteResult, err error)

AccountsListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (CognitiveServicesAccountsClient) AccountsListComplete 

func (c CognitiveServicesAccountsClient) AccountsListComplete(ctx context.Context, id commonids.SubscriptionId) (AccountsListCompleteResult, error)

AccountsListComplete retrieves all the results into a single object

func (CognitiveServicesAccountsClient) AccountsListCompleteMatchingPredicate 

func (c CognitiveServicesAccountsClient) AccountsListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate AccountOperationPredicate) (result AccountsListCompleteResult, err error)

AccountsListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (CognitiveServicesAccountsClient) AccountsListKeys 

func (c CognitiveServicesAccountsClient) AccountsListKeys(ctx context.Context, id AccountId) (result AccountsListKeysOperationResponse, err error)

AccountsListKeys ...

func (CognitiveServicesAccountsClient) AccountsListSkus 

func (c CognitiveServicesAccountsClient) AccountsListSkus(ctx context.Context, id AccountId) (result AccountsListSkusOperationResponse, err error)

AccountsListSkus ...

func (CognitiveServicesAccountsClient) AccountsListUsages 

func (c CognitiveServicesAccountsClient) AccountsListUsages(ctx context.Context, id AccountId, options AccountsListUsagesOperationOptions) (result AccountsListUsagesOperationResponse, err error)

AccountsListUsages ...

func (CognitiveServicesAccountsClient) AccountsRegenerateKey 

func (c CognitiveServicesAccountsClient) AccountsRegenerateKey(ctx context.Context, id AccountId, input RegenerateKeyParameters) (result AccountsRegenerateKeyOperationResponse, err error)

AccountsRegenerateKey ...

func (CognitiveServicesAccountsClient) AccountsUpdate 

func (c CognitiveServicesAccountsClient) AccountsUpdate(ctx context.Context, id AccountId, input Account) (result AccountsUpdateOperationResponse, err error)

AccountsUpdate ...

func (CognitiveServicesAccountsClient) AccountsUpdateThenPoll 

func (c CognitiveServicesAccountsClient) AccountsUpdateThenPoll(ctx context.Context, id AccountId, input Account) error

AccountsUpdateThenPoll performs AccountsUpdate then polls until it's completed

func (CognitiveServicesAccountsClient) CheckDomainAvailability 

func (c CognitiveServicesAccountsClient) CheckDomainAvailability(ctx context.Context, id commonids.SubscriptionId, input CheckDomainAvailabilityParameter) (result CheckDomainAvailabilityOperationResponse, err error)

CheckDomainAvailability ...

func (CognitiveServicesAccountsClient) CheckSkuAvailability 

func (c CognitiveServicesAccountsClient) CheckSkuAvailability(ctx context.Context, id LocationId, input CheckSkuAvailabilityParameter) (result CheckSkuAvailabilityOperationResponse, err error)

CheckSkuAvailability ...

func (CognitiveServicesAccountsClient) DeletedAccountsGet 

func (c CognitiveServicesAccountsClient) DeletedAccountsGet(ctx context.Context, id DeletedAccountId) (result DeletedAccountsGetOperationResponse, err error)

DeletedAccountsGet ...

func (CognitiveServicesAccountsClient) DeletedAccountsList 

func (c CognitiveServicesAccountsClient) DeletedAccountsList(ctx context.Context, id commonids.SubscriptionId) (result DeletedAccountsListOperationResponse, err error)

DeletedAccountsList ...

func (CognitiveServicesAccountsClient) DeletedAccountsListComplete 

func (c CognitiveServicesAccountsClient) DeletedAccountsListComplete(ctx context.Context, id commonids.SubscriptionId) (DeletedAccountsListCompleteResult, error)

DeletedAccountsListComplete retrieves all the results into a single object

func (CognitiveServicesAccountsClient) DeletedAccountsListCompleteMatchingPredicate 

func (c CognitiveServicesAccountsClient) DeletedAccountsListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate AccountOperationPredicate) (result DeletedAccountsListCompleteResult, err error)

DeletedAccountsListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (CognitiveServicesAccountsClient) DeletedAccountsPurge 

func (c CognitiveServicesAccountsClient) DeletedAccountsPurge(ctx context.Context, id DeletedAccountId) (result DeletedAccountsPurgeOperationResponse, err error)

DeletedAccountsPurge ...

func (CognitiveServicesAccountsClient) DeletedAccountsPurgeThenPoll 

func (c CognitiveServicesAccountsClient) DeletedAccountsPurgeThenPoll(ctx context.Context, id DeletedAccountId) error

DeletedAccountsPurgeThenPoll performs DeletedAccountsPurge then polls until it's completed

func (CognitiveServicesAccountsClient) ResourceSkusList 

func (c CognitiveServicesAccountsClient) ResourceSkusList(ctx context.Context, id commonids.SubscriptionId) (result ResourceSkusListOperationResponse, err error)

ResourceSkusList ...

func (CognitiveServicesAccountsClient) ResourceSkusListComplete 

func (c CognitiveServicesAccountsClient) ResourceSkusListComplete(ctx context.Context, id commonids.SubscriptionId) (ResourceSkusListCompleteResult, error)

ResourceSkusListComplete retrieves all the results into a single object

func (CognitiveServicesAccountsClient) ResourceSkusListCompleteMatchingPredicate 

func (c CognitiveServicesAccountsClient) ResourceSkusListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate ResourceSkuOperationPredicate) (result ResourceSkusListCompleteResult, err error)

ResourceSkusListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type DeletedAccountId 

type DeletedAccountId struct {
	SubscriptionId     string
	LocationName       string
	ResourceGroupName  string
	DeletedAccountName string
}

DeletedAccountId is a struct representing the Resource ID for a Deleted Account

func NewDeletedAccountID 

func NewDeletedAccountID(subscriptionId string, locationName string, resourceGroupName string, deletedAccountName string) DeletedAccountId

NewDeletedAccountID returns a new DeletedAccountId struct

func ParseDeletedAccountID 

func ParseDeletedAccountID(input string) (*DeletedAccountId, error)

ParseDeletedAccountID parses 'input' into a DeletedAccountId

func ParseDeletedAccountIDInsensitively 

func ParseDeletedAccountIDInsensitively(input string) (*DeletedAccountId, error)

ParseDeletedAccountIDInsensitively parses 'input' case-insensitively into a DeletedAccountId note: this method should only be used for API response data and not user input

func (DeletedAccountId) ID 

func (id DeletedAccountId) ID() string

ID returns the formatted Deleted Account ID

func (DeletedAccountId) Segments 

func (id DeletedAccountId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Deleted Account ID

func (DeletedAccountId) String 

func (id DeletedAccountId) String() string

String returns a human-readable description of this Deleted Account ID

type DeletedAccountsGetOperationResponse 

type DeletedAccountsGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Account
}

type DeletedAccountsListCompleteResult 

type DeletedAccountsListCompleteResult struct {
	Items []Account
}

type DeletedAccountsListOperationResponse 

type DeletedAccountsListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Account
}

type DeletedAccountsPurgeOperationResponse 

type DeletedAccountsPurgeOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type DomainAvailability 

type DomainAvailability struct {
	IsSubdomainAvailable *bool   `json:"isSubdomainAvailable,omitempty"`
	Reason               *string `json:"reason,omitempty"`
	SubdomainName        *string `json:"subdomainName,omitempty"`
	Type                 *string `json:"type,omitempty"`
}

type Encryption 

type Encryption struct {
	KeySource          *KeySource          `json:"keySource,omitempty"`
	KeyVaultProperties *KeyVaultProperties `json:"keyVaultProperties,omitempty"`
}

type IPRule added in v0.20220725.1131927 

type IPRule struct {
	Value string `json:"value"`
}

type KeyName 

type KeyName string
const (
	KeyNameKeyOne KeyName = "Key1"
	KeyNameKeyTwo KeyName = "Key2"
)

func (*KeyName) UnmarshalJSON added in v0.20230503.1093249 

func (s *KeyName) UnmarshalJSON(bytes []byte) error

type KeySource 

type KeySource string
const (
	KeySourceMicrosoftPointCognitiveServices KeySource = "Microsoft.CognitiveServices"
	KeySourceMicrosoftPointKeyVault          KeySource = "Microsoft.KeyVault"
)

func (*KeySource) UnmarshalJSON added in v0.20230503.1093249 

func (s *KeySource) UnmarshalJSON(bytes []byte) error

type KeyVaultProperties 

type KeyVaultProperties struct {
	IdentityClientId *string `json:"identityClientId,omitempty"`
	KeyName          *string `json:"keyName,omitempty"`
	KeyVaultUri      *string `json:"keyVaultUri,omitempty"`
	KeyVersion       *string `json:"keyVersion,omitempty"`
}

type LocationId 

type LocationId struct {
	SubscriptionId string
	LocationName   string
}

LocationId is a struct representing the Resource ID for a Location

func NewLocationID 

func NewLocationID(subscriptionId string, locationName string) LocationId

NewLocationID returns a new LocationId struct

func ParseLocationID 

func ParseLocationID(input string) (*LocationId, error)

ParseLocationID parses 'input' into a LocationId

func ParseLocationIDInsensitively 

func ParseLocationIDInsensitively(input string) (*LocationId, error)

ParseLocationIDInsensitively parses 'input' case-insensitively into a LocationId note: this method should only be used for API response data and not user input

func (LocationId) ID 

func (id LocationId) ID() string

ID returns the formatted Location ID

func (LocationId) Segments 

func (id LocationId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Location ID

func (LocationId) String 

func (id LocationId) String() string

String returns a human-readable description of this Location ID

type MetricName 

type MetricName struct {
	LocalizedValue *string `json:"localizedValue,omitempty"`
	Value          *string `json:"value,omitempty"`
}

type NetworkRuleAction 

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

func (*NetworkRuleAction) UnmarshalJSON added in v0.20230503.1093249 

func (s *NetworkRuleAction) UnmarshalJSON(bytes []byte) error

type NetworkRuleSet 

type NetworkRuleSet struct {
	DefaultAction       *NetworkRuleAction    `json:"defaultAction,omitempty"`
	IPRules             *[]IPRule             `json:"ipRules,omitempty"`
	VirtualNetworkRules *[]VirtualNetworkRule `json:"virtualNetworkRules,omitempty"`
}

type PrivateEndpoint 

type PrivateEndpoint struct {
	Id *string `json:"id,omitempty"`
}

type PrivateEndpointConnection 

type PrivateEndpointConnection struct {
	Etag       *string                              `json:"etag,omitempty"`
	Id         *string                              `json:"id,omitempty"`
	Location   *string                              `json:"location,omitempty"`
	Name       *string                              `json:"name,omitempty"`
	Properties *PrivateEndpointConnectionProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData               `json:"systemData,omitempty"`
	Type       *string                              `json:"type,omitempty"`
}

type PrivateEndpointConnectionProperties 

type PrivateEndpointConnectionProperties struct {
	GroupIds                          *[]string                                   `json:"groupIds,omitempty"`
	PrivateEndpoint                   *PrivateEndpoint                            `json:"privateEndpoint,omitempty"`
	PrivateLinkServiceConnectionState PrivateLinkServiceConnectionState           `json:"privateLinkServiceConnectionState"`
	ProvisioningState                 *PrivateEndpointConnectionProvisioningState `json:"provisioningState,omitempty"`
}

type PrivateEndpointConnectionProvisioningState 

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

func (*PrivateEndpointConnectionProvisioningState) UnmarshalJSON added in v0.20230503.1093249 

func (s *PrivateEndpointConnectionProvisioningState) UnmarshalJSON(bytes []byte) error

type PrivateEndpointServiceConnectionStatus 

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

func (*PrivateEndpointServiceConnectionStatus) UnmarshalJSON added in v0.20230503.1093249 

func (s *PrivateEndpointServiceConnectionStatus) UnmarshalJSON(bytes []byte) error

type PrivateLinkServiceConnectionState 

type PrivateLinkServiceConnectionState struct {
	ActionsRequired *string                                 `json:"actionsRequired,omitempty"`
	Description     *string                                 `json:"description,omitempty"`
	Status          *PrivateEndpointServiceConnectionStatus `json:"status,omitempty"`
}

type ProvisioningState 

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

func (*ProvisioningState) UnmarshalJSON added in v0.20230503.1093249 

func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error

type PublicNetworkAccess 

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

func (*PublicNetworkAccess) UnmarshalJSON added in v0.20230503.1093249 

func (s *PublicNetworkAccess) UnmarshalJSON(bytes []byte) error

type QuotaLimit 

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

type QuotaUsageStatus 

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

func (*QuotaUsageStatus) UnmarshalJSON added in v0.20230503.1093249 

func (s *QuotaUsageStatus) UnmarshalJSON(bytes []byte) error

type RegenerateKeyParameters 

type RegenerateKeyParameters struct {
	KeyName KeyName `json:"keyName"`
}

type RequestMatchPattern 

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

type ResourceSku 

type ResourceSku struct {
	Kind         *string                    `json:"kind,omitempty"`
	Locations    *[]string                  `json:"locations,omitempty"`
	Name         *string                    `json:"name,omitempty"`
	ResourceType *string                    `json:"resourceType,omitempty"`
	Restrictions *[]ResourceSkuRestrictions `json:"restrictions,omitempty"`
	Tier         *string                    `json:"tier,omitempty"`
}

type ResourceSkuOperationPredicate 

type ResourceSkuOperationPredicate struct {
	Kind         *string
	Name         *string
	ResourceType *string
	Tier         *string
}

func (ResourceSkuOperationPredicate) Matches 

func (p ResourceSkuOperationPredicate) Matches(input ResourceSku) bool

type ResourceSkuRestrictionInfo 

type ResourceSkuRestrictionInfo struct {
	Locations *[]string     `json:"locations,omitempty"`
	Zones     *zones.Schema `json:"zones,omitempty"`
}

type ResourceSkuRestrictions 

type ResourceSkuRestrictions struct {
	ReasonCode      *ResourceSkuRestrictionsReasonCode `json:"reasonCode,omitempty"`
	RestrictionInfo *ResourceSkuRestrictionInfo        `json:"restrictionInfo,omitempty"`
	Type            *ResourceSkuRestrictionsType       `json:"type,omitempty"`
	Values          *[]string                          `json:"values,omitempty"`
}

type ResourceSkuRestrictionsReasonCode 

type ResourceSkuRestrictionsReasonCode string
const (
	ResourceSkuRestrictionsReasonCodeNotAvailableForSubscription ResourceSkuRestrictionsReasonCode = "NotAvailableForSubscription"
	ResourceSkuRestrictionsReasonCodeQuotaId                     ResourceSkuRestrictionsReasonCode = "QuotaId"
)

func (*ResourceSkuRestrictionsReasonCode) UnmarshalJSON added in v0.20230503.1093249 

func (s *ResourceSkuRestrictionsReasonCode) UnmarshalJSON(bytes []byte) error

type ResourceSkuRestrictionsType 

type ResourceSkuRestrictionsType string
const (
	ResourceSkuRestrictionsTypeLocation ResourceSkuRestrictionsType = "Location"
	ResourceSkuRestrictionsTypeZone     ResourceSkuRestrictionsType = "Zone"
)

func (*ResourceSkuRestrictionsType) UnmarshalJSON added in v0.20230503.1093249 

func (s *ResourceSkuRestrictionsType) UnmarshalJSON(bytes []byte) error

type ResourceSkusListCompleteResult 

type ResourceSkusListCompleteResult struct {
	Items []ResourceSku
}

type ResourceSkusListOperationResponse 

type ResourceSkusListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ResourceSku
}

type Sku 

type Sku struct {
	Capacity *int64   `json:"capacity,omitempty"`
	Family   *string  `json:"family,omitempty"`
	Name     string   `json:"name"`
	Size     *string  `json:"size,omitempty"`
	Tier     *SkuTier `json:"tier,omitempty"`
}

type SkuAvailability 

type SkuAvailability struct {
	Kind         *string `json:"kind,omitempty"`
	Message      *string `json:"message,omitempty"`
	Reason       *string `json:"reason,omitempty"`
	SkuAvailable *bool   `json:"skuAvailable,omitempty"`
	SkuName      *string `json:"skuName,omitempty"`
	Type         *string `json:"type,omitempty"`
}

type SkuAvailabilityListResult 

type SkuAvailabilityListResult struct {
	Value *[]SkuAvailability `json:"value,omitempty"`
}

type SkuCapability 

type SkuCapability struct {
	Name  *string `json:"name,omitempty"`
	Value *string `json:"value,omitempty"`
}

type SkuChangeInfo 

type SkuChangeInfo struct {
	CountOfDowngrades              *float64 `json:"countOfDowngrades,omitempty"`
	CountOfUpgradesAfterDowngrades *float64 `json:"countOfUpgradesAfterDowngrades,omitempty"`
	LastChangeDate                 *string  `json:"lastChangeDate,omitempty"`
}

type SkuTier 

type SkuTier string
const (
	SkuTierBasic      SkuTier = "Basic"
	SkuTierEnterprise SkuTier = "Enterprise"
	SkuTierFree       SkuTier = "Free"
	SkuTierPremium    SkuTier = "Premium"
	SkuTierStandard   SkuTier = "Standard"
)

func (*SkuTier) UnmarshalJSON added in v0.20230503.1093249 

func (s *SkuTier) UnmarshalJSON(bytes []byte) error

type ThrottlingRule 

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

type UnitType 

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

func (*UnitType) UnmarshalJSON added in v0.20230503.1093249 

func (s *UnitType) UnmarshalJSON(bytes []byte) error

type Usage 

type Usage struct {
	CurrentValue  *float64          `json:"currentValue,omitempty"`
	Limit         *float64          `json:"limit,omitempty"`
	Name          *MetricName       `json:"name,omitempty"`
	NextResetTime *string           `json:"nextResetTime,omitempty"`
	QuotaPeriod   *string           `json:"quotaPeriod,omitempty"`
	Status        *QuotaUsageStatus `json:"status,omitempty"`
	Unit          *UnitType         `json:"unit,omitempty"`
}

type UsageListResult 

type UsageListResult struct {
	Value *[]Usage `json:"value,omitempty"`
}

type UserOwnedStorage 

type UserOwnedStorage struct {
	IdentityClientId *string `json:"identityClientId,omitempty"`
	ResourceId       *string `json:"resourceId,omitempty"`
}

type VirtualNetworkRule 

type VirtualNetworkRule struct {
	Id                               string  `json:"id"`
	IgnoreMissingVnetServiceEndpoint *bool   `json:"ignoreMissingVnetServiceEndpoint,omitempty"`
	State                            *string `json:"state,omitempty"`
}

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.