Documentation ¶
Index ¶
- Constants
- type AliasPathType
- type AliasType
- type BasicDependency
- type DebugSetting
- type Dependency
- type Deployment
- type DeploymentExportResult
- type DeploymentExtended
- type DeploymentExtendedFilter
- type DeploymentListResult
- type DeploymentOperation
- type DeploymentOperationProperties
- type DeploymentOperationsListResult
- type DeploymentProperties
- type DeploymentPropertiesExtended
- type DeploymentValidateResult
- type ExportTemplateRequest
- type GenericResource
- type GenericResourceFilter
- type HTTPMessage
- type Identity
- type ParametersLink
- type Plan
- type Provider
- type ProviderListResult
- type ProviderResourceType
- type Resource
- type ResourceGroup
- type ResourceGroupExportResult
- type ResourceGroupFilter
- type ResourceGroupListResult
- type ResourceGroupProperties
- type ResourceListResult
- type ResourceManagementErrorWithDetails
- type ResourceProviderOperationDisplayProperties
- type ResourcesMoveInfo
- type Sku
- type SubResource
- type TagCount
- type TagDetails
- type TagValue
- type TagsListResult
- type TargetResource
- type TemplateLink
Constants ¶
const ( // DeploymentPropertiesModeIncremental captures enum value "Incremental" DeploymentPropertiesModeIncremental string = "Incremental" // DeploymentPropertiesModeComplete captures enum value "Complete" DeploymentPropertiesModeComplete string = "Complete" )
const ( // DeploymentPropertiesExtendedModeIncremental captures enum value "Incremental" DeploymentPropertiesExtendedModeIncremental string = "Incremental" // DeploymentPropertiesExtendedModeComplete captures enum value "Complete" DeploymentPropertiesExtendedModeComplete string = "Complete" )
const ( // IdentityTypeSystemAssigned captures enum value "SystemAssigned" IdentityTypeSystemAssigned string = "SystemAssigned" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AliasPathType ¶
type AliasPathType struct { // The API versions. APIVersions []string `json:"apiVersions"` // The path of an alias. Path string `json:"path,omitempty"` }
AliasPathType The type of the paths for alias. swagger:model AliasPathType
type AliasType ¶
type AliasType struct { // The alias name. Name string `json:"name,omitempty"` // The paths for an alias. Paths []*AliasPathType `json:"paths"` }
AliasType The alias type. swagger:model AliasType
type BasicDependency ¶
type BasicDependency struct { // The ID of the dependency. ID string `json:"id,omitempty"` // The dependency resource name. ResourceName string `json:"resourceName,omitempty"` // The dependency resource type. ResourceType string `json:"resourceType,omitempty"` }
BasicDependency Deployment dependency information. swagger:model BasicDependency
type DebugSetting ¶
type DebugSetting struct { // Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations. DetailLevel string `json:"detailLevel,omitempty"` }
DebugSetting debug setting swagger:model DebugSetting
type Dependency ¶
type Dependency struct { // The list of dependencies. DependsOn []*BasicDependency `json:"dependsOn"` // The ID of the dependency. ID string `json:"id,omitempty"` // The dependency resource name. ResourceName string `json:"resourceName,omitempty"` // The dependency resource type. ResourceType string `json:"resourceType,omitempty"` }
Dependency Deployment dependency information. swagger:model Dependency
type Deployment ¶
type Deployment struct { // The deployment properties. // Required: true Properties *DeploymentProperties `json:"properties"` }
Deployment Deployment operation parameters. swagger:model Deployment
type DeploymentExportResult ¶
type DeploymentExportResult struct {
// The template content.
Template interface{} `json:"template,omitempty"`
}
DeploymentExportResult The deployment export result. swagger:model DeploymentExportResult
type DeploymentExtended ¶
type DeploymentExtended struct { // The ID of the deployment. ID string `json:"id,omitempty"` // The name of the deployment. // Required: true Name *string `json:"name"` // Deployment properties. Properties *DeploymentPropertiesExtended `json:"properties,omitempty"` }
DeploymentExtended Deployment information. swagger:model DeploymentExtended
type DeploymentExtendedFilter ¶
type DeploymentExtendedFilter struct { // The provisioning state. ProvisioningState string `json:"provisioningState,omitempty"` }
DeploymentExtendedFilter Deployment filter. swagger:model DeploymentExtendedFilter
type DeploymentListResult ¶
type DeploymentListResult struct { // The URL to use for getting the next set of results. // Read Only: true NextLink string `json:"nextLink,omitempty"` // An array of deployments. Value []*DeploymentExtended `json:"value"` }
DeploymentListResult List of deployments. swagger:model DeploymentListResult
type DeploymentOperation ¶
type DeploymentOperation struct { // Full deployment operation ID. // Read Only: true ID string `json:"id,omitempty"` // Deployment operation ID. // Read Only: true OperationID string `json:"operationId,omitempty"` // Deployment properties. Properties *DeploymentOperationProperties `json:"properties,omitempty"` }
DeploymentOperation Deployment operation information. swagger:model DeploymentOperation
type DeploymentOperationProperties ¶
type DeploymentOperationProperties struct { // The state of the provisioning. // Read Only: true ProvisioningState string `json:"provisioningState,omitempty"` // The HTTP request message. // Read Only: true Request *HTTPMessage `json:"request,omitempty"` // The HTTP response message. // Read Only: true Response *HTTPMessage `json:"response,omitempty"` // Deployment operation service request id. // Read Only: true ServiceRequestID string `json:"serviceRequestId,omitempty"` // Operation status code. // Read Only: true StatusCode string `json:"statusCode,omitempty"` // Operation status message. // Read Only: true StatusMessage interface{} `json:"statusMessage,omitempty"` // The target resource. // Read Only: true TargetResource *TargetResource `json:"targetResource,omitempty"` // The date and time of the operation. // Read Only: true Timestamp strfmt.DateTime `json:"timestamp,omitempty"` }
DeploymentOperationProperties Deployment operation properties. swagger:model DeploymentOperationProperties
type DeploymentOperationsListResult ¶
type DeploymentOperationsListResult struct { // The URL to use for getting the next set of results. // Read Only: true NextLink string `json:"nextLink,omitempty"` // An array of deployment operations. Value []*DeploymentOperation `json:"value"` }
DeploymentOperationsListResult List of deployment operations. swagger:model DeploymentOperationsListResult
type DeploymentProperties ¶
type DeploymentProperties struct { // The debug setting of the deployment. DebugSetting *DebugSetting `json:"debugSetting,omitempty"` // The mode that is used to deploy resources. This value can be either Incremental or Complete. In Incremental mode, resources are deployed without deleting existing resources that are not included in the template. In Complete mode, resources are deployed and existing resources in the resource group that are not included in the template are deleted. Be careful when using Complete mode as you may unintentionally delete resources. // Required: true Mode *string `json:"mode"` // Name and value pairs that define the deployment parameters for the template. You use this element when you want to provide the parameter values directly in the request rather than link to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or a well formed JSON string. Parameters interface{} `json:"parameters,omitempty"` // The URI of parameters file. You use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both. ParametersLink *ParametersLink `json:"parametersLink,omitempty"` // The template content. You use this element when you want to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both. Template interface{} `json:"template,omitempty"` // The URI of the template. Use either the templateLink property or the template property, but not both. TemplateLink *TemplateLink `json:"templateLink,omitempty"` }
DeploymentProperties Deployment properties. swagger:model DeploymentProperties
type DeploymentPropertiesExtended ¶
type DeploymentPropertiesExtended struct { // The correlation ID of the deployment. // Read Only: true CorrelationID string `json:"correlationId,omitempty"` // The debug setting of the deployment. DebugSetting *DebugSetting `json:"debugSetting,omitempty"` // The list of deployment dependencies. Dependencies []*Dependency `json:"dependencies"` // The deployment mode. Possible values are Incremental and Complete. Mode string `json:"mode,omitempty"` // Key/value pairs that represent deploymentoutput. Outputs interface{} `json:"outputs,omitempty"` // Deployment parameters. Use only one of Parameters or ParametersLink. Parameters interface{} `json:"parameters,omitempty"` // The URI referencing the parameters. Use only one of Parameters or ParametersLink. ParametersLink *ParametersLink `json:"parametersLink,omitempty"` // The list of resource providers needed for the deployment. Providers []*Provider `json:"providers"` // The state of the provisioning. // Read Only: true ProvisioningState string `json:"provisioningState,omitempty"` // The template content. Use only one of Template or TemplateLink. Template interface{} `json:"template,omitempty"` // The URI referencing the template. Use only one of Template or TemplateLink. TemplateLink *TemplateLink `json:"templateLink,omitempty"` // The timestamp of the template deployment. // Read Only: true Timestamp strfmt.DateTime `json:"timestamp,omitempty"` }
DeploymentPropertiesExtended Deployment properties with additional details. swagger:model DeploymentPropertiesExtended
type DeploymentValidateResult ¶
type DeploymentValidateResult struct { // Validation error. Error *ResourceManagementErrorWithDetails `json:"error,omitempty"` // The template deployment properties. Properties *DeploymentPropertiesExtended `json:"properties,omitempty"` }
DeploymentValidateResult Information from validate template deployment response. swagger:model DeploymentValidateResult
type ExportTemplateRequest ¶
type ExportTemplateRequest struct { // The export template options. Supported values include 'IncludeParameterDefaultValue', 'IncludeComments' or 'IncludeParameterDefaultValue, IncludeComments Options string `json:"options,omitempty"` // The IDs of the resources. The only supported string currently is '*' (all resources). Future updates will support exporting specific resources. Resources []string `json:"resources"` }
ExportTemplateRequest Export resource group template request parameters. swagger:model ExportTemplateRequest
type GenericResource ¶
type GenericResource struct { Resource // The identity of the resource. Identity *Identity `json:"identity,omitempty"` // The kind of the resource. // Pattern: ^[-\w\._,\(\)]+$ Kind string `json:"kind,omitempty"` // ID of the resource that manages this resource. ManagedBy string `json:"managedBy,omitempty"` // The plan of the resource. Plan *Plan `json:"plan,omitempty"` // The resource properties. Properties interface{} `json:"properties,omitempty"` // The SKU of the resource. Sku *Sku `json:"sku,omitempty"` }
GenericResource Resource information. swagger:model GenericResource
func (GenericResource) MarshalJSON ¶
func (m GenericResource) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*GenericResource) UnmarshalJSON ¶
func (m *GenericResource) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type GenericResourceFilter ¶
type GenericResourceFilter struct { // The resource type. ResourceType string `json:"resourceType,omitempty"` // The tag name. Tagname string `json:"tagname,omitempty"` // The tag value. Tagvalue string `json:"tagvalue,omitempty"` }
GenericResourceFilter Resource filter. swagger:model GenericResourceFilter
type HTTPMessage ¶
type HTTPMessage struct {
// HTTP message content.
Content interface{} `json:"content,omitempty"`
}
HTTPMessage Http message swagger:model HttpMessage
type Identity ¶
type Identity struct { // The principal ID of resource identity. // Read Only: true PrincipalID string `json:"principalId,omitempty"` // The tenant ID of resource. // Read Only: true TenantID string `json:"tenantId,omitempty"` // The identity type. Type string `json:"type,omitempty"` }
Identity Identity for the resource. swagger:model Identity
type ParametersLink ¶
type ParametersLink struct { // If included, must match the ContentVersion in the template. ContentVersion string `json:"contentVersion,omitempty"` // The URI of the parameters file. // Required: true URI *string `json:"uri"` }
ParametersLink Entity representing the reference to the deployment paramaters. swagger:model ParametersLink
type Plan ¶
type Plan struct { // The plan ID. Name string `json:"name,omitempty"` // The offer ID. Product string `json:"product,omitempty"` // The promotion code. PromotionCode string `json:"promotionCode,omitempty"` // The publisher ID. Publisher string `json:"publisher,omitempty"` }
Plan Plan for the resource. swagger:model Plan
type Provider ¶
type Provider struct { // The provider ID. // Read Only: true ID string `json:"id,omitempty"` // The namespace of the resource provider. Namespace string `json:"namespace,omitempty"` // The registration state of the provider. // Read Only: true RegistrationState string `json:"registrationState,omitempty"` // The collection of provider resource types. // Read Only: true ResourceTypes []*ProviderResourceType `json:"resourceTypes"` }
Provider Resource provider information. swagger:model Provider
type ProviderListResult ¶
type ProviderListResult struct { // The URL to use for getting the next set of results. // Read Only: true NextLink string `json:"nextLink,omitempty"` // An array of resource providers. Value []*Provider `json:"value"` }
ProviderListResult List of resource providers. swagger:model ProviderListResult
type ProviderResourceType ¶
type ProviderResourceType struct { // The aliases that are supported by this resource type. Aliases []*AliasType `json:"aliases"` // The API version. APIVersions []string `json:"apiVersions"` // The collection of locations where this resource type can be created. Locations []string `json:"locations"` // The properties. Properties map[string]string `json:"properties,omitempty"` // The resource type. ResourceType string `json:"resourceType,omitempty"` }
ProviderResourceType Resource type managed by the resource provider. swagger:model ProviderResourceType
type Resource ¶
type Resource struct { // Resource ID // Read Only: true ID string `json:"id,omitempty"` // Resource location Location string `json:"location,omitempty"` // Resource name // Read Only: true Name string `json:"name,omitempty"` // Resource tags Tags map[string]string `json:"tags,omitempty"` // Resource type // Read Only: true Type string `json:"type,omitempty"` }
Resource resource swagger:model Resource
type ResourceGroup ¶
type ResourceGroup struct { // The ID of the resource group. // Read Only: true ID string `json:"id,omitempty"` // The location of the resource group. It cannot be changed after the resource group has been created. It muct be one of the supported Azure locations. // Required: true Location *string `json:"location"` // The ID of the resource that manages this resource group. ManagedBy string `json:"managedBy,omitempty"` // The name of the resource group. Name string `json:"name,omitempty"` // properties Properties *ResourceGroupProperties `json:"properties,omitempty"` // The tags attached to the resource group. Tags map[string]string `json:"tags,omitempty"` }
ResourceGroup Resource group information. swagger:model ResourceGroup
type ResourceGroupExportResult ¶
type ResourceGroupExportResult struct { // The error. Error *ResourceManagementErrorWithDetails `json:"error,omitempty"` // The template content. Template interface{} `json:"template,omitempty"` }
ResourceGroupExportResult resource group export result swagger:model ResourceGroupExportResult
type ResourceGroupFilter ¶
type ResourceGroupFilter struct { // The tag name. TagName string `json:"tagName,omitempty"` // The tag value. TagValue string `json:"tagValue,omitempty"` }
ResourceGroupFilter Resource group filter. swagger:model ResourceGroupFilter
type ResourceGroupListResult ¶
type ResourceGroupListResult struct { // The URL to use for getting the next set of results. // Read Only: true NextLink string `json:"nextLink,omitempty"` // An array of resource groups. Value []*ResourceGroup `json:"value"` }
ResourceGroupListResult List of resource groups. swagger:model ResourceGroupListResult
type ResourceGroupProperties ¶
type ResourceGroupProperties struct { // The provisioning state. // Read Only: true ProvisioningState string `json:"provisioningState,omitempty"` }
ResourceGroupProperties The resource group properties. swagger:model ResourceGroupProperties
type ResourceListResult ¶
type ResourceListResult struct { // The URL to use for getting the next set of results. // Read Only: true NextLink string `json:"nextLink,omitempty"` // An array of resources. Value []*GenericResource `json:"value"` }
ResourceListResult List of resource groups. swagger:model ResourceListResult
type ResourceManagementErrorWithDetails ¶
type ResourceManagementErrorWithDetails struct { // The error code returned when exporting the template. // Read Only: true Code string `json:"code,omitempty"` // Validation error. // Read Only: true Details []*ResourceManagementErrorWithDetails `json:"details"` // The error message describing the export error. // Read Only: true Message string `json:"message,omitempty"` // The target of the error. // Read Only: true Target string `json:"target,omitempty"` }
ResourceManagementErrorWithDetails resource management error with details swagger:model ResourceManagementErrorWithDetails
type ResourceProviderOperationDisplayProperties ¶
type ResourceProviderOperationDisplayProperties struct { // Operation description. Description string `json:"description,omitempty"` // Operation. Operation string `json:"operation,omitempty"` // Operation provider. Provider string `json:"provider,omitempty"` // Operation description. Publisher string `json:"publisher,omitempty"` // Operation resource. Resource string `json:"resource,omitempty"` }
ResourceProviderOperationDisplayProperties Resource provider operation's display properties. swagger:model ResourceProviderOperationDisplayProperties
type ResourcesMoveInfo ¶
type ResourcesMoveInfo struct { // The IDs of the resources. Resources []string `json:"resources"` // The target resource group. TargetResourceGroup string `json:"targetResourceGroup,omitempty"` }
ResourcesMoveInfo Parameters of move resources. swagger:model ResourcesMoveInfo
type Sku ¶
type Sku struct { // The SKU capacity. Capacity int32 `json:"capacity,omitempty"` // The SKU family. Family string `json:"family,omitempty"` // The SKU model. Model string `json:"model,omitempty"` // The SKU name. Name string `json:"name,omitempty"` // The SKU size. Size string `json:"size,omitempty"` // The SKU tier. Tier string `json:"tier,omitempty"` }
Sku SKU for the resource. swagger:model Sku
type SubResource ¶
type SubResource struct { // Resource ID ID string `json:"id,omitempty"` }
SubResource sub resource swagger:model SubResource
type TagCount ¶
type TagCount struct { // Type of count. Type string `json:"type,omitempty"` // Value of count. Value int64 `json:"value,omitempty"` }
TagCount Tag count. swagger:model TagCount
type TagDetails ¶
type TagDetails struct { // The total number of resources that use the resource tag. When a tag is initially created and has no associated resources, the value is 0. Count *TagCount `json:"count,omitempty"` // The tag ID. ID string `json:"id,omitempty"` // The tag name. TagName string `json:"tagName,omitempty"` // The list of tag values. Values []*TagValue `json:"values"` }
TagDetails Tag details. swagger:model TagDetails
type TagValue ¶
type TagValue struct { // The tag value count. Count *TagCount `json:"count,omitempty"` // The tag ID. ID string `json:"id,omitempty"` // The tag value. TagValue string `json:"tagValue,omitempty"` }
TagValue Tag information. swagger:model TagValue
type TagsListResult ¶
type TagsListResult struct { // The URL to use for getting the next set of results. // Read Only: true NextLink string `json:"nextLink,omitempty"` // An array of tags. Value []*TagDetails `json:"value"` }
TagsListResult List of subscription tags. swagger:model TagsListResult
type TargetResource ¶
type TargetResource struct { // The ID of the resource. ID string `json:"id,omitempty"` // The name of the resource. ResourceName string `json:"resourceName,omitempty"` // The type of the resource. ResourceType string `json:"resourceType,omitempty"` }
TargetResource Target resource. swagger:model TargetResource
type TemplateLink ¶
type TemplateLink struct { // If included, must match the ContentVersion in the template. ContentVersion string `json:"contentVersion,omitempty"` // The URI of the template to deploy. // Required: true URI *string `json:"uri"` }
TemplateLink Entity representing the reference to the template. swagger:model TemplateLink
Source Files ¶
- alias_path_type.go
- alias_type.go
- basic_dependency.go
- debug_setting.go
- dependency.go
- deployment.go
- deployment_export_result.go
- deployment_extended.go
- deployment_extended_filter.go
- deployment_list_result.go
- deployment_operation.go
- deployment_operation_properties.go
- deployment_operations_list_result.go
- deployment_properties.go
- deployment_properties_extended.go
- deployment_validate_result.go
- export_template_request.go
- generic_resource.go
- generic_resource_filter.go
- http_message.go
- identity.go
- parameters_link.go
- plan.go
- provider.go
- provider_list_result.go
- provider_resource_type.go
- resource.go
- resource_group.go
- resource_group_export_result.go
- resource_group_filter.go
- resource_group_list_result.go
- resource_group_properties.go
- resource_list_result.go
- resource_management_error_with_details.go
- resource_provider_operation_display_properties.go
- resources_move_info.go
- sku.go
- sub_resource.go
- tag_count.go
- tag_details.go
- tag_value.go
- tags_list_result.go
- target_resource.go
- template_link.go