swagger: '2.0' info: version: '2015-08-01' title: Microsoft Azure WebSite Management Client description: >- Use these APIs to manage Azure Websites resources through the Azure Resource Manager. All task operations conform to the HTTP/1.1 protocol specification and each operation returns an x-ms-request-id header that can be used to obtain information about the request. You must make sure that requests made to these resources are secure. For more information, see https://msdn.microsoft.com/en-us/library/azure/dn790557.aspx. host: management.azure.com schemes: - https paths: ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/certificates/{name} : get: tags: - CertificateOrders summary: Microsoft Azure Get Certificate Associated With The Certificate Order operationId: microsoftAzureCertificateordersGetcertificate consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Azure resource group name required: true type: string - name: certificateOrderName in: path description: Certificate name required: true type: string - name: name in: path description: Certificate name required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/CertificateOrderCertificate' deprecated: false description: Needs a more full description created. put: tags: - CertificateOrders summary: >- Microsoft Azure Associates A Key Vault Secret To A Certificate Store That Will Be Used For Storing The Certificate Once It S Ready operationId: microsoftAzureCertificateordersCreateorupdatecertificate consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Azure resource group name required: true type: string - name: certificateOrderName in: path description: Certificate name required: true type: string - name: name in: path description: Certificate name required: true type: string - name: keyVaultCertificate in: body description: Key Vault secret csm Id required: true schema: $ref: '#/definitions/CertificateOrderCertificate' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/CertificateOrderCertificate' deprecated: false description: Needs a more full description created. delete: tags: - CertificateOrders summary: Microsoft Azure Deletes The Certificate Associated With The Certificate Order operationId: microsoftAzureCertificateordersDeletecertificate consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Azure resource group name required: true type: string - name: certificateOrderName in: path description: Certificate name required: true type: string - name: name in: path description: Certificate name required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. patch: tags: - CertificateOrders summary: >- Microsoft Azure Associates A Key Vault Secret To A Certificate Store That Will Be Used For Storing The Certificate Once It S Ready operationId: microsoftAzureCertificateordersUpdatecertificate consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Azure resource group name required: true type: string - name: certificateOrderName in: path description: Certificate name required: true type: string - name: name in: path description: Certificate name required: true type: string - name: keyVaultCertificate in: body description: Key Vault secret csm Id required: true schema: $ref: '#/definitions/CertificateOrderCertificate' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/CertificateOrderCertificate' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{name} : get: tags: - CertificateOrders summary: Microsoft Azure Get A Certificate Order operationId: microsoftAzureCertificateordersGetcertificateorder consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Azure resource group name required: true type: string - name: name in: path description: Certificate name required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/CertificateOrder' deprecated: false description: Needs a more full description created. put: tags: - CertificateOrders summary: Microsoft Azure Create Or Update A Certificate Purchase Order operationId: microsoftAzureCertificateordersCreateorupdatecertificateorder consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Azure resource group name required: true type: string - name: name in: path description: Certificate name required: true type: string - name: certificateDistinguishedName in: body description: Distinguished name to be used for purchasing certificate required: true schema: $ref: '#/definitions/CertificateOrder' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/CertificateOrder' deprecated: false description: Needs a more full description created. delete: tags: - CertificateOrders summary: Microsoft Azure Delete An Existing Certificate Order operationId: microsoftAzureCertificateordersDeletecertificateorder consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Azure resource group name required: true type: string - name: name in: path description: Certificate name required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. patch: tags: - CertificateOrders summary: Microsoft Azure Create Or Update A Certificate Purchase Order operationId: microsoftAzureCertificateordersUpdatecertificateorder consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Azure resource group name required: true type: string - name: name in: path description: Certificate name required: true type: string - name: certificateDistinguishedName in: body description: Distinguished name to be used for purchasing certificate required: true schema: $ref: '#/definitions/CertificateOrder' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/CertificateOrder' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders : get: tags: - CertificateOrders summary: Microsoft Azure Get Certificate Orders In A Resource Group operationId: microsoftAzureCertificateordersGetcertificateorders consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Azure resource group name required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/CertificateOrderCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/certificates : get: tags: - CertificateOrders summary: >- Microsoft Azure List All Certificates Associated With A Certificate Order Only One Certificate Can Be Associated With An Order At A Time operationId: microsoftAzureCertificateordersGetcertificates consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Azure resource group name required: true type: string - name: certificateOrderName in: path description: Certificate name required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/CertificateOrderCertificateCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{name}/reissue : post: tags: - CertificateOrders summary: Microsoft Azure Reissue An Existing Certificate Order operationId: microsoftAzureCertificateordersReissuecertificateorder consumes: - application/json - text/json - application/xml - text/xml - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Azure resource group name required: true type: string - name: name in: path description: Certificate name required: true type: string - name: reissueCertificateOrderRequest in: body description: Reissue parameters required: true schema: $ref: '#/definitions/ReissueCertificateOrderRequest' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{name}/renew : post: tags: - CertificateOrders summary: Microsoft Azure Renew An Existing Certificate Order operationId: microsoftAzureCertificateordersRenewcertificateorder consumes: - application/json - text/json - application/xml - text/xml - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Azure resource group name required: true type: string - name: name in: path description: Certificate name required: true type: string - name: renewCertificateOrderRequest in: body description: Renew parameters required: true schema: $ref: '#/definitions/RenewCertificateOrderRequest' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{name}/retrieveCertificateActions : post: tags: - CertificateOrders summary: Microsoft Azure Retrieve The List Of Certificate Actions operationId: microsoftAzureCertificateordersRetrievecertificateactions consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Azure resource group name required: true type: string - name: name in: path description: Certificate order name required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: type: array items: $ref: '#/definitions/CertificateOrderAction' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{name}/retrieveEmailHistory : post: tags: - CertificateOrders summary: Microsoft Azure Retrieve Email History operationId: microsoftAzureCertificateordersRetrievecertificateemailhistory consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Azure resource group name required: true type: string - name: name in: path description: Certificate order name required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: type: array items: $ref: '#/definitions/CertificateEmail' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{name}/resendEmail : post: tags: - CertificateOrders summary: Microsoft Azure Resend Certificate Email operationId: microsoftAzureCertificateordersResendcertificateemail consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Azure resource group name required: true type: string - name: name in: path description: Certificate order name required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{name}/verifyDomainOwnership : post: tags: - CertificateOrders summary: Microsoft Azure Verify Domain Ownership For This Certificate Order operationId: microsoftAzureCertificateordersVerifydomainownership consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Azure resource group name required: true type: string - name: name in: path description: Certificate order name required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates: get: tags: - Certificates summary: 'Microsoft Azure Get Certificates For A Subscription In The Specified Resource Group' operationId: microsoftAzureCertificatesGetcertificates consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of the resource group required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/CertificateCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates/{name}: get: tags: - Certificates summary: >- Microsoft Azure Get A Certificate By Certificate Name For A Subscription In The Specified Resource Group operationId: microsoftAzureCertificatesGetcertificate consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of the resource group required: true type: string - name: name in: path description: Name of the certificate. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Certificate' deprecated: false description: Needs a more full description created. put: tags: - Certificates summary: 'Microsoft Azure Creates Or Modifies An Existing Certificate' operationId: microsoftAzureCertificatesCreateorupdatecertificate consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of the resource group required: true type: string - name: name in: path description: Name of the certificate. required: true type: string - name: certificateEnvelope in: body description: Details of certificate if it exists already. required: true schema: $ref: '#/definitions/Certificate' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Certificate' deprecated: false description: Needs a more full description created. delete: tags: - Certificates summary: >- Microsoft Azure Delete A Certificate By Name In A Specified Subscription And Resourcegroup operationId: microsoftAzureCertificatesDeletecertificate consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of the resource group required: true type: string - name: name in: path description: Name of the certificate to be deleted. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. patch: tags: - Certificates summary: 'Microsoft Azure Creates Or Modifies An Existing Certificate' operationId: microsoftAzureCertificatesUpdatecertificate consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of the resource group required: true type: string - name: name in: path description: Name of the certificate. required: true type: string - name: certificateEnvelope in: body description: Details of certificate if it exists already. required: true schema: $ref: '#/definitions/Certificate' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Certificate' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/csrs: get: tags: - Certificates summary: >- Microsoft Azure Gets The Certificate Signing Requests For A Subscription In The Specified Resource Group operationId: microsoftAzureCertificatesGetcsrs consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of the resource group required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: type: array items: $ref: '#/definitions/Csr' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/csrs/{name}: get: tags: - Certificates summary: >- Microsoft Azure Gets A Certificate Signing Request By Certificate Name For A Subscription In The Specified Resource Group operationId: microsoftAzureCertificatesGetcsr consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of the resource group required: true type: string - name: name in: path description: Name of the certificate. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Csr' deprecated: false description: Needs a more full description created. put: tags: - Certificates summary: 'Microsoft Azure Creates Or Modifies An Existing Certificate Signing Request' operationId: microsoftAzureCertificatesCreateorupdatecsr consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of the resource group required: true type: string - name: name in: path description: Name of the certificate. required: true type: string - name: csrEnvelope in: body description: Details of certificate signing request if it exists already. required: true schema: $ref: '#/definitions/Csr' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Csr' deprecated: false description: Needs a more full description created. delete: tags: - Certificates summary: 'Microsoft Azure Delete The Certificate Signing Request' operationId: microsoftAzureCertificatesDeletecsr consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of the resource group required: true type: string - name: name in: path description: Name of the certificate signing request. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. patch: tags: - Certificates summary: 'Microsoft Azure Creates Or Modifies An Existing Certificate Signing Request' operationId: microsoftAzureCertificatesUpdatecsr consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of the resource group required: true type: string - name: name in: path description: Name of the certificate. required: true type: string - name: csrEnvelope in: body description: Details of certificate signing request if it exists already. required: true schema: $ref: '#/definitions/Csr' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Csr' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/classicMobileServices: get: tags: - ClassicMobileServices summary: 'Microsoft Azure Get All Mobile Services In A Resource Group' operationId: microsoftAzureClassicmobileservicesGetclassicmobileservices consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ClassicMobileServiceCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/classicMobileServices/{name}: get: tags: - ClassicMobileServices summary: 'Microsoft Azure Get A Mobile Service' operationId: microsoftAzureClassicmobileservicesGetclassicmobileservice consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of mobile service required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ClassicMobileService' deprecated: false description: Needs a more full description created. delete: tags: - ClassicMobileServices summary: 'Microsoft Azure Delete A Mobile Service' operationId: microsoftAzureClassicmobileservicesDeleteclassicmobileservice consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of mobile service required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains: get: tags: - Domains summary: Microsoft Azure Lists Domains Under A Resource Group operationId: microsoftAzureDomainsGetdomains consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of the resource group required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/DomainCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName} : get: tags: - Domains summary: Microsoft Azure Gets Details Of A Domain operationId: microsoftAzureDomainsGetdomain consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of the resource group required: true type: string - name: domainName in: path description: Name of the domain required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Domain' deprecated: false description: Needs a more full description created. put: tags: - Domains summary: Microsoft Azure Creates A Domain operationId: microsoftAzureDomainsCreateorupdatedomain consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: '>Name of the resource group' required: true type: string - name: domainName in: path description: Name of the domain required: true type: string - name: domain in: body description: Domain registration information required: true schema: $ref: '#/definitions/Domain' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Domain purchase was successful schema: $ref: '#/definitions/Domain' '202': description: Domain purchase is in progress schema: $ref: '#/definitions/Domain' deprecated: false description: Needs a more full description created. delete: tags: - Domains summary: Microsoft Azure Deletes A Domain operationId: microsoftAzureDomainsDeletedomain consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of the resource group required: true type: string - name: domainName in: path description: Name of the domain required: true type: string - name: forceHardDeleteDomain in: query description: >- If true then the domain will be deleted immediately instead of after 24 hours type: boolean - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '204': description: >- Domain does not exist in Azure database probably because it has already been deleted schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. patch: tags: - Domains summary: Microsoft Azure Creates A Domain operationId: microsoftAzureDomainsUpdatedomain consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: '>Name of the resource group' required: true type: string - name: domainName in: path description: Name of the domain required: true type: string - name: domain in: body description: Domain registration information required: true schema: $ref: '#/definitions/Domain' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Domain purchase was successful schema: $ref: '#/definitions/Domain' '202': description: Domain purchase is in progress schema: $ref: '#/definitions/Domain' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/operationresults/{operationId} : get: tags: - Domains summary: Microsoft Azure Retrieves The Latest Status Of A Domain Purchase Operation operationId: microsoftAzureDomainsGetdomainoperation consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of the resource group required: true type: string - name: domainName in: path description: Name of the domain required: true type: string - name: operationId in: path description: Domain purchase operation Id required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Domain purchase was successful schema: $ref: '#/definitions/Domain' '202': description: Domain purchase is in progress schema: $ref: '#/definitions/Domain' '500': description: Domain purchase request failed deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/providers/Microsoft.Web/publishingCredentials: get: tags: - Global summary: Microsoft Azure Gets Publishing Credentials For The Subscription Owner operationId: microsoftAzureGlobalGetsubscriptionpublishingcredentials consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/User' deprecated: false description: Needs a more full description created. put: tags: - Global summary: Microsoft Azure Updates Publishing Credentials For The Subscription Owner operationId: microsoftAzureGlobalUpdatesubscriptionpublishingcredentials consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: requestMessage in: body description: requestMessage with new publishing credentials required: true schema: $ref: '#/definitions/User' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/User' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/providers/Microsoft.Web/geoRegions: get: tags: - Global summary: Microsoft Azure Gets List Of Available Geo Regions operationId: microsoftAzureGlobalGetsubscriptiongeoregions consumes: [] produces: - application/json - text/json parameters: - name: sku in: query description: Filter only to regions that support this sku type: string - name: linuxWorkersEnabled in: query description: Filter only to regions that support linux workers type: boolean - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/GeoRegionCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. /subscriptions/{subscriptionId}/providers/Microsoft.Web/certificates: get: tags: - Global summary: Microsoft Azure Get All Certificates For A Subscription operationId: microsoftAzureGlobalGetallcertificates consumes: [] produces: - application/json - text/json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/CertificateCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. /subscriptions/{subscriptionId}/providers/Microsoft.Web/serverfarms: get: tags: - Global summary: Microsoft Azure Gets All App Service Plans For A Subscription operationId: microsoftAzureGlobalGetallserverfarms consumes: [] produces: - application/json - text/json parameters: - name: detailed in: query description: "False to return a subset of App Service Plan properties, true to return all of the properties.\r\n Retrieval of all properties may increase the API latency." type: boolean - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ServerFarmCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. /subscriptions/{subscriptionId}/providers/Microsoft.Web/sites: get: tags: - Global summary: Microsoft Azure Gets All Web Apps For A Subscription operationId: microsoftAzureGlobalGetallsites consumes: [] produces: - application/json - text/json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. /subscriptions/{subscriptionId}/providers/Microsoft.Web/hostingEnvironments: get: tags: - Global summary: Microsoft Azure Gets All Hostingenvironments App Service Environment For A Subscription operationId: microsoftAzureGlobalGetallhostingenvironments consumes: [] produces: - application/json - text/json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/HostingEnvironmentCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. /subscriptions/{subscriptionId}/providers/Microsoft.Web/managedHostingEnvironments: get: tags: - Global summary: Microsoft Azure Gets All Managed Hosting Environments For A Subscription operationId: microsoftAzureGlobalGetallmanagedhostingenvironments consumes: [] produces: - application/json - text/json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ManagedHostingEnvironmentCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. /subscriptions/{subscriptionId}/providers/Microsoft.Web/classicMobileServices: get: tags: - Global summary: Microsoft Azure Gets All Mobile Services For A Subscription operationId: microsoftAzureGlobalGetallclassicmobileservices consumes: [] produces: - application/json - text/json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ClassicMobileServiceCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. /subscriptions/{subscriptionId}/providers/Microsoft.Web/premieraddonoffers: get: tags: - Global summary: Microsoft Azure List Premier Add On Offers operationId: microsoftAzureGlobalListpremieraddonoffers consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/providers/Microsoft.Web/ishostingenvironmentnameavailable: get: tags: - Global summary: Microsoft Azure Whether Hosting Environment Name Is Available operationId: microsoftAzureGlobalIshostingenvironmentnameavailable consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: name in: query description: Hosting environment name required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/providers/Microsoft.Web/ishostingenvironmentnameavailable/{name}: get: tags: - Global summary: Microsoft Azure Whether Hosting Environment Name Is Available operationId: microsoftAzureGlobalIshostingenvironmentwithlegacynameavailable consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: name in: path description: Hosting environment name required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/providers/Microsoft.Web/checknameavailability: post: tags: - Global summary: Microsoft Azure Check If Resource Name Is Available operationId: microsoftAzureGlobalChecknameavailability consumes: - application/json - text/json - application/xml - text/xml - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: request in: body description: Name availability request required: true schema: $ref: '#/definitions/ResourceNameAvailabilityRequest' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ResourceNameAvailability' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/providers/Microsoft.CertificateRegistration/certificateOrders: get: tags: - GlobalCertificateOrder summary: Microsoft Azure Lists All Domains In A Subscription operationId: microsoftAzureGlobalcertificateorderGetallcertificateorders consumes: [] produces: - application/json - text/json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/CertificateOrderCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. /subscriptions/{subscriptionId}/providers/Microsoft.CertificateRegistration/validateCertificateRegistrationInformation: post: tags: - GlobalCertificateOrder summary: Microsoft Azure Validate Certificate Purchase Information operationId: >- microsoftAzureGlobalcertificateorderValidatecertificatepurchaseinformation consumes: - application/json - text/json - application/xml - text/xml - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: certificateOrder in: body description: Certificate order required: true schema: $ref: '#/definitions/CertificateOrder' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/domains: get: tags: - GlobalDomainRegistration summary: Microsoft Azure Lists All Domains In A Subscription operationId: microsoftAzureGlobaldomainregistrationGetalldomains consumes: [] produces: - application/json - text/json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/DomainCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. /subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/generateSsoRequest: post: tags: - GlobalDomainRegistration summary: Microsoft Azure Generates A Single Sign On Request For Domain Management Portal operationId: microsoftAzureGlobaldomainregistrationGetdomaincontrolcenterssorequest consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/DomainControlCenterSsoRequest' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/validateDomainRegistrationInformation: post: tags: - GlobalDomainRegistration summary: Microsoft Azure Validates Domain Registration Information operationId: microsoftAzureGlobaldomainregistrationValidatedomainpurchaseinformation consumes: - application/json - text/json - application/xml - text/xml - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: domainRegistrationInput in: body description: Domain registration information required: true schema: $ref: '#/definitions/DomainRegistrationInput' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/checkDomainAvailability: post: tags: - GlobalDomainRegistration summary: Microsoft Azure Checks If A Domain Is Available For Registration operationId: microsoftAzureGlobaldomainregistrationCheckdomainavailability consumes: - application/json - text/json - application/xml - text/xml - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: identifier in: body description: Name of the domain required: true schema: $ref: '#/definitions/NameIdentifier' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/DomainAvailablilityCheckResult' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/listDomainRecommendations: post: tags: - GlobalDomainRegistration summary: Microsoft Azure Lists Domain Recommendations Based On Keywords operationId: microsoftAzureGlobaldomainregistrationListdomainrecommendations consumes: - application/json - text/json - application/xml - text/xml - application/x-www-form-urlencoded produces: - application/json - text/json parameters: - name: parameters in: body description: Domain recommendation search parameters required: true schema: $ref: '#/definitions/DomainRecommendationSearchParameters' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/NameIdentifierCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/moveResources: post: tags: - GlobalResourceGroups operationId: microsoftAzureGlobalresourcegroupsMoveresources consumes: - application/json - text/json - application/xml - text/xml - application/x-www-form-urlencoded produces: [] parameters: - name: resourceGroupName in: path required: true type: string - name: moveResourceEnvelope in: body required: true schema: $ref: '#/definitions/CsmMoveResourceEnvelope' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '204': description: No Content deprecated: false summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Moveresources description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}: get: tags: - HostingEnvironments summary: 'Microsoft Azure Get Properties Of Hostingenvironment App Service Environment' operationId: microsoftAzureHostingenvironmentsGethostingenvironment consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/HostingEnvironment' deprecated: false description: Needs a more full description created. put: tags: - HostingEnvironments summary: 'Microsoft Azure Create Or Update A Hostingenvironment App Service Environment' operationId: microsoftAzureHostingenvironmentsCreateorupdatehostingenvironment consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - name: hostingEnvironmentEnvelope in: body description: Properties of hostingEnvironment (App Service Environment) required: true schema: $ref: '#/definitions/HostingEnvironment' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/HostingEnvironment' '202': description: Operation is in progress schema: $ref: '#/definitions/HostingEnvironment' '400': description: Bad request '404': description: Not found '409': description: Conflict deprecated: false x-ms-long-running-operation: true description: Needs a more full description created. delete: tags: - HostingEnvironments summary: 'Microsoft Azure Delete A Hostingenvironment App Service Environment' operationId: microsoftAzureHostingenvironmentsDeletehostingenvironment consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - name: forceDelete in: query description: >- Delete even if the hostingEnvironment (App Service Environment) contains resources type: boolean - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' '202': description: Operation is in progress schema: $ref: '#/definitions/Object' '400': description: Bad request '404': description: Not found '409': description: Conflict deprecated: false x-ms-long-running-operation: true description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics : get: tags: - HostingEnvironments summary: >- Microsoft Azure Get Diagnostic Information For Hostingenvironment App Service Environment operationId: microsoftAzureHostingenvironmentsGethostingenvironmentdiagnostics consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: type: array items: $ref: '#/definitions/HostingEnvironmentDiagnostics' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics/{diagnosticsName} : get: tags: - HostingEnvironments summary: >- Microsoft Azure Get Diagnostic Information For Hostingenvironment App Service Environment operationId: microsoftAzureHostingenvironmentsGethostingenvironmentdiagnosticsitem consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - name: diagnosticsName in: path description: Name of the diagnostics required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/HostingEnvironmentDiagnostics' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/compute : get: tags: - HostingEnvironments summary: >- Microsoft Azure Get Used, Available, And Total Worker Capacity For Hostingenvironment App Service Environment operationId: microsoftAzureHostingenvironmentsGethostingenvironmentcapacities consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/StampCapacityCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/virtualip : get: tags: - HostingEnvironments summary: >- Microsoft Azure Get Ip Addresses Assigned To The Hostingenvironment App Service Environment operationId: microsoftAzureHostingenvironmentsGethostingenvironmentvips consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/AddressResponse' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments: get: tags: - HostingEnvironments summary: >- Microsoft Azure Get All Hostingenvironments App Service Environments In A Resource Group operationId: microsoftAzureHostingenvironmentsGethostingenvironments consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/HostingEnvironmentCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/reboot : post: tags: - HostingEnvironments summary: 'Microsoft Azure Reboots All Machines In A Hostingenvironment App Service Environment' operationId: microsoftAzureHostingenvironmentsReboothostingenvironment consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '202': description: Asynchronous operation in progress schema: $ref: '#/definitions/Object' '400': description: Bad request '404': description: Not found '409': description: Conflict deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/operations : get: tags: - HostingEnvironments summary: >- Microsoft Azure List All Currently Running Operations On The Hostingenvironment App Service Environment operationId: microsoftAzureHostingenvironmentsGethostingenvironmentoperations consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/operations/{operationId} : get: tags: - HostingEnvironments summary: >- Microsoft Azure Get Status Of An Operation On A Hostingenvironment App Service Environment operationId: microsoftAzureHostingenvironmentsGethostingenvironmentoperation consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - name: operationId in: path description: operation identifier GUID required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Operation completed successfully schema: $ref: '#/definitions/Object' '202': description: Asynchronous operation in progress schema: $ref: '#/definitions/Object' '404': description: Not found '500': description: Operation failed deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/metrics : get: tags: - HostingEnvironments summary: 'Microsoft Azure Get Global Metrics Of Hostingenvironment App Service Environment' operationId: microsoftAzureHostingenvironmentsGethostingenvironmentmetrics consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - name: details in: query description: Include instance details type: boolean - name: $filter in: query description: >- Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'. type: string x-ms-skip-url-encoding: true - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ResourceMetricCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/metricdefinitions : get: tags: - HostingEnvironments summary: >- Microsoft Azure Get Global Metric Definitions Of Hostingenvironment App Service Environment operationId: microsoftAzureHostingenvironmentsGethostingenvironmentmetricdefinitions consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/MetricDefinition' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/usages : get: tags: - HostingEnvironments summary: 'Microsoft Azure Get Global Usages Of Hostingenvironment App Service Environment' operationId: microsoftAzureHostingenvironmentsGethostingenvironmentusages consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - name: $filter in: query description: >- Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'. type: string x-ms-skip-url-encoding: true - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/CsmUsageQuotaCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/metrics : get: tags: - HostingEnvironments summary: >- Microsoft Azure Get Metrics For A Multirole Pool Of A Hostingenvironment App Service Environment operationId: microsoftAzureHostingenvironmentsGethostingenvironmentmultirolemetrics consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - name: startTime in: query description: Beginning time of metrics query type: string - name: endTime in: query description: End time of metrics query type: string - name: timeGrain in: query description: Time granularity of metrics query type: string - name: details in: query description: Include instance details type: boolean - name: $filter in: query description: >- Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'. type: string x-ms-skip-url-encoding: true - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ResourceMetricCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/metrics : get: tags: - HostingEnvironments summary: >- Microsoft Azure Get Metrics For A Worker Pool Of A Hostingenvironment App Service Environment operationId: microsoftAzureHostingenvironmentsGethostingenvironmentwebworkermetrics consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - name: workerPoolName in: path description: Name of worker pool required: true type: string - name: details in: query description: Include instance details type: boolean - name: $filter in: query description: >- Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'. type: string x-ms-skip-url-encoding: true - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ResourceMetricCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/metricdefinitions : get: tags: - HostingEnvironments summary: >- Microsoft Azure Get Metric Definitions For A Multirole Pool Of A Hostingenvironment App Service Environment operationId: >- microsoftAzureHostingenvironmentsGethostingenvironmentmultirolemetricdefinitions consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/MetricDefinitionCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/metricdefinitions : get: tags: - HostingEnvironments summary: >- Microsoft Azure Get Metric Definitions For A Worker Pool Of A Hostingenvironment App Service Environment operationId: >- microsoftAzureHostingenvironmentsGethostingenvironmentwebworkermetricdefinitions consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - name: workerPoolName in: path description: Name of worker pool required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/MetricDefinitionCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/usages : get: tags: - HostingEnvironments summary: >- Microsoft Azure Get Usages For A Multirole Pool Of A Hostingenvironment App Service Environment operationId: microsoftAzureHostingenvironmentsGethostingenvironmentmultiroleusages consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/UsageCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/usages : get: tags: - HostingEnvironments summary: >- Microsoft Azure Get Usages For A Worker Pool Of A Hostingenvironment App Service Environment operationId: microsoftAzureHostingenvironmentsGethostingenvironmentwebworkerusages consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - name: workerPoolName in: path description: Name of worker pool required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/UsageCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/sites : get: tags: - HostingEnvironments summary: 'Microsoft Azure Get All Sites On The Hostingenvironment App Service Environment' operationId: microsoftAzureHostingenvironmentsGethostingenvironmentsites consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - name: propertiesToInclude in: query description: Comma separated list of site properties to include type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/webhostingplans : get: tags: - HostingEnvironments summary: >- Microsoft Azure Get All Serverfarms App Service Plans On The Hostingenvironment App Service Environment operationId: microsoftAzureHostingenvironmentsGethostingenvironmentwebhostingplans consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ServerFarmCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/serverfarms : get: tags: - HostingEnvironments summary: >- Microsoft Azure Get All Serverfarms App Service Plans On The Hostingenvironment App Service Environment operationId: microsoftAzureHostingenvironmentsGethostingenvironmentserverfarms consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ServerFarmCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools : get: tags: - HostingEnvironments summary: Microsoft Azure Get All Multi Role Pools operationId: microsoftAzureHostingenvironmentsGetmultirolepools consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/WorkerPoolCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default : get: tags: - HostingEnvironments summary: 'Microsoft Azure Get Properties Of A Multirole Pool' operationId: microsoftAzureHostingenvironmentsGetmultirolepool consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/WorkerPool' deprecated: false description: Needs a more full description created. put: tags: - HostingEnvironments summary: 'Microsoft Azure Create Or Update A Multirole Pool' operationId: microsoftAzureHostingenvironmentsCreateorupdatemultirolepool consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - name: multiRolePoolEnvelope in: body description: Properties of multiRole pool required: true schema: $ref: '#/definitions/WorkerPool' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/WorkerPool' '202': description: Operation is in progress schema: $ref: '#/definitions/WorkerPool' '400': description: Bad request '404': description: Not found '409': description: Conflict deprecated: false x-ms-long-running-operation: true description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/skus : get: tags: - HostingEnvironments summary: 'Microsoft Azure Get Available Skus For Scaling A Multirole Pool' operationId: microsoftAzureHostingenvironmentsGetmultirolepoolskus consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SkuInfoCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools : get: tags: - HostingEnvironments summary: Microsoft Azure Get All Worker Pools operationId: microsoftAzureHostingenvironmentsGetworkerpools consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/WorkerPoolCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName} : get: tags: - HostingEnvironments summary: 'Microsoft Azure Get Properties Of A Worker Pool' operationId: microsoftAzureHostingenvironmentsGetworkerpool consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - name: workerPoolName in: path description: Name of worker pool required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/WorkerPool' deprecated: false description: Needs a more full description created. put: tags: - HostingEnvironments summary: 'Microsoft Azure Create Or Update A Worker Pool' operationId: microsoftAzureHostingenvironmentsCreateorupdateworkerpool consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - name: workerPoolName in: path description: Name of worker pool required: true type: string - name: workerPoolEnvelope in: body description: Properties of worker pool required: true schema: $ref: '#/definitions/WorkerPool' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/WorkerPool' '202': description: Operation is in progress schema: $ref: '#/definitions/WorkerPool' '400': description: Bad request '404': description: Not found '409': description: Conflict deprecated: false x-ms-long-running-operation: true description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/skus : get: tags: - HostingEnvironments summary: 'Microsoft Azure Get Available Skus For Scaling A Worker Pool' operationId: microsoftAzureHostingenvironmentsGetworkerpoolskus consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - name: workerPoolName in: path description: Name of worker pool required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SkuInfoCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/instances/{instance}/metrics : get: tags: - HostingEnvironments summary: >- Microsoft Azure Get Metrics For A Specific Instance Of A Worker Pool Of A Hostingenvironment App Service Environment operationId: microsoftAzureHostingenvironmentsGetworkerpoolinstancemetrics consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - name: workerPoolName in: path description: Name of worker pool required: true type: string - name: instance in: path description: Name of instance in the worker pool required: true type: string - name: details in: query description: Include instance details type: boolean - name: $filter in: query description: >- Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'. type: string x-ms-skip-url-encoding: true - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/instances/{instance}/metricdefinitions : get: tags: - HostingEnvironments summary: >- Microsoft Azure Get Metric Definitions For A Specific Instance Of A Worker Pool Of A Hostingenvironment App Service Environment operationId: microsoftAzureHostingenvironmentsGetworkerpoolinstancemetricdefinitions consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - name: workerPoolName in: path description: Name of worker pool required: true type: string - name: instance in: path description: Name of instance in the worker pool required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/instances/{instance}/metrics : get: tags: - HostingEnvironments summary: >- Microsoft Azure Get Metrics For A Specific Instance Of A Multirole Pool Of A Hostingenvironment App Service Environment operationId: microsoftAzureHostingenvironmentsGetmultirolepoolinstancemetrics consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - name: instance in: path description: Name of instance in the multiRole pool required: true type: string - name: details in: query description: Include instance details type: boolean - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/instances/{instance}/metricdefinitions : get: tags: - HostingEnvironments summary: >- Microsoft Azure Get Metric Definitions For A Specific Instance Of A Multirole Pool Of A Hostingenvironment App Service Environment operationId: >- microsoftAzureHostingenvironmentsGetmultirolepoolinstancemetricdefinitions consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - name: instance in: path description: Name of instance in the multiRole pool> required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/suspend : post: tags: - HostingEnvironments summary: 'Microsoft Azure Suspends The Hostingenvironment' operationId: microsoftAzureHostingenvironmentsSuspendhostingenvironment consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteCollection' '202': description: Operation is in progress schema: $ref: '#/definitions/SiteCollection' deprecated: false x-ms-long-running-operation: true x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/resume : post: tags: - HostingEnvironments summary: 'Microsoft Azure Resumes The Hostingenvironment' operationId: microsoftAzureHostingenvironmentsResumehostingenvironment consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteCollection' '202': description: Operation is in progress schema: $ref: '#/definitions/SiteCollection' deprecated: false x-ms-long-running-operation: true x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name} : get: tags: - ManagedHostingEnvironments summary: 'Microsoft Azure Get Properties Of A Managed Hosting Environment' operationId: microsoftAzureManagedhostingenvironmentsGetmanagedhostingenvironment consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of managed hosting environment required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ManagedHostingEnvironment' deprecated: false description: Needs a more full description created. put: tags: - ManagedHostingEnvironments summary: 'Microsoft Azure Create Or Update A Managed Hosting Environment' operationId: >- microsoftAzureManagedhostingenvironmentsCreateorupdatemanagedhostingenvironment consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of managed hosting environment required: true type: string - name: ManagedHostingEnvironmentEnvelope in: body description: Properties of managed hosting environment required: true schema: $ref: '#/definitions/HostingEnvironment' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '202': description: Asynchronous operation in progress schema: $ref: '#/definitions/HostingEnvironment' '400': description: Bad request '404': description: Not found '409': description: Conflict deprecated: false x-ms-long-running-operation: true description: Needs a more full description created. delete: tags: - ManagedHostingEnvironments summary: 'Microsoft Azure Delete A Managed Hosting Environment' operationId: microsoftAzureManagedhostingenvironmentsDeletemanagedhostingenvironment consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of managed hosting environment required: true type: string - name: forceDelete in: query description: Delete even if the managed hosting environment contains resources type: boolean - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '202': description: Asynchronous operation in progress schema: $ref: '#/definitions/Object' '400': description: Bad request '404': description: Not found '409': description: Conflict deprecated: false x-ms-long-running-operation: true description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments: get: tags: - ManagedHostingEnvironments summary: 'Microsoft Azure Get All Managed Hosting Environments In A Resource Group' operationId: microsoftAzureManagedhostingenvironmentsGetmanagedhostingenvironments consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/HostingEnvironmentCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}/capacities/virtualip : get: tags: - ManagedHostingEnvironments summary: Microsoft Azure Get List Of Ip Addresses Assigned To A Managed Hosting Environment operationId: microsoftAzureManagedhostingenvironmentsGetmanagedhostingenvironmentvips consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of managed hosting environment required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/AddressResponse' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}/operations/{operationId} : get: tags: - ManagedHostingEnvironments summary: 'Microsoft Azure Get Status Of An Operation On A Managed Hosting Environment' operationId: >- microsoftAzureManagedhostingenvironmentsGetmanagedhostingenvironmentoperation consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of managed hosting environment required: true type: string - name: operationId in: path description: operation identifier GUID required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Operation completed successfully schema: $ref: '#/definitions/Object' '202': description: Asynchronous operation in progress schema: $ref: '#/definitions/Object' '404': description: Not found '500': description: Operation failed deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}/sites : get: tags: - ManagedHostingEnvironments summary: 'Microsoft Azure Get All Sites On The Managed Hosting Environment' operationId: >- microsoftAzureManagedhostingenvironmentsGetmanagedhostingenvironmentsites consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of managed hosting environment required: true type: string - name: propertiesToInclude in: query description: Comma separated list of site properties to include type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}/webhostingplans : get: tags: - ManagedHostingEnvironments summary: >- Microsoft Azure Get All Serverfarms App Service Plans On The Managed Hosting Environment operationId: >- microsoftAzureManagedhostingenvironmentsGetmanagedhostingenvironmentwebhostingplans consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of managed hosting environment required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ServerFarmCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}/serverfarms : get: tags: - ManagedHostingEnvironments summary: >- Microsoft Azure Get All Serverfarms App Service Plans On The Managed Hosting Environment operationId: >- microsoftAzureManagedhostingenvironmentsGetmanagedhostingenvironmentserverfarms consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of managed hosting environment required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ServerFarmCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. /providers/Microsoft.Web/sourcecontrols: get: tags: - Provider summary: Microsoft Azure Gets The Source Controls Available For Azure Websites operationId: microsoftAzureProviderGetsourcecontrols consumes: [] produces: - application/json - text/json parameters: - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SourceControlCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. /providers/Microsoft.Web/sourcecontrols/{sourceControlType}: get: tags: - Provider summary: Microsoft Azure Gets Source Control Token operationId: microsoftAzureProviderGetsourcecontrol consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: sourceControlType in: path description: Type of source control required: true type: string - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SourceControl' deprecated: false description: Needs a more full description created. put: tags: - Provider summary: Microsoft Azure Updates Source Control Token operationId: microsoftAzureProviderUpdatesourcecontrol consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: sourceControlType in: path description: Type of source control required: true type: string - name: requestMessage in: body description: Source control token information required: true schema: $ref: '#/definitions/SourceControl' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SourceControl' deprecated: false description: Needs a more full description created. /providers/Microsoft.Web/publishingUsers/web: get: tags: - Provider summary: Microsoft Azure Gets Publishing User operationId: microsoftAzureProviderGetpublishinguser consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/User' deprecated: false description: Needs a more full description created. put: tags: - Provider summary: Microsoft Azure Updates Publishing User operationId: microsoftAzureProviderUpdatepublishinguser consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: requestMessage in: body description: Details of publishing user required: true schema: $ref: '#/definitions/User' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/User' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/providers/Microsoft.Web/recommendations: get: tags: - Recommendations summary: >- Microsoft Azure Gets A List Of Recommendations Associated With The Specified Subscription operationId: microsoftAzureRecommendationsGetrecommendationbysubscription consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: featured in: query description: >- If set, this API returns only the most critical recommendation among the others. Otherwise this API returns all recommendations available type: boolean - name: $filter in: query description: >- Return only channels specified in the filter. Filter is specified by using OData syntax. Example: $filter=channels eq 'Api' or channel eq 'Notification' type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: type: array items: $ref: '#/definitions/Recommendation' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendations/{name} : get: tags: - Recommendations summary: >- Microsoft Azure Gets The Detailed Properties Of The Recommendation Object For The Specified Web Site operationId: microsoftAzureRecommendationsGetruledetailsbysitename consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Resource group name required: true type: string - name: siteName in: path description: Site name required: true type: string - name: name in: path description: Recommendation rule name required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/RecommendationRule' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendations : get: tags: - Recommendations summary: 'Microsoft Azure Gets A List Of Recommendations Associated With The Specified Web Site' operationId: microsoftAzureRecommendationsGetrecommendedrulesforsite consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Resource group name required: true type: string - name: siteName in: path description: Site name required: true type: string - name: featured in: query description: >- If set, this API returns only the most critical recommendation among the others. Otherwise this API returns all recommendations available type: boolean - name: siteSku in: query description: The name of site SKU. type: string - name: numSlots in: query description: The number of site slots associated to the site type: integer format: int32 - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: type: array items: $ref: '#/definitions/Recommendation' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendationHistory : get: tags: - Recommendations summary: >- Microsoft Azure Gets The List Of Past Recommendations Optionally Specified By The Time Range operationId: microsoftAzureRecommendationsGetrecommendationhistoryforsite consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Resource group name required: true type: string - name: siteName in: path description: Site name required: true type: string - name: startTime in: query description: >- The start time of a time range to query, e.g. $filter=startTime eq '2015-01-01T00:00:00Z' and endTime eq '2015-01-02T00:00:00Z' type: string - name: endTime in: query description: >- The end time of a time range to query, e.g. $filter=startTime eq '2015-01-01T00:00:00Z' and endTime eq '2015-01-02T00:00:00Z' type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: type: array items: $ref: '#/definitions/Recommendation' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms: get: tags: - ServerFarms summary: >- Microsoft Azure Gets Collection Of App Service Plans In A Resource Group For A Given Subscription operationId: microsoftAzureServerfarmsGetserverfarms consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ServerFarmCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}: get: tags: - ServerFarms summary: Microsoft Azure Gets Specified App Service Plan In A Resource Group operationId: microsoftAzureServerfarmsGetserverfarm consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of App Service Plan required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ServerFarmWithRichSku' deprecated: false description: Needs a more full description created. put: tags: - ServerFarms summary: Microsoft Azure Creates Or Updates An App Service Plan operationId: microsoftAzureServerfarmsCreateorupdateserverfarm consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of App Service Plan required: true type: string - name: serverFarmEnvelope in: body description: Details of App Service Plan required: true schema: $ref: '#/definitions/ServerFarmWithRichSku' - name: allowPendingState in: query description: 'OBSOLETE: If true, allow pending state for App Service Plan' type: boolean - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ServerFarmWithRichSku' '202': description: Operation is in progress schema: $ref: '#/definitions/ServerFarmWithRichSku' deprecated: false x-ms-long-running-operation: true description: Needs a more full description created. delete: tags: - ServerFarms summary: Microsoft Azure Deletes A App Service Plan operationId: microsoftAzureServerfarmsDeleteserverfarm consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of App Service Plan required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/metrics: get: tags: - ServerFarms summary: Microsoft Azure Queries For App Service Plan Metrics operationId: microsoftAzureServerfarmsGetserverfarmmetrics consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of App Service Plan required: true type: string - name: details in: query description: If true, metrics are broken down per App Service Plan instance type: boolean - name: $filter in: query description: >- Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'. type: string x-ms-skip-url-encoding: true - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ResourceMetricCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/metricdefinitions : get: tags: - ServerFarms summary: Microsoft Azure List Of Metrics That Can Be Queried For An App Service Plan operationId: microsoftAzureServerfarmsGetserverfarmmetricdefintions consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of App Service Plan required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/MetricDefinitionCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections : get: tags: - ServerFarms summary: Microsoft Azure Gets List Of Vnets Associated With App Service Plan operationId: microsoftAzureServerfarmsGetvnetsforserverfarm consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of App Service Plan required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: type: array items: $ref: '#/definitions/VnetInfo' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName} : get: tags: - ServerFarms summary: Microsoft Azure Gets A Vnet Associated With An App Service Plan operationId: microsoftAzureServerfarmsGetvnetfromserverfarm consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of App Service Plan required: true type: string - name: vnetName in: path description: Name of virtual network required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/VnetInfo' '404': description: Virtual network could not be found deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes : get: tags: - ServerFarms summary: Microsoft Azure Gets A List Of All Routes Associated With A Vnet, In An App Service Plan operationId: microsoftAzureServerfarmsGetroutesforvnet consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of App Service Plan required: true type: string - name: vnetName in: path description: Name of virtual network required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: type: array items: $ref: '#/definitions/VnetRoute' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName} : get: tags: - ServerFarms summary: Microsoft Azure Gets A Specific Route Associated With A Vnet, In An App Service Plan operationId: microsoftAzureServerfarmsGetrouteforvnet consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of App Service Plan required: true type: string - name: vnetName in: path description: Name of virtual network required: true type: string - name: routeName in: path description: Name of the virtual network route required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: type: array items: $ref: '#/definitions/VnetRoute' '404': description: Specified route does not exist deprecated: false description: Needs a more full description created. put: tags: - ServerFarms summary: >- Microsoft Azure Creates A New Route Or Updates An Existing Route For A Vnet In An App Service Plan operationId: microsoftAzureServerfarmsCreateorupdatevnetroute consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of App Service Plan required: true type: string - name: vnetName in: path description: Name of virtual network required: true type: string - name: routeName in: path description: Name of the virtual network route required: true type: string - name: route in: body description: The route object required: true schema: $ref: '#/definitions/VnetRoute' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/VnetRoute' '400': description: >- Invalid request. Ensure that required parameters are given, and that addresses and address spaces are valid '404': description: Route not found. This will only occur when using the PATCH verb. deprecated: false description: Needs a more full description created. delete: tags: - ServerFarms summary: 'Microsoft Azure Deletes An Existing Route For A Vnet In An App Service Plan' operationId: microsoftAzureServerfarmsDeletevnetroute consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of App Service Plan required: true type: string - name: vnetName in: path description: Name of virtual network required: true type: string - name: routeName in: path description: Name of the virtual network route required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' '404': description: Specified route does not exist. deprecated: false description: Needs a more full description created. patch: tags: - ServerFarms summary: >- Microsoft Azure Creates A New Route Or Updates An Existing Route For A Vnet In An App Service Plan operationId: microsoftAzureServerfarmsUpdatevnetroute consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of App Service Plan required: true type: string - name: vnetName in: path description: Name of virtual network required: true type: string - name: routeName in: path description: Name of the virtual network route required: true type: string - name: route in: body description: The route object required: true schema: $ref: '#/definitions/VnetRoute' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/VnetRoute' '400': description: >- Invalid request. Ensure that required parameters are given, and that addresses and address spaces are valid '404': description: Route not found. This will only occur when using the PATCH verb. deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName} : get: tags: - ServerFarms summary: 'Microsoft Azure Gets The Vnet Gateway' operationId: microsoftAzureServerfarmsGetserverfarmvnetgateway consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of the App Service Plan required: true type: string - name: vnetName in: path description: Name of the virtual network required: true type: string - name: gatewayName in: path description: Name of the gateway. Only the 'primary' gateway is supported. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/VnetGateway' deprecated: false description: Needs a more full description created. put: tags: - ServerFarms summary: Microsoft Azure Updates The Vnet Gateway operationId: microsoftAzureServerfarmsUpdateserverfarmvnetgateway consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: The resource group required: true type: string - name: name in: path description: The name of the App Service Plan required: true type: string - name: vnetName in: path description: The name of the virtual network required: true type: string - name: gatewayName in: path description: The name of the gateway. Only 'primary' is supported. required: true type: string - name: connectionEnvelope in: body description: The gateway entity. required: true schema: $ref: '#/definitions/VnetGateway' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/VnetGateway' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/sites: get: tags: - ServerFarms summary: Microsoft Azure Gets List Of Apps Associated With An App Service Plan operationId: microsoftAzureServerfarmsGetserverfarmsites consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of App Service Plan required: true type: string - name: $skipToken in: query description: >- Skip to of web apps in a list. If specified, the resulting list will contain web apps starting from (including) the skipToken. Else, the resulting list contains web apps from the start of the list type: string - name: $filter in: query description: >- Supported filter: $filter=state eq running. Returns only web apps that are currently running type: string - name: $top in: query description: List page size. If specified, results are paged. type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/workers/{workerName}/reboot : post: tags: - ServerFarms summary: >- Microsoft Azure Submit A Reboot Request For A Worker Machine In The Specified Server Farm operationId: microsoftAzureServerfarmsRebootworkerforserverfarm consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of server farm required: true type: string - name: workerName in: path description: Name of worker machine, typically starts with RD required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/restartSites: post: tags: - ServerFarms summary: Microsoft Azure Restarts Web Apps In A Specified App Service Plan operationId: microsoftAzureServerfarmsRestartsitesforserverfarm consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of App Service Plan required: true type: string - name: softRestart in: query description: >- Soft restart applies the configuration settings and restarts the apps if necessary. Hard restart always restarts and reprovisions the apps type: boolean - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/operationresults/{operationId} : get: tags: - ServerFarms summary: Microsoft Azure Gets A Server Farm Operation operationId: microsoftAzureServerfarmsGetserverfarmoperation consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of server farm required: true type: string - name: operationId in: path description: Id of Server farm operation"> required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ServerFarmWithRichSku' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName} : get: tags: - Sites summary: >- Microsoft Azure Retrieves A Specific Virtual Network Connection Associated With This Web App operationId: microsoftAzureSitesGetsitevnetconnectionslot consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: The resource group name required: true type: string - name: name in: path description: The name of the web app required: true type: string - name: vnetName in: path description: The name of the Virtual Network required: true type: string - name: slot in: path description: The name of the slot for this web app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/VnetInfo' deprecated: false description: Needs a more full description created. put: tags: - Sites summary: 'Microsoft Azure Adds A Virtual Network Connection Or Updates It S Properties' operationId: microsoftAzureSitesCreateorupdatesitevnetconnectionslot consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: The resource group name required: true type: string - name: name in: path description: The name of the web app required: true type: string - name: vnetName in: path description: The name of the Virtual Network required: true type: string - name: connectionEnvelope in: body description: The properties of this Virtual Network Connection required: true schema: $ref: '#/definitions/VnetInfo' - name: slot in: path description: The name of the slot for this web app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/VnetInfo' deprecated: false description: Needs a more full description created. delete: tags: - Sites summary: >- Microsoft Azure Removes The Specified Virtual Network Connection Association From This Web App operationId: microsoftAzureSitesDeletesitevnetconnectionslot consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: The resource group name required: true type: string - name: name in: path description: The name of the web app required: true type: string - name: vnetName in: path description: The name of the Virtual Network required: true type: string - name: slot in: path description: The name of the slot for this web app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. patch: tags: - Sites summary: 'Microsoft Azure Adds A Virtual Network Connection Or Updates It S Properties' operationId: microsoftAzureSitesUpdatesitevnetconnectionslot consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: The resource group name required: true type: string - name: name in: path description: The name of the web app required: true type: string - name: vnetName in: path description: The name of the Virtual Network required: true type: string - name: connectionEnvelope in: body description: The properties of this Virtual Network Connection required: true schema: $ref: '#/definitions/VnetInfo' - name: slot in: path description: The name of the slot for this web app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/VnetInfo' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName} : get: tags: - Sites summary: >- Microsoft Azure Retrieves A Specific Virtual Network Connection Associated With This Web App operationId: microsoftAzureSitesGetsitevnetconnection consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: The resource group name required: true type: string - name: name in: path description: The name of the web app required: true type: string - name: vnetName in: path description: The name of the Virtual Network required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/VnetInfo' deprecated: false description: Needs a more full description created. put: tags: - Sites summary: 'Microsoft Azure Adds A Virtual Network Connection Or Updates It S Properties' operationId: microsoftAzureSitesCreateorupdatesitevnetconnection consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: The resource group name required: true type: string - name: name in: path description: The name of the web app required: true type: string - name: vnetName in: path description: The name of the Virtual Network required: true type: string - name: connectionEnvelope in: body description: The properties of this Virtual Network Connection required: true schema: $ref: '#/definitions/VnetInfo' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/VnetInfo' deprecated: false description: Needs a more full description created. delete: tags: - Sites summary: >- Microsoft Azure Removes The Specified Virtual Network Connection Association From This Web App operationId: microsoftAzureSitesDeletesitevnetconnection consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: The resource group name required: true type: string - name: name in: path description: The name of the web app required: true type: string - name: vnetName in: path description: The name of the Virtual Network required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. patch: tags: - Sites summary: 'Microsoft Azure Adds A Virtual Network Connection Or Updates It S Properties' operationId: microsoftAzureSitesUpdatesitevnetconnection consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: The resource group name required: true type: string - name: name in: path description: The name of the web app required: true type: string - name: vnetName in: path description: The name of the Virtual Network required: true type: string - name: connectionEnvelope in: body description: The properties of this Virtual Network Connection required: true schema: $ref: '#/definitions/VnetInfo' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/VnetInfo' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkFeatures/{view} : get: tags: - Sites summary: 'Microsoft Azure Retrieves A View Of All Network Features In Use On This Web App' operationId: microsoftAzureSitesGetsitenetworkfeaturesslot consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: The resource group name required: true type: string - name: name in: path description: The name of the web app required: true type: string - name: view in: path description: The type of view. This can either be "summary" or "detailed". required: true type: string - name: slot in: path description: The name of the slot for this web app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/NetworkFeatures' '404': description: The requested view does not exist. deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkFeatures/{view} : get: tags: - Sites summary: 'Microsoft Azure Retrieves A View Of All Network Features In Use On This Web App' operationId: microsoftAzureSitesGetsitenetworkfeatures consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: The resource group name required: true type: string - name: name in: path description: The name of the web app required: true type: string - name: view in: path description: The type of view. This can either be "summary" or "detailed". required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/NetworkFeatures' '404': description: The requested view does not exist. deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/operationresults/{operationId} : get: tags: - Sites summary: Microsoft Azure Gets The Operation For A Web App operationId: microsoftAzureSitesGetsiteoperationslot consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: operationId in: path description: Id of an operation required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/operationresults/{operationId} : get: tags: - Sites summary: Microsoft Azure Gets The Operation For A Web App operationId: microsoftAzureSitesGetsiteoperation consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: operationId in: path description: Id of an operation required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slotsswap: post: tags: - Sites summary: Microsoft Azure Swaps Web App Slots operationId: microsoftAzureSitesSwapslotwithproduction consumes: - application/json - text/json - application/xml - text/xml - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: slotSwapEntity in: body description: Request body that contains the target slot name required: true schema: $ref: '#/definitions/CsmSlotEntity' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' '202': description: Operation is in progress schema: $ref: '#/definitions/Object' deprecated: false x-ms-long-running-operation: true description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/slotsswap : post: tags: - Sites summary: Microsoft Azure Swaps Web App Slots operationId: microsoftAzureSitesSwapslotsslot consumes: - application/json - text/json - application/xml - text/xml - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: slotSwapEntity in: body description: Request body that contains the target slot name required: true schema: $ref: '#/definitions/CsmSlotEntity' - name: slot in: path description: Name of source slot for the swap required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' '202': description: Operation is in progress schema: $ref: '#/definitions/Object' deprecated: false x-ms-long-running-operation: true description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slotsdiffs: post: tags: - Sites summary: Microsoft Azure Get The Difference In Configuration Settings Between Two Web App Slots operationId: microsoftAzureSitesGetslotsdifferencesfromproduction consumes: - application/json - text/json - application/xml - text/xml - application/x-www-form-urlencoded produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: slotSwapEntity in: body description: Request body that contains the target slot name required: true schema: $ref: '#/definitions/CsmSlotEntity' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SlotDifferenceCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/slotsdiffs : post: tags: - Sites summary: Microsoft Azure Get The Difference In Configuration Settings Between Two Web App Slots operationId: microsoftAzureSitesGetslotsdifferencesslot consumes: - application/json - text/json - application/xml - text/xml - application/x-www-form-urlencoded produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: slotSwapEntity in: body description: Request body that contains the target slot name required: true schema: $ref: '#/definitions/CsmSlotEntity' - name: slot in: path description: Name of the source slot required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SlotDifferenceCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/applySlotConfig: post: tags: - Sites summary: >- Microsoft Azure Applies The Configuration Settings From The Target Slot Onto The Current Slot operationId: microsoftAzureSitesApplyslotconfigtoproduction consumes: - application/json - text/json - application/xml - text/xml - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: slotSwapEntity in: body description: >- Request body that contains the target slot name. Settings from that slot will be applied on the source slot required: true schema: $ref: '#/definitions/CsmSlotEntity' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/applySlotConfig : post: tags: - Sites summary: >- Microsoft Azure Applies The Configuration Settings From The Target Slot Onto The Current Slot operationId: microsoftAzureSitesApplyslotconfigslot consumes: - application/json - text/json - application/xml - text/xml - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: slotSwapEntity in: body description: >- Request body that contains the target slot name. Settings from that slot will be applied on the source slot required: true schema: $ref: '#/definitions/CsmSlotEntity' - name: slot in: path description: >- Name of the source slot. Settings from the target slot will be applied onto this slot required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/resetSlotConfig: post: tags: - Sites summary: >- Microsoft Azure Resets The Configuration Settings Of The Current Slot If They Were Previously Modified By Calling Applyslotconfig Api operationId: microsoftAzureSitesResetproductionslotconfig consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/resetSlotConfig : post: tags: - Sites summary: >- Microsoft Azure Resets The Configuration Settings Of The Current Slot If They Were Previously Modified By Calling Applyslotconfig Api operationId: microsoftAzureSitesResetslotconfigslot consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/slotConfigNames : get: tags: - Sites summary: >- Microsoft Azure Gets The Names Of Application Settings And Connection String That Remain With The Slot During Swap Operation operationId: microsoftAzureSitesGetslotconfignames consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SlotConfigNamesResource' deprecated: false description: Needs a more full description created. put: tags: - Sites summary: >- Microsoft Azure Updates The Names Of Application Settings And Connection String That Remain With The Slot During Swap Operation operationId: microsoftAzureSitesUpdateslotconfignames consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: slotConfigNames in: body description: >- Request body containing the names of application settings and connection strings required: true schema: $ref: '#/definitions/SlotConfigNamesResource' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SlotConfigNamesResource' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots: get: tags: - Sites summary: Microsoft Azure Gets All The Slots For A Web Apps operationId: microsoftAzureSitesGetsiteslots consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: propertiesToInclude in: query description: List of app properties to include in the response type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites: get: tags: - Sites summary: Microsoft Azure Gets The Web Apps For A Subscription In The Specified Resource Group operationId: microsoftAzureSitesGetsites consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: propertiesToInclude in: query description: Additional web app properties included in the response type: string - name: includeSiteTypes in: query description: Types of apps included in the response type: string - name: includeSlots in: query description: Whether or not to include deployments slots in results type: boolean - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}: get: tags: - Sites summary: Microsoft Azure Get Details Of A Web App operationId: microsoftAzureSitesGetsite consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: propertiesToInclude in: query description: Additional web app properties included in the response type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Site' deprecated: false description: Needs a more full description created. put: tags: - Sites summary: 'Microsoft Azure Creates A New Web App Or Modifies An Existing Web App' operationId: microsoftAzureSitesCreateorupdatesite consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of the resource group required: true type: string - name: name in: path description: Name of the web app required: true type: string - name: siteEnvelope in: body description: Details of web app if it exists already required: true schema: $ref: '#/definitions/Site' - name: skipDnsRegistration in: query description: "If true web app hostname is not registered with DNS on creation. This parameter is\r\n only used for app creation" type: string - name: skipCustomDomainVerification in: query description: >- If true, custom (non *.azurewebsites.net) domains associated with web app are not verified. type: string - name: forceDnsRegistration in: query description: If true, web app hostname is force registered with DNS type: string - name: ttlInSeconds in: query description: Time to live in seconds for web app's default domain name type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Site' '202': description: Asynchronous operation in progress schema: $ref: '#/definitions/Site' deprecated: false x-ms-long-running-operation: true description: Needs a more full description created. delete: tags: - Sites summary: Microsoft Azure Deletes A Web App operationId: microsoftAzureSitesDeletesite consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: deleteMetrics in: query description: If true, web app metrics are also deleted type: string - name: deleteEmptyServerFarm in: query description: >- If true and App Service Plan is empty after web app deletion, App Service Plan is also deleted type: string - name: skipDnsRegistration in: query description: If true, DNS registration is skipped type: string - name: deleteAllSlots in: query description: If true, all slots associated with web app are also deleted type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}: get: tags: - Sites summary: Microsoft Azure Get Details Of A Web App operationId: microsoftAzureSitesGetsiteslot consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - name: propertiesToInclude in: query description: Additional web app properties included in the response type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Site' deprecated: false description: Needs a more full description created. put: tags: - Sites summary: 'Microsoft Azure Creates A New Web App Or Modifies An Existing Web App' operationId: microsoftAzureSitesCreateorupdatesiteslot consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of the resource group required: true type: string - name: name in: path description: Name of the web app required: true type: string - name: siteEnvelope in: body description: Details of web app if it exists already required: true schema: $ref: '#/definitions/Site' - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - name: skipDnsRegistration in: query description: "If true web app hostname is not registered with DNS on creation. This parameter is\r\n only used for app creation" type: string - name: skipCustomDomainVerification in: query description: >- If true, custom (non *.azurewebsites.net) domains associated with web app are not verified. type: string - name: forceDnsRegistration in: query description: If true, web app hostname is force registered with DNS type: string - name: ttlInSeconds in: query description: Time to live in seconds for web app's default domain name type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Site' '202': description: Asynchronous operation in progress schema: $ref: '#/definitions/Site' deprecated: false x-ms-long-running-operation: true description: Needs a more full description created. delete: tags: - Sites summary: Microsoft Azure Deletes A Web App operationId: microsoftAzureSitesDeletesiteslot consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - name: deleteMetrics in: query description: If true, web app metrics are also deleted type: string - name: deleteEmptyServerFarm in: query description: >- If true and App Service Plan is empty after web app deletion, App Service Plan is also deleted type: string - name: skipDnsRegistration in: query description: If true, DNS registration is skipped type: string - name: deleteAllSlots in: query description: If true, all slots associated with web app are also deleted type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/iscloneable: post: tags: - Sites summary: 'Microsoft Azure Creates A New Web App Or Modifies An Existing Web App' operationId: microsoftAzureSitesIssitecloneable consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of the resource group required: true type: string - name: name in: path description: Name of the web app required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteCloneability' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/iscloneable : post: tags: - Sites summary: 'Microsoft Azure Creates A New Web App Or Modifies An Existing Web App' operationId: microsoftAzureSitesIssitecloneableslot consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of the resource group required: true type: string - name: name in: path description: Name of the web app required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteCloneability' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/recover: post: tags: - Sites summary: Microsoft Azure Recovers A Deleted Web App operationId: microsoftAzureSitesRecoversite consumes: - application/json - text/json - application/xml - text/xml - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: recoveryEntity in: body description: >- Snapshot data used for web app recovery. Snapshot information can be obtained by calling GetDeletedSites or GetSiteSnapshots API. required: true schema: $ref: '#/definitions/CsmSiteRecoveryEntity' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '202': description: Asynchronous operation in progress schema: $ref: '#/definitions/Site' '404': description: Web app not found deprecated: false x-ms-long-running-operation: true description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/recover : post: tags: - Sites summary: Microsoft Azure Recovers A Deleted Web App operationId: microsoftAzureSitesRecoversiteslot consumes: - application/json - text/json - application/xml - text/xml - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: recoveryEntity in: body description: >- Snapshot data used for web app recovery. Snapshot information can be obtained by calling GetDeletedSites or GetSiteSnapshots API. required: true schema: $ref: '#/definitions/CsmSiteRecoveryEntity' - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '202': description: Asynchronous operation in progress schema: $ref: '#/definitions/Site' '404': description: Web app not found deprecated: false x-ms-long-running-operation: true description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/snapshots: put: tags: - Sites summary: 'Microsoft Azure Returns All Snapshots To The User' operationId: microsoftAzureSitesGetsitesnapshots consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Webspace required: true type: string - name: name in: path description: Website Name required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/snapshots : put: tags: - Sites summary: 'Microsoft Azure Returns All Snapshots To The User' operationId: microsoftAzureSitesGetsitesnapshotsslot consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Webspace required: true type: string - name: name in: path description: Website Name required: true type: string - name: slot in: path description: Website Slot required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/deletedSites: get: tags: - Sites summary: Microsoft Azure Gets Deleted Web Apps In Subscription operationId: microsoftAzureSitesGetdeletedsites consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: propertiesToInclude in: query description: Additional web app properties included in the response type: string - name: includeSiteTypes in: query description: Types of apps included in the response type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/DeletedSiteCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments: get: tags: - Sites summary: Microsoft Azure List Deployments operationId: microsoftAzureSitesGetdeployments consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/DeploymentCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments : get: tags: - Sites summary: Microsoft Azure List Deployments operationId: microsoftAzureSitesGetdeploymentsslot consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/DeploymentCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/deployments : get: tags: - Sites summary: Microsoft Azure List Deployments operationId: microsoftAzureSitesGetinstancedeployments consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: instanceId in: path description: Id of web app instance required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/DeploymentCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/deployments : get: tags: - Sites summary: Microsoft Azure List Deployments operationId: microsoftAzureSitesGetinstancedeploymentsslot consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - name: instanceId in: path description: Id of web app instance required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/DeploymentCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/deployments/{id} : get: tags: - Sites summary: Microsoft Azure Get The Deployment operationId: microsoftAzureSitesGetinstancedeployment consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: id in: path description: Id of the deployment required: true type: string - name: instanceId in: path description: Id of web app instance required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Deployment' deprecated: false description: Needs a more full description created. put: tags: - Sites summary: Microsoft Azure Create A Deployment operationId: microsoftAzureSitesCreateinstancedeployment consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: id in: path description: Id of the deployment required: true type: string - name: instanceId in: path description: Id of web app instance required: true type: string - name: deployment in: body description: Details of deployment required: true schema: $ref: '#/definitions/Deployment' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Deployment' deprecated: false description: Needs a more full description created. delete: tags: - Sites summary: Microsoft Azure Delete The Deployment operationId: microsoftAzureSitesDeleteinstancedeployment consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: id in: path description: Id of the deployment required: true type: string - name: instanceId in: path description: Id of web app instance required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}: get: tags: - Sites summary: Microsoft Azure Get The Deployment operationId: microsoftAzureSitesGetdeployment consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: id in: path description: Id of the deployment required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Deployment' deprecated: false description: Needs a more full description created. put: tags: - Sites summary: Microsoft Azure Create A Deployment operationId: microsoftAzureSitesCreatedeployment consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: id in: path description: Id of the deployment required: true type: string - name: deployment in: body description: Details of deployment required: true schema: $ref: '#/definitions/Deployment' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Deployment' deprecated: false description: Needs a more full description created. delete: tags: - Sites summary: Microsoft Azure Delete The Deployment operationId: microsoftAzureSitesDeletedeployment consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: id in: path description: Id of the deployment required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id} : get: tags: - Sites summary: Microsoft Azure Get The Deployment operationId: microsoftAzureSitesGetdeploymentslot consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: id in: path description: Id of the deployment required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Deployment' deprecated: false description: Needs a more full description created. put: tags: - Sites summary: Microsoft Azure Create A Deployment operationId: microsoftAzureSitesCreatedeploymentslot consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: id in: path description: Id of the deployment required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - name: deployment in: body description: Details of deployment required: true schema: $ref: '#/definitions/Deployment' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Deployment' deprecated: false description: Needs a more full description created. delete: tags: - Sites summary: Microsoft Azure Delete The Deployment operationId: microsoftAzureSitesDeletedeploymentslot consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: id in: path description: Id of the deployment required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/deployments/{id} : get: tags: - Sites summary: Microsoft Azure Get The Deployment operationId: microsoftAzureSitesGetinstancedeploymentslot consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: id in: path description: Id of the deployment required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - name: instanceId in: path description: Id of web app instance required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Deployment' deprecated: false description: Needs a more full description created. put: tags: - Sites summary: Microsoft Azure Create A Deployment operationId: microsoftAzureSitesCreateinstancedeploymentslot consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: id in: path description: Id of the deployment required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - name: instanceId in: path description: Id of web app instance required: true type: string - name: deployment in: body description: Details of deployment required: true schema: $ref: '#/definitions/Deployment' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Deployment' deprecated: false description: Needs a more full description created. delete: tags: - Sites summary: Microsoft Azure Delete The Deployment operationId: microsoftAzureSitesDeleteinstancedeploymentslot consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: id in: path description: Id of the deployment required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - name: instanceId in: path description: Id of web app instance required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances: get: tags: - Sites summary: Microsoft Azure Gets All Instance Of A Web App operationId: microsoftAzureSitesGetsiteinstanceidentifiers consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteInstanceCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances : get: tags: - Sites summary: Microsoft Azure Gets All Instance Of A Web App operationId: microsoftAzureSitesGetsiteinstanceidentifiersslot consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteInstanceCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings: get: tags: - Sites summary: Microsoft Azure Get Web App Hostname Bindings operationId: microsoftAzureSitesGetsitehostnamebindings consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/HostNameBindingCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings : get: tags: - Sites summary: Microsoft Azure Get Web App Hostname Bindings operationId: microsoftAzureSitesGetsitehostnamebindingsslot consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/HostNameBindingCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings/{hostName} : get: tags: - Sites summary: Microsoft Azure Get Web App Binding For A Hostname operationId: microsoftAzureSitesGetsitehostnamebinding consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: hostName in: path description: Name of host required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/HostNameBinding' deprecated: false description: Needs a more full description created. put: tags: - Sites summary: Microsoft Azure Creates A Web App Hostname Binding operationId: microsoftAzureSitesCreateorupdatesitehostnamebinding consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: hostName in: path description: Name of host required: true type: string - name: hostNameBinding in: body description: Host name binding information required: true schema: $ref: '#/definitions/HostNameBinding' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/HostNameBinding' deprecated: false description: Needs a more full description created. delete: tags: - Sites summary: Microsoft Azure Deletes A Host Name Binding operationId: microsoftAzureSitesDeletesitehostnamebinding consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: hostName in: path description: Name of host required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings/{hostName} : get: tags: - Sites summary: Microsoft Azure Get Web App Binding For A Hostname operationId: microsoftAzureSitesGetsitehostnamebindingslot consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - name: hostName in: path description: Name of host required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/HostNameBinding' deprecated: false description: Needs a more full description created. put: tags: - Sites summary: Microsoft Azure Creates A Web App Hostname Binding operationId: microsoftAzureSitesCreateorupdatesitehostnamebindingslot consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: hostName in: path description: Name of host required: true type: string - name: hostNameBinding in: body description: Host name binding information required: true schema: $ref: '#/definitions/HostNameBinding' - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/HostNameBinding' deprecated: false description: Needs a more full description created. delete: tags: - Sites summary: Microsoft Azure Deletes A Host Name Binding operationId: microsoftAzureSitesDeletesitehostnamebindingslot consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - name: hostName in: path description: Name of host required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web: get: tags: - Sites summary: Microsoft Azure Gets The Configuration Of The Web App operationId: microsoftAzureSitesGetsiteconfig consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteConfig' deprecated: false description: Needs a more full description created. put: tags: - Sites summary: Microsoft Azure Update The Configuration Of Web App operationId: microsoftAzureSitesCreateorupdatesiteconfig consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: siteConfig in: body description: Request body that contains the configuration setting for the web app required: true schema: $ref: '#/definitions/SiteConfig' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteConfig' deprecated: false description: Needs a more full description created. patch: tags: - Sites summary: Microsoft Azure Update The Configuration Of Web App operationId: microsoftAzureSitesUpdatesiteconfig consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: siteConfig in: body description: Request body that contains the configuration setting for the web app required: true schema: $ref: '#/definitions/SiteConfig' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteConfig' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web : get: tags: - Sites summary: Microsoft Azure Gets The Configuration Of The Web App operationId: microsoftAzureSitesGetsiteconfigslot consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteConfig' deprecated: false description: Needs a more full description created. put: tags: - Sites summary: Microsoft Azure Update The Configuration Of Web App operationId: microsoftAzureSitesCreateorupdatesiteconfigslot consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: siteConfig in: body description: Request body that contains the configuration setting for the web app required: true schema: $ref: '#/definitions/SiteConfig' - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteConfig' deprecated: false description: Needs a more full description created. patch: tags: - Sites summary: Microsoft Azure Update The Configuration Of Web App operationId: microsoftAzureSitesUpdatesiteconfigslot consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: siteConfig in: body description: Request body that contains the configuration setting for the web app required: true schema: $ref: '#/definitions/SiteConfig' - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteConfig' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web: get: tags: - Sites summary: Microsoft Azure Get The Source Control Configuration Of Web App operationId: microsoftAzureSitesGetsitesourcecontrol consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteSourceControl' deprecated: false description: Needs a more full description created. put: tags: - Sites summary: Microsoft Azure Update The Source Control Configuration Of Web App operationId: microsoftAzureSitesCreateorupdatesitesourcecontrol consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: siteSourceControl in: body description: Request body that contains the source control parameters required: true schema: $ref: '#/definitions/SiteSourceControl' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteSourceControl' '201': description: Created schema: $ref: '#/definitions/SiteSourceControl' deprecated: false description: Needs a more full description created. delete: tags: - Sites summary: Microsoft Azure Delete Source Control Configuration Of Web App operationId: microsoftAzureSitesDeletesitesourcecontrol consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. patch: tags: - Sites summary: Microsoft Azure Update The Source Control Configuration Of Web App operationId: microsoftAzureSitesUpdatesitesourcecontrol consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: siteSourceControl in: body description: Request body that contains the source control parameters required: true schema: $ref: '#/definitions/SiteSourceControl' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteSourceControl' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web : get: tags: - Sites summary: Microsoft Azure Get The Source Control Configuration Of Web App operationId: microsoftAzureSitesGetsitesourcecontrolslot consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteSourceControl' deprecated: false description: Needs a more full description created. put: tags: - Sites summary: Microsoft Azure Update The Source Control Configuration Of Web App operationId: microsoftAzureSitesCreateorupdatesitesourcecontrolslot consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: siteSourceControl in: body description: Request body that contains the source control parameters required: true schema: $ref: '#/definitions/SiteSourceControl' - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteSourceControl' '201': description: Created schema: $ref: '#/definitions/SiteSourceControl' deprecated: false description: Needs a more full description created. delete: tags: - Sites summary: Microsoft Azure Delete Source Control Configuration Of Web App operationId: microsoftAzureSitesDeletesitesourcecontrolslot consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. patch: tags: - Sites summary: Microsoft Azure Update The Source Control Configuration Of Web App operationId: microsoftAzureSitesUpdatesitesourcecontrolslot consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: siteSourceControl in: body description: Request body that contains the source control parameters required: true schema: $ref: '#/definitions/SiteSourceControl' - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteSourceControl' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings/list : post: tags: - Sites summary: Microsoft Azure Gets The Application Settings Of Web App operationId: microsoftAzureSitesListsiteappsettingsslot consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/StringDictionary' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/appsettings/list : post: tags: - Sites summary: Microsoft Azure Gets The Application Settings Of Web App operationId: microsoftAzureSitesListsiteappsettings consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/StringDictionary' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/appsettings: put: tags: - Sites summary: Microsoft Azure Updates The Application Settings Of Web App operationId: microsoftAzureSitesUpdatesiteappsettings consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: appSettings in: body description: Application settings of web app required: true schema: $ref: '#/definitions/StringDictionary' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/StringDictionary' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings : put: tags: - Sites summary: Microsoft Azure Updates The Application Settings Of Web App operationId: microsoftAzureSitesUpdatesiteappsettingsslot consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: appSettings in: body description: Application settings of web app required: true schema: $ref: '#/definitions/StringDictionary' - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/StringDictionary' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/connectionstrings/list : post: tags: - Sites summary: Microsoft Azure Gets The Connection Strings Associated With Web App operationId: microsoftAzureSitesListsiteconnectionstrings consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ConnectionStringDictionary' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings/list : post: tags: - Sites summary: Microsoft Azure Gets The Connection Strings Associated With Web App operationId: microsoftAzureSitesListsiteconnectionstringsslot consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ConnectionStringDictionary' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/connectionstrings : put: tags: - Sites summary: Microsoft Azure Updates The Connection Strings Associated With Web App operationId: microsoftAzureSitesUpdatesiteconnectionstrings consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: connectionStrings in: body description: Connection strings associated with web app required: true schema: $ref: '#/definitions/ConnectionStringDictionary' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ConnectionStringDictionary' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings : put: tags: - Sites summary: Microsoft Azure Updates The Connection Strings Associated With Web App operationId: microsoftAzureSitesUpdatesiteconnectionstringsslot consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: connectionStrings in: body description: Connection strings associated with web app required: true schema: $ref: '#/definitions/ConnectionStringDictionary' - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ConnectionStringDictionary' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings/list : post: tags: - Sites summary: Microsoft Azure Gets The Authentication Authorization Settings Associated With Web App operationId: microsoftAzureSitesListsiteauthsettings consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteAuthSettings' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings/list : post: tags: - Sites summary: Microsoft Azure Gets The Authentication Authorization Settings Associated With Web App operationId: microsoftAzureSitesListsiteauthsettingsslot consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteAuthSettings' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings : put: tags: - Sites summary: >- Microsoft Azure Updates The Authentication Authorization Settings Associated With Web App operationId: microsoftAzureSitesUpdatesiteauthsettings consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: siteAuthSettings in: body description: Auth settings associated with web app required: true schema: $ref: '#/definitions/SiteAuthSettings' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteAuthSettings' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings : put: tags: - Sites summary: >- Microsoft Azure Updates The Authentication Authorization Settings Associated With Web App operationId: microsoftAzureSitesUpdatesiteauthsettingsslot consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: siteAuthSettings in: body description: Auth settings associated with web app required: true schema: $ref: '#/definitions/SiteAuthSettings' - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteAuthSettings' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/publishingcredentials/list : post: tags: - Sites summary: Microsoft Azure Gets The Web App Publishing Credentials operationId: microsoftAzureSitesListsitepublishingcredentials consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/User' deprecated: false x-ms-long-running-operation: true description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/publishingcredentials/list : post: tags: - Sites summary: Microsoft Azure Gets The Web App Publishing Credentials operationId: microsoftAzureSitesListsitepublishingcredentialsslot consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/User' deprecated: false x-ms-long-running-operation: true description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/metadata/list : post: tags: - Sites summary: 'Microsoft Azure Gets The Web App Meta Data' operationId: microsoftAzureSitesListsitemetadata consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/StringDictionary' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata/list : post: tags: - Sites summary: 'Microsoft Azure Gets The Web App Meta Data' operationId: microsoftAzureSitesListsitemetadataslot consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/StringDictionary' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/metadata: put: tags: - Sites summary: Microsoft Azure Updates The Meta Data For Web App operationId: microsoftAzureSitesUpdatesitemetadata consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: metadata in: body description: Meta data of web app required: true schema: $ref: '#/definitions/StringDictionary' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/StringDictionary' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata : put: tags: - Sites summary: Microsoft Azure Updates The Meta Data For Web App operationId: microsoftAzureSitesUpdatesitemetadataslot consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: metadata in: body description: Meta data of web app required: true schema: $ref: '#/definitions/StringDictionary' - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/StringDictionary' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/logs: get: tags: - Sites summary: Microsoft Azure Gets The Web App Logs Configuration operationId: microsoftAzureSitesGetsitelogsconfig consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteLogsConfig' deprecated: false description: Needs a more full description created. put: tags: - Sites summary: Microsoft Azure Updates The Meta Data For Web App operationId: microsoftAzureSitesUpdatesitelogsconfig consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: siteLogsConfig in: body description: Site logs configuration required: true schema: $ref: '#/definitions/SiteLogsConfig' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteLogsConfig' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/logs : get: tags: - Sites summary: Microsoft Azure Gets The Web App Logs Configuration operationId: microsoftAzureSitesGetsitelogsconfigslot consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteLogsConfig' deprecated: false description: Needs a more full description created. put: tags: - Sites summary: Microsoft Azure Updates The Meta Data For Web App operationId: microsoftAzureSitesUpdatesitelogsconfigslot consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: siteLogsConfig in: body description: Site logs configuration required: true schema: $ref: '#/definitions/SiteLogsConfig' - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteLogsConfig' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons: get: tags: - Sites operationId: microsoftAzureSitesListsitepremieraddons consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path required: true type: string - name: name in: path required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Web Sites Name Premieraddons description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons : get: tags: - Sites operationId: microsoftAzureSitesListsitepremieraddonsslot consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path required: true type: string - name: name in: path required: true type: string - name: slot in: path required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Web Sites Name Slots Slot Premieraddons description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons/{premierAddOnName} : get: tags: - Sites operationId: microsoftAzureSitesGetsitepremieraddon consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path required: true type: string - name: name in: path required: true type: string - name: premierAddOnName in: path required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Web Sites Name Premieraddons Premieraddonname description: Needs a more full description created. put: tags: - Sites operationId: microsoftAzureSitesAddsitepremieraddon consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path required: true type: string - name: name in: path required: true type: string - name: premierAddOnName in: path required: true type: string - name: premierAddOn in: body required: true schema: $ref: '#/definitions/PremierAddOnRequest' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false summary: >- Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Web Sites Name Premieraddons Premieraddonname description: Needs a more full description created. delete: tags: - Sites operationId: microsoftAzureSitesDeletesitepremieraddon consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path required: true type: string - name: name in: path required: true type: string - name: premierAddOnName in: path required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Web Sites Name Premieraddons Premieraddonname description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons/{premierAddOnName} : get: tags: - Sites operationId: microsoftAzureSitesGetsitepremieraddonslot consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path required: true type: string - name: name in: path required: true type: string - name: premierAddOnName in: path required: true type: string - name: slot in: path required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Web Sites Name Slots Slot Premieraddons Premieraddonname description: Needs a more full description created. put: tags: - Sites operationId: microsoftAzureSitesAddsitepremieraddonslot consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path required: true type: string - name: name in: path required: true type: string - name: premierAddOnName in: path required: true type: string - name: premierAddOn in: body required: true schema: $ref: '#/definitions/PremierAddOnRequest' - name: slot in: path required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false summary: >- Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Web Sites Name Slots Slot Premieraddons Premieraddonname description: Needs a more full description created. delete: tags: - Sites operationId: microsoftAzureSitesDeletesitepremieraddonslot consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path required: true type: string - name: name in: path required: true type: string - name: premierAddOnName in: path required: true type: string - name: slot in: path required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Web Sites Name Slots Slot Premieraddons Premieraddonname description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup/list: post: tags: - Sites summary: Microsoft Azure Gets The Backup Configuration For A Web App operationId: microsoftAzureSitesGetsitebackupconfiguration consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/BackupRequest' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup/list : post: tags: - Sites summary: Microsoft Azure Gets The Backup Configuration For A Web App operationId: microsoftAzureSitesGetsitebackupconfigurationslot consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/BackupRequest' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup: put: tags: - Sites summary: Microsoft Azure Updates Backup Configuration Of Web App operationId: microsoftAzureSitesUpdatesitebackupconfiguration consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: request in: body description: Information on backup request required: true schema: $ref: '#/definitions/BackupRequest' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/BackupRequest' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup : put: tags: - Sites summary: Microsoft Azure Updates Backup Configuration Of Web App operationId: microsoftAzureSitesUpdatesitebackupconfigurationslot consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: request in: body description: Information on backup request required: true schema: $ref: '#/definitions/BackupRequest' - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/BackupRequest' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backup: post: tags: - Sites summary: Microsoft Azure Creates Web App Backup operationId: microsoftAzureSitesBackupsite consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: request in: body description: Information on backup request required: true schema: $ref: '#/definitions/BackupRequest' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/BackupItem' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backup : post: tags: - Sites summary: Microsoft Azure Creates Web App Backup operationId: microsoftAzureSitesBackupsiteslot consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: request in: body description: Information on backup request required: true schema: $ref: '#/definitions/BackupRequest' - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/BackupItem' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/discover: put: tags: - Sites summary: Microsoft Azure Discovers Existing Web App Backups That Can Be Restored operationId: microsoftAzureSitesDiscoversiterestore consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: request in: body description: Information on restore request required: true schema: $ref: '#/definitions/RestoreRequest' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/RestoreRequest' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/discover : put: tags: - Sites summary: Microsoft Azure Discovers Existing Web App Backups That Can Be Restored operationId: microsoftAzureSitesDiscoversiterestoreslot consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: request in: body description: Information on restore request required: true schema: $ref: '#/definitions/RestoreRequest' - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/RestoreRequest' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups: get: tags: - Sites summary: Microsoft Azure Lists All Available Backups For Web App operationId: microsoftAzureSitesListsitebackups consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/BackupItemCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups : get: tags: - Sites summary: Microsoft Azure Lists All Available Backups For Web App operationId: microsoftAzureSitesListsitebackupsslot consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/BackupItemCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}: get: tags: - Sites summary: 'Microsoft Azure Gets Status Of A Web App Backup That May Be In Progress' operationId: microsoftAzureSitesGetsitebackupstatus consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: backupId in: path description: Id of backup required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/BackupItem' deprecated: false description: Needs a more full description created. delete: tags: - Sites summary: Microsoft Azure Deletes A Backup From Azure Storage operationId: microsoftAzureSitesDeletebackup consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: backupId in: path description: Id of backup required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/BackupItem' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId} : get: tags: - Sites summary: 'Microsoft Azure Gets Status Of A Web App Backup That May Be In Progress' operationId: microsoftAzureSitesGetsitebackupstatusslot consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: backupId in: path description: Id of backup required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/BackupItem' deprecated: false description: Needs a more full description created. delete: tags: - Sites summary: Microsoft Azure Deletes A Backup From Azure Storage operationId: microsoftAzureSitesDeletebackupslot consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: backupId in: path description: Id of backup required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/BackupItem' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/list : post: tags: - Sites summary: >- Microsoft Azure Gets Status Of A Web App Backup That May Be In Progress, Including Secrets Associated With The Backup, Such As The Azure Storage Sas Url Also Can Be Used To Update The Sas Url For The Backup If A New Url Is Passed In The Request Body operationId: microsoftAzureSitesGetsitebackupstatussecretsslot consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: backupId in: path description: Id of backup required: true type: string - name: request in: body description: Information on backup request required: true schema: $ref: '#/definitions/BackupRequest' - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/BackupItem' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}/list : post: tags: - Sites summary: >- Microsoft Azure Gets Status Of A Web App Backup That May Be In Progress, Including Secrets Associated With The Backup, Such As The Azure Storage Sas Url Also Can Be Used To Update The Sas Url For The Backup If A New Url Is Passed In The Request Body operationId: microsoftAzureSitesGetsitebackupstatussecrets consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: backupId in: path description: Id of backup required: true type: string - name: request in: body description: Information on backup request required: true schema: $ref: '#/definitions/BackupRequest' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/BackupItem' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}/restore : post: tags: - Sites summary: Microsoft Azure Restores A Web App operationId: microsoftAzureSitesRestoresite consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: backupId in: path description: Id of backup to restore required: true type: string - name: request in: body description: Information on restore request required: true schema: $ref: '#/definitions/RestoreRequest' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/RestoreResponse' deprecated: false x-ms-long-running-operation: true description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/restore : post: tags: - Sites summary: Microsoft Azure Restores A Web App operationId: microsoftAzureSitesRestoresiteslot consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: backupId in: path description: Id of backup to restore required: true type: string - name: request in: body description: Information on restore request required: true schema: $ref: '#/definitions/RestoreRequest' - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/RestoreResponse' deprecated: false x-ms-long-running-operation: true description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/usages: get: tags: - Sites summary: Microsoft Azure Gets The Quota Usage Numbers For Web App operationId: microsoftAzureSitesGetsiteusages consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: $filter in: query description: >- Return only usages specified in the filter. Filter is specified by using OData syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'. type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/CsmUsageQuotaCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/usages : get: tags: - Sites summary: Microsoft Azure Gets The Quota Usage Numbers For Web App operationId: microsoftAzureSitesGetsiteusagesslot consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - name: $filter in: query description: >- Return only usages specified in the filter. Filter is specified by using OData syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'. type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/CsmUsageQuotaCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/metrics: get: tags: - Sites summary: Microsoft Azure Gets Metrics For Web App operationId: microsoftAzureSitesGetsitemetrics consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: details in: query description: If true, metric details are included in response type: boolean - name: $filter in: query description: >- Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'. type: string x-ms-skip-url-encoding: true - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ResourceMetricCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/metrics : get: tags: - Sites summary: Microsoft Azure Gets Metrics For Web App operationId: microsoftAzureSitesGetsitemetricsslot consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - name: details in: query description: If true, metric details are included in response type: boolean - name: $filter in: query description: >- Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'. type: string x-ms-skip-url-encoding: true - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ResourceMetricCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/metricdefinitions : get: tags: - Sites summary: Microsoft Azure Gets Metric Definitions For Web App operationId: microsoftAzureSitesGetsitemetricdefinitionsslot consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/MetricDefinitionCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/metricdefinitions: get: tags: - Sites summary: Microsoft Azure Gets Metric Definitions For Web App operationId: microsoftAzureSitesGetsitemetricdefinitions consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/MetricDefinitionCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publishxml: post: tags: - Sites summary: Microsoft Azure Gets The Publishing Profile For Web App operationId: microsoftAzureSitesListsitepublishingprofilexml consumes: - application/json - text/json - application/xml - text/xml - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: options in: body description: >- Specifies options for publishing profile. Pass CsmPublishingProfileOptions.Format=FileZilla3 for FileZilla FTP format. required: true schema: $ref: '#/definitions/CsmPublishingProfileOptions' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: type: file deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publishxml : post: tags: - Sites summary: Microsoft Azure Gets The Publishing Profile For Web App operationId: microsoftAzureSitesListsitepublishingprofilexmlslot consumes: - application/json - text/json - application/xml - text/xml - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: options in: body description: >- Specifies options for publishing profile. Pass CsmPublishingProfileOptions.Format=FileZilla3 for FileZilla FTP format. required: true schema: $ref: '#/definitions/CsmPublishingProfileOptions' - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: type: file deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restart : post: tags: - Sites summary: Microsoft Azure Restarts Web App operationId: microsoftAzureSitesRestartsiteslot consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - name: softRestart in: query description: >- Soft restart applies the configuration settings and restarts the app if necessary. Hard restart always restarts and reprovisions the app type: boolean - name: synchronous in: query description: If true then the API will block until the app has been restarted type: boolean - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restart: post: tags: - Sites summary: Microsoft Azure Restarts Web App operationId: microsoftAzureSitesRestartsite consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: softRestart in: query description: >- Soft restart applies the configuration settings and restarts the app if necessary. Hard restart always restarts and reprovisions the app type: boolean - name: synchronous in: query description: If true then the API will block until the app has been restarted type: boolean - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/start: post: tags: - Sites summary: Microsoft Azure Starts Web App operationId: microsoftAzureSitesStartsite consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/start: post: tags: - Sites summary: Microsoft Azure Starts Web App operationId: microsoftAzureSitesStartsiteslot consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/stop: post: tags: - Sites summary: Microsoft Azure Stops Web App operationId: microsoftAzureSitesStopsite consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/stop: post: tags: - Sites summary: Microsoft Azure Stops Web App operationId: microsoftAzureSitesStopsiteslot consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sync: post: tags: - Sites operationId: microsoftAzureSitesSyncsiterepository consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path required: true type: string - name: name in: path required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Web Sites Name Sync description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sync: post: tags: - Sites operationId: microsoftAzureSitesSyncsiterepositoryslot consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path required: true type: string - name: name in: path required: true type: string - name: slot in: path required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Web Sites Name Slots Slot Sync description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/newpassword : post: tags: - Sites summary: Microsoft Azure Generates New Random App Publishing Password operationId: microsoftAzureSitesGeneratenewsitepublishingpasswordslot consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/newpassword: post: tags: - Sites summary: Microsoft Azure Generates New Random App Publishing Password operationId: microsoftAzureSitesGeneratenewsitepublishingpassword consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of web app required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName} : get: tags: - Sites summary: 'Microsoft Azure Retrieves A Biztalk Hybrid Connection Identified By Its Entity Name' operationId: microsoftAzureSitesGetsiterelayserviceconnection consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: The resource group name required: true type: string - name: name in: path description: The name of the web app required: true type: string - name: entityName in: path description: The name by which the Hybrid Connection is identified required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/RelayServiceConnectionEntity' deprecated: false description: Needs a more full description created. put: tags: - Sites summary: >- Microsoft Azure Creates A New Association To A Biztalk Hybrid Connection, Or Updates An Existing One operationId: microsoftAzureSitesCreateorupdatesiterelayserviceconnection consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: The resource group name required: true type: string - name: name in: path description: The name of the web app required: true type: string - name: entityName in: path description: The name by which the Hybrid Connection is identified required: true type: string - name: connectionEnvelope in: body description: The details of the Hybrid Connection required: true schema: $ref: '#/definitions/RelayServiceConnectionEntity' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/RelayServiceConnectionEntity' deprecated: false description: Needs a more full description created. delete: tags: - Sites summary: >- Microsoft Azure Removes The Association To A Biztalk Hybrid Connection, Identified By Its Entity Name operationId: microsoftAzureSitesDeletesiterelayserviceconnection consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: The resource group name required: true type: string - name: name in: path description: The name of the web app required: true type: string - name: entityName in: path description: The name by which the Hybrid Connection is identified required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. patch: tags: - Sites summary: >- Microsoft Azure Creates A New Association To A Biztalk Hybrid Connection, Or Updates An Existing One operationId: microsoftAzureSitesUpdatesiterelayserviceconnection consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: The resource group name required: true type: string - name: name in: path description: The name of the web app required: true type: string - name: entityName in: path description: The name by which the Hybrid Connection is identified required: true type: string - name: connectionEnvelope in: body description: The details of the Hybrid Connection required: true schema: $ref: '#/definitions/RelayServiceConnectionEntity' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/RelayServiceConnectionEntity' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName} : get: tags: - Sites summary: 'Microsoft Azure Retrieves A Biztalk Hybrid Connection Identified By Its Entity Name' operationId: microsoftAzureSitesGetsiterelayserviceconnectionslot consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: The resource group name required: true type: string - name: name in: path description: The name of the web app required: true type: string - name: entityName in: path description: The name by which the Hybrid Connection is identified required: true type: string - name: slot in: path description: The name of the slot for the web app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/RelayServiceConnectionEntity' deprecated: false description: Needs a more full description created. put: tags: - Sites summary: >- Microsoft Azure Creates A New Association To A Biztalk Hybrid Connection, Or Updates An Existing One operationId: microsoftAzureSitesCreateorupdatesiterelayserviceconnectionslot consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: The resource group name required: true type: string - name: name in: path description: The name of the web app required: true type: string - name: entityName in: path description: The name by which the Hybrid Connection is identified required: true type: string - name: connectionEnvelope in: body description: The details of the Hybrid Connection required: true schema: $ref: '#/definitions/RelayServiceConnectionEntity' - name: slot in: path description: The name of the slot for the web app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/RelayServiceConnectionEntity' deprecated: false description: Needs a more full description created. delete: tags: - Sites summary: >- Microsoft Azure Removes The Association To A Biztalk Hybrid Connection, Identified By Its Entity Name operationId: microsoftAzureSitesDeletesiterelayserviceconnectionslot consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: The resource group name required: true type: string - name: name in: path description: The name of the web app required: true type: string - name: entityName in: path description: The name by which the Hybrid Connection is identified required: true type: string - name: slot in: path description: The name of the slot for the web app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. patch: tags: - Sites summary: >- Microsoft Azure Creates A New Association To A Biztalk Hybrid Connection, Or Updates An Existing One operationId: microsoftAzureSitesUpdatesiterelayserviceconnectionslot consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: The resource group name required: true type: string - name: name in: path description: The name of the web app required: true type: string - name: entityName in: path description: The name by which the Hybrid Connection is identified required: true type: string - name: connectionEnvelope in: body description: The details of the Hybrid Connection required: true schema: $ref: '#/definitions/RelayServiceConnectionEntity' - name: slot in: path description: The name of the slot for the web app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/RelayServiceConnectionEntity' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection : get: tags: - Sites summary: 'Microsoft Azure Retrieves All Biztalk Hybrid Connections Associated With This Web App' operationId: microsoftAzureSitesListsiterelayserviceconnectionsslot consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: The resource group name required: true type: string - name: name in: path description: The name of the web app required: true type: string - name: slot in: path description: The name of the slot for the web app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/RelayServiceConnectionEntity' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection: get: tags: - Sites summary: 'Microsoft Azure Retrieves All Biztalk Hybrid Connections Associated With This Web App' operationId: microsoftAzureSitesListsiterelayserviceconnections consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: The resource group name required: true type: string - name: name in: path description: The name of the web app required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/RelayServiceConnectionEntity' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName} : get: tags: - Sites summary: >- Microsoft Azure Retrieves A Virtual Network Connection Gateway Associated With This Web App And Virtual Network operationId: microsoftAzureSitesGetsitevnetgatewayslot consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: The resource group name required: true type: string - name: name in: path description: The name of the web app required: true type: string - name: vnetName in: path description: The name of the Virtual Network required: true type: string - name: gatewayName in: path description: >- The name of the gateway. The only gateway that exists presently is "primary" required: true type: string - name: slot in: path description: The name of the slot for this web app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' '404': description: Gateway does not exist. Only the "primary" gateway exists presently. deprecated: false description: Needs a more full description created. put: tags: - Sites summary: 'Microsoft Azure Updates The Virtual Network Gateway' operationId: microsoftAzureSitesCreateorupdatesitevnetconnectiongatewayslot consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: The resource group name required: true type: string - name: name in: path description: The name of the web app required: true type: string - name: vnetName in: path description: The name of the Virtual Network required: true type: string - name: gatewayName in: path description: >- The name of the gateway. The only gateway that exists presently is "primary" required: true type: string - name: connectionEnvelope in: body description: The properties to update this gateway with. required: true schema: $ref: '#/definitions/VnetGateway' - name: slot in: path description: The name of the slot for this web app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/VnetGateway' deprecated: false description: Needs a more full description created. patch: tags: - Sites summary: 'Microsoft Azure Updates The Virtual Network Gateway' operationId: microsoftAzureSitesUpdatesitevnetconnectiongatewayslot consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: The resource group name required: true type: string - name: name in: path description: The name of the web app required: true type: string - name: vnetName in: path description: The name of the Virtual Network required: true type: string - name: gatewayName in: path description: >- The name of the gateway. The only gateway that exists presently is "primary" required: true type: string - name: connectionEnvelope in: body description: The properties to update this gateway with. required: true schema: $ref: '#/definitions/VnetGateway' - name: slot in: path description: The name of the slot for this web app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/VnetGateway' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName} : get: tags: - Sites summary: >- Microsoft Azure Retrieves A Virtual Network Connection Gateway Associated With This Web App And Virtual Network operationId: microsoftAzureSitesGetsitevnetgateway consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: The resource group name required: true type: string - name: name in: path description: The name of the web app required: true type: string - name: vnetName in: path description: The name of the Virtual Network required: true type: string - name: gatewayName in: path description: >- The name of the gateway. The only gateway that exists presently is "primary" required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' '404': description: Gateway does not exist. Only the "primary" gateway exists presently. deprecated: false description: Needs a more full description created. put: tags: - Sites summary: 'Microsoft Azure Updates The Virtual Network Gateway' operationId: microsoftAzureSitesCreateorupdatesitevnetconnectiongateway consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: The resource group name required: true type: string - name: name in: path description: The name of the web app required: true type: string - name: vnetName in: path description: The name of the Virtual Network required: true type: string - name: gatewayName in: path description: >- The name of the gateway. The only gateway that exists presently is "primary" required: true type: string - name: connectionEnvelope in: body description: The properties to update this gateway with. required: true schema: $ref: '#/definitions/VnetGateway' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/VnetGateway' deprecated: false description: Needs a more full description created. patch: tags: - Sites summary: 'Microsoft Azure Updates The Virtual Network Gateway' operationId: microsoftAzureSitesUpdatesitevnetconnectiongateway consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: The resource group name required: true type: string - name: name in: path description: The name of the web app required: true type: string - name: vnetName in: path description: The name of the Virtual Network required: true type: string - name: gatewayName in: path description: >- The name of the gateway. The only gateway that exists presently is "primary" required: true type: string - name: connectionEnvelope in: body description: The properties to update this gateway with. required: true schema: $ref: '#/definitions/VnetGateway' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/VnetGateway' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections : get: tags: - Sites summary: >- Microsoft Azure Retrieves A List Of All Virtual Network Connections Associated With This Web App operationId: microsoftAzureSitesGetsitevnetconnections consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: The resource group name required: true type: string - name: name in: path description: The name of the web app required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: type: array items: $ref: '#/definitions/VnetInfo' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections : get: tags: - Sites summary: >- Microsoft Azure Retrieves A List Of All Virtual Network Connections Associated With This Web App operationId: microsoftAzureSitesGetsitevnetconnectionsslot consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: The resource group name required: true type: string - name: name in: path description: The name of the web app required: true type: string - name: slot in: path description: The name of the slot for this web app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: type: array items: $ref: '#/definitions/VnetInfo' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/topLevelDomains: get: tags: - TopLevelDomains summary: Microsoft Azure Lists All Top Level Domains Supported For Registration operationId: microsoftAzureTopleveldomainsGetgettopleveldomains consumes: [] produces: - application/json - text/json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/TopLevelDomainCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. /subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/topLevelDomains/{name}: get: tags: - TopLevelDomains summary: Microsoft Azure Gets Details Of A Top Level Domain operationId: microsoftAzureTopleveldomainsGettopleveldomain consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: name in: path description: Name of the top level domain required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/TopLevelDomain' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/topLevelDomains/{name}/listAgreements: post: tags: - TopLevelDomains summary: >- Microsoft Azure Lists Legal Agreements That User Needs To Accept Before Purchasing Domain operationId: microsoftAzureTopleveldomainsListtopleveldomainagreements consumes: - application/json - text/json - application/xml - text/xml - application/x-www-form-urlencoded produces: - application/json - text/json parameters: - name: name in: path description: Name of the top level domain required: true type: string - name: agreementOption in: body description: Domain agreement options required: true schema: $ref: '#/definitions/TopLevelDomainAgreementOption' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/TldLegalAgreementCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web.Admin/environments/{environmentName}/usage : get: tags: - Usage summary: Microsoft Azure Returns Usage Records For Specified Subscription And Resource Groups operationId: microsoftAzureUsageGetusage consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: environmentName in: path description: Environment name required: true type: string - name: lastId in: query description: Last marker that was returned from the batch required: true type: string - name: batchSize in: query description: size of the batch to be returned. required: true type: integer format: int32 - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. definitions: ArmPlan: description: The plan object in an ARM, represents a marketplace plan type: object properties: name: description: The name type: string publisher: description: The publisher type: string product: description: The product type: string promotionCode: description: The promotion code type: string version: description: Version of product type: string CertificateOrderCertificate: description: >- Class representing the Key Vault container for certificate purchased through Azure type: object allOf: - $ref: '#/definitions/Resource' properties: properties: properties: keyVaultId: description: Key Vault Csm resource Id type: string keyVaultSecretName: description: Key Vault secret name type: string provisioningState: description: Status of the Key Vault secret enum: - Initialized - WaitingOnCertificateOrder - Succeeded - CertificateOrderFailed - OperationNotPermittedOnKeyVault - AzureServiceUnauthorizedToAccessKeyVault - KeyVaultDoesNotExist - KeyVaultSecretDoesNotExist - UnknownError - Unknown type: string x-ms-enum: name: KeyVaultSecretStatus modelAsString: false x-ms-client-flatten: true SkuDescription: description: Describes a sku for a scalable resource type: object properties: name: description: Name of the resource sku type: string tier: description: Service Tier of the resource sku type: string size: description: Size specifier of the resource sku type: string family: description: Family code of the resource sku type: string capacity: format: int32 description: Current number of instances assigned to the resource type: integer Object: type: object properties: {} CertificateOrder: description: Certificate purchase order type: object allOf: - $ref: '#/definitions/Resource' properties: properties: properties: certificates: description: State of the Key Vault secret type: object additionalProperties: $ref: '#/definitions/CertificateOrderCertificate' distinguishedName: description: Certificate distinguished name type: string domainVerificationToken: description: Domain Verification Token type: string validityInYears: format: int32 description: Duration in years (must be between 1 and 3) type: integer keySize: format: int32 description: Certificate Key Size type: integer productType: description: Certificate product type enum: - StandardDomainValidatedSsl - StandardDomainValidatedWildCardSsl type: string x-ms-enum: name: CertificateProductType modelAsString: false autoRenew: description: Auto renew type: boolean provisioningState: description: Status of certificate order enum: - Succeeded - Failed - Canceled - InProgress - Deleting type: string x-ms-enum: name: ProvisioningState modelAsString: false status: description: Current order status enum: - Pendingissuance - Issued - Revoked - Canceled - Denied - Pendingrevocation - PendingRekey - Unused - Expired - NotSubmitted type: string x-ms-enum: name: CertificateOrderStatus modelAsString: false signedCertificate: $ref: '#/definitions/CertificateDetails' description: Signed certificate csr: description: Last CSR that was created for this order type: string intermediate: $ref: '#/definitions/CertificateDetails' description: Intermediate certificate root: $ref: '#/definitions/CertificateDetails' description: Root certificate serialNumber: description: Current serial number of the certificate type: string lastCertificateIssuanceTime: format: date-time description: Certificate last issuance time type: string expirationTime: format: date-time description: Certificate expiration time type: string x-ms-client-flatten: true CertificateDetails: description: Certificate Details type: object allOf: - $ref: '#/definitions/Resource' properties: properties: properties: version: format: int32 description: Version type: integer serialNumber: description: Serial Number type: string thumbprint: description: Thumbprint type: string subject: description: Subject type: string notBefore: format: date-time description: Valid from type: string notAfter: format: date-time description: Valid to type: string signatureAlgorithm: description: Signature Algorithm type: string issuer: description: Issuer type: string rawData: description: Raw certificate data type: string x-ms-client-flatten: true CertificateOrderCollection: description: Collection of certificate orders type: object properties: value: description: Collection of resources type: array items: $ref: '#/definitions/CertificateOrder' nextLink: description: Link to next page of resources type: string CertificateOrderCertificateCollection: description: Collection of certificate order certificates type: object properties: value: description: Collection of resources type: array items: $ref: '#/definitions/CertificateOrderCertificate' nextLink: description: Link to next page of resources type: string ReissueCertificateOrderRequest: description: Class representing certificate reissue request type: object allOf: - $ref: '#/definitions/Resource' properties: properties: properties: keySize: format: int32 description: Certificate Key Size type: integer delayExistingRevokeInHours: format: int32 description: >- Delay in hours to revoke existing certificate after the new certificate is issued type: integer x-ms-client-flatten: true RenewCertificateOrderRequest: description: Class representing certificate renew request type: object allOf: - $ref: '#/definitions/Resource' properties: properties: properties: keySize: format: int32 description: Certificate Key Size type: integer x-ms-client-flatten: true CertificateOrderAction: description: Represents a certificate action type: object allOf: - $ref: '#/definitions/Resource' properties: properties: required: - type properties: type: description: Type enum: - CertificateIssued - CertificateOrderCanceled - CertificateOrderCreated - CertificateRevoked - DomainValidationComplete - FraudDetected - OrgNameChange - OrgValidationComplete - SanDrop type: string x-ms-enum: name: CertificateOrderActionType modelAsString: false createdAt: format: date-time description: Time at which the certificate action was performed type: string x-ms-client-flatten: true CertificateEmail: description: Certificate Email type: object allOf: - $ref: '#/definitions/Resource' properties: properties: properties: emailId: description: Email id type: string timeStamp: format: date-time description: Time stamp type: string x-ms-client-flatten: true CertificateCollection: description: Collection of certificates type: object properties: value: description: Collection of resources type: array items: $ref: '#/definitions/Certificate' nextLink: description: Link to next page of resources type: string Certificate: description: App certificate type: object allOf: - $ref: '#/definitions/Resource' properties: properties: properties: friendlyName: description: Friendly name of the certificate type: string subjectName: description: Subject name of the certificate type: string hostNames: description: Host names the certificate applies to type: array items: type: string pfxBlob: description: Pfx blob type: string siteName: description: App name type: string selfLink: description: Self link type: string issuer: description: Certificate issuer type: string issueDate: format: date-time description: Certificate issue Date type: string expirationDate: format: date-time description: Certificate expiration date type: string password: description: Certificate password type: string thumbprint: description: Certificate thumbprint type: string valid: description: Is the certificate valid? type: boolean cerBlob: description: Raw bytes of .cer file type: string publicKeyHash: description: Public key hash type: string hostingEnvironmentProfile: $ref: '#/definitions/HostingEnvironmentProfile' description: >- Specification for the hosting environment (App Service Environment) to use for the certificate x-ms-client-flatten: true HostingEnvironmentProfile: description: >- Specification for a hostingEnvironment (App Service Environment) to use for this resource type: object properties: id: description: Resource id of the hostingEnvironment (App Service Environment) type: string name: description: Name of the hostingEnvironment (App Service Environment) (read only) type: string type: description: >- Resource type of the hostingEnvironment (App Service Environment) (read only) type: string Csr: description: Certificate signing request object type: object allOf: - $ref: '#/definitions/Resource' properties: properties: properties: name: description: Name used to locate CSR object type: string distinguishedName: description: Distinguished name of certificate to be created type: string csrString: description: Actual CSR string created type: string pfxBlob: description: PFX certificate of created certificate type: string password: description: PFX password type: string publicKeyHash: description: Hash of the certificates public key type: string hostingEnvironment: description: Hosting environment type: string x-ms-client-flatten: true ClassicMobileServiceCollection: description: Collection of Classic Mobile Services type: object properties: value: description: Collection of resources type: array items: $ref: '#/definitions/ClassicMobileService' nextLink: description: Link to next page of resources type: string ClassicMobileService: description: A mobile service type: object allOf: - $ref: '#/definitions/Resource' properties: properties: properties: name: description: Name of the mobile service type: string x-ms-client-flatten: true DomainCollection: description: Collection of domains type: object properties: value: description: Collection of resources type: array items: $ref: '#/definitions/Domain' nextLink: description: Link to next page of resources type: string Domain: description: Represents a domain type: object allOf: - $ref: '#/definitions/Resource' properties: properties: properties: contactAdmin: $ref: '#/definitions/Contact' description: Admin contact information contactBilling: $ref: '#/definitions/Contact' description: Billing contact information contactRegistrant: $ref: '#/definitions/Contact' description: Registrant contact information contactTech: $ref: '#/definitions/Contact' description: Technical contact information registrationStatus: description: Domain registration status enum: - Active - Awaiting - Cancelled - Confiscated - Disabled - Excluded - Expired - Failed - Held - Locked - Parked - Pending - Reserved - Reverted - Suspended - Transferred - Unknown - Unlocked - Unparked - Updated - JsonConverterFailed type: string x-ms-enum: name: DomainStatus modelAsString: false provisioningState: description: Domain provisioning state enum: - Succeeded - Failed - Canceled - InProgress - Deleting type: string x-ms-enum: name: ProvisioningState modelAsString: false nameServers: description: Name servers type: array items: type: string privacy: description: If true then domain privacy is enabled for this domain type: boolean createdTime: format: date-time description: Domain creation timestamp type: string expirationTime: format: date-time description: Domain expiration timestamp type: string lastRenewedTime: format: date-time description: Timestamp when the domain was renewed last time type: string autoRenew: description: If true then domain will renewed automatically type: boolean readyForDnsRecordManagement: description: >- If true then Azure can assign this domain to Web Apps. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to type: boolean managedHostNames: description: >- All hostnames derived from the domain and assigned to Azure resources type: array items: $ref: '#/definitions/HostName' consent: $ref: '#/definitions/DomainPurchaseConsent' description: Legal agreement consent domainNotRenewableReasons: description: Reasons why domain is not renewable type: array items: enum: - RegistrationStatusNotSupportedForRenewal - ExpirationNotInRenewalTimeRange - SubscriptionNotActive type: string x-ms-client-flatten: true Contact: description: >- Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information will be made publicly available through the Whois directories as per ICANN requirements. type: object properties: addressMailing: $ref: '#/definitions/Address' description: Mailing address email: description: Email address type: string fax: description: Fax number type: string jobTitle: description: Job title type: string nameFirst: description: First name type: string nameLast: description: Last name type: string nameMiddle: description: Middle name type: string organization: description: Organization type: string phone: description: Phone number type: string HostName: description: Details of a hostname derived from a domain type: object properties: name: description: Name of the hostname type: string siteNames: description: >- List of sites the hostname is assigned to. This list will have more than one site only if the hostname is pointing to a Traffic Manager type: array items: type: string azureResourceName: description: >- Name of the Azure resource the hostname is assigned to. If it is assigned to a traffic manager then it will be the traffic manager name otherwise it will be the website name type: string azureResourceType: description: Type of the Azure resource the hostname is assigned to enum: - Website - TrafficManager type: string x-ms-enum: name: AzureResourceType modelAsString: false customHostNameDnsRecordType: description: Type of the Dns record enum: - CName - A type: string x-ms-enum: name: CustomHostNameDnsRecordType modelAsString: false hostNameType: description: Type of the hostname enum: - Verified - Managed type: string x-ms-enum: name: HostNameType modelAsString: false DomainPurchaseConsent: description: >- Domain purchase consent object representing acceptance of applicable legal agreements type: object properties: agreementKeys: description: >- List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements Api under TopLevelDomain resource type: array items: type: string agreedBy: description: Client IP address type: string agreedAt: format: date-time description: Timestamp when the agreements were accepted type: string Address: description: Address information for domain registration type: object properties: address1: description: Address 1 type: string address2: description: Address 2 type: string city: description: City type: string country: description: Country type: string postalCode: description: Postal code type: string state: description: State type: string User: description: Represents user credentials used for publishing activity type: object allOf: - $ref: '#/definitions/Resource' properties: properties: properties: name: description: Username (internal) type: string publishingUserName: description: Username used for publishing type: string publishingPassword: description: Password used for publishing type: string scmUri: description: Service Control Manager URI, including username and password type: string x-ms-client-flatten: true GeoRegionCollection: description: Collection of geo regions type: object properties: value: description: Collection of resources type: array items: $ref: '#/definitions/GeoRegion' nextLink: description: Link to next page of resources type: string GeoRegion: description: Geographical region type: object allOf: - $ref: '#/definitions/Resource' properties: properties: properties: name: description: Region name type: string description: description: Region description type: string displayName: description: Display name for region type: string x-ms-client-flatten: true ServerFarmCollection: description: Collection of serverfarms type: object properties: value: description: Collection of resources type: array items: $ref: '#/definitions/ServerFarmWithRichSku' nextLink: description: Link to next page of resources type: string ServerFarmWithRichSku: description: App Service Plan Model type: object allOf: - $ref: '#/definitions/Resource' properties: properties: required: - status properties: name: description: Name for the App Service Plan type: string workerTierName: description: Target worker tier assigned to the App Service Plan type: string status: description: App Service Plan Status enum: - Ready - Pending type: string readOnly: true x-ms-enum: name: StatusOptions modelAsString: false subscription: description: App Service Plan Subscription type: string readOnly: true adminSiteName: description: App Service Plan administration site type: string hostingEnvironmentProfile: $ref: '#/definitions/HostingEnvironmentProfile' description: >- Specification for the hosting environment (App Service Environment) to use for the App Service Plan maximumNumberOfWorkers: format: int32 description: >- Maximum number of instances that can be assigned to this App Service Plan type: integer geoRegion: description: Geographical location for the App Service Plan type: string readOnly: true perSiteScaling: description: "If True apps assigned to this App Service Plan can be scaled independently\r\n If False apps assigned to this App Service Plan will scale to all instances of the plan" type: boolean numberOfSites: format: int32 description: Number of web apps assigned to this App Service Plan type: integer readOnly: true resourceGroup: description: Resource group of the server farm type: string readOnly: true reserved: description: Enables creation of a Linux App Service Plan type: boolean x-ms-client-flatten: true sku: $ref: '#/definitions/SkuDescription' SiteCollection: description: Collection of sites type: object properties: value: description: Collection of resources type: array items: $ref: '#/definitions/Site' nextLink: description: Link to next page of resources type: string Site: description: Represents a web app type: object allOf: - $ref: '#/definitions/Resource' properties: properties: required: - usageState - availabilityState properties: name: description: Name of web app type: string state: description: State of the web app type: string readOnly: true hostNames: description: Hostnames associated with web app type: array items: type: string readOnly: true repositorySiteName: description: Name of repository site type: string readOnly: true usageState: description: State indicating whether web app has exceeded its quota usage enum: - Normal - Exceeded type: string readOnly: true x-ms-enum: name: UsageState modelAsString: false enabled: description: >- True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). type: boolean enabledHostNames: description: "Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled\r\n the app is not served on those hostnames" type: array items: type: string readOnly: true availabilityState: description: "Management information availability state for the web app. Possible values are Normal or Limited. \r\n Normal means that the site is running correctly and that management information for the site is available. \r\n Limited means that only partial management information for the site is available and that detailed site information is unavailable." enum: - Normal - Limited - DisasterRecoveryMode type: string readOnly: true x-ms-enum: name: SiteAvailabilityState modelAsString: false hostNameSslStates: description: >- Hostname SSL states are used to manage the SSL bindings for site's hostnames. type: array items: $ref: '#/definitions/HostNameSslState' serverFarmId: type: string lastModifiedTimeUtc: format: date-time description: Last time web app was modified in UTC type: string readOnly: true siteConfig: $ref: '#/definitions/SiteConfig' description: Configuration of web app trafficManagerHostNames: description: >- Read-only list of Azure Traffic manager hostnames associated with web app type: array items: type: string readOnly: true premiumAppDeployed: description: If set indicates whether web app is deployed as a premium app type: boolean readOnly: true scmSiteAlsoStopped: description: >- If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. type: boolean targetSwapSlot: description: >- Read-only property that specifies which slot this app will swap into type: string readOnly: true hostingEnvironmentProfile: $ref: '#/definitions/HostingEnvironmentProfile' description: >- Specification for the hosting environment (App Service Environment) to use for the web app microService: description: '' type: string gatewaySiteName: description: Name of gateway app associated with web app type: string clientAffinityEnabled: description: >- Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app type: boolean clientCertEnabled: description: Specifies if the client certificate is enabled for the web app type: boolean hostNamesDisabled: description: "Specifies if the public hostnames are disabled the web app.\r\n If set to true the app is only accessible via API Management process" type: boolean outboundIpAddresses: description: >- List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. type: string readOnly: true containerSize: format: int32 description: Size of a function container type: integer maxNumberOfWorkers: format: int32 description: "Maximum number of workers\r\n This only applies to function container" type: integer cloningInfo: $ref: '#/definitions/CloningInfo' description: "This is only valid for web app creation. If specified, web app is cloned from \r\n a source web app" resourceGroup: description: Resource group web app belongs to type: string readOnly: true isDefaultContainer: description: Site is a default container type: boolean readOnly: true defaultHostName: description: Default hostname of the web app type: string readOnly: true x-ms-client-flatten: true SiteProperties: type: object properties: metadata: type: array items: $ref: '#/definitions/NameValuePair' properties: type: array items: $ref: '#/definitions/NameValuePair' appSettings: type: array items: $ref: '#/definitions/NameValuePair' HostNameSslState: description: Object that represents a SSL-enabled host name. required: - sslState type: object properties: name: description: Host name type: string sslState: description: SSL type enum: - Disabled - SniEnabled - IpBasedEnabled type: string x-ms-enum: name: SslState modelAsString: false virtualIP: description: >- Virtual IP address assigned to the host name if IP based SSL is enabled type: string thumbprint: description: SSL cert thumbprint type: string toUpdate: description: Set this flag to update existing host name type: boolean SiteConfig: description: Configuration of Azure web site type: object allOf: - $ref: '#/definitions/Resource' properties: properties: properties: numberOfWorkers: format: int32 description: Number of workers type: integer defaultDocuments: description: Default documents type: array items: type: string netFrameworkVersion: description: Net Framework Version type: string phpVersion: description: Version of PHP type: string pythonVersion: description: Version of Python type: string nodeVersion: description: Version of Node type: string requestTracingEnabled: description: Enable request tracing type: boolean requestTracingExpirationTime: format: date-time description: Request tracing expiration time type: string remoteDebuggingEnabled: description: Remote Debugging Enabled type: boolean remoteDebuggingVersion: description: Remote Debugging Version type: string httpLoggingEnabled: description: HTTP logging Enabled type: boolean logsDirectorySizeLimit: format: int32 description: HTTP Logs Directory size limit type: integer detailedErrorLoggingEnabled: description: Detailed error logging enabled type: boolean publishingUsername: description: Publishing user name type: string publishingPassword: description: Publishing password type: string appSettings: description: Application Settings type: array items: $ref: '#/definitions/NameValuePair' metadata: description: Site Metadata type: array items: $ref: '#/definitions/NameValuePair' connectionStrings: description: Connection strings type: array items: $ref: '#/definitions/ConnStringInfo' handlerMappings: description: Handler mappings type: array items: $ref: '#/definitions/HandlerMapping' documentRoot: description: Document root type: string scmType: description: SCM type type: string use32BitWorkerProcess: description: Use 32 bit worker process type: boolean webSocketsEnabled: description: Web socket enabled. type: boolean alwaysOn: description: Always On type: boolean javaVersion: description: Java version type: string javaContainer: description: Java container type: string javaContainerVersion: description: Java container version type: string appCommandLine: description: App Command Line to launch type: string managedPipelineMode: description: Managed pipeline mode enum: - Integrated - Classic type: string x-ms-enum: name: ManagedPipelineMode modelAsString: false virtualApplications: description: Virtual applications type: array items: $ref: '#/definitions/VirtualApplication' loadBalancing: description: Site load balancing enum: - WeightedRoundRobin - LeastRequests - LeastResponseTime - WeightedTotalTraffic - RequestHash type: string x-ms-enum: name: SiteLoadBalancing modelAsString: false experiments: $ref: '#/definitions/Experiments' description: This is work around for polymorphic types limits: $ref: '#/definitions/SiteLimits' description: Site limits autoHealEnabled: description: Auto heal enabled type: boolean autoHealRules: $ref: '#/definitions/AutoHealRules' description: Auto heal rules tracingOptions: description: Tracing options type: string vnetName: description: Vnet name type: string cors: $ref: '#/definitions/CorsSettings' description: Cross-Origin Resource Sharing (CORS) settings. apiDefinition: $ref: '#/definitions/ApiDefinitionInfo' description: Information about the formal API definition for the web app. autoSwapSlotName: description: Auto swap slot name type: string localMySqlEnabled: description: Local mysql enabled type: boolean ipSecurityRestrictions: description: Ip Security restrictions type: array items: $ref: '#/definitions/IpSecurityRestriction' x-ms-client-flatten: true CloningInfo: description: Represents information needed for cloning operation type: object properties: correlationId: description: "Correlation Id of cloning operation. This id ties multiple cloning operations\r\n together to use the same snapshot" type: string overwrite: description: Overwrite destination web app type: boolean cloneCustomHostNames: description: If true, clone custom hostnames from source web app type: boolean cloneSourceControl: description: Clone source control from source web app type: boolean sourceWebAppId: description: "ARM resource id of the source web app. Web app resource id is of the form \r\n /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \r\n /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots" type: string hostingEnvironment: description: Hosting environment type: string appSettingsOverrides: description: "Application settings overrides for cloned web app. If specified these settings will override the settings cloned \r\n from source web app. If not specified, application settings from source web app are retained." type: object additionalProperties: type: string configureLoadBalancing: description: If specified configure load balancing for source and clone site type: boolean trafficManagerProfileId: description: "ARM resource id of the traffic manager profile to use if it exists. Traffic manager resource id is of the form \r\n /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}" type: string trafficManagerProfileName: description: >- Name of traffic manager profile to create. This is only needed if traffic manager profile does not already exist type: string NameValuePair: description: Name value pair type: object properties: name: description: Pair name type: string value: description: Pair value type: string ConnStringInfo: description: Represents database connection string information required: - type type: object properties: name: description: Name of connection string type: string connectionString: description: Connection string value type: string type: description: Type of database enum: - MySql - SQLServer - SQLAzure - Custom type: string x-ms-enum: name: DatabaseServerType modelAsString: false HandlerMapping: description: "The IIS handler mappings used to define which handler processes HTTP requests with certain extension. \r\n For example it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension." type: object properties: extension: description: >- Requests with this extension will be handled using the specified FastCGI application. type: string scriptProcessor: description: The absolute path to the FastCGI application. type: string arguments: description: Command-line arguments to be passed to the script processor. type: string VirtualApplication: type: object properties: virtualPath: type: string physicalPath: type: string preloadEnabled: type: boolean virtualDirectories: type: array items: $ref: '#/definitions/VirtualDirectory' RoutingRule: description: Routing rules for TiP type: object properties: name: description: >- Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. type: string Experiments: description: Class containing Routing in production experiments type: object properties: rampUpRules: description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. type: array items: $ref: '#/definitions/RampUpRule' SiteLimits: description: Represents metric limits set on a web app. type: object properties: maxPercentageCpu: format: double description: Maximum allowed CPU usage percentage type: number maxMemoryInMb: format: int64 description: Maximum allowed memory usage in MB type: integer maxDiskSizeInMb: format: int64 description: Maximum allowed disk size usage in MB type: integer AutoHealRules: description: AutoHealRules - describes the rules which can be defined for auto-heal type: object properties: triggers: $ref: '#/definitions/AutoHealTriggers' description: >- Triggers - Conditions that describe when to execute the auto-heal actions actions: $ref: '#/definitions/AutoHealActions' description: Actions - Actions to be executed when a rule is triggered SiteAuthSettings: description: >- Configuration settings for the Azure App Service Authentication / Authorization feature. type: object properties: enabled: description: >- Gets or sets a value indicating whether the Authentication / Authorization feature is enabled for the current app. type: boolean httpApiPrefixPath: description: "Gets or sets the relative path prefix used by platform HTTP APIs.\r\n Changing this value is not recommended except for compatibility reasons." type: string unauthenticatedClientAction: description: >- Gets or sets the action to take when an unauthenticated client attempts to access the app. enum: - RedirectToLoginPage - AllowAnonymous type: string x-ms-enum: name: UnauthenticatedClientAction modelAsString: false tokenStoreEnabled: description: "Gets or sets a value indicating whether to durably store platform-specific security tokens\r\n obtained during login flows. This capability is disabled by default." type: boolean allowedExternalRedirectUrls: description: "Gets or sets a collection of external URLs that can be redirected to as part of logging in\r\n or logging out of the web app. Note that the query string part of the URL is ignored.\r\n This is an advanced setting typically only needed by Windows Store application backends.\r\n Note that URLs within the current domain are always implicitly allowed." type: array items: type: string defaultProvider: description: "Gets or sets the default authentication provider to use when multiple providers are configured.\r\n This setting is only needed if multiple providers are configured and the unauthenticated client\r\n action is set to \"RedirectToLoginPage\"." enum: - AzureActiveDirectory - Facebook - Google - MicrosoftAccount - Twitter type: string x-ms-enum: name: BuiltInAuthenticationProvider modelAsString: false tokenRefreshExtensionHours: format: double description: "Gets or sets the number of hours after session token expiration that a session token can be used to\r\n call the token refresh API. The default is 72 hours." type: number clientId: description: "Gets or sets the Client ID of this relying party application, known as the client_id.\r\n This setting is required for enabling OpenID Connection authentication with Azure Active Directory or \r\n other 3rd party OpenID Connect providers.\r\n More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html" type: string clientSecret: description: "Gets or sets the Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key).\r\n This setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users.\r\n Otherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users.\r\n More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html" type: string issuer: description: "Gets or sets the OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\r\n When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.\r\n This URI is a case-sensitive identifier for the token issuer.\r\n More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html" type: string allowedAudiences: description: "Gets or sets a list of allowed audience values to consider when validating JWTs issued by \r\n Azure Active Directory. Note that the {Microsoft.Web.Hosting.Administration.SiteAuthSettings.ClientId} value is always considered an\r\n allowed audience, regardless of this setting." type: array items: type: string additionalLoginParams: description: "Gets or sets a list of login parameters to send to the OpenID Connect authorization endpoint when\r\n a user logs in. Each parameter must be in the form \"key=value\"." type: array items: type: string aadClientId: type: string openIdIssuer: type: string googleClientId: description: "Gets or sets the OpenID Connect Client ID for the Google web application.\r\n This setting is required for enabling Google Sign-In.\r\n Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/" type: string googleClientSecret: description: "Gets or sets the client secret associated with the Google web application.\r\n This setting is required for enabling Google Sign-In.\r\n Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/" type: string googleOAuthScopes: description: "Gets or sets the OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication.\r\n This setting is optional. If not specified, \"openid\", \"profile\", and \"email\" are used as default scopes.\r\n Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/" type: array items: type: string facebookAppId: description: "Gets or sets the App ID of the Facebook app used for login.\r\n This setting is required for enabling Facebook Login.\r\n Facebook Login documentation: https://developers.facebook.com/docs/facebook-login" type: string facebookAppSecret: description: "Gets or sets the App Secret of the Facebook app used for Facebook Login.\r\n This setting is required for enabling Facebook Login.\r\n Facebook Login documentation: https://developers.facebook.com/docs/facebook-login" type: string facebookOAuthScopes: description: "Gets or sets the OAuth 2.0 scopes that will be requested as part of Facebook Login authentication.\r\n This setting is optional.\r\n Facebook Login documentation: https://developers.facebook.com/docs/facebook-login" type: array items: type: string twitterConsumerKey: description: "Gets or sets the OAuth 1.0a consumer key of the Twitter application used for sign-in.\r\n This setting is required for enabling Twitter Sign-In.\r\n Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in" type: string twitterConsumerSecret: description: "Gets or sets the OAuth 1.0a consumer secret of the Twitter application used for sign-in.\r\n This setting is required for enabling Twitter Sign-In.\r\n Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in" type: string microsoftAccountClientId: description: "Gets or sets the OAuth 2.0 client ID that was created for the app used for authentication.\r\n This setting is required for enabling Microsoft Account authentication.\r\n Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm" type: string microsoftAccountClientSecret: description: "Gets or sets the OAuth 2.0 client secret that was created for the app used for authentication.\r\n This setting is required for enabling Microsoft Account authentication.\r\n Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm" type: string microsoftAccountOAuthScopes: description: "Gets or sets the OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication.\r\n This setting is optional. If not specified, \"wl.basic\" is used as the default scope.\r\n Microsoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx" type: array items: type: string CorsSettings: description: Cross-Origin Resource Sharing (CORS) settings for the web app. type: object properties: allowedOrigins: description: "Gets or sets the list of origins that should be allowed to make cross-origin\r\n calls (for example: http://example.com:12345). Use \"*\" to allow all." type: array items: type: string ApiDefinitionInfo: description: Information about the formal API definition for the web app. type: object properties: url: description: The URL of the API definition. type: string IpSecurityRestriction: description: Represents an ip security restriction on a web app. type: object properties: ipAddress: description: IP address the security restriction is valid for type: string subnetMask: description: Subnet mask for the range of IP addresses the restriction is valid for type: string VirtualDirectory: type: object properties: virtualPath: type: string physicalPath: type: string RampUpRule: description: >- Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance type: object properties: actionHostName: description: >- Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net type: string reroutePercentage: format: double description: >- Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} type: number changeStep: format: double description: "[Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches \r\n {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}.\r\n Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl}" type: number changeIntervalInMinutes: format: int32 description: >- [Optional] Specifies interval in minutes to reevaluate ReroutePercentage type: integer minReroutePercentage: format: double description: >- [Optional] Specifies lower boundary above which ReroutePercentage will stay. type: number maxReroutePercentage: format: double description: >- [Optional] Specifies upper boundary below which ReroutePercentage will stay. type: number changeDecisionCallbackUrl: description: "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. See TiPCallback site extension for the scaffold and contracts.\r\n https://www.siteextensions.net/packages/TiPCallback/" type: string name: description: >- Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. type: string AutoHealTriggers: description: AutoHealTriggers - describes the triggers for auto-heal. type: object properties: requests: $ref: '#/definitions/RequestsBasedTrigger' description: Requests - Defines a rule based on total requests privateBytesInKB: format: int32 description: PrivateBytesInKB - Defines a rule based on private bytes type: integer statusCodes: description: StatusCodes - Defines a rule based on status codes type: array items: $ref: '#/definitions/StatusCodesBasedTrigger' slowRequests: $ref: '#/definitions/SlowRequestsBasedTrigger' description: SlowRequests - Defines a rule based on request execution time AutoHealActions: description: "AutoHealActions - Describes the actions which can be\r\n taken by the auto-heal module when a rule is triggered." required: - actionType type: object properties: actionType: description: ActionType - predefined action to be taken enum: - Recycle - LogEvent - CustomAction type: string x-ms-enum: name: AutoHealActionType modelAsString: false customAction: $ref: '#/definitions/AutoHealCustomAction' description: CustomAction - custom action to be taken minProcessExecutionTime: description: "MinProcessExecutionTime - minimum time the process must execute\r\n before taking the action" type: string RequestsBasedTrigger: description: RequestsBasedTrigger type: object properties: count: format: int32 description: Count type: integer timeInterval: description: TimeInterval type: string StatusCodesBasedTrigger: description: StatusCodeBasedTrigger type: object properties: status: format: int32 description: HTTP status code type: integer subStatus: format: int32 description: SubStatus type: integer win32Status: format: int32 description: Win32 error code type: integer count: format: int32 description: Count type: integer timeInterval: description: TimeInterval type: string SlowRequestsBasedTrigger: description: SlowRequestsBasedTrigger type: object properties: timeTaken: description: TimeTaken type: string count: format: int32 description: Count type: integer timeInterval: description: TimeInterval type: string AutoHealCustomAction: description: "AutoHealCustomAction - Describes the custom action to be executed\r\n when an auto heal rule is triggered." type: object properties: exe: description: Executable to be run type: string parameters: description: Parameters for the executable type: string HostingEnvironmentCollection: description: Collection of hosting environments (App Service Environments) type: object properties: value: description: Collection of resources type: array items: $ref: '#/definitions/HostingEnvironment' nextLink: description: Link to next page of resources type: string HostingEnvironment: description: Description of an hostingEnvironment (App Service Environment) type: object allOf: - $ref: '#/definitions/Resource' properties: properties: required: - status properties: name: description: Name of the hostingEnvironment (App Service Environment) type: string location: description: >- Location of the hostingEnvironment (App Service Environment), e.g. "West US" type: string provisioningState: description: >- Provisioning state of the hostingEnvironment (App Service Environment) enum: - Succeeded - Failed - Canceled - InProgress - Deleting type: string x-ms-enum: name: ProvisioningState modelAsString: false status: description: Current status of the hostingEnvironment (App Service Environment) enum: - Preparing - Ready - Scaling - Deleting type: string x-ms-enum: name: HostingEnvironmentStatus modelAsString: false vnetName: description: >- Name of the hostingEnvironment's (App Service Environment) virtual network type: string vnetResourceGroupName: description: >- Resource group of the hostingEnvironment's (App Service Environment) virtual network type: string vnetSubnetName: description: >- Subnet of the hostingEnvironment's (App Service Environment) virtual network type: string virtualNetwork: $ref: '#/definitions/VirtualNetworkProfile' description: >- Description of the hostingEnvironment's (App Service Environment) virtual network internalLoadBalancingMode: description: >- Specifies which endpoints to serve internally in the hostingEnvironment's (App Service Environment) VNET enum: - None - Web - Publishing type: string x-ms-enum: name: InternalLoadBalancingMode modelAsString: false multiSize: description: Front-end VM size, e.g. "Medium", "Large" type: string multiRoleCount: format: int32 description: Number of front-end instances type: integer workerPools: description: >- Description of worker pools with worker size ids, VM sizes, and number of workers in each pool type: array items: $ref: '#/definitions/WorkerPool' ipsslAddressCount: format: int32 description: >- Number of IP SSL addresses reserved for this hostingEnvironment (App Service Environment) type: integer databaseEdition: description: >- Edition of the metadata database for the hostingEnvironment (App Service Environment) e.g. "Standard" type: string databaseServiceObjective: description: >- Service objective of the metadata database for the hostingEnvironment (App Service Environment) e.g. "S0" type: string upgradeDomains: format: int32 description: >- Number of upgrade domains of this hostingEnvironment (App Service Environment) type: integer subscriptionId: description: Subscription of the hostingEnvironment (App Service Environment) type: string dnsSuffix: description: DNS suffix of the hostingEnvironment (App Service Environment) type: string lastAction: description: >- Last deployment action on this hostingEnvironment (App Service Environment) type: string lastActionResult: description: >- Result of the last deployment action on this hostingEnvironment (App Service Environment) type: string allowedMultiSizes: description: >- List of comma separated strings describing which VM sizes are allowed for front-ends type: string allowedWorkerSizes: description: >- List of comma separated strings describing which VM sizes are allowed for workers type: string maximumNumberOfMachines: format: int32 description: >- Maximum number of VMs in this hostingEnvironment (App Service Environment) type: integer vipMappings: description: >- Description of IP SSL mapping for this hostingEnvironment (App Service Environment) type: array items: $ref: '#/definitions/VirtualIPMapping' environmentCapacities: description: Current total, used, and available worker capacities type: array items: $ref: '#/definitions/StampCapacity' networkAccessControlList: description: >- Access control list for controlling traffic to the hostingEnvironment (App Service Environment) type: array items: $ref: '#/definitions/NetworkAccessControlEntry' environmentIsHealthy: description: >- True/false indicating whether the hostingEnvironment (App Service Environment) is healthy type: boolean environmentStatus: description: >- Detailed message about with results of the last check of the hostingEnvironment (App Service Environment) type: string resourceGroup: description: Resource group of the hostingEnvironment (App Service Environment) type: string apiManagementAccountId: description: Api Management Account associated with this Hosting Environment type: string suspended: description: "True/false indicating whether the hostingEnvironment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available\r\n (most likely because NSG blocked the incoming traffic)" type: boolean clusterSettings: description: >- Custom settings for changing the behavior of the hosting environment type: array items: $ref: '#/definitions/NameValuePair' x-ms-client-flatten: true VirtualNetworkProfile: description: Specification for using a virtual network type: object properties: id: description: Resource id of the virtual network type: string name: description: Name of the virtual network (read-only) type: string type: description: Resource type of the virtual network (read-only) type: string subnet: description: Subnet within the virtual network type: string WorkerPool: description: Worker pool of a hostingEnvironment (App Service Environment) type: object allOf: - $ref: '#/definitions/Resource' properties: properties: properties: workerSizeId: format: int32 description: Worker size id for referencing this worker pool type: integer computeMode: description: Shared or dedicated web app hosting enum: - Shared - Dedicated - Dynamic type: string x-ms-enum: name: ComputeModeOptions modelAsString: false workerSize: description: VM size of the worker pool instances type: string workerCount: format: int32 description: Number of instances in the worker pool type: integer instanceNames: description: Names of all instances in the worker pool (read only) type: array items: type: string x-ms-client-flatten: true sku: $ref: '#/definitions/SkuDescription' VirtualIPMapping: description: Class that represents a VIP mapping type: object properties: virtualIP: description: Virtual IP address type: string internalHttpPort: format: int32 description: Internal HTTP port type: integer internalHttpsPort: format: int32 description: Internal HTTPS port type: integer inUse: description: Is VIP mapping in use type: boolean StampCapacity: description: Class containing stamp capacity information type: object properties: name: description: Name of the stamp type: string availableCapacity: format: int64 description: Available capacity (# of machines, bytes of storage etc...) type: integer totalCapacity: format: int64 description: Total capacity (# of machines, bytes of storage etc...) type: integer unit: description: Name of the unit type: string computeMode: description: Shared/Dedicated workers enum: - Shared - Dedicated - Dynamic type: string x-ms-enum: name: ComputeModeOptions modelAsString: false workerSize: description: Size of the machines enum: - Default - Small - Medium - Large type: string x-ms-enum: name: WorkerSizeOptions modelAsString: false workerSizeId: format: int32 description: "Size Id of machines: \r\n 0 - Small\r\n 1 - Medium\r\n 2 - Large" type: integer excludeFromCapacityAllocation: description: "If true it includes basic sites\r\n Basic sites are not used for capacity allocation." type: boolean isApplicableForAllComputeModes: description: Is capacity applicable for all sites? type: boolean siteMode: description: Shared or Dedicated type: string NetworkAccessControlEntry: type: object properties: action: enum: - Permit - Deny type: string x-ms-enum: name: AccessControlEntryAction modelAsString: false description: type: string order: format: int32 type: integer remoteSubnet: type: string ManagedHostingEnvironmentCollection: description: Collection of managed hosting environments type: object properties: value: description: Collection of resources type: array items: $ref: '#/definitions/ManagedHostingEnvironment' nextLink: description: Link to next page of resources type: string ManagedHostingEnvironment: description: Description of a managed hosting environment type: object allOf: - $ref: '#/definitions/Resource' properties: properties: required: - status properties: name: description: Name of the managed hosting environment type: string location: description: Location of the managed hosting environment e.g. "West US" type: string status: description: Current status of the managed hosting environment enum: - Preparing - Ready - Deleting type: string x-ms-enum: name: ManagedHostingEnvironmentStatus modelAsString: false virtualNetwork: $ref: '#/definitions/VirtualNetworkProfile' description: Description of the managed hosting environment's virtual network ipsslAddressCount: format: int32 description: >- Number of ip ssl addresses reserved for the managed hosting environment type: integer dnsSuffix: description: DNS suffix of the managed hosting environment type: string subscriptionId: description: Subscription of the managed hosting environment (read only) type: string resourceGroup: description: Resource group of the managed hosting environment (read only) type: string environmentIsHealthy: description: >- True/false indicating whether the managed hosting environment is healthy type: boolean environmentStatus: description: >- Detailed message about with results of the last check of the managed hosting environment type: string suspended: description: "True/false indicating whether the managed hosting environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available\r\n (most likely because NSG blocked the incoming traffic)" type: boolean apiManagementAccount: description: >- Resource id of the api management account associated with this managed hosting environment (read only) type: string x-ms-client-flatten: true ResourceNameAvailabilityRequest: description: Resource name availability request content type: object properties: name: description: Resource name to verify type: string type: description: Resource type used for verification type: string isFqdn: description: Is fully qualified domain name type: boolean ResourceNameAvailability: description: Describes if a resource name is available type: object properties: nameAvailable: description: >- True indicates name is valid and available. False indicates the name is invalid, unavailable, or both. type: boolean reason: description: >- Required if nameAvailable is false. 'Invalid' indicates the name provided does not match Azure WebApp service’s naming requirements. 'AlreadyExists' indicates that the name is already in use and is therefore unavailable. type: string message: type: string DomainControlCenterSsoRequest: description: Single sign on request information for domain management type: object properties: url: description: Url where the single sign on request is to be made type: string postParameterKey: description: Post parameter key type: string postParameterValue: description: >- Post parameter value. Client should use 'application/x-www-form-urlencoded' encoding for this value. type: string DomainRegistrationInput: description: Domain registration input for validation Api type: object allOf: - $ref: '#/definitions/Resource' properties: properties: properties: name: description: Name of the domain type: string contactAdmin: $ref: '#/definitions/Contact' description: Admin contact information contactBilling: $ref: '#/definitions/Contact' description: Billing contact information contactRegistrant: $ref: '#/definitions/Contact' description: Registrant contact information contactTech: $ref: '#/definitions/Contact' description: Technical contact information registrationStatus: description: Domain registration status enum: - Active - Awaiting - Cancelled - Confiscated - Disabled - Excluded - Expired - Failed - Held - Locked - Parked - Pending - Reserved - Reverted - Suspended - Transferred - Unknown - Unlocked - Unparked - Updated - JsonConverterFailed type: string x-ms-enum: name: DomainStatus modelAsString: false provisioningState: description: Domain provisioning state enum: - Succeeded - Failed - Canceled - InProgress - Deleting type: string x-ms-enum: name: ProvisioningState modelAsString: false nameServers: description: Name servers type: array items: type: string privacy: description: If true then domain privacy is enabled for this domain type: boolean createdTime: format: date-time description: Domain creation timestamp type: string expirationTime: format: date-time description: Domain expiration timestamp type: string lastRenewedTime: format: date-time description: Timestamp when the domain was renewed last time type: string autoRenew: description: If true then domain will renewed automatically type: boolean readyForDnsRecordManagement: description: >- If true then Azure can assign this domain to Web Apps. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to type: boolean managedHostNames: description: >- All hostnames derived from the domain and assigned to Azure resources type: array items: $ref: '#/definitions/HostName' consent: $ref: '#/definitions/DomainPurchaseConsent' description: Legal agreement consent domainNotRenewableReasons: description: Reasons why domain is not renewable type: array items: enum: - RegistrationStatusNotSupportedForRenewal - ExpirationNotInRenewalTimeRange - SubscriptionNotActive type: string x-ms-client-flatten: true NameIdentifier: description: Identifies an object type: object properties: name: description: Name of the object type: string DomainAvailablilityCheckResult: description: Domain availablility check result type: object properties: name: description: Name of the domain type: string available: description: If true then domain can be purchased using CreateDomain Api type: boolean domainType: description: Domain type enum: - Regular - SoftDeleted type: string x-ms-enum: name: DomainType modelAsString: false DomainRecommendationSearchParameters: description: Domain recommendation search parameters type: object properties: keywords: description: Keywords to be used for generating domain recommendations type: string maxDomainRecommendations: format: int32 description: Maximum number of recommendations type: integer NameIdentifierCollection: description: Collection of domain name identifiers type: object properties: value: description: Collection of resources type: array items: $ref: '#/definitions/NameIdentifier' nextLink: description: Link to next page of resources type: string CsmMoveResourceEnvelope: description: >- Class containing a list of the resources that need to be moved and the resource group they should be moved to type: object properties: targetResourceGroup: type: string resources: type: array items: type: string HostingEnvironmentDiagnostics: description: Diagnostics for a hosting environment (App Service Environment) type: object properties: name: description: Name/identifier of the diagnostics type: string diagnosicsOutput: description: Diagnostics output type: string StampCapacityCollection: description: Collection of stamp capacities type: object properties: value: description: Collection of resources type: array items: $ref: '#/definitions/StampCapacity' nextLink: description: Link to next page of resources type: string AddressResponse: description: Describes main public ip address and any extra vips type: object properties: serviceIpAddress: description: Main public vip type: string internalIpAddress: description: >- VNET internal ip address of the hostingEnvironment (App Service Environment) if it is in internal load-balancing mode type: string outboundIpAddresses: description: IP addresses appearing on outbound connections type: array items: type: string vipMappings: description: Additional vips type: array items: $ref: '#/definitions/VirtualIPMapping' ResourceMetricCollection: description: Collection of metric responses type: object properties: value: description: Collection of resources type: array items: $ref: '#/definitions/ResourceMetric' nextLink: description: Link to next page of resources type: string ResourceMetric: description: Object representing a metric for any resource type: object properties: name: $ref: '#/definitions/ResourceMetricName' description: Name of metric unit: description: Metric unit type: string timeGrain: description: Metric granularity. E.g PT1H, PT5M, P1D type: string startTime: format: date-time description: Metric start time type: string endTime: format: date-time description: Metric end time type: string resourceId: description: Metric resource Id type: string metricValues: description: Metric values type: array items: $ref: '#/definitions/ResourceMetricValue' properties: description: Properties type: array items: $ref: '#/definitions/KeyValuePair[String,String]' ResourceMetricName: description: Name of a metric for any resource type: object properties: value: description: metric name value type: string localizedValue: description: Localized metric name value type: string ResourceMetricValue: description: Value of resource metric type: object properties: timeStamp: description: Value timestamp type: string average: format: float description: Value average type: number minimum: format: float description: Value minimum type: number maximum: format: float description: Value maximum type: number total: format: float description: Value total type: number count: format: float description: Value count type: number KeyValuePair[String,String]: type: object properties: key: type: string readOnly: true value: type: string readOnly: true MetricDefinition: description: Class representing metadata for the metrics type: object allOf: - $ref: '#/definitions/Resource' properties: properties: properties: name: description: Name of the metric type: string unit: description: Unit of the metric type: string primaryAggregationType: description: Primary aggregation type type: string metricAvailabilities: description: >- List of time grains supported for the metric together with retention period type: array items: $ref: '#/definitions/MetricAvailabilily' displayName: description: Friendly name shown in the UI type: string x-ms-client-flatten: true MetricAvailabilily: description: Class representing metrics availability and retention type: object properties: timeGrain: description: Time grain type: string retention: description: >- Retention period for the current {Microsoft.Web.Hosting.Administration.MetricAvailabilily.TimeGrain} type: string CsmUsageQuotaCollection: description: Collection of csm usage quotas type: object properties: value: description: Collection of resources type: array items: $ref: '#/definitions/CsmUsageQuota' nextLink: description: Link to next page of resources type: string CsmUsageQuota: description: Usage of the quota resource type: object properties: unit: description: Units of measurement for the quota resource type: string nextResetTime: format: date-time description: Next reset time for the resource counter type: string currentValue: format: int64 description: The current value of the resource counter type: integer limit: format: int64 description: The resource limit type: integer name: $ref: '#/definitions/LocalizableString' description: Quota name LocalizableString: description: LocalizableString object containing the name and a localized value. type: object properties: value: description: Non localized name type: string localizedValue: description: Localized name type: string MetricDefinitionCollection: description: Collection of metric definitions type: object properties: value: description: Collection of resources type: array items: $ref: '#/definitions/MetricDefinition' nextLink: description: Link to next page of resources type: string UsageCollection: description: Collection of usages type: object properties: value: description: Collection of resources type: array items: $ref: '#/definitions/Usage' nextLink: description: Link to next page of resources type: string Usage: description: Class that represents usage of the quota resource. type: object allOf: - $ref: '#/definitions/Resource' properties: properties: properties: displayName: description: Friendly name shown in the UI type: string name: description: Name of the quota type: string resourceName: description: Name of the quota resource type: string unit: description: Units of measurement for the quota resource type: string currentValue: format: int64 description: The current value of the resource counter type: integer limit: format: int64 description: The resource limit type: integer nextResetTime: format: date-time description: Next reset time for the resource counter type: string computeMode: description: ComputeMode used for this usage enum: - Shared - Dedicated - Dynamic type: string x-ms-enum: name: ComputeModeOptions modelAsString: false siteMode: description: SiteMode used for this usage type: string x-ms-client-flatten: true WorkerPoolCollection: description: Collection of worker pools type: object properties: value: description: Collection of resources type: array items: $ref: '#/definitions/WorkerPool' nextLink: description: Link to next page of resources type: string SkuInfoCollection: description: Collection of SkuInfos type: object properties: value: description: Collection of resources type: array items: $ref: '#/definitions/SkuInfo' nextLink: description: Link to next page of resources type: string SkuInfo: description: Sku discovery information type: object properties: resourceType: description: Resource type that this sku applies to type: string sku: $ref: '#/definitions/SkuDescription' description: Name and tier of the sku capacity: $ref: '#/definitions/SkuCapacity' description: Min, max, and default scale values of the sku SkuCapacity: description: Description of the App Service Plan scale options type: object properties: minimum: format: int32 description: Minimum number of Workers for this App Service Plan SKU type: integer maximum: format: int32 description: Maximum number of Workers for this App Service Plan SKU type: integer default: format: int32 description: Default number of Workers for this App Service Plan SKU type: integer scaleType: description: Available scale configurations for an App Service Plan type: string SourceControlCollection: description: Collection of source controls type: object properties: value: description: Collection of resources type: array items: $ref: '#/definitions/SourceControl' nextLink: description: Link to next page of resources type: string SourceControl: description: Describes the Source Control OAuth Token type: object allOf: - $ref: '#/definitions/Resource' properties: properties: properties: name: description: Name or Source Control Type type: string token: description: OAuth Access Token type: string tokenSecret: description: OAuth Access Token Secret type: string refreshToken: description: OAuth Refresh Token type: string expirationTime: format: date-time description: OAuth Token Expiration type: string x-ms-client-flatten: true Recommendation: description: Represents a recommendation result generated by the recommendation engine required: - level - channels type: object properties: creationTime: format: date-time description: Timestamp when this instance was created. type: string recommendationId: description: A GUID value that each recommendation object is associated with. type: string resourceId: description: >- Full ARM resource ID string that this recommendation object is associated with. type: string resourceScope: description: >- Name of a resource type this recommendation applies, e.g. Subscription, ServerFarm, Site. type: string ruleName: description: Unique name of the rule type: string displayName: description: UI friendly name of the rule (may not be unique) type: string message: description: Localized text of recommendation, good for UI. type: string level: description: Level indicating how critical this recommendation can impact. enum: - Critical - Warning - Information - NonUrgentSuggestion type: string x-ms-enum: name: NotificationLevel modelAsString: false channels: description: List of channels that this recommendation can apply. enum: - Notification - Api - Email - All type: string x-ms-enum: name: Channels modelAsString: false tags: description: The list of category tags that this recommendation belongs to. type: array items: type: string actionName: description: Name of action recommended by this object. type: string enabled: format: int32 description: On/off flag indicating the rule is currently enabled or disabled. type: integer startTime: format: date-time description: The beginning time of a range that the recommendation refers to. type: string endTime: format: date-time description: The end time of a range that the recommendation refers to. type: string nextNotificationTime: format: date-time description: >- When to notify this recommendation next. Null means that this will never be notified anymore. type: string notificationExpirationTime: format: date-time description: Date and time when this notification expires. type: string notifiedTime: format: date-time description: >- Last timestamp this instance was actually notified. Null means that this recommendation hasn't been notified yet. type: string score: format: double description: A metric value measured by the rule. type: number RecommendationRule: description: >- Represents a recommendation rule that the recommendation engine can perform required: - level - channels type: object properties: name: description: Unique name of the rule type: string displayName: description: UI friendly name of the rule type: string message: description: Localized name of the rule (Good for UI) type: string recommendationId: description: "Recommendation ID of an associated recommendation object tied to the rule, if exists.\r\n If such an object doesn't exist, it is set to null." type: string description: description: Localized detailed description of the rule type: string actionName: description: Name of action that is recommended by this rule in string type: string enabled: format: int32 description: On/off flag indicating the rule is currently enabled or disabled. type: integer level: description: Level of impact indicating how critical this rule is. enum: - Critical - Warning - Information - NonUrgentSuggestion type: string x-ms-enum: name: NotificationLevel modelAsString: false channels: description: List of available channels that this rule applies. enum: - Notification - Api - Email - All type: string x-ms-enum: name: Channels modelAsString: false tags: description: An array of category tags that the rule contains. type: array items: type: string VnetInfo: description: >- VNETInfo contract. This contract is public and is a stripped down version of VNETInfoInternal type: object allOf: - $ref: '#/definitions/Resource' properties: properties: properties: vnetResourceId: description: The vnet resource id type: string certThumbprint: description: The client certificate thumbprint type: string certBlob: description: "A certificate file (.cer) blob containing the public key of the private key used to authenticate a \r\n Point-To-Site VPN connection." type: string routes: description: The routes that this virtual network connection uses. type: array items: $ref: '#/definitions/VnetRoute' resyncRequired: description: Flag to determine if a resync is required type: boolean dnsServers: description: >- Dns servers to be used by this VNET. This should be a comma-separated list of IP addresses. type: string x-ms-client-flatten: true VnetRoute: description: VnetRoute contract used to pass routing information for a vnet. type: object allOf: - $ref: '#/definitions/Resource' properties: properties: properties: name: description: >- The name of this route. This is only returned by the server and does not need to be set by the client. type: string startAddress: description: >- The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. type: string endAddress: description: >- The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. type: string routeType: description: "The type of route this is:\r\n DEFAULT - By default, every web app has routes to the local address ranges specified by RFC1918\r\n INHERITED - Routes inherited from the real Virtual Network routes\r\n STATIC - Static route set on the web app only\r\n \r\n These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them\r\n with new INHERITED routes." type: string x-ms-client-flatten: true VnetGateway: description: >- The VnetGateway contract. This is used to give the vnet gateway access to the VPN package. type: object allOf: - $ref: '#/definitions/Resource' properties: properties: properties: vnetName: description: The VNET name. type: string vpnPackageUri: description: The URI where the Vpn package can be downloaded type: string x-ms-client-flatten: true NetworkFeatures: description: "This is an object used to store a full view of network features (presently VNET integration and Hybrid Connections)\r\n for a web app." type: object allOf: - $ref: '#/definitions/Resource' properties: properties: properties: virtualNetworkName: description: The Vnet Name type: string virtualNetworkConnection: $ref: '#/definitions/VnetInfo' description: The Vnet Summary view hybridConnections: description: The Hybrid Connections Summary view type: array items: $ref: '#/definitions/RelayServiceConnectionEntity' x-ms-client-flatten: true RelayServiceConnectionEntity: description: Class that represents a BizTalk Hybrid Connection type: object allOf: - $ref: '#/definitions/Resource' properties: properties: properties: entityName: type: string entityConnectionString: type: string resourceType: type: string resourceConnectionString: type: string hostname: type: string port: format: int32 type: integer biztalkUri: type: string x-ms-client-flatten: true CsmSlotEntity: description: Class containing deployment slot parameters type: object properties: targetSlot: description: Set the destination deployment slot during swap operation type: string preserveVnet: description: >- Get or set the flag indicating it should preserve VNet to the slot during swap type: boolean SlotDifferenceCollection: description: Collection of Slot Differences type: object properties: value: description: Collection of resources type: array items: $ref: '#/definitions/SlotDifference' nextLink: description: Link to next page of resources type: string SlotDifference: description: >- An object describing the difference in setting values between two web app slots type: object allOf: - $ref: '#/definitions/Resource' properties: properties: properties: type: description: >- Indicates the type of the difference: Information, Warning or Error. type: string settingType: description: 'The type of the settings: General, AppSetting or ConnectionString' type: string diffRule: description: >- Rule that describes how to process the difference in settings during web app slot swap. type: string settingName: description: Name of the setting type: string valueInCurrentSlot: description: Value of the setting in the current web app slot type: string valueInTargetSlot: description: Value of the setting in the target web app slot type: string description: description: Description of the difference type: string x-ms-client-flatten: true SlotConfigNamesResource: description: Slot Config names azure resource type: object allOf: - $ref: '#/definitions/Resource' properties: properties: properties: connectionStringNames: description: List of connection string names type: array items: type: string appSettingNames: description: List of application settings names type: array items: type: string x-ms-client-flatten: true SlotConfigNames: description: "Class containing names for connection strings and application settings to be marked as sticky to the slot \r\n and not moved during swap operation\r\n This is valid for all deployment slots under the site" type: object properties: connectionStringNames: description: List of connection string names type: array items: type: string appSettingNames: description: List of application settings names type: array items: type: string SiteCloneability: description: Represents whether or not a web app is cloneable required: - result type: object properties: result: description: Name of web app enum: - Cloneable - PartiallyCloneable - NotCloneable type: string x-ms-enum: name: CloneAbilityResult modelAsString: false blockingFeatures: description: List of features enabled on web app that prevent cloning type: array items: $ref: '#/definitions/SiteCloneabilityCriterion' unsupportedFeatures: description: "List of features enabled on web app that are non-blocking but cannot be cloned. The web app can still be cloned\r\n but the features in this list will not be set up on cloned web app." type: array items: $ref: '#/definitions/SiteCloneabilityCriterion' blockingCharacteristics: description: List of blocking application characteristics type: array items: $ref: '#/definitions/SiteCloneabilityCriterion' SiteCloneabilityCriterion: description: Represents a site cloneability criterion type: object properties: name: description: Name of criterion type: string description: description: Description of criterion type: string CsmSiteRecoveryEntity: description: Class containing details about site recovery operation. type: object properties: snapshotTime: format: date-time description: Point in time in which the site recover should be attempted. type: string recoverConfig: description: >- If true, then the website's configuration will be reverted to its state at SnapshotTime type: boolean siteName: description: >- [Optional] Destination web app name into which web app should be recovered. This is case when new web app should be created instead. type: string slotName: description: >- [Optional] Destination web app slot name into which web app should be recovered type: string DeletedSiteCollection: description: Collection of deleted sites type: object properties: value: description: Collection of resources type: array items: $ref: '#/definitions/DeletedSite' nextLink: description: Link to next page of resources type: string DeletedSite: description: Reports deleted site including the timestamp of operation type: object allOf: - $ref: '#/definitions/Resource' properties: properties: required: - usageState - availabilityState properties: deletedTimestamp: format: date-time description: Time when the site was deleted type: string name: description: Name of web app type: string state: description: State of the web app type: string readOnly: true hostNames: description: Hostnames associated with web app type: array items: type: string readOnly: true repositorySiteName: description: Name of repository site type: string readOnly: true usageState: description: State indicating whether web app has exceeded its quota usage enum: - Normal - Exceeded type: string readOnly: true x-ms-enum: name: UsageState modelAsString: false enabled: description: >- True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). type: boolean enabledHostNames: description: "Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled\r\n the app is not served on those hostnames" type: array items: type: string readOnly: true availabilityState: description: "Management information availability state for the web app. Possible values are Normal or Limited. \r\n Normal means that the site is running correctly and that management information for the site is available. \r\n Limited means that only partial management information for the site is available and that detailed site information is unavailable." enum: - Normal - Limited - DisasterRecoveryMode type: string readOnly: true x-ms-enum: name: SiteAvailabilityState modelAsString: false hostNameSslStates: description: >- Hostname SSL states are used to manage the SSL bindings for site's hostnames. type: array items: $ref: '#/definitions/HostNameSslState' serverFarmId: type: string lastModifiedTimeUtc: format: date-time description: Last time web app was modified in UTC type: string readOnly: true siteConfig: $ref: '#/definitions/SiteConfig' description: Configuration of web app trafficManagerHostNames: description: >- Read-only list of Azure Traffic manager hostnames associated with web app type: array items: type: string readOnly: true premiumAppDeployed: description: If set indicates whether web app is deployed as a premium app type: boolean readOnly: true scmSiteAlsoStopped: description: >- If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. type: boolean targetSwapSlot: description: >- Read-only property that specifies which slot this app will swap into type: string readOnly: true hostingEnvironmentProfile: $ref: '#/definitions/HostingEnvironmentProfile' description: >- Specification for the hosting environment (App Service Environment) to use for the web app microService: description: '' type: string gatewaySiteName: description: Name of gateway app associated with web app type: string clientAffinityEnabled: description: >- Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app type: boolean clientCertEnabled: description: Specifies if the client certificate is enabled for the web app type: boolean hostNamesDisabled: description: "Specifies if the public hostnames are disabled the web app.\r\n If set to true the app is only accessible via API Management process" type: boolean outboundIpAddresses: description: >- List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. type: string readOnly: true containerSize: format: int32 description: Size of a function container type: integer maxNumberOfWorkers: format: int32 description: "Maximum number of workers\r\n This only applies to function container" type: integer cloningInfo: $ref: '#/definitions/CloningInfo' description: "This is only valid for web app creation. If specified, web app is cloned from \r\n a source web app" resourceGroup: description: Resource group web app belongs to type: string readOnly: true isDefaultContainer: description: Site is a default container type: boolean readOnly: true defaultHostName: description: Default hostname of the web app type: string readOnly: true x-ms-client-flatten: true DeploymentCollection: description: Collection of app deployments type: object properties: value: description: Collection of resources type: array items: $ref: '#/definitions/Deployment' nextLink: description: Link to next page of resources type: string Deployment: description: Represents user credentials used for publishing activity type: object allOf: - $ref: '#/definitions/Resource' properties: properties: properties: id: description: Id type: string status: format: int32 description: Status type: integer message: description: Message type: string author: description: Author type: string deployer: description: Deployer type: string author_email: description: AuthorEmail type: string start_time: format: date-time description: StartTime type: string end_time: format: date-time description: EndTime type: string active: description: Active type: boolean details: description: Detail type: string x-ms-client-flatten: true SiteInstanceCollection: description: Collection of site instances type: object properties: value: description: Collection of resources type: array items: $ref: '#/definitions/SiteInstance' nextLink: description: Link to next page of resources type: string SiteInstance: description: Instance of a web app type: object allOf: - $ref: '#/definitions/Resource' properties: properties: properties: name: description: Name of instance type: string x-ms-client-flatten: true HostNameBindingCollection: description: Collection of host name bindings type: object properties: value: description: Collection of resources type: array items: $ref: '#/definitions/HostNameBinding' nextLink: description: Link to next page of resources type: string HostNameBinding: description: A host name binding object type: object allOf: - $ref: '#/definitions/Resource' properties: properties: properties: name: description: Hostname type: string siteName: description: Web app name type: string domainId: description: Fully qualified ARM domain resource URI type: string azureResourceName: description: Azure resource name type: string azureResourceType: description: Azure resource type enum: - Website - TrafficManager type: string x-ms-enum: name: AzureResourceType modelAsString: false customHostNameDnsRecordType: description: Custom DNS record type enum: - CName - A type: string x-ms-enum: name: CustomHostNameDnsRecordType modelAsString: false hostNameType: description: Host name type enum: - Verified - Managed type: string x-ms-enum: name: HostNameType modelAsString: false x-ms-client-flatten: true SiteSourceControl: description: Describes the source control configuration for web app type: object allOf: - $ref: '#/definitions/Resource' properties: properties: properties: repoUrl: description: Repository or source control url type: string branch: description: Name of branch to use for deployment type: string isManualIntegration: description: Whether to manual or continuous integration type: boolean deploymentRollbackEnabled: description: Whether to manual or continuous integration type: boolean isMercurial: description: Mercurial or Git repository type type: boolean x-ms-client-flatten: true StringDictionary: description: String dictionary resource type: object allOf: - $ref: '#/definitions/Resource' properties: properties: description: Settings type: object additionalProperties: type: string x-ms-client-flatten: true ConnectionStringDictionary: description: String dictionary resource type: object allOf: - $ref: '#/definitions/Resource' properties: properties: description: Connection strings type: object additionalProperties: $ref: '#/definitions/ConnStringValueTypePair' x-ms-client-flatten: true ConnStringValueTypePair: description: Database connection string value to type pair required: - type type: object properties: value: description: Value of pair type: string type: description: Type of database enum: - MySql - SQLServer - SQLAzure - Custom type: string x-ms-enum: name: DatabaseServerType modelAsString: false SiteLogsConfig: description: Configuration of Azure web site type: object allOf: - $ref: '#/definitions/Resource' properties: properties: properties: applicationLogs: $ref: '#/definitions/ApplicationLogsConfig' description: Application logs configuration httpLogs: $ref: '#/definitions/HttpLogsConfig' description: Http logs configuration failedRequestsTracing: $ref: '#/definitions/EnabledConfig' description: Failed requests tracing configuration detailedErrorMessages: $ref: '#/definitions/EnabledConfig' description: Detailed error messages configuration x-ms-client-flatten: true ApplicationLogsConfig: description: Application logs configuration type: object properties: fileSystem: $ref: '#/definitions/FileSystemApplicationLogsConfig' description: Application logs to file system configuration azureTableStorage: $ref: '#/definitions/AzureTableStorageApplicationLogsConfig' description: Application logs to azure table storage configuration azureBlobStorage: $ref: '#/definitions/AzureBlobStorageApplicationLogsConfig' description: Application logs to blob storage configuration HttpLogsConfig: description: Http logs configuration type: object properties: fileSystem: $ref: '#/definitions/FileSystemHttpLogsConfig' description: Http logs to file system configuration azureBlobStorage: $ref: '#/definitions/AzureBlobStorageHttpLogsConfig' description: Http logs to azure blob storage configuration EnabledConfig: description: Enabled configuration type: object properties: enabled: description: Enabled type: boolean FileSystemApplicationLogsConfig: description: Application logs to file system configuration type: object properties: level: description: Log level enum: - 'Off' - Verbose - Information - Warning - Error type: string x-ms-enum: name: LogLevel modelAsString: false AzureTableStorageApplicationLogsConfig: description: Application logs to azure table storage configuration type: object properties: level: description: Log level enum: - 'Off' - Verbose - Information - Warning - Error type: string x-ms-enum: name: LogLevel modelAsString: false sasUrl: description: SAS url to an azure table with add/query/delete permissions type: string AzureBlobStorageApplicationLogsConfig: description: Application logs azure blob storage configuration type: object properties: level: description: Log level enum: - 'Off' - Verbose - Information - Warning - Error type: string x-ms-enum: name: LogLevel modelAsString: false sasUrl: description: >- SAS url to a azure blob container with read/write/list/delete permissions type: string retentionInDays: format: int32 description: "Retention in days.\r\n Remove blobs older than X days.\r\n 0 or lower means no retention." type: integer FileSystemHttpLogsConfig: description: Http logs to file system configuration type: object properties: retentionInMb: format: int32 description: "Maximum size in megabytes that http log files can use.\r\n When reached old log files will be removed to make space for new ones.\r\n Value can range between 25 and 100." type: integer retentionInDays: format: int32 description: "Retention in days.\r\n Remove files older than X days.\r\n 0 or lower means no retention." type: integer enabled: description: Enabled type: boolean AzureBlobStorageHttpLogsConfig: description: Http logs to azure blob storage configuration type: object properties: sasUrl: description: >- SAS url to a azure blob container with read/write/list/delete permissions type: string retentionInDays: format: int32 description: "Retention in days.\r\n Remove blobs older than X days.\r\n 0 or lower means no retention." type: integer enabled: description: Enabled type: boolean PremierAddOnRequest: type: object properties: location: description: Geo region resource belongs to e.g. SouthCentralUS, SouthEastAsia type: string tags: description: Tags associated with resource type: object additionalProperties: type: string plan: $ref: '#/definitions/ArmPlan' description: Azure resource manager plan properties: $ref: '#/definitions/Object' description: Resource specific properties sku: $ref: '#/definitions/SkuDescription' description: Sku description of the resource BackupRequest: description: Description of a backup which will be performed type: object allOf: - $ref: '#/definitions/Resource' properties: properties: required: - type properties: name: description: Name of the backup type: string enabled: description: >- True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled type: boolean storageAccountUrl: description: SAS URL to the container type: string backupSchedule: $ref: '#/definitions/BackupSchedule' description: Schedule for the backup if it is executed periodically databases: description: Databases included in the backup type: array items: $ref: '#/definitions/DatabaseBackupSetting' type: description: Type of the backup enum: - Default - Clone - Relocation type: string x-ms-enum: name: BackupRestoreOperationType modelAsString: false x-ms-client-flatten: true BackupSchedule: description: >- Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy. required: - frequencyUnit type: object properties: frequencyInterval: format: int32 description: >- How often should be the backup executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day) type: integer frequencyUnit: description: >- How often should be the backup executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7) enum: - Day - Hour type: string x-ms-enum: name: FrequencyUnit modelAsString: false keepAtLeastOneBackup: description: >- True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. type: boolean retentionPeriodInDays: format: int32 description: After how many days backups should be deleted type: integer startTime: format: date-time description: When the schedule should start working type: string lastExecutionTime: format: date-time description: The last time when this schedule was triggered type: string DatabaseBackupSetting: description: "Note: properties are serialized in JSON format and stored in DB. \r\n if new properties are added they might not be in the previous data rows \r\n so please handle nulls" type: object properties: databaseType: description: SqlAzure / MySql type: string name: type: string connectionStringName: description: "Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.\r\n This is used during restore with overwrite connection strings options." type: string connectionString: description: >- Contains a connection string to a database which is being backed up/restored. If the restore should happen to a new database, the database name inside is the new one. type: string BackupItem: description: Backup description type: object allOf: - $ref: '#/definitions/Resource' properties: properties: required: - status properties: id: format: int32 description: Id of the backup. type: integer storageAccountUrl: description: >- SAS URL for the storage account container which contains this backup type: string blobName: description: Name of the blob which contains data for this backup type: string name: description: Name of this backup type: string status: description: Backup status enum: - InProgress - Failed - Succeeded - TimedOut - Created - Skipped - PartiallySucceeded - DeleteInProgress - DeleteFailed - Deleted type: string x-ms-enum: name: BackupItemStatus modelAsString: false sizeInBytes: format: int64 description: Size of the backup in bytes type: integer created: format: date-time description: Timestamp of the backup creation type: string log: description: Details regarding this backup. Might contain an error message. type: string databases: description: List of databases included in the backup type: array items: $ref: '#/definitions/DatabaseBackupSetting' scheduled: description: >- True if this backup has been created due to a schedule being triggered. type: boolean lastRestoreTimeStamp: format: date-time description: Timestamp of a last restore operation which used this backup. type: string finishedTimeStamp: format: date-time description: Timestamp when this backup finished. type: string correlationId: description: >- Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support. type: string websiteSizeInBytes: format: int64 description: Size of the original web app which has been backed up type: integer x-ms-client-flatten: true RestoreRequest: description: Description of a restore request type: object allOf: - $ref: '#/definitions/Resource' properties: properties: required: - operationType properties: storageAccountUrl: description: SAS URL to the container type: string blobName: description: Name of a blob which contains the backup type: string overwrite: description: >- True if the restore operation can overwrite target site. "True" needed if trying to restore over an existing site. type: boolean siteName: description: Name of a site (Web App) type: string databases: description: >- Collection of databases which should be restored. This list has to match the list of databases included in the backup. type: array items: $ref: '#/definitions/DatabaseBackupSetting' ignoreConflictingHostNames: description: "Changes a logic when restoring a site with custom domains. If \"true\", custom domains are removed automatically. If \"false\", custom domains are added to \r\n the site object when it is being restored, but that might fail due to conflicts during the operation." type: boolean operationType: description: Operation type enum: - Default - Clone - Relocation type: string x-ms-enum: name: BackupRestoreOperationType modelAsString: false adjustConnectionStrings: description: >- Gets or sets a flag showing if SiteConfig.ConnectionStrings should be set in new site type: boolean hostingEnvironment: description: >- App Service Environment name, if needed (only when restoring a site to an App Service Environment) type: string x-ms-client-flatten: true BackupItemCollection: description: Collection of Backup Items type: object properties: value: description: Collection of resources type: array items: $ref: '#/definitions/BackupItem' nextLink: description: Link to next page of resources type: string RestoreResponse: description: Response for a restore site request type: object allOf: - $ref: '#/definitions/Resource' properties: properties: properties: operationId: description: >- When server starts the restore process, it will return an OperationId identifying that particular restore operation type: string x-ms-client-flatten: true CsmPublishingProfileOptions: description: Publishing options for requested profile type: object properties: format: description: "Name of the format. Valid values are: \r\n FileZilla3\r\n WebDeploy -- default\r\n Ftp" type: string TopLevelDomainCollection: description: Collection of Top Level Domains type: object properties: value: description: Collection of resources type: array items: $ref: '#/definitions/TopLevelDomain' nextLink: description: Link to next page of resources type: string TopLevelDomain: description: A top level domain object type: object allOf: - $ref: '#/definitions/Resource' properties: properties: properties: name: description: Name of the top level domain type: string privacy: description: If true then the top level domain supports domain privacy type: boolean x-ms-client-flatten: true TopLevelDomainAgreementOption: description: Options for retrieving the list of top level domain legal agreements type: object properties: includePrivacy: description: >- If true then the list of agreements will include agreements for domain privacy as well. type: boolean TldLegalAgreementCollection: description: Collection of Tld Legal Agreements type: object properties: value: description: Collection of resources type: array items: $ref: '#/definitions/TldLegalAgreement' nextLink: description: Link to next page of resources type: string TldLegalAgreement: description: Represents a legal agreement for top level domain type: object properties: agreementKey: description: Unique identifier for the agreement type: string title: description: Agreement title type: string content: description: Agreement details type: string url: description: Url where a copy of the agreement details is hosted type: string Resource: required: - location properties: id: description: Resource Id type: string name: description: Resource Name type: string kind: description: Kind of resource type: string location: description: Resource Location type: string type: description: Resource type type: string tags: description: Resource tags type: object additionalProperties: type: string x-ms-azure-resource: true parameters: subscriptionIdParameter: name: subscriptionId in: path description: Subscription Id required: true type: string apiVersionParameter: name: api-version in: query description: API Version required: true type: string securityDefinitions: azure_auth: type: oauth2 description: Azure Active Directory OAuth2 Flow flow: implicit authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize scopes: user_impersonation: impersonate your user account security: - azure_auth: - user_impersonation tags: - name: CertificateOrders - name: Certificates - name: ClassicMobileServices - name: Domains - name: Global - name: GlobalCertificateOrder - name: GlobalDomainRegistration - name: GlobalResourceGroups - name: HostingEnvironments - name: ManagedHostingEnvironments - name: Provider - name: Recommendations - name: ServerFarms - name: Sites - name: TopLevelDomains - name: Usage