diff --git a/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/changeanalysis.json b/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/changeanalysis.json new file mode 100644 index 000000000000..5e9311a95e5a --- /dev/null +++ b/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/changeanalysis.json @@ -0,0 +1,519 @@ +{ + "swagger": "2.0", + "info": { + "title": "AzureChangeAnalysisManagementClient", + "version": "2020-04-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.ChangeAnalysis/profile/{profileName}": { + "get": { + "tags": [ + "ConfigurationProfile" + ], + "summary": "Gets the configuration profile for the Microsoft.ChangeAnalysis resource provider. The profile name should be always set to 'default'.", + "operationId": "ConfigurationProfile_Get", + "produces": [ + "application/json", + "default" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProfileNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ConfigurationProfileResource" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "ConfigurationProfile_Get": { + "$ref": "./examples/ConfigurationProfileGet.json" + } + } + }, + "put": { + "tags": [ + "ConfigurationProfile" + ], + "summary": "Updates configuration profile for for the Microsoft.ChangeAnalysis resource provider. The profile name should be always set to 'default'.", + "operationId": "ConfigurationProfile_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json", + "default" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProfileNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Request body containing new configuration profile.", + "schema": { + "$ref": "#/definitions/ConfigurationProfileResource" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ConfigurationProfileResource" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "ConfigurationProfile_Create": { + "$ref": "./examples/ConfigurationProfileCreate.json" + }, + "ConfigurationProfile_CreateWithIdentity": { + "$ref": "./examples/ConfigurationProfileCreateWithIdentity.json" + } + } + }, + "patch": { + "tags": [ + "ConfigurationProfile" + ], + "summary": "Updates a configuration profile with the specified parameters. The profile name should be always set to 'default'", + "operationId": "ConfigurationProfile_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json", + "default" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProfileNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "The parameters for updating a configuration store.", + "schema": { + "$ref": "#/definitions/ConfigurationProfileResource" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ConfigurationProfileResource" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "ConfigurationProfile_Update": { + "$ref": "./examples/ConfigurationProfileUpdate.json" + }, + "ConfigurationProfile_UpdateWithIdentity": { + "$ref": "./examples/ConfigurationProfileUpdateWithIdentity.json" + } + } + }, + "delete": { + "tags": [ + "ConfigurationProfile" + ], + "summary": "Deletes existing configuration profile. The profile name should be always set to 'default'", + "operationId": "ConfigurationProfile_Delete", + "produces": [ + "default" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ProfileNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "204": { + "description": "No Content - the specified resource was not found." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "ConfigurationProfile_Delete": { + "$ref": "./examples/ConfigurationProfileDelete.json" + } + } + } + }, + "/providers/Microsoft.ChangeAnalysis/operations": { + "get": { + "tags": [ + "Operations" + ], + "summary": "Lists all the supported operations by the Microsoft.ChangeAnalysis resource provider along with their descriptions.", + "operationId": "Operations_List", + "produces": [ + "application/json", + "default" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "query", + "name": "$skipToken", + "description": "A skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.", + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ResourceProviderOperationList" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/OperationsList.json" + } + } + } + } + }, + "definitions": { + "ResourceIdentity": { + "description": "The identity block returned by ARM resource that supports managed identity.", + "type": "object", + "properties": { + "type": { + "description": "The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities.", + "enum": [ + "None", + "SystemAssigned" + ], + "type": "string", + "x-ms-enum": { + "name": "ManagedIdentityTypes", + "modelAsString": true + } + }, + "principalId": { + "format": "uuid", + "description": "The principal id of the identity. This property will only be provided for a system-assigned identity.", + "type": "string", + "readOnly": true + }, + "tenantId": { + "format": "uuid", + "description": "The tenant id associated with the resource's identity. This property will only be provided for a system-assigned identity.", + "type": "string", + "readOnly": true + } + } + }, + "AzureMonitorWorkspaceProperties": { + "description": "Configuration properties of an Azure Monitor workspace that receives change notifications.", + "type": "object", + "properties": { + "workspaceId": { + "description": "The Azure Monitor workspace ID - the unique identifier for the Log Analytics workspace.", + "type": "string" + }, + "workspaceResourceId": { + "description": "The Azure Monitor workspace ARM Resource ID. The resource ID should be in the following format: /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}", + "type": "string" + } + } + }, + "NotificationsState": { + "description": "The state of notifications feature.", + "enum": [ + "None", + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "NotificationsState", + "modelAsString": true + } + }, + "NotificationSettings": { + "description": "Settings of change notification configuration for a subscription.", + "type": "object", + "properties": { + "azureMonitorWorkspaceProperties": { + "$ref": "#/definitions/AzureMonitorWorkspaceProperties" + }, + "activationState": { + "$ref": "#/definitions/NotificationsState" + } + } + }, + "ConfigurationProfileResourceProperties": { + "description": "The properties of a configuration profile.", + "type": "object", + "properties": { + "notifications": { + "$ref": "#/definitions/NotificationSettings" + } + } + }, + "SystemData": { + "description": "Top level metadata https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#system-metadata-for-all-azure-resources", + "type": "object", + "properties": { + "createdBy": { + "description": "A string identifier for the identity that created the resource", + "type": "string", + "readOnly": true + }, + "createdByType": { + "description": "The type of identity that created the resource: user, application, managedIdentity, key", + "type": "string", + "readOnly": true + }, + "createdAt": { + "format": "date-time", + "description": "The timestamp of resource creation (UTC)", + "type": "string", + "readOnly": true + }, + "lastModifiedBy": { + "description": "A string identifier for the identity that last modified the resource", + "type": "string", + "readOnly": true + }, + "lastModifiedByType": { + "description": "The type of identity that last modified the resource: user, application, managedIdentity, key", + "type": "string", + "readOnly": true + }, + "lastModifiedAt": { + "format": "date-time", + "description": "The timestamp of resource last modification (UTC)", + "type": "string", + "readOnly": true + } + } + }, + "ConfigurationProfileResource": { + "description": "A profile object that contains change analysis configuration, such as notification settings, for this subscription", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "identity": { + "$ref": "#/definitions/ResourceIdentity" + }, + "properties": { + "$ref": "#/definitions/ConfigurationProfileResourceProperties" + } + } + }, + "ProxyResource": { + "description": "An Azure resource.", + "properties": { + "id": { + "description": "Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the resource.", + "type": "string", + "readOnly": true + }, + "systemData": { + "$ref": "#/definitions/SystemData" + } + }, + "x-ms-azure-resource": true + }, + "ResourceProviderOperationDisplay": { + "description": "The resource provider operation details.", + "type": "object", + "properties": { + "provider": { + "description": "Name of the resource provider.", + "type": "string" + }, + "resource": { + "description": "Name of the resource type.", + "type": "string" + }, + "operation": { + "description": "Name of the resource provider operation.", + "type": "string" + }, + "description": { + "description": "Description of the resource provider operation.", + "type": "string" + } + } + }, + "ResourceProviderOperationDefinition": { + "description": "The resource provider operation definition.", + "type": "object", + "properties": { + "name": { + "description": "The resource provider operation name.", + "type": "string" + }, + "display": { + "$ref": "#/definitions/ResourceProviderOperationDisplay" + } + } + }, + "ResourceProviderOperationList": { + "description": "The resource provider operation list.", + "type": "object", + "properties": { + "value": { + "description": "Resource provider operations list.", + "type": "array", + "items": { + "$ref": "#/definitions/ResourceProviderOperationDefinition" + } + }, + "nextLink": { + "description": "The URI that can be used to request the next page for list of Azure operations.", + "type": "string" + } + } + }, + "Error": { + "description": "Unexpected Microsoft.ChangeAnalysis Resource Provider Error.", + "properties": { + "code": { + "description": "Error code.", + "type": "string" + }, + "message": { + "description": "Error message.", + "type": "string" + } + } + } + }, + "parameters": { + "ProfileNameParameter": { + "in": "path", + "name": "profileName", + "description": "The name of the configuration profile. The profile name should be set to 'default', all other names will be overwritten.", + "required": true, + "type": "string", + "pattern": "^(?!.*-$)[^-][a-zA-Z0-9-]*$", + "x-ms-parameter-location": "method" + }, + "SubscriptionIdParameter": { + "in": "path", + "name": "subscriptionId", + "description": "The Microsoft Azure subscription ID.", + "required": true, + "type": "string" + }, + "ApiVersionParameter": { + "in": "query", + "name": "api-version", + "description": "The resource provider API version.", + "required": true, + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileCreate.json b/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileCreate.json new file mode 100644 index 000000000000..bd24d84d7d07 --- /dev/null +++ b/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileCreate.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882", + "profileName": "default", + "api-version": "2020-04-01-preview", + "resource": {} + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.AppConfiguration/profile", + "properties": { + "notifications": { + "azureMonitorWorkspaceProperties": { + "workspaceId": null, + "workspaceResourceId": null + }, + "activationState": "None" + } + }, + "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/providers/Microsoft.ChangeAnalysis/profile/default", + "name": "default" + } + } + } +} diff --git a/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileCreateWithIdentity.json b/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileCreateWithIdentity.json new file mode 100644 index 000000000000..09c9f23cba8d --- /dev/null +++ b/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileCreateWithIdentity.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882", + "profileName": "default", + "api-version": "2020-04-01-preview", + "resource": { + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ChangeAnalysis/profile", + "properties": { + "notifications": { + "azureMonitorWorkspaceProperties": { + "workspaceId": null, + "workspaceResourceId": null + }, + "activationState": "None" + } + }, + "identity": { + "principalId": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA", + "tenantId": "BBBBBBBB-BBBB-BBBB-BBBB-BBBBBBBBBBBB", + "type": "SystemAssigned" + }, + "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/providers/Microsoft.ChangeAnalysis/profile/default", + "name": "default" + } + } + } +} diff --git a/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileDelete.json b/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileDelete.json new file mode 100644 index 000000000000..a30a48f30bf0 --- /dev/null +++ b/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileDelete.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882", + "profileName": "default", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileGet.json b/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileGet.json new file mode 100644 index 000000000000..9cc400f02bac --- /dev/null +++ b/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882", + "profileName": "default", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ChangeAnalysis/profile", + "properties": { + "notifications": { + "azureMonitorWorkspaceProperties": { + "workspaceId": null, + "workspaceResourceId": null + }, + "activationState": "None" + } + }, + "identity": { + "principalId": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA", + "tenantId": "BBBBBBBB-BBBB-BBBB-BBBB-BBBBBBBBBBBB", + "type": "SystemAssigned" + }, + "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/providers/Microsoft.ChangeAnalysis/profile/default", + "name": "default" + } + } + } +} diff --git a/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileUpdate.json b/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileUpdate.json new file mode 100644 index 000000000000..000c465f20ca --- /dev/null +++ b/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileUpdate.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882", + "profileName": "default", + "api-version": "2020-04-01-preview", + "resource": { + "properties": { + "notifications": { + "azureMonitorWorkspaceProperties": { + "workspaceId": "workspaceIdValue", + "workspaceResourceId": "workspace resource Id" + }, + "activationState": "Enabled" + } + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ChangeAnalysis/profile", + "properties": { + "notifications": { + "azureMonitorWorkspaceProperties": { + "workspaceId": "workspaceIdValue", + "workspaceResourceId": "workspace resource Id" + }, + "activationState": "Enabled" + } + } + }, + "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/providers/Microsoft.ChangeAnalysis/profile/default", + "name": "default" + } + } +} diff --git a/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileUpdateWithIdentity.json b/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileUpdateWithIdentity.json new file mode 100644 index 000000000000..3b06d6733ce9 --- /dev/null +++ b/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/ConfigurationProfileUpdateWithIdentity.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882", + "profileName": "default", + "api-version": "2020-04-01-preview", + "resource": { + "properties": { + "notifications": { + "azureMonitorWorkspaceProperties": { + "workspaceId": "workspaceIdValue", + "workspaceResourceId": "workspace resource Id" + }, + "activationState": "Enabled" + } + }, + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ChangeAnalysis/profile", + "properties": { + "notifications": { + "azureMonitorWorkspaceProperties": { + "workspaceId": "workspaceIdValue", + "workspaceResourceId": "workspace resource Id" + }, + "activationState": "Enabled" + } + }, + "identity": { + "principalId": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA", + "tenantId": "BBBBBBBB-BBBB-BBBB-BBBB-BBBBBBBBBBBB", + "type": "SystemAssigned" + }, + "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/providers/Microsoft.ChangeAnalysis/profile/default", + "name": "default" + } + } + } +} diff --git a/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/OperationsList.json b/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/OperationsList.json new file mode 100644 index 000000000000..2d2000363115 --- /dev/null +++ b/specification/changeanalysis/resource-manager/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/examples/OperationsList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2020-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.ChangeAnalysis/profile/read", + "display": { + "provider": "Microsoft Change Analysis", + "resource": "Azure Application Change Analysis Service Configuration Profile", + "operation": "Read Azure Application Change Analysis Servie Configuration Profile" + } + }, + { + "name": "Microsoft.ChangeAnalysis/profile/write", + "display": { + "provider": "Microsoft Change Analysis", + "resource": "Azure Application Change Analysis Service Configuration Profile", + "operation": "Create or Update Azure Application Change Analysis Servie Configuration Profile Properties" + } + }, + { + "name": "Microsoft.ChangeAnalysis/register/action", + "display": { + "provider": "Microsoft Change Analysis", + "resource": "", + "operation": "Register Microsoft Change Analysis resource provider with a subscriptions" + } + } + ] + } + } + } +} diff --git a/specification/changeanalysis/resource-manager/readme.csharp.md b/specification/changeanalysis/resource-manager/readme.csharp.md new file mode 100644 index 000000000000..8e5139845e12 --- /dev/null +++ b/specification/changeanalysis/resource-manager/readme.csharp.md @@ -0,0 +1,15 @@ +## C + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +```yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 1 + clear-output-folder: true + client-side-validation: false + namespace: Microsoft.ChangeAnalysis + output-folder: $(csharp-sdks-folder)/changeanalysis/management/Microsoft.ChangeAnalysis/GeneratedProtocol +``` diff --git a/specification/changeanalysis/resource-manager/readme.go.md b/specification/changeanalysis/resource-manager/readme.go.md new file mode 100644 index 000000000000..c2b2c0df4332 --- /dev/null +++ b/specification/changeanalysis/resource-manager/readme.go.md @@ -0,0 +1,19 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +```yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + clear-output-folder: true +``` + +### Tag: package-2020-04-01-preview and go + +These settings apply only when `--tag=package-2020-04-01-preview --go` is specified on the command line. +Please also specify `--go-sdks-folder=`. + +```yaml $(tag) == 'package-2020-04-01-preview' && $(go) +namespace: Microsoft.ChangeAnalysis +output-folder: $(go-sdks-folder)/changeanalysis/Generated +``` diff --git a/specification/changeanalysis/resource-manager/readme.md b/specification/changeanalysis/resource-manager/readme.md new file mode 100644 index 000000000000..f8d14def5168 --- /dev/null +++ b/specification/changeanalysis/resource-manager/readme.md @@ -0,0 +1,115 @@ +# changeanalysis + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for changeanalysis. + +## Getting Started + +To build the SDKs for My API, simply install AutoRest via `npm` (`npm install -g autorest`) and then run: + +> `autorest readme.md` + +To see additional help and options, run: + +> `autorest --help` + +For other options on installation see [Installing AutoRest](https://aka.ms/autorest/install) on the AutoRest github page. + +--- + +## Configuration + +### Basic Information + +These are the global settings for the changeanalysis. + +``` yaml +openapi-type: arm +tag: package-2020-04-01-preview +``` + +### Tag: package-2020-04-01-preview + +These settings apply only when `--tag=package-2020-04-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2020-04-01-preview' +input-file: + - Microsoft.ChangeAnalysis/preview/2020-04-01-preview/changeanalysis.json + +``` + +--- + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_changeanalysis'] +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## Ruby + +See configuration in [readme.ruby.md](./readme.ruby.md) + +## TypeScript + +See configuration in [readme.typescript.md](./readme.typescript.md) + +## CSharp + +See configuration in [readme.csharp.md](./readme.csharp.md) + +## Suppression + +``` yaml +directive: + - suppress: BodyTopLevelProperties + where: $.definitions.ConfigurationProfileResource.properties + from: changeanalysis.json + reason: |- + https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#system-metadata-for-all-azure-resources + + The systemData should be top level element based on the new requirement: + { + "id": "/subscriptions/{id}/resourceGroups/{group}/providers/{rpns}/{type}/{name}", + "name": "{name}", + "type": "{resourceProviderNamespace}/{resourceType}", + "location": "North US", + "systemData":{ + "createdBy": "", + "createdByType": "", + "createdAt": "", + "lastModifiedBy": "", + "lastModifiedByType": "", + "lastModifiedAt": "" + }, + "tags": { + "key1": "value 1", + "key2": "value 2" + }, + "kind": "resource kind", + "properties": { + "comment": "Resource defined structure" + } + } +``` diff --git a/specification/changeanalysis/resource-manager/readme.python.md b/specification/changeanalysis/resource-manager/readme.python.md new file mode 100644 index 000000000000..5bfa3618bd78 --- /dev/null +++ b/specification/changeanalysis/resource-manager/readme.python.md @@ -0,0 +1,21 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +```yaml $(python) +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: Microsoft.ChangeAnalysis + package-name: changeanalysis + package-version: 2020-04-01-preview + clear-output-folder: true +``` + +```yaml $(python) +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt/changeanalysis +``` diff --git a/specification/changeanalysis/resource-manager/readme.ruby.md b/specification/changeanalysis/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..7b7265a1b2ca --- /dev/null +++ b/specification/changeanalysis/resource-manager/readme.ruby.md @@ -0,0 +1,19 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +```yaml +package-name: azure_mgmt_changeanalysis +package-version: 2020-04-01-preview +azure-arm: true +``` + +### Tag: package-2020-04-01-preview and ruby + +These settings apply only when `--tag=package-2020-04-01-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +```yaml $(tag) == 'package-2020-04-01-preview' && $(ruby) +namespace: Microsoft.ChangeAnalysis +output-folder: $(ruby-sdks-folder)/changeanalysis +``` diff --git a/specification/changeanalysis/resource-manager/readme.typescript.md b/specification/changeanalysis/resource-manager/readme.typescript.md new file mode 100644 index 000000000000..63e73c265818 --- /dev/null +++ b/specification/changeanalysis/resource-manager/readme.typescript.md @@ -0,0 +1,13 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +```yaml $(typescript) +typescript: + azure-arm: true + package-name: "changeanalysis" + output-folder: "$(typescript-sdks-folder)/packages/changeanalysis" + payload-flattening-threshold: 1 + generate-metadata: true +```