Skip to content

Racastur/associations #6040

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
amarzavery merged 6 commits into from
May 22, 2019
Merged

Racastur/associations #6040

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e63791f
Add Associations API Swagger specification
May 20, 2019
a299994
Add Associations API Swagger specification
May 21, 2019
71366ce
Add Associations API Swagger specification
May 21, 2019
00d7f34
Add Associations API Swagger specification
May 21, 2019
892c4cd
Add Associations API Swagger specification
May 21, 2019
60a2682
Add Associations API Swagger specification
May 21, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
286 changes: 285 additions & 1 deletion ...esource-manager/Microsoft.CustomProviders/preview/2018-09-01-preview/customproviders.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -380,6 +380,225 @@
"application/json"
]
}
},
"/{scope}/providers/Microsoft.CustomProviders/associations/{associationName}": {
Comment thread
ramacasturi marked this conversation as resolved.
"put": {
"tags": [
"Associations"
],
"operationId": "Associations_CreateOrUpdate",
"x-ms-long-running-operation": true,
"description": "Create or update an association.",
"x-ms-examples": {
"Create or update an association": {
"$ref": "examples/createOrUpdateAssociation.json"
}
},
"parameters": [
{
"name": "scope",
"in": "path",
"required": true,
"type": "string",
"description": "The scope of the association. The scope can be any valid REST resource instance. For example, use '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.Compute/virtualMachines/{vm-name}' for a virtual machine resource.",
"x-ms-skip-url-encoding": true
},
{
"name": "associationName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the association."
},
{
"name": "association",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/Association"
},
"description": "The parameters required to create or update an association."
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"201": {
"description": "Created. Association has been created.",
"schema": {
"$ref": "#/definitions/Association"
}
},
"200": {
"description": "OK. Association already exists and the changes have been accepted.",
"schema": {
"$ref": "#/definitions/Association"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"produces": [
"application/json"
],
"consumes": [
"application/json"
]
},
"delete": {
"tags": [
"Associations"
],
"operationId": "Associations_Delete",
"x-ms-long-running-operation": true,
"description": "Delete an association.",
"x-ms-examples": {
"Delete an association": {
"$ref": "examples/deleteAssociation.json"
}
},
"parameters": [
{
"name": "scope",
"in": "path",
"required": true,
"type": "string",
"description": "The scope of the association.",
"x-ms-skip-url-encoding": true
},
{
"name": "associationName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the association."
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK. Association deleted."
},
"202": {
"description": "Accepted. Association delete has been accepted."
},
"204": {
"description": "No Content. Association was not found."
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"produces": [
"application/json"
]
},
"get": {
"tags": [
"Associations"
],
"operationId": "Associations_Get",
"description": "Get an association.",
"x-ms-examples": {
"Get an association": {
"$ref": "examples/getAssociation.json"
}
},
"parameters": [
{
"name": "scope",
"in": "path",
"required": true,
"type": "string",
"description": "The scope of the association.",
"x-ms-skip-url-encoding": true
},
{
"name": "associationName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the association."
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK. Returns association.",
"schema": {
"$ref": "#/definitions/Association"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"produces": [
"application/json"
]
}
},
"/{scope}/providers/Microsoft.CustomProviders/associations": {
"get": {
"tags": [
"Associations"
],
"operationId": "Associations_ListAll",
"description": "Gets all association for the given scope.",
"x-ms-pageable": {
"nextLinkName": "nextLink"
},
"x-ms-examples": {
"Get all associations": {
"$ref": "examples/getAllAssociations.json"
}
},
"parameters": [
{
"name": "scope",
"in": "path",
"required": true,
"type": "string",
"description": "The scope of the association.",
"x-ms-skip-url-encoding": true
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK. Returns all associations for the given scope.",
"schema": {
"$ref": "#/definitions/AssociationsList"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"produces": [
"application/json"
]
}
}
},
"definitions": {
Expand Down Expand Up @@ -586,7 +805,72 @@
}
}
},
"Resource": {
"Association": {
"x-ms-azure-resource": true,
"x-ms-client-flatten": true,
"description": "The resource definition of this association.",
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "The association id."
},
"name": {
"type": "string",
"readOnly": true,
"description": "The association name."
},
"type": {
"type": "string",
"readOnly": true,
"description": "The association type."
},
"properties": {
"type": "object",
"description": "The properties of the association.",
"x-ms-client-flatten": true,
"properties": {
"targetResourceId": {
"type": "string",
"description": "The REST resource instance of the target resource for this association."
},
"provisioningState": {
"type": "string",
"description": "The provisioning state of the association.",
"readOnly": true,
"x-ms-enum": {
"modelAsString": true,
"name": "ProvisioningState"
},
"enum": [
"Accepted",
"Deleting",
"Running",
"Succeeded",
"Failed"
]
}
}
}
}
},
"AssociationsList": {
"description": "List of associations.",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/Association"
},
"description": "The array of associations."
},
"nextLink": {
"type": "string",
"description": "The URL to use for getting the next set of results."
}
}
},
"Resource": {
"properties": {
"id": {
"readOnly": true,
Expand Down
38 changes: 38 additions & 0 deletions ...rosoft.CustomProviders/preview/2018-09-01-preview/examples/createOrUpdateAssociation.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
{
Comment thread
ramacasturi marked this conversation as resolved.
"parameters": {
"scope": "scope",
"associationName": "associationName",
"api-version": "2018-09-01-preview",
"association": {
"properties": {
"targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/appRG/providers/Microsoft.Solutions/applications/applicationName"
}
}
},
"responses": {
"201": {
"headers": {},
"body": {
"name": "associationName",
"id": "/scope/providers/Microsoft.CustomProviders/associations/associationName",
"type": "Microsoft.CustomProviders/associations",
"properties": {
"targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/appRG/providers/Microsoft.Solutions/applications/applicationName",
"provisioningState": "Accepted"
}
}
},
"200": {
"headers": {},
"body": {
"name": "associationName",
"id": "/scope/providers/Microsoft.CustomProviders/associations/associationName",
"type": "Microsoft.CustomProviders/associations",
"properties": {
"targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/appRG/providers/Microsoft.Solutions/applications/applicationName",
"provisioningState": "Accepted"
Comment thread
ramacasturi marked this conversation as resolved.
Outdated
}
}
}
}
}
12 changes: 12 additions & 0 deletions ...ager/Microsoft.CustomProviders/preview/2018-09-01-preview/examples/deleteAssociation.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"parameters": {
"scope": "scope",
"associationName": "associationName",
"api-version": "2018-09-01-preview"
},
"responses": {
"200": {},
"202": {},
"204": {}
}
}
24 changes: 24 additions & 0 deletions ...ger/Microsoft.CustomProviders/preview/2018-09-01-preview/examples/getAllAssociations.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{
"parameters": {
"scope": "scope",
"api-version": "2018-09-01-preview"
},
"responses": {
"200": {
"headers": {},
"body": {
"value": [
{
"name": "associationName",
"id": "scope/providers/Microsoft.CustomProviders/associations/associationName",
"type": "Microsoft.CustomProviders/associations",
"properties": {
"targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/appRG/providers/Microsoft.Solutions/applications/applicationName",
"provisioningState": "Succeeded"
}
}
]
}
}
}
}
Loading