diff --git a/custom-words.txt b/custom-words.txt index 3b86e0485a37..5a667072e243 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -640,6 +640,9 @@ failover failovers Fairplay Fanout +farmbeats +Farmbeats +FarmBeats fatherable faultable fconfig diff --git a/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json b/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json new file mode 100644 index 000000000000..2c9eab108ab5 --- /dev/null +++ b/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json @@ -0,0 +1,889 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure AgFoodPlatform RP Service", + "description": "APIs documentation for Azure AgFoodPlatform Resource Provider Service.", + "version": "2020-05-12-preview" + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}/extensions/{extensionId}": { + "put": { + "tags": [ + "Extensions" + ], + "description": "Install extension.", + "operationId": "Extensions_Create", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ExtensionIdParameter" + }, + { + "$ref": "#/parameters/FarmBeatsResourceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Extension" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Extensions_Create": { + "$ref": "./examples/Extensions_Create.json" + } + } + }, + "get": { + "tags": [ + "Extensions" + ], + "description": "Get installed extension details by extension id.", + "operationId": "Extensions_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ExtensionIdParameter" + }, + { + "$ref": "#/parameters/FarmBeatsResourceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Extension" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Extensions_Get": { + "$ref": "./examples/Extensions_Get.json" + } + } + }, + "patch": { + "tags": [ + "Extensions" + ], + "description": "Upgrade to latest extension.", + "operationId": "Extensions_Update", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ExtensionIdParameter" + }, + { + "$ref": "#/parameters/FarmBeatsResourceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Extension" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Extensions_Update": { + "$ref": "./examples/Extensions_Update.json" + } + } + }, + "delete": { + "tags": [ + "Extensions" + ], + "description": "Uninstall extension.", + "operationId": "Extensions_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ExtensionIdParameter" + }, + { + "$ref": "#/parameters/FarmBeatsResourceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "Success" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Extensions_Delete": { + "$ref": "./examples/Extensions_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}/extensions": { + "get": { + "tags": [ + "Extensions" + ], + "description": "Get installed extensions details.", + "operationId": "Extensions_ListByFarmBeats", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FarmBeatsResourceNameParameter" + }, + { + "in": "query", + "name": "extensionId", + "description": "Id of extension resource.", + "type": "string" + }, + { + "in": "query", + "name": "extensionCategory", + "description": "Category of extension (weather/sensor/satellite etc.).", + "type": "string", + "maxLength": 50, + "minLength": 0 + }, + { + "in": "query", + "name": "$maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "$skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ExtensionListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Extensions_ListByFarmBeats": { + "$ref": "./examples/Extensions_ListByFarmBeats.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}": { + "get": { + "tags": [ + "FarmBeatsModels" + ], + "description": "Get FarmBeats resource.", + "operationId": "FarmBeatsModels_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FarmBeatsResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FarmBeats" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "FarmBeatsModels_Get": { + "$ref": "./examples/FarmBeatsModels_Get.json" + } + } + }, + "put": { + "tags": [ + "FarmBeatsModels" + ], + "description": "Create or update FarmBeats resource.", + "operationId": "FarmBeatsModels_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/FarmBeatsResourceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "FarmBeats resource create or update request object.", + "required": true, + "schema": { + "$ref": "#/definitions/FarmBeats" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FarmBeats" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FarmBeats" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "FarmBeatsModels_CreateOrUpdate": { + "$ref": "./examples/FarmBeatsModels_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "FarmBeatsModels" + ], + "description": "Update a FarmBeats resource.", + "operationId": "FarmBeatsModels_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/FarmBeatsResourceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Request object.", + "required": true, + "schema": { + "$ref": "#/definitions/FarmBeatsUpdateRequestModel" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FarmBeats" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "FarmBeatsModels_Update": { + "$ref": "./examples/FarmBeatsModels_Update.json" + } + } + }, + "delete": { + "tags": [ + "FarmBeatsModels" + ], + "description": "Delete a FarmBeats resource.", + "operationId": "FarmBeatsModels_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FarmBeatsResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "Success" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "FarmBeatsModels_Delete": { + "$ref": "./examples/FarmBeatsModels_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AgFoodPlatform/farmBeats": { + "get": { + "tags": [ + "FarmBeatsModels" + ], + "description": "Lists the FarmBeats instances for a subscription.", + "operationId": "FarmBeatsModels_ListBySubscription", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "$maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "$skipToken", + "description": "Skip token for getting next set of results.", + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FarmBeatsListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "FarmBeatsModels_ListBySubscription": { + "$ref": "./examples/FarmBeatsModels_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats": { + "get": { + "tags": [ + "FarmBeatsModels" + ], + "description": "Lists the FarmBeats instances for a resource group.", + "operationId": "FarmBeatsModels_ListByResourceGroup", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "$maxPageSize", + "description": "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50.", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 1000, + "minimum": 10 + }, + { + "in": "query", + "name": "$skipToken", + "description": "Continuation token for getting next set of results.", + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FarmBeatsListResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "FarmBeatsModels_ListByResourceGroup": { + "$ref": "./examples/FarmBeatsModels_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AgFoodPlatform/checkNameAvailability": { + "post": { + "tags": [ + "Locations" + ], + "description": "Checks the name availability of the resource with requested resource name.", + "operationId": "Locations_CheckNameAvailability", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "NameAvailabilityRequest object.", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/CheckNameAvailabilityRequest" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/CheckNameAvailabilityResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Locations_CheckNameAvailability_AlreadyExists": { + "$ref": "./examples/Locations_CheckNameAvailability_AlreadyExists.json" + }, + "Locations_CheckNameAvailability_Available": { + "$ref": "./examples/Locations_CheckNameAvailability_Available.json" + } + } + } + }, + "/providers/Microsoft.AgFoodPlatform/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists the available operations of Microsoft.AgFoodPlatform resource provider.", + "operationId": "Operations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + } + } + } + }, + "definitions": { + "ExtensionProperties": { + "description": "Extension resource properties.", + "type": "object", + "properties": { + "extensionId": { + "description": "Extension Id.", + "pattern": "^[A-za-z]{3,50}[.][A-za-z]{3,100}$", + "type": "string", + "readOnly": true + }, + "extensionCategory": { + "description": "Extension category. e.g. weather/sensor/satellite.", + "type": "string", + "readOnly": true + }, + "installedExtensionVersion": { + "description": "Installed extension version.", + "pattern": "^([1-9]|10).\\d$", + "type": "string", + "readOnly": true + }, + "extensionAuthLink": { + "description": "Extension auth link.", + "type": "string", + "readOnly": true + }, + "extensionApiDocsLink": { + "description": "Extension api docs link.", + "type": "string", + "readOnly": true + } + } + }, + "Extension": { + "description": "Extension resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + }, + "properties": { + "$ref": "#/definitions/ExtensionProperties", + "x-ms-client-flatten": true + }, + "eTag": { + "description": "The ETag value to implement optimistic concurrency.", + "type": "string", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "ExtensionListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "items": { + "$ref": "#/definitions/Extension" + } + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string", + "readOnly": true + } + } + }, + "FarmBeatsProperties": { + "description": "FarmBeats ARM Resource properties.", + "type": "object", + "properties": { + "instanceUri": { + "format": "uri", + "description": "Uri of the FarmBeats instance.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "FarmBeats instance provisioning state.", + "enum": [ + "Succeeded", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + } + } + }, + "FarmBeats": { + "description": "FarmBeats ARM Resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + }, + "properties": { + "$ref": "#/definitions/FarmBeatsProperties", + "x-ms-client-flatten": true + } + }, + "x-ms-azure-resource": true + }, + "FarmBeatsUpdateRequestModel": { + "description": "FarmBeats update request.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "FarmBeatsListResponse": { + "description": "Paged response contains list of requested objects and a URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "description": "List of requested objects.", + "type": "array", + "uniqueItems": false, + "items": { + "$ref": "#/definitions/FarmBeats" + } + }, + "nextLink": { + "description": "Continuation link (absolute URI) to the next page of results in the list.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "FarmBeatsResourceNameParameter": { + "in": "path", + "name": "farmBeatsResourceName", + "description": "FarmBeats resource name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ExtensionIdParameter": { + "in": "path", + "name": "extensionId", + "description": "Id of extension resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "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" + ] + } + ], + "host": "management.azure.com", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] +} diff --git a/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Extensions_Create.json b/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Extensions_Create.json new file mode 100644 index 000000000000..1bf3fe863980 --- /dev/null +++ b/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Extensions_Create.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2020-05-12-preview", + "subscriptionId": "11111111-2222-3333-4444-555555555555", + "resourceGroupName": "examples-rg", + "farmBeatsResourceName": "examples-farmbeatsResourceName", + "extensionId": "provider.extension" + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/examples-rg/Microsoft.AgFoodPlatform/farmBeats/examples-farmbeatsResourceName/extensions/provider.extension", + "name": "provider.extension", + "type": "Microsoft.AgFoodPlatform/farmBeats/extensions", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, + "eTag": "7200b954-0000-0700-0000-603cbbc40000", + "properties": { + "extensionCategory": "Weather", + "installedExtensionVersion": "1.0", + "extensionAuthLink": "https://www.provider.com/extension/", + "extensionApiDocsLink": "https://docs.provider.com/documentation/extension" + } + } + } + } +} diff --git a/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Extensions_Delete.json b/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Extensions_Delete.json new file mode 100644 index 000000000000..acc12ece1dc8 --- /dev/null +++ b/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Extensions_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-05-12-preview", + "subscriptionId": "11111111-2222-3333-4444-555555555555", + "resourceGroupName": "examples-rg", + "farmBeatsResourceName": "examples-farmbeatsResourceName", + "extensionId": "provider.extension" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Extensions_Get.json b/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Extensions_Get.json new file mode 100644 index 000000000000..a9fd49929933 --- /dev/null +++ b/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Extensions_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2020-05-12-preview", + "subscriptionId": "11111111-2222-3333-4444-555555555555", + "resourceGroupName": "examples-rg", + "farmBeatsResourceName": "examples-farmbeatsResourceName", + "extensionId": "provider.extension" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/examples-rg/Microsoft.AgFoodPlatform/farmBeats/examples-farmbeatsResourceName/extensions/provider.extension", + "name": "provider.extension", + "type": "Microsoft.AgFoodPlatform/farmBeats/extensions", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, + "eTag": "7200b954-0000-0700-0000-603cbbc40000", + "properties": { + "extensionCategory": "Weather", + "installedExtensionVersion": "1.0", + "extensionAuthLink": "https://www.provider.com/extension/", + "extensionApiDocsLink": "https://docs.provider.com/documentation/extension" + } + } + } + } +} diff --git a/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Extensions_ListByFarmBeats.json b/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Extensions_ListByFarmBeats.json new file mode 100644 index 000000000000..c3e1f3b78402 --- /dev/null +++ b/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Extensions_ListByFarmBeats.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2020-05-12-preview", + "subscriptionId": "11111111-2222-3333-4444-555555555555", + "resourceGroupName": "examples-rg", + "farmBeatsResourceName": "examples-farmbeatsResourceName" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/examples-rg/Microsoft.AgFoodPlatform/farmBeats/examples-farmbeatsResourceName/extensions/provider.extension", + "name": "provider.extension", + "type": "Microsoft.AgFoodPlatform/farmBeats/extensions", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, + "eTag": "7200b954-0000-0700-0000-603cbbc40000", + "properties": { + "extensionCategory": "Weather", + "installedExtensionVersion": "1.0", + "extensionAuthLink": "https://www.provider.com/extension/", + "extensionApiDocsLink": "https://docs.provider.com/documentation/extension" + } + } + ] + } + } + } +} diff --git a/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Extensions_Update.json b/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Extensions_Update.json new file mode 100644 index 000000000000..2d08b1b5f6d3 --- /dev/null +++ b/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Extensions_Update.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2020-05-12-preview", + "subscriptionId": "11111111-2222-3333-4444-555555555555", + "resourceGroupName": "examples-rg", + "farmBeatsResourceName": "examples-farmbeatsResourceName", + "extensionId": "provider.extension" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/examples-rg/Microsoft.AgFoodPlatform/farmBeats/examples-farmbeatsResourceName/extensions/provider.extension", + "name": "provider.extension", + "type": "Microsoft.AgFoodPlatform/farmBeats/extensions", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, + "eTag": "7200b954-0000-0700-0000-603cbbc40000", + "properties": { + "extensionCategory": "Weather", + "installedExtensionVersion": "2.0", + "extensionAuthLink": "https://www.provider.com/extension/", + "extensionApiDocsLink": "https://docs.provider.com/documentation/extension" + } + } + } + } +} diff --git a/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsModels_CreateOrUpdate.json b/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsModels_CreateOrUpdate.json new file mode 100644 index 000000000000..5613d21df6f7 --- /dev/null +++ b/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsModels_CreateOrUpdate.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2020-05-12-preview", + "subscriptionId": "11111111-2222-3333-4444-555555555555", + "resourceGroupName": "examples-rg", + "farmBeatsResourceName": "examples-farmbeatsResourceName", + "body": { + "location": "eastus2", + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/examples-rg/Microsoft.AgFoodPlatform/farmBeats/examples-farmbeatsResourceName", + "name": "examples-farmbeatsResourceName", + "type": "Microsoft.AgFoodPlatform/farmBeats", + "location": "eastus2", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, + "properties": { + "instanceUri": "https://examples-farmbeatsResourceName.eastus2.farmbeats.azure.net", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/examples-rg/Microsoft.AgFoodPlatform/farmBeats/examples-farmbeatsResourceName", + "name": "examples-farmbeatsResourceName", + "type": "Microsoft.AgFoodPlatform/farmBeats", + "location": "eastus2", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, + "properties": { + "instanceUri": "https://examples-farmbeatsResourceName.eastus2.farmbeats.azure.net", + "provisioningState": "Failed" + } + } + } + } +} diff --git a/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsModels_Delete.json b/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsModels_Delete.json new file mode 100644 index 000000000000..ca960b71cfdf --- /dev/null +++ b/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsModels_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2020-05-12-preview", + "subscriptionId": "11111111-2222-3333-4444-555555555555", + "resourceGroupName": "examples-rg", + "farmBeatsResourceName": "examples-farmBeatsResourceName" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsModels_Get.json b/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsModels_Get.json new file mode 100644 index 000000000000..f15db77e4d33 --- /dev/null +++ b/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsModels_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2020-05-12-preview", + "subscriptionId": "11111111-2222-3333-4444-555555555555", + "resourceGroupName": "examples-rg", + "farmBeatsResourceName": "examples-farmBeatsResourceName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/examples-rg/Microsoft.AgFoodPlatform/farmBeats/examples-farmbeatsResourceName", + "name": "examples-farmBeatsResourceName", + "type": "Microsoft.AgFoodPlatform/farmBeats", + "location": "eastus2", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, + "properties": { + "instanceUri": "https://examples-farmbeatsResourceName.eastus2.farmbeats.azure.net", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsModels_ListByResourceGroup.json b/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsModels_ListByResourceGroup.json new file mode 100644 index 000000000000..69b66f5bec27 --- /dev/null +++ b/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsModels_ListByResourceGroup.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2020-05-12-preview", + "subscriptionId": "11111111-2222-3333-4444-555555555555", + "resourceGroupName": "examples-rg" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/examples-rg/Microsoft.AgFoodPlatform/farmBeats/examples-farmbeatsResourceName", + "name": "examples-farmBeatsResourceName", + "type": "Microsoft.AgFoodPlatform/farmBeats", + "location": "eastus2", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, + "properties": { + "instanceUri": "https://examples-farmbeatsResourceName.eastus2.farmbeats.azure.net", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsModels_ListBySubscription.json b/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsModels_ListBySubscription.json new file mode 100644 index 000000000000..60ae3f9167ec --- /dev/null +++ b/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsModels_ListBySubscription.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2020-05-12-preview", + "subscriptionId": "11111111-2222-3333-4444-555555555555" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/examples-rg/Microsoft.AgFoodPlatform/farmBeats/examples-farmbeatsResourceName", + "name": "examples-farmBeatsResourceName", + "type": "Microsoft.AgFoodPlatform/farmBeats", + "location": "eastus2", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, + "properties": { + "instanceUri": "https://examples-farmbeatsResourceName.eastus2.farmbeats.azure.net", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsModels_Update.json b/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsModels_Update.json new file mode 100644 index 000000000000..91916585be34 --- /dev/null +++ b/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/FarmBeatsModels_Update.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2020-05-12-preview", + "subscriptionId": "11111111-2222-3333-4444-555555555555", + "resourceGroupName": "examples-rg", + "farmBeatsResourceName": "examples-farmBeatsResourceName", + "body": { + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/examples-rg/Microsoft.AgFoodPlatform/farmBeats/examples-farmbeatsResourceName", + "name": "examples-farmBeatsResourceName", + "type": "Microsoft.AgFoodPlatform/farmBeats", + "location": "eastus2", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, + "properties": { + "instanceUri": "https://examples-farmbeatsResourceName.eastus2.farmbeats.azure.net", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Locations_CheckNameAvailability_AlreadyExists.json b/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Locations_CheckNameAvailability_AlreadyExists.json new file mode 100644 index 000000000000..67af64832527 --- /dev/null +++ b/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Locations_CheckNameAvailability_AlreadyExists.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2020-05-12-preview", + "subscriptionId": "11111111-2222-3333-4444-555555555555", + "body": { + "name": "existingaccountname", + "type": "Microsoft.AgFoodPlatform/farmBeats" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "AlreadyExists", + "message": "An account named 'existingaccountname' is already in use." + } + } + } +} diff --git a/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Locations_CheckNameAvailability_Available.json b/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Locations_CheckNameAvailability_Available.json new file mode 100644 index 000000000000..c515d3f3c2be --- /dev/null +++ b/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Locations_CheckNameAvailability_Available.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2020-05-12-preview", + "subscriptionId": "11111111-2222-3333-4444-555555555555", + "body": { + "name": "newaccountname", + "type": "Microsoft.AgFoodPlatform/farmBeats" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} diff --git a/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Operations_List.json b/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Operations_List.json new file mode 100644 index 000000000000..a80bbb8e33d4 --- /dev/null +++ b/specification/agfood/resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples/Operations_List.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "api-version": "2020-05-12-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.AgFoodPlatform/farmBeats/read", + "isDataAction": false, + "display": { + "provider": "Microsoft AgFoodPlatform", + "resource": "AgFoodPlatform FarmBeats", + "operation": "Get or List AgFoodPlatform FarmBeats resource(s).", + "description": "Gets or Lists existing AgFoodPlatform FarmBeats resource(s)." + } + }, + { + "name": "Microsoft.AgFoodPlatform/farmBeats/write", + "isDataAction": false, + "display": { + "provider": "Microsoft AgFoodPlatform", + "resource": "AgFoodPlatform FarmBeats", + "operation": "Create or Update AgFoodPlatform FarmBeats.", + "description": "Creates or Updates AgFoodPlatform FarmBeats." + } + }, + { + "name": "Microsoft.AgFoodPlatform/farmBeats/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft AgFoodPlatform", + "resource": "AgFoodPlatform FarmBeats", + "operation": "Delete AgFoodPlatform FarmBeats resource.", + "description": "Deletes an existing AgFoodPlatform FarmBeats resource." + } + }, + { + "name": "Microsoft.AgFoodPlatform/locations/checkNameAvailability/action", + "isDataAction": false, + "display": { + "provider": "Microsoft AgFoodPlatform", + "resource": "Locations", + "operation": "Check Name Availability", + "description": "Checks that resource name is valid and is not in use." + } + }, + { + "name": "Microsoft.AgFoodPlatform/operations/read", + "isDataAction": false, + "display": { + "provider": "Microsoft AgFoodPlatform", + "resource": "List all operations in Microsoft AgFoodPlatform resource provider.", + "operation": "List all operations.", + "description": "List all operations in Microsoft AgFoodPlatform resource provider." + } + }, + { + "name": "Microsoft.AgFoodPlatform/farmBeats/extensions/read", + "isDataAction": false, + "display": { + "provider": "Microsoft AgFoodPlatform", + "resource": "AgFoodPlatform Extensions", + "operation": "Get or List AgFoodPlatform Extensions resource(s).", + "description": "Gets or Lists existing AgFoodPlatform Extensions resource(s)." + } + }, + { + "name": "Microsoft.AgFoodPlatform/farmBeats/extensions/write", + "isDataAction": false, + "display": { + "provider": "Microsoft AgFoodPlatform", + "resource": "AgFoodPlatform Extensions", + "operation": "Create or Update AgFoodPlatform Extensions.", + "description": "Creates or Updates AgFoodPlatform Extensions." + } + }, + { + "name": "Microsoft.AgFoodPlatform/farmBeats/extensions/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft AgFoodPlatform", + "resource": "AgFoodPlatform Extensions", + "operation": "Delete AgFoodPlatform Extensions resource.", + "description": "Deletes an existing AgFoodPlatform Extensions resource." + } + } + ], + "nextLink": "https://management.azure.com/providers/Microsoft.AgFoodPlatform/operations?$skiptoken={token}" + } + } + } +} diff --git a/specification/agfood/resource-manager/readme.csharp.md b/specification/agfood/resource-manager/readme.csharp.md new file mode 100644 index 000000000000..9e64c3052486 --- /dev/null +++ b/specification/agfood/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.AgFoodPlatform + output-folder: $(csharp-sdks-folder)/agfood/management/Microsoft.AgFoodPlatform/Generated +``` diff --git a/specification/agfood/resource-manager/readme.go.md b/specification/agfood/resource-manager/readme.go.md new file mode 100644 index 000000000000..a7cbc2aa134b --- /dev/null +++ b/specification/agfood/resource-manager/readme.go.md @@ -0,0 +1,26 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +```yaml $(go) +go: + license-header: MICROSOFT_MIT_NO_VERSION + namespace: agfood + clear-output-folder: true +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: package-2020-05-12-preview +``` + +### Tag: package-2020-05-12-preview and go + +These settings apply only when `--tag=package-2020-05-12-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +```yaml $(tag) == 'package-2020-05-12-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2020-05-12-preview/$(namespace) +``` diff --git a/specification/agfood/resource-manager/readme.md b/specification/agfood/resource-manager/readme.md new file mode 100644 index 000000000000..5a0e4ca8f66f --- /dev/null +++ b/specification/agfood/resource-manager/readme.md @@ -0,0 +1,106 @@ +# agfood + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for agfood. + +## 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 agfood. + +```yaml +openapi-type: arm +tag: package-2020-05-12-preview +``` + +### Tag: package-2020-05-12-preview + +These settings apply only when `--tag=package-2020-05-12-preview` is specified on the command line. + +```yaml $(tag) == 'package-2020-05-12-preview' +input-file: + - Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.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-track2 + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js +``` +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## TypeScript + +See configuration in [readme.typescript.md](./readme.typescript.md) + +## CSharp + +See configuration in [readme.csharp.md](./readme.csharp.md) + +## Suppression + +``` yaml +directive: + - from: agfood.json + suppress: R3006 # BodyTopLevelProperties + where: $.definitions.FarmBeats.properties + reason: Currently systemData is not allowed. + - from: agfood.json + suppress: R3006 # BodyTopLevelProperties + where: $.definitions.Extension.properties + reason: Currently systemData is not allowed. + - from: agfood.json + suppress: R3018 # EnumInsteadOfBoolean + where: + - $.definitions.Operation.properties.isDataAction + - $.definitions.CheckNameAvailabilityResult.properties.nameAvailable + reason: Booleans are used to indicate binary states of the property, enum is not appropriate. + - from: agfood.json + suppress: R4000 # DescriptionAndTitleMissing + where: + - $.definitions.Error.properties.innererror + - $.definitions.ErrorResponse.properties.error + - $.definitions.Extension.properties.properties + - $.definitions.Extension.properties.systemData + - $.definitions.FarmBeats.properties.properties + - $.definitions.FarmBeats.properties.systemData + - $.definitions.InnerError.properties.innererror + - $.definitions.Operation.properties.display + reason: Model has description added in it's schema. + - from: types.json + suppress: R4000 # DescriptionAndTitleMissing + where: $.definitions.Resource + reason: Common type models are inherited. +``` diff --git a/specification/agfood/resource-manager/readme.python.md b/specification/agfood/resource-manager/readme.python.md new file mode 100644 index 000000000000..f109f297029c --- /dev/null +++ b/specification/agfood/resource-manager/readme.python.md @@ -0,0 +1,23 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(track2) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +package-name: azure-mgmt-agfood +no-namespace-folders: true +package-version: 1.0.0b1 +clear-output-folder: true +``` + +``` yaml $(python-mode) == 'update' && $(track2) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/agfood/azure-mgmt-agfood/azure/mgmt/agfood +``` + +``` yaml $(python-mode) == 'create' && $(track2) +basic-setup-py: true +output-folder: $(python-sdks-folder)/agfood/azure-mgmt-agfood +``` diff --git a/specification/agfood/resource-manager/readme.typescript.md b/specification/agfood/resource-manager/readme.typescript.md new file mode 100644 index 000000000000..c4ad9c4e1545 --- /dev/null +++ b/specification/agfood/resource-manager/readme.typescript.md @@ -0,0 +1,15 @@ +## 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 + license-header: MICROSOFT_MIT_NO_VERSION + package-name: "@azure/arm-agfood" + output-folder: "$(typescript-sdks-folder)/sdk/agfood/arm-agfood" + payload-flattening-threshold: 1 + clear-output-folder: true + generate-metadata: true +```