다음을 통해 공유


Deployments - Get At Subscription Scope

배포를 가져옵니다.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}?api-version=2021-04-01

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
deploymentName
path True

string

배포의 이름입니다.

regex 패턴: ^[-\w\._\(\)]+$

subscriptionId
path True

string

Microsoft Azure 구독 ID입니다.

api-version
query True

string

이 작업에 사용할 API 버전입니다.

응답

Name 형식 Description
200 OK

DeploymentExtended

OK - 프로비전 상태 포함하여 배포에 대한 정보를 반환합니다.

Other Status Codes

CloudError

작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name Description
user_impersonation 사용자 계정 가장

정의

Name Description
Alias

별칭 형식입니다.

AliasPath

별칭에 대한 경로의 형식입니다.

AliasPathAttributes

별칭 경로가 참조하는 토큰의 특성입니다.

AliasPathMetadata
AliasPathTokenType

별칭 경로가 참조하는 토큰의 형식입니다.

AliasPattern

별칭 경로에 대한 패턴의 형식입니다.

AliasPatternType

별칭 패턴의 형식

AliasType

별칭의 형식입니다.

ApiProfile
BasicDependency

배포 종속성 정보입니다.

CloudError

리소스 관리 요청에 대한 오류 응답입니다.

DebugSetting

디버그 설정입니다.

Dependency

배포 종속성 정보입니다.

DeploymentExtended

배포 정보입니다.

DeploymentMode

리소스를 배포하는 데 사용되는 모드입니다. 이 값은 증분 또는 완료일 수 있습니다. 증분 모드에서 리소스는 템플릿에 포함되지 않은 기존 리소스를 삭제하지 않고 배포됩니다. 전체 모드에서는 리소스가 배포되고 템플릿에 포함되지 않은 리소스 그룹의 기존 리소스가 삭제됩니다. 의도치 않게 리소스를 삭제할 수 있으므로 완료 모드를 사용할 때는 주의해야 합니다.

DeploymentPropertiesExtended

추가 세부 정보가 포함된 배포 속성입니다.

ErrorAdditionalInfo

리소스 관리 오류 추가 정보입니다.

ErrorResponse

오류 응답

OnErrorDeploymentExtended

추가 세부 정보가 포함된 오류 동작에 대한 배포.

OnErrorDeploymentType

오류 동작 유형에 대한 배포입니다. 가능한 값은 LastSuccessful 및 SpecificDeployment입니다.

ParametersLink

배포 매개 변수에 대한 참조를 나타내는 엔터티입니다.

Provider

리소스 공급자 정보입니다.

ProviderAuthorizationConsentState

공급자 권한 부여 동의 상태입니다.

ProviderExtendedLocation

공급자 확장 위치입니다.

ProviderResourceType

리소스 공급자가 관리하는 리소스 종류입니다.

ProvisioningState

프로비전 상태를 표시합니다.

ResourceReference

리소스 ID 모델입니다.

TemplateLink

템플릿에 대한 참조를 나타내는 엔터티입니다.

ZoneMapping

Alias

별칭 형식입니다.

Name 형식 Description
defaultMetadata

AliasPathMetadata

기본 별칭 경로 메타데이터입니다. 기본 경로 및 메타데이터가 없는 별칭 경로에 적용됩니다.

defaultPath

string

별칭의 기본 경로입니다.

defaultPattern

AliasPattern

별칭의 기본 패턴입니다.

name

string

별칭 이름입니다.

paths

AliasPath[]

별칭의 경로입니다.

type

AliasType

별칭의 형식입니다.

AliasPath

별칭에 대한 경로의 형식입니다.

Name 형식 Description
apiVersions

string[]

API 버전입니다.

metadata

AliasPathMetadata

별칭 경로의 메타데이터입니다. 누락된 경우 별칭의 기본 메타데이터로 대체합니다.

path

string

별칭의 경로입니다.

pattern

AliasPattern

별칭 경로에 대한 패턴입니다.

AliasPathAttributes

별칭 경로가 참조하는 토큰의 특성입니다.

Name 형식 Description
Modifiable

string

별칭 경로가 참조하는 토큰은 'modify' 효과가 있는 정책으로 수정할 수 있습니다.

None

string

별칭 경로가 참조하는 토큰에는 특성이 없습니다.

AliasPathMetadata

Name 형식 Description
attributes

AliasPathAttributes

별칭 경로가 참조하는 토큰의 특성입니다.

type

AliasPathTokenType

별칭 경로가 참조하는 토큰의 형식입니다.

AliasPathTokenType

별칭 경로가 참조하는 토큰의 형식입니다.

Name 형식 Description
Any

string

토큰 형식은 무엇이든 될 수 있습니다.

Array

string

토큰 형식은 배열입니다.

Boolean

string

토큰 유형이 부울입니다.

Integer

string

토큰 형식이 정수입니다.

NotSpecified

string

토큰 형식이 지정되지 않았습니다.

Number

string

토큰 유형은 number입니다.

Object

string

토큰 형식은 개체입니다.

String

string

토큰 형식은 문자열입니다.

AliasPattern

별칭 경로에 대한 패턴의 형식입니다.

Name 형식 Description
phrase

string

별칭 패턴 구입니다.

type

AliasPatternType

별칭 패턴의 형식

variable

string

별칭 패턴 변수입니다.

AliasPatternType

별칭 패턴의 형식

Name 형식 Description
Extract

string

추출은 유일하게 허용되는 값입니다.

NotSpecified

string

NotSpecified는 허용되지 않습니다.

AliasType

별칭의 형식입니다.

Name 형식 Description
Mask

string

별칭 값은 비밀입니다.

NotSpecified

string

별칭 형식을 알 수 없습니다(별칭 형식을 제공하지 않는 것과 동일).

PlainText

string

별칭 값은 비밀이 아닙니다.

ApiProfile

Name 형식 Description
apiVersion

string

API 버전입니다.

profileVersion

string

프로필 버전입니다.

BasicDependency

배포 종속성 정보입니다.

Name 형식 Description
id

string

종속성의 ID입니다.

resourceName

string

종속성 리소스 이름입니다.

resourceType

string

종속성 리소스 유형입니다.

CloudError

리소스 관리 요청에 대한 오류 응답입니다.

Name 형식 Description
error

ErrorResponse

오류 응답
실패한 작업에 대한 오류 세부 정보를 반환하는 모든 Azure Resource Manager API에 대한 일반적인 오류 응답입니다. OData 오류 응답 형식도 따릅니다.

DebugSetting

디버그 설정입니다.

Name 형식 Description
detailLevel

string

디버깅을 위해 기록할 정보의 유형을 지정합니다. 허용되는 값은 none, requestContent, responseContent 또는 requestContent 및 responseContent가 모두 쉼표로 구분되어 있습니다. 기본값은 none입니다. 이 값을 설정할 때 배포 중에 전달하는 정보의 유형을 신중하게 고려합니다. 요청 또는 응답에 대한 정보를 로깅하게 되면 배포 작업을 통해 검색되는 중요한 데이터가 노출될 가능성이 있기 때문입니다.

Dependency

배포 종속성 정보입니다.

Name 형식 Description
dependsOn

BasicDependency[]

종속성 목록입니다.

id

string

종속성의 ID입니다.

resourceName

string

종속성 리소스 이름입니다.

resourceType

string

종속성 리소스 유형입니다.

DeploymentExtended

배포 정보입니다.

Name 형식 Description
id

string

배포의 ID입니다.

location

string

배포의 위치입니다.

name

string

배포의 이름입니다.

properties

DeploymentPropertiesExtended

배포 속성입니다.

tags

object

배포 태그

type

string

배포의 유형입니다.

DeploymentMode

리소스를 배포하는 데 사용되는 모드입니다. 이 값은 증분 또는 완료일 수 있습니다. 증분 모드에서 리소스는 템플릿에 포함되지 않은 기존 리소스를 삭제하지 않고 배포됩니다. 전체 모드에서는 리소스가 배포되고 템플릿에 포함되지 않은 리소스 그룹의 기존 리소스가 삭제됩니다. 의도치 않게 리소스를 삭제할 수 있으므로 완료 모드를 사용할 때는 주의해야 합니다.

Name 형식 Description
Complete

string

Incremental

string

DeploymentPropertiesExtended

추가 세부 정보가 포함된 배포 속성입니다.

Name 형식 Description
correlationId

string

배포의 상관 관계 ID입니다.

debugSetting

DebugSetting

배포의 디버그 설정입니다.

dependencies

Dependency[]

배포 종속성 목록입니다.

duration

string

템플릿 배포 기간입니다.

error

ErrorResponse

오류 응답
배포 오류입니다.

mode

DeploymentMode

배포 모드입니다. 가능한 값은 증분 및 완료입니다.

onErrorDeployment

OnErrorDeploymentExtended

오류 동작에 대한 배포입니다.

outputResources

ResourceReference[]

프로비전된 리소스의 배열입니다.

outputs

object

배포 출력을 나타내는 키/값 쌍입니다.

parameters

object

배포 매개 변수입니다.

parametersLink

ParametersLink

매개 변수를 참조하는 URI입니다.

providers

Provider[]

배포에 필요한 리소스 공급자 목록입니다.

provisioningState

ProvisioningState

프로비전 상태를 표시합니다.

templateHash

string

템플릿에 대해 생성된 해시입니다.

templateLink

TemplateLink

템플릿을 참조하는 URI입니다.

timestamp

string

템플릿 배포의 타임스탬프입니다.

validatedResources

ResourceReference[]

유효성이 검사된 리소스의 배열입니다.

ErrorAdditionalInfo

리소스 관리 오류 추가 정보입니다.

Name 형식 Description
info

object

추가 정보입니다.

type

string

추가 정보 유형입니다.

ErrorResponse

오류 응답

Name 형식 Description
additionalInfo

ErrorAdditionalInfo[]

오류 추가 정보입니다.

code

string

오류 코드입니다.

details

ErrorResponse[]

오류 세부 정보입니다.

message

string

오류 메시지입니다.

target

string

오류 대상입니다.

OnErrorDeploymentExtended

추가 세부 정보가 포함된 오류 동작에 대한 배포.

Name 형식 Description
deploymentName

string

오류 사례에 사용할 배포입니다.

provisioningState

string

오류 배포 시 에 대한 프로비저닝 상태입니다.

type

OnErrorDeploymentType

오류 동작 유형에 대한 배포입니다. 가능한 값은 LastSuccessful 및 SpecificDeployment입니다.

OnErrorDeploymentType

오류 동작 유형에 대한 배포입니다. 가능한 값은 LastSuccessful 및 SpecificDeployment입니다.

Name 형식 Description
LastSuccessful

string

SpecificDeployment

string

배포 매개 변수에 대한 참조를 나타내는 엔터티입니다.

Name 형식 Description
contentVersion

string

포함된 경우 템플릿의 ContentVersion과 일치해야 합니다.

uri

string

매개 변수 파일의 URI입니다.

Provider

리소스 공급자 정보입니다.

Name 형식 Description
id

string

공급자 ID입니다.

namespace

string

리소스 공급자의 네임스페이스입니다.

providerAuthorizationConsentState

ProviderAuthorizationConsentState

공급자 권한 부여 동의 상태입니다.

registrationPolicy

string

리소스 공급자의 등록 정책입니다.

registrationState

string

리소스 공급자의 등록 상태입니다.

resourceTypes

ProviderResourceType[]

공급자 리소스 유형의 컬렉션입니다.

ProviderAuthorizationConsentState

공급자 권한 부여 동의 상태입니다.

Name 형식 Description
Consented

string

NotRequired

string

NotSpecified

string

Required

string

ProviderExtendedLocation

공급자 확장 위치입니다.

Name 형식 Description
extendedLocations

string[]

azure 위치에 대한 확장된 위치입니다.

location

string

azure 위치입니다.

type

string

확장된 위치 유형입니다.

ProviderResourceType

리소스 공급자가 관리하는 리소스 종류입니다.

Name 형식 Description
aliases

Alias[]

이 리소스 종류에서 지원하는 별칭입니다.

apiProfiles

ApiProfile[]

리소스 공급자에 대한 API 프로필입니다.

apiVersions

string[]

API 버전입니다.

capabilities

string

이 리소스 종류에서 제공하는 추가 기능입니다.

defaultApiVersion

string

기본 API 버전입니다.

locationMappings

ProviderExtendedLocation[]

이 리소스 종류에서 지원하는 위치 매핑입니다.

locations

string[]

이 리소스 종류를 만들 수 있는 위치의 컬렉션입니다.

properties

object

속성입니다.

resourceType

string

리소스 종류입니다.

zoneMappings

ZoneMapping[]

ProvisioningState

프로비전 상태를 표시합니다.

Name 형식 Description
Accepted

string

Canceled

string

Created

string

Creating

string

Deleted

string

Deleting

string

Failed

string

NotSpecified

string

Ready

string

Running

string

Succeeded

string

Updating

string

ResourceReference

리소스 ID 모델입니다.

Name 형식 Description
id

string

정규화된 리소스 ID입니다.

템플릿에 대한 참조를 나타내는 엔터티입니다.

Name 형식 Description
contentVersion

string

포함된 경우 템플릿의 ContentVersion과 일치해야 합니다.

id

string

템플릿 사양의 리소스 ID입니다. ID 또는 uri 속성을 사용하지만 둘 다 사용하지는 않습니다.

queryString

string

templateLink URI와 함께 사용할 쿼리 문자열(예: SAS 토큰)입니다.

relativePath

string

relativePath 속성을 사용하여 부모에 상대적인 위치에 연결된 템플릿을 배포할 수 있습니다. 부모 템플릿이 TemplateSpec과 연결된 경우 TemplateSpec에서 아티팩트를 참조합니다. 부모가 URI와 연결된 경우 자식 배포는 부모 및 relativePath URI의 조합이 됩니다.

uri

string

배포할 템플릿의 URI입니다. URI 또는 ID 속성을 사용하지만 둘 다 사용하지는 않습니다.

ZoneMapping

Name 형식 Description
location

string

영역 매핑의 위치입니다.

zones

string[]