{ "swagger": "2.0", "info": { "title": "Microsoft.AwsConnector", "version": "2024-12-01", "description": "Microsoft.AwsConnector 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": "ElasticBeanstalkConfigurationTemplates" } ], "paths": { "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/elasticBeanstalkConfigurationTemplates": { "get": { "operationId": "ElasticBeanstalkConfigurationTemplates_ListBySubscription", "tags": [ "ElasticBeanstalkConfigurationTemplates" ], "description": "List ElasticBeanstalkConfigurationTemplate resources by subscription ID", "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/ElasticBeanstalkConfigurationTemplateListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ElasticBeanstalkConfigurationTemplates_ListBySubscription": { "$ref": "./examples/ElasticBeanstalkConfigurationTemplates_ListBySubscription.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/elasticBeanstalkConfigurationTemplates": { "get": { "operationId": "ElasticBeanstalkConfigurationTemplates_ListByResourceGroup", "tags": [ "ElasticBeanstalkConfigurationTemplates" ], "description": "List ElasticBeanstalkConfigurationTemplate resources by resource group", "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/ElasticBeanstalkConfigurationTemplateListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ElasticBeanstalkConfigurationTemplates_ListByResourceGroup": { "$ref": "./examples/ElasticBeanstalkConfigurationTemplates_ListByResourceGroup.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/elasticBeanstalkConfigurationTemplates/{name}": { "get": { "operationId": "ElasticBeanstalkConfigurationTemplates_Get", "tags": [ "ElasticBeanstalkConfigurationTemplates" ], "description": "Get a ElasticBeanstalkConfigurationTemplate", "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": "name", "in": "path", "description": "Name of ElasticBeanstalkConfigurationTemplate", "required": true, "type": "string", "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ElasticBeanstalkConfigurationTemplate" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "ElasticBeanstalkConfigurationTemplates_Get": { "$ref": "./examples/ElasticBeanstalkConfigurationTemplates_Get.json" } } }, "put": { "operationId": "ElasticBeanstalkConfigurationTemplates_CreateOrReplace", "tags": [ "ElasticBeanstalkConfigurationTemplates" ], "description": "Create a ElasticBeanstalkConfigurationTemplate. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", "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": "name", "in": "path", "description": "Name of ElasticBeanstalkConfigurationTemplate", "required": true, "type": "string", "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" }, { "name": "resource", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/ElasticBeanstalkConfigurationTemplate" } } ], "responses": { "200": { "description": "Resource 'ElasticBeanstalkConfigurationTemplate' update operation succeeded", "schema": { "$ref": "#/definitions/ElasticBeanstalkConfigurationTemplate" } }, "201": { "description": "Resource 'ElasticBeanstalkConfigurationTemplate' create operation succeeded", "schema": { "$ref": "#/definitions/ElasticBeanstalkConfigurationTemplate" }, "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": { "ElasticBeanstalkConfigurationTemplates_CreateOrReplace": { "$ref": "./examples/ElasticBeanstalkConfigurationTemplates_CreateOrReplace.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "ElasticBeanstalkConfigurationTemplates_Update", "tags": [ "ElasticBeanstalkConfigurationTemplates" ], "description": "Update a ElasticBeanstalkConfigurationTemplate", "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": "name", "in": "path", "description": "Name of ElasticBeanstalkConfigurationTemplate", "required": true, "type": "string", "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" }, { "name": "properties", "in": "body", "description": "The resource properties to be updated.", "required": true, "schema": { "$ref": "#/definitions/ElasticBeanstalkConfigurationTemplateTagsUpdate" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ElasticBeanstalkConfigurationTemplate" } }, "202": { "description": "Resource update request accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "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": { "ElasticBeanstalkConfigurationTemplates_Update": { "$ref": "./examples/ElasticBeanstalkConfigurationTemplates_Update.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "ElasticBeanstalkConfigurationTemplates_Delete", "tags": [ "ElasticBeanstalkConfigurationTemplates" ], "description": "Delete a ElasticBeanstalkConfigurationTemplate", "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": "name", "in": "path", "description": "Name of ElasticBeanstalkConfigurationTemplate", "required": true, "type": "string", "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "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": { "ElasticBeanstalkConfigurationTemplates_Delete": { "$ref": "./examples/ElasticBeanstalkConfigurationTemplates_Delete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } } }, "definitions": { "AwsElasticBeanstalkConfigurationTemplateProperties": { "type": "object", "description": "Definition of awsElasticBeanstalkConfigurationTemplate", "properties": { "applicationName": { "type": "string", "description": "The name of the Elastic Beanstalk application to associate with this configuration template." }, "description": { "type": "string", "description": "An optional description for this configuration." }, "environmentId": { "type": "string", "description": "The ID of an environment whose settings you want to use to create the configuration template. You must specify EnvironmentId if you don't specify PlatformArn, SolutionStackName, or SourceConfiguration." }, "optionSettings": { "type": "array", "description": "Option values for the Elastic Beanstalk configuration, such as the instance type. If specified, these values override the values obtained from the solution stack or the source configuration template. For a complete list of Elastic Beanstalk configuration options, see [Option Values](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html) in the AWS Elastic Beanstalk Developer Guide.", "items": { "$ref": "#/definitions/ConfigurationOptionSetting" }, "x-ms-identifiers": [] }, "platformArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the custom platform. For more information, see [Custom Platforms](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html) in the AWS Elastic Beanstalk Developer Guide." }, "solutionStackName": { "type": "string", "description": "The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses. For example, 64bit Amazon Linux 2013.09 running Tomcat 7 Java 7. A solution stack specifies the operating system, runtime, and application server for a configuration template. It also determines the set of configuration options as well as the possible and default values. For more information, see [Supported Platforms](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html) in the AWS Elastic Beanstalk Developer Guide. You must specify SolutionStackName if you don't specify PlatformArn, EnvironmentId, or SourceConfiguration. Use the ListAvailableSolutionStacks API to obtain a list of available solution stacks." }, "sourceConfiguration": { "$ref": "#/definitions/SourceConfiguration", "description": "An Elastic Beanstalk configuration template to base this one on. If specified, Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.Values specified in OptionSettings override any values obtained from the SourceConfiguration.You must specify SourceConfiguration if you don't specify PlatformArn, EnvironmentId, or SolutionStackName.Constraint: If both solution stack name and source configuration are specified, the solution stack of the source configuration template must match the specified solution stack name." }, "templateName": { "type": "string", "description": "The name of the configuration template" } } }, "ConfigurationOptionSetting": { "type": "object", "description": "Definition of ConfigurationOptionSetting", "properties": { "namespace": { "type": "string", "description": "A unique namespace that identifies the option's associated AWS resource." }, "optionName": { "type": "string", "description": "The name of the configuration option." }, "resourceName": { "type": "string", "description": "A unique resource name for the option setting. Use it for a time–based scaling configuration option." }, "value": { "type": "string", "description": "The current value for the configuration option." } } }, "ElasticBeanstalkConfigurationTemplate": { "type": "object", "description": "A Microsoft.AwsConnector resource", "properties": { "properties": { "$ref": "#/definitions/ElasticBeanstalkConfigurationTemplateProperties", "description": "The resource-specific properties for this resource." } }, "allOf": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ] }, "ElasticBeanstalkConfigurationTemplateListResult": { "type": "object", "description": "The response of a ElasticBeanstalkConfigurationTemplate list operation.", "properties": { "value": { "type": "array", "description": "The ElasticBeanstalkConfigurationTemplate items on this page", "items": { "$ref": "#/definitions/ElasticBeanstalkConfigurationTemplate" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ElasticBeanstalkConfigurationTemplateProperties": { "type": "object", "description": "Definition of ElasticBeanstalkConfigurationTemplate", "properties": { "awsProperties": { "$ref": "#/definitions/AwsElasticBeanstalkConfigurationTemplateProperties", "description": "AWS Properties" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsTags": { "type": "object", "description": "AWS Tags", "additionalProperties": { "type": "string" } }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The status of the last operation.", "readOnly": true } } }, "ElasticBeanstalkConfigurationTemplateTagsUpdate": { "type": "object", "description": "The type used for updating tags in ElasticBeanstalkConfigurationTemplate resources.", "properties": { "tags": { "type": "object", "description": "Resource tags.", "additionalProperties": { "type": "string" } } } }, "ProvisioningState": { "type": "string", "description": "The provisioning state of a resource.", "enum": [ "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", "Accepted" ], "x-ms-enum": { "name": "ProvisioningState", "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." }, { "name": "Provisioning", "value": "Provisioning", "description": "The resource is being provisioned" }, { "name": "Updating", "value": "Updating", "description": "The resource is updating" }, { "name": "Deleting", "value": "Deleting", "description": "The resource is being deleted" }, { "name": "Accepted", "value": "Accepted", "description": "The resource create request has been accepted" } ] }, "readOnly": true }, "SourceConfiguration": { "type": "object", "description": "Definition of SourceConfiguration", "properties": { "applicationName": { "type": "string", "description": "The name of the application associated with the configuration." }, "templateName": { "type": "string", "description": "The name of the configuration template." } } } }, "parameters": {} }