Skip to content

Commit

Permalink
Merge pull request #3183 from Azure/dev/subbart/guestagent
Browse files Browse the repository at this point in the history
Adding proxy resource for VM guest agent provisioning...
  • Loading branch information
weidongxu-microsoft authored Mar 17, 2021
2 parents bdcde43 + df114e6 commit 4022243
Show file tree
Hide file tree
Showing 5 changed files with 453 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -2619,6 +2619,251 @@
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/virtualMachines/{virtualMachineName}/guestAgents/{name}": {
"put": {
"tags": [
"GuestAgents"
],
"operationId": "GuestAgent_Create",
"description": "Create Or Update GuestAgent.",
"summary": "Implements GuestAgent PUT method.",
"x-ms-examples": {
"CreateGuestAgent": {
"$ref": "./examples/CreateGuestAgent.json"
}
},
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"in": "path",
"name": "virtualMachineName",
"required": true,
"type": "string",
"description": "Name of the vm."
},
{
"in": "path",
"name": "name",
"required": true,
"type": "string",
"description": "Name of the guestAgents."
},
{
"$ref": "#/parameters/api-version"
},
{
"in": "body",
"name": "body",
"description": "Request payload.",
"schema": {
"$ref": "#/definitions/GuestAgent"
}
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/GuestAgent"
}
},
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/GuestAgent"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "azure-async-operation"
}
},
"get": {
"tags": [
"GuestAgents"
],
"operationId": "GuestAgent_Get",
"summary": "Gets GuestAgent.",
"description": "Implements GuestAgent GET method.",
"x-ms-examples": {
"GetGuestAgent": {
"$ref": "./examples/GetGuestAgent.json"
}
},
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"in": "path",
"name": "virtualMachineName",
"required": true,
"type": "string",
"description": "Name of the vm."
},
{
"in": "path",
"name": "name",
"required": true,
"type": "string",
"description": "Name of the GuestAgent."
},
{
"$ref": "#/parameters/api-version"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/GuestAgent"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
},
"delete": {
"tags": [
"GuestAgents"
],
"operationId": "GuestAgent_Delete",
"summary": "Deletes an GuestAgent.",
"description": "Implements GuestAgent DELETE method.",
"x-ms-examples": {
"DeleteGuestAgent": {
"$ref": "./examples/DeleteGuestAgent.json"
}
},
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"in": "path",
"name": "virtualMachineName",
"required": true,
"type": "string",
"description": "Name of the vm."
},
{
"in": "path",
"name": "name",
"required": true,
"type": "string",
"description": "Name of the GuestAgent."
},
{
"$ref": "#/parameters/api-version"
}
],
"responses": {
"200": {
"description": "Success"
},
"202": {
"description": "Accepted"
},
"204": {
"description": "No Content"
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/virtualMachines/{virtualMachineName}/guestAgents": {
"get": {
"tags": [
"GuestAgents"
],
"operationId": "GuestAgent_ListByVm",
"summary": "Implements GET GuestAgent in a vm.",
"description": "Returns the list of GuestAgent of the given vm.",
"x-ms-examples": {
"GuestAgentListByVm": {
"$ref": "./examples/GuestAgent_ListByVm.json"
}
},
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/resourceGroupName"
},
{
"in": "path",
"name": "virtualMachineName",
"required": true,
"type": "string",
"description": "Name of the vm."
},
{
"$ref": "#/parameters/api-version"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/GuestAgentList"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
}
},
"definitions": {
Expand Down Expand Up @@ -4491,6 +4736,107 @@
}
},
"description": "Describes the Machine Extensions List Result."
},
"ProvisioningAction": {
"description": "Defines the different types of operations for guest agent.",
"enum": [
"install",
"uninstall",
"repair"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "ProvisioningAction"
}
},
"GuestCredential": {
"description": "Username / Password Credentials to connect to guest.",
"type": "object",
"properties": {
"username": {
"description": "Gets or sets username to connect with the guest.",
"type": "string"
},
"password": {
"description": "Gets or sets the password to connect with the guest.",
"type": "string",
"x-ms-mutability": [
"create",
"update"
],
"x-ms-secret": true
}
}
},
"GuestAgentList": {
"description": "List of GuestAgent.",
"properties": {
"nextLink": {
"description": "Url to follow for getting next page of GuestAgent.",
"type": "string"
},
"value": {
"description": "Array of GuestAgent",
"type": "array",
"items": {
"$ref": "#/definitions/GuestAgent"
}
}
},
"required": [
"value"
]
},
"GuestAgent": {
"description": "Defines the GuestAgent.",
"required": [
"properties"
],
"type": "object",
"allOf": [
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource",
"description": "The resource model definition for an Azure Resource Manager proxy resource. It will have everything other than required location and tags."
}
],
"properties": {
"properties": {
"x-ms-client-flatten": true,
"description": "Resource properties.",
"$ref": "#/definitions/GuestAgentProperties"
},
"systemData": {
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
"description": "The system data."
}
},
"x-ms-azure-resource": true
},
"GuestAgentProperties": {
"description": "Defines the resource properties.",
"type": "object",
"properties": {
"credentials": {
"description": "Username / Password Credentials to provision guest agent.",
"$ref": "#/definitions/GuestCredential"
},
"provisioningAction": {
"description": "Gets or sets the guest agent provisioning action.",
"$ref": "#/definitions/ProvisioningAction",
"type": "string"
},
"status": {
"description": "Gets or sets the guest agent status.",
"type": "string",
"readOnly": true
},
"provisioningState": {
"description": "Gets or sets the provisioning state.",
"type": "string",
"readOnly": true
}
}
}
},
"parameters": {
Expand Down
Loading

0 comments on commit 4022243

Please sign in to comment.