v20231001preview

package
v0.31.0-rc1 Latest Latest
Warning

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

 Go to latest Published: Feb 28, 2024 License: Apache-2.0 Imports: 17 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 AWSCredentialKind 

type AWSCredentialKind string

AWSCredentialKind - AWS credential kind 

const (
	// AWSCredentialKindAccessKey - The AWS Access Key credential
	AWSCredentialKindAccessKey AWSCredentialKind = "AccessKey"
)

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

	// REQUIRED; The AWS credential kind
	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 storage properties

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

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.

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

Generated from API version 2023-10-01-preview

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

Generated from API version 2023-10-01-preview

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

Generated from API version 2023-10-01-preview

  • 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

Generated from API version 2023-10-01-preview

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

Generated from API version 2023-10-01-preview

  • 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 AzureCredentialKind 

type AzureCredentialKind string

AzureCredentialKind - Azure credential kinds supported. 

const (
	// AzureCredentialKindServicePrincipal - The Service Principal Credential
	AzureCredentialKindServicePrincipal AzureCredentialKind = "ServicePrincipal"
)

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

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.

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

Generated from API version 2023-10-01-preview

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

Generated from API version 2023-10-01-preview

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

Generated from API version 2023-10-01-preview

  • 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

Generated from API version 2023-10-01-preview

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

Generated from API version 2023-10-01-preview

  • 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 AzureServicePrincipalProperties 

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

	// REQUIRED; secret for ServicePrincipal
	ClientSecret *string

	// REQUIRED; The kind of Azure credential
	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 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 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) NewAwsCredentialsClient 

func (c *ClientFactory) NewAwsCredentialsClient() *AwsCredentialsClient

func (*ClientFactory) NewAzureCredentialsClient 

func (c *ClientFactory) NewAzureCredentialsClient() *AzureCredentialsClient

func (*ClientFactory) NewPlanesClient 

func (c *ClientFactory) NewPlanesClient() *PlanesClient

func (*ClientFactory) NewResourceGroupsClient 

func (c *ClientFactory) NewResourceGroupsClient() *ResourceGroupsClient

func (*ClientFactory) NewResourcesClient 

func (c *ClientFactory) NewResourcesClient() *ResourcesClient

type ComponentsKhmx01SchemasGenericresourceAllof0 

type ComponentsKhmx01SchemasGenericresourceAllof0 struct {
	// The resource-specific properties for this resource.
	Properties map[string]any

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

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

func (ComponentsKhmx01SchemasGenericresourceAllof0) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ComponentsKhmx01SchemasGenericresourceAllof0.

func (*ComponentsKhmx01SchemasGenericresourceAllof0) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ComponentsKhmx01SchemasGenericresourceAllof0.

type CreatedByType 

type CreatedByType string

CreatedByType - The type of identity that created the resource. 

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

func PossibleCreatedByTypeValues 

func PossibleCreatedByTypeValues() []CreatedByType

PossibleCreatedByTypeValues returns the possible values for the CreatedByType const type.

type CredentialStorageKind 

type CredentialStorageKind string

CredentialStorageKind - Credential store kinds supported. 

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

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 ErrorAdditionalInfo 

type ErrorAdditionalInfo struct {
	// READ-ONLY; The additional info.
	Info map[string]any

	// READ-ONLY; The additional info type.
	Type *string
}

ErrorAdditionalInfo - The resource management error additional info.

func (ErrorAdditionalInfo) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ErrorAdditionalInfo.

func (*ErrorAdditionalInfo) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorAdditionalInfo.

type ErrorDetail 

type ErrorDetail struct {
	// READ-ONLY; The error additional info.
	AdditionalInfo []*ErrorAdditionalInfo

	// READ-ONLY; The error code.
	Code *string

	// READ-ONLY; The error details.
	Details []*ErrorDetail

	// READ-ONLY; The error message.
	Message *string

	// READ-ONLY; The error target.
	Target *string
}

ErrorDetail - The error detail.

func (ErrorDetail) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ErrorDetail.

func (*ErrorDetail) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorDetail.

type ErrorResponse 

type ErrorResponse struct {
	// The error object.
	Error *ErrorDetail
}

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

func (ErrorResponse) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ErrorResponse.

func (*ErrorResponse) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorResponse.

type GenericResource 

type GenericResource struct {
	// The resource-specific properties for this resource.
	Properties map[string]any

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

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *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 {
	// REQUIRED; The kind of credential storage
	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 PlaneKind 

type PlaneKind string

PlaneKind - Plane kinds supported. 

const (
	// PlaneKindAWS - AWS Plane
	PlaneKindAWS PlaneKind = "AWS"
	// PlaneKindAzure - Azure Plane
	PlaneKindAzure PlaneKind = "Azure"
	// PlaneKindUCPNative - UCP Native Plane
	PlaneKindUCPNative PlaneKind = "UCPNative"
)

func PossiblePlaneKindValues 

func PossiblePlaneKindValues() []PlaneKind

PossiblePlaneKindValues returns the possible values for the PlaneKind const type.

type PlaneResource 

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

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

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

PlaneResource - The plane resource

func (*PlaneResource) ConvertFrom 

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

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

func (*PlaneResource) ConvertTo 

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

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

func (PlaneResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type PlaneResource.

func (*PlaneResource) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type PlaneResource.

type PlaneResourceListResult 

type PlaneResourceListResult struct {
	// REQUIRED; The PlaneResource items on this page
	Value []*PlaneResource

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

PlaneResourceListResult - The response of a PlaneResource list operation.

func (PlaneResourceListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type PlaneResourceListResult.

func (*PlaneResourceListResult) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type PlaneResourceListResult.

type PlaneResourceProperties 

type PlaneResourceProperties struct {
	// REQUIRED; The kind of plane
	Kind *PlaneKind

	// Resource Providers for UCP Native Plane
	ResourceProviders map[string]*string

	// URL to forward requests to for non UCP Native Plane
	URL *string

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

PlaneResourceProperties - The Plane properties.

func (PlaneResourceProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type PlaneResourceProperties.

func (*PlaneResourceProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type PlaneResourceProperties.

type PlaneResourceTagsUpdate 

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

PlaneResourceTagsUpdate - The type used for updating tags in PlaneResource resources.

func (PlaneResourceTagsUpdate) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type PlaneResourceTagsUpdate.

func (*PlaneResourceTagsUpdate) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type PlaneResourceTagsUpdate.

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.

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 - pass nil to accept the default values.

func (*PlanesClient) BeginCreateOrUpdate 

func (client *PlanesClient) BeginCreateOrUpdate(ctx context.Context, planeType string, planeName string, resource PlaneResource, options *PlanesClientBeginCreateOrUpdateOptions) (*runtime.Poller[PlanesClientCreateOrUpdateResponse], error)

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

Generated from API version 2023-10-01-preview

  • planeType - The plane type.
  • planeName - The name of the plane
  • resource - Resource create parameters.
  • options - PlanesClientBeginCreateOrUpdateOptions contains the optional parameters for the PlanesClient.BeginCreateOrUpdate method.

func (*PlanesClient) BeginDelete 

func (client *PlanesClient) BeginDelete(ctx context.Context, planeType string, planeName string, options *PlanesClientBeginDeleteOptions) (*runtime.Poller[PlanesClientDeleteResponse], error)

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

Generated from API version 2023-10-01-preview

  • planeType - The plane type.
  • planeName - The name of the plane
  • options - PlanesClientBeginDeleteOptions contains the optional parameters for the PlanesClient.BeginDelete method.

func (*PlanesClient) BeginUpdate 

func (client *PlanesClient) BeginUpdate(ctx context.Context, planeType string, planeName string, properties PlaneResourceTagsUpdate, options *PlanesClientBeginUpdateOptions) (*runtime.Poller[PlanesClientUpdateResponse], error)

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

Generated from API version 2023-10-01-preview

  • planeType - The plane type.
  • planeName - The name of the plane
  • properties - The resource properties to be updated.
  • options - PlanesClientBeginUpdateOptions contains the optional parameters for the PlanesClient.BeginUpdate method.

func (*PlanesClient) Get 

func (client *PlanesClient) Get(ctx context.Context, planeType string, planeName string, options *PlanesClientGetOptions) (PlanesClientGetResponse, error)

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

Generated from API version 2023-10-01-preview

  • planeType - The plane type.
  • planeName - The name of the plane
  • options - PlanesClientGetOptions contains the optional parameters for the PlanesClient.Get method.

func (*PlanesClient) NewListByTypePager 

func (client *PlanesClient) NewListByTypePager(planeType string, options *PlanesClientListByTypeOptions) *runtime.Pager[PlanesClientListByTypeResponse]

NewListByTypePager - List planes by type

Generated from API version 2023-10-01-preview

  • planeType - The plane type.
  • options - PlanesClientListByTypeOptions contains the optional parameters for the PlanesClient.NewListByTypePager method.

func (*PlanesClient) NewListPlanesPager 

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

NewListPlanesPager - List all planes

Generated from API version 2023-10-01-preview

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

type PlanesClientBeginCreateOrUpdateOptions 

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

PlanesClientBeginCreateOrUpdateOptions contains the optional parameters for the PlanesClient.BeginCreateOrUpdate method.

type PlanesClientBeginDeleteOptions 

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

PlanesClientBeginDeleteOptions contains the optional parameters for the PlanesClient.BeginDelete method.

type PlanesClientBeginUpdateOptions 

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

PlanesClientBeginUpdateOptions contains the optional parameters for the PlanesClient.BeginUpdate method.

type PlanesClientCreateOrUpdateResponse 

type PlanesClientCreateOrUpdateResponse struct {
	// The plane resource
	PlaneResource
}

PlanesClientCreateOrUpdateResponse contains the response from method PlanesClient.BeginCreateOrUpdate.

type PlanesClientDeleteResponse 

type PlanesClientDeleteResponse struct {
}

PlanesClientDeleteResponse contains the response from method PlanesClient.BeginDelete.

type PlanesClientGetOptions 

type PlanesClientGetOptions struct {
}

PlanesClientGetOptions contains the optional parameters for the PlanesClient.Get method.

type PlanesClientGetResponse 

type PlanesClientGetResponse struct {
	// The plane resource
	PlaneResource
}

PlanesClientGetResponse contains the response from method PlanesClient.Get.

type PlanesClientListByTypeOptions 

type PlanesClientListByTypeOptions struct {
}

PlanesClientListByTypeOptions contains the optional parameters for the PlanesClient.NewListByTypePager method.

type PlanesClientListByTypeResponse 

type PlanesClientListByTypeResponse struct {
	// The response of a PlaneResource list operation.
	PlaneResourceListResult
}

PlanesClientListByTypeResponse contains the response from method PlanesClient.NewListByTypePager.

type PlanesClientListPlanesOptions 

type PlanesClientListPlanesOptions struct {
}

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

type PlanesClientListPlanesResponse 

type PlanesClientListPlanesResponse struct {
	// The response of a PlaneResource list operation.
	PlaneResourceListResult
}

PlanesClientListPlanesResponse contains the response from method PlanesClient.NewListPlanesPager.

type PlanesClientUpdateResponse 

type PlanesClientUpdateResponse struct {
	// The plane resource
	PlaneResource
}

PlanesClientUpdateResponse contains the response from method PlanesClient.BeginUpdate.

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 - Resource creation was canceled.
	ProvisioningStateCanceled ProvisioningState = "Canceled"
	// ProvisioningStateDeleting - The resource is being deleted
	ProvisioningStateDeleting ProvisioningState = "Deleting"
	// ProvisioningStateFailed - Resource creation failed.
	ProvisioningStateFailed ProvisioningState = "Failed"
	// ProvisioningStateProvisioning - The resource is being provisioned
	ProvisioningStateProvisioning ProvisioningState = "Provisioning"
	// ProvisioningStateSucceeded - Resource has been created.
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
	// ProvisioningStateUpdating - The resource is updating
	ProvisioningStateUpdating ProvisioningState = "Updating"
)

func PossibleProvisioningStateValues 

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns the possible values for the ProvisioningState const type.

type ProxyResource 

type ProxyResource struct {
	// 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
}

ProxyResource - The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

func (ProxyResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ProxyResource.

func (*ProxyResource) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ProxyResource.

type Resource 

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

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

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

func (Resource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Resource.

func (*Resource) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type Resource.

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

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 - pass nil to accept the default values.

func (*ResourceGroupsClient) CreateOrUpdate 

func (client *ResourceGroupsClient) CreateOrUpdate(ctx context.Context, planeType string, 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.

Generated from API version 2023-10-01-preview

  • planeType - The plane type.
  • planeName - The name of the plane
  • 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, planeType string, planeName string, resourceGroupName string, options *ResourceGroupsClientDeleteOptions) (ResourceGroupsClientDeleteResponse, error)

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

Generated from API version 2023-10-01-preview

  • planeType - The plane type.
  • planeName - The name of the plane
  • 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, planeType string, planeName string, resourceGroupName string, options *ResourceGroupsClientGetOptions) (ResourceGroupsClientGetResponse, error)

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

Generated from API version 2023-10-01-preview

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

func (*ResourceGroupsClient) NewListPager 

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

NewListPager - List resource groups

Generated from API version 2023-10-01-preview

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

func (*ResourceGroupsClient) Update 

func (client *ResourceGroupsClient) Update(ctx context.Context, planeType string, 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.

Generated from API version 2023-10-01-preview

  • planeType - The plane type.
  • planeName - The name of the plane
  • 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 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.

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 - pass nil to accept the default values.

func (*ResourcesClient) NewListPager 

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

NewListPager - List resources in a resource group

Generated from API version 2023-10-01-preview

  • planeType - The plane type.
  • planeName - The name of the plane
  • 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.

type TrackedResource 

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

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

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

func (TrackedResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type TrackedResource.

func (*TrackedResource) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type TrackedResource.

type Versions 

type Versions string

Versions - Supported API versions for Universal Control Plane resource provider. 

const (
	// VersionsV20231001Preview - 2023-10-01-preview
	VersionsV20231001Preview Versions = "2023-10-01-preview"
)

func PossibleVersionsValues 

func PossibleVersionsValues() []Versions

PossibleVersionsValues returns the possible values for the Versions const type.

Source Files

View all Source files

Jump to

Keyboard shortcuts

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