generated

package
v0.31.0-rc3 Latest Latest
Warning

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

 Go to latest Published: Feb 28, 2024 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

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.

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.

func (ErrorAdditionalInfo) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ErrorAdditionalInfo.

func (*ErrorAdditionalInfo) UnmarshalJSON 

func (e *ErrorAdditionalInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorAdditionalInfo.

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.

func (*ErrorDetail) UnmarshalJSON 

func (e *ErrorDetail) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorDetail.

type ErrorResponse 

type ErrorResponse struct {
	// The error object.
	Error *ErrorDetail `json:"error,omitempty"`
}

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.).

func (ErrorResponse) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ErrorResponse.

func (*ErrorResponse) UnmarshalJSON 

func (e *ErrorResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorResponse.

type GenericResource 

type GenericResource struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string `json:"location,omitempty"`

	// REQUIRED; Any object
	Properties map[string]interface{} `json:"properties,omitempty"`

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

	// 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; Metadata pertaining to creation and last modification of the resource.
	SystemData *SystemData `json:"systemData,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"`
}

GenericResource - Generic resource

func (GenericResource) MarshalJSON 

func (g GenericResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type GenericResource.

func (*GenericResource) UnmarshalJSON 

func (g *GenericResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type GenericResource.

type GenericResourcesClient 

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

GenericResourcesClient contains the methods for the GenericResources group. Don't use this type directly, use NewGenericResourcesClient() instead.

func NewGenericResourcesClient 

func NewGenericResourcesClient(rootScope string, resourceType string, credential azcore.TokenCredential, options *arm.ClientOptions) (*GenericResourcesClient, error)

NewGenericResourcesClient creates a new instance of GenericResourcesClient with the specified values. rootScope - The scope in which the resource is present. For Azure resource this would be /subscriptions/{subscriptionID}/resourceGroups/{resourcegroupID} resourceType - The azure resource type. For example RedisCache, RabbitMQ and other credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*GenericResourcesClient) BeginCreateOrUpdate added in v0.26.0 

func (client *GenericResourcesClient) BeginCreateOrUpdate(ctx context.Context, resourceName string, genericResourceParameters GenericResource, options *GenericResourcesClientBeginCreateOrUpdateOptions) (*runtime.Poller[GenericResourcesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a Generic resource If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2023-10-01-preview resourceName - The name of the generic resource genericResourceParameters - generic resource create parameters options - GenericResourcesClientBeginCreateOrUpdateOptions contains the optional parameters for the GenericResourcesClient.BeginCreateOrUpdate method.

func (*GenericResourcesClient) BeginDelete 

func (client *GenericResourcesClient) BeginDelete(ctx context.Context, resourceName string, options *GenericResourcesClientBeginDeleteOptions) (*runtime.Poller[GenericResourcesClientDeleteResponse], error)

BeginDelete - Deletes an existing Generic resource If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2023-10-01-preview resourceName - The name of the generic resource options - GenericResourcesClientBeginDeleteOptions contains the optional parameters for the GenericResourcesClient.BeginDelete method.

func (*GenericResourcesClient) Get 

func (client *GenericResourcesClient) Get(ctx context.Context, resourceName string, options *GenericResourcesClientGetOptions) (GenericResourcesClientGetResponse, error)

Get - Retrieves information about a generic resource with the name given of the type given within the root scope If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2023-10-01-preview resourceName - The name of the generic resource options - GenericResourcesClientGetOptions contains the optional parameters for the GenericResourcesClient.Get method.

func (*GenericResourcesClient) ListSecrets added in v0.26.0 

func (client *GenericResourcesClient) ListSecrets(ctx context.Context, resourceName string, options *GenericResourcesClientListSecretsOptions) (GenericResourcesClientListSecretsResponse, error)

ListSecrets - Lists secrets for a resource If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2023-10-01-preview resourceName - The name of the generic resource options - GenericResourcesClientListSecretsOptions contains the optional parameters for the GenericResourcesClient.ListSecrets method.

func (*GenericResourcesClient) NewListByRootScopePager 

func (client *GenericResourcesClient) NewListByRootScopePager(options *GenericResourcesClientListByRootScopeOptions) *runtime.Pager[GenericResourcesClientListByRootScopeResponse]

NewListByRootScopePager - Lists information about all resources of the given resource type in the given root scope Generated from API version 2023-10-01-preview options - GenericResourcesClientListByRootScopeOptions contains the optional parameters for the GenericResourcesClient.ListByRootScope method.

type GenericResourcesClientBeginCreateOrUpdateOptions added in v0.26.0 

type GenericResourcesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

GenericResourcesClientBeginCreateOrUpdateOptions contains the optional parameters for the GenericResourcesClient.BeginCreateOrUpdate method.

type GenericResourcesClientBeginDeleteOptions 

type GenericResourcesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

GenericResourcesClientBeginDeleteOptions contains the optional parameters for the GenericResourcesClient.BeginDelete method.

type GenericResourcesClientCreateOrUpdateResponse 

type GenericResourcesClientCreateOrUpdateResponse struct {
	GenericResource
}

GenericResourcesClientCreateOrUpdateResponse contains the response from method GenericResourcesClient.CreateOrUpdate.

type GenericResourcesClientDeleteResponse 

type GenericResourcesClientDeleteResponse struct {
}

GenericResourcesClientDeleteResponse contains the response from method GenericResourcesClient.Delete.

type GenericResourcesClientGetOptions 

type GenericResourcesClientGetOptions struct {
}

GenericResourcesClientGetOptions contains the optional parameters for the GenericResourcesClient.Get method.

type GenericResourcesClientGetResponse 

type GenericResourcesClientGetResponse struct {
	GenericResource
}

GenericResourcesClientGetResponse contains the response from method GenericResourcesClient.Get.

type GenericResourcesClientListByRootScopeOptions 

type GenericResourcesClientListByRootScopeOptions struct {
}

GenericResourcesClientListByRootScopeOptions contains the optional parameters for the GenericResourcesClient.ListByRootScope method.

type GenericResourcesClientListByRootScopeResponse 

type GenericResourcesClientListByRootScopeResponse struct {
	GenericResourcesList
}

GenericResourcesClientListByRootScopeResponse contains the response from method GenericResourcesClient.ListByRootScope.

type GenericResourcesClientListSecretsOptions added in v0.26.0 

type GenericResourcesClientListSecretsOptions struct {
}

GenericResourcesClientListSecretsOptions contains the optional parameters for the GenericResourcesClient.ListSecrets method.

type GenericResourcesClientListSecretsResponse added in v0.26.0 

type GenericResourcesClientListSecretsResponse struct {
	// Response to a list secrets request
	Value map[string]*string
}

GenericResourcesClientListSecretsResponse contains the response from method GenericResourcesClient.ListSecrets.

type GenericResourcesList 

type GenericResourcesList struct {
	// The link used to fetch the next page of resource list.
	NextLink *string `json:"nextLink,omitempty"`

	// List of GenericResources resources
	Value []*GenericResource `json:"value,omitempty"`
}

GenericResourcesList - Object that includes an array of GenericResources and a possible link for next set

func (GenericResourcesList) MarshalJSON 

func (g GenericResourcesList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type GenericResourcesList.

func (*GenericResourcesList) UnmarshalJSON 

func (g *GenericResourcesList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type GenericResourcesList.

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.

func (*Resource) UnmarshalJSON 

func (r *Resource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Resource.

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 TrackedResource 

type TrackedResource struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string `json:"location,omitempty"`

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

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

TrackedResource - The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

func (TrackedResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type TrackedResource.

func (*TrackedResource) UnmarshalJSON 

func (t *TrackedResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TrackedResource.

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.