resourceproviders

package
v0.20240320.1143605 Latest Latest
Warning

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

Go to latest
Published: Mar 20, 2024 License: MPL-2.0 Imports: 13 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/web/2022-09-01/resourceproviders Documentation

The resourceproviders SDK allows for interaction with the Azure Resource Manager Service web (API Version 2022-09-01).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/web/2022-09-01/resourceproviders"

Client Initialization

client := resourceproviders.NewResourceProvidersClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ResourceProvidersClient.CheckNameAvailability

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

payload := resourceproviders.ResourceNameAvailabilityRequest{
	// ...
}


read, err := client.CheckNameAvailability(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ResourceProvidersClient.GetPublishingUser

ctx := context.TODO()


read, err := client.GetPublishingUser(ctx)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ResourceProvidersClient.GetSourceControl

ctx := context.TODO()
id := resourceproviders.NewSourceControlID("sourceControlValue")

read, err := client.GetSourceControl(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ResourceProvidersClient.GetSubscriptionDeploymentLocations

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

read, err := client.GetSubscriptionDeploymentLocations(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ResourceProvidersClient.ListBillingMeters

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

// alternatively `client.ListBillingMeters(ctx, id, resourceproviders.DefaultListBillingMetersOperationOptions())` can be used to do batched pagination
items, err := client.ListBillingMetersComplete(ctx, id, resourceproviders.DefaultListBillingMetersOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: ResourceProvidersClient.ListCustomHostNameSites

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

// alternatively `client.ListCustomHostNameSites(ctx, id, resourceproviders.DefaultListCustomHostNameSitesOperationOptions())` can be used to do batched pagination
items, err := client.ListCustomHostNameSitesComplete(ctx, id, resourceproviders.DefaultListCustomHostNameSitesOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: ResourceProvidersClient.ListGeoRegions

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

// alternatively `client.ListGeoRegions(ctx, id, resourceproviders.DefaultListGeoRegionsOperationOptions())` can be used to do batched pagination
items, err := client.ListGeoRegionsComplete(ctx, id, resourceproviders.DefaultListGeoRegionsOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: ResourceProvidersClient.ListPremierAddOnOffers

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

// alternatively `client.ListPremierAddOnOffers(ctx, id)` can be used to do batched pagination
items, err := client.ListPremierAddOnOffersComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: ResourceProvidersClient.ListSiteIdentifiersAssignedToHostName

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

payload := resourceproviders.NameIdentifier{
	// ...
}


// alternatively `client.ListSiteIdentifiersAssignedToHostName(ctx, id, payload)` can be used to do batched pagination
items, err := client.ListSiteIdentifiersAssignedToHostNameComplete(ctx, id, payload)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: ResourceProvidersClient.ListSkus

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

read, err := client.ListSkus(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ResourceProvidersClient.ListSourceControls

ctx := context.TODO()


// alternatively `client.ListSourceControls(ctx)` can be used to do batched pagination
items, err := client.ListSourceControlsComplete(ctx)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: ResourceProvidersClient.Move

ctx := context.TODO()
id := commonids.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group")

payload := resourceproviders.CsmMoveResourceEnvelope{
	// ...
}


read, err := client.Move(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ResourceProvidersClient.UpdatePublishingUser

ctx := context.TODO()

payload := resourceproviders.User{
	// ...
}


read, err := client.UpdatePublishingUser(ctx, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ResourceProvidersClient.UpdateSourceControl

ctx := context.TODO()
id := resourceproviders.NewSourceControlID("sourceControlValue")

payload := resourceproviders.SourceControl{
	// ...
}


read, err := client.UpdateSourceControl(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ResourceProvidersClient.Validate

ctx := context.TODO()
id := commonids.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group")

payload := resourceproviders.ValidateRequest{
	// ...
}


read, err := client.Validate(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ResourceProvidersClient.ValidateMove

ctx := context.TODO()
id := commonids.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group")

payload := resourceproviders.CsmMoveResourceEnvelope{
	// ...
}


read, err := client.ValidateMove(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ResourceProvidersClient.VerifyHostingEnvironmentVnet

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

payload := resourceproviders.VnetParameters{
	// ...
}


read, err := client.VerifyHostingEnvironmentVnet(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForAppServicePlanRestrictions

func PossibleValuesForAppServicePlanRestrictions() []string

func PossibleValuesForCheckNameResourceTypes

func PossibleValuesForCheckNameResourceTypes() []string

func PossibleValuesForCustomDnsSuffixProvisioningState

func PossibleValuesForCustomDnsSuffixProvisioningState() []string

func PossibleValuesForHostingEnvironmentStatus

func PossibleValuesForHostingEnvironmentStatus() []string

func PossibleValuesForInAvailabilityReasonType

func PossibleValuesForInAvailabilityReasonType() []string

func PossibleValuesForLoadBalancingMode

func PossibleValuesForLoadBalancingMode() []string

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func PossibleValuesForSkuName

func PossibleValuesForSkuName() []string

func PossibleValuesForUpgradeAvailability

func PossibleValuesForUpgradeAvailability() []string

func PossibleValuesForUpgradePreference

func PossibleValuesForUpgradePreference() []string

func PossibleValuesForValidateResourceTypes

func PossibleValuesForValidateResourceTypes() []string

func ValidateSourceControlID

func ValidateSourceControlID(input interface{}, key string) (warnings []string, errors []error)

ValidateSourceControlID checks that 'input' can be parsed as a Source Control ID

Types

type AppServiceEnvironment

type AppServiceEnvironment struct {
	ClusterSettings              *[]NameValuePair              `json:"clusterSettings,omitempty"`
	CustomDnsSuffixConfiguration *CustomDnsSuffixConfiguration `json:"customDnsSuffixConfiguration,omitempty"`
	DedicatedHostCount           *int64                        `json:"dedicatedHostCount,omitempty"`
	DnsSuffix                    *string                       `json:"dnsSuffix,omitempty"`
	FrontEndScaleFactor          *int64                        `json:"frontEndScaleFactor,omitempty"`
	HasLinuxWorkers              *bool                         `json:"hasLinuxWorkers,omitempty"`
	IPsslAddressCount            *int64                        `json:"ipsslAddressCount,omitempty"`
	InternalLoadBalancingMode    *LoadBalancingMode            `json:"internalLoadBalancingMode,omitempty"`
	MaximumNumberOfMachines      *int64                        `json:"maximumNumberOfMachines,omitempty"`
	MultiRoleCount               *int64                        `json:"multiRoleCount,omitempty"`
	MultiSize                    *string                       `json:"multiSize,omitempty"`
	NetworkingConfiguration      *AseV3NetworkingConfiguration `json:"networkingConfiguration,omitempty"`
	ProvisioningState            *ProvisioningState            `json:"provisioningState,omitempty"`
	Status                       *HostingEnvironmentStatus     `json:"status,omitempty"`
	Suspended                    *bool                         `json:"suspended,omitempty"`
	UpgradeAvailability          *UpgradeAvailability          `json:"upgradeAvailability,omitempty"`
	UpgradePreference            *UpgradePreference            `json:"upgradePreference,omitempty"`
	UserWhitelistedIPRanges      *[]string                     `json:"userWhitelistedIpRanges,omitempty"`
	VirtualNetwork               VirtualNetworkProfile         `json:"virtualNetwork"`
	ZoneRedundant                *bool                         `json:"zoneRedundant,omitempty"`
}

type AppServicePlanRestrictions

type AppServicePlanRestrictions string
const (
	AppServicePlanRestrictionsBasic    AppServicePlanRestrictions = "Basic"
	AppServicePlanRestrictionsFree     AppServicePlanRestrictions = "Free"
	AppServicePlanRestrictionsNone     AppServicePlanRestrictions = "None"
	AppServicePlanRestrictionsPremium  AppServicePlanRestrictions = "Premium"
	AppServicePlanRestrictionsShared   AppServicePlanRestrictions = "Shared"
	AppServicePlanRestrictionsStandard AppServicePlanRestrictions = "Standard"
)

func (*AppServicePlanRestrictions) UnmarshalJSON

func (s *AppServicePlanRestrictions) UnmarshalJSON(bytes []byte) error

type AseV3NetworkingConfiguration

type AseV3NetworkingConfiguration struct {
	Id         *string                                 `json:"id,omitempty"`
	Kind       *string                                 `json:"kind,omitempty"`
	Name       *string                                 `json:"name,omitempty"`
	Properties *AseV3NetworkingConfigurationProperties `json:"properties,omitempty"`
	Type       *string                                 `json:"type,omitempty"`
}

type AseV3NetworkingConfigurationProperties

type AseV3NetworkingConfigurationProperties struct {
	AllowNewPrivateEndpointConnections *bool     `json:"allowNewPrivateEndpointConnections,omitempty"`
	ExternalInboundIPAddresses         *[]string `json:"externalInboundIpAddresses,omitempty"`
	FtpEnabled                         *bool     `json:"ftpEnabled,omitempty"`
	InboundIPAddressOverride           *string   `json:"inboundIpAddressOverride,omitempty"`
	InternalInboundIPAddresses         *[]string `json:"internalInboundIpAddresses,omitempty"`
	LinuxOutboundIPAddresses           *[]string `json:"linuxOutboundIpAddresses,omitempty"`
	RemoteDebugEnabled                 *bool     `json:"remoteDebugEnabled,omitempty"`
	WindowsOutboundIPAddresses         *[]string `json:"windowsOutboundIpAddresses,omitempty"`
}

type BillingMeter

type BillingMeter struct {
	Id         *string                 `json:"id,omitempty"`
	Kind       *string                 `json:"kind,omitempty"`
	Name       *string                 `json:"name,omitempty"`
	Properties *BillingMeterProperties `json:"properties,omitempty"`
	Type       *string                 `json:"type,omitempty"`
}

type BillingMeterOperationPredicate

type BillingMeterOperationPredicate struct {
	Id   *string
	Kind *string
	Name *string
	Type *string
}

func (BillingMeterOperationPredicate) Matches

type BillingMeterProperties

type BillingMeterProperties struct {
	BillingLocation *string  `json:"billingLocation,omitempty"`
	FriendlyName    *string  `json:"friendlyName,omitempty"`
	MeterId         *string  `json:"meterId,omitempty"`
	Multiplier      *float64 `json:"multiplier,omitempty"`
	OsType          *string  `json:"osType,omitempty"`
	ResourceType    *string  `json:"resourceType,omitempty"`
	ShortName       *string  `json:"shortName,omitempty"`
}

type Capability

type Capability struct {
	Name   *string `json:"name,omitempty"`
	Reason *string `json:"reason,omitempty"`
	Value  *string `json:"value,omitempty"`
}

type CheckNameAvailabilityOperationResponse

type CheckNameAvailabilityOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ResourceNameAvailability
}

type CheckNameResourceTypes

type CheckNameResourceTypes string
const (
	CheckNameResourceTypesHostingEnvironment                   CheckNameResourceTypes = "HostingEnvironment"
	CheckNameResourceTypesMicrosoftPointWebHostingEnvironments CheckNameResourceTypes = "Microsoft.Web/hostingEnvironments"
	CheckNameResourceTypesMicrosoftPointWebPublishingUsers     CheckNameResourceTypes = "Microsoft.Web/publishingUsers"
	CheckNameResourceTypesMicrosoftPointWebSites               CheckNameResourceTypes = "Microsoft.Web/sites"
	CheckNameResourceTypesMicrosoftPointWebSitesSlots          CheckNameResourceTypes = "Microsoft.Web/sites/slots"
	CheckNameResourceTypesPublishingUser                       CheckNameResourceTypes = "PublishingUser"
	CheckNameResourceTypesSite                                 CheckNameResourceTypes = "Site"
	CheckNameResourceTypesSlot                                 CheckNameResourceTypes = "Slot"
)

func (*CheckNameResourceTypes) UnmarshalJSON

func (s *CheckNameResourceTypes) UnmarshalJSON(bytes []byte) error

type CsmMoveResourceEnvelope

type CsmMoveResourceEnvelope struct {
	Resources           *[]string `json:"resources,omitempty"`
	TargetResourceGroup *string   `json:"targetResourceGroup,omitempty"`
}

type CustomDnsSuffixConfiguration

type CustomDnsSuffixConfiguration struct {
	Id         *string                                 `json:"id,omitempty"`
	Kind       *string                                 `json:"kind,omitempty"`
	Name       *string                                 `json:"name,omitempty"`
	Properties *CustomDnsSuffixConfigurationProperties `json:"properties,omitempty"`
	Type       *string                                 `json:"type,omitempty"`
}

type CustomDnsSuffixConfigurationProperties

type CustomDnsSuffixConfigurationProperties struct {
	CertificateUrl            *string                           `json:"certificateUrl,omitempty"`
	DnsSuffix                 *string                           `json:"dnsSuffix,omitempty"`
	KeyVaultReferenceIdentity *string                           `json:"keyVaultReferenceIdentity,omitempty"`
	ProvisioningDetails       *string                           `json:"provisioningDetails,omitempty"`
	ProvisioningState         *CustomDnsSuffixProvisioningState `json:"provisioningState,omitempty"`
}

type CustomDnsSuffixProvisioningState

type CustomDnsSuffixProvisioningState string
const (
	CustomDnsSuffixProvisioningStateDegraded   CustomDnsSuffixProvisioningState = "Degraded"
	CustomDnsSuffixProvisioningStateFailed     CustomDnsSuffixProvisioningState = "Failed"
	CustomDnsSuffixProvisioningStateInProgress CustomDnsSuffixProvisioningState = "InProgress"
	CustomDnsSuffixProvisioningStateSucceeded  CustomDnsSuffixProvisioningState = "Succeeded"
)

func (*CustomDnsSuffixProvisioningState) UnmarshalJSON

func (s *CustomDnsSuffixProvisioningState) UnmarshalJSON(bytes []byte) error

type CustomHostnameSites

type CustomHostnameSites struct {
	Id         *string                        `json:"id,omitempty"`
	Kind       *string                        `json:"kind,omitempty"`
	Name       *string                        `json:"name,omitempty"`
	Properties *CustomHostnameSitesProperties `json:"properties,omitempty"`
	Type       *string                        `json:"type,omitempty"`
}

type CustomHostnameSitesOperationPredicate

type CustomHostnameSitesOperationPredicate struct {
	Id   *string
	Kind *string
	Name *string
	Type *string
}

func (CustomHostnameSitesOperationPredicate) Matches

type CustomHostnameSitesProperties

type CustomHostnameSitesProperties struct {
	CustomHostname  *string       `json:"customHostname,omitempty"`
	Region          *string       `json:"region,omitempty"`
	SiteResourceIds *[]Identifier `json:"siteResourceIds,omitempty"`
}

type DeploymentLocations

type DeploymentLocations struct {
	HostingEnvironmentDeploymentInfos *[]HostingEnvironmentDeploymentInfo `json:"hostingEnvironmentDeploymentInfos,omitempty"`
	HostingEnvironments               *[]AppServiceEnvironment            `json:"hostingEnvironments,omitempty"`
	Locations                         *[]GeoRegion                        `json:"locations,omitempty"`
}

type GeoRegion

type GeoRegion struct {
	Id         *string              `json:"id,omitempty"`
	Kind       *string              `json:"kind,omitempty"`
	Name       *string              `json:"name,omitempty"`
	Properties *GeoRegionProperties `json:"properties,omitempty"`
	Type       *string              `json:"type,omitempty"`
}

type GeoRegionOperationPredicate

type GeoRegionOperationPredicate struct {
	Id   *string
	Kind *string
	Name *string
	Type *string
}

func (GeoRegionOperationPredicate) Matches

func (p GeoRegionOperationPredicate) Matches(input GeoRegion) bool

type GeoRegionProperties

type GeoRegionProperties struct {
	Description *string `json:"description,omitempty"`
	DisplayName *string `json:"displayName,omitempty"`
	OrgDomain   *string `json:"orgDomain,omitempty"`
}

type GetPublishingUserOperationResponse

type GetPublishingUserOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *User
}

type GetSourceControlOperationResponse

type GetSourceControlOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SourceControl
}

type GetSubscriptionDeploymentLocationsOperationResponse

type GetSubscriptionDeploymentLocationsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DeploymentLocations
}

type GlobalCsmSkuDescription

type GlobalCsmSkuDescription struct {
	Capabilities *[]Capability `json:"capabilities,omitempty"`
	Capacity     *SkuCapacity  `json:"capacity,omitempty"`
	Family       *string       `json:"family,omitempty"`
	Locations    *[]string     `json:"locations,omitempty"`
	Name         *string       `json:"name,omitempty"`
	Size         *string       `json:"size,omitempty"`
	Tier         *string       `json:"tier,omitempty"`
}

type HostingEnvironmentDeploymentInfo

type HostingEnvironmentDeploymentInfo struct {
	Location *string `json:"location,omitempty"`
	Name     *string `json:"name,omitempty"`
}

type HostingEnvironmentStatus

type HostingEnvironmentStatus string
const (
	HostingEnvironmentStatusDeleting  HostingEnvironmentStatus = "Deleting"
	HostingEnvironmentStatusPreparing HostingEnvironmentStatus = "Preparing"
	HostingEnvironmentStatusReady     HostingEnvironmentStatus = "Ready"
	HostingEnvironmentStatusScaling   HostingEnvironmentStatus = "Scaling"
)

func (*HostingEnvironmentStatus) UnmarshalJSON

func (s *HostingEnvironmentStatus) UnmarshalJSON(bytes []byte) error

type Identifier

type Identifier struct {
	Id         *string               `json:"id,omitempty"`
	Kind       *string               `json:"kind,omitempty"`
	Name       *string               `json:"name,omitempty"`
	Properties *IdentifierProperties `json:"properties,omitempty"`
	Type       *string               `json:"type,omitempty"`
}

type IdentifierOperationPredicate

type IdentifierOperationPredicate struct {
	Id   *string
	Kind *string
	Name *string
	Type *string
}

func (IdentifierOperationPredicate) Matches

func (p IdentifierOperationPredicate) Matches(input Identifier) bool

type IdentifierProperties

type IdentifierProperties struct {
	Id *string `json:"id,omitempty"`
}

type InAvailabilityReasonType

type InAvailabilityReasonType string
const (
	InAvailabilityReasonTypeAlreadyExists InAvailabilityReasonType = "AlreadyExists"
	InAvailabilityReasonTypeInvalid       InAvailabilityReasonType = "Invalid"
)

func (*InAvailabilityReasonType) UnmarshalJSON

func (s *InAvailabilityReasonType) UnmarshalJSON(bytes []byte) error

type ListBillingMetersCompleteResult

type ListBillingMetersCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []BillingMeter
}

type ListBillingMetersOperationOptions

type ListBillingMetersOperationOptions struct {
	BillingLocation *string
	OsType          *string
}

func DefaultListBillingMetersOperationOptions

func DefaultListBillingMetersOperationOptions() ListBillingMetersOperationOptions

func (ListBillingMetersOperationOptions) ToHeaders

func (ListBillingMetersOperationOptions) ToOData

func (ListBillingMetersOperationOptions) ToQuery

type ListBillingMetersOperationResponse

type ListBillingMetersOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]BillingMeter
}

type ListCustomHostNameSitesCompleteResult

type ListCustomHostNameSitesCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []CustomHostnameSites
}

type ListCustomHostNameSitesOperationOptions

type ListCustomHostNameSitesOperationOptions struct {
	Hostname *string
}

func DefaultListCustomHostNameSitesOperationOptions

func DefaultListCustomHostNameSitesOperationOptions() ListCustomHostNameSitesOperationOptions

func (ListCustomHostNameSitesOperationOptions) ToHeaders

func (ListCustomHostNameSitesOperationOptions) ToOData

func (ListCustomHostNameSitesOperationOptions) ToQuery

type ListCustomHostNameSitesOperationResponse

type ListCustomHostNameSitesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]CustomHostnameSites
}

type ListGeoRegionsCompleteResult

type ListGeoRegionsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []GeoRegion
}

type ListGeoRegionsOperationOptions

type ListGeoRegionsOperationOptions struct {
	LinuxDynamicWorkersEnabled *bool
	LinuxWorkersEnabled        *bool
	Sku                        *SkuName
	XenonWorkersEnabled        *bool
}

func DefaultListGeoRegionsOperationOptions

func DefaultListGeoRegionsOperationOptions() ListGeoRegionsOperationOptions

func (ListGeoRegionsOperationOptions) ToHeaders

func (ListGeoRegionsOperationOptions) ToOData

func (ListGeoRegionsOperationOptions) ToQuery

type ListGeoRegionsOperationResponse

type ListGeoRegionsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]GeoRegion
}

type ListPremierAddOnOffersCompleteResult

type ListPremierAddOnOffersCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []PremierAddOnOffer
}

type ListPremierAddOnOffersOperationResponse

type ListPremierAddOnOffersOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]PremierAddOnOffer
}

type ListSiteIdentifiersAssignedToHostNameCompleteResult

type ListSiteIdentifiersAssignedToHostNameCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Identifier
}

type ListSiteIdentifiersAssignedToHostNameOperationResponse

type ListSiteIdentifiersAssignedToHostNameOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Identifier
}

type ListSkusOperationResponse

type ListSkusOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SkuInfos
}

type ListSourceControlsCompleteResult

type ListSourceControlsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []SourceControl
}

type ListSourceControlsOperationResponse

type ListSourceControlsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]SourceControl
}

type LoadBalancingMode

type LoadBalancingMode string
const (
	LoadBalancingModeNone          LoadBalancingMode = "None"
	LoadBalancingModePublishing    LoadBalancingMode = "Publishing"
	LoadBalancingModeWeb           LoadBalancingMode = "Web"
	LoadBalancingModeWebPublishing LoadBalancingMode = "Web, Publishing"
)

func (*LoadBalancingMode) UnmarshalJSON

func (s *LoadBalancingMode) UnmarshalJSON(bytes []byte) error

type MoveOperationResponse

type MoveOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type NameIdentifier

type NameIdentifier struct {
	Name *string `json:"name,omitempty"`
}

type NameValuePair

type NameValuePair struct {
	Name  *string `json:"name,omitempty"`
	Value *string `json:"value,omitempty"`
}

type PremierAddOnOffer

type PremierAddOnOffer struct {
	Id         *string                      `json:"id,omitempty"`
	Kind       *string                      `json:"kind,omitempty"`
	Name       *string                      `json:"name,omitempty"`
	Properties *PremierAddOnOfferProperties `json:"properties,omitempty"`
	Type       *string                      `json:"type,omitempty"`
}

type PremierAddOnOfferOperationPredicate

type PremierAddOnOfferOperationPredicate struct {
	Id   *string
	Kind *string
	Name *string
	Type *string
}

func (PremierAddOnOfferOperationPredicate) Matches

type PremierAddOnOfferProperties

type PremierAddOnOfferProperties struct {
	LegalTermsUrl              *string                     `json:"legalTermsUrl,omitempty"`
	MarketplaceOffer           *string                     `json:"marketplaceOffer,omitempty"`
	MarketplacePublisher       *string                     `json:"marketplacePublisher,omitempty"`
	PrivacyPolicyUrl           *string                     `json:"privacyPolicyUrl,omitempty"`
	Product                    *string                     `json:"product,omitempty"`
	PromoCodeRequired          *bool                       `json:"promoCodeRequired,omitempty"`
	Quota                      *int64                      `json:"quota,omitempty"`
	Sku                        *string                     `json:"sku,omitempty"`
	Vendor                     *string                     `json:"vendor,omitempty"`
	WebHostingPlanRestrictions *AppServicePlanRestrictions `json:"webHostingPlanRestrictions,omitempty"`
}

type ProvisioningState

type ProvisioningState string
const (
	ProvisioningStateCanceled   ProvisioningState = "Canceled"
	ProvisioningStateDeleting   ProvisioningState = "Deleting"
	ProvisioningStateFailed     ProvisioningState = "Failed"
	ProvisioningStateInProgress ProvisioningState = "InProgress"
	ProvisioningStateSucceeded  ProvisioningState = "Succeeded"
)

func (*ProvisioningState) UnmarshalJSON

func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error

type ResourceNameAvailability

type ResourceNameAvailability struct {
	Message       *string                   `json:"message,omitempty"`
	NameAvailable *bool                     `json:"nameAvailable,omitempty"`
	Reason        *InAvailabilityReasonType `json:"reason,omitempty"`
}

type ResourceNameAvailabilityRequest

type ResourceNameAvailabilityRequest struct {
	IsFqdn *bool                  `json:"isFqdn,omitempty"`
	Name   string                 `json:"name"`
	Type   CheckNameResourceTypes `json:"type"`
}

type ResourceProvidersClient

type ResourceProvidersClient struct {
	Client *resourcemanager.Client
}

func NewResourceProvidersClientWithBaseURI

func NewResourceProvidersClientWithBaseURI(sdkApi sdkEnv.Api) (*ResourceProvidersClient, error)

func (ResourceProvidersClient) CheckNameAvailability

CheckNameAvailability ...

func (ResourceProvidersClient) GetPublishingUser

func (c ResourceProvidersClient) GetPublishingUser(ctx context.Context) (result GetPublishingUserOperationResponse, err error)

GetPublishingUser ...

func (ResourceProvidersClient) GetSourceControl

GetSourceControl ...

func (ResourceProvidersClient) GetSubscriptionDeploymentLocations

GetSubscriptionDeploymentLocations ...

func (ResourceProvidersClient) ListBillingMeters

ListBillingMeters ...

func (ResourceProvidersClient) ListBillingMetersComplete

ListBillingMetersComplete retrieves all the results into a single object

func (ResourceProvidersClient) ListBillingMetersCompleteMatchingPredicate

ListBillingMetersCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ResourceProvidersClient) ListCustomHostNameSites

ListCustomHostNameSites ...

func (ResourceProvidersClient) ListCustomHostNameSitesComplete

ListCustomHostNameSitesComplete retrieves all the results into a single object

func (ResourceProvidersClient) ListCustomHostNameSitesCompleteMatchingPredicate

ListCustomHostNameSitesCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ResourceProvidersClient) ListGeoRegions

ListGeoRegions ...

func (ResourceProvidersClient) ListGeoRegionsComplete

ListGeoRegionsComplete retrieves all the results into a single object

func (ResourceProvidersClient) ListGeoRegionsCompleteMatchingPredicate

func (c ResourceProvidersClient) ListGeoRegionsCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, options ListGeoRegionsOperationOptions, predicate GeoRegionOperationPredicate) (result ListGeoRegionsCompleteResult, err error)

ListGeoRegionsCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ResourceProvidersClient) ListPremierAddOnOffers

ListPremierAddOnOffers ...

func (ResourceProvidersClient) ListPremierAddOnOffersComplete

ListPremierAddOnOffersComplete retrieves all the results into a single object

func (ResourceProvidersClient) ListPremierAddOnOffersCompleteMatchingPredicate

func (c ResourceProvidersClient) ListPremierAddOnOffersCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate PremierAddOnOfferOperationPredicate) (result ListPremierAddOnOffersCompleteResult, err error)

ListPremierAddOnOffersCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ResourceProvidersClient) ListSiteIdentifiersAssignedToHostName

ListSiteIdentifiersAssignedToHostName ...

func (ResourceProvidersClient) ListSiteIdentifiersAssignedToHostNameComplete

ListSiteIdentifiersAssignedToHostNameComplete retrieves all the results into a single object

func (ResourceProvidersClient) ListSiteIdentifiersAssignedToHostNameCompleteMatchingPredicate

func (c ResourceProvidersClient) ListSiteIdentifiersAssignedToHostNameCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, input NameIdentifier, predicate IdentifierOperationPredicate) (result ListSiteIdentifiersAssignedToHostNameCompleteResult, err error)

ListSiteIdentifiersAssignedToHostNameCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ResourceProvidersClient) ListSkus

ListSkus ...

func (ResourceProvidersClient) ListSourceControls

func (c ResourceProvidersClient) ListSourceControls(ctx context.Context) (result ListSourceControlsOperationResponse, err error)

ListSourceControls ...

func (ResourceProvidersClient) ListSourceControlsComplete

func (c ResourceProvidersClient) ListSourceControlsComplete(ctx context.Context) (ListSourceControlsCompleteResult, error)

ListSourceControlsComplete retrieves all the results into a single object

func (ResourceProvidersClient) ListSourceControlsCompleteMatchingPredicate

func (c ResourceProvidersClient) ListSourceControlsCompleteMatchingPredicate(ctx context.Context, predicate SourceControlOperationPredicate) (result ListSourceControlsCompleteResult, err error)

ListSourceControlsCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ResourceProvidersClient) Move

Move ...

func (ResourceProvidersClient) UpdatePublishingUser

func (c ResourceProvidersClient) UpdatePublishingUser(ctx context.Context, input User) (result UpdatePublishingUserOperationResponse, err error)

UpdatePublishingUser ...

func (ResourceProvidersClient) UpdateSourceControl

UpdateSourceControl ...

func (ResourceProvidersClient) Validate

Validate ...

func (ResourceProvidersClient) ValidateMove

ValidateMove ...

func (ResourceProvidersClient) VerifyHostingEnvironmentVnet

VerifyHostingEnvironmentVnet ...

type SkuCapacity

type SkuCapacity struct {
	Default        *int64  `json:"default,omitempty"`
	ElasticMaximum *int64  `json:"elasticMaximum,omitempty"`
	Maximum        *int64  `json:"maximum,omitempty"`
	Minimum        *int64  `json:"minimum,omitempty"`
	ScaleType      *string `json:"scaleType,omitempty"`
}

type SkuInfos

type SkuInfos struct {
	ResourceType *string                    `json:"resourceType,omitempty"`
	Skus         *[]GlobalCsmSkuDescription `json:"skus,omitempty"`
}

type SkuName

type SkuName string
const (
	SkuNameBasic            SkuName = "Basic"
	SkuNameDynamic          SkuName = "Dynamic"
	SkuNameElasticIsolated  SkuName = "ElasticIsolated"
	SkuNameElasticPremium   SkuName = "ElasticPremium"
	SkuNameFree             SkuName = "Free"
	SkuNameIsolated         SkuName = "Isolated"
	SkuNameIsolatedVTwo     SkuName = "IsolatedV2"
	SkuNamePremium          SkuName = "Premium"
	SkuNamePremiumContainer SkuName = "PremiumContainer"
	SkuNamePremiumVThree    SkuName = "PremiumV3"
	SkuNamePremiumVTwo      SkuName = "PremiumV2"
	SkuNameShared           SkuName = "Shared"
	SkuNameStandard         SkuName = "Standard"
)

func (*SkuName) UnmarshalJSON

func (s *SkuName) UnmarshalJSON(bytes []byte) error

type SourceControl

type SourceControl struct {
	Id         *string                  `json:"id,omitempty"`
	Kind       *string                  `json:"kind,omitempty"`
	Name       *string                  `json:"name,omitempty"`
	Properties *SourceControlProperties `json:"properties,omitempty"`
	Type       *string                  `json:"type,omitempty"`
}

type SourceControlId

type SourceControlId struct {
	SourceControlName string
}

SourceControlId is a struct representing the Resource ID for a Source Control

func NewSourceControlID

func NewSourceControlID(sourceControlName string) SourceControlId

NewSourceControlID returns a new SourceControlId struct

func ParseSourceControlID

func ParseSourceControlID(input string) (*SourceControlId, error)

ParseSourceControlID parses 'input' into a SourceControlId

func ParseSourceControlIDInsensitively

func ParseSourceControlIDInsensitively(input string) (*SourceControlId, error)

ParseSourceControlIDInsensitively parses 'input' case-insensitively into a SourceControlId note: this method should only be used for API response data and not user input

func (*SourceControlId) FromParseResult

func (id *SourceControlId) FromParseResult(input resourceids.ParseResult) error

func (SourceControlId) ID

func (id SourceControlId) ID() string

ID returns the formatted Source Control ID

func (SourceControlId) Segments

func (id SourceControlId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Source Control ID

func (SourceControlId) String

func (id SourceControlId) String() string

String returns a human-readable description of this Source Control ID

type SourceControlOperationPredicate

type SourceControlOperationPredicate struct {
	Id   *string
	Kind *string
	Name *string
	Type *string
}

func (SourceControlOperationPredicate) Matches

type SourceControlProperties

type SourceControlProperties struct {
	ExpirationTime *string `json:"expirationTime,omitempty"`
	RefreshToken   *string `json:"refreshToken,omitempty"`
	Token          *string `json:"token,omitempty"`
	TokenSecret    *string `json:"tokenSecret,omitempty"`
}

func (*SourceControlProperties) GetExpirationTimeAsTime

func (o *SourceControlProperties) GetExpirationTimeAsTime() (*time.Time, error)

func (*SourceControlProperties) SetExpirationTimeAsTime

func (o *SourceControlProperties) SetExpirationTimeAsTime(input time.Time)

type UpdatePublishingUserOperationResponse

type UpdatePublishingUserOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *User
}

type UpdateSourceControlOperationResponse

type UpdateSourceControlOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SourceControl
}

type UpgradeAvailability

type UpgradeAvailability string
const (
	UpgradeAvailabilityNone  UpgradeAvailability = "None"
	UpgradeAvailabilityReady UpgradeAvailability = "Ready"
)

func (*UpgradeAvailability) UnmarshalJSON

func (s *UpgradeAvailability) UnmarshalJSON(bytes []byte) error

type UpgradePreference

type UpgradePreference string
const (
	UpgradePreferenceEarly  UpgradePreference = "Early"
	UpgradePreferenceLate   UpgradePreference = "Late"
	UpgradePreferenceManual UpgradePreference = "Manual"
	UpgradePreferenceNone   UpgradePreference = "None"
)

func (*UpgradePreference) UnmarshalJSON

func (s *UpgradePreference) UnmarshalJSON(bytes []byte) error

type User

type User struct {
	Id         *string         `json:"id,omitempty"`
	Kind       *string         `json:"kind,omitempty"`
	Name       *string         `json:"name,omitempty"`
	Properties *UserProperties `json:"properties,omitempty"`
	Type       *string         `json:"type,omitempty"`
}

type UserProperties

type UserProperties struct {
	PublishingPassword         *string `json:"publishingPassword,omitempty"`
	PublishingPasswordHash     *string `json:"publishingPasswordHash,omitempty"`
	PublishingPasswordHashSalt *string `json:"publishingPasswordHashSalt,omitempty"`
	PublishingUserName         string  `json:"publishingUserName"`
	ScmUri                     *string `json:"scmUri,omitempty"`
}

type ValidateMoveOperationResponse

type ValidateMoveOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type ValidateOperationResponse

type ValidateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ValidateResponse
}

type ValidateProperties

type ValidateProperties struct {
	AppServiceEnvironment     *AppServiceEnvironment `json:"appServiceEnvironment,omitempty"`
	Capacity                  *int64                 `json:"capacity,omitempty"`
	ContainerImagePlatform    *string                `json:"containerImagePlatform,omitempty"`
	ContainerImageRepository  *string                `json:"containerImageRepository,omitempty"`
	ContainerImageTag         *string                `json:"containerImageTag,omitempty"`
	ContainerRegistryBaseUrl  *string                `json:"containerRegistryBaseUrl,omitempty"`
	ContainerRegistryPassword *string                `json:"containerRegistryPassword,omitempty"`
	ContainerRegistryUsername *string                `json:"containerRegistryUsername,omitempty"`
	HostingEnvironment        *string                `json:"hostingEnvironment,omitempty"`
	IsSpot                    *bool                  `json:"isSpot,omitempty"`
	IsXenon                   *bool                  `json:"isXenon,omitempty"`
	NeedLinuxWorkers          *bool                  `json:"needLinuxWorkers,omitempty"`
	ServerFarmId              *string                `json:"serverFarmId,omitempty"`
	SkuName                   *string                `json:"skuName,omitempty"`
}

type ValidateRequest

type ValidateRequest struct {
	Location   string                `json:"location"`
	Name       string                `json:"name"`
	Properties ValidateProperties    `json:"properties"`
	Type       ValidateResourceTypes `json:"type"`
}

type ValidateResourceTypes

type ValidateResourceTypes string
const (
	ValidateResourceTypesMicrosoftPointWebHostingEnvironments ValidateResourceTypes = "Microsoft.Web/hostingEnvironments"
	ValidateResourceTypesServerFarm                           ValidateResourceTypes = "ServerFarm"
	ValidateResourceTypesSite                                 ValidateResourceTypes = "Site"
)

func (*ValidateResourceTypes) UnmarshalJSON

func (s *ValidateResourceTypes) UnmarshalJSON(bytes []byte) error

type ValidateResponse

type ValidateResponse struct {
	Error  *ValidateResponseError `json:"error,omitempty"`
	Status *string                `json:"status,omitempty"`
}

type ValidateResponseError

type ValidateResponseError struct {
	Code    *string `json:"code,omitempty"`
	Message *string `json:"message,omitempty"`
}

type VerifyHostingEnvironmentVnetOperationResponse

type VerifyHostingEnvironmentVnetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *VnetValidationFailureDetails
}

type VirtualNetworkProfile

type VirtualNetworkProfile struct {
	Id     string  `json:"id"`
	Name   *string `json:"name,omitempty"`
	Subnet *string `json:"subnet,omitempty"`
	Type   *string `json:"type,omitempty"`
}

type VnetParameters

type VnetParameters struct {
	Id         *string                   `json:"id,omitempty"`
	Kind       *string                   `json:"kind,omitempty"`
	Name       *string                   `json:"name,omitempty"`
	Properties *VnetParametersProperties `json:"properties,omitempty"`
	Type       *string                   `json:"type,omitempty"`
}

type VnetParametersProperties

type VnetParametersProperties struct {
	SubnetResourceId  *string `json:"subnetResourceId,omitempty"`
	VnetName          *string `json:"vnetName,omitempty"`
	VnetResourceGroup *string `json:"vnetResourceGroup,omitempty"`
	VnetSubnetName    *string `json:"vnetSubnetName,omitempty"`
}

type VnetValidationFailureDetails

type VnetValidationFailureDetails struct {
	Id         *string                                 `json:"id,omitempty"`
	Kind       *string                                 `json:"kind,omitempty"`
	Name       *string                                 `json:"name,omitempty"`
	Properties *VnetValidationFailureDetailsProperties `json:"properties,omitempty"`
	Type       *string                                 `json:"type,omitempty"`
}

type VnetValidationFailureDetailsProperties

type VnetValidationFailureDetailsProperties struct {
	Failed      *bool                        `json:"failed,omitempty"`
	FailedTests *[]VnetValidationTestFailure `json:"failedTests,omitempty"`
	Message     *string                      `json:"message,omitempty"`
	Warnings    *[]VnetValidationTestFailure `json:"warnings,omitempty"`
}

type VnetValidationTestFailure

type VnetValidationTestFailure struct {
	Id         *string                              `json:"id,omitempty"`
	Kind       *string                              `json:"kind,omitempty"`
	Name       *string                              `json:"name,omitempty"`
	Properties *VnetValidationTestFailureProperties `json:"properties,omitempty"`
	Type       *string                              `json:"type,omitempty"`
}

type VnetValidationTestFailureProperties

type VnetValidationTestFailureProperties struct {
	Details  *string `json:"details,omitempty"`
	TestName *string `json:"testName,omitempty"`
}

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL