Text Analysis Authoring - List Assigned Resource Deployments

Service:: Azure AI Services

API Version:: 2023-11-15-preview

Lists the deployments to which an Azure resource is assigned. This doesn't return deployments belonging to projects owned by this resource. It only returns deployments belonging to projects owned by other resources.

GET {Endpoint}/language/authoring/analyze-text/projects/global/deployments/resources?api-version=2023-11-15-preview

With optional parameters:

GET {Endpoint}/language/authoring/analyze-text/projects/global/deployments/resources?top={top}&skip={skip}&maxpagesize={maxpagesize}&api-version=2023-11-15-preview

URI Parameters

Name	In	Required	Type	Description
api-version	query	True	string	Client API version.
maxpagesize	query		integer (int32)	The maximum number of resources to include in a single response.
skip	query		integer (int32)	An offset into the collection of the first resource to be returned.
top	query		integer (int32)	The maximum number of resources to return from the collection.

Responses

Name	Type	Description
200 OK	TextAnalysisAuthoringAssignedResourceDeploymentsMetadata	The assigned deployments metadata for the resource.
Other Status Codes	ErrorResponse	Error response.

Security

AADToken

These are the Azure Active Directory OAuth2 Flows. When paired with Azure role-based access control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.

To implement scenarios, we recommend viewing authentication concepts. In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.

Notes

This security definition requires the use of the x-ms-client-id header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the Maps management API.

The Authorization URL is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. * The Azure role-based access control is configured from the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs. * Usage of the Azure Maps Web SDK allows for configuration based setup of an application for multiple use cases.

Currently, Azure Active Directory v1.0 or v2.0 supports Work, School, and Guests but does not support Personal accounts.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
https://cognitiveservices.azure.com/.default	https://cognitiveservices.azure.com/.default

Ocp-Apim-Subscription-Key

A subscription key for a Language service resource.

Type: apiKey
In: header

Examples

Successful List Assigned Resource Deployments

Sample request

HTTP

GET {Endpoint}/language/authoring/analyze-text/projects/global/deployments/resources?api-version=2023-11-15-preview

Sample response

Status code:: 200

{
  "value": [
    {
      "projectName": "Booking",
      "deploymentsMetadata": [
        {
          "deploymentName": "staging",
          "lastDeployedDateTime": "2022-04-18T14:49:01Z",
          "deploymentExpirationDate": "2023-10-28"
        }
      ]
    }
  ],
  "nextLink": null
}

Definitions

Name	Description
Error	The error object.
ErrorCode	Human-readable error code.
ErrorResponse	Error response.
InnerErrorCode	Human-readable error code.
InnerErrorModel	An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
TextAnalysisAuthoringAssignedProjectDeploymentMetadata	Represents the metadata for an assigned deployment
TextAnalysisAuthoringAssignedProjectDeploymentsMetadata	Represents the metadata for assigned deployments for a project.
TextAnalysisAuthoringAssignedResourceDeploymentsMetadata	Represents the metadata for deployments assigned to a resource.

Error

Object

The error object.

Name	Type	Description
code	ErrorCode	One of a server-defined set of error codes.
details	Error[]	An array of details about specific errors that led to this reported error.
innererror	InnerErrorModel	An object containing more specific information than the current object about the error.
message	string	A human-readable representation of the error.
target	string	The target of the error.

ErrorCode

Enumeration

Human-readable error code.

Value	Description
InvalidRequest
InvalidArgument
Unauthorized
Forbidden
NotFound
ProjectNotFound
OperationNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchIndexNotFound
TooManyRequests
AzureCognitiveSearchThrottling
AzureCognitiveSearchIndexLimitReached
InternalServerError
ServiceUnavailable
Timeout
QuotaExceeded
Conflict
Warning

ErrorResponse

Object

Error response.

Name	Type	Description
error	Error	The error object.

InnerErrorCode

Enumeration

Human-readable error code.

Value	Description
InvalidRequest
InvalidParameterValue
KnowledgeBaseNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure
InvalidRequestBodyFormat
EmptyRequest
MissingInputDocuments
InvalidDocument
ModelVersionIncorrect
InvalidDocumentBatch
UnsupportedLanguageCode
InvalidCountryHint

InnerErrorModel

Object

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	InnerErrorCode	One of a server-defined set of error codes.
details	object	Error details.
innererror	InnerErrorModel	An object containing more specific information than the current object about the error.
message	string	Error message.
target	string	Error target.

TextAnalysisAuthoringAssignedProjectDeploymentMetadata

Object

Represents the metadata for an assigned deployment

Name	Type	Description
deploymentExpirationDate	string (date)	Represents deployment expiration date in the runtime.
deploymentName	string	Represents the deployment name.
lastDeployedDateTime	string (date-time)	Represents deployment last deployed time.

TextAnalysisAuthoringAssignedProjectDeploymentsMetadata

Object

Represents the metadata for assigned deployments for a project.

Name	Type	Description
deploymentsMetadata	TextAnalysisAuthoringAssignedProjectDeploymentMetadata[]	Represents the resource region.
projectName	string	Represents the project name.

TextAnalysisAuthoringAssignedResourceDeploymentsMetadata

Object

Represents the metadata for deployments assigned to a resource.

Name	Type	Description
nextLink	string	The next page link.
value	TextAnalysisAuthoringAssignedProjectDeploymentsMetadata[]	The list of retrieved assigned project deployments.

Share via

Text Analysis Authoring - List Assigned Resource Deployments

URI Parameters

Responses

Security

AADToken

Notes

Scopes

Ocp-Apim-Subscription-Key

Examples

Successful List Assigned Resource Deployments

Sample request

Sample response

Definitions

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

TextAnalysisAuthoringAssignedProjectDeploymentMetadata

TextAnalysisAuthoringAssignedProjectDeploymentsMetadata

TextAnalysisAuthoringAssignedResourceDeploymentsMetadata