Documentation
¶
Index ¶
- Constants
- type ActionType
- type AzureResourceManagerCommonTypesTrackedResourceUpdate
- type ClientFactory
- type CreatedByType
- type EnvironmentProperties
- type EnvironmentResource
- type EnvironmentResourceListResult
- type EnvironmentResourceUpdate
- type EnvironmentsClient
- func (client *EnvironmentsClient) CreateOrUpdate(ctx context.Context, environmentName string, resource EnvironmentResource, ...) (EnvironmentsClientCreateOrUpdateResponse, error)
- func (client *EnvironmentsClient) Delete(ctx context.Context, environmentName string, ...) (EnvironmentsClientDeleteResponse, error)
- func (client *EnvironmentsClient) Get(ctx context.Context, environmentName string, ...) (EnvironmentsClientGetResponse, error)
- func (client *EnvironmentsClient) NewListByScopePager(options *EnvironmentsClientListByScopeOptions) *runtime.Pager[EnvironmentsClientListByScopeResponse]
- func (client *EnvironmentsClient) Update(ctx context.Context, environmentName string, ...) (EnvironmentsClientUpdateResponse, error)
- type EnvironmentsClientCreateOrUpdateOptions
- type EnvironmentsClientCreateOrUpdateResponse
- type EnvironmentsClientDeleteOptions
- type EnvironmentsClientDeleteResponse
- type EnvironmentsClientGetOptions
- type EnvironmentsClientGetResponse
- type EnvironmentsClientListByScopeOptions
- type EnvironmentsClientListByScopeResponse
- type EnvironmentsClientUpdateOptions
- type EnvironmentsClientUpdateResponse
- type ErrorAdditionalInfo
- type ErrorDetail
- type ErrorResponse
- type IdentitySettingKind
- type IdentitySettings
- type Operation
- type OperationDisplay
- type OperationListResult
- type OperationsClient
- type OperationsClientListOptions
- type OperationsClientListResponse
- type Origin
- type Providers
- type ProvidersAws
- type ProvidersAzure
- type ProvidersKubernetes
- type ProvisioningState
- type Resource
- type SystemData
- type TrackedResource
Constants ¶
const Version = "2025-08-01-preview"
Version represents the api version in this package.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ActionType ¶
type ActionType string
ActionType - Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
const (
ActionTypeInternal ActionType = "Internal"
)
func PossibleActionTypeValues ¶
func PossibleActionTypeValues() []ActionType
PossibleActionTypeValues returns the possible values for the ActionType const type.
type AzureResourceManagerCommonTypesTrackedResourceUpdate ¶
type AzureResourceManagerCommonTypesTrackedResourceUpdate struct {
// 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
}
AzureResourceManagerCommonTypesTrackedResourceUpdate - The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
func (AzureResourceManagerCommonTypesTrackedResourceUpdate) MarshalJSON ¶
func (a AzureResourceManagerCommonTypesTrackedResourceUpdate) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type AzureResourceManagerCommonTypesTrackedResourceUpdate.
func (*AzureResourceManagerCommonTypesTrackedResourceUpdate) UnmarshalJSON ¶
func (a *AzureResourceManagerCommonTypesTrackedResourceUpdate) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type AzureResourceManagerCommonTypesTrackedResourceUpdate.
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(rootScope string, 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.
- rootScope - The scope in which the resource is present. UCP Scope is /planes/{planeType}/{planeName}/resourceGroup/{resourcegroupID} and Azure resource scope is /subscriptions/{subscriptionID}/resourceGroup/{resourcegroupID}
- credential - used to authorize requests. Usually a credential from azidentity.
- options - pass nil to accept the default values.
func (*ClientFactory) NewEnvironmentsClient ¶
func (c *ClientFactory) NewEnvironmentsClient() *EnvironmentsClient
NewEnvironmentsClient creates a new instance of EnvironmentsClient.
func (*ClientFactory) NewOperationsClient ¶
func (c *ClientFactory) NewOperationsClient() *OperationsClient
NewOperationsClient creates a new instance of OperationsClient.
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 EnvironmentProperties ¶
type EnvironmentProperties struct {
// Cloud provider configuration for the environment.
Providers *Providers
// List of Recipe Pack resource IDs linked to this environment.
RecipePacks []*string
// Simulated environment.
Simulated *bool
// READ-ONLY; The status of the asynchronous operation.
ProvisioningState *ProvisioningState
}
EnvironmentProperties - Environment properties
func (EnvironmentProperties) MarshalJSON ¶
func (e EnvironmentProperties) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type EnvironmentProperties.
func (*EnvironmentProperties) UnmarshalJSON ¶
func (e *EnvironmentProperties) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type EnvironmentProperties.
type EnvironmentResource ¶
type EnvironmentResource struct {
// REQUIRED; The geo-location where the resource lives
Location *string
// REQUIRED; The resource-specific properties for this resource.
Properties *EnvironmentProperties
// 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
}
EnvironmentResource - The environment resource
func (*EnvironmentResource) ConvertFrom ¶
func (dst *EnvironmentResource) ConvertFrom(src v1.DataModelInterface) error
ConvertFrom converts from version-agnostic datamodel to the versioned Environment resource.
func (*EnvironmentResource) ConvertTo ¶
func (src *EnvironmentResource) ConvertTo() (v1.DataModelInterface, error)
ConvertTo converts from the versioned Environment resource to version-agnostic datamodel.
func (EnvironmentResource) MarshalJSON ¶
func (e EnvironmentResource) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type EnvironmentResource.
func (*EnvironmentResource) UnmarshalJSON ¶
func (e *EnvironmentResource) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type EnvironmentResource.
type EnvironmentResourceListResult ¶
type EnvironmentResourceListResult struct {
// REQUIRED; The EnvironmentResource items on this page
Value []*EnvironmentResource
// The link to the next page of items
NextLink *string
}
EnvironmentResourceListResult - The response of a EnvironmentResource list operation.
func (EnvironmentResourceListResult) MarshalJSON ¶
func (e EnvironmentResourceListResult) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type EnvironmentResourceListResult.
func (*EnvironmentResourceListResult) UnmarshalJSON ¶
func (e *EnvironmentResourceListResult) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type EnvironmentResourceListResult.
type EnvironmentResourceUpdate ¶
type EnvironmentResourceUpdate struct {
// 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
}
EnvironmentResourceUpdate - The environment resource
func (EnvironmentResourceUpdate) MarshalJSON ¶
func (e EnvironmentResourceUpdate) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type EnvironmentResourceUpdate.
func (*EnvironmentResourceUpdate) UnmarshalJSON ¶
func (e *EnvironmentResourceUpdate) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type EnvironmentResourceUpdate.
type EnvironmentsClient ¶
type EnvironmentsClient struct {
// contains filtered or unexported fields
}
EnvironmentsClient contains the methods for the Environments group. Don't use this type directly, use NewEnvironmentsClient() instead.
func NewEnvironmentsClient ¶
func NewEnvironmentsClient(rootScope string, credential azcore.TokenCredential, options *arm.ClientOptions) (*EnvironmentsClient, error)
NewEnvironmentsClient creates a new instance of EnvironmentsClient with the specified values.
- rootScope - The scope in which the resource is present. UCP Scope is /planes/{planeType}/{planeName}/resourceGroup/{resourcegroupID} and Azure resource scope is /subscriptions/{subscriptionID}/resourceGroup/{resourcegroupID}
- credential - used to authorize requests. Usually a credential from azidentity.
- options - pass nil to accept the default values.
func (*EnvironmentsClient) CreateOrUpdate ¶
func (client *EnvironmentsClient) CreateOrUpdate(ctx context.Context, environmentName string, resource EnvironmentResource, options *EnvironmentsClientCreateOrUpdateOptions) (EnvironmentsClientCreateOrUpdateResponse, error)
CreateOrUpdate - Create a EnvironmentResource If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2025-08-01-preview
- environmentName - environment name
- resource - Resource create parameters.
- options - EnvironmentsClientCreateOrUpdateOptions contains the optional parameters for the EnvironmentsClient.CreateOrUpdate method.
func (*EnvironmentsClient) Delete ¶
func (client *EnvironmentsClient) Delete(ctx context.Context, environmentName string, options *EnvironmentsClientDeleteOptions) (EnvironmentsClientDeleteResponse, error)
Delete - Delete a EnvironmentResource If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2025-08-01-preview
- environmentName - environment name
- options - EnvironmentsClientDeleteOptions contains the optional parameters for the EnvironmentsClient.Delete method.
func (*EnvironmentsClient) Get ¶
func (client *EnvironmentsClient) Get(ctx context.Context, environmentName string, options *EnvironmentsClientGetOptions) (EnvironmentsClientGetResponse, error)
Get - Get a EnvironmentResource If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2025-08-01-preview
- environmentName - environment name
- options - EnvironmentsClientGetOptions contains the optional parameters for the EnvironmentsClient.Get method.
func (*EnvironmentsClient) NewListByScopePager ¶
func (client *EnvironmentsClient) NewListByScopePager(options *EnvironmentsClientListByScopeOptions) *runtime.Pager[EnvironmentsClientListByScopeResponse]
NewListByScopePager - List EnvironmentResource resources by Scope
Generated from API version 2025-08-01-preview
- options - EnvironmentsClientListByScopeOptions contains the optional parameters for the EnvironmentsClient.NewListByScopePager method.
func (*EnvironmentsClient) Update ¶
func (client *EnvironmentsClient) Update(ctx context.Context, environmentName string, properties EnvironmentResourceUpdate, options *EnvironmentsClientUpdateOptions) (EnvironmentsClientUpdateResponse, error)
Update - Update a EnvironmentResource If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2025-08-01-preview
- environmentName - environment name
- properties - The resource properties to be updated.
- options - EnvironmentsClientUpdateOptions contains the optional parameters for the EnvironmentsClient.Update method.
type EnvironmentsClientCreateOrUpdateOptions ¶
type EnvironmentsClientCreateOrUpdateOptions struct {
}
EnvironmentsClientCreateOrUpdateOptions contains the optional parameters for the EnvironmentsClient.CreateOrUpdate method.
type EnvironmentsClientCreateOrUpdateResponse ¶
type EnvironmentsClientCreateOrUpdateResponse struct {
// The environment resource
EnvironmentResource
}
EnvironmentsClientCreateOrUpdateResponse contains the response from method EnvironmentsClient.CreateOrUpdate.
type EnvironmentsClientDeleteOptions ¶
type EnvironmentsClientDeleteOptions struct {
}
EnvironmentsClientDeleteOptions contains the optional parameters for the EnvironmentsClient.Delete method.
type EnvironmentsClientDeleteResponse ¶
type EnvironmentsClientDeleteResponse struct {
}
EnvironmentsClientDeleteResponse contains the response from method EnvironmentsClient.Delete.
type EnvironmentsClientGetOptions ¶
type EnvironmentsClientGetOptions struct {
}
EnvironmentsClientGetOptions contains the optional parameters for the EnvironmentsClient.Get method.
type EnvironmentsClientGetResponse ¶
type EnvironmentsClientGetResponse struct {
// The environment resource
EnvironmentResource
}
EnvironmentsClientGetResponse contains the response from method EnvironmentsClient.Get.
type EnvironmentsClientListByScopeOptions ¶
type EnvironmentsClientListByScopeOptions struct {
}
EnvironmentsClientListByScopeOptions contains the optional parameters for the EnvironmentsClient.NewListByScopePager method.
type EnvironmentsClientListByScopeResponse ¶
type EnvironmentsClientListByScopeResponse struct {
// The response of a EnvironmentResource list operation.
EnvironmentResourceListResult
}
EnvironmentsClientListByScopeResponse contains the response from method EnvironmentsClient.NewListByScopePager.
type EnvironmentsClientUpdateOptions ¶
type EnvironmentsClientUpdateOptions struct {
}
EnvironmentsClientUpdateOptions contains the optional parameters for the EnvironmentsClient.Update method.
type EnvironmentsClientUpdateResponse ¶
type EnvironmentsClientUpdateResponse struct {
// The environment resource
EnvironmentResource
}
EnvironmentsClientUpdateResponse contains the response from method EnvironmentsClient.Update.
type ErrorAdditionalInfo ¶
type ErrorAdditionalInfo struct {
// READ-ONLY; The additional info.
Info 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 IdentitySettingKind ¶
type IdentitySettingKind string
IdentitySettingKind - IdentitySettingKind is the kind of supported external identity setting
const ( // IdentitySettingKindAzureComWorkload - azure ad workload identity IdentitySettingKindAzureComWorkload IdentitySettingKind = "azure.com.workload" // IdentitySettingKindSystemAssigned - System assigned managed identity IdentitySettingKindSystemAssigned IdentitySettingKind = "systemAssigned" // IdentitySettingKindSystemAssignedUserAssigned - System assigned and user assigned managed identity IdentitySettingKindSystemAssignedUserAssigned IdentitySettingKind = "systemAssignedUserAssigned" // IdentitySettingKindUndefined - undefined identity IdentitySettingKindUndefined IdentitySettingKind = "undefined" // IdentitySettingKindUserAssigned - User assigned managed identity IdentitySettingKindUserAssigned IdentitySettingKind = "userAssigned" )
func PossibleIdentitySettingKindValues ¶
func PossibleIdentitySettingKindValues() []IdentitySettingKind
PossibleIdentitySettingKindValues returns the possible values for the IdentitySettingKind const type.
type IdentitySettings ¶
type IdentitySettings struct {
// REQUIRED; kind of identity setting
Kind *IdentitySettingKind
// The list of user assigned managed identities
ManagedIdentity []*string
// The URI for your compute platform's OIDC issuer
OidcIssuer *string
// The resource ID of the provisioned identity
Resource *string
}
IdentitySettings is the external identity setting.
func (IdentitySettings) MarshalJSON ¶
func (i IdentitySettings) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type IdentitySettings.
func (*IdentitySettings) UnmarshalJSON ¶
func (i *IdentitySettings) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type IdentitySettings.
type Operation ¶
type Operation struct {
// Localized display information for this particular operation.
Display *OperationDisplay
// READ-ONLY; Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
ActionType *ActionType
// READ-ONLY; Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane
// operations.
IsDataAction *bool
// READ-ONLY; The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write",
// "Microsoft.Compute/virtualMachines/capture/action"
Name *string
// READ-ONLY; The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default
// value is "user,system"
Origin *Origin
}
Operation - Details of a REST API operation, returned from the Resource Provider Operations API
func (Operation) MarshalJSON ¶
MarshalJSON implements the json.Marshaller interface for type Operation.
func (*Operation) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaller interface for type Operation.
type OperationDisplay ¶
type OperationDisplay struct {
// READ-ONLY; The short, localized friendly description of the operation; suitable for tool tips and detailed views.
Description *string
// READ-ONLY; The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual
// Machine", "Restart Virtual Machine".
Operation *string
// READ-ONLY; The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft
// Compute".
Provider *string
// READ-ONLY; The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job
// Schedule Collections".
Resource *string
}
OperationDisplay - Localized display information for this particular operation.
func (OperationDisplay) MarshalJSON ¶
func (o OperationDisplay) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type OperationDisplay.
func (*OperationDisplay) UnmarshalJSON ¶
func (o *OperationDisplay) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type OperationDisplay.
type OperationListResult ¶
type OperationListResult struct {
// READ-ONLY; URL to get the next set of operation list results (if there are any).
NextLink *string
// READ-ONLY; List of operations supported by the resource provider
Value []*Operation
}
OperationListResult - A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.
func (OperationListResult) MarshalJSON ¶
func (o OperationListResult) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type OperationListResult.
func (*OperationListResult) UnmarshalJSON ¶
func (o *OperationListResult) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type OperationListResult.
type OperationsClient ¶
type OperationsClient struct {
// contains filtered or unexported fields
}
OperationsClient contains the methods for the Operations group. Don't use this type directly, use NewOperationsClient() instead.
func NewOperationsClient ¶
func NewOperationsClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*OperationsClient, error)
NewOperationsClient creates a new instance of OperationsClient with the specified values.
- credential - used to authorize requests. Usually a credential from azidentity.
- options - pass nil to accept the default values.
func (*OperationsClient) NewListPager ¶
func (client *OperationsClient) NewListPager(options *OperationsClientListOptions) *runtime.Pager[OperationsClientListResponse]
NewListPager - List the operations for the provider
Generated from API version 2025-08-01-preview
- options - OperationsClientListOptions contains the optional parameters for the OperationsClient.NewListPager method.
type OperationsClientListOptions ¶
type OperationsClientListOptions struct {
}
OperationsClientListOptions contains the optional parameters for the OperationsClient.NewListPager method.
type OperationsClientListResponse ¶
type OperationsClientListResponse struct {
// A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.
OperationListResult
}
OperationsClientListResponse contains the response from method OperationsClient.NewListPager.
type Origin ¶
type Origin string
Origin - The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
func PossibleOriginValues ¶
func PossibleOriginValues() []Origin
PossibleOriginValues returns the possible values for the Origin const type.
type Providers ¶
type Providers struct {
// The AWS cloud provider configuration.
Aws *ProvidersAws
// The Azure cloud provider configuration.
Azure *ProvidersAzure
// The Kubernetes provider configuration.
Kubernetes *ProvidersKubernetes
}
func (Providers) MarshalJSON ¶
MarshalJSON implements the json.Marshaller interface for type Providers.
func (*Providers) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaller interface for type Providers.
type ProvidersAws ¶
type ProvidersAws struct {
// REQUIRED; Target scope for AWS resources to be deployed into. For example: '/planes/aws/aws/accounts/000000000000/regions/us-west-2'.
Scope *string
}
ProvidersAws - The AWS cloud provider definition.
func (ProvidersAws) MarshalJSON ¶
func (p ProvidersAws) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type ProvidersAws.
func (*ProvidersAws) UnmarshalJSON ¶
func (p *ProvidersAws) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type ProvidersAws.
type ProvidersAzure ¶
type ProvidersAzure struct {
// REQUIRED; Azure subscription ID hosting deployed resources.
SubscriptionID *string
// External identity settings (moved from compute).
Identity *IdentitySettings
// Optional resource group name.
ResourceGroupName *string
}
ProvidersAzure - The Azure cloud provider definition.
func (ProvidersAzure) MarshalJSON ¶
func (p ProvidersAzure) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type ProvidersAzure.
func (*ProvidersAzure) UnmarshalJSON ¶
func (p *ProvidersAzure) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type ProvidersAzure.
type ProvidersKubernetes ¶
type ProvidersKubernetes struct {
// REQUIRED; Kubernetes namespace to deploy workloads into.
Namespace *string
}
func (ProvidersKubernetes) MarshalJSON ¶
func (p ProvidersKubernetes) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type ProvidersKubernetes.
func (*ProvidersKubernetes) UnmarshalJSON ¶
func (p *ProvidersKubernetes) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type ProvidersKubernetes.
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 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 ¶
MarshalJSON implements the json.Marshaller interface for type Resource.
func (*Resource) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaller interface for type Resource.
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.