Cloud Services - Get
클라우드 서비스에 대한 정보를 표시합니다.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}?api-version=2024-11-04
URI 매개 변수
Name | In(다음 안에) | 필수 | 형식 | Description |
---|---|---|---|---|
cloud
|
path | True |
string |
클라우드 서비스의 이름입니다. |
resource
|
path | True |
string |
리소스 그룹의 이름입니다. |
subscription
|
path | True |
string |
Microsoft Azure 구독을 고유하게 식별하는 구독 자격 증명입니다. 구독 ID는 모든 서비스 호출에 대한 URI의 일부를 형성합니다. |
api-version
|
query | True |
string |
클라이언트 API 버전입니다. |
응답
Name | 형식 | Description |
---|---|---|
200 OK |
그래 |
|
Other Status Codes |
오류 |
보안
azure_auth
Azure Active Directory OAuth2 Flow
형식:
oauth2
Flow:
implicit
권한 부여 URL:
https://login.microsoftonline.com/common/oauth2/authorize
범위
Name | Description |
---|---|
user_impersonation | 사용자 계정 가장 |
예제
Get Cloud Service with Multiple Roles and RDP Extension
샘플 요청
GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}?api-version=2024-11-04
샘플 응답
{
"name": "{cs-name}",
"id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}",
"type": "Microsoft.Compute/cloudServices",
"location": "eastus2euap",
"properties": {
"configuration": "{ServiceConfiguration}",
"upgradeMode": "Auto",
"roleProfile": {
"roles": [
{
"name": "ContosoFrontend",
"sku": {
"name": "Standard_D1_v2",
"tier": "Standard",
"capacity": 2
}
},
{
"name": "ContosoBackend",
"sku": {
"name": "Standard_D1_v2",
"tier": "Standard",
"capacity": 2
}
}
]
},
"osProfile": {
"secrets": []
},
"networkProfile": {
"loadBalancerConfigurations": [
{
"name": "contosolb",
"properties": {
"frontendIpConfigurations": [
{
"name": "contosofe",
"properties": {
"publicIPAddress": {
"id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Network/publicIPAddresses/contosopublicip"
}
}
}
]
}
}
]
},
"extensionProfile": {
"extensions": [
{
"name": "RDPExtension",
"properties": {
"autoUpgradeMinorVersion": false,
"provisioningState": "Succeeded",
"rolesAppliedTo": [
"*"
],
"publisher": "Microsoft.Windows.Azure.Extensions",
"type": "RDP",
"typeHandlerVersion": "1.2",
"settings": "<PublicConfig><UserName>userazure</UserName><Expiration>01/12/2022 16:29:02</Expiration></PublicConfig>"
}
}
]
},
"provisioningState": "Succeeded",
"uniqueId": "4ccb4323-4740-4545-bb81-780b27375947"
},
"systemData": {
"createdAt": "2020-01-01T17:18:19.1234567Z",
"lastModifiedAt": "2020-01-01T17:18:19.1234567Z"
}
}
정의
Name | Description |
---|---|
Api |
API 오류입니다. |
Api |
API 오류 기준입니다. |
Cloud |
Compute 서비스의 오류 응답입니다. |
Cloud |
클라우드 서비스에 대해 설명합니다. |
Cloud |
클라우드 서비스 확장 프로필을 설명합니다. |
Cloud |
확장 속성입니다. |
Cloud |
클라우드 서비스에 대한 네트워크 프로필입니다. |
Cloud |
클라우드 서비스에 대한 OS 프로필을 설명합니다. |
Cloud |
클라우드 서비스 속성 |
Cloud |
클라우드 서비스의 역할 프로필에 대해 설명합니다. |
Cloud |
역할 속성을 설명합니다. |
Cloud |
클라우드 서비스 역할 sku에 대해 설명합니다. |
Cloud |
클라우드 서비스의 슬롯 유형입니다.
가능한 값은 다음과 같습니다. |
Cloud |
클라우드 서비스의 업데이트 모드입니다. 역할 인스턴스는 서비스가 배포될 때 도메인을 업데이트하기 위해 할당됩니다. 업데이트는 각 업데이트 도메인에서 수동으로 시작하거나 모든 업데이트 도메인에서 자동으로 시작할 수 있습니다.
가능한 값은 다음과 같습니다. |
Cloud |
역할 인스턴스로 전송되기 전에 암호화된 KeyVault를 사용하여 참조되는 확장에 대한 보호된 설정입니다. |
Cloud |
Key Vault의 단일 인증서 참조와 인증서가 역할 인스턴스에 상주해야 하는 위치에 대해 설명합니다. |
Cloud |
모두 동일한 Key Vault에 있는 인증서 집합에 대해 설명합니다. |
Extension |
클라우드 서비스 확장을 설명합니다. |
Inner |
내부 오류 세부 정보입니다. |
Load |
부하 분산 장치 구성에 대해 설명합니다. |
Load |
부하 분산 장치 구성의 속성을 설명합니다. |
Load |
부하 분산 장치에 사용할 프런트 엔드 IP를 지정합니다. IPv4 프런트 엔드 IP 주소만 지원됩니다. 각 부하 분산 장치 구성에는 정확히 하나의 프런트 엔드 IP 구성이 있어야 합니다. |
Load |
클라우드 서비스 IP 구성에 대해 설명합니다. |
Sub |
|
System |
이 리소스와 관련된 시스템 메타 데이터입니다. |
ApiError
API 오류입니다.
Name | 형식 | Description |
---|---|---|
code |
string |
오류 코드입니다. |
details |
API 오류 세부 정보 |
|
innererror |
API 내부 오류 |
|
message |
string |
오류 메시지입니다. |
target |
string |
특정 오류의 대상입니다. |
ApiErrorBase
API 오류 기준입니다.
Name | 형식 | Description |
---|---|---|
code |
string |
오류 코드입니다. |
message |
string |
오류 메시지입니다. |
target |
string |
특정 오류의 대상입니다. |
CloudError
Compute 서비스의 오류 응답입니다.
Name | 형식 | Description |
---|---|---|
error |
API 오류입니다. |
CloudService
클라우드 서비스에 대해 설명합니다.
Name | 형식 | Description |
---|---|---|
id |
string |
리소스 ID입니다. |
location |
string |
리소스 위치입니다. |
name |
string |
리소스 이름입니다. |
properties |
클라우드 서비스 속성 |
|
systemData |
이 리소스와 관련된 시스템 메타 데이터입니다. |
|
tags |
object |
리소스 태그. |
type |
string |
리소스 종류입니다. |
zones |
string[] |
리소스의 논리적 가용성 영역 목록입니다. 목록에는 클라우드 서비스를 프로비전해야 하는 영역이 1개만 포함되어야 합니다. 이 필드는 선택 사항입니다. |
CloudServiceExtensionProfile
클라우드 서비스 확장 프로필을 설명합니다.
Name | 형식 | Description |
---|---|---|
extensions |
클라우드 서비스에 대한 확장 목록입니다. |
CloudServiceExtensionProperties
확장 속성입니다.
Name | 형식 | Description |
---|---|---|
autoUpgradeMinorVersion |
boolean |
플랫폼이 사용 가능해지면 typeHandlerVersion을 상위 부 버전으로 자동으로 업그레이드할 수 있는지 여부를 명시적으로 지정합니다. |
forceUpdateTag |
string |
제공된 공용 및 보호된 설정을 강제로 적용하는 태그입니다. 태그 값을 변경하면 공용 또는 보호된 설정을 변경하지 않고 확장을 다시 실행할 수 있습니다. forceUpdateTag가 변경되지 않으면 공용 또는 보호된 설정에 대한 업데이트가 처리기에서 계속 적용됩니다. forceUpdateTag 또는 public 또는 protected 설정이 변경되지 않는 경우 확장은 동일한 시퀀스 번호가 있는 역할 인스턴스로 흐르며 다시 실행할지 여부는 처리기 구현에 달려 있습니다. |
protectedSettings |
object |
역할 인스턴스로 전송되기 전에 암호화된 확장에 대한 보호된 설정입니다. |
protectedSettingsFromKeyVault |
역할 인스턴스로 전송되기 전에 암호화된 KeyVault를 사용하여 참조되는 확장에 대한 보호된 설정입니다. |
|
provisioningState |
string |
응답에만 표시되는 프로비전 상태입니다. |
publisher |
string |
확장 처리기 게시자의 이름입니다. |
rolesAppliedTo |
string[] |
이 확장을 적용할 역할의 선택적 목록입니다. 속성을 지정하지 않거나 '*'를 지정하면 클라우드 서비스의 모든 역할에 확장이 적용됩니다. |
settings |
object |
확장에 대한 공용 설정입니다. JSON 확장의 경우 확장에 대한 JSON 설정입니다. XML 확장(예: RDP)의 경우 확장에 대한 XML 설정입니다. |
type |
string |
확장의 형식을 지정합니다. |
typeHandlerVersion |
string |
확장의 버전을 지정합니다. 확장의 버전을 지정합니다. 이 요소를 지정하지 않았거나 별표(*)를 값으로 사용하는 경우 최신 버전의 확장이 사용됩니다. 값이 주 버전 번호와 별표로 부 버전 번호(X.)로 지정된 경우 지정된 주 버전의 최신 부 버전이 선택됩니다. 주 버전 번호와 부 버전 번호(X.Y)가 지정된 경우 특정 확장 버전이 선택됩니다. 버전을 지정하면 역할 인스턴스에서 자동 업그레이드가 수행됩니다. |
CloudServiceNetworkProfile
클라우드 서비스에 대한 네트워크 프로필입니다.
Name | 형식 | Description |
---|---|---|
loadBalancerConfigurations |
부하 분산 장치 구성 목록입니다. 클라우드 서비스에는 공용 Load Balancer 및 내부 Load Balancer에 해당하는 최대 2개의 부하 분산 장치 구성이 있을 수 있습니다. |
|
slotType |
클라우드 서비스의 슬롯 유형입니다.
가능한 값은 다음과 같습니다. |
|
swappableCloudService |
주체 클라우드 서비스가 교환을 수행할 수 있는 대상 IP를 포함하는 클라우드 서비스의 ID 참조입니다. 이 속성은 설정된 후에는 업데이트할 수 없습니다. 이 ID에서 참조하는 교환 가능한 클라우드 서비스가 있어야 합니다. 그렇지 않으면 오류가 throw됩니다. |
CloudServiceOsProfile
클라우드 서비스에 대한 OS 프로필을 설명합니다.
Name | 형식 | Description |
---|---|---|
secrets |
역할 인스턴스에 설치해야 하는 인증서 집합을 지정합니다. |
CloudServiceProperties
클라우드 서비스 속성
Name | 형식 | Description |
---|---|---|
allowModelOverride |
boolean |
(선택 사항) 모델/템플릿에 지정된 역할 sku 속성(roleProfile.roles.sku)이 .cscfg 및 .csdef에 지정된 역할 인스턴스 수 및 vm 크기를 각각 재정의해야 하는지 여부를 나타냅니다.
기본값은 |
configuration |
string |
클라우드 서비스에 대한 XML 서비스 구성(.cscfg)을 지정합니다. |
configurationUrl |
string |
Blob 서비스에서 서비스 구성의 위치를 참조하는 URL을 지정합니다. 서비스 패키지 URL은 모든 스토리지 계정의 SAS(공유 액세스 서명) URI일 수 있습니다. 이 속성은 쓰기 전용 속성이며 GET 호출에서 반환되지 않습니다. |
extensionProfile |
클라우드 서비스 확장 프로필을 설명합니다. |
|
networkProfile |
클라우드 서비스에 대한 네트워크 프로필입니다. |
|
osProfile |
클라우드 서비스에 대한 OS 프로필을 설명합니다. |
|
packageUrl |
string |
Blob 서비스에서 서비스 패키지의 위치를 참조하는 URL을 지정합니다. 서비스 패키지 URL은 모든 스토리지 계정의 SAS(공유 액세스 서명) URI일 수 있습니다. 이 속성은 쓰기 전용 속성이며 GET 호출에서 반환되지 않습니다. |
provisioningState |
string |
응답에만 표시되는 프로비전 상태입니다. |
roleProfile |
클라우드 서비스의 역할 프로필에 대해 설명합니다. |
|
startCloudService |
boolean |
(선택 사항) 클라우드 서비스를 만든 직후 시작할지 여부를 나타냅니다. 기본값은 |
uniqueId |
string |
클라우드 서비스에 대한 고유 식별자입니다. |
upgradeMode |
클라우드 서비스의 업데이트 모드입니다. 역할 인스턴스는 서비스가 배포될 때 도메인을 업데이트하기 위해 할당됩니다. 업데이트는 각 업데이트 도메인에서 수동으로 시작하거나 모든 업데이트 도메인에서 자동으로 시작할 수 있습니다.
가능한 값은 다음과 같습니다. |
CloudServiceRoleProfile
클라우드 서비스의 역할 프로필에 대해 설명합니다.
Name | 형식 | Description |
---|---|---|
roles |
클라우드 서비스에 대한 역할 목록입니다. |
CloudServiceRoleProfileProperties
역할 속성을 설명합니다.
Name | 형식 | Description |
---|---|---|
name |
string |
리소스 이름입니다. |
sku |
클라우드 서비스 역할 sku에 대해 설명합니다. |
CloudServiceRoleSku
클라우드 서비스 역할 sku에 대해 설명합니다.
Name | 형식 | Description |
---|---|---|
capacity |
integer |
클라우드 서비스의 역할 인스턴스 수를 지정합니다. |
name |
string |
sku 이름입니다. 참고: 클라우드 서비스가 현재 있는 하드웨어에서 새 SKU가 지원되지 않는 경우 클라우드 서비스를 삭제하고 다시 만들거나 이전 sku로 다시 이동해야 합니다. |
tier |
string |
클라우드 서비스의 계층을 지정합니다. 가능한 값은 다음과 같습니다. |
CloudServiceSlotType
클라우드 서비스의 슬롯 유형입니다.
가능한 값은 다음과 같습니다.
프로덕션
스테이징
지정하지 않으면 기본값은 Production입니다.
Name | 형식 | Description |
---|---|---|
Production |
string |
|
Staging |
string |
CloudServiceUpgradeMode
클라우드 서비스의 업데이트 모드입니다. 역할 인스턴스는 서비스가 배포될 때 도메인을 업데이트하기 위해 할당됩니다. 업데이트는 각 업데이트 도메인에서 수동으로 시작하거나 모든 업데이트 도메인에서 자동으로 시작할 수 있습니다.
가능한 값은 다음과 같습니다.
자동
수동
동시
지정하지 않으면 기본값은 Auto입니다. 수동으로 설정하면 업데이트를 적용하려면 PUT UpdateDomain을 호출해야 합니다. Auto로 설정하면 업데이트가 각 업데이트 도메인에 순서대로 자동으로 적용됩니다.
Name | 형식 | Description |
---|---|---|
Auto |
string |
|
Manual |
string |
|
Simultaneous |
string |
CloudServiceVaultAndSecretReference
역할 인스턴스로 전송되기 전에 암호화된 KeyVault를 사용하여 참조되는 확장에 대한 보호된 설정입니다.
Name | 형식 | Description |
---|---|---|
secretUrl |
string |
확장의 보호된 설정을 포함하는 비밀 URL |
sourceVault |
Key Vault의 ARM 리소스 ID |
CloudServiceVaultCertificate
Key Vault의 단일 인증서 참조와 인증서가 역할 인스턴스에 상주해야 하는 위치에 대해 설명합니다.
Name | 형식 | Description |
---|---|---|
certificateUrl |
string |
Key Vault에 비밀로 업로드된 인증서의 URL입니다. |
isBootstrapCertificate |
boolean |
제공된 인증서가 Key Vault 확장에서 나머지 인증서를 가져오는 데 사용할 부트스트랩 인증서인지 여부를 나타내는 플래그입니다. |
CloudServiceVaultSecretGroup
모두 동일한 Key Vault에 있는 인증서 집합에 대해 설명합니다.
Name | 형식 | Description |
---|---|---|
sourceVault |
VaultCertificates의 모든 인증서를 포함하는 Key Vault의 상대 URL입니다. |
|
vaultCertificates |
인증서를 포함하는 SourceVault의 키 자격 증명 모음 참조 목록입니다. |
Extension
클라우드 서비스 확장을 설명합니다.
Name | 형식 | Description |
---|---|---|
name |
string |
확장의 이름입니다. |
properties |
확장 속성입니다. |
InnerError
내부 오류 세부 정보입니다.
Name | 형식 | Description |
---|---|---|
errordetail |
string |
내부 오류 메시지 또는 예외 덤프입니다. |
exceptiontype |
string |
예외 형식입니다. |
LoadBalancerConfiguration
부하 분산 장치 구성에 대해 설명합니다.
Name | 형식 | Description |
---|---|---|
id |
string |
리소스 ID |
name |
string |
부하 분산 장치의 이름 |
properties |
부하 분산 장치 구성의 속성입니다. |
LoadBalancerConfigurationProperties
부하 분산 장치 구성의 속성을 설명합니다.
Name | 형식 | Description |
---|---|---|
frontendIpConfigurations |
부하 분산 장치에 사용할 프런트 엔드 IP를 지정합니다. IPv4 프런트 엔드 IP 주소만 지원됩니다. 각 부하 분산 장치 구성에는 정확히 하나의 프런트 엔드 IP 구성이 있어야 합니다. |
LoadBalancerFrontendIpConfiguration
부하 분산 장치에 사용할 프런트 엔드 IP를 지정합니다. IPv4 프런트 엔드 IP 주소만 지원됩니다. 각 부하 분산 장치 구성에는 정확히 하나의 프런트 엔드 IP 구성이 있어야 합니다.
Name | 형식 | Description |
---|---|---|
name |
string |
부하 분산 장치에서 사용하는 프런트 엔드 IP 구성 집합 내에서 고유한 리소스의 이름입니다. 이 이름은 리소스에 액세스하는 데 사용할 수 있습니다. |
properties |
부하 분산 장치 프런트 엔드 IP 구성의 속성입니다. |
LoadBalancerFrontendIpConfigurationProperties
클라우드 서비스 IP 구성에 대해 설명합니다.
Name | 형식 | Description |
---|---|---|
privateIPAddress |
string |
IP 구성의 가상 네트워크 개인 IP 주소입니다. |
publicIPAddress |
공용 IP 주소 리소스에 대한 참조입니다. |
|
subnet |
가상 네트워크 서브넷 리소스에 대한 참조입니다. |
SubResource
Name | 형식 | Description |
---|---|---|
id |
string |
리소스 ID |
SystemData
이 리소스와 관련된 시스템 메타 데이터입니다.
Name | 형식 | Description |
---|---|---|
createdAt |
string |
클라우드 서비스(추가 지원) 리소스가 만들어진 시간을 UTC로 지정합니다. |
lastModifiedAt |
string |
클라우드 서비스(추가 지원) 리소스가 마지막으로 수정된 시간을 UTC로 지정합니다. |