{ "opencollection": "1.0.0", "info": { "name": "Microsoft Azure AccessControlClient AccessConnector ServiceType API", "version": "2020-08-01-preview" }, "items": [ { "info": { "name": "ServiceType", "type": "folder" }, "items": [ { "info": { "name": "Microsoft Azure Gets The List Containing The Information About Service Types That Are Supported By A Provisioned Application Type In A Service Fabric Cluster", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ApplicationTypes/:applicationTypeName/$/GetServiceTypes", "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": "applicationTypeName", "value": "", "type": "path", "description": "The name of the application type." }, { "name": "ApplicationTypeVersion", "value": "", "type": "query", "description": "The version of the application type." }, { "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 list containing the information about service types that are supported by a provisioned application type in a Service Fabric cluster. The provided application type must exist. Otherwise, a 404 status is returned." }, { "info": { "name": "Microsoft Azure Gets The Information About A Specific Service Type That Is Supported By A Provisioned Application Type In A Service Fabric Cluster", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ApplicationTypes/:applicationTypeName/$/GetServiceTypes/:serviceTypeName", "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": "applicationTypeName", "value": "", "type": "path", "description": "The name of the application type." }, { "name": "ApplicationTypeVersion", "value": "", "type": "query", "description": "The version of the application type." }, { "name": "serviceTypeName", "value": "", "type": "path", "description": "Specifies the name of a Service Fabric service type." }, { "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 information about a specific service type that is supported by a provisioned application type in a Service Fabric cluster. The provided application type must exist. Otherwise, a 404 status is returned. A 204 response is returned if the specified service type is not found in the cluster." }, { "info": { "name": "Microsoft Azure Gets The Manifest Describing A Service Type", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ApplicationTypes/:applicationTypeName/$/GetServiceManifest", "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": "applicationTypeName", "value": "", "type": "path", "description": "The name of the application type." }, { "name": "ApplicationTypeVersion", "value": "", "type": "query", "description": "The version of the application type." }, { "name": "ServiceManifestName", "value": "", "type": "query", "description": "The name of a service manifest registered as part of an application type in a Service Fabric cluster." }, { "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 manifest describing a service type. The response contains the service manifest XML as a string." }, { "info": { "name": "Microsoft Azure Gets The List Containing The Information About Service Types From The Applications Deployed On A Node In A Service Fabric Cluster", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/Nodes/:nodeName/$/GetApplications/:applicationId/$/GetServiceTypes", "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": "applicationId", "value": "", "type": "path", "description": "The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme.\nStarting from version 6.0, hierarchical names are delimited with the \"~\" character.\nFor example, if the application name is \"fabric:/myapp/app1\", the application identity would be \"myapp~app1\" in 6.0+ and \"myapp/app1\" in previous versions." }, { "name": "ServiceManifestName", "value": "", "type": "query", "description": "The name of the service manifest to filter the list of deployed service type information. If specified, the response will only contain the information about service types that are defined in this service manifest." }, { "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 list containing the information about service types from the applications deployed on a node in a Service Fabric cluster. The response includes the name of the service type, its registration status, the code package that registered it and activation ID of the service package." }, { "info": { "name": "Microsoft Azure Gets The Information About A Specified Service Type Of The Application Deployed On A Node In A Service Fabric Cluster", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/Nodes/:nodeName/$/GetApplications/:applicationId/$/GetServiceTypes/:serviceTypeName", "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": "applicationId", "value": "", "type": "path", "description": "The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme.\nStarting from version 6.0, hierarchical names are delimited with the \"~\" character.\nFor example, if the application name is \"fabric:/myapp/app1\", the application identity would be \"myapp~app1\" in 6.0+ and \"myapp/app1\" in previous versions." }, { "name": "serviceTypeName", "value": "", "type": "path", "description": "Specifies the name of a Service Fabric service type." }, { "name": "ServiceManifestName", "value": "", "type": "query", "description": "The name of the service manifest to filter the list of deployed service type information. If specified, the response will only contain the information about service types that are defined in this service manifest." }, { "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 list containing the information about a specific service type from the applications deployed on a node in a Service Fabric cluster. The response includes the name of the service type, its registration status, the code package that registered it and activation ID of the service package. Each entry represents one activation of a service type, differentiated by the activation ID." } ] } ], "bundled": true }