Microsoft.Compute cloudServices 2022-04-04
Definicja zasobu Bicep
Typ zasobu cloudServices można wdrożyć z operacjami docelowymi:
- Grupy zasobów — zobacz polecenia wdrażania grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.
Format zasobu
Aby utworzyć zasób Microsoft.Compute/cloudServices, dodaj następujący kod Bicep do szablonu.
resource symbolicname 'Microsoft.Compute/cloudServices@2022-04-04' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
properties: {
allowModelOverride: bool
configuration: 'string'
configurationUrl: 'string'
extensionProfile: {
extensions: [
{
name: 'string'
properties: {
autoUpgradeMinorVersion: bool
forceUpdateTag: 'string'
protectedSettings: any()
protectedSettingsFromKeyVault: {
secretUrl: 'string'
sourceVault: {
id: 'string'
}
}
publisher: 'string'
rolesAppliedTo: [
'string'
]
settings: any()
type: 'string'
typeHandlerVersion: 'string'
}
}
]
}
networkProfile: {
loadBalancerConfigurations: [
{
id: 'string'
name: 'string'
properties: {
frontendIPConfigurations: [
{
name: 'string'
properties: {
privateIPAddress: 'string'
publicIPAddress: {
id: 'string'
}
subnet: {
id: 'string'
}
}
}
]
}
}
]
slotType: 'string'
swappableCloudService: {
id: 'string'
}
}
osProfile: {
secrets: [
{
sourceVault: {
id: 'string'
}
vaultCertificates: [
{
certificateUrl: 'string'
}
]
}
]
}
packageUrl: 'string'
roleProfile: {
roles: [
{
name: 'string'
sku: {
capacity: int
name: 'string'
tier: 'string'
}
}
]
}
startCloudService: bool
upgradeMode: 'string'
}
systemData: {}
}
Wartości właściwości
cloudServices
| Nazwa | Opis | Wartość |
|---|---|---|
| name | Nazwa zasobu | ciąg (wymagany) Limit znaków: 1–15 Prawidłowe znaki: Nie można używać spacji, znaków kontrolnych ani następujących znaków: ~ ! @ # $ % ^ & * ( ) = + _ [ ] { } \ | ; : . ' " , < > / ?Nie można rozpocząć od podkreślenia. Nie można zakończyć kropką ani łącznikiem. |
| location | Lokalizacja zasobu. | ciąg (wymagany) |
| tags | Tagi zasobów. | Słownik nazw tagów i wartości. Zobacz Tagi w szablonach |
| properties | Właściwości usługi w chmurze | CloudServiceProperties |
| systemData | Metadane systemowe odnoszące się do tego zasobu. | Dane systemu |
CloudServiceProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| allowModelOverride | (Opcjonalnie) Wskazuje, czy właściwości jednostki SKU roli (roleProfile.roles.sku) określone w modelu/szablonie powinny zastąpić liczbę wystąpień roli i rozmiar maszyny wirtualnej określony odpowiednio w plikach cscfg i csdef. Wartość domyślna to false. |
bool |
| konfiguracja | Określa konfigurację usługi XML (cscfg) dla usługi w chmurze. | ciąg |
| configurationUrl | Określa adres URL odwołujący się do lokalizacji konfiguracji usługi w usłudze Blob Service. Adres URL pakietu usługi może być identyfikatorem URI sygnatury dostępu współdzielonego (SAS) z dowolnego konta magazynu. Jest to właściwość tylko do zapisu i nie jest zwracana w wywołaniach GET. |
ciąg |
| extensionProfile | Opisuje profil rozszerzenia usługi w chmurze. | CloudServiceExtensionProfile |
| networkProfile | Profil sieciowy dla usługi w chmurze. | CloudServiceNetworkProfile |
| osProfile | Opisuje profil systemu operacyjnego dla usługi w chmurze. | CloudServiceOsProfile |
| packageUrl | Określa adres URL odwołujący się do lokalizacji pakietu usługi w usłudze Blob Service. Adres URL pakietu usługi może być identyfikatorem URI sygnatury dostępu współdzielonego (SAS) z dowolnego konta magazynu. Jest to właściwość tylko do zapisu i nie jest zwracana w wywołaniach GET. |
ciąg |
| roleProfile | Opisuje profil roli dla usługi w chmurze. | CloudServiceRoleProfile |
| startCloudService | (Opcjonalnie) Wskazuje, czy usługa w chmurze ma być uruchamiana natychmiast po jej utworzeniu. Wartość domyślna to true.Jeśli wartość false, model usługi jest nadal wdrożony, ale kod nie jest uruchamiany natychmiast. Zamiast tego usługa jest obsługiwana do momentu wywołania polecenia Start, w którym momencie usługa zostanie uruchomiona. Wdrożona usługa nadal ponosi opłaty, nawet jeśli jest włączona. |
bool |
| upgradeMode | Tryb aktualizacji dla usługi w chmurze. Wystąpienia ról są przydzielane do domen aktualizacji podczas wdrażania usługi. Aktualizacje można zainicjować ręcznie w każdej domenie aktualizacji lub inicjować automatycznie we wszystkich domenach aktualizacji. Możliwe wartości to Automatycznie Ręczne Jednoczesne Jeśli nie zostanie określony, wartość domyślna to Auto. Jeśli jest ustawiona wartość Manual (Ręczne), funkcja PUT UpdateDomain musi zostać wywołana, aby zastosować aktualizację. W przypadku ustawienia automatycznego aktualizacja jest automatycznie stosowana do każdej domeny aktualizacji w sekwencji. |
"Auto" "Ręczne" "Równoczesne" |
CloudServiceExtensionProfile
| Nazwa | Opis | Wartość |
|---|---|---|
| extensions | Lista rozszerzeń dla usługi w chmurze. | Rozszerzenie[] |
Rozszerzenie
| Nazwa | Opis | Wartość |
|---|---|---|
| name | Nazwa rozszerzenia. | ciąg |
| properties | Właściwości rozszerzenia. | CloudServiceExtensionProperties |
CloudServiceExtensionProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| autoUpgradeMinorVersion | Jawnie określ, czy platforma może automatycznie uaktualnić typHandlerVersion do wyższych wersji pomocniczych, gdy staną się dostępne. | bool |
| forceUpdateTag | Tag w celu wymuszenia zastosowania podanych ustawień publicznych i chronionych. Zmiana wartości tagu umożliwia ponowne uruchomienie rozszerzenia bez zmiany żadnych ustawień publicznych lub chronionych. Jeśli element forceUpdateTag nie zostanie zmieniony, aktualizacje ustawień publicznych lub chronionych będą nadal stosowane przez program obsługi. Jeśli ani forceUpdateTag, ani żadne z ustawień publicznych lub chronionych nie zostaną zmienione, rozszerzenie będzie przepływać do wystąpienia roli z tym samym numerem sekwencji i Jest to konieczne wykonanie procedury obsługi, czy należy ją ponownie uruchomić, czy nie |
ciąg |
| protectedSettings | Ustawienia chronione dla rozszerzenia, które są szyfrowane przed wysłaniem do wystąpienia roli. | W przypadku Bicep można użyć funkcji any(). |
| protectedSettingsFromKeyVault | Ustawienia chronione dla rozszerzenia, do których odwołuje się funkcja KeyVault, które są szyfrowane przed wysłaniem do wystąpienia roli. | CloudServiceVaultAndSecretReference |
| publisher | Nazwa wydawcy programu obsługi rozszerzeń. | ciąg |
| rolesAppliedTo | Opcjonalna lista ról do zastosowania tego rozszerzenia. Jeśli właściwość nie zostanie określona lub zostanie określona wartość "*", rozszerzenie zostanie zastosowane do wszystkich ról w usłudze w chmurze. | ciąg[] |
| ustawienia | Ustawienia publiczne rozszerzenia. W przypadku rozszerzeń JSON jest to ustawienia JSON rozszerzenia. W przypadku rozszerzenia XML (na przykład RDP) jest to ustawienie XML dla rozszerzenia. | W przypadku Bicep można użyć funkcji any(). |
| typ | Określa typ rozszerzenia. | ciąg |
| typeHandlerVersion | Określa wersję rozszerzenia. Określa wersję rozszerzenia. Jeśli ten element nie zostanie określony lub gwiazdka (*) zostanie użyta jako wartość, zostanie użyta najnowsza wersja rozszerzenia. Jeśli wartość jest określona z numerem wersji głównej i gwiazdką jako numer wersji pomocniczej (X.), zostanie wybrana najnowsza wersja pomocnicza określonej wersji głównej. Jeśli zostanie określony numer wersji głównej i numer wersji pomocniczej (X.Y), wybrana jest określona wersja rozszerzenia. Jeśli określono wersję, automatyczne uaktualnianie jest wykonywane w wystąpieniu roli. | ciąg |
CloudServiceVaultAndSecretReference
| Nazwa | Opis | Wartość |
|---|---|---|
| secretUrl | Adres URL wpisu tajnego, który zawiera ustawienia chronione rozszerzenia | ciąg |
| sourceVault | Identyfikator zasobu usługi ARM Key Vault | Podźródło |
Podźródło
| Nazwa | Opis | Wartość |
|---|---|---|
| identyfikator | Identyfikator zasobu | ciąg |
CloudServiceNetworkProfile
| Nazwa | Opis | Wartość |
|---|---|---|
| loadBalancerConfigurations | Lista konfiguracji modułu równoważenia obciążenia. Usługa w chmurze może mieć maksymalnie dwie konfiguracje modułu równoważenia obciążenia odpowiadające publicznemu Load Balancer i wewnętrznemu Load Balancer. | LoadBalancerConfiguration[] |
| slotType | Typ miejsca dla usługi w chmurze. Możliwe wartości to Produkcja Przygotowanie Jeśli nie zostanie określona, wartość domyślna to Produkcja. |
"Produkcja" "Przejściowe" |
| swappableCloudService | Identyfikator odwołania do usługi w chmurze zawierającej docelowy adres IP, z którym usługa w chmurze podmiotu może wykonać zamianę. Nie można zaktualizować tej właściwości po jej ustawieniu. Zamienialna usługa w chmurze, do której odwołuje się ten identyfikator, musi być obecna. W przeciwnym razie zostanie zgłoszony błąd. | Podźródło |
LoadBalancerConfiguration
| Nazwa | Opis | Wartość |
|---|---|---|
| identyfikator | Identyfikator zasobu | ciąg |
| name | Nazwa modułu równoważenia obciążenia | ciąg (wymagany) |
| properties | Właściwości konfiguracji modułu równoważenia obciążenia. | LoadBalancerConfigurationProperties (wymagane) |
LoadBalancerConfigurationProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| frontendIPConfigurations | Określa adres IP frontonu, który ma być używany dla modułu równoważenia obciążenia. Obsługiwany jest tylko adres IP frontonu IPv4. Każda konfiguracja modułu równoważenia obciążenia musi mieć dokładnie jedną konfigurację adresu IP frontonu. | LoadBalancerFrontendIPConfiguration[] (wymagane) |
LoadBalancerFrontendIPConfiguration
| Nazwa | Opis | Wartość |
|---|---|---|
| name | Nazwa zasobu, który jest unikatowy w zestawie konfiguracji adresów IP frontonu używanych przez moduł równoważenia obciążenia. Ta nazwa może służyć do uzyskiwania dostępu do zasobu. | ciąg (wymagany) |
| properties | Właściwości konfiguracji adresu IP frontonu modułu równoważenia obciążenia. | LoadBalancerFrontendIPConfigurationProperties (wymagane) |
LoadBalancerFrontendIPConfigurationProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| privateIPAddress | Prywatny adres IP sieci wirtualnej konfiguracji adresu IP. | ciąg |
| publicIPAddress | Odwołanie do zasobu publicznego adresu IP. | Podźródło |
| podsieć | Odwołanie do zasobu podsieci sieci wirtualnej. | Podźródło |
CloudServiceOsProfile
| Nazwa | Opis | Wartość |
|---|---|---|
| wpisy tajne | Określa zestaw certyfikatów, które mają być zainstalowane w wystąpieniach roli. | CloudServiceVaultSecretGroup[] |
CloudServiceVaultSecretGroup
| Nazwa | Opis | Wartość |
|---|---|---|
| sourceVault | Względny adres URL Key Vault zawierający wszystkie certyfikaty w usłudze VaultCertificates. | Podźródło |
| vaultCertificates | Lista odwołań do magazynu kluczy w usłudze SourceVault, które zawierają certyfikaty. | CloudServiceVaultCertificate[] |
CloudServiceVaultCertificate
| Nazwa | Opis | Wartość |
|---|---|---|
| certificateUrl | Jest to adres URL certyfikatu, który został przekazany do Key Vault jako wpis tajny. | ciąg |
CloudServiceRoleProfile
| Nazwa | Opis | Wartość |
|---|---|---|
| role | Lista ról dla usługi w chmurze. | CloudServiceRoleProfileProperties[] |
CloudServiceRoleProfileProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| name | Nazwa zasobu. | ciąg |
| sku | Opisuje jednostkę SKU roli usługi w chmurze. | CloudServiceRoleSku |
CloudServiceRoleSku
| Nazwa | Opis | Wartość |
|---|---|---|
| capacity | Określa liczbę wystąpień roli w usłudze w chmurze. | int |
| name | Nazwa jednostki SKU. UWAGA: Jeśli nowa jednostka SKU nie jest obsługiwana na sprzęcie, na którym jest obecnie włączona usługa w chmurze, musisz usunąć i ponownie utworzyć usługę w chmurze lub wrócić do starej jednostki SKU. | ciąg |
| tier | Określa warstwę usługi w chmurze. Możliwe wartości to Standardowa Podstawowa |
ciąg |
Dane systemu
Ten obiekt nie zawiera żadnych właściwości do ustawienia podczas wdrażania. Wszystkie właściwości to ReadOnly.
Definicja zasobu szablonu usługi ARM
Typ zasobu cloudServices można wdrożyć z operacjami docelowymi:
- Grupy zasobów — zobacz polecenia wdrażania grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.
Format zasobu
Aby utworzyć zasób Microsoft.Compute/cloudServices, dodaj następujący kod JSON do szablonu.
{
"type": "Microsoft.Compute/cloudServices",
"apiVersion": "2022-04-04",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"allowModelOverride": "bool",
"configuration": "string",
"configurationUrl": "string",
"extensionProfile": {
"extensions": [
{
"name": "string",
"properties": {
"autoUpgradeMinorVersion": "bool",
"forceUpdateTag": "string",
"protectedSettings": {},
"protectedSettingsFromKeyVault": {
"secretUrl": "string",
"sourceVault": {
"id": "string"
}
},
"publisher": "string",
"rolesAppliedTo": [ "string" ],
"settings": {},
"type": "string",
"typeHandlerVersion": "string"
}
}
]
},
"networkProfile": {
"loadBalancerConfigurations": [
{
"id": "string",
"name": "string",
"properties": {
"frontendIPConfigurations": [
{
"name": "string",
"properties": {
"privateIPAddress": "string",
"publicIPAddress": {
"id": "string"
},
"subnet": {
"id": "string"
}
}
}
]
}
}
],
"slotType": "string",
"swappableCloudService": {
"id": "string"
}
},
"osProfile": {
"secrets": [
{
"sourceVault": {
"id": "string"
},
"vaultCertificates": [
{
"certificateUrl": "string"
}
]
}
]
},
"packageUrl": "string",
"roleProfile": {
"roles": [
{
"name": "string",
"sku": {
"capacity": "int",
"name": "string",
"tier": "string"
}
}
]
},
"startCloudService": "bool",
"upgradeMode": "string"
},
"systemData": {}
}
Wartości właściwości
cloudServices
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ zasobu | "Microsoft.Compute/cloudServices" |
| apiVersion | Wersja interfejsu API zasobów | '2022-04-04' |
| name | Nazwa zasobu | ciąg (wymagany) Limit znaków: 1–15 Prawidłowe znaki: Nie można używać spacji, znaków kontrolnych ani następujących znaków: ~ ! @ # $ % ^ & * ( ) = + _ [ ] { } \ | ; : . ' " , < > / ?Nie można rozpocząć od podkreślenia. Nie można zakończyć kropką ani łącznikiem. |
| location | Lokalizacja zasobu. | ciąg (wymagany) |
| tags | Tagi zasobów. | Słownik nazw tagów i wartości. Zobacz Tagi w szablonach |
| properties | Właściwości usługi w chmurze | CloudServiceProperties |
| systemData | Metadane systemowe odnoszące się do tego zasobu. | Dane systemu |
CloudServiceProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| allowModelOverride | (Opcjonalnie) Wskazuje, czy właściwości jednostki SKU roli (roleProfile.roles.sku) określone w modelu/szablonie powinny zastąpić liczbę wystąpień roli i rozmiar maszyny wirtualnej określony odpowiednio w plikach cscfg i csdef. Wartość domyślna to false. |
bool |
| konfiguracja | Określa konfigurację usługi XML (cscfg) dla usługi w chmurze. | ciąg |
| configurationUrl | Określa adres URL odwołujący się do lokalizacji konfiguracji usługi w usłudze Blob Service. Adres URL pakietu usługi może być identyfikatorem URI sygnatury dostępu współdzielonego (SAS) z dowolnego konta magazynu. Jest to właściwość tylko do zapisu i nie jest zwracana w wywołaniach GET. |
ciąg |
| extensionProfile | Opisuje profil rozszerzenia usługi w chmurze. | CloudServiceExtensionProfile |
| networkProfile | Profil sieciowy dla usługi w chmurze. | CloudServiceNetworkProfile |
| osProfile | Opisuje profil systemu operacyjnego dla usługi w chmurze. | CloudServiceOsProfile |
| packageUrl | Określa adres URL odwołujący się do lokalizacji pakietu usługi w usłudze Blob Service. Adres URL pakietu usługi może być identyfikatorem URI sygnatury dostępu współdzielonego (SAS) z dowolnego konta magazynu. Jest to właściwość tylko do zapisu i nie jest zwracana w wywołaniach GET. |
ciąg |
| roleProfile | Opisuje profil roli dla usługi w chmurze. | CloudServiceRoleProfile |
| startCloudService | (Opcjonalnie) Wskazuje, czy usługa w chmurze ma być uruchamiana natychmiast po jej utworzeniu. Wartość domyślna to true.Jeśli wartość false, model usługi jest nadal wdrożony, ale kod nie jest uruchamiany natychmiast. Zamiast tego usługa jest obsługiwana do momentu wywołania polecenia Start, w którym momencie usługa zostanie uruchomiona. Wdrożona usługa nadal ponosi opłaty, nawet jeśli jest włączona. |
bool |
| upgradeMode | Tryb aktualizacji dla usługi w chmurze. Wystąpienia ról są przydzielane do domen aktualizacji podczas wdrażania usługi. Aktualizacje można zainicjować ręcznie w każdej domenie aktualizacji lub inicjować automatycznie we wszystkich domenach aktualizacji. Możliwe wartości to Automatycznie Ręczne Jednoczesne Jeśli nie zostanie określony, wartość domyślna to Auto. Jeśli jest ustawiona wartość Manual (Ręczne), funkcja PUT UpdateDomain musi zostać wywołana, aby zastosować aktualizację. W przypadku ustawienia automatycznego aktualizacja jest automatycznie stosowana do każdej domeny aktualizacji w sekwencji. |
"Auto" "Ręczne" "Równoczesne" |
CloudServiceExtensionProfile
| Nazwa | Opis | Wartość |
|---|---|---|
| extensions | Lista rozszerzeń dla usługi w chmurze. | Rozszerzenie[] |
Rozszerzenie
| Nazwa | Opis | Wartość |
|---|---|---|
| name | Nazwa rozszerzenia. | ciąg |
| properties | Właściwości rozszerzenia. | CloudServiceExtensionProperties |
CloudServiceExtensionProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| autoUpgradeMinorVersion | Jawnie określ, czy platforma może automatycznie uaktualnić typeHandlerVersion do wyższych wersji pomocniczych, gdy staną się dostępne. | bool |
| forceUpdateTag | Tag w celu wymuszenia zastosowania podanych ustawień publicznych i chronionych. Zmiana wartości tagu umożliwia ponowne uruchomienie rozszerzenia bez zmiany ustawień publicznych lub chronionych. Jeśli element forceUpdateTag nie zostanie zmieniony, aktualizacje ustawień publicznych lub chronionych będą nadal stosowane przez program obsługi. Jeśli ani forceUpdateTag, ani żadne z ustawień publicznych lub chronionych nie zostaną zmienione, rozszerzenie będzie przepływać do wystąpienia roli z tym samym numerem sekwencji i jest to implementacja procedury obsługi, niezależnie od tego, czy należy ją ponownie uruchomić, czy nie |
ciąg |
| protectedSettings | Ustawienia chronione dla rozszerzenia, które są szyfrowane przed wysłaniem do wystąpienia roli. | |
| protectedSettingsFromKeyVault | Ustawienia chronione dla rozszerzenia, do których odwołuje się funkcja KeyVault, które są szyfrowane przed wysłaniem do wystąpienia roli. | CloudServiceVaultAndSecretReference |
| publisher | Nazwa wydawcy programu obsługi rozszerzeń. | ciąg |
| rolesAppliedTo | Opcjonalna lista ról do zastosowania tego rozszerzenia. Jeśli właściwość nie jest określona lub określono wartość "*", rozszerzenie jest stosowane do wszystkich ról w usłudze w chmurze. | ciąg[] |
| ustawienia | Ustawienia publiczne rozszerzenia. W przypadku rozszerzeń JSON jest to ustawienia JSON rozszerzenia. W przypadku rozszerzenia XML (na przykład RDP) jest to ustawienie XML dla rozszerzenia. | |
| typ | Określa typ rozszerzenia. | ciąg |
| typeHandlerVersion | Określa wersję rozszerzenia. Określa wersję rozszerzenia. Jeśli ten element nie jest określony lub gwiazdka (*) jest używana jako wartość, używana jest najnowsza wersja rozszerzenia. Jeśli wartość jest określona z numerem wersji głównej i gwiazdką jako numer wersji pomocniczej (X.), zostanie wybrana najnowsza wersja pomocnicza określonej wersji głównej. Jeśli określono numer wersji głównej i numer wersji pomocniczej (X.Y), wybrana jest określona wersja rozszerzenia. Jeśli określono wersję, automatyczne uaktualnianie jest wykonywane w wystąpieniu roli. | ciąg |
CloudServiceVaultAndSecretReference
| Nazwa | Opis | Wartość |
|---|---|---|
| secretUrl | Tajny adres URL zawierający chronione ustawienia rozszerzenia | ciąg |
| sourceVault | Identyfikator zasobu usługi ARM Key Vault | Podźródło |
Podźródło
| Nazwa | Opis | Wartość |
|---|---|---|
| identyfikator | Identyfikator zasobu | ciąg |
CloudServiceNetworkProfile
| Nazwa | Opis | Wartość |
|---|---|---|
| loadBalancerConfigurations | Lista konfiguracji modułu równoważenia obciążenia. Usługa w chmurze może mieć maksymalnie dwie konfiguracje modułu równoważenia obciążenia, co odpowiada Load Balancer publicznej i wewnętrznej Load Balancer. | LoadBalancerConfiguration[] |
| slotType | Typ miejsca dla usługi w chmurze. Możliwe wartości to Produkcja Przygotowanie Jeśli nie zostanie określony, wartość domyślna to Produkcja. |
"Produkcja" "Przemieszczanie" |
| swappableCloudService | Odwołanie identyfikatora usługi w chmurze zawierającego docelowy adres IP, za pomocą którego usługa w chmurze podmiotu może wykonać zamianę. Nie można zaktualizować tej właściwości po jej ustawieniu. Usługa w chmurze, do której odwołuje się ten identyfikator, musi być obecna. W przeciwnym razie zostanie zgłoszony błąd. | Podźródło |
LoadBalancerConfiguration
| Nazwa | Opis | Wartość |
|---|---|---|
| identyfikator | Identyfikator zasobu | ciąg |
| name | Nazwa modułu równoważenia obciążenia | ciąg (wymagany) |
| properties | Właściwości konfiguracji modułu równoważenia obciążenia. | LoadBalancerConfigurationProperties (wymagane) |
LoadBalancerConfigurationProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| frontendIPConfigurations | Określa adres IP frontonu, który ma być używany dla modułu równoważenia obciążenia. Obsługiwany jest tylko adres IP frontonu IPv4. Każda konfiguracja modułu równoważenia obciążenia musi mieć dokładnie jedną konfigurację adresu IP frontonu. | LoadBalancerFrontendIPConfiguration[] (wymagane) |
LoadBalancerFrontendIPConfiguration
| Nazwa | Opis | Wartość |
|---|---|---|
| name | Nazwa zasobu, który jest unikatowy w zestawie konfiguracji adresów IP frontonu używanych przez moduł równoważenia obciążenia. Ta nazwa może służyć do uzyskiwania dostępu do zasobu. | ciąg (wymagany) |
| properties | Właściwości konfiguracji adresu IP frontonu modułu równoważenia obciążenia. | LoadBalancerFrontendIPConfigurationProperties (wymagane) |
LoadBalancerFrontendIPConfigurationProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| privateIPAddress | Prywatny adres IP sieci wirtualnej konfiguracji adresu IP. | ciąg |
| publicIPAddress | Odwołanie do zasobu publicznego adresu IP. | Podźródło |
| podsieć | Odwołanie do zasobu podsieci sieci wirtualnej. | Podźródło |
CloudServiceOsProfile
| Nazwa | Opis | Wartość |
|---|---|---|
| wpisy tajne | Określa zestaw certyfikatów, które należy zainstalować na wystąpieniach roli. | CloudServiceVaultSecretGroup[] |
CloudServiceVaultSecretGroup
| Nazwa | Opis | Wartość |
|---|---|---|
| sourceVault | Względny adres URL Key Vault zawierający wszystkie certyfikaty w usłudze VaultCertificates. | Podźródło |
| vaultCertificates | Lista odwołań do magazynu kluczy w usłudze SourceVault, które zawierają certyfikaty. | CloudServiceVaultCertificate[] |
CloudServiceVaultCertificate
| Nazwa | Opis | Wartość |
|---|---|---|
| certificateUrl | Jest to adres URL certyfikatu, który został przekazany do Key Vault jako wpis tajny. | ciąg |
CloudServiceRoleProfile
| Nazwa | Opis | Wartość |
|---|---|---|
| role | Lista ról dla usługi w chmurze. | CloudServiceRoleProfileProperties[] |
CloudServiceRoleProfileProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| name | Nazwa zasobu. | ciąg |
| sku | Opisuje jednostkę SKU roli usługi w chmurze. | CloudServiceRoleSku |
CloudServiceRoleSku
| Nazwa | Opis | Wartość |
|---|---|---|
| capacity | Określa liczbę wystąpień ról w usłudze w chmurze. | int |
| name | Nazwa jednostki SKU. UWAGA: Jeśli nowa jednostka SKU nie jest obecnie obsługiwana na sprzęcie, usługa w chmurze jest obecnie włączona, musisz usunąć i ponownie utworzyć usługę w chmurze lub wrócić do starej jednostki SKU. | ciąg |
| tier | Określa warstwę usługi w chmurze. Możliwe wartości to Standardowa Podstawowa |
ciąg |
SystemData
Ten obiekt nie zawiera żadnych właściwości do ustawienia podczas wdrażania. Wszystkie właściwości to ReadOnly.
Definicja zasobu narzędzia Terraform (dostawcy AzAPI)
Typ zasobu cloudServices można wdrożyć przy użyciu operacji docelowych:
- Grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.
Format zasobu
Aby utworzyć zasób Microsoft.Compute/cloudServices, dodaj następujące narzędzie Terraform do szablonu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Compute/cloudServices@2022-04-04"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
allowModelOverride = bool
configuration = "string"
configurationUrl = "string"
extensionProfile = {
extensions = [
{
name = "string"
properties = {
autoUpgradeMinorVersion = bool
forceUpdateTag = "string"
protectedSettingsFromKeyVault = {
secretUrl = "string"
sourceVault = {
id = "string"
}
}
publisher = "string"
rolesAppliedTo = [
"string"
]
type = "string"
typeHandlerVersion = "string"
}
}
]
}
networkProfile = {
loadBalancerConfigurations = [
{
id = "string"
name = "string"
properties = {
frontendIPConfigurations = [
{
name = "string"
properties = {
privateIPAddress = "string"
publicIPAddress = {
id = "string"
}
subnet = {
id = "string"
}
}
}
]
}
}
]
slotType = "string"
swappableCloudService = {
id = "string"
}
}
osProfile = {
secrets = [
{
sourceVault = {
id = "string"
}
vaultCertificates = [
{
certificateUrl = "string"
}
]
}
]
}
packageUrl = "string"
roleProfile = {
roles = [
{
name = "string"
sku = {
capacity = int
name = "string"
tier = "string"
}
}
]
}
startCloudService = bool
upgradeMode = "string"
}
systemData = {}
})
}
Wartości właściwości
cloudServices
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ zasobu | "Microsoft.Compute/cloudServices@2022-04-04" |
| name | Nazwa zasobu | ciąg (wymagany) Limit znaków: 1–15 Prawidłowe znaki: Nie można używać spacji, znaków sterujących ani następujących znaków: ~ ! @ # $ % ^ & * ( ) = + _ [ ] { } \ | ; : . ' " , < > / ?Nie można rozpocząć od podkreślenia. Nie można zakończyć kropką ani łącznikiem. |
| location | Lokalizacja zasobu. | ciąg (wymagany) |
| parent_id | Aby wdrożyć w grupie zasobów, użyj identyfikatora tej grupy zasobów. | ciąg (wymagany) |
| tags | Tagi zasobów. | Słownik nazw tagów i wartości. |
| properties | Właściwości usługi w chmurze | CloudServiceProperties |
| systemData | Dane metadane systemowe odnoszące się do tego zasobu. | SystemData |
CloudServiceProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| allowModelOverride | (Opcjonalnie) Wskazuje, czy właściwości jednostki SKU roli (roleProfile.roles.sku) określone w modelu/szablonie powinny zastąpić liczbę wystąpień roli i rozmiar maszyny wirtualnej określony odpowiednio w pliku cscfg i pliku csdef. Wartość domyślna to false. |
bool |
| konfiguracja | Określa konfigurację usługi XML (cscfg) dla usługi w chmurze. | ciąg |
| configurationUrl | Określa adres URL odwołujący się do lokalizacji konfiguracji usługi w usłudze Blob Service. Adres URL pakietu usługi może być identyfikatorem URI sygnatury dostępu współdzielonego (SAS) z dowolnego konta magazynu. Jest to właściwość tylko do zapisu i nie jest zwracana w wywołaniach GET. |
ciąg |
| extensionProfile | Opisuje profil rozszerzenia usługi w chmurze. | CloudServiceExtensionProfile |
| networkProfile | Profil sieciowy dla usługi w chmurze. | CloudServiceNetworkProfile |
| osProfile | Opisuje profil systemu operacyjnego dla usługi w chmurze. | CloudServiceOsProfile |
| packageUrl | Określa adres URL odwołujący się do lokalizacji pakietu usługi w usłudze Blob Service. Adres URL pakietu usługi może być identyfikatorem URI sygnatury dostępu współdzielonego (SAS) z dowolnego konta magazynu. Jest to właściwość tylko do zapisu i nie jest zwracana w wywołaniach GET. |
ciąg |
| roleProfile | Opisuje profil roli usługi w chmurze. | CloudServiceRoleProfile |
| startCloudService | (Opcjonalnie) Wskazuje, czy usługa w chmurze ma być uruchamiana natychmiast po jej utworzeniu. Wartość domyślna to true.Jeśli fałsz, model usługi jest nadal wdrażany, ale kod nie jest uruchamiany natychmiast. Zamiast tego usługa jest obsługiwana do momentu wywołania polecenia Start, w którym momencie zostanie uruchomiona usługa. Wdrożona usługa nadal ponosi opłaty, nawet jeśli jest włączona. |
bool |
| upgradeMode | Tryb aktualizacji dla usługi w chmurze. Wystąpienia ról są przydzielane do domen aktualizacji po wdrożeniu usługi. Aktualizacje można inicjować ręcznie w każdej domenie aktualizacji lub inicjować automatycznie we wszystkich domenach aktualizacji. Możliwe wartości to Automatycznie Ręczne Jednoczesne Jeśli nie zostanie określony, wartość domyślna to Auto. Jeśli jest ustawiona na Wartość Ręczna, funkcja PUT UpdateDomain musi zostać wywołana, aby zastosować aktualizację. Jeśli ustawiono wartość Auto, aktualizacja zostanie automatycznie zastosowana do każdej domeny aktualizacji w kolejności. |
"Auto" "Ręczne" "Równoczesne" |
CloudServiceExtensionProfile
| Nazwa | Opis | Wartość |
|---|---|---|
| extensions | Lista rozszerzeń dla usługi w chmurze. | Rozszerzenie[] |
Rozszerzenie
| Nazwa | Opis | Wartość |
|---|---|---|
| name | Nazwa rozszerzenia. | ciąg |
| properties | Właściwości rozszerzenia. | CloudServiceExtensionProperties |
CloudServiceExtensionProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| autoUpgradeMinorVersion | Jawnie określ, czy platforma może automatycznie uaktualnić typHandlerVersion do wyższych wersji pomocniczych, gdy staną się dostępne. | bool |
| forceUpdateTag | Tag w celu wymuszenia zastosowania podanych ustawień publicznych i chronionych. Zmiana wartości tagu umożliwia ponowne uruchomienie rozszerzenia bez zmiany żadnych ustawień publicznych lub chronionych. Jeśli element forceUpdateTag nie zostanie zmieniony, aktualizacje ustawień publicznych lub chronionych będą nadal stosowane przez program obsługi. Jeśli ani forceUpdateTag, ani żadne z ustawień publicznych lub chronionych nie zostaną zmienione, rozszerzenie będzie przepływać do wystąpienia roli z tym samym numerem sekwencji i Jest to konieczne wykonanie procedury obsługi, czy należy ją ponownie uruchomić, czy nie |
ciąg |
| protectedSettings | Ustawienia chronione dla rozszerzenia, które są szyfrowane przed wysłaniem do wystąpienia roli. | |
| protectedSettingsFromKeyVault | Ustawienia chronione dla rozszerzenia, do których odwołuje się funkcja KeyVault, które są szyfrowane przed wysłaniem do wystąpienia roli. | CloudServiceVaultAndSecretReference |
| publisher | Nazwa wydawcy programu obsługi rozszerzeń. | ciąg |
| rolesAppliedTo | Opcjonalna lista ról do zastosowania tego rozszerzenia. Jeśli właściwość nie zostanie określona lub zostanie określona wartość "*", rozszerzenie zostanie zastosowane do wszystkich ról w usłudze w chmurze. | ciąg[] |
| ustawienia | Ustawienia publiczne rozszerzenia. W przypadku rozszerzeń JSON jest to ustawienia JSON rozszerzenia. W przypadku rozszerzenia XML (na przykład RDP) jest to ustawienie XML dla rozszerzenia. | |
| typ | Określa typ rozszerzenia. | ciąg |
| typeHandlerVersion | Określa wersję rozszerzenia. Określa wersję rozszerzenia. Jeśli ten element nie zostanie określony lub gwiazdka (*) zostanie użyta jako wartość, zostanie użyta najnowsza wersja rozszerzenia. Jeśli wartość jest określona z numerem wersji głównej i gwiazdką jako numer wersji pomocniczej (X.), zostanie wybrana najnowsza wersja pomocnicza określonej wersji głównej. Jeśli zostanie określony numer wersji głównej i numer wersji pomocniczej (X.Y), wybrana jest określona wersja rozszerzenia. Jeśli określono wersję, automatyczne uaktualnianie jest wykonywane w wystąpieniu roli. | ciąg |
CloudServiceVaultAndSecretReference
| Nazwa | Opis | Wartość |
|---|---|---|
| secretUrl | Adres URL wpisu tajnego, który zawiera ustawienia chronione rozszerzenia | ciąg |
| sourceVault | Identyfikator zasobu usługi ARM Key Vault | Podźródło |
Podźródło
| Nazwa | Opis | Wartość |
|---|---|---|
| identyfikator | Identyfikator zasobu | ciąg |
CloudServiceNetworkProfile
| Nazwa | Opis | Wartość |
|---|---|---|
| loadBalancerConfigurations | Lista konfiguracji modułu równoważenia obciążenia. Usługa w chmurze może mieć maksymalnie dwie konfiguracje modułu równoważenia obciążenia odpowiadające publicznemu Load Balancer i wewnętrznemu Load Balancer. | LoadBalancerConfiguration[] |
| slotType | Typ miejsca dla usługi w chmurze. Możliwe wartości to Produkcja Przygotowanie Jeśli nie zostanie określona, wartość domyślna to Produkcja. |
"Produkcja" "Przejściowe" |
| swappableCloudService | Identyfikator odwołania do usługi w chmurze zawierającej docelowy adres IP, z którym usługa w chmurze podmiotu może wykonać zamianę. Nie można zaktualizować tej właściwości po jej ustawieniu. Zamienialna usługa w chmurze, do której odwołuje się ten identyfikator, musi być obecna. W przeciwnym razie zostanie zgłoszony błąd. | Podźródło |
LoadBalancerConfiguration
| Nazwa | Opis | Wartość |
|---|---|---|
| identyfikator | Identyfikator zasobu | ciąg |
| name | Nazwa modułu równoważenia obciążenia | ciąg (wymagany) |
| properties | Właściwości konfiguracji modułu równoważenia obciążenia. | LoadBalancerConfigurationProperties (wymagane) |
LoadBalancerConfigurationProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| frontendIPConfigurations | Określa adres IP frontonu, który ma być używany dla modułu równoważenia obciążenia. Obsługiwany jest tylko adres IP frontonu IPv4. Każda konfiguracja modułu równoważenia obciążenia musi mieć dokładnie jedną konfigurację adresu IP frontonu. | LoadBalancerFrontendIPConfiguration[] (wymagane) |
LoadBalancerFrontendIPConfiguration
| Nazwa | Opis | Wartość |
|---|---|---|
| name | Nazwa zasobu, który jest unikatowy w zestawie konfiguracji adresów IP frontonu używanych przez moduł równoważenia obciążenia. Ta nazwa może służyć do uzyskiwania dostępu do zasobu. | ciąg (wymagany) |
| properties | Właściwości konfiguracji adresu IP frontonu modułu równoważenia obciążenia. | LoadBalancerFrontendIPConfigurationProperties (wymagane) |
LoadBalancerFrontendIPConfigurationProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| privateIPAddress | Prywatny adres IP sieci wirtualnej konfiguracji adresu IP. | ciąg |
| publicIPAddress | Odwołanie do zasobu publicznego adresu IP. | Podźródło |
| podsieć | Odwołanie do zasobu podsieci sieci wirtualnej. | Podźródło |
CloudServiceOsProfile
| Nazwa | Opis | Wartość |
|---|---|---|
| wpisy tajne | Określa zestaw certyfikatów, które mają być zainstalowane w wystąpieniach roli. | CloudServiceVaultSecretGroup[] |
CloudServiceVaultSecretGroup
| Nazwa | Opis | Wartość |
|---|---|---|
| sourceVault | Względny adres URL Key Vault zawierający wszystkie certyfikaty w usłudze VaultCertificates. | Podźródło |
| vaultCertificates | Lista odwołań do magazynu kluczy w usłudze SourceVault, które zawierają certyfikaty. | CloudServiceVaultCertificate[] |
CloudServiceVaultCertificate
| Nazwa | Opis | Wartość |
|---|---|---|
| certificateUrl | Jest to adres URL certyfikatu, który został przekazany do Key Vault jako wpis tajny. | ciąg |
CloudServiceRoleProfile
| Nazwa | Opis | Wartość |
|---|---|---|
| role | Lista ról dla usługi w chmurze. | CloudServiceRoleProfileProperties[] |
CloudServiceRoleProfileProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| name | Nazwa zasobu. | ciąg |
| sku | Opisuje jednostkę SKU roli usługi w chmurze. | CloudServiceRoleSku |
CloudServiceRoleSku
| Nazwa | Opis | Wartość |
|---|---|---|
| capacity | Określa liczbę wystąpień roli w usłudze w chmurze. | int |
| name | Nazwa jednostki SKU. UWAGA: Jeśli nowa jednostka SKU nie jest obsługiwana na sprzęcie, na którym jest obecnie włączona usługa w chmurze, musisz usunąć i ponownie utworzyć usługę w chmurze lub wrócić do starej jednostki SKU. | ciąg |
| tier | Określa warstwę usługi w chmurze. Możliwe wartości to Standardowa Podstawowa |
ciąg |
Dane systemu
Ten obiekt nie zawiera żadnych właściwości do ustawienia podczas wdrażania. Wszystkie właściwości to ReadOnly.