v20231001preview

package
v0.60.0 Latest Latest
Warning

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

 Go to latest Published: Aug 19, 2026 License: Apache-2.0 Imports: 22 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// AwsCredentialType represents the ucp azure crendetial type value.
	AWSCredentialType = "System.AWS/credentials"
)
View Source 
const (
	// AzureCredentialType represents the ucp azure crendetial type value.
	AzureCredentialType = "System.Azure/credentials"
)
View Source 
const (
	ResourceGroupType = "System.Resources/resourceGroups"
)
View Source 
const (
	ResourceType = "System.Resources/resources"
)
View Source 
const Version = "2023-10-01-preview"

Version represents the api version in this package.

Variables

This section is empty.

Functions

This section is empty.

Types

type APIVersionProperties added in v0.39.0 

type APIVersionProperties struct {
	// Schema is the schema for the resource type.
	Schema map[string]any

	// READ-ONLY; The status of the asynchronous operation.
	ProvisioningState *ProvisioningState
}

APIVersionProperties - The properties of an API version.

func (APIVersionProperties) MarshalJSON added in v0.39.0 

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

MarshalJSON implements the json.Marshaller interface for type APIVersionProperties.

func (*APIVersionProperties) UnmarshalJSON added in v0.39.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type APIVersionProperties.

type APIVersionResource added in v0.39.0 

type APIVersionResource struct {
	// The resource-specific properties for this resource.
	Properties *APIVersionProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

APIVersionResource - The resource type for defining an API version of a resource type supported by the containing resource provider.

func (*APIVersionResource) ConvertFrom added in v0.39.0 

func (dst *APIVersionResource) ConvertFrom(src v1.DataModelInterface) error

ConvertFrom converts from version-agnostic datamodel to the versioned APIVersionResource resource.

func (*APIVersionResource) ConvertTo added in v0.39.0 

func (src *APIVersionResource) ConvertTo() (v1.DataModelInterface, error)

ConvertTo converts from the versioned APIVersionResource resource to version-agnostic datamodel.

func (APIVersionResource) MarshalJSON added in v0.39.0 

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

MarshalJSON implements the json.Marshaller interface for type APIVersionResource.

func (*APIVersionResource) UnmarshalJSON added in v0.39.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type APIVersionResource.

type APIVersionResourceListResult added in v0.39.0 

type APIVersionResourceListResult struct {
	// REQUIRED; The ApiVersionResource items on this page
	Value []*APIVersionResource

	// The link to the next page of items
	NextLink *string
}

APIVersionResourceListResult - The response of a ApiVersionResource list operation.

func (APIVersionResourceListResult) MarshalJSON added in v0.39.0 

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

MarshalJSON implements the json.Marshaller interface for type APIVersionResourceListResult.

func (*APIVersionResourceListResult) UnmarshalJSON added in v0.39.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type APIVersionResourceListResult.

type APIVersionsClient added in v0.39.0 

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

APIVersionsClient contains the methods for the APIVersions group. Don't use this type directly, use NewAPIVersionsClient() instead.

Generated from API version 2023-10-01-preview

func NewAPIVersionsClient added in v0.39.0 

func NewAPIVersionsClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*APIVersionsClient, error)

NewAPIVersionsClient creates a new instance of APIVersionsClient with the specified values.

  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - Contains optional client configuration. Pass nil to accept the default values.

func (*APIVersionsClient) BeginCreateOrUpdate added in v0.39.0 

func (client *APIVersionsClient) BeginCreateOrUpdate(ctx context.Context, planeName string, resourceProviderName string, resourceTypeName string, apiVersionName string, resource APIVersionResource, options *APIVersionsClientBeginCreateOrUpdateOptions) (*runtime.Poller[APIVersionsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create or update an API version. If the operation fails it returns an *azcore.ResponseError type.

  • planeName - The plane name.
  • resourceProviderName - The resource provider name. This is also the resource provider namespace. Example: 'Applications.Datastores'.
  • resourceTypeName - The resource type name.
  • apiVersionName - The API version name.
  • resource - Resource create parameters.
  • options - APIVersionsClientBeginCreateOrUpdateOptions contains the optional parameters for the APIVersionsClient.BeginCreateOrUpdate method.

func (*APIVersionsClient) BeginDelete added in v0.39.0 

func (client *APIVersionsClient) BeginDelete(ctx context.Context, planeName string, resourceProviderName string, resourceTypeName string, apiVersionName string, options *APIVersionsClientBeginDeleteOptions) (*runtime.Poller[APIVersionsClientDeleteResponse], error)

BeginDelete - Delete an API version. If the operation fails it returns an *azcore.ResponseError type.

  • planeName - The plane name.
  • resourceProviderName - The resource provider name. This is also the resource provider namespace. Example: 'Applications.Datastores'.
  • resourceTypeName - The resource type name.
  • apiVersionName - The API version name.
  • options - APIVersionsClientBeginDeleteOptions contains the optional parameters for the APIVersionsClient.BeginDelete method.

func (*APIVersionsClient) Get added in v0.39.0 

func (client *APIVersionsClient) Get(ctx context.Context, planeName string, resourceProviderName string, resourceTypeName string, apiVersionName string, options *APIVersionsClientGetOptions) (APIVersionsClientGetResponse, error)

Get - Get the specified API version. If the operation fails it returns an *azcore.ResponseError type.

  • planeName - The plane name.
  • resourceProviderName - The resource provider name. This is also the resource provider namespace. Example: 'Applications.Datastores'.
  • resourceTypeName - The resource type name.
  • apiVersionName - The API version name.
  • options - APIVersionsClientGetOptions contains the optional parameters for the APIVersionsClient.Get method.

func (*APIVersionsClient) NewListPager added in v0.39.0 

func (client *APIVersionsClient) NewListPager(planeName string, resourceProviderName string, resourceTypeName string, options *APIVersionsClientListOptions) *runtime.Pager[APIVersionsClientListResponse]

NewListPager - List API versions.

  • planeName - The plane name.
  • resourceProviderName - The resource provider name. This is also the resource provider namespace. Example: 'Applications.Datastores'.
  • resourceTypeName - The resource type name.
  • options - APIVersionsClientListOptions contains the optional parameters for the APIVersionsClient.NewListPager method.

type APIVersionsClientBeginCreateOrUpdateOptions added in v0.39.0 

type APIVersionsClientBeginCreateOrUpdateOptions struct {
	// Resumes the long-running operation from the provided token.
	ResumeToken string
}

APIVersionsClientBeginCreateOrUpdateOptions contains the optional parameters for the APIVersionsClient.BeginCreateOrUpdate method.

type APIVersionsClientBeginDeleteOptions added in v0.39.0 

type APIVersionsClientBeginDeleteOptions struct {
	// Resumes the long-running operation from the provided token.
	ResumeToken string
}

APIVersionsClientBeginDeleteOptions contains the optional parameters for the APIVersionsClient.BeginDelete method.

type APIVersionsClientCreateOrUpdateResponse added in v0.39.0 

type APIVersionsClientCreateOrUpdateResponse struct {
	// The resource type for defining an API version of a resource type supported by the containing resource provider.
	APIVersionResource
}

APIVersionsClientCreateOrUpdateResponse contains the response from method APIVersionsClient.BeginCreateOrUpdate.

type APIVersionsClientDeleteResponse added in v0.39.0 

type APIVersionsClientDeleteResponse struct {
}

APIVersionsClientDeleteResponse contains the response from method APIVersionsClient.BeginDelete.

type APIVersionsClientGetOptions added in v0.39.0 

type APIVersionsClientGetOptions struct {
}

APIVersionsClientGetOptions contains the optional parameters for the APIVersionsClient.Get method.

type APIVersionsClientGetResponse added in v0.39.0 

type APIVersionsClientGetResponse struct {
	// The resource type for defining an API version of a resource type supported by the containing resource provider.
	APIVersionResource
}

APIVersionsClientGetResponse contains the response from method APIVersionsClient.Get.

type APIVersionsClientListOptions added in v0.39.0 

type APIVersionsClientListOptions struct {
}

APIVersionsClientListOptions contains the optional parameters for the APIVersionsClient.NewListPager method.

type APIVersionsClientListResponse added in v0.39.0 

type APIVersionsClientListResponse struct {
	// The response of a ApiVersionResource list operation.
	APIVersionResourceListResult
}

APIVersionsClientListResponse contains the response from method APIVersionsClient.NewListPager.

type AWSCredentialKind 

type AWSCredentialKind string

AWSCredentialKind - AWS credential kind 

const (
	// AWSCredentialKindAccessKey - The AWS Access Key credential
	AWSCredentialKindAccessKey AWSCredentialKind = "AccessKey"
	// AWSCredentialKindIRSA - AWS IAM roles for service accounts. For more information, please see: https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html
	AWSCredentialKindIRSA AWSCredentialKind = "IRSA"
)

func PossibleAWSCredentialKindValues 

func PossibleAWSCredentialKindValues() []AWSCredentialKind

PossibleAWSCredentialKindValues returns the possible values for the AWSCredentialKind const type.

type AwsAccessKeyCredentialProperties 

type AwsAccessKeyCredentialProperties struct {
	// REQUIRED; Access key ID for AWS identity
	AccessKeyID *string

	// CONSTANT; Access Key kind
	// Field has constant value AWSCredentialKindAccessKey, any specified value is ignored.
	Kind *AWSCredentialKind

	// REQUIRED; Secret Access Key for AWS identity
	SecretAccessKey *string

	// REQUIRED; The storage properties
	Storage CredentialStoragePropertiesClassification

	// READ-ONLY; The status of the asynchronous operation.
	ProvisioningState *ProvisioningState
}

AwsAccessKeyCredentialProperties - AWS credential properties for Access Key

func (*AwsAccessKeyCredentialProperties) GetAwsCredentialProperties 

func (a *AwsAccessKeyCredentialProperties) GetAwsCredentialProperties() *AwsCredentialProperties

GetAwsCredentialProperties implements the AwsCredentialPropertiesClassification interface for type AwsAccessKeyCredentialProperties.

func (AwsAccessKeyCredentialProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AwsAccessKeyCredentialProperties.

func (*AwsAccessKeyCredentialProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AwsAccessKeyCredentialProperties.

type AwsCredentialProperties 

type AwsCredentialProperties struct {
	// REQUIRED; The AWS credential kind
	Kind *AWSCredentialKind

	// READ-ONLY; The status of the asynchronous operation.
	ProvisioningState *ProvisioningState
}

AwsCredentialProperties - AWS Credential properties

func (*AwsCredentialProperties) GetAwsCredentialProperties 

func (a *AwsCredentialProperties) GetAwsCredentialProperties() *AwsCredentialProperties

GetAwsCredentialProperties implements the AwsCredentialPropertiesClassification interface for type AwsCredentialProperties.

func (AwsCredentialProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AwsCredentialProperties.

func (*AwsCredentialProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AwsCredentialProperties.

type AwsCredentialPropertiesClassification 

type AwsCredentialPropertiesClassification interface {
	// GetAwsCredentialProperties returns the AwsCredentialProperties content of the underlying type.
	GetAwsCredentialProperties() *AwsCredentialProperties
}

AwsCredentialPropertiesClassification provides polymorphic access to related types. Call the interface's GetAwsCredentialProperties() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AwsAccessKeyCredentialProperties, *AwsCredentialProperties, *AwsIRSACredentialProperties

type AwsCredentialResource 

type AwsCredentialResource struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// REQUIRED; The resource-specific properties for this resource.
	Properties AwsCredentialPropertiesClassification

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

AwsCredentialResource - Concrete tracked resource types can be created by aliasing this type using a specific property type.

func (*AwsCredentialResource) ConvertFrom 

func (dst *AwsCredentialResource) ConvertFrom(src v1.DataModelInterface) error

ConvertFrom converts from version-agnostic datamodel to the versioned Credential resource.

func (*AwsCredentialResource) ConvertTo 

func (cr *AwsCredentialResource) ConvertTo() (v1.DataModelInterface, error)

ConvertTo converts from the versioned Credential resource to version-agnostic datamodel.

func (AwsCredentialResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AwsCredentialResource.

func (*AwsCredentialResource) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AwsCredentialResource.

type AwsCredentialResourceListResult 

type AwsCredentialResourceListResult struct {
	// REQUIRED; The AwsCredentialResource items on this page
	Value []*AwsCredentialResource

	// The link to the next page of items
	NextLink *string
}

AwsCredentialResourceListResult - The response of a AwsCredentialResource list operation.

func (AwsCredentialResourceListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AwsCredentialResourceListResult.

func (*AwsCredentialResourceListResult) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AwsCredentialResourceListResult.

type AwsCredentialResourceTagsUpdate 

type AwsCredentialResourceTagsUpdate struct {
	// Resource tags.
	Tags map[string]*string
}

AwsCredentialResourceTagsUpdate - The type used for updating tags in AwsCredentialResource resources.

func (AwsCredentialResourceTagsUpdate) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AwsCredentialResourceTagsUpdate.

func (*AwsCredentialResourceTagsUpdate) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AwsCredentialResourceTagsUpdate.

type AwsCredentialsClient 

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

AwsCredentialsClient contains the methods for the AwsCredentials group. Don't use this type directly, use NewAwsCredentialsClient() instead.

Generated from API version 2023-10-01-preview

func NewAwsCredentialsClient 

func NewAwsCredentialsClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*AwsCredentialsClient, error)

NewAwsCredentialsClient creates a new instance of AwsCredentialsClient with the specified values.

  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - Contains optional client configuration. Pass nil to accept the default values.

func (*AwsCredentialsClient) CreateOrUpdate 

func (client *AwsCredentialsClient) CreateOrUpdate(ctx context.Context, planeName string, credentialName string, resource AwsCredentialResource, options *AwsCredentialsClientCreateOrUpdateOptions) (AwsCredentialsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create or update an AWS credential If the operation fails it returns an *azcore.ResponseError type.

  • planeName - The name of AWS plane
  • credentialName - The AWS credential name.
  • resource - Resource create parameters.
  • options - AwsCredentialsClientCreateOrUpdateOptions contains the optional parameters for the AwsCredentialsClient.CreateOrUpdate method.

func (*AwsCredentialsClient) Delete 

func (client *AwsCredentialsClient) Delete(ctx context.Context, planeName string, credentialName string, options *AwsCredentialsClientDeleteOptions) (AwsCredentialsClientDeleteResponse, error)

Delete - Delete an AWS credential If the operation fails it returns an *azcore.ResponseError type.

  • planeName - The name of AWS plane
  • credentialName - The AWS credential name.
  • options - AwsCredentialsClientDeleteOptions contains the optional parameters for the AwsCredentialsClient.Delete method.

func (*AwsCredentialsClient) Get 

func (client *AwsCredentialsClient) Get(ctx context.Context, planeName string, credentialName string, options *AwsCredentialsClientGetOptions) (AwsCredentialsClientGetResponse, error)

Get - Get an AWS credential If the operation fails it returns an *azcore.ResponseError type.

  • planeName - The name of AWS plane
  • credentialName - The AWS credential name.
  • options - AwsCredentialsClientGetOptions contains the optional parameters for the AwsCredentialsClient.Get method.

func (*AwsCredentialsClient) NewListPager 

func (client *AwsCredentialsClient) NewListPager(planeName string, options *AwsCredentialsClientListOptions) *runtime.Pager[AwsCredentialsClientListResponse]

NewListPager - List AWS credentials

  • planeName - The name of AWS plane
  • options - AwsCredentialsClientListOptions contains the optional parameters for the AwsCredentialsClient.NewListPager method.

func (*AwsCredentialsClient) Update 

func (client *AwsCredentialsClient) Update(ctx context.Context, planeName string, credentialName string, properties AwsCredentialResourceTagsUpdate, options *AwsCredentialsClientUpdateOptions) (AwsCredentialsClientUpdateResponse, error)

Update - Update an AWS credential If the operation fails it returns an *azcore.ResponseError type.

  • planeName - The name of AWS plane
  • credentialName - The AWS credential name.
  • properties - The resource properties to be updated.
  • options - AwsCredentialsClientUpdateOptions contains the optional parameters for the AwsCredentialsClient.Update method.

type AwsCredentialsClientCreateOrUpdateOptions 

type AwsCredentialsClientCreateOrUpdateOptions struct {
}

AwsCredentialsClientCreateOrUpdateOptions contains the optional parameters for the AwsCredentialsClient.CreateOrUpdate method.

type AwsCredentialsClientCreateOrUpdateResponse 

type AwsCredentialsClientCreateOrUpdateResponse struct {
	// Concrete tracked resource types can be created by aliasing this type using a specific property type.
	AwsCredentialResource
}

AwsCredentialsClientCreateOrUpdateResponse contains the response from method AwsCredentialsClient.CreateOrUpdate.

type AwsCredentialsClientDeleteOptions 

type AwsCredentialsClientDeleteOptions struct {
}

AwsCredentialsClientDeleteOptions contains the optional parameters for the AwsCredentialsClient.Delete method.

type AwsCredentialsClientDeleteResponse 

type AwsCredentialsClientDeleteResponse struct {
}

AwsCredentialsClientDeleteResponse contains the response from method AwsCredentialsClient.Delete.

type AwsCredentialsClientGetOptions 

type AwsCredentialsClientGetOptions struct {
}

AwsCredentialsClientGetOptions contains the optional parameters for the AwsCredentialsClient.Get method.

type AwsCredentialsClientGetResponse 

type AwsCredentialsClientGetResponse struct {
	// Concrete tracked resource types can be created by aliasing this type using a specific property type.
	AwsCredentialResource
}

AwsCredentialsClientGetResponse contains the response from method AwsCredentialsClient.Get.

type AwsCredentialsClientListOptions 

type AwsCredentialsClientListOptions struct {
}

AwsCredentialsClientListOptions contains the optional parameters for the AwsCredentialsClient.NewListPager method.

type AwsCredentialsClientListResponse 

type AwsCredentialsClientListResponse struct {
	// The response of a AwsCredentialResource list operation.
	AwsCredentialResourceListResult
}

AwsCredentialsClientListResponse contains the response from method AwsCredentialsClient.NewListPager.

type AwsCredentialsClientUpdateOptions 

type AwsCredentialsClientUpdateOptions struct {
}

AwsCredentialsClientUpdateOptions contains the optional parameters for the AwsCredentialsClient.Update method.

type AwsCredentialsClientUpdateResponse 

type AwsCredentialsClientUpdateResponse struct {
	// Concrete tracked resource types can be created by aliasing this type using a specific property type.
	AwsCredentialResource
}

AwsCredentialsClientUpdateResponse contains the response from method AwsCredentialsClient.Update.

type AwsIRSACredentialProperties added in v0.36.0 

type AwsIRSACredentialProperties struct {
	// CONSTANT; IRSA credential kind
	// Field has constant value AWSCredentialKindIRSA, any specified value is ignored.
	Kind *AWSCredentialKind

	// REQUIRED; RoleARN for AWS IRSA identity
	RoleARN *string

	// REQUIRED; The storage properties
	Storage CredentialStoragePropertiesClassification

	// READ-ONLY; The status of the asynchronous operation.
	ProvisioningState *ProvisioningState
}

AwsIRSACredentialProperties - AWS credential properties for IAM Roles for Service Accounts (IRSA)

func (*AwsIRSACredentialProperties) GetAwsCredentialProperties added in v0.36.0 

func (a *AwsIRSACredentialProperties) GetAwsCredentialProperties() *AwsCredentialProperties

GetAwsCredentialProperties implements the AwsCredentialPropertiesClassification interface for type AwsIRSACredentialProperties.

func (AwsIRSACredentialProperties) MarshalJSON added in v0.36.0 

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

MarshalJSON implements the json.Marshaller interface for type AwsIRSACredentialProperties.

func (*AwsIRSACredentialProperties) UnmarshalJSON added in v0.36.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AwsIRSACredentialProperties.

type AwsPlaneResource added in v0.34.0 

type AwsPlaneResource struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// REQUIRED; The resource-specific properties for this resource.
	Properties *AwsPlaneResourceProperties

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

AwsPlaneResource - The AWS plane resource

func (*AwsPlaneResource) ConvertFrom added in v0.34.0 

func (dst *AwsPlaneResource) ConvertFrom(src v1.DataModelInterface) error

ConvertFrom converts from version-agnostic datamodel to the versioned AWS Plane resource.

func (*AwsPlaneResource) ConvertTo added in v0.34.0 

func (src *AwsPlaneResource) ConvertTo() (v1.DataModelInterface, error)

ConvertTo converts from the versioned AWS Plane resource to version-agnostic datamodel.

func (AwsPlaneResource) MarshalJSON added in v0.34.0 

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

MarshalJSON implements the json.Marshaller interface for type AwsPlaneResource.

func (*AwsPlaneResource) UnmarshalJSON added in v0.34.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AwsPlaneResource.

type AwsPlaneResourceListResult added in v0.34.0 

type AwsPlaneResourceListResult struct {
	// REQUIRED; The AwsPlaneResource items on this page
	Value []*AwsPlaneResource

	// The link to the next page of items
	NextLink *string
}

AwsPlaneResourceListResult - The response of a AwsPlaneResource list operation.

func (AwsPlaneResourceListResult) MarshalJSON added in v0.34.0 

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

MarshalJSON implements the json.Marshaller interface for type AwsPlaneResourceListResult.

func (*AwsPlaneResourceListResult) UnmarshalJSON added in v0.34.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AwsPlaneResourceListResult.

type AwsPlaneResourceProperties added in v0.34.0 

type AwsPlaneResourceProperties struct {
	// READ-ONLY; The status of the asynchronous operation.
	ProvisioningState *ProvisioningState
}

AwsPlaneResourceProperties - The Plane properties.

func (AwsPlaneResourceProperties) MarshalJSON added in v0.34.0 

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

MarshalJSON implements the json.Marshaller interface for type AwsPlaneResourceProperties.

func (*AwsPlaneResourceProperties) UnmarshalJSON added in v0.34.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AwsPlaneResourceProperties.

type AwsPlaneResourceTagsUpdate added in v0.34.0 

type AwsPlaneResourceTagsUpdate struct {
	// Resource tags.
	Tags map[string]*string
}

AwsPlaneResourceTagsUpdate - The type used for updating tags in AwsPlaneResource resources.

func (AwsPlaneResourceTagsUpdate) MarshalJSON added in v0.34.0 

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

MarshalJSON implements the json.Marshaller interface for type AwsPlaneResourceTagsUpdate.

func (*AwsPlaneResourceTagsUpdate) UnmarshalJSON added in v0.34.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AwsPlaneResourceTagsUpdate.

type AwsPlanesClient added in v0.34.0 

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

AwsPlanesClient contains the methods for the AwsPlanes group. Don't use this type directly, use NewAwsPlanesClient() instead.

Generated from API version 2023-10-01-preview

func NewAwsPlanesClient added in v0.34.0 

func NewAwsPlanesClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*AwsPlanesClient, error)

NewAwsPlanesClient creates a new instance of AwsPlanesClient with the specified values.

  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - Contains optional client configuration. Pass nil to accept the default values.

func (*AwsPlanesClient) BeginCreateOrUpdate added in v0.34.0 

func (client *AwsPlanesClient) BeginCreateOrUpdate(ctx context.Context, planeName string, resource AwsPlaneResource, options *AwsPlanesClientBeginCreateOrUpdateOptions) (*runtime.Poller[AwsPlanesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create or update a plane If the operation fails it returns an *azcore.ResponseError type.

  • planeName - The plane name.
  • resource - Resource create parameters.
  • options - AwsPlanesClientBeginCreateOrUpdateOptions contains the optional parameters for the AwsPlanesClient.BeginCreateOrUpdate method.

func (*AwsPlanesClient) BeginDelete added in v0.34.0 

func (client *AwsPlanesClient) BeginDelete(ctx context.Context, planeName string, options *AwsPlanesClientBeginDeleteOptions) (*runtime.Poller[AwsPlanesClientDeleteResponse], error)

BeginDelete - Delete a plane If the operation fails it returns an *azcore.ResponseError type.

  • planeName - The plane name.
  • options - AwsPlanesClientBeginDeleteOptions contains the optional parameters for the AwsPlanesClient.BeginDelete method.

func (*AwsPlanesClient) BeginUpdate added in v0.34.0 

func (client *AwsPlanesClient) BeginUpdate(ctx context.Context, planeName string, properties AwsPlaneResourceTagsUpdate, options *AwsPlanesClientBeginUpdateOptions) (*runtime.Poller[AwsPlanesClientUpdateResponse], error)

BeginUpdate - Update a plane If the operation fails it returns an *azcore.ResponseError type.

  • planeName - The plane name.
  • properties - The resource properties to be updated.
  • options - AwsPlanesClientBeginUpdateOptions contains the optional parameters for the AwsPlanesClient.BeginUpdate method.

func (*AwsPlanesClient) Get added in v0.34.0 

func (client *AwsPlanesClient) Get(ctx context.Context, planeName string, options *AwsPlanesClientGetOptions) (AwsPlanesClientGetResponse, error)

Get - Get a plane by name If the operation fails it returns an *azcore.ResponseError type.

  • planeName - The plane name.
  • options - AwsPlanesClientGetOptions contains the optional parameters for the AwsPlanesClient.Get method.

func (*AwsPlanesClient) NewListPager added in v0.34.0 

func (client *AwsPlanesClient) NewListPager(options *AwsPlanesClientListOptions) *runtime.Pager[AwsPlanesClientListResponse]

NewListPager - List AWS planes

  • options - AwsPlanesClientListOptions contains the optional parameters for the AwsPlanesClient.NewListPager method.

type AwsPlanesClientBeginCreateOrUpdateOptions added in v0.34.0 

type AwsPlanesClientBeginCreateOrUpdateOptions struct {
	// Resumes the long-running operation from the provided token.
	ResumeToken string
}

AwsPlanesClientBeginCreateOrUpdateOptions contains the optional parameters for the AwsPlanesClient.BeginCreateOrUpdate method.

type AwsPlanesClientBeginDeleteOptions added in v0.34.0 

type AwsPlanesClientBeginDeleteOptions struct {
	// Resumes the long-running operation from the provided token.
	ResumeToken string
}

AwsPlanesClientBeginDeleteOptions contains the optional parameters for the AwsPlanesClient.BeginDelete method.

type AwsPlanesClientBeginUpdateOptions added in v0.34.0 

type AwsPlanesClientBeginUpdateOptions struct {
	// Resumes the long-running operation from the provided token.
	ResumeToken string
}

AwsPlanesClientBeginUpdateOptions contains the optional parameters for the AwsPlanesClient.BeginUpdate method.

type AwsPlanesClientCreateOrUpdateResponse added in v0.34.0 

type AwsPlanesClientCreateOrUpdateResponse struct {
	// The AWS plane resource
	AwsPlaneResource
}

AwsPlanesClientCreateOrUpdateResponse contains the response from method AwsPlanesClient.BeginCreateOrUpdate.

type AwsPlanesClientDeleteResponse added in v0.34.0 

type AwsPlanesClientDeleteResponse struct {
}

AwsPlanesClientDeleteResponse contains the response from method AwsPlanesClient.BeginDelete.

type AwsPlanesClientGetOptions added in v0.34.0 

type AwsPlanesClientGetOptions struct {
}

AwsPlanesClientGetOptions contains the optional parameters for the AwsPlanesClient.Get method.

type AwsPlanesClientGetResponse added in v0.34.0 

type AwsPlanesClientGetResponse struct {
	// The AWS plane resource
	AwsPlaneResource
}

AwsPlanesClientGetResponse contains the response from method AwsPlanesClient.Get.

type AwsPlanesClientListOptions added in v0.34.0 

type AwsPlanesClientListOptions struct {
}

AwsPlanesClientListOptions contains the optional parameters for the AwsPlanesClient.NewListPager method.

type AwsPlanesClientListResponse added in v0.34.0 

type AwsPlanesClientListResponse struct {
	// The response of a AwsPlaneResource list operation.
	AwsPlaneResourceListResult
}

AwsPlanesClientListResponse contains the response from method AwsPlanesClient.NewListPager.

type AwsPlanesClientUpdateResponse added in v0.34.0 

type AwsPlanesClientUpdateResponse struct {
}

AwsPlanesClientUpdateResponse contains the response from method AwsPlanesClient.BeginUpdate.

type AzureCredentialKind 

type AzureCredentialKind string

AzureCredentialKind - Azure credential kinds supported. 

const (
	// AzureCredentialKindServicePrincipal - The Service Principal Credential
	AzureCredentialKindServicePrincipal AzureCredentialKind = "ServicePrincipal"
	// AzureCredentialKindWorkloadIdentity - The Workload Identity Credential
	AzureCredentialKindWorkloadIdentity AzureCredentialKind = "WorkloadIdentity"
)

func PossibleAzureCredentialKindValues 

func PossibleAzureCredentialKindValues() []AzureCredentialKind

PossibleAzureCredentialKindValues returns the possible values for the AzureCredentialKind const type.

type AzureCredentialProperties 

type AzureCredentialProperties struct {
	// REQUIRED; The kind of Azure credential
	Kind *AzureCredentialKind

	// READ-ONLY; The status of the asynchronous operation.
	ProvisioningState *ProvisioningState
}

AzureCredentialProperties - The base properties of Azure Credential

func (*AzureCredentialProperties) GetAzureCredentialProperties 

func (a *AzureCredentialProperties) GetAzureCredentialProperties() *AzureCredentialProperties

GetAzureCredentialProperties implements the AzureCredentialPropertiesClassification interface for type AzureCredentialProperties.

func (AzureCredentialProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AzureCredentialProperties.

func (*AzureCredentialProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AzureCredentialProperties.

type AzureCredentialPropertiesClassification 

type AzureCredentialPropertiesClassification interface {
	// GetAzureCredentialProperties returns the AzureCredentialProperties content of the underlying type.
	GetAzureCredentialProperties() *AzureCredentialProperties
}

AzureCredentialPropertiesClassification provides polymorphic access to related types. Call the interface's GetAzureCredentialProperties() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AzureCredentialProperties, *AzureServicePrincipalProperties, *AzureWorkloadIdentityProperties

type AzureCredentialResource 

type AzureCredentialResource struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// REQUIRED; The resource-specific properties for this resource.
	Properties AzureCredentialPropertiesClassification

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

AzureCredentialResource - Represents Azure Credential Resource

func (*AzureCredentialResource) ConvertFrom 

func (dst *AzureCredentialResource) ConvertFrom(src v1.DataModelInterface) error

ConvertFrom converts from version-agnostic datamodel to the versioned Credential resource.

func (*AzureCredentialResource) ConvertTo 

func (cr *AzureCredentialResource) ConvertTo() (v1.DataModelInterface, error)

ConvertTo converts from the versioned Credential resource to version-agnostic datamodel.

func (AzureCredentialResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AzureCredentialResource.

func (*AzureCredentialResource) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AzureCredentialResource.

type AzureCredentialResourceListResult 

type AzureCredentialResourceListResult struct {
	// REQUIRED; The AzureCredentialResource items on this page
	Value []*AzureCredentialResource

	// The link to the next page of items
	NextLink *string
}

AzureCredentialResourceListResult - The response of a AzureCredentialResource list operation.

func (AzureCredentialResourceListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AzureCredentialResourceListResult.

func (*AzureCredentialResourceListResult) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AzureCredentialResourceListResult.

type AzureCredentialResourceTagsUpdate 

type AzureCredentialResourceTagsUpdate struct {
	// Resource tags.
	Tags map[string]*string
}

AzureCredentialResourceTagsUpdate - The type used for updating tags in AzureCredentialResource resources.

func (AzureCredentialResourceTagsUpdate) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AzureCredentialResourceTagsUpdate.

func (*AzureCredentialResourceTagsUpdate) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AzureCredentialResourceTagsUpdate.

type AzureCredentialsClient 

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

AzureCredentialsClient contains the methods for the AzureCredentials group. Don't use this type directly, use NewAzureCredentialsClient() instead.

Generated from API version 2023-10-01-preview

func NewAzureCredentialsClient 

func NewAzureCredentialsClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*AzureCredentialsClient, error)

NewAzureCredentialsClient creates a new instance of AzureCredentialsClient with the specified values.

  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - Contains optional client configuration. Pass nil to accept the default values.

func (*AzureCredentialsClient) CreateOrUpdate 

func (client *AzureCredentialsClient) CreateOrUpdate(ctx context.Context, planeName string, credentialName string, resource AzureCredentialResource, options *AzureCredentialsClientCreateOrUpdateOptions) (AzureCredentialsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create or update an Azure credential If the operation fails it returns an *azcore.ResponseError type.

  • planeName - The name of the plane
  • credentialName - The Azure credential name.
  • resource - Resource create parameters.
  • options - AzureCredentialsClientCreateOrUpdateOptions contains the optional parameters for the AzureCredentialsClient.CreateOrUpdate method.

func (*AzureCredentialsClient) Delete 

func (client *AzureCredentialsClient) Delete(ctx context.Context, planeName string, credentialName string, options *AzureCredentialsClientDeleteOptions) (AzureCredentialsClientDeleteResponse, error)

Delete - Delete an Azure credential If the operation fails it returns an *azcore.ResponseError type.

  • planeName - The name of the plane
  • credentialName - The Azure credential name.
  • options - AzureCredentialsClientDeleteOptions contains the optional parameters for the AzureCredentialsClient.Delete method.

func (*AzureCredentialsClient) Get 

func (client *AzureCredentialsClient) Get(ctx context.Context, planeName string, credentialName string, options *AzureCredentialsClientGetOptions) (AzureCredentialsClientGetResponse, error)

Get - Get an Azure credential If the operation fails it returns an *azcore.ResponseError type.

  • planeName - The name of the plane
  • credentialName - The Azure credential name.
  • options - AzureCredentialsClientGetOptions contains the optional parameters for the AzureCredentialsClient.Get method.

func (*AzureCredentialsClient) NewListPager 

func (client *AzureCredentialsClient) NewListPager(planeName string, options *AzureCredentialsClientListOptions) *runtime.Pager[AzureCredentialsClientListResponse]

NewListPager - List Azure credentials

  • planeName - The name of the plane
  • options - AzureCredentialsClientListOptions contains the optional parameters for the AzureCredentialsClient.NewListPager method.

func (*AzureCredentialsClient) Update 

func (client *AzureCredentialsClient) Update(ctx context.Context, planeName string, credentialName string, properties AzureCredentialResourceTagsUpdate, options *AzureCredentialsClientUpdateOptions) (AzureCredentialsClientUpdateResponse, error)

Update - Update an Azure credential If the operation fails it returns an *azcore.ResponseError type.

  • planeName - The name of the plane
  • credentialName - The Azure credential name.
  • properties - The resource properties to be updated.
  • options - AzureCredentialsClientUpdateOptions contains the optional parameters for the AzureCredentialsClient.Update method.

type AzureCredentialsClientCreateOrUpdateOptions 

type AzureCredentialsClientCreateOrUpdateOptions struct {
}

AzureCredentialsClientCreateOrUpdateOptions contains the optional parameters for the AzureCredentialsClient.CreateOrUpdate method.

type AzureCredentialsClientCreateOrUpdateResponse 

type AzureCredentialsClientCreateOrUpdateResponse struct {
	// Represents Azure Credential Resource
	AzureCredentialResource
}

AzureCredentialsClientCreateOrUpdateResponse contains the response from method AzureCredentialsClient.CreateOrUpdate.

type AzureCredentialsClientDeleteOptions 

type AzureCredentialsClientDeleteOptions struct {
}

AzureCredentialsClientDeleteOptions contains the optional parameters for the AzureCredentialsClient.Delete method.

type AzureCredentialsClientDeleteResponse 

type AzureCredentialsClientDeleteResponse struct {
}

AzureCredentialsClientDeleteResponse contains the response from method AzureCredentialsClient.Delete.

type AzureCredentialsClientGetOptions 

type AzureCredentialsClientGetOptions struct {
}

AzureCredentialsClientGetOptions contains the optional parameters for the AzureCredentialsClient.Get method.

type AzureCredentialsClientGetResponse 

type AzureCredentialsClientGetResponse struct {
	// Represents Azure Credential Resource
	AzureCredentialResource
}

AzureCredentialsClientGetResponse contains the response from method AzureCredentialsClient.Get.

type AzureCredentialsClientListOptions 

type AzureCredentialsClientListOptions struct {
}

AzureCredentialsClientListOptions contains the optional parameters for the AzureCredentialsClient.NewListPager method.

type AzureCredentialsClientListResponse 

type AzureCredentialsClientListResponse struct {
	// The response of a AzureCredentialResource list operation.
	AzureCredentialResourceListResult
}

AzureCredentialsClientListResponse contains the response from method AzureCredentialsClient.NewListPager.

type AzureCredentialsClientUpdateOptions 

type AzureCredentialsClientUpdateOptions struct {
}

AzureCredentialsClientUpdateOptions contains the optional parameters for the AzureCredentialsClient.Update method.

type AzureCredentialsClientUpdateResponse 

type AzureCredentialsClientUpdateResponse struct {
	// Represents Azure Credential Resource
	AzureCredentialResource
}

AzureCredentialsClientUpdateResponse contains the response from method AzureCredentialsClient.Update.

type AzurePlaneResource added in v0.34.0 

type AzurePlaneResource struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// REQUIRED; The resource-specific properties for this resource.
	Properties *AzurePlaneResourceProperties

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

AzurePlaneResource - The Azure plane resource.

func (*AzurePlaneResource) ConvertFrom added in v0.34.0 

func (dst *AzurePlaneResource) ConvertFrom(src v1.DataModelInterface) error

ConvertFrom converts from version-agnostic datamodel to the versioned Azure Plane resource.

func (*AzurePlaneResource) ConvertTo added in v0.34.0 

func (src *AzurePlaneResource) ConvertTo() (v1.DataModelInterface, error)

ConvertTo converts from the versioned Azure Plane resource to version-agnostic datamodel.

func (AzurePlaneResource) MarshalJSON added in v0.34.0 

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

MarshalJSON implements the json.Marshaller interface for type AzurePlaneResource.

func (*AzurePlaneResource) UnmarshalJSON added in v0.34.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AzurePlaneResource.

type AzurePlaneResourceListResult added in v0.34.0 

type AzurePlaneResourceListResult struct {
	// REQUIRED; The AzurePlaneResource items on this page
	Value []*AzurePlaneResource

	// The link to the next page of items
	NextLink *string
}

AzurePlaneResourceListResult - The response of a AzurePlaneResource list operation.

func (AzurePlaneResourceListResult) MarshalJSON added in v0.34.0 

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

MarshalJSON implements the json.Marshaller interface for type AzurePlaneResourceListResult.

func (*AzurePlaneResourceListResult) UnmarshalJSON added in v0.34.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AzurePlaneResourceListResult.

type AzurePlaneResourceProperties added in v0.34.0 

type AzurePlaneResourceProperties struct {
	// REQUIRED; The URL used to proxy requests.
	URL *string

	// READ-ONLY; The status of the asynchronous operation.
	ProvisioningState *ProvisioningState
}

AzurePlaneResourceProperties - The Plane properties.

func (AzurePlaneResourceProperties) MarshalJSON added in v0.34.0 

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

MarshalJSON implements the json.Marshaller interface for type AzurePlaneResourceProperties.

func (*AzurePlaneResourceProperties) UnmarshalJSON added in v0.34.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AzurePlaneResourceProperties.

type AzurePlaneResourceTagsUpdate added in v0.34.0 

type AzurePlaneResourceTagsUpdate struct {
	// Resource tags.
	Tags map[string]*string
}

AzurePlaneResourceTagsUpdate - The type used for updating tags in AzurePlaneResource resources.

func (AzurePlaneResourceTagsUpdate) MarshalJSON added in v0.34.0 

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

MarshalJSON implements the json.Marshaller interface for type AzurePlaneResourceTagsUpdate.

func (*AzurePlaneResourceTagsUpdate) UnmarshalJSON added in v0.34.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AzurePlaneResourceTagsUpdate.

type AzurePlanesClient added in v0.34.0 

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

AzurePlanesClient contains the methods for the AzurePlanes group. Don't use this type directly, use NewAzurePlanesClient() instead.

Generated from API version 2023-10-01-preview

func NewAzurePlanesClient added in v0.34.0 

func NewAzurePlanesClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*AzurePlanesClient, error)

NewAzurePlanesClient creates a new instance of AzurePlanesClient with the specified values.

  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - Contains optional client configuration. Pass nil to accept the default values.

func (*AzurePlanesClient) BeginCreateOrUpdate added in v0.34.0 

func (client *AzurePlanesClient) BeginCreateOrUpdate(ctx context.Context, planeName string, resource AzurePlaneResource, options *AzurePlanesClientBeginCreateOrUpdateOptions) (*runtime.Poller[AzurePlanesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create or update a plane If the operation fails it returns an *azcore.ResponseError type.

  • planeName - The plane name.
  • resource - Resource create parameters.
  • options - AzurePlanesClientBeginCreateOrUpdateOptions contains the optional parameters for the AzurePlanesClient.BeginCreateOrUpdate method.

func (*AzurePlanesClient) BeginDelete added in v0.34.0 

func (client *AzurePlanesClient) BeginDelete(ctx context.Context, planeName string, options *AzurePlanesClientBeginDeleteOptions) (*runtime.Poller[AzurePlanesClientDeleteResponse], error)

BeginDelete - Delete a plane If the operation fails it returns an *azcore.ResponseError type.

  • planeName - The plane name.
  • options - AzurePlanesClientBeginDeleteOptions contains the optional parameters for the AzurePlanesClient.BeginDelete method.

func (*AzurePlanesClient) BeginUpdate added in v0.34.0 

func (client *AzurePlanesClient) BeginUpdate(ctx context.Context, planeName string, properties AzurePlaneResourceTagsUpdate, options *AzurePlanesClientBeginUpdateOptions) (*runtime.Poller[AzurePlanesClientUpdateResponse], error)

BeginUpdate - Update a plane If the operation fails it returns an *azcore.ResponseError type.

  • planeName - The plane name.
  • properties - The resource properties to be updated.
  • options - AzurePlanesClientBeginUpdateOptions contains the optional parameters for the AzurePlanesClient.BeginUpdate method.

func (*AzurePlanesClient) Get added in v0.34.0 

func (client *AzurePlanesClient) Get(ctx context.Context, planeName string, options *AzurePlanesClientGetOptions) (AzurePlanesClientGetResponse, error)

Get - Get a plane by name If the operation fails it returns an *azcore.ResponseError type.

  • planeName - The plane name.
  • options - AzurePlanesClientGetOptions contains the optional parameters for the AzurePlanesClient.Get method.

func (*AzurePlanesClient) NewListPager added in v0.34.0 

func (client *AzurePlanesClient) NewListPager(options *AzurePlanesClientListOptions) *runtime.Pager[AzurePlanesClientListResponse]

NewListPager - List azure planes

  • options - AzurePlanesClientListOptions contains the optional parameters for the AzurePlanesClient.NewListPager method.

type AzurePlanesClientBeginCreateOrUpdateOptions added in v0.34.0 

type AzurePlanesClientBeginCreateOrUpdateOptions struct {
	// Resumes the long-running operation from the provided token.
	ResumeToken string
}

AzurePlanesClientBeginCreateOrUpdateOptions contains the optional parameters for the AzurePlanesClient.BeginCreateOrUpdate method.

type AzurePlanesClientBeginDeleteOptions added in v0.34.0 

type AzurePlanesClientBeginDeleteOptions struct {
	// Resumes the long-running operation from the provided token.
	ResumeToken string
}

AzurePlanesClientBeginDeleteOptions contains the optional parameters for the AzurePlanesClient.BeginDelete method.

type AzurePlanesClientBeginUpdateOptions added in v0.34.0 

type AzurePlanesClientBeginUpdateOptions struct {
	// Resumes the long-running operation from the provided token.
	ResumeToken string
}

AzurePlanesClientBeginUpdateOptions contains the optional parameters for the AzurePlanesClient.BeginUpdate method.

type AzurePlanesClientCreateOrUpdateResponse added in v0.34.0 

type AzurePlanesClientCreateOrUpdateResponse struct {
	// The Azure plane resource.
	AzurePlaneResource
}

AzurePlanesClientCreateOrUpdateResponse contains the response from method AzurePlanesClient.BeginCreateOrUpdate.

type AzurePlanesClientDeleteResponse added in v0.34.0 

type AzurePlanesClientDeleteResponse struct {
}

AzurePlanesClientDeleteResponse contains the response from method AzurePlanesClient.BeginDelete.

type AzurePlanesClientGetOptions added in v0.34.0 

type AzurePlanesClientGetOptions struct {
}

AzurePlanesClientGetOptions contains the optional parameters for the AzurePlanesClient.Get method.

type AzurePlanesClientGetResponse added in v0.34.0 

type AzurePlanesClientGetResponse struct {
	// The Azure plane resource.
	AzurePlaneResource
}

AzurePlanesClientGetResponse contains the response from method AzurePlanesClient.Get.

type AzurePlanesClientListOptions added in v0.34.0 

type AzurePlanesClientListOptions struct {
}

AzurePlanesClientListOptions contains the optional parameters for the AzurePlanesClient.NewListPager method.

type AzurePlanesClientListResponse added in v0.34.0 

type AzurePlanesClientListResponse struct {
	// The response of a AzurePlaneResource list operation.
	AzurePlaneResourceListResult
}

AzurePlanesClientListResponse contains the response from method AzurePlanesClient.NewListPager.

type AzurePlanesClientUpdateResponse added in v0.34.0 

type AzurePlanesClientUpdateResponse struct {
}

AzurePlanesClientUpdateResponse contains the response from method AzurePlanesClient.BeginUpdate.

type AzureServicePrincipalProperties 

type AzureServicePrincipalProperties struct {
	// REQUIRED; clientId for ServicePrincipal
	ClientID *string

	// REQUIRED; secret for ServicePrincipal
	ClientSecret *string

	// CONSTANT; Service Principal kind
	// Field has constant value AzureCredentialKindServicePrincipal, any specified value is ignored.
	Kind *AzureCredentialKind

	// REQUIRED; The storage properties
	Storage CredentialStoragePropertiesClassification

	// REQUIRED; tenantId for ServicePrincipal
	TenantID *string

	// READ-ONLY; The status of the asynchronous operation.
	ProvisioningState *ProvisioningState
}

AzureServicePrincipalProperties - The properties of Azure Service Principal credential storage

func (*AzureServicePrincipalProperties) GetAzureCredentialProperties 

func (a *AzureServicePrincipalProperties) GetAzureCredentialProperties() *AzureCredentialProperties

GetAzureCredentialProperties implements the AzureCredentialPropertiesClassification interface for type AzureServicePrincipalProperties.

func (AzureServicePrincipalProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AzureServicePrincipalProperties.

func (*AzureServicePrincipalProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AzureServicePrincipalProperties.

type AzureWorkloadIdentityProperties added in v0.35.0 

type AzureWorkloadIdentityProperties struct {
	// REQUIRED; clientId for WorkloadIdentity
	ClientID *string

	// CONSTANT; Workload Identity kind
	// Field has constant value AzureCredentialKindWorkloadIdentity, any specified value is ignored.
	Kind *AzureCredentialKind

	// REQUIRED; The storage properties
	Storage CredentialStoragePropertiesClassification

	// REQUIRED; tenantId for WorkloadIdentity
	TenantID *string

	// READ-ONLY; The status of the asynchronous operation.
	ProvisioningState *ProvisioningState
}

AzureWorkloadIdentityProperties - The properties of Azure Workload Identity credential storage

func (*AzureWorkloadIdentityProperties) GetAzureCredentialProperties added in v0.35.0 

func (a *AzureWorkloadIdentityProperties) GetAzureCredentialProperties() *AzureCredentialProperties

GetAzureCredentialProperties implements the AzureCredentialPropertiesClassification interface for type AzureWorkloadIdentityProperties.

func (AzureWorkloadIdentityProperties) MarshalJSON added in v0.35.0 

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

MarshalJSON implements the json.Marshaller interface for type AzureWorkloadIdentityProperties.

func (*AzureWorkloadIdentityProperties) UnmarshalJSON added in v0.35.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AzureWorkloadIdentityProperties.

type ClientFactory 

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

ClientFactory is a client factory used to create any client in this module. Don't use this type directly, use NewClientFactory instead.

func NewClientFactory 

func NewClientFactory(credential azcore.TokenCredential, options *arm.ClientOptions) (*ClientFactory, error)

NewClientFactory creates a new instance of ClientFactory with the specified values. The parameter values will be propagated to any client created from this factory.

  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ClientFactory) NewAPIVersionsClient added in v0.39.0 

func (c *ClientFactory) NewAPIVersionsClient() *APIVersionsClient

NewAPIVersionsClient creates a new instance of APIVersionsClient.

func (*ClientFactory) NewAwsCredentialsClient 

func (c *ClientFactory) NewAwsCredentialsClient() *AwsCredentialsClient

NewAwsCredentialsClient creates a new instance of AwsCredentialsClient.

func (*ClientFactory) NewAwsPlanesClient added in v0.34.0 

func (c *ClientFactory) NewAwsPlanesClient() *AwsPlanesClient

NewAwsPlanesClient creates a new instance of AwsPlanesClient.

func (*ClientFactory) NewAzureCredentialsClient 

func (c *ClientFactory) NewAzureCredentialsClient() *AzureCredentialsClient

NewAzureCredentialsClient creates a new instance of AzureCredentialsClient.

func (*ClientFactory) NewAzurePlanesClient added in v0.34.0 

func (c *ClientFactory) NewAzurePlanesClient() *AzurePlanesClient

NewAzurePlanesClient creates a new instance of AzurePlanesClient.

func (*ClientFactory) NewLocationsClient added in v0.39.0 

func (c *ClientFactory) NewLocationsClient() *LocationsClient

NewLocationsClient creates a new instance of LocationsClient.

func (*ClientFactory) NewPlanesClient 

func (c *ClientFactory) NewPlanesClient() *PlanesClient

NewPlanesClient creates a new instance of PlanesClient.

func (*ClientFactory) NewRadiusPlanesClient added in v0.34.0 

func (c *ClientFactory) NewRadiusPlanesClient() *RadiusPlanesClient

NewRadiusPlanesClient creates a new instance of RadiusPlanesClient.

func (*ClientFactory) NewResourceGroupsClient 

func (c *ClientFactory) NewResourceGroupsClient() *ResourceGroupsClient

NewResourceGroupsClient creates a new instance of ResourceGroupsClient.

func (*ClientFactory) NewResourceProvidersClient added in v0.39.0 

func (c *ClientFactory) NewResourceProvidersClient() *ResourceProvidersClient

NewResourceProvidersClient creates a new instance of ResourceProvidersClient.

func (*ClientFactory) NewResourceTypesClient added in v0.39.0 

func (c *ClientFactory) NewResourceTypesClient() *ResourceTypesClient

NewResourceTypesClient creates a new instance of ResourceTypesClient.

func (*ClientFactory) NewResourcesClient 

func (c *ClientFactory) NewResourcesClient() *ResourcesClient

NewResourcesClient creates a new instance of ResourcesClient.

type CreatedByType 

type CreatedByType string

CreatedByType - The kind of entity that created the resource. 

const (
	// CreatedByTypeApplication - The entity was created by an application.
	CreatedByTypeApplication CreatedByType = "Application"
	// CreatedByTypeKey - The entity was created by a key.
	CreatedByTypeKey CreatedByType = "Key"
	// CreatedByTypeManagedIdentity - The entity was created by a managed identity.
	CreatedByTypeManagedIdentity CreatedByType = "ManagedIdentity"
	// CreatedByTypeUser - The entity was created by a user.
	CreatedByTypeUser CreatedByType = "User"
)

func PossibleCreatedByTypeValues 

func PossibleCreatedByTypeValues() []CreatedByType

PossibleCreatedByTypeValues returns the possible values for the CreatedByType const type.

type CredentialStorageKind 

type CredentialStorageKind string

CredentialStorageKind - Credential store kinds supported. 

const (
	// CredentialStorageKindInternal - Internal credential storage
	CredentialStorageKindInternal CredentialStorageKind = "Internal"
	CredentialStorageKindString   CredentialStorageKind = "string"
)

func PossibleCredentialStorageKindValues 

func PossibleCredentialStorageKindValues() []CredentialStorageKind

PossibleCredentialStorageKindValues returns the possible values for the CredentialStorageKind const type.

type CredentialStorageProperties 

type CredentialStorageProperties struct {
	// REQUIRED; The kind of credential storage
	Kind *CredentialStorageKind
}

CredentialStorageProperties - The base credential storage properties

func (*CredentialStorageProperties) GetCredentialStorageProperties 

func (c *CredentialStorageProperties) GetCredentialStorageProperties() *CredentialStorageProperties

GetCredentialStorageProperties implements the CredentialStoragePropertiesClassification interface for type CredentialStorageProperties.

func (CredentialStorageProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CredentialStorageProperties.

func (*CredentialStorageProperties) UnmarshalJSON 

func (c *CredentialStorageProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CredentialStorageProperties.

type CredentialStoragePropertiesClassification 

type CredentialStoragePropertiesClassification interface {
	// GetCredentialStorageProperties returns the CredentialStorageProperties content of the underlying type.
	GetCredentialStorageProperties() *CredentialStorageProperties
}

CredentialStoragePropertiesClassification provides polymorphic access to related types. Call the interface's GetCredentialStorageProperties() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *CredentialStorageProperties, *InternalCredentialStorageProperties

type GenericPlaneResource added in v0.34.0 

type GenericPlaneResource struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// REQUIRED; The resource-specific properties for this resource.
	Properties *GenericPlaneResourceProperties

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

GenericPlaneResource - The generic representation of a plane resource

func (*GenericPlaneResource) ConvertFrom added in v0.34.0 

func (dst *GenericPlaneResource) ConvertFrom(src v1.DataModelInterface) error

ConvertFrom converts from version-agnostic datamodel to the versioned generic Plane resource.

func (*GenericPlaneResource) ConvertTo added in v0.34.0 

func (src *GenericPlaneResource) ConvertTo() (v1.DataModelInterface, error)

ConvertTo converts from the versioned generic Plane resource to version-agnostic datamodel.

func (GenericPlaneResource) MarshalJSON added in v0.34.0 

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

MarshalJSON implements the json.Marshaller interface for type GenericPlaneResource.

func (*GenericPlaneResource) UnmarshalJSON added in v0.34.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type GenericPlaneResource.

type GenericPlaneResourceListResult added in v0.34.0 

type GenericPlaneResourceListResult struct {
	// REQUIRED; The GenericPlaneResource items on this page
	Value []*GenericPlaneResource

	// The link to the next page of items
	NextLink *string
}

GenericPlaneResourceListResult - The response of a GenericPlaneResource list operation.

func (GenericPlaneResourceListResult) MarshalJSON added in v0.34.0 

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

MarshalJSON implements the json.Marshaller interface for type GenericPlaneResourceListResult.

func (*GenericPlaneResourceListResult) UnmarshalJSON added in v0.34.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type GenericPlaneResourceListResult.

type GenericPlaneResourceProperties added in v0.34.0 

type GenericPlaneResourceProperties struct {
	// READ-ONLY; The status of the asynchronous operation.
	ProvisioningState *ProvisioningState
}

GenericPlaneResourceProperties - The properties of the generic representation of a plane resource.

func (GenericPlaneResourceProperties) MarshalJSON added in v0.34.0 

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

MarshalJSON implements the json.Marshaller interface for type GenericPlaneResourceProperties.

func (*GenericPlaneResourceProperties) UnmarshalJSON added in v0.34.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type GenericPlaneResourceProperties.

type GenericResource 

type GenericResource struct {
	// The resource-specific properties for this resource.
	Properties *ResourceProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

GenericResource - Represents resource data.

func (*GenericResource) ConvertFrom 

func (dst *GenericResource) ConvertFrom(src v1.DataModelInterface) error

ConvertFrom converts from version-agnostic datamodel to the versioned GenericResource resource.

func (*GenericResource) ConvertTo 

func (src *GenericResource) ConvertTo() (v1.DataModelInterface, error)

ConvertTo converts from the versioned GenericResource resource to version-agnostic datamodel.

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 GenericResourceListResult 

type GenericResourceListResult struct {
	// REQUIRED; The GenericResource items on this page
	Value []*GenericResource

	// The link to the next page of items
	NextLink *string
}

GenericResourceListResult - The response of a GenericResource list operation.

func (GenericResourceListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type GenericResourceListResult.

func (*GenericResourceListResult) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type GenericResourceListResult.

type InternalCredentialStorageProperties 

type InternalCredentialStorageProperties struct {
	// CONSTANT; Internal credential storage kind
	// Field has constant value CredentialStorageKindInternal, any specified value is ignored.
	Kind *CredentialStorageKind

	// READ-ONLY; The name of secret stored.
	SecretName *string
}

InternalCredentialStorageProperties - Internal credential storage properties

func (*InternalCredentialStorageProperties) GetCredentialStorageProperties 

func (i *InternalCredentialStorageProperties) GetCredentialStorageProperties() *CredentialStorageProperties

GetCredentialStorageProperties implements the CredentialStoragePropertiesClassification interface for type InternalCredentialStorageProperties.

func (InternalCredentialStorageProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type InternalCredentialStorageProperties.

func (*InternalCredentialStorageProperties) UnmarshalJSON 

func (i *InternalCredentialStorageProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InternalCredentialStorageProperties.

type LocationProperties added in v0.39.0 

type LocationProperties struct {
	// Address of a resource provider implementation.
	Address *string

	// Configuration for resource types supported by the location.
	ResourceTypes map[string]*LocationResourceType

	// READ-ONLY; The status of the asynchronous operation.
	ProvisioningState *ProvisioningState
}

LocationProperties - The properties of a location.

func (LocationProperties) MarshalJSON added in v0.39.0 

func (l LocationProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LocationProperties.

func (*LocationProperties) UnmarshalJSON added in v0.39.0 

func (l *LocationProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LocationProperties.

type LocationResource added in v0.39.0 

type LocationResource struct {
	// The resource-specific properties for this resource.
	Properties *LocationProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

LocationResource - The resource type for defining a location of the containing resource provider. The location resource represents a logical location where the resource provider operates.

func (*LocationResource) ConvertFrom added in v0.39.0 

func (dst *LocationResource) ConvertFrom(src v1.DataModelInterface) error

ConvertFrom converts from version-agnostic datamodel to the versioned LocationResource resource.

func (*LocationResource) ConvertTo added in v0.39.0 

func (src *LocationResource) ConvertTo() (v1.DataModelInterface, error)

ConvertTo converts from the versioned LocationResource resource to version-agnostic datamodel.

func (LocationResource) MarshalJSON added in v0.39.0 

func (l LocationResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LocationResource.

func (*LocationResource) UnmarshalJSON added in v0.39.0 

func (l *LocationResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LocationResource.

type LocationResourceListResult added in v0.39.0 

type LocationResourceListResult struct {
	// REQUIRED; The LocationResource items on this page
	Value []*LocationResource

	// The link to the next page of items
	NextLink *string
}

LocationResourceListResult - The response of a LocationResource list operation.

func (LocationResourceListResult) MarshalJSON added in v0.39.0 

func (l LocationResourceListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LocationResourceListResult.

func (*LocationResourceListResult) UnmarshalJSON added in v0.39.0 

func (l *LocationResourceListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LocationResourceListResult.

type LocationResourceType added in v0.39.0 

type LocationResourceType struct {
	// The configuration for API versions of a resource type supported by the location.
	APIVersions map[string]*LocationResourceTypeAPIVersion
}

LocationResourceType - The configuration for a resource type in a specific location.

func (LocationResourceType) MarshalJSON added in v0.39.0 

func (l LocationResourceType) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LocationResourceType.

func (*LocationResourceType) UnmarshalJSON added in v0.39.0 

func (l *LocationResourceType) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LocationResourceType.

type LocationResourceTypeAPIVersion added in v0.60.0 

type LocationResourceTypeAPIVersion struct {
}

LocationResourceTypeAPIVersion - The configuration for an API version of an resource type.

type LocationsClient added in v0.39.0 

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

LocationsClient contains the methods for the Locations group. Don't use this type directly, use NewLocationsClient() instead.

Generated from API version 2023-10-01-preview

func NewLocationsClient added in v0.39.0 

func NewLocationsClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*LocationsClient, error)

NewLocationsClient creates a new instance of LocationsClient with the specified values.

  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - Contains optional client configuration. Pass nil to accept the default values.

func (*LocationsClient) BeginCreateOrUpdate added in v0.39.0 

func (client *LocationsClient) BeginCreateOrUpdate(ctx context.Context, planeName string, resourceProviderName string, locationName string, resource LocationResource, options *LocationsClientBeginCreateOrUpdateOptions) (*runtime.Poller[LocationsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create or update a location. The location resource represents a logical location where the resource provider operates. If the operation fails it returns an *azcore.ResponseError type.

  • planeName - The plane name.
  • resourceProviderName - The resource provider name. This is also the resource provider namespace. Example: 'Applications.Datastores'.
  • locationName - The location name.
  • resource - Resource create parameters.
  • options - LocationsClientBeginCreateOrUpdateOptions contains the optional parameters for the LocationsClient.BeginCreateOrUpdate method.

func (*LocationsClient) BeginDelete added in v0.39.0 

func (client *LocationsClient) BeginDelete(ctx context.Context, planeName string, resourceProviderName string, locationName string, options *LocationsClientBeginDeleteOptions) (*runtime.Poller[LocationsClientDeleteResponse], error)

BeginDelete - Delete a location. The location resource represents a logical location where the resource provider operates. If the operation fails it returns an *azcore.ResponseError type.

  • planeName - The plane name.
  • resourceProviderName - The resource provider name. This is also the resource provider namespace. Example: 'Applications.Datastores'.
  • locationName - The location name.
  • options - LocationsClientBeginDeleteOptions contains the optional parameters for the LocationsClient.BeginDelete method.

func (*LocationsClient) Get added in v0.39.0 

func (client *LocationsClient) Get(ctx context.Context, planeName string, resourceProviderName string, locationName string, options *LocationsClientGetOptions) (LocationsClientGetResponse, error)

Get - Get the specified location. The location resource represents a logical location where the resource provider operates. If the operation fails it returns an *azcore.ResponseError type.

  • planeName - The plane name.
  • resourceProviderName - The resource provider name. This is also the resource provider namespace. Example: 'Applications.Datastores'.
  • locationName - The location name.
  • options - LocationsClientGetOptions contains the optional parameters for the LocationsClient.Get method.

func (*LocationsClient) NewListPager added in v0.39.0 

func (client *LocationsClient) NewListPager(planeName string, resourceProviderName string, options *LocationsClientListOptions) *runtime.Pager[LocationsClientListResponse]

NewListPager - List available locations for the specified resource provider.

  • planeName - The plane name.
  • resourceProviderName - The resource provider name. This is also the resource provider namespace. Example: 'Applications.Datastores'.
  • options - LocationsClientListOptions contains the optional parameters for the LocationsClient.NewListPager method.

type LocationsClientBeginCreateOrUpdateOptions added in v0.39.0 

type LocationsClientBeginCreateOrUpdateOptions struct {
	// Resumes the long-running operation from the provided token.
	ResumeToken string
}

LocationsClientBeginCreateOrUpdateOptions contains the optional parameters for the LocationsClient.BeginCreateOrUpdate method.

type LocationsClientBeginDeleteOptions added in v0.39.0 

type LocationsClientBeginDeleteOptions struct {
	// Resumes the long-running operation from the provided token.
	ResumeToken string
}

LocationsClientBeginDeleteOptions contains the optional parameters for the LocationsClient.BeginDelete method.

type LocationsClientCreateOrUpdateResponse added in v0.39.0 

type LocationsClientCreateOrUpdateResponse struct {
	// The resource type for defining a location of the containing resource provider. The location resource represents a logical
	// location where the resource provider operates.
	LocationResource
}

LocationsClientCreateOrUpdateResponse contains the response from method LocationsClient.BeginCreateOrUpdate.

type LocationsClientDeleteResponse added in v0.39.0 

type LocationsClientDeleteResponse struct {
}

LocationsClientDeleteResponse contains the response from method LocationsClient.BeginDelete.

type LocationsClientGetOptions added in v0.39.0 

type LocationsClientGetOptions struct {
}

LocationsClientGetOptions contains the optional parameters for the LocationsClient.Get method.

type LocationsClientGetResponse added in v0.39.0 

type LocationsClientGetResponse struct {
	// The resource type for defining a location of the containing resource provider. The location resource represents a logical
	// location where the resource provider operates.
	LocationResource
}

LocationsClientGetResponse contains the response from method LocationsClient.Get.

type LocationsClientListOptions added in v0.39.0 

type LocationsClientListOptions struct {
}

LocationsClientListOptions contains the optional parameters for the LocationsClient.NewListPager method.

type LocationsClientListResponse added in v0.39.0 

type LocationsClientListResponse struct {
	// The response of a LocationResource list operation.
	LocationResourceListResult
}

LocationsClientListResponse contains the response from method LocationsClient.NewListPager.

type PagedResourceProviderSummary added in v0.39.0 

type PagedResourceProviderSummary struct {
	// REQUIRED; The ResourceProviderSummary items on this page
	Value []*ResourceProviderSummary

	// The link to the next page of items
	NextLink *string
}

PagedResourceProviderSummary - Paged collection of ResourceProviderSummary items

func (PagedResourceProviderSummary) MarshalJSON added in v0.39.0 

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

MarshalJSON implements the json.Marshaller interface for type PagedResourceProviderSummary.

func (*PagedResourceProviderSummary) UnmarshalJSON added in v0.39.0 

func (p *PagedResourceProviderSummary) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PagedResourceProviderSummary.

type PlanesClient 

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

PlanesClient contains the methods for the Planes group. Don't use this type directly, use NewPlanesClient() instead.

Generated from API version 2023-10-01-preview

func NewPlanesClient 

func NewPlanesClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*PlanesClient, error)

NewPlanesClient creates a new instance of PlanesClient with the specified values.

  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - Contains optional client configuration. Pass nil to accept the default values.

func (*PlanesClient) NewListPlanesPager 

func (client *PlanesClient) NewListPlanesPager(options *PlanesClientListPlanesOptions) *runtime.Pager[PlanesClientListPlanesResponse]

NewListPlanesPager - List all planes

  • options - PlanesClientListPlanesOptions contains the optional parameters for the PlanesClient.NewListPlanesPager method.

type PlanesClientListPlanesOptions 

type PlanesClientListPlanesOptions struct {
}

PlanesClientListPlanesOptions contains the optional parameters for the PlanesClient.NewListPlanesPager method.

type PlanesClientListPlanesResponse 

type PlanesClientListPlanesResponse struct {
	// The response of a GenericPlaneResource list operation.
	GenericPlaneResourceListResult
}

PlanesClientListPlanesResponse contains the response from method PlanesClient.NewListPlanesPager.

type ProvisioningState 

type ProvisioningState string

ProvisioningState - Provisioning state of the resource at the time the operation was called 

const (
	// ProvisioningStateAccepted - The resource create request has been accepted
	ProvisioningStateAccepted ProvisioningState = "Accepted"
	// ProvisioningStateCanceled - The resource provisioning has been canceled
	ProvisioningStateCanceled ProvisioningState = "Canceled"
	// ProvisioningStateCreating - The resource is being created
	ProvisioningStateCreating ProvisioningState = "Creating"
	// ProvisioningStateDeleting - The resource is being deleted
	ProvisioningStateDeleting ProvisioningState = "Deleting"
	// ProvisioningStateFailed - The resource provisioning has failed
	ProvisioningStateFailed ProvisioningState = "Failed"
	// ProvisioningStateProvisioning - The resource is being provisioned
	ProvisioningStateProvisioning ProvisioningState = "Provisioning"
	// ProvisioningStateSucceeded - The resource has been successfully provisioned
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
	// ProvisioningStateUpdating - The resource is being updated
	ProvisioningStateUpdating ProvisioningState = "Updating"
)

func PossibleProvisioningStateValues 

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns the possible values for the ProvisioningState const type.

type RadiusPlaneResource added in v0.34.0 

type RadiusPlaneResource struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// REQUIRED; The resource-specific properties for this resource.
	Properties *RadiusPlaneResourceProperties

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

RadiusPlaneResource - The Radius plane resource.

func (*RadiusPlaneResource) ConvertFrom added in v0.34.0 

func (dst *RadiusPlaneResource) ConvertFrom(src v1.DataModelInterface) error

ConvertFrom converts from version-agnostic datamodel to the versioned Radius Plane resource.

func (*RadiusPlaneResource) ConvertTo added in v0.34.0 

func (src *RadiusPlaneResource) ConvertTo() (v1.DataModelInterface, error)

ConvertTo converts from the versioned Radius Plane resource to version-agnostic datamodel.

func (RadiusPlaneResource) MarshalJSON added in v0.34.0 

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

MarshalJSON implements the json.Marshaller interface for type RadiusPlaneResource.

func (*RadiusPlaneResource) UnmarshalJSON added in v0.34.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type RadiusPlaneResource.

type RadiusPlaneResourceListResult added in v0.34.0 

type RadiusPlaneResourceListResult struct {
	// REQUIRED; The RadiusPlaneResource items on this page
	Value []*RadiusPlaneResource

	// The link to the next page of items
	NextLink *string
}

RadiusPlaneResourceListResult - The response of a RadiusPlaneResource list operation.

func (RadiusPlaneResourceListResult) MarshalJSON added in v0.34.0 

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

MarshalJSON implements the json.Marshaller interface for type RadiusPlaneResourceListResult.

func (*RadiusPlaneResourceListResult) UnmarshalJSON added in v0.34.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type RadiusPlaneResourceListResult.

type RadiusPlaneResourceProperties added in v0.34.0 

type RadiusPlaneResourceProperties struct {
	// REQUIRED; Resource Providers for UCP Native Plane
	ResourceProviders map[string]*string

	// READ-ONLY; The status of the asynchronous operation.
	ProvisioningState *ProvisioningState
}

RadiusPlaneResourceProperties - The Plane properties.

func (RadiusPlaneResourceProperties) MarshalJSON added in v0.34.0 

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

MarshalJSON implements the json.Marshaller interface for type RadiusPlaneResourceProperties.

func (*RadiusPlaneResourceProperties) UnmarshalJSON added in v0.34.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type RadiusPlaneResourceProperties.

type RadiusPlaneResourceTagsUpdate added in v0.34.0 

type RadiusPlaneResourceTagsUpdate struct {
	// Resource tags.
	Tags map[string]*string
}

RadiusPlaneResourceTagsUpdate - The type used for updating tags in RadiusPlaneResource resources.

func (RadiusPlaneResourceTagsUpdate) MarshalJSON added in v0.34.0 

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

MarshalJSON implements the json.Marshaller interface for type RadiusPlaneResourceTagsUpdate.

func (*RadiusPlaneResourceTagsUpdate) UnmarshalJSON added in v0.34.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type RadiusPlaneResourceTagsUpdate.

type RadiusPlanesClient added in v0.34.0 

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

RadiusPlanesClient contains the methods for the RadiusPlanes group. Don't use this type directly, use NewRadiusPlanesClient() instead.

Generated from API version 2023-10-01-preview

func NewRadiusPlanesClient added in v0.34.0 

func NewRadiusPlanesClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*RadiusPlanesClient, error)

NewRadiusPlanesClient creates a new instance of RadiusPlanesClient with the specified values.

  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - Contains optional client configuration. Pass nil to accept the default values.

func (*RadiusPlanesClient) BeginCreateOrUpdate added in v0.34.0 

func (client *RadiusPlanesClient) BeginCreateOrUpdate(ctx context.Context, planeName string, resource RadiusPlaneResource, options *RadiusPlanesClientBeginCreateOrUpdateOptions) (*runtime.Poller[RadiusPlanesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create or update a plane If the operation fails it returns an *azcore.ResponseError type.

  • planeName - The plane name.
  • resource - Resource create parameters.
  • options - RadiusPlanesClientBeginCreateOrUpdateOptions contains the optional parameters for the RadiusPlanesClient.BeginCreateOrUpdate method.

func (*RadiusPlanesClient) BeginDelete added in v0.34.0 

func (client *RadiusPlanesClient) BeginDelete(ctx context.Context, planeName string, options *RadiusPlanesClientBeginDeleteOptions) (*runtime.Poller[RadiusPlanesClientDeleteResponse], error)

BeginDelete - Delete a plane If the operation fails it returns an *azcore.ResponseError type.

  • planeName - The plane name.
  • options - RadiusPlanesClientBeginDeleteOptions contains the optional parameters for the RadiusPlanesClient.BeginDelete method.

func (*RadiusPlanesClient) BeginUpdate added in v0.34.0 

func (client *RadiusPlanesClient) BeginUpdate(ctx context.Context, planeName string, properties RadiusPlaneResourceTagsUpdate, options *RadiusPlanesClientBeginUpdateOptions) (*runtime.Poller[RadiusPlanesClientUpdateResponse], error)

BeginUpdate - Update a plane If the operation fails it returns an *azcore.ResponseError type.

  • planeName - The plane name.
  • properties - The resource properties to be updated.
  • options - RadiusPlanesClientBeginUpdateOptions contains the optional parameters for the RadiusPlanesClient.BeginUpdate method.

func (*RadiusPlanesClient) Get added in v0.34.0 

func (client *RadiusPlanesClient) Get(ctx context.Context, planeName string, options *RadiusPlanesClientGetOptions) (RadiusPlanesClientGetResponse, error)

Get - Get a plane by name If the operation fails it returns an *azcore.ResponseError type.

  • planeName - The plane name.
  • options - RadiusPlanesClientGetOptions contains the optional parameters for the RadiusPlanesClient.Get method.

func (*RadiusPlanesClient) NewListPager added in v0.34.0 

func (client *RadiusPlanesClient) NewListPager(options *RadiusPlanesClientListOptions) *runtime.Pager[RadiusPlanesClientListResponse]

NewListPager - List Radius planes

  • options - RadiusPlanesClientListOptions contains the optional parameters for the RadiusPlanesClient.NewListPager method.

type RadiusPlanesClientBeginCreateOrUpdateOptions added in v0.34.0 

type RadiusPlanesClientBeginCreateOrUpdateOptions struct {
	// Resumes the long-running operation from the provided token.
	ResumeToken string
}

RadiusPlanesClientBeginCreateOrUpdateOptions contains the optional parameters for the RadiusPlanesClient.BeginCreateOrUpdate method.

type RadiusPlanesClientBeginDeleteOptions added in v0.34.0 

type RadiusPlanesClientBeginDeleteOptions struct {
	// Resumes the long-running operation from the provided token.
	ResumeToken string
}

RadiusPlanesClientBeginDeleteOptions contains the optional parameters for the RadiusPlanesClient.BeginDelete method.

type RadiusPlanesClientBeginUpdateOptions added in v0.34.0 

type RadiusPlanesClientBeginUpdateOptions struct {
	// Resumes the long-running operation from the provided token.
	ResumeToken string
}

RadiusPlanesClientBeginUpdateOptions contains the optional parameters for the RadiusPlanesClient.BeginUpdate method.

type RadiusPlanesClientCreateOrUpdateResponse added in v0.34.0 

type RadiusPlanesClientCreateOrUpdateResponse struct {
	// The Radius plane resource.
	RadiusPlaneResource
}

RadiusPlanesClientCreateOrUpdateResponse contains the response from method RadiusPlanesClient.BeginCreateOrUpdate.

type RadiusPlanesClientDeleteResponse added in v0.34.0 

type RadiusPlanesClientDeleteResponse struct {
}

RadiusPlanesClientDeleteResponse contains the response from method RadiusPlanesClient.BeginDelete.

type RadiusPlanesClientGetOptions added in v0.34.0 

type RadiusPlanesClientGetOptions struct {
}

RadiusPlanesClientGetOptions contains the optional parameters for the RadiusPlanesClient.Get method.

type RadiusPlanesClientGetResponse added in v0.34.0 

type RadiusPlanesClientGetResponse struct {
	// The Radius plane resource.
	RadiusPlaneResource
}

RadiusPlanesClientGetResponse contains the response from method RadiusPlanesClient.Get.

type RadiusPlanesClientListOptions added in v0.34.0 

type RadiusPlanesClientListOptions struct {
}

RadiusPlanesClientListOptions contains the optional parameters for the RadiusPlanesClient.NewListPager method.

type RadiusPlanesClientListResponse added in v0.34.0 

type RadiusPlanesClientListResponse struct {
	// The response of a RadiusPlaneResource list operation.
	RadiusPlaneResourceListResult
}

RadiusPlanesClientListResponse contains the response from method RadiusPlanesClient.NewListPager.

type RadiusPlanesClientUpdateResponse added in v0.34.0 

type RadiusPlanesClientUpdateResponse struct {
}

RadiusPlanesClientUpdateResponse contains the response from method RadiusPlanesClient.BeginUpdate.

type ResourceGroupProperties 

type ResourceGroupProperties struct {
	// READ-ONLY; The status of the asynchronous operation.
	ProvisioningState *ProvisioningState
}

ResourceGroupProperties - The resource group resource properties

func (ResourceGroupProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ResourceGroupProperties.

func (*ResourceGroupProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceGroupProperties.

type ResourceGroupResource 

type ResourceGroupResource struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// The resource-specific properties for this resource.
	Properties *ResourceGroupProperties

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

ResourceGroupResource - The resource group resource

func (*ResourceGroupResource) ConvertFrom 

func (dst *ResourceGroupResource) ConvertFrom(src v1.DataModelInterface) error

ConvertFrom converts from version-agnostic datamodel to the versioned ResourceGroup resource.

func (*ResourceGroupResource) ConvertTo 

func (src *ResourceGroupResource) ConvertTo() (v1.DataModelInterface, error)

ConvertTo converts from the versioned ResourceGroup resource to version-agnostic datamodel.

func (ResourceGroupResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ResourceGroupResource.

func (*ResourceGroupResource) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceGroupResource.

type ResourceGroupResourceListResult 

type ResourceGroupResourceListResult struct {
	// REQUIRED; The ResourceGroupResource items on this page
	Value []*ResourceGroupResource

	// The link to the next page of items
	NextLink *string
}

ResourceGroupResourceListResult - The response of a ResourceGroupResource list operation.

func (ResourceGroupResourceListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ResourceGroupResourceListResult.

func (*ResourceGroupResourceListResult) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceGroupResourceListResult.

type ResourceGroupResourceTagsUpdate 

type ResourceGroupResourceTagsUpdate struct {
	// Resource tags.
	Tags map[string]*string
}

ResourceGroupResourceTagsUpdate - The type used for updating tags in ResourceGroupResource resources.

func (ResourceGroupResourceTagsUpdate) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ResourceGroupResourceTagsUpdate.

func (*ResourceGroupResourceTagsUpdate) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceGroupResourceTagsUpdate.

type ResourceGroupsClient 

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

ResourceGroupsClient contains the methods for the ResourceGroups group. Don't use this type directly, use NewResourceGroupsClient() instead.

Generated from API version 2023-10-01-preview

func NewResourceGroupsClient 

func NewResourceGroupsClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*ResourceGroupsClient, error)

NewResourceGroupsClient creates a new instance of ResourceGroupsClient with the specified values.

  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - Contains optional client configuration. Pass nil to accept the default values.

func (*ResourceGroupsClient) CreateOrUpdate 

func (client *ResourceGroupsClient) CreateOrUpdate(ctx context.Context, planeName string, resourceGroupName string, resource ResourceGroupResource, options *ResourceGroupsClientCreateOrUpdateOptions) (ResourceGroupsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create or update a resource group If the operation fails it returns an *azcore.ResponseError type.

  • planeName - The plane name.
  • resourceGroupName - The name of resource group
  • resource - Resource create parameters.
  • options - ResourceGroupsClientCreateOrUpdateOptions contains the optional parameters for the ResourceGroupsClient.CreateOrUpdate method.

func (*ResourceGroupsClient) Delete 

func (client *ResourceGroupsClient) Delete(ctx context.Context, planeName string, resourceGroupName string, options *ResourceGroupsClientDeleteOptions) (ResourceGroupsClientDeleteResponse, error)

Delete - Delete a resource group If the operation fails it returns an *azcore.ResponseError type.

  • planeName - The plane name.
  • resourceGroupName - The name of resource group
  • options - ResourceGroupsClientDeleteOptions contains the optional parameters for the ResourceGroupsClient.Delete method.

func (*ResourceGroupsClient) Get 

func (client *ResourceGroupsClient) Get(ctx context.Context, planeName string, resourceGroupName string, options *ResourceGroupsClientGetOptions) (ResourceGroupsClientGetResponse, error)

Get - Get a resource group If the operation fails it returns an *azcore.ResponseError type.

  • planeName - The plane name.
  • resourceGroupName - The name of resource group
  • options - ResourceGroupsClientGetOptions contains the optional parameters for the ResourceGroupsClient.Get method.

func (*ResourceGroupsClient) NewListPager 

func (client *ResourceGroupsClient) NewListPager(planeName string, options *ResourceGroupsClientListOptions) *runtime.Pager[ResourceGroupsClientListResponse]

NewListPager - List resource groups

  • planeName - The plane name.
  • options - ResourceGroupsClientListOptions contains the optional parameters for the ResourceGroupsClient.NewListPager method.

func (*ResourceGroupsClient) Update 

func (client *ResourceGroupsClient) Update(ctx context.Context, planeName string, resourceGroupName string, properties ResourceGroupResourceTagsUpdate, options *ResourceGroupsClientUpdateOptions) (ResourceGroupsClientUpdateResponse, error)

Update - Update a resource group If the operation fails it returns an *azcore.ResponseError type.

  • planeName - The plane name.
  • resourceGroupName - The name of resource group
  • properties - The resource properties to be updated.
  • options - ResourceGroupsClientUpdateOptions contains the optional parameters for the ResourceGroupsClient.Update method.

type ResourceGroupsClientCreateOrUpdateOptions 

type ResourceGroupsClientCreateOrUpdateOptions struct {
}

ResourceGroupsClientCreateOrUpdateOptions contains the optional parameters for the ResourceGroupsClient.CreateOrUpdate method.

type ResourceGroupsClientCreateOrUpdateResponse 

type ResourceGroupsClientCreateOrUpdateResponse struct {
	// The resource group resource
	ResourceGroupResource
}

ResourceGroupsClientCreateOrUpdateResponse contains the response from method ResourceGroupsClient.CreateOrUpdate.

type ResourceGroupsClientDeleteOptions 

type ResourceGroupsClientDeleteOptions struct {
}

ResourceGroupsClientDeleteOptions contains the optional parameters for the ResourceGroupsClient.Delete method.

type ResourceGroupsClientDeleteResponse 

type ResourceGroupsClientDeleteResponse struct {
}

ResourceGroupsClientDeleteResponse contains the response from method ResourceGroupsClient.Delete.

type ResourceGroupsClientGetOptions 

type ResourceGroupsClientGetOptions struct {
}

ResourceGroupsClientGetOptions contains the optional parameters for the ResourceGroupsClient.Get method.

type ResourceGroupsClientGetResponse 

type ResourceGroupsClientGetResponse struct {
	// The resource group resource
	ResourceGroupResource
}

ResourceGroupsClientGetResponse contains the response from method ResourceGroupsClient.Get.

type ResourceGroupsClientListOptions 

type ResourceGroupsClientListOptions struct {
}

ResourceGroupsClientListOptions contains the optional parameters for the ResourceGroupsClient.NewListPager method.

type ResourceGroupsClientListResponse 

type ResourceGroupsClientListResponse struct {
	// The response of a ResourceGroupResource list operation.
	ResourceGroupResourceListResult
}

ResourceGroupsClientListResponse contains the response from method ResourceGroupsClient.NewListPager.

type ResourceGroupsClientUpdateOptions 

type ResourceGroupsClientUpdateOptions struct {
}

ResourceGroupsClientUpdateOptions contains the optional parameters for the ResourceGroupsClient.Update method.

type ResourceGroupsClientUpdateResponse 

type ResourceGroupsClientUpdateResponse struct {
	// The resource group resource
	ResourceGroupResource
}

ResourceGroupsClientUpdateResponse contains the response from method ResourceGroupsClient.Update.

type ResourceProperties added in v0.60.0 

type ResourceProperties struct {
}

ResourceProperties - The resource properties

type ResourceProviderProperties added in v0.39.0 

type ResourceProviderProperties struct {
	// READ-ONLY; The status of the asynchronous operation.
	ProvisioningState *ProvisioningState
}

ResourceProviderProperties - The properties of a resource provider.

func (ResourceProviderProperties) MarshalJSON added in v0.39.0 

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

MarshalJSON implements the json.Marshaller interface for type ResourceProviderProperties.

func (*ResourceProviderProperties) UnmarshalJSON added in v0.39.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceProviderProperties.

type ResourceProviderResource added in v0.39.0 

type ResourceProviderResource struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// The resource-specific properties for this resource.
	Properties *ResourceProviderProperties

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

ResourceProviderResource - The resource type for defining a resource provider.

func (*ResourceProviderResource) ConvertFrom added in v0.39.0 

func (dst *ResourceProviderResource) ConvertFrom(src v1.DataModelInterface) error

ConvertFrom converts from version-agnostic datamodel to the versioned ResourceProviderResource resource.

func (*ResourceProviderResource) ConvertTo added in v0.39.0 

func (src *ResourceProviderResource) ConvertTo() (v1.DataModelInterface, error)

ConvertTo converts from the versioned ResourceProviderResource resource to version-agnostic datamodel.

func (ResourceProviderResource) MarshalJSON added in v0.39.0 

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

MarshalJSON implements the json.Marshaller interface for type ResourceProviderResource.

func (*ResourceProviderResource) UnmarshalJSON added in v0.39.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceProviderResource.

type ResourceProviderResourceListResult added in v0.39.0 

type ResourceProviderResourceListResult struct {
	// REQUIRED; The ResourceProviderResource items on this page
	Value []*ResourceProviderResource

	// The link to the next page of items
	NextLink *string
}

ResourceProviderResourceListResult - The response of a ResourceProviderResource list operation.

func (ResourceProviderResourceListResult) MarshalJSON added in v0.39.0 

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

MarshalJSON implements the json.Marshaller interface for type ResourceProviderResourceListResult.

func (*ResourceProviderResourceListResult) UnmarshalJSON added in v0.39.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceProviderResourceListResult.

type ResourceProviderSummary added in v0.39.0 

type ResourceProviderSummary struct {
	// REQUIRED; The resource provider locations.
	Locations map[string]*ResourceProviderSummaryLocation

	// REQUIRED; The resource provider name.
	Name *string

	// REQUIRED; The resource types supported by the resource provider.
	ResourceTypes map[string]*ResourceProviderSummaryResourceType
}

ResourceProviderSummary - The summary of a resource provider configuration. This type is optimized for querying resource providers and supported types.

func (*ResourceProviderSummary) ConvertFrom added in v0.39.0 

func (dst *ResourceProviderSummary) ConvertFrom(src v1.DataModelInterface) error

ConvertFrom converts from version-agnostic datamodel to the versioned ResourceProviderSummary resource.

func (*ResourceProviderSummary) ConvertTo added in v0.39.0 

func (src *ResourceProviderSummary) ConvertTo() (v1.DataModelInterface, error)

ConvertTo converts from the versioned ResourceProviderSummary resource to version-agnostic datamodel.

NOTE: ResourceProviderSummary is READONLY. There is no conversion from versioned to datamodel.

func (ResourceProviderSummary) MarshalJSON added in v0.39.0 

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

MarshalJSON implements the json.Marshaller interface for type ResourceProviderSummary.

func (*ResourceProviderSummary) UnmarshalJSON added in v0.39.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceProviderSummary.

type ResourceProviderSummaryLocation added in v0.60.0 

type ResourceProviderSummaryLocation struct {
}

ResourceProviderSummaryLocation - The configuration of a resource provider in a specific location.

type ResourceProviderSummaryResourceType added in v0.39.0 

type ResourceProviderSummaryResourceType struct {
	// REQUIRED; API versions supported by the resource type.
	APIVersions map[string]*ResourceTypeSummaryResultAPIVersion

	// The resource type capabilities.
	Capabilities []*string

	// The default api version for the resource type.
	DefaultAPIVersion *string

	// Description of the resource type.
	Description *string

	// The verbatim SVG icon content associated with the resource type, carried as a UTF-8 string.
	Icon *string

	// The SHA-256 hash of the icon's SVG bytes, computed by the control plane.
	IconHash *string
}

ResourceProviderSummaryResourceType - A resource type and its versions.

func (ResourceProviderSummaryResourceType) MarshalJSON added in v0.39.0 

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

MarshalJSON implements the json.Marshaller interface for type ResourceProviderSummaryResourceType.

func (*ResourceProviderSummaryResourceType) UnmarshalJSON added in v0.39.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceProviderSummaryResourceType.

type ResourceProvidersClient added in v0.39.0 

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

ResourceProvidersClient contains the methods for the ResourceProviders group. Don't use this type directly, use NewResourceProvidersClient() instead.

Generated from API version 2023-10-01-preview

func NewResourceProvidersClient added in v0.39.0 

func NewResourceProvidersClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*ResourceProvidersClient, error)

NewResourceProvidersClient creates a new instance of ResourceProvidersClient with the specified values.

  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - Contains optional client configuration. Pass nil to accept the default values.

func (*ResourceProvidersClient) BeginCreateOrUpdate added in v0.39.0 

func (client *ResourceProvidersClient) BeginCreateOrUpdate(ctx context.Context, planeName string, resourceProviderName string, resource ResourceProviderResource, options *ResourceProvidersClientBeginCreateOrUpdateOptions) (*runtime.Poller[ResourceProvidersClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create or update a resource provider If the operation fails it returns an *azcore.ResponseError type.

  • planeName - The plane name.
  • resourceProviderName - The resource provider name. This is also the resource provider namespace. Example: 'Applications.Datastores'.
  • resource - Resource create parameters.
  • options - ResourceProvidersClientBeginCreateOrUpdateOptions contains the optional parameters for the ResourceProvidersClient.BeginCreateOrUpdate method.

func (*ResourceProvidersClient) BeginDelete added in v0.39.0 

func (client *ResourceProvidersClient) BeginDelete(ctx context.Context, planeName string, resourceProviderName string, options *ResourceProvidersClientBeginDeleteOptions) (*runtime.Poller[ResourceProvidersClientDeleteResponse], error)

BeginDelete - Delete a resource provider If the operation fails it returns an *azcore.ResponseError type.

  • planeName - The plane name.
  • resourceProviderName - The resource provider name. This is also the resource provider namespace. Example: 'Applications.Datastores'.
  • options - ResourceProvidersClientBeginDeleteOptions contains the optional parameters for the ResourceProvidersClient.BeginDelete method.

func (*ResourceProvidersClient) Get added in v0.39.0 

func (client *ResourceProvidersClient) Get(ctx context.Context, planeName string, resourceProviderName string, options *ResourceProvidersClientGetOptions) (ResourceProvidersClientGetResponse, error)

Get - Get the specified resource provider. If the operation fails it returns an *azcore.ResponseError type.

  • planeName - The plane name.
  • resourceProviderName - The resource provider name. This is also the resource provider namespace. Example: 'Applications.Datastores'.
  • options - ResourceProvidersClientGetOptions contains the optional parameters for the ResourceProvidersClient.Get method.

func (*ResourceProvidersClient) GetProviderSummary added in v0.39.0 

func (client *ResourceProvidersClient) GetProviderSummary(ctx context.Context, planeName string, resourceProviderName string, options *ResourceProvidersClientGetProviderSummaryOptions) (ResourceProvidersClientGetProviderSummaryResponse, error)

GetProviderSummary - Get the specified resource provider summary. The resource provider summary aggregates the most commonly used information including locations, api versions and resource types. If the operation fails it returns an *azcore.ResponseError type.

  • planeName - The plane name.
  • resourceProviderName - The resource provider name. This is also the resource provider namespace. Example: 'Applications.Datastores'.
  • options - ResourceProvidersClientGetProviderSummaryOptions contains the optional parameters for the ResourceProvidersClient.GetProviderSummary method.

func (*ResourceProvidersClient) NewListPager added in v0.39.0 

func (client *ResourceProvidersClient) NewListPager(planeName string, options *ResourceProvidersClientListOptions) *runtime.Pager[ResourceProvidersClientListResponse]

NewListPager - List resource providers.

  • planeName - The plane name.
  • options - ResourceProvidersClientListOptions contains the optional parameters for the ResourceProvidersClient.NewListPager method.

func (*ResourceProvidersClient) NewListProviderSummariesPager added in v0.39.0 

func (client *ResourceProvidersClient) NewListProviderSummariesPager(planeName string, options *ResourceProvidersClientListProviderSummariesOptions) *runtime.Pager[ResourceProvidersClientListProviderSummariesResponse]

NewListProviderSummariesPager - List resource provider summaries. The resource provider summary aggregates the most commonly used information including locations, api versions and resource types.

  • planeName - The plane name.
  • options - ResourceProvidersClientListProviderSummariesOptions contains the optional parameters for the ResourceProvidersClient.NewListProviderSummariesPager method.

type ResourceProvidersClientBeginCreateOrUpdateOptions added in v0.39.0 

type ResourceProvidersClientBeginCreateOrUpdateOptions struct {
	// Resumes the long-running operation from the provided token.
	ResumeToken string
}

ResourceProvidersClientBeginCreateOrUpdateOptions contains the optional parameters for the ResourceProvidersClient.BeginCreateOrUpdate method.

type ResourceProvidersClientBeginDeleteOptions added in v0.39.0 

type ResourceProvidersClientBeginDeleteOptions struct {
	// Resumes the long-running operation from the provided token.
	ResumeToken string
}

ResourceProvidersClientBeginDeleteOptions contains the optional parameters for the ResourceProvidersClient.BeginDelete method.

type ResourceProvidersClientCreateOrUpdateResponse added in v0.39.0 

type ResourceProvidersClientCreateOrUpdateResponse struct {
	// The resource type for defining a resource provider.
	ResourceProviderResource
}

ResourceProvidersClientCreateOrUpdateResponse contains the response from method ResourceProvidersClient.BeginCreateOrUpdate.

type ResourceProvidersClientDeleteResponse added in v0.39.0 

type ResourceProvidersClientDeleteResponse struct {
}

ResourceProvidersClientDeleteResponse contains the response from method ResourceProvidersClient.BeginDelete.

type ResourceProvidersClientGetOptions added in v0.39.0 

type ResourceProvidersClientGetOptions struct {
}

ResourceProvidersClientGetOptions contains the optional parameters for the ResourceProvidersClient.Get method.

type ResourceProvidersClientGetProviderSummaryOptions added in v0.39.0 

type ResourceProvidersClientGetProviderSummaryOptions struct {
	// When true, resource type icon bytes are included in the response. When false or omitted, only the icon hash is returned.
	IncludeIcons *bool
}

ResourceProvidersClientGetProviderSummaryOptions contains the optional parameters for the ResourceProvidersClient.GetProviderSummary method.

type ResourceProvidersClientGetProviderSummaryResponse added in v0.39.0 

type ResourceProvidersClientGetProviderSummaryResponse struct {
	// The summary of a resource provider configuration. This type is optimized for querying resource providers and supported
	// types.
	ResourceProviderSummary
}

ResourceProvidersClientGetProviderSummaryResponse contains the response from method ResourceProvidersClient.GetProviderSummary.

type ResourceProvidersClientGetResponse added in v0.39.0 

type ResourceProvidersClientGetResponse struct {
	// The resource type for defining a resource provider.
	ResourceProviderResource
}

ResourceProvidersClientGetResponse contains the response from method ResourceProvidersClient.Get.

type ResourceProvidersClientListOptions added in v0.39.0 

type ResourceProvidersClientListOptions struct {
}

ResourceProvidersClientListOptions contains the optional parameters for the ResourceProvidersClient.NewListPager method.

type ResourceProvidersClientListProviderSummariesOptions added in v0.39.0 

type ResourceProvidersClientListProviderSummariesOptions struct {
}

ResourceProvidersClientListProviderSummariesOptions contains the optional parameters for the ResourceProvidersClient.NewListProviderSummariesPager method.

type ResourceProvidersClientListProviderSummariesResponse added in v0.39.0 

type ResourceProvidersClientListProviderSummariesResponse struct {
	// Paged collection of ResourceProviderSummary items
	PagedResourceProviderSummary
}

ResourceProvidersClientListProviderSummariesResponse contains the response from method ResourceProvidersClient.NewListProviderSummariesPager.

type ResourceProvidersClientListResponse added in v0.39.0 

type ResourceProvidersClientListResponse struct {
	// The response of a ResourceProviderResource list operation.
	ResourceProviderResourceListResult
}

ResourceProvidersClientListResponse contains the response from method ResourceProvidersClient.NewListPager.

type ResourceTypeProperties added in v0.39.0 

type ResourceTypeProperties struct {
	// The resource type capabilities.
	Capabilities []*string

	// The default api version for the resource type.
	DefaultAPIVersion *string

	// Description of the resource type.
	Description *string

	// The verbatim SVG file content of the icon associated with the resource type, carried as a UTF-8 string. Set by 'rad resource-type
	// create --icon <path>'.
	Icon *string

	// READ-ONLY; The SHA-256 hash of the icon's SVG bytes. Computed by the control plane and used to content-address the icon.
	IconHash *string

	// READ-ONLY; The status of the asynchronous operation.
	ProvisioningState *ProvisioningState
}

ResourceTypeProperties - The properties of a resource type.

func (ResourceTypeProperties) MarshalJSON added in v0.39.0 

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

MarshalJSON implements the json.Marshaller interface for type ResourceTypeProperties.

func (*ResourceTypeProperties) UnmarshalJSON added in v0.39.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceTypeProperties.

type ResourceTypeResource added in v0.39.0 

type ResourceTypeResource struct {
	// The resource-specific properties for this resource.
	Properties *ResourceTypeProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

ResourceTypeResource - The resource type for defining a resource type supported by the containing resource provider.

func (*ResourceTypeResource) ConvertFrom added in v0.39.0 

func (dst *ResourceTypeResource) ConvertFrom(src v1.DataModelInterface) error

ConvertFrom converts from version-agnostic datamodel to the versioned ResourceTypeResource resource.

func (*ResourceTypeResource) ConvertTo added in v0.39.0 

func (src *ResourceTypeResource) ConvertTo() (v1.DataModelInterface, error)

ConvertTo converts from the versioned ResourceTypeResource resource to version-agnostic datamodel.

func (ResourceTypeResource) MarshalJSON added in v0.39.0 

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

MarshalJSON implements the json.Marshaller interface for type ResourceTypeResource.

func (*ResourceTypeResource) UnmarshalJSON added in v0.39.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceTypeResource.

type ResourceTypeResourceListResult added in v0.39.0 

type ResourceTypeResourceListResult struct {
	// REQUIRED; The ResourceTypeResource items on this page
	Value []*ResourceTypeResource

	// The link to the next page of items
	NextLink *string
}

ResourceTypeResourceListResult - The response of a ResourceTypeResource list operation.

func (ResourceTypeResourceListResult) MarshalJSON added in v0.39.0 

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

MarshalJSON implements the json.Marshaller interface for type ResourceTypeResourceListResult.

func (*ResourceTypeResourceListResult) UnmarshalJSON added in v0.39.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceTypeResourceListResult.

type ResourceTypeSummaryResultAPIVersion added in v0.48.0 

type ResourceTypeSummaryResultAPIVersion struct {
	// Schema holds the resource type definitions for this API version.
	Schema map[string]any
}

ResourceTypeSummaryResultAPIVersion - The configuration of a resource type API version.

func (ResourceTypeSummaryResultAPIVersion) MarshalJSON added in v0.48.0 

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

MarshalJSON implements the json.Marshaller interface for type ResourceTypeSummaryResultAPIVersion.

func (*ResourceTypeSummaryResultAPIVersion) UnmarshalJSON added in v0.48.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceTypeSummaryResultAPIVersion.

type ResourceTypesClient added in v0.39.0 

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

ResourceTypesClient contains the methods for the ResourceTypes group. Don't use this type directly, use NewResourceTypesClient() instead.

Generated from API version 2023-10-01-preview

func NewResourceTypesClient added in v0.39.0 

func NewResourceTypesClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*ResourceTypesClient, error)

NewResourceTypesClient creates a new instance of ResourceTypesClient with the specified values.

  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - Contains optional client configuration. Pass nil to accept the default values.

func (*ResourceTypesClient) BeginCreateOrUpdate added in v0.39.0 

func (client *ResourceTypesClient) BeginCreateOrUpdate(ctx context.Context, planeName string, resourceProviderName string, resourceTypeName string, resource ResourceTypeResource, options *ResourceTypesClientBeginCreateOrUpdateOptions) (*runtime.Poller[ResourceTypesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create or update a resource type If the operation fails it returns an *azcore.ResponseError type.

  • planeName - The plane name.
  • resourceProviderName - The resource provider name. This is also the resource provider namespace. Example: 'Applications.Datastores'.
  • resourceTypeName - The resource type name.
  • resource - Resource create parameters.
  • options - ResourceTypesClientBeginCreateOrUpdateOptions contains the optional parameters for the ResourceTypesClient.BeginCreateOrUpdate method.

func (*ResourceTypesClient) BeginDelete added in v0.39.0 

func (client *ResourceTypesClient) BeginDelete(ctx context.Context, planeName string, resourceProviderName string, resourceTypeName string, options *ResourceTypesClientBeginDeleteOptions) (*runtime.Poller[ResourceTypesClientDeleteResponse], error)

BeginDelete - Delete a resource type If the operation fails it returns an *azcore.ResponseError type.

  • planeName - The plane name.
  • resourceProviderName - The resource provider name. This is also the resource provider namespace. Example: 'Applications.Datastores'.
  • resourceTypeName - The resource type name.
  • options - ResourceTypesClientBeginDeleteOptions contains the optional parameters for the ResourceTypesClient.BeginDelete method.

func (*ResourceTypesClient) Get added in v0.39.0 

func (client *ResourceTypesClient) Get(ctx context.Context, planeName string, resourceProviderName string, resourceTypeName string, options *ResourceTypesClientGetOptions) (ResourceTypesClientGetResponse, error)

Get - Get the specified resource type. If the operation fails it returns an *azcore.ResponseError type.

  • planeName - The plane name.
  • resourceProviderName - The resource provider name. This is also the resource provider namespace. Example: 'Applications.Datastores'.
  • resourceTypeName - The resource type name.
  • options - ResourceTypesClientGetOptions contains the optional parameters for the ResourceTypesClient.Get method.

func (*ResourceTypesClient) GetIcon added in v0.60.0 

func (client *ResourceTypesClient) GetIcon(ctx context.Context, planeName string, resourceProviderName string, resourceTypeName string, hashParam string, options *ResourceTypesClientGetIconOptions) (ResourceTypesClientGetIconResponse, error)

GetIcon - Get the icon bytes stored for the specified resource type, addressed by the SHA-256 hash of those bytes. Returns the verbatim SVG file content with Content-Type: image/svg+xml and an immutable Cache-Control. If the hash does not match the stored icon, or the resource type has no icon, returns 404. If the operation fails it returns an *azcore.ResponseError type.

  • planeName - The plane name.
  • resourceProviderName - The resource provider name. This is also the resource provider namespace. Example: 'Applications.Datastores'.
  • resourceTypeName - The resource type name.
  • hashParam - The SHA-256 hash of the icon's SVG bytes, as a lowercase hex string.
  • options - ResourceTypesClientGetIconOptions contains the optional parameters for the ResourceTypesClient.GetIcon method.

func (*ResourceTypesClient) NewListPager added in v0.39.0 

func (client *ResourceTypesClient) NewListPager(planeName string, resourceProviderName string, options *ResourceTypesClientListOptions) *runtime.Pager[ResourceTypesClientListResponse]

NewListPager - List resource types.

  • planeName - The plane name.
  • resourceProviderName - The resource provider name. This is also the resource provider namespace. Example: 'Applications.Datastores'.
  • options - ResourceTypesClientListOptions contains the optional parameters for the ResourceTypesClient.NewListPager method.

type ResourceTypesClientBeginCreateOrUpdateOptions added in v0.39.0 

type ResourceTypesClientBeginCreateOrUpdateOptions struct {
	// Resumes the long-running operation from the provided token.
	ResumeToken string
}

ResourceTypesClientBeginCreateOrUpdateOptions contains the optional parameters for the ResourceTypesClient.BeginCreateOrUpdate method.

type ResourceTypesClientBeginDeleteOptions added in v0.39.0 

type ResourceTypesClientBeginDeleteOptions struct {
	// Resumes the long-running operation from the provided token.
	ResumeToken string
}

ResourceTypesClientBeginDeleteOptions contains the optional parameters for the ResourceTypesClient.BeginDelete method.

type ResourceTypesClientCreateOrUpdateResponse added in v0.39.0 

type ResourceTypesClientCreateOrUpdateResponse struct {
	// The resource type for defining a resource type supported by the containing resource provider.
	ResourceTypeResource
}

ResourceTypesClientCreateOrUpdateResponse contains the response from method ResourceTypesClient.BeginCreateOrUpdate.

type ResourceTypesClientDeleteResponse added in v0.39.0 

type ResourceTypesClientDeleteResponse struct {
}

ResourceTypesClientDeleteResponse contains the response from method ResourceTypesClient.BeginDelete.

type ResourceTypesClientGetIconOptions added in v0.60.0 

type ResourceTypesClientGetIconOptions struct {
}

ResourceTypesClientGetIconOptions contains the optional parameters for the ResourceTypesClient.GetIcon method.

type ResourceTypesClientGetIconResponse added in v0.60.0 

type ResourceTypesClientGetIconResponse struct {
	// Body contains the streaming response.
	Body io.ReadCloser

	// Caching hint. Icon bytes are content-addressed by SHA-256 and safe to cache immutably.
	CacheControl *string

	// MIME type of the icon bytes.
	ContentType *string
}

ResourceTypesClientGetIconResponse contains the response from method ResourceTypesClient.GetIcon.

type ResourceTypesClientGetOptions added in v0.39.0 

type ResourceTypesClientGetOptions struct {
}

ResourceTypesClientGetOptions contains the optional parameters for the ResourceTypesClient.Get method.

type ResourceTypesClientGetResponse added in v0.39.0 

type ResourceTypesClientGetResponse struct {
	// The resource type for defining a resource type supported by the containing resource provider.
	ResourceTypeResource
}

ResourceTypesClientGetResponse contains the response from method ResourceTypesClient.Get.

type ResourceTypesClientListOptions added in v0.39.0 

type ResourceTypesClientListOptions struct {
}

ResourceTypesClientListOptions contains the optional parameters for the ResourceTypesClient.NewListPager method.

type ResourceTypesClientListResponse added in v0.39.0 

type ResourceTypesClientListResponse struct {
	// The response of a ResourceTypeResource list operation.
	ResourceTypeResourceListResult
}

ResourceTypesClientListResponse contains the response from method ResourceTypesClient.NewListPager.

type ResourcesClient 

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

ResourcesClient contains the methods for the Resources group. Don't use this type directly, use NewResourcesClient() instead.

Generated from API version 2023-10-01-preview

func NewResourcesClient 

func NewResourcesClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*ResourcesClient, error)

NewResourcesClient creates a new instance of ResourcesClient with the specified values.

  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - Contains optional client configuration. Pass nil to accept the default values.

func (*ResourcesClient) NewListPager 

func (client *ResourcesClient) NewListPager(planeName string, resourceGroupName string, options *ResourcesClientListOptions) *runtime.Pager[ResourcesClientListResponse]

NewListPager - List resources in a resource group

  • planeName - The plane name.
  • resourceGroupName - The name of resource group
  • options - ResourcesClientListOptions contains the optional parameters for the ResourcesClient.NewListPager method.

type ResourcesClientListOptions 

type ResourcesClientListOptions struct {
}

ResourcesClientListOptions contains the optional parameters for the ResourcesClient.NewListPager method.

type ResourcesClientListResponse 

type ResourcesClientListResponse struct {
	// The response of a GenericResource list operation.
	GenericResourceListResult
}

ResourcesClientListResponse contains the response from method ResourcesClient.NewListPager.

type SystemData 

type SystemData struct {
	// The timestamp of resource creation (UTC).
	CreatedAt *time.Time

	// The identity that created the resource.
	CreatedBy *string

	// The type of identity that created the resource.
	CreatedByType *CreatedByType

	// The timestamp of resource last modification (UTC)
	LastModifiedAt *time.Time

	// The identity that last modified the resource.
	LastModifiedBy *string

	// The type of identity that last modified the resource.
	LastModifiedByType *CreatedByType
}

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.

Source Files

View all Source files

Directories

Path Synopsis

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.