Microsoft Azure Deployments API
Operations for managing model deployments
Microsoft Azure Deployments API is one of 1667 APIs that Microsoft Azure publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Deployment. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, pricing, a JSON-LD context, and a getting-started guide.
This API exposes 77 operations across 52 paths, and defines 199 schemas. It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.
77 operations
52 paths
199 schemas
9 DELETE18 GET5 HEAD2 PATCH35 POST8 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 77
Across 52 paths, the API surfaces 77 operations — 9 DELETE, 18 GET, 5 HEAD, 2 PATCH, 35 POST, 8 PUT. Each is listed below with its method, path, parameters, and response codes.
Deployments 77
Operations for managing model deployments
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/deployments
Microsoft Azure List Model Deployments
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/deployments/{deploymentName}
Microsoft Azure Get a Model Deployment
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/deployments/{deploymentName}
Microsoft Azure Create or Update a Model Deployment
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/deployments/{deploymentName}
Microsoft Azure Delete a Model Deployment
POST
/deployments/{deploymentId}/audio/speech
Microsoft Azure Post Deployments Deploymentid Audio Speech
POST
/deployments/{deploymentId}/audio/transcriptions
Microsoft Azure Post Deployments Deploymentid Audio Transcriptions
POST
/deployments/{deploymentId}/audio/translations
Microsoft Azure Post Deployments Deploymentid Audio Translations
POST
/deployments/{deploymentId}/chat/completions
Microsoft Azure Post Deployments Deploymentid Chat Completions
POST
/deployments/{deploymentId}/completions
Microsoft Azure Post Deployments Deploymentid Completions
POST
/deployments/{deploymentId}/embeddings
Microsoft Azure Post Deployments Deploymentid Embeddings
POST
/deployments/{deploymentId}/images/generations
Microsoft Azure Post Deployments Deploymentid Images Generations
GET
/deployments
Microsoft Azure Gets The List Of Deployments Owned By The Azure Openai Resource
POST
/deployments
Microsoft Azure Creates A New Deployment For The Azure Openai Resource According To The Given Specification
GET
/deployments/{deployment_id}
Microsoft Azure Gets Details For A Single Deployment Specified By The Given Deployment Id
PATCH
/deployments/{deployment_id}
Microsoft Azure Updates The Mutable Details Of The Deployment With The Given Deployment Id
DELETE
/deployments/{deployment_id}
Microsoft Azure Deletes The Deployment Specified By The Given Deployment Id
GET
/deployments/{deployment-id}
Microsoft Azure Gets Details For A Single Deployment Specified By The Given Deployment Id
PATCH
/deployments/{deployment-id}
Microsoft Azure Updates The Mutable Details Of The Deployment With The Given Deployment Id
DELETE
/deployments/{deployment-id}
Microsoft Azure Deletes The Deployment Specified By The Given Deployment Id
POST
/deployments/{deployment-id}/completions
Microsoft Azure Creates A Completion For The Provided Prompt, Parameters And Chosen Model
POST
/deployments/{deployment-id}/embeddings
Microsoft Azure Get A Vector Representation Of A Given Input That Can Be Easily Consumed By Machine Learning Models And Algorithms
POST
/deployments/{deployment-id}/chat/completions
Microsoft Azure Creates A Completion For The Chat Message
POST
/deployments/{deployment-id}/audio/transcriptions
Microsoft Azure Transcribes Audio Into The Input Language
POST
/deployments/{deployment-id}/audio/translations
Microsoft Azure Transcribes And Translates Input Audio Into English Text
POST
/deployments/{deployment-id}/audio/speech
Microsoft Azure Generates Audio From The Input Text
POST
/deployments/{deployment-id}/images/generations
Microsoft Azure Generates A Batch Of Images From A Text Caption On A Given Dalle Model Deployment
PUT
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/deployments/{deploymentName}
Microsoft Azure Create or Update a Deployment
GET
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/deployments/{deploymentName}
Microsoft Azure Get a Deployment
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/deployments
Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname Products Productname Devicegroups Devicegroupname Deployments
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/deployments/{deploymentName}
Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname Products Productname Devicegroups Devicegroupname Deployments Deploymentname
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/deployments/{deploymentName}
Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname Products Productname Devicegroups Devicegroupname Deployments Deploymentname
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/deployments/{deploymentName}
Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname Products Productname Devicegroups Devicegroupname Deployments Deploymentname
DELETE
/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}
Microsoft Azure Deletes A Deployment From The Deployment History
HEAD
/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}
Microsoft Azure Head Scope Providers Microsoft Resources Deployments Deploymentname
PUT
/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}
Microsoft Azure Deploys Resources At A Given Scope
GET
/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}
Microsoft Azure Get Scope Providers Microsoft Resources Deployments Deploymentname
POST
/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel
Microsoft Azure Cancels A Currently Running Template Deployment
POST
/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/validate
Microsoft Azure Post Scope Providers Microsoft Resources Deployments Deploymentname Validate
POST
/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate
Microsoft Azure Post Scope Providers Microsoft Resources Deployments Deploymentname Exporttemplate
GET
/{scope}/providers/Microsoft.Resources/deployments/
Microsoft Azure Get Scope Providers Microsoft Resources Deployments
DELETE
/providers/Microsoft.Resources/deployments/{deploymentName}
Microsoft Azure Deletes A Deployment From The Deployment History
HEAD
/providers/Microsoft.Resources/deployments/{deploymentName}
Microsoft Azure Head Providers Microsoft Resources Deployments Deploymentname
PUT
/providers/Microsoft.Resources/deployments/{deploymentName}
Microsoft Azure Deploys Resources At Tenant Scope
GET
/providers/Microsoft.Resources/deployments/{deploymentName}
Microsoft Azure Get Providers Microsoft Resources Deployments Deploymentname
POST
/providers/Microsoft.Resources/deployments/{deploymentName}/cancel
Microsoft Azure Cancels A Currently Running Template Deployment
POST
/providers/Microsoft.Resources/deployments/{deploymentName}/validate
Microsoft Azure Post Providers Microsoft Resources Deployments Deploymentname Validate
POST
/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf
Microsoft Azure Post Providers Microsoft Resources Deployments Deploymentname Whatif
POST
/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate
Microsoft Azure Post Providers Microsoft Resources Deployments Deploymentname Exporttemplate
GET
/providers/Microsoft.Resources/deployments/
Microsoft Azure Get Providers Microsoft Resources Deployments
DELETE
/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}
Microsoft Azure Deletes A Deployment From The Deployment History
HEAD
/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}
Microsoft Azure Head Providers Microsoft Management Managementgroups Groupid Providers Microsoft Resources Deployments Deploymentname
PUT
/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}
Microsoft Azure Deploys Resources At Management Group Scope
GET
/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}
Microsoft Azure Get Providers Microsoft Management Managementgroups Groupid Providers Microsoft Resources Deployments Deploymentname
POST
/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel
Microsoft Azure Cancels A Currently Running Template Deployment
POST
/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/validate
Microsoft Azure Post Providers Microsoft Management Managementgroups Groupid Providers Microsoft Resources Deployments Deploymentname Validate
POST
/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf
Microsoft Azure Post Providers Microsoft Management Managementgroups Groupid Providers Microsoft Resources Deployments Deploymentname Whatif
POST
/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate
Microsoft Azure Post Providers Microsoft Management Managementgroups Groupid Providers Microsoft Resources Deployments Deploymentname Exporttemplate
GET
/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/
Microsoft Azure Get Providers Microsoft Management Managementgroups Groupid Providers Microsoft Resources Deployments
DELETE
/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}
Microsoft Azure Deletes A Deployment From The Deployment History
HEAD
/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}
Microsoft Azure Head Subscriptions Subscriptionid Providers Microsoft Resources Deployments Deploymentname
PUT
/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}
Microsoft Azure Deploys Resources At Subscription Scope
GET
/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}
Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Resources Deployments Deploymentname
POST
/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel
Microsoft Azure Cancels A Currently Running Template Deployment
POST
/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/validate
Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Resources Deployments Deploymentname Validate
POST
/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf
Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Resources Deployments Deploymentname Whatif
POST
/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate
Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Resources Deployments Deploymentname Exporttemplate
GET
/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/
Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Resources Deployments
DELETE
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}
Microsoft Azure Deletes A Deployment From The Deployment History
HEAD
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}
Microsoft Azure Head Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Resources Deployments Deploymentname
PUT
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}
Microsoft Azure Deploys Resources To A Resource Group
GET
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Resources Deployments Deploymentname
POST
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel
Microsoft Azure Cancels A Currently Running Template Deployment
POST
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/validate
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Resources Deployments Deploymentname Validate
POST
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Resources Deployments Deploymentname Whatif
POST
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Resources Deployments Deploymentname Exporttemplate
GET
/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Resources Deployments
POST
/providers/Microsoft.Resources/calculateTemplateHash
Microsoft Azure Post Providers Microsoft Resources Calculatetemplatehash
Schemas 199
The contract defines 199 schemas that model the data the API accepts and returns. The most detailed are ChatCompletionsOptions (22 properties), DeploymentPropertiesExtended_2 (17 properties), CompletionsOptions (16 properties), audioSegment (10 properties). Each schema is shown below with its type and property counts.
CompletionsUsage
object
Representation of the token counts processed for a completions request. Counts consider all tokens across prompts, choices, choice alternates, bestof generatio…
3 properties
3 required
contentFilterResultBase
object
1 property
1 required
Azure.Core.Foundations.Error
object
The error object.
5 properties
2 required
DeploymentWhatIfSettings
object
Deployment What-If operation settings.
1 property
audioResponse
object
Translation or transcription response when responseformat was json
1 property
1 required
chatCompletionFunctionCall
object
Deprecated and replaced by toolcalls. The name and arguments of a function that should be called, as generated by the model.
2 properties
2 required
CloudError_2
object
An error response for a resource management request.
1 property
AzureChatEnhancements
object
Represents the output results of Azure enhancements to chat completions, as configured via the matching input provided in the request.
1 property
ContentFilterResult
object
Information about filtered content severity level and if it has been filtered or not.
2 properties
2 required
span
object
A span object that represents a detected object and its bounding box information.
4 properties
4 required
DeploymentUpdate
object
Defines changes to the deployment.
2 properties
contentFilterPromptResults
object
Information about the content filtering category (hate, sexual, violence, selfharm), if it has been detected, as well as the severity level (verylow, low, medi…
errorResponse
object
1 property
EmbeddingsOptions
object
The configuration information for an embeddings request. Embeddings measure the relatedness of text strings and are commonly used for search, clustering, recom…
6 properties
1 required
ContentFilterResultsForChoice
object
Information about content filtering evaluated against generated model output.
9 properties
InnerError
object
Inner error as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md7102-error-condition-responses).
2 properties
ProviderExtendedLocation
object
The provider extended location.
3 properties
imageQuality
string
The quality of the image that will be generated.
ImageGenerationOptions
object
Represents the request data used to generate images.
8 properties
1 required
AzureChatExtensionsMessageContext
object
A representation of the additional context information available when Azure OpenAI chat extensions are involved in the generation of a corresponding chat compl…
2 properties
contentFilterChoiceResults
object
Information about the content filtering category (hate, sexual, violence, selfharm), if it has been detected, as well as the severity level (verylow, low, medi…
AzureChatOCREnhancementConfiguration
object
A representation of the available options for the Azure OpenAI optical character recognition (OCR) enhancement.
1 property
1 required
chatCompletionNamedToolChoice
object
Specifies a tool the model should use. Use to force the model to call a specific function.
2 properties
errorBase
object
2 properties
ScopedDeployment
object
Deployment operation parameters.
3 properties
2 required
Azure.Core.Foundations.InnerError
object
An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Gu…
2 properties
dalleErrorResponse
object
1 property
ErrorResponse_2_2
object
Error response as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md7102-error-condition-responses).
1 property
1 required
Deployment_2
object
Deployments manage the reserved quota for Azure OpenAI models and make them available for inference requests.
9 properties
2 required
FunctionCall
object
The name and arguments of a function that should be called, as generated by the model.
2 properties
2 required
citation
object
citation information for a chat completions response message.
5 properties
1 required
Embeddings
object
Representation of the response data from an embeddings request. Embeddings measure the relatedness of text strings and are commonly used for search, clustering…
2 properties
2 required
imageResult
object
The image url or encoded image if successful, and an error otherwise.
5 properties
DebugSetting
object
The debug setting.
1 property
State_2
string
The state of a job or item.
DeploymentPropertiesExtended
object
Deployment properties with additional details.
6 properties
DebugSetting_2
object
The debug setting.
1 property
SpeechVoice
string
The available voices for text-to-speech.
Completions
object
Representation of the response data from a completions request. Completions support a wide variety of tasks and generate text that continues from or "completes…
5 properties
4 required
line
object
A content line object consisting of an adjacent sequence of content elements, such as words and selection marks.
2 properties
2 required
AzureGroundingEnhancementCoordinatePoint
object
A representation of a single polygon point as used by the Azure grounding enhancement.
2 properties
2 required
EmbeddingsUsage
object
Measurement of the amount of tokens used in this request and response.
2 properties
2 required
DeploymentParameter
object
Deployment parameter for the template.
2 properties
AliasPathMetadata
object
2 properties
chatCompletionTokenLogprob
object
4 properties
4 required
AzureChatEnhancementConfiguration
object
A representation of the available Azure OpenAI enhancement configurations.
2 properties
createTranslationRequest
object
Translation request.
4 properties
1 required
State
string
The state of a job or item.
DeploymentListResult_2
object
List of deployments.
2 properties
CloudError
object
An error response for a resource management request.
1 property
audioVerboseResponse
object
Translation or transcription response when responseformat was verbosejson
1 required
dalleContentFilterResults
object
Information about the content filtering results.
4 properties
AliasPath
object
The type of the paths for alias.
4 properties
innerError
object
Inner error with additional details.
2 properties
createTranscriptionRequest
object
Transcription request.
5 properties
1 required
error
object
3 properties
imageStyle
string
The style of the generated images.
CompletionsOptions
object
The configuration information for a completions request. Completions support a wide variety of tasks and generate text that continues from or "completes" provi…
16 properties
1 required
AzureGroundingEnhancementLine
object
A content line object consisting of an adjacent sequence of content elements, such as words and selection marks.
2 properties
2 required
ImageType
string
Image type values.
CompletionsLogProbabilityModel
object
Representation of a log probabilities model for a completions generation.
4 properties
4 required
FunctionDefinition
object
The definition of a caller-specified function that chat completions may invoke in response to matching user input.
3 properties
1 required
ChatCompletionsOptions
object
The configuration information for a chat completions request. Completions support a wide variety of tasks and generate text that continues from or "completes"…
22 properties
1 required
OnErrorDeploymentExtended
object
Deployment on error behavior with additional details.
3 properties
ContentFilterResultsForPrompt
object
Content filtering results for a single prompt in the request.
2 properties
2 required
dalleFilterResults
object
Information about the content filtering category (hate, sexual, violence, selfharm), if it has been detected, as well as the severity level (verylow, low, medi…
RegionalDataBoundary
string
Regional data boundary values.
Provider
object
Resource provider information.
6 properties
InnerErrorCode
string
Inner error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md7102-error-condition-respons…
contentFilterDetectedWithCitationResult
object
2 required
generateImagesResponse
object
2 properties
2 required
ImageGenerations
object
The result of a successful image generation operation.
2 properties
2 required
DeploymentProperties
object
Properties of Cognitive Services account deployment.
6 properties
chatCompletionResponseMessageRole
string
The role of the author of the response message.
KeyVaultReference
object
Azure Key Vault reference.
1 property
1 required
DeploymentWhatIf
object
Deployment What-if operation parameters.
2 properties
1 required
chatCompletionResponseFormat
stringnull
Setting to jsonobject enables JSON mode. This guarantees that the message the model generates is valid JSON.
AzureChatExtensionConfiguration
object
A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat completions request that should use Azure OpenAI c…
1 property
1 required
audioSegment
object
Transcription or translation segment.
10 properties
chatCompletionResponseObject
string
The object type.
chatCompletionChoiceLogProbs
objectnull
Log probability information for the choice.
1 property
1 required
ScopedDeploymentWhatIf
object
Deployment What-if operation parameters.
2 properties
2 required
ChatChoiceLogProbabilityInfo
object
Log probability information for a choice, as requested via 'logprobs' and 'toplogprobs'.
1 property
1 required
chatCompletionToolChoiceOption
Controls which (if any) function is called by the model. none means the model will not call a function and instead generates a message. auto means the model ca…
chatCompletionFunctionParameters
object
The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/gpt/function-calling) for examples, and the [JSON Schema…
Deployment_4
object
An deployment resource belonging to a device group resource.
1 property
ExpressionEvaluationOptions
object
Specifies whether template expressions are evaluated within the scope of the parent template or nested template.
1 property
ImageGenerationContentFilterResults
object
Describes the content filtering result for the image generation request.
4 properties
ErrorResponse_3
object
Common error response for all Azure Resource Manager APIs.
5 properties
promptFilterResults
array
Content filtering results for zero or more prompts in the request. In a streaming request, results for different prompts may arrive at different times or in di…
ScaleSettings
object
The scale settings of a deployment. It defines the modes for scaling and the reserved capacity.
1 property
1 required
Deployment_5
object
Deployment operation parameters.
3 properties
1 required
ChatCompletionsResponseFormat
object
An abstract representation of a response format configuration usable by Chat Completions. Can be used to enable JSON mode.
1 property
1 required
ChatResponseMessage
object
A representation of a chat message as received in a response.
5 properties
2 required
ContentFilterResultDetailsForPrompt
object
Information about content filtering evaluated against input data to Azure OpenAI.
8 properties
ChatTokenLogProbabilityInfo
object
A representation of the log probability information for a single message content token.
3 properties
3 required
ChatRole
string
A description of the intended purpose of a message within a chat completions interaction.
DeploymentProperties_2
object
Deployment properties.
6 properties
1 required
AzureGroundingEnhancement
object
The grounding enhancement that returns the bounding box of the objects detected in the image.
1 property
1 required
chatCompletionRequestMessageRole
string
The role of the messages author.
DeploymentProperties_2_2
object
Deployment properties.
8 properties
1 required
ContentFilterBlocklistIdResult
object
Represents the outcome of an evaluation against a custom blocklist as performed by content filtering.
2 properties
2 required
ScaleType
string
Defines how scaling operations will be executed.
Error
object
Error content as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md7102-error-condition-responses).
5 properties
2 required
AzureChatGroundingEnhancementConfiguration
object
A representation of the available options for the Azure OpenAI grounding enhancement.
1 property
1 required
Choice
object
The representation of a single prompt completion as part of an overall completions request. Generally, n choices are generated per provided prompt with a defau…
5 properties
4 required
completionUsage
object
Usage statistics for the completion request.
3 properties
3 required
DeploymentWhatIfProperties
object
Deployment What-if properties.
1 property
ErrorCode
string
Error codes as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md7102-error-condition-responses).
ParametersLink
object
Entity representing the reference to the deployment parameters.
2 properties
1 required
DeploymentExtended_2
object
Deployment information.
6 properties
SpeechGenerationOptions
object
A representation of the request options that control the behavior of a text-to-speech operation.
5 properties
2 required
toolCallType
string
The type of the tool call, in this case function.
DeploymentUpdate_2
object
Defines changes to the deployment.
2 properties
ApiProfile
object
2 properties
TemplateLink_2
object
Entity representing the reference to the template.
5 properties
ChatTokenLogProbabilityResult
object
A representation of the log probability information for a single content token, including a list of most likely tokens if 'toplogprobs' were requested.
4 properties
4 required
EmbeddingItem
object
Representation of a single embeddings relatedness comparison.
2 properties
2 required
createSpeechRequest
object
Speech request.
4 properties
2 required
imageSize
string
The size of the generated images.
ProvisioningState
string
Provisioning state of resource.
AzureChatExtensionDataSourceResponseCitation
object
A single instance of additional context information available when Azure OpenAI chat extensions are involved in the generation of a corresponding chat completi…
5 properties
1 required
chatCompletionTool
object
2 properties
2 required
DeploymentProperties_3
object
The properties of deployment
4 properties
audioResponseFormat
string
Defines the format of the output.
DeploymentValidateResult
object
Information from validate template deployment response.
2 properties
enhancement
object
1 property
chatCompletionsResponseCommon
object
6 properties
4 required
DeploymentModel
object
Properties of the deployment model.
4 properties
3 required
chatCompletionMessageToolCall
object
3 properties
3 required
ProviderResourceType
object
Resource type managed by the resource provider.
10 properties
DeploymentExportResult
object
The deployment export result.
1 property
AliasPattern
object
The type of the pattern for an alias path.
3 properties
azureChatExtensionConfiguration
object
A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat completions request that should use Azure OpenAI c…
1 property
1 required
promptFilterResult
object
Content filtering results for a single prompt in the request.
2 properties
WhatIfOperationResult
object
Result of the What-If operation. Contains a list of predicted changes and a URL link to get to the next set of results.
3 properties
imageGenerationsRequest
object
7 properties
1 required
imagesResponseFormat
string
The format in which the generated images are returned.
WhatIfPropertyChange
object
The predicted change to the resource property.
5 properties
2 required
ContentFilterDetectionResult
object
Represents the outcome of a detection operation performed by content filtering.
2 properties
2 required
Alias
object
The alias type.
6 properties
DeploymentExtended
object
Deployment information.
6 properties
DeploymentListResult_3
object
The response of a Deployment list operation.
2 properties
1 required
createChatCompletionResponse
object
5 required
Image
object
An image resource belonging to a catalog resource.
1 property
ContentFilterCitedDetectionResult
object
Represents the outcome of a detection operation against protected resources as performed by content filtering.
4 properties
3 required
ErrorAdditionalInfo
object
The resource management error additional info.
2 properties
TemplateHashResult
object
Result of the request to calculate template hash. It contains a string of minified template and its hash.
2 properties
BasicDependency
object
Deployment dependency information.
3 properties
contentFilterDetectedResult
object
2 required
chatCompletionRequestMessage
object
1 property
1 required
ChatCompletions
object
Representation of the response data from a chat completions request. Completions support a wide variety of tasks and generate text that continues from or "comp…
7 properties
4 required
createChatCompletionRequest
object
1 required
ChatCompletionsToolCall
object
An abstract representation of a tool call that must be resolved in a subsequent request to perform the requested chat completion.
2 properties
2 required
chatCompletionToolType
string
The type of the tool. Currently, only function is supported.
ErrorResponse_2
object
Error response as defined in the Microsoft REST guidelines (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md7102-error-condition-responses).
1 property
ImageGenerationData
object
A representation of a single generated image, provided as either base64-encoded data or as a URL from which the image may be retrieved.
5 properties
Deployment
object
Cognitive Services account deployment.
6 properties
KeyVaultParameterReference
object
Azure Key Vault parameter reference.
3 properties
2 required
chatCompletionResponseMessage
object
A chat completion message generated by the model.
5 properties
ParametersLink_2
object
Entity representing the reference to the deployment parameters.
2 properties
1 required
ContentFilterSeverity
string
Ratings for the intensity and risk level of harmful content.
Deployment_3
object
Deployment operation parameters.
3 properties
1 required
contentFilterIdResult
object
2 required
ChatRequestMessage
object
An abstract representation of a chat message as provided in a request.
1 property
1 required
azureChatExtensionType
string
A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat completions request that should use Azure OpenAI c…
DeploymentListResult
object
The list of cognitive services account deployments.
2 properties
Dependency
object
Deployment dependency information.
4 properties
TemplateLink
object
Entity representing the reference to the template.
2 properties
1 required
WhatIfChange
object
Information about a single resource change predicted by What-If operation.
6 properties
2 required
DeploymentList
object
Represents a list of deployments.
2 properties
ChatFinishDetails
object
An abstract representation of structured information about why a chat completions response terminated.
1 property
1 required
ZoneMapping
object
2 properties
ChatChoice
object
The representation of a single prompt completion as part of an overall chat completions request. Generally, n choices are generated per provided prompt with a…
8 properties
3 required
ImageGenerationPromptFilterResults
object
Describes the content filtering results for the prompt of a image generation request.
6 properties
OnErrorDeployment
object
Deployment on error behavior.
2 properties
chatCompletionFunction
object
3 properties
1 required
CompletionsFinishReason
string
Representation of the manner in which a completions response concluded.
Sku
object
The resource model definition representing SKU.
2 properties
1 required
innerErrorCode
string
Error codes for the inner error object.
Deployment_6
object
Deployments manage the reserved quota for Azure OpenAI models and make them available for inference requests.
8 properties
2 required
DeploymentPropertiesExtended_2
object
Deployment properties with additional details.
17 properties
AzureChatExtensionType
string
A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat completions request that should use Azure OpenAI c…
Azure.Core.Foundations.ErrorResponse
object
A response containing error details.
1 property
1 required
ScaleSettingsUpdate
object
The scale settings of a deployment. It defines the modes for scaling and the reserved capacity.
1 property
1 required
ChatCompletionsToolDefinition
object
An abstract representation of a tool that can be used by the model to improve a chat completions response.
1 property
1 required
AzureGroundingEnhancementLineSpan
object
A span object that represents a detected object and its bounding box information.
4 properties
4 required
contentFilterSeverityResult
object
2 required
ErrorResponse
object
Error response.
1 property
ImageProperties
object
The properties of image
9 properties
WhatIfOperationProperties
object
Deployment operation properties.
1 property
chatCompletionsRequestCommon
object
9 properties
dalleInnerError
object
Inner error with additional details.
3 properties
dalleError
object
3 properties
azureChatExtensionsMessageContext
object
A representation of the additional context information available when Azure OpenAI chat extensions are involved in the generation of a corresponding chat compl…
2 properties
TypeDiscriminator
string
Defines the type of an object.
contentFilterResultsBase
object
Information about the content filtering results.
7 properties
chatCompletionChoiceCommon
object
2 properties
ResourceReference
object
The resource Id model.
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Microsoft Azure 12
Other APIs Microsoft Azure publishes across the network.
Microsoft Azure AI Search API
Microsoft Azure Communication Services API
Microsoft Azure Event Grid API
Microsoft Azure Functions API
Microsoft Azure DevOps REST API
Microsoft Azure AI Foundry API
Microsoft Azure Resource JSON Schema
Microsoft Azure JSON-LD Context
Microsoft Azure AccessConnector API
Microsoft Azure AccessControlRecords API
Microsoft Azure AccessPolicies API
Microsoft Azure AccessReviewInstanceAcceptRecommmendations API
#Deployment
Where this information came from
This is an independent, third-party profile of Microsoft Azure Deployments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.