{ "swagger": "2.0", "info": { "title": "Edge Sites", "version": "2024-02-01-preview", "description": "Azure Edge Sites Resource Provider management API.", "x-typespec-generated": [ { "emitter": "@azure-tools/typespec-autorest" } ] }, "schemes": [ "https" ], "host": "management.azure.com", "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "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" } } }, "tags": [ { "name": "Sites" } ], "paths": { "/subscriptions/{subscriptionId}/providers/Microsoft.Edge/sites": { "get": { "operationId": "SitesBySubscription_List", "description": "List Site resources by scope", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SiteListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List by Subscription": { "$ref": "./examples/SitesBySubscription_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Edge/sites/{siteName}": { "get": { "operationId": "SitesBySubscription_Get", "description": "Get a Site", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "name": "siteName", "in": "path", "description": "The name of the Site", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]{2,22}[a-zA-Z0-9]$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Site" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get Site Subscription": { "$ref": "./examples/SitesBySubscription_Get.json" } } }, "put": { "operationId": "SitesBySubscription_CreateOrUpdate", "description": "Create a Site", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "name": "siteName", "in": "path", "description": "The name of the Site", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]{2,22}[a-zA-Z0-9]$" }, { "name": "resource", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/Site" } } ], "responses": { "200": { "description": "Resource 'Site' update operation succeeded", "schema": { "$ref": "#/definitions/Site" } }, "201": { "description": "Resource 'Site' create operation succeeded", "schema": { "$ref": "#/definitions/Site" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create Site Subscription": { "$ref": "./examples/SitesBySubscription_CreateOrUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "SitesBySubscription_Update", "description": "Update a Site", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "name": "siteName", "in": "path", "description": "The name of the Site", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]{2,22}[a-zA-Z0-9]$" }, { "name": "properties", "in": "body", "description": "The resource properties to be updated.", "required": true, "schema": { "$ref": "#/definitions/SiteUpdate" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Site" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Patch Site Subscription": { "$ref": "./examples/SitesBySubscription_Update.json" } } }, "delete": { "operationId": "SitesBySubscription_Delete", "description": "Delete a Site", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "name": "siteName", "in": "path", "description": "The name of the Site", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]{2,22}[a-zA-Z0-9]$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete Site Subscription": { "$ref": "./examples/SitesBySubscription_Delete.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/sites": { "get": { "operationId": "Sites_ListByResourceGroup", "tags": [ "Sites" ], "description": "List Site resources by scope", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SiteListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List by Site Subscription": { "$ref": "./examples/Sites_ListByResourceGroup.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Edge/sites/{siteName}": { "get": { "operationId": "Sites_Get", "tags": [ "Sites" ], "description": "Get a Site", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "siteName", "in": "path", "description": "The name of the Site", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]{2,22}[a-zA-Z0-9]$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Site" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get Site": { "$ref": "./examples/Sites_Get.json" } } }, "put": { "operationId": "Sites_CreateOrUpdate", "tags": [ "Sites" ], "description": "Create a Site", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "siteName", "in": "path", "description": "The name of the Site", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]{2,22}[a-zA-Z0-9]$" }, { "name": "resource", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/Site" } } ], "responses": { "200": { "description": "Resource 'Site' update operation succeeded", "schema": { "$ref": "#/definitions/Site" } }, "201": { "description": "Resource 'Site' create operation succeeded", "schema": { "$ref": "#/definitions/Site" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create or update Site": { "$ref": "./examples/Sites_CreateOrUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "Sites_Update", "tags": [ "Sites" ], "description": "Update a Site", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "siteName", "in": "path", "description": "The name of the Site", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]{2,22}[a-zA-Z0-9]$" }, { "name": "properties", "in": "body", "description": "The resource properties to be updated.", "required": true, "schema": { "$ref": "#/definitions/SiteUpdate" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Site" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update Site": { "$ref": "./examples/Sites_Update.json" } } }, "delete": { "operationId": "Sites_Delete", "tags": [ "Sites" ], "description": "Delete a Site", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "siteName", "in": "path", "description": "The name of the Site", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]{2,22}[a-zA-Z0-9]$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete Site": { "$ref": "./examples/Sites_Delete.json" } } } } }, "definitions": { "AvailabilityStatus": { "type": "string", "description": "ResourceType availability status", "enum": [ "ComingSoon", "Supported" ], "x-ms-enum": { "name": "AvailabilityStatus", "modelAsString": true, "values": [ { "name": "ComingSoon", "value": "ComingSoon", "description": "Coming soon if aggregation is going to come in future for the resource-type" }, { "name": "Supported", "value": "Supported", "description": "Supported if aggregation is supported for the resource-type" } ] } }, "Azure.ResourceManager.ResourceProvisioningState": { "type": "string", "description": "The provisioning state of a resource type.", "enum": [ "Succeeded", "Failed", "Canceled" ], "x-ms-enum": { "name": "ResourceProvisioningState", "modelAsString": true, "values": [ { "name": "Succeeded", "value": "Succeeded", "description": "Resource has been created." }, { "name": "Failed", "value": "Failed", "description": "Resource creation failed." }, { "name": "Canceled", "value": "Canceled", "description": "Resource creation was canceled." } ] }, "readOnly": true }, "Site": { "type": "object", "description": "Site as Extension Resource", "properties": { "properties": { "$ref": "#/definitions/SiteProperties", "description": "The resource-specific properties for this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "SiteListResult": { "type": "object", "description": "The response of a Site list operation.", "properties": { "value": { "type": "array", "description": "The Site items on this page", "items": { "$ref": "#/definitions/Site" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "SiteProperties": { "type": "object", "description": "Site properties", "properties": { "displayName": { "type": "string", "description": "displayName of Site resource" }, "description": { "type": "string", "description": "Description of Site resource" }, "addressResourceId": { "type": "string", "format": "arm-id", "description": "AddressResource ArmId of Site resource", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.EdgeOrder/addresses" } ] } }, "provisioningState": { "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState", "description": "Provisioning state of last operation", "readOnly": true } } }, "SiteUpdate": { "type": "object", "description": "The type used for update operations of the Site.", "properties": { "properties": { "$ref": "#/definitions/SiteUpdateProperties", "description": "The updatable properties of the Site." } } }, "SiteUpdateProperties": { "type": "object", "description": "The updatable properties of the Site.", "properties": { "displayName": { "type": "string", "description": "displayName of Site resource" }, "description": { "type": "string", "description": "Description of Site resource" }, "addressResourceId": { "type": "string", "format": "arm-id", "description": "AddressResource ArmId of Site resource", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.EdgeOrder/addresses" } ] } } } } }, "parameters": {} }