{ "opencollection": "1.0.0", "info": { "name": "Microsoft Azure AccessControlClient AccessConnector Node API", "version": "2020-08-01-preview" }, "items": [ { "info": { "name": "Node", "type": "folder" }, "items": [ { "info": { "name": "Microsoft Azure Gets The List Of Nodes In The Service Fabric Cluster", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/Nodes", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.3'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "ContinuationToken", "value": "", "type": "query", "description": "The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded." }, { "name": "NodeStatusFilter", "value": "", "type": "query", "description": "Allows filtering the nodes based on the NodeStatus. Only the nodes that are matching the specified filter value will be returned. The filter value can be one of the following." }, { "name": "MaxResults", "value": "", "type": "query", "description": "The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message." }, { "name": "timeout", "value": "", "type": "query", "description": "The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds." } ] }, "docs": "The response includes the name, status, ID, health, uptime, and other details about the nodes." }, { "info": { "name": "Microsoft Azure Gets The Information About A Specific Node In The Service Fabric Cluster", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/Nodes/:nodeName", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.0'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accept any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0, but if the runtime is 6.1, in order to make it easier to write the clients, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "nodeName", "value": "", "type": "path", "description": "The name of the node." }, { "name": "timeout", "value": "", "type": "query", "description": "The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds." } ] }, "docs": "The response includes the name, status, ID, health, uptime, and other details about the node." }, { "info": { "name": "Microsoft Azure Gets The Health Of A Service Fabric Node", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/Nodes/:nodeName/$/GetHealth", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.0'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accept any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0, but if the runtime is 6.1, in order to make it easier to write the clients, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "nodeName", "value": "", "type": "path", "description": "The name of the node." }, { "name": "EventsHealthStateFilter", "value": "", "type": "query", "description": "Allows filtering the collection of HealthEvent objects returned based on health state.\nThe possible values for this parameter include integer value of one of the following health states.\nOnly events that match the filter are returned. All events are used to evaluate the aggregated health state.\nIf not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535." }, { "name": "timeout", "value": "", "type": "query", "description": "The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds." } ] }, "docs": "Gets the health of a Service Fabric node. Use EventsHealthStateFilter to filter the collection of health events reported on the node based on the health state. If the node that you specify by name does not exist in the health store, this returns an error." }, { "info": { "name": "Microsoft Azure Gets The Health Of A Service Fabric Node, By Using The Specified Health Policy", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/Nodes/:nodeName/$/GetHealth", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.0'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accept any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0, but if the runtime is 6.1, in order to make it easier to write the clients, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "nodeName", "value": "", "type": "path", "description": "The name of the node." }, { "name": "EventsHealthStateFilter", "value": "", "type": "query", "description": "Allows filtering the collection of HealthEvent objects returned based on health state.\nThe possible values for this parameter include integer value of one of the following health states.\nOnly events that match the filter are returned. All events are used to evaluate the aggregated health state.\nIf not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535." }, { "name": "timeout", "value": "", "type": "query", "description": "The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds." } ] }, "docs": "Gets the health of a Service Fabric node. Use EventsHealthStateFilter to filter the collection of health events reported on the node based on the health state. Use ClusterHealthPolicy in the POST body to override the health policies used to evaluate the health. If the node that you specify by name does not exist in the health store, this returns an error." }, { "info": { "name": "Microsoft Azure Sends A Health Report On The Service Fabric Node", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/Nodes/:nodeName/$/ReportHealth", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.0'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accept any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0, but if the runtime is 6.1, in order to make it easier to write the clients, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "nodeName", "value": "", "type": "path", "description": "The name of the node." }, { "name": "Immediate", "value": "", "type": "query", "description": "A flag that indicates whether the report should be sent immediately.\nA health report is sent to a Service Fabric gateway Application, which forwards to the health store.\nIf Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using.\nThis is useful for critical reports that should be sent as soon as possible.\nDepending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn't reach the Gateway.\nIf Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. Therefore, it will be batched according to the HealthReportSendInterval configuration.\nThis is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing.\nBy default, reports are not sent immediately." }, { "name": "timeout", "value": "", "type": "query", "description": "The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds." } ] }, "docs": "Reports health state of the specified Service Fabric node. The report must contain the information about the source of the health report and property on which it is reported.
The report is sent to a Service Fabric gateway node, which forwards to the health store.
The report may be accepted by the gateway, but rejected by the health store after extra validation.
For example, the health store may reject the report because of an invalid parameter, like a stale sequence number.
To see wh" }, { "info": { "name": "Microsoft Azure Gets The Load Information Of A Service Fabric Node", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/Nodes/:nodeName/$/GetLoadInformation", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.0'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accept any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0, but if the runtime is 6.1, in order to make it easier to write the clients, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "nodeName", "value": "", "type": "path", "description": "The name of the node." }, { "name": "timeout", "value": "", "type": "query", "description": "The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds." } ] }, "docs": "Retrieves the load information of a Service Fabric node for all the metrics that have load or capacity defined." }, { "info": { "name": "Microsoft Azure Deactivate A Service Fabric Cluster Node With The Specified Deactivation Intent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/Nodes/:nodeName/$/Deactivate", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.0'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accept any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0, but if the runtime is 6.1, in order to make it easier to write the clients, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "nodeName", "value": "", "type": "path", "description": "The name of the node." }, { "name": "timeout", "value": "", "type": "query", "description": "The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds." } ] }, "docs": "Deactivate a Service Fabric cluster node with the specified deactivation intent. Once the deactivation is in progress, the deactivation intent can be increased, but not decreased (for example, a node that is deactivated with the Pause intent can be deactivated further with Restart, but not the other way around. Nodes may be reactivated using the Activate a node operation any time after they are deactivated. If the deactivation is not complete, this will cancel the deactivation. A node that goes " }, { "info": { "name": "Microsoft Azure Activate A Service Fabric Cluster Node That Is Currently Deactivated", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/Nodes/:nodeName/$/Activate", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.0'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accept any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0, but if the runtime is 6.1, in order to make it easier to write the clients, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "nodeName", "value": "", "type": "path", "description": "The name of the node." }, { "name": "timeout", "value": "", "type": "query", "description": "The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds." } ] }, "docs": "Activates a Service Fabric cluster node that is currently deactivated. Once activated, the node will again become a viable target for placing new replicas, and any deactivated replicas remaining on the node will be reactivated." }, { "info": { "name": "Microsoft Azure Notifies Service Fabric That The Persisted State On A Node Has Been Permanently Removed Or Lost", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/Nodes/:nodeName/$/RemoveNodeState", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.0'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accept any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0, but if the runtime is 6.1, in order to make it easier to write the clients, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "nodeName", "value": "", "type": "path", "description": "The name of the node." }, { "name": "timeout", "value": "", "type": "query", "description": "The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds." } ] }, "docs": "This implies that it is not possible to recover the persisted state of that node. This generally happens if a hard disk has been wiped clean, or if a hard disk crashes. The node has to be down for this operation to be successful. This operation lets Service Fabric know that the replicas on that node no longer exist, and that Service Fabric should stop waiting for those replicas to come back up. Do not run this cmdlet if the state on the node has not been removed and the node can come back up wit" }, { "info": { "name": "Microsoft Azure Restarts A Service Fabric Cluster Node", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/Nodes/:nodeName/$/Restart", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '6.0'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accept any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0, but if the runtime is 6.1, in order to make it easier to write the clients, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "nodeName", "value": "", "type": "path", "description": "The name of the node." }, { "name": "timeout", "value": "", "type": "query", "description": "The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds." } ] }, "docs": "Restarts a Service Fabric cluster node that is already started." }, { "info": { "name": "Microsoft Azure Removes Configuration Overrides On The Specified Node", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/Nodes/:nodeName/$/RemoveConfigurationOverrides", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '7.0'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "nodeName", "value": "", "type": "path", "description": "The name of the node." }, { "name": "timeout", "value": "", "type": "query", "description": "The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds." } ] }, "docs": "This api allows removing all existing configuration overrides on specified node." }, { "info": { "name": "Microsoft Azure Gets The List Of Configuration Overrides On The Specified Node", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/Nodes/:nodeName/$/GetConfigurationOverrides", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '7.0'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "nodeName", "value": "", "type": "path", "description": "The name of the node." }, { "name": "timeout", "value": "", "type": "query", "description": "The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds." } ] }, "docs": "This api allows getting all existing configuration overrides on the specified node." }, { "info": { "name": "Microsoft Azure Adds The List Of Configuration Overrides On The Specified Node", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/Nodes/:nodeName/$/AddConfigurationParameterOverrides", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '7.0'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "nodeName", "value": "", "type": "path", "description": "The name of the node." }, { "name": "Force", "value": "", "type": "query", "description": "Force adding configuration overrides on specified nodes." }, { "name": "timeout", "value": "", "type": "query", "description": "The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds." } ] }, "docs": "This api allows adding all existing configuration overrides on the specified node." }, { "info": { "name": "Microsoft Azure Removes The List Of Tags From The Specified Node", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/Nodes/:nodeName/$/RemoveNodeTags", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '7.0'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "nodeName", "value": "", "type": "path", "description": "The name of the node." } ] }, "docs": "This api allows removing set of tags from the specified node." }, { "info": { "name": "Microsoft Azure Adds The List Of Tags On The Specified Node", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/Nodes/:nodeName/$/AddNodeTags", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API. This parameter is required and its value must be '7.2'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version." }, { "name": "nodeName", "value": "", "type": "path", "description": "The name of the node." } ] }, "docs": "This api allows adding tags to the specified node." } ] } ], "bundled": true }