Property | Type | Description | |
---|---|---|---|
SlotFormat | string |
Method | Description | |
---|---|---|
BuildWebProject ( string projectFile, string configuration, string logFile ) : string |
Build a Visual Studio web project and generate a WebDeploy package.
|
|
CheckWebsiteNameAvailability ( string name ) : bool |
Checks whether a website name is available or not.
|
|
CreateWebJob ( string name, string slot, string jobName, WebJobType jobType, string jobFile ) : IPSWebJob |
Creates new web job for a website
|
|
CreateWebsite ( string webspaceName, Utilities siteToCreate, string slot ) : Utilities.Site |
Create a new website.
|
|
CreateWebsiteRepository ( string webspaceName, string websiteName ) : void |
Create a git repository for the web site.
|
|
DeleteWebJob ( string name, string slot, string jobName, WebJobType jobType ) : void |
Deletes a web job for a website.
|
|
DeleteWebsite ( string webspaceName, string websiteName, bool deleteMetrics = false, bool deleteEmptyServerFarm = false ) : void |
Delete a website.
|
|
DeleteWebsite ( string webspaceName, string websiteName, string slot ) : void |
Delete a website slot.
|
|
DisableApplicationDiagnostic ( string name, WebsiteDiagnosticOutput output ) : void |
Disables application diagnostic.
|
|
DisableApplicationDiagnostic ( string name, WebsiteDiagnosticOutput output, string slot ) : void |
Disables application diagnostic.
|
|
DisableSiteDiagnostic ( string name, bool webServerLogging, bool detailedErrorMessages, bool failedRequestTracing ) : void |
Disables site diagnostic.
|
|
EnableApplicationDiagnostic ( string name, WebsiteDiagnosticOutput output, object>.Dictionary |
Enables application diagnostic on website slot.
|
|
EnableApplicationDiagnostic ( string name, WebsiteDiagnosticOutput output, object>.Dictionary |
Enables application diagnostic on website slot.
|
|
EnableSiteDiagnostic ( string name, bool webServerLogging, bool detailedErrorMessages, bool failedRequestTracing ) : void |
Enables website diagnostic.
|
|
FilterWebJobHistory ( Microsoft.WindowsAzure.Commands.Utilities.Websites.Services.WebJobs.WebJobHistoryFilterOptions options ) : List |
Filters a web job history.
|
|
FilterWebJobs ( Microsoft.WindowsAzure.Commands.Utilities.Websites.Services.WebJobs.WebJobFilterOptions options ) : List |
Filters the web jobs.
|
|
GetApplicationDiagnosticsSettings ( string name ) : DiagnosticsSettings |
Gets the application diagnostics settings
|
|
GetApplicationDiagnosticsSettings ( string name, string slot ) : DiagnosticsSettings |
Gets the application diagnostics settings
|
|
GetDefaultLocation ( ) : string |
Gets the default location for websites.
|
|
GetHistoricalUsageMetrics ( string siteName, string slot, IList |
Get a list of historic metrics for the site.
|
|
GetHostName ( string name, string slot ) : string |
Gets the hostname of the website
|
|
GetPlanHistoricalUsageMetrics ( string webSpaceName, string planName, IList |
Get a list of historic metrics for the web hosting plan.
|
|
GetSlotDnsName ( string name, string slot ) : string |
Gets a website slot DNS name.
|
|
GetSlotName ( string name ) : string |
Gets the slot name from the website name.
|
|
GetWebDeployPublishProfile ( string websiteName, string slot = null ) : WebSiteGetPublishProfileResponse.PublishProfile |
Gets the website WebDeploy publish profile.
|
|
GetWebHostingPlan ( string webSpaceName, string planName ) : Utilities.WebHostingPlan |
Get web hosting plan by name
|
|
GetWebsite ( string name ) : Utilities.Site |
Gets a website instance.
|
|
GetWebsite ( string name, string slot ) : Utilities.Site |
Gets a website slot instance.
|
|
GetWebsiteConfiguration ( string name ) : Utilities.SiteConfig |
Gets the website configuration.
|
|
GetWebsiteConfiguration ( string name, string slot ) : Utilities.SiteConfig |
Gets a website slot configuration
|
|
GetWebsiteDnsSuffix ( ) : string |
Gets the default website DNS suffix for the current environment.
|
|
GetWebsiteNameFromFullName ( string name ) : string |
Gets the website name without slot part
|
|
GetWebsiteSlots ( string name ) : List |
Gets all slots for a website
|
|
ListAvailableLocations ( ) : List |
Lists available website locations.
|
|
ListLogPaths ( string name ) : List |
List log paths for a given website.
|
|
ListLogPaths ( string name, string slot ) : List |
List log paths for a given website.
|
|
ListPublishingUserNames ( ) : IList |
Get a list of the user names configured to publish to the space.
|
|
ListSitesInWebSpace ( string spaceName ) : IList |
Get the sites in the given webspace
|
|
ListWebHostingPlans ( ) : List |
Return web hosting plans in the subscription
|
|
ListWebHostingPlans ( string webSpaceName ) : List |
Return web hosting plans in the subscription
|
|
ListWebSpaces ( ) : IList |
Get the WebSpaces.
|
|
ListWebsiteInstances ( string webSpace, string fullName ) : Microsoft.WindowsAzure.Commands.Utilities.Websites.WebsiteInstance[] | ||
ListWebsites ( ) : List |
Lists all websites under the current subscription
|
|
ListWebsites ( string slot ) : List |
Lists all websites with the provided slot name.
|
|
ParseConnectionStringNamesFromWebConfig ( string defaultWebConfigFile, string overwriteWebConfigFile ) : string[] |
Parse the Web.config files to get the connection string names.
|
|
PublishWebProject ( string websiteName, string slot, string package, string setParametersFile, |
Publish a WebDeploy package folder to a web site.
|
|
RestartWebsite ( string name ) : void |
Restarts a website.
|
|
RestartWebsite ( string name, string slot ) : void |
Restarts a website.
|
|
SaveWebJobLog ( string name, string slot, string jobName, WebJobType jobType ) : void |
Saves a web job logs to file.
|
|
SaveWebJobLog ( string name, string slot, string jobName, WebJobType jobType, string output, string runId ) : void |
Saves a web job logs to file.
|
|
SetAppSetting ( string name, string key, string value ) : void |
Sets an AppSetting of a website.
|
|
SetConnectionString ( string name, string key, string value, Utilities connectionStringType ) : void |
Sets a connection string for a website.
|
|
StartLogStreaming ( string name, string path, string message, Predicate |
Starts log streaming for the given website.
|
|
StartLogStreaming ( string name, string slot, string path, string message, Predicate |
Starts log streaming for the given website.
|
|
StartWebJob ( string name, string slot, string jobName, WebJobType jobType ) : void |
Starts a web job in a website.
|
|
StartWebsite ( string name ) : void |
Starts a website.
|
|
StartWebsite ( string name, string slot ) : void |
Starts a website.
|
|
StopWebJob ( string name, string slot, string jobName, WebJobType jobType ) : void |
Stops a web job in a website.
|
|
StopWebsite ( string name ) : void |
Stops a website.
|
|
StopWebsite ( string name, string slot ) : void |
Stops a website.
|
|
SwitchSlots ( string webspaceName, string websiteName, string slot1, string slot2 ) : void |
Switches the given website slot with the production slot
|
|
UpdateWebsiteComputeMode ( Utilities websiteToUpdate ) : void |
Updates a website compute mode.
|
|
UpdateWebsiteConfiguration ( string name, Utilities newConfiguration ) : void |
Update the website configuration
|
|
UpdateWebsiteConfiguration ( string name, Utilities newConfiguration, string slot ) : void |
Update the website slot configuration
|
|
UpdateWebsiteHostNames ( Utilities site, IEnumerable |
Update the set of host names for a website.
|
|
UpdateWebsiteHostNames ( Utilities site, IEnumerable |
Update the set of host names for a website slot.
|
|
WebsiteExists ( string name ) : bool |
Checks if a website exists or not.
|
|
WebsiteExists ( string name, string slot ) : bool |
Checks if a website slot exists or not.
|
|
WebsitesClient ( AzureSMProfile profile, AzureSubscription subscription, Action |
Creates new WebsitesClient
|
Method | Description | |
---|---|---|
AddConnectionString ( DeploymentObject deployment, string name, string value ) : void |
Add a connection string parameter to the deployment.
|
|
ChangeWebsiteState ( string name, string webspace, WebsiteState state ) : void | ||
CreateDeploymentHttpClient ( string websiteName ) : |
||
CreateRemoteDeploymentBaseOptions ( string websiteName, string slot ) : DeploymentBaseOptions |
Create remote deployment base options using the web site publish profile.
|
|
CreateWebsite ( string webspaceName, Utilities siteToCreate ) : Utilities.Site |
Create a new website in production.
|
|
GetDeploymentBaseOptionsUserAgent ( ) : string |
Gets remote deployment base options useragent using AzureSession/WebSiteManagementClient.
|
|
GetRepository ( string websiteName ) : Repository | ||
GetWebSiteExtensionsClient ( string websiteName ) : IWebSiteExtensionsClient | ||
GetWebSiteExtensionsCredentials ( string name ) : BasicAuthenticationCloudCredentials | ||
GetWebsiteDeploymentHttpConfiguration ( string name, Repository &repository, ICredentials &credentials ) : string | ||
GetWebsiteFromCurrentDirectory ( ) : string |
Gets website name in the current directory.
|
|
GetWebsiteName ( string name ) : string | ||
IsProductionSlot ( string slot ) : bool | ||
PublishWebProjectFromPackageFile ( string websiteName, string slot, string package, string setParametersFile, |
Publish a WebDeploy package zip file to a web site.
|
|
PublishWebProjectFromPackagePath ( string websiteName, string slot, string package, |
Publish a WebDeploy package zip file to a web site.
|
|
ReplaceConnectionStrings ( DeploymentObject deployment, |
Replace all the connection strings in the deployment.
|
|
SetApplicationDiagnosticsSettings ( string name, WebsiteDiagnosticOutput output, bool setFlag, object>.Dictionary |
||
SetSiteDiagnosticsSettings ( string name, bool webServerLogging, bool detailedErrorMessages, bool failedRequestTracing, bool setFlag ) : void | ||
SetWebDeployToSkipAppData ( bool skipAppData, DeploymentBaseOptions localBaseOptions, DeploymentBaseOptions remoteBaseOptions ) : void | ||
SetWebsiteName ( string name, string slot ) : string |
Get the real website name.
|
|
SetWebsiteNameForWebDeploy ( string name, string slot ) : string |
public BuildWebProject ( string projectFile, string configuration, string logFile ) : string | ||
projectFile | string | The project file. |
configuration | string | The configuration of the build, like Release or Debug. |
logFile | string | The build log file if there is any error. |
return | string |
public CheckWebsiteNameAvailability ( string name ) : bool | ||
name | string | The website name |
return | bool |
public CreateWebJob ( string name, string slot, string jobName, WebJobType jobType, string jobFile ) : IPSWebJob | ||
name | string | The website name |
slot | string | The website slot name |
jobName | string | The web job name |
jobType | WebJobType | The web job type |
jobFile | string | The web job file name |
return | IPSWebJob |
public CreateWebsite ( string webspaceName, Utilities siteToCreate, string slot ) : Utilities.Site | ||
webspaceName | string | Web space to create site in. |
siteToCreate | Utilities | Details about the site to create. |
slot | string | The slot name. |
return | Utilities.Site |
public CreateWebsiteRepository ( string webspaceName, string websiteName ) : void | ||
webspaceName | string | Webspace that site is in. |
websiteName | string | The site name. |
return | void |
public DeleteWebJob ( string name, string slot, string jobName, WebJobType jobType ) : void | ||
name | string | The website name |
slot | string | The slot name |
jobName | string | The web job name |
jobType | WebJobType | The web job type |
return | void |
public DeleteWebsite ( string webspaceName, string websiteName, bool deleteMetrics = false, bool deleteEmptyServerFarm = false ) : void | ||
webspaceName | string | webspace the site is in. |
websiteName | string | website name. |
deleteMetrics | bool | pass true to delete stored metrics as part of removing site. |
deleteEmptyServerFarm | bool | Pass true to delete server farm is this was the last website in it. |
return | void |
public DeleteWebsite ( string webspaceName, string websiteName, string slot ) : void | ||
webspaceName | string | webspace the site is in. |
websiteName | string | website name. |
slot | string | The website slot name |
return | void |
public DisableApplicationDiagnostic ( string name, WebsiteDiagnosticOutput output ) : void | ||
name | string | The website name |
output | WebsiteDiagnosticOutput | The application log output, FileSystem or StorageTable |
return | void |
public DisableApplicationDiagnostic ( string name, WebsiteDiagnosticOutput output, string slot ) : void | ||
name | string | The website name |
output | WebsiteDiagnosticOutput | The application log output, FileSystem or StorageTable |
slot | string | The website slot name |
return | void |
public DisableSiteDiagnostic ( string name, bool webServerLogging, bool detailedErrorMessages, bool failedRequestTracing ) : void | ||
name | string | The website name |
webServerLogging | bool | Flag for webServerLogging |
detailedErrorMessages | bool | Flag for detailedErrorMessages |
failedRequestTracing | bool | Flag for failedRequestTracing |
return | void |
public EnableApplicationDiagnostic ( string name, WebsiteDiagnosticOutput output, object>.Dictionary |
||
name | string | The website name |
output | WebsiteDiagnosticOutput | The application log output, FileSystem or StorageTable |
properties | object>.Dictionary | The diagnostic setting properties |
return | void |
public EnableApplicationDiagnostic ( string name, WebsiteDiagnosticOutput output, object>.Dictionary |
||
name | string | The website name |
output | WebsiteDiagnosticOutput | The application log output, FileSystem or StorageTable |
properties | object>.Dictionary | The diagnostic setting properties |
slot | string | The website slot name |
return | void |
public EnableSiteDiagnostic ( string name, bool webServerLogging, bool detailedErrorMessages, bool failedRequestTracing ) : void | ||
name | string | The website name |
webServerLogging | bool | Flag for webServerLogging |
detailedErrorMessages | bool | Flag for detailedErrorMessages |
failedRequestTracing | bool | Flag for failedRequestTracing |
return | void |
public FilterWebJobHistory ( Microsoft.WindowsAzure.Commands.Utilities.Websites.Services.WebJobs.WebJobHistoryFilterOptions options ) : List |
||
options | Microsoft.WindowsAzure.Commands.Utilities.Websites.Services.WebJobs.WebJobHistoryFilterOptions | The web job filter options |
return | List |
public FilterWebJobs ( Microsoft.WindowsAzure.Commands.Utilities.Websites.Services.WebJobs.WebJobFilterOptions options ) : List |
||
options | Microsoft.WindowsAzure.Commands.Utilities.Websites.Services.WebJobs.WebJobFilterOptions | The web job filter options |
return | List |
public GetApplicationDiagnosticsSettings ( string name ) : DiagnosticsSettings | ||
name | string | The website name |
return | DiagnosticsSettings |
public GetApplicationDiagnosticsSettings ( string name, string slot ) : DiagnosticsSettings | ||
name | string | The website name |
slot | string | The website slot name |
return | DiagnosticsSettings |
public GetHistoricalUsageMetrics ( string siteName, string slot, IList |
||
siteName | string | The website name |
slot | string | Slot name |
metricNames | IList |
List of metrics names to retrieve. See metric definitions for supported names |
starTime | System.DateTime | Start date of the requested period |
endTime | System.DateTime | End date of the requested period |
timeGrain | string | Time grains for the metrics. |
instanceDetails | bool | Include details for the server instances in which the site is running. |
slotView | bool | Represent the metrics for the hostnames that receive the traffic at the current slot. /// If swap occurred in the middle of the period metrics will be merged |
return | IList |
public GetHostName ( string name, string slot ) : string | ||
name | string | The website name |
slot | string | The website slot name |
return | string |
public GetPlanHistoricalUsageMetrics ( string webSpaceName, string planName, IList |
||
webSpaceName | string | web space name where plan belongs |
planName | string | The web hosting plan name |
metricNames | IList |
List of metrics names to retrieve. See metric definitions for supported names |
starTime | System.DateTime | Start date of the requested period |
endTime | System.DateTime | End date of the requested period |
timeGrain | string | Time grains for the metrics. |
instanceDetails | bool | Include details for the server instances in which the site is running. |
return | IList |
public GetSlotDnsName ( string name, string slot ) : string | ||
name | string | The website name |
slot | string | The slot name |
return | string |
public GetSlotName ( string name ) : string | ||
name | string | The website name |
return | string |
public GetWebDeployPublishProfile ( string websiteName, string slot = null ) : WebSiteGetPublishProfileResponse.PublishProfile | ||
websiteName | string | Website name. |
slot | string | Slot name. By default is null. |
return | WebSiteGetPublishProfileResponse.PublishProfile |
public GetWebHostingPlan ( string webSpaceName, string planName ) : Utilities.WebHostingPlan | ||
webSpaceName | string | web space name where plan belongs |
planName | string | web hosting plan name |
return | Utilities.WebHostingPlan |
public GetWebsite ( string name ) : Utilities.Site | ||
name | string | The website name |
return | Utilities.Site |
public GetWebsite ( string name, string slot ) : Utilities.Site | ||
name | string | The website name |
slot | string | The slot name |
return | Utilities.Site |
public GetWebsiteConfiguration ( string name ) : Utilities.SiteConfig | ||
name | string | The website name |
return | Utilities.SiteConfig |
public GetWebsiteConfiguration ( string name, string slot ) : Utilities.SiteConfig | ||
name | string | The website name |
slot | string | The website slot name |
return | Utilities.SiteConfig |
public GetWebsiteNameFromFullName ( string name ) : string | ||
name | string | The website full name which may include slot name |
return | string |
public GetWebsiteSlots ( string name ) : List |
||
name | string | The website name |
return | List |
public ListLogPaths ( string name, string slot ) : List |
||
name | string | The website name |
slot | string | The website slot name |
return | List |
public ListSitesInWebSpace ( string spaceName ) : IList |
||
spaceName | string | Name of webspace |
return | IList |
public ListWebHostingPlans ( string webSpaceName ) : List |
||
webSpaceName | string | |
return | List |
public ListWebsiteInstances ( string webSpace, string fullName ) : Microsoft.WindowsAzure.Commands.Utilities.Websites.WebsiteInstance[] | ||
webSpace | string | |
fullName | string | |
return | Microsoft.WindowsAzure.Commands.Utilities.Websites.WebsiteInstance[] |
public ListWebsites ( string slot ) : List |
||
slot | string | The slot name |
return | List |
public ParseConnectionStringNamesFromWebConfig ( string defaultWebConfigFile, string overwriteWebConfigFile ) : string[] | ||
defaultWebConfigFile | string | The default Web.config file. |
overwriteWebConfigFile | string | The additional Web.config file for the specified configuration, like Web.Release.Config file. |
return | string[] |
public PublishWebProject ( string websiteName, string slot, string package, string setParametersFile, |
||
websiteName | string | The name of the web site. |
slot | string | The name of the slot. |
package | string | The WebDeploy package. |
setParametersFile | string | The SetParametersFile.xml used to override internal package configuration. |
connectionStrings | The connection strings to overwrite the ones in the Web.config file. | |
skipAppData | bool | Skip app data |
doNotDelete | bool | Do not delete files at destination |
return | DeploymentChangeSummary |
public RestartWebsite ( string name ) : void | ||
name | string | The website name |
return | void |
public RestartWebsite ( string name, string slot ) : void | ||
name | string | The website name |
slot | string | The website slot name |
return | void |
public SaveWebJobLog ( string name, string slot, string jobName, WebJobType jobType ) : void | ||
name | string | The website name |
slot | string | The slot name |
jobName | string | The web job name |
jobType | WebJobType | The web job type |
return | void |
public SaveWebJobLog ( string name, string slot, string jobName, WebJobType jobType, string output, string runId ) : void | ||
name | string | The website name |
slot | string | The slot name |
jobName | string | The web job name |
jobType | WebJobType | The web job type |
output | string | The output file name |
runId | string | The job run id |
return | void |
public SetAppSetting ( string name, string key, string value ) : void | ||
name | string | The website name |
key | string | The app setting name |
value | string | The app setting value |
return | void |
public SetConnectionString ( string name, string key, string value, Utilities connectionStringType ) : void | ||
name | string | Name of the website. |
key | string | Connection string key. |
value | string | Value for the connection string. |
connectionStringType | Utilities | Type of connection string. |
return | void |
public StartLogStreaming ( string name, string path, string message, Predicate |
||
name | string | The website name |
path | string | The log path, by default root |
message | string | The substring message |
endStreaming | Predicate |
Predicate to end streaming |
waitInterval | int | The fetch wait interval |
return | IEnumerable |
public StartLogStreaming ( string name, string slot, string path, string message, Predicate |
||
name | string | The website name |
slot | string | The website slot name |
path | string | The log path, by default root |
message | string | The substring message |
endStreaming | Predicate |
Predicate to end streaming |
waitInternal | int | The fetch wait interval |
return | IEnumerable |
public StartWebJob ( string name, string slot, string jobName, WebJobType jobType ) : void | ||
name | string | The website name |
slot | string | The slot name |
jobName | string | The web job name |
jobType | WebJobType | The web job type |
return | void |
public StartWebsite ( string name ) : void | ||
name | string | The website name |
return | void |
public StartWebsite ( string name, string slot ) : void | ||
name | string | The website name |
slot | string | The website slot name |
return | void |
public StopWebJob ( string name, string slot, string jobName, WebJobType jobType ) : void | ||
name | string | The website name |
slot | string | The slot name |
jobName | string | The web job name |
jobType | WebJobType | The web job type |
return | void |
public StopWebsite ( string name ) : void | ||
name | string | The website name |
return | void |
public StopWebsite ( string name, string slot ) : void | ||
name | string | The website name |
slot | string | The website slot name |
return | void |
public SwitchSlots ( string webspaceName, string websiteName, string slot1, string slot2 ) : void | ||
webspaceName | string | The webspace name |
websiteName | string | The website name |
slot1 | string | The website's first slot name |
slot2 | string | The website's second slot name |
return | void |
public UpdateWebsiteComputeMode ( Utilities websiteToUpdate ) : void | ||
websiteToUpdate | Utilities | The website to update |
return | void |
public UpdateWebsiteConfiguration ( string name, Utilities newConfiguration ) : void | ||
name | string | The website name |
newConfiguration | Utilities | The website configuration object containing updates. |
return | void |
public UpdateWebsiteConfiguration ( string name, Utilities newConfiguration, string slot ) : void | ||
name | string | The website name |
newConfiguration | Utilities | The website configuration object containing updates. |
slot | string | The website slot name |
return | void |
public UpdateWebsiteHostNames ( Utilities site, IEnumerable |
||
site | Utilities | The site name. |
hostNames | IEnumerable |
The new host names. |
return | void |
public UpdateWebsiteHostNames ( Utilities site, IEnumerable |
||
site | Utilities | The website name. |
hostNames | IEnumerable |
The new host names. |
slot | string | The website slot name. |
return | void |
public WebsiteExists ( string name ) : bool | ||
name | string | The website name |
return | bool |
public WebsiteExists ( string name, string slot ) : bool | ||
name | string | The website name |
slot | string | The website slot name |
return | bool |
public WebsitesClient ( AzureSMProfile profile, AzureSubscription subscription, Action |
||
profile | AzureSMProfile | |
subscription | AzureSubscription | Subscription containing websites to manipulate |
logger | Action |
The logger action |
return | System |