Api Deployments - Get Deployment
Get an API deployment.
GET https://{serviceName}.data.azure-apicenter.net/workspaces/{workspaceName}/apis/{apiName}/deployments/{deploymentName}?api-version=2024-02-01-preview
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
api
|
path | True |
string |
Api identifier. |
deployment
|
path | True |
string |
Deployment identifier. |
service
|
path | True |
string |
Region-unique API Center service name |
workspace
|
path | True |
string |
Workspace identifier. |
api-version
|
query | True |
string |
The API version to use for this operation. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
The request has succeeded. |
|
Other Status Codes |
An unexpected error response. Headers x-ms-error-code: string |
Security
AadOauth2Auth
The Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
accessCode
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Token URL:
https://login.microsoftonline.com/common/oauth2/token
Scopes
Name | Description |
---|---|
https://azure-apicenter.net/user_impersonation |
Examples
ApiDeployments_GetDeployment
Sample request
GET https://{serviceName}.data.azure-apicenter.net/workspaces/eeoezynpqqgtykbukjcelrwvomtccvbjwntxfqh/apis/lauuo/deployments/ffc?api-version=2024-02-01-preview
Sample response
{
"name": "production",
"title": "Production",
"description": "Production deployment (Public Cloud)",
"environment": "public",
"server": {
"runtimeUris": [
"https://contoso.azure-api.net"
]
},
"recommended": true
}
Definitions
Name | Description |
---|---|
Api |
API deployment resource model. |
Api |
Api Deployment Server |
Azure. |
The error object. |
Azure. |
A response containing error details. |
Azure. |
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. |
ApiDeployment
API deployment resource model.
Name | Type | Description |
---|---|---|
customProperties |
object |
The custom metadata defined for API deployment entities. |
description |
string |
The description of the deployment. |
environment |
string |
The name of the deployment environment. |
name |
string |
Deployment identifier. |
recommended |
boolean |
Indicates if this is currently recommended deployment. |
server |
The server information of the API deployment. |
|
title |
string |
The name of the deployment. |
ApiDeploymentServer
Api Deployment Server
Name | Type | Description |
---|---|---|
runtimeUris |
string[] |
Base runtime URIs for this deployment. |
Azure.Core.Foundations.Error
The error object.
Name | Type | Description |
---|---|---|
code |
string |
One of a server-defined set of error codes. |
details |
An array of details about specific errors that led to this reported error. |
|
innererror |
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. |
Azure.Core.Foundations.ErrorResponse
A response containing error details.
Name | Type | Description |
---|---|---|
error |
The error object. |
Azure.Core.Foundations.InnerError
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 |
string |
One of a server-defined set of error codes. |
innererror |
Inner error. |