swagger: '2.0'
info:
version: 2020-08-01-preview
title: Microsoft Azure AccessControlClient AccessConnector VmwarePropertiesController API
schemes:
- https
tags:
- name: VmwarePropertiesController
paths:
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/updateDependencyMapStatus
: post:
operationId: microsoftAzureVmwarepropertiescontrollerUpdatedependencymapstatus
tags:
- VmwarePropertiesController
description: Method to enable disable dependency map status for machines
in a
site.
parameters:
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
- name: siteName
in: path
description: Site name
required: true
type: string
pattern: ^[a-zA-Z0-9-]{3,24}$
- name: updateMachineDepMapStatus
in: body
description: The content of the action request
required: true
schema:
$ref: '#/definitions/UpdateMachineDepMapStatus'
responses:
'200':
description: ARM operation completed successfully.
schema:
type: object
'202':
description: The request has been accepted for processing, but processing has not yet completed.
headers:
Retry-After:
type: integer
format: int32
description: The Retry-After header can indicate how long the client should wait before polling the operation status.
location:
type: string
description: The Location header contains the URL where the status of the long running operation can be checked.
default:
description: An unexpected error response.
schema:
$ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-long-running-operation-options:
final-state-via: location
x-ms-long-running-operation: true
x-ms-examples:
VmwarePropertiesController_UpdateDependencyMapStatus_MaximumSet_Gen:
$ref: ./examples/VmwarePropertiesController_UpdateDependencyMapStatus_MaximumSet_Gen.json
summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Vmwaresites Sitename Updatedependencymapstatus
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/updateProperties
: post:
operationId: microsoftAzureVmwarepropertiescontrollerUpdateproperties
tags:
- VmwarePropertiesController
description: Method to update properties for machines in a site.
parameters:
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
- name: siteName
in: path
description: Site name
required: true
type: string
pattern: ^[a-zA-Z0-9-]{3,24}$
- name: metaData
in: body
description: The content of the action request
required: true
schema:
$ref: '#/definitions/MachineMetadataCollection'
responses:
'200':
description: ARM operation completed successfully.
schema:
type: object
'202':
description: Resource operation accepted.
headers:
Retry-After:
type: integer
format: int32
description: The Retry-After header can indicate how long the client should wait before polling the operation status.
Location:
type: string
description: The Location header contains the URL where the status of the long running operation can be checked.
default:
description: An unexpected error response.
schema:
$ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-long-running-operation-options:
final-state-via: location
x-ms-long-running-operation: true
x-ms-examples:
VmwarePropertiesController_UpdateProperties_MaximumSet_Gen:
$ref: ./examples/VmwarePropertiesController_UpdateProperties_MaximumSet_Gen.json
summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Vmwaresites Sitename Updateproperties
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/updateRunAsAccount
: post:
operationId: microsoftAzureVmwarepropertiescontrollerUpdaterunasaccount
tags:
- VmwarePropertiesController
description: Method to associate Run as account to machine
in a site.
parameters:
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
- name: siteName
in: path
description: Site name
required: true
type: string
pattern: ^[a-zA-Z0-9-]{3,24}$
- name: updateMachineRunAsAccount
in: body
description: The content of the action request
required: true
schema:
$ref: '#/definitions/UpdateMachineRunAsAccount'
responses:
'200':
description: ARM operation completed successfully.
schema:
type: object
'202':
description: The request has been accepted for processing, but processing has not yet completed.
headers:
Retry-After:
type: integer
format: int32
description: The Retry-After header can indicate how long the client should wait before polling the operation status.
location:
type: string
description: The Location header contains the URL where the status of the long running operation can be checked.
default:
description: An unexpected error response.
schema:
$ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-long-running-operation-options:
final-state-via: location
x-ms-long-running-operation: true
x-ms-examples:
VmwarePropertiesController_UpdateRunAsAccount_MaximumSet_Gen:
$ref: ./examples/VmwarePropertiesController_UpdateRunAsAccount_MaximumSet_Gen.json
summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Vmwaresites Sitename Updaterunasaccount
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/updateTags
: post:
operationId: microsoftAzureVmwarepropertiescontrollerUpdatetags
tags:
- VmwarePropertiesController
description: Method to associate Run as account to machine
in a site.
parameters:
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
- name: siteName
in: path
description: Site name
required: true
type: string
pattern: ^[a-zA-Z0-9-]{3,24}$
- name: updateMachineTags
in: body
description: The content of the action request
required: true
schema:
$ref: '#/definitions/UpdateMachineTags'
responses:
'200':
description: ARM operation completed successfully.
schema:
type: object
'202':
description: The request has been accepted for processing, but processing has not yet completed.
headers:
Retry-After:
type: integer
format: int32
description: The Retry-After header can indicate how long the client should wait before polling the operation status.
location:
type: string
description: The Location header contains the URL where the status of the long running operation can be checked.
default:
description: An unexpected error response.
schema:
$ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-long-running-operation-options:
final-state-via: location
x-ms-long-running-operation: true
x-ms-examples:
VmwarePropertiesController_UpdateTags_MaximumSet_Gen:
$ref: ./examples/VmwarePropertiesController_UpdateTags_MaximumSet_Gen.json
summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Vmwaresites Sitename Updatetags
definitions:
MachineMetadata:
type: object
description: The properties of Machine MetaData
properties:
machineArmId:
type: string
description: arm id of the machine.
dependencyMapping:
type: string
description: value representing state of dependency mapping (enabled/disabled).
tags:
type: object
description: machine tags
additionalProperties:
type: string
required:
- machineArmId
- dependencyMapping
- tags
UpdateMachineDepMapStatus:
type: object
description: "Defines class that represents input to enable or disable DMP on machine\n \n for cosmos entity operation."
properties:
machines:
type: array
description: Gets or sets the machine collection.
items:
$ref: '#/definitions/DependencyMapMachineInput'
x-ms-identifiers: []
UpdateMachineRunAsAccount:
type: object
description: "Defines class that represents input to update RunAsAccount on machine\n \n for cosmos entity operation."
properties:
machines:
type: array
description: Gets or sets the machine collection.
items:
$ref: '#/definitions/RunAsAccountMachineInput'
x-ms-identifiers: []
UpdateMachineTags:
type: object
description: "Defines class that represents input to update Tags on machine\n \n for cosmos entity operation."
properties:
machines:
type: array
description: Gets or sets the machine collection.
items:
$ref: '#/definitions/TagsMachineInput'
x-ms-identifiers: []
TagsMachineInput:
type: object
description: Machine class.
properties:
machineId:
type: string
description: Gets or sets the ARM id of the machine.
tags:
type: object
description: run as AccountId
additionalProperties:
type: string
MachineMetadataCollection:
type: object
description: The list of Machine MetaData.
properties:
value:
type: array
description: The list of Machine MetaData.
items:
$ref: '#/definitions/MachineMetadata'
x-ms-identifiers: []
required:
- value
DependencyMapMachineInput:
type: object
description: Machine class.
properties:
machineId:
type: string
description: Gets or sets the ARM id of the machine.
isDependencyMapToBeEnabled:
type: boolean
description: "Gets or sets a value indicating whether\n dependency mapping is to\nbe enabled or not."
RunAsAccountMachineInput:
type: object
description: Machine class.
properties:
machineId:
type: string
description: Gets or sets the ARM id of the machine.
runAsAccountId:
type: string
description: run as AccountId
x-ms-parameterized-host:
hostTemplate: '{endpoint}'
useSchemePrefix: false
parameters:
- $ref: '#/parameters/Endpoint'