Dela via


Reservation - Update

Uppdateringar en Reservation.
Uppdateringar de tillämpade omfången för Reservation.

PATCH https://management.azure.com/providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}?api-version=2022-11-01

URI-parametrar

Name I Obligatorisk Typ Description
reservationId
path True

string

ID för reservationsobjektet

reservationOrderId
path True

string

Beställnings-ID för reservationen

api-version
query True

string

Version som stöds.

Begärandetext

Name Typ Description
properties.appliedScopeProperties

AppliedScopeProperties

Egenskaper som är specifika för tillämpad omfångstyp. Krävs inte om det inte är tillämpligt. Krävs och måste ange tenantId och managementGroupId om AppliedScopeType är ManagementGroup

properties.appliedScopeType

AppliedScopeType

Typ av tillämpat omfång.

properties.appliedScopes

string[]

Lista över de prenumerationer som förmånen ska tillämpas på. Ange inte om AppliedScopeType är Delat. Den här egenskapen kommer att bli inaktuell och ersättas av appliedScopeProperties i stället för Single AppliedScopeType.

properties.instanceFlexibility

InstanceFlexibility

Om du aktiverar detta tillämpas reservationsrabatten på andra virtuella datorer i samma vm-storleksgrupp. Ange endast för reserverad resurstyp för VirtualMachines.

properties.name

string

Visningsnamn för reservationen

properties.renew

boolean

Om du ställer in detta på true köps automatiskt en ny reservation på förfallodatumtiden.

properties.renewProperties

RenewProperties

properties.reviewDateTime

string

Det här är den tidpunkt då Azure Hybrid-förmånen behöver granskas.

Svar

Name Typ Description
200 OK

ReservationResponse

Returnerar den uppdaterade Reservation.

202 Accepted

Begäran godkänns och bearbetas

Sidhuvuden

  • Azure-AsyncOperation: string
  • Location: string
  • Retry-After: integer
Other Status Codes

Error

Oväntat fel

Exempel

PatchReservation

Exempelbegäran

PATCH https://management.azure.com/providers/Microsoft.Capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/6ef59113-3482-40da-8d79-787f823e34bc?api-version=2022-11-01

{
  "properties": {
    "appliedScopeType": "Shared",
    "instanceFlexibility": "Off"
  }
}

Exempelsvar

{
  "sku": {
    "name": "Standard_DS1_v2"
  },
  "id": "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/6ef59113-3482-40da-8d79-787f823e34bc",
  "type": "Microsoft.Capacity/reservationOrders/reservations",
  "name": "6ef59113-3482-40da-8d79-787f823e34bc",
  "etag": 4,
  "location": "eastus",
  "properties": {
    "appliedScopeType": "Shared",
    "renew": false,
    "billingScopeId": "/subscriptions/19376483-64b8-49e4-a931-d5248828720a",
    "quantity": 3,
    "provisioningState": "Succeeded",
    "expiryDate": "2018-09-22",
    "expiryDateTime": "2018-09-22T23:57:48.1891638Z",
    "displayName": "cabri_test",
    "billingPlan": "Monthly",
    "effectiveDateTime": "2017-09-22T23:57:48.1891638Z",
    "lastUpdatedDateTime": "2017-09-22T23:57:54.3768768Z",
    "reservedResourceType": "VirtualMachines",
    "instanceFlexibility": "Off",
    "skuDescription": "D1 v2",
    "mergeProperties": {
      "mergeSources": [
        "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/00238563-7312-4c20-a134-8c030bf938a7",
        "/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de"
      ]
    }
  }
}
Azure-AsyncOperation: https://management.azure.com/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/6ef59113-3482-40da-8d79-787f823e34bc?api-version=2022-11-01
Location: https://management.azure.com/providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/6ef59113-3482-40da-8d79-787f823e34bc?api-version=2022-11-01
Retry-After: 120

Definitioner

Name Description
AppliedScopeProperties

Egenskaper som är specifika för tillämpad omfångstyp. Krävs inte om det inte är tillämpligt. Krävs och måste ange tenantId och managementGroupId om AppliedScopeType är ManagementGroup

AppliedScopeType

Typ av tillämpat omfång.

BillingCurrencyTotal

Valuta och belopp som kunden debiteras i kundens lokala valuta för förnyelseköp. Skatt ingår inte.

createdByType

Den typ av identitet som skapade resursen.

Error

Felinformation

ErrorResponseCode

Felkod som beskriver orsaken till att tjänsten inte kan bearbeta den inkommande begäran

ExtendedErrorInfo

Utökad felinformation inklusive felkod och felmeddelande

ExtendedStatusInfo
InstanceFlexibility

Om du aktiverar detta tillämpas reservationsrabatten på andra virtuella datorer i samma vm-storleksgrupp. Ange endast för reserverad resurstyp för VirtualMachines.

Kind

Resursprovidertyp som ska reserveras.

Patch

Begäran om reservationskorrigering

PricingCurrencyTotal

Belopp som Microsoft använder för post. Används under återbetalning för att beräkna återbetalningsgränsen. Skatt ingår inte. Det här är låst pris 30 dagar före förfallodatum.

ProvisioningState

Representerar det aktuella tillståndet för reservationen.

PurchaseRequest

Begäran om reservationsköp

RenewProperties
RenewPropertiesResponse

Förnyelseegenskaperna för en reservation.

ReservationBillingPlan

Representera faktureringsplanerna.

ReservationMergeProperties

Egenskaper för reservationssammanslagning

ReservationResponse

Definitionen av reservationen.

ReservationSplitProperties

Egenskaper för reservationsdelning

ReservationsProperties

Egenskaperna för reservationerna

ReservationStatusCode
ReservationSwapProperties

Egenskaper för reservationsväxling

ReservationTerm

Representerar reservationsperioden.

ReservationUtilizationAggregates

Aggregerade värden för reservationsanvändning

ReservedResourceProperties

Egenskaper som är specifika för varje reserverad resurstyp. Krävs inte om det inte är tillämpligt.

ReservedResourceType

Typen av resurs som reserveras.

SkuName

Namnet på sku

systemData

Metadata som rör skapande och senaste ändring av resursen.

Utilization

Reservationsanvändning

AppliedScopeProperties

Egenskaper som är specifika för tillämpad omfångstyp. Krävs inte om det inte är tillämpligt. Krävs och måste ange tenantId och managementGroupId om AppliedScopeType är ManagementGroup

Name Typ Description
displayName

string

Visningsnamn

managementGroupId

string

Fullständigt kvalificerad identifierare för den hanteringsgrupp där förmånen måste tillämpas.

resourceGroupId

string

Fullständigt kvalificerad identifierare för resursgruppen.

subscriptionId

string

Fullständigt kvalificerad identifierare för prenumerationen.

tenantId

string

Klientorganisations-ID där sparplanen ska tillämpa förmånen.

AppliedScopeType

Typ av tillämpat omfång.

Name Typ Description
ManagementGroup

string

Shared

string

Single

string

BillingCurrencyTotal

Valuta och belopp som kunden debiteras i kundens lokala valuta för förnyelseköp. Skatt ingår inte.

Name Typ Description
amount

number

currencyCode

string

ISO 4217 3-bokstavs valutakod för den valuta som används av den här inköpsposten.

createdByType

Den typ av identitet som skapade resursen.

Name Typ Description
Application

string

Key

string

ManagedIdentity

string

User

string

Error

Felinformation

Name Typ Description
error

ExtendedErrorInfo

Utökad felinformation inklusive felkod och felmeddelande

ErrorResponseCode

Felkod som beskriver orsaken till att tjänsten inte kan bearbeta den inkommande begäran

Name Typ Description
ActivateQuoteFailed

string

AppliedScopesNotAssociatedWithCommerceAccount

string

AppliedScopesSameAsExisting

string

AuthorizationFailed

string

BadRequest

string

BillingCustomerInputError

string

BillingError

string

BillingPaymentInstrumentHardError

string

BillingPaymentInstrumentSoftError

string

BillingScopeIdCannotBeChanged

string

BillingTransientError

string

CalculatePriceFailed

string

CapacityUpdateScopesFailed

string

ClientCertificateThumbprintNotSet

string

CreateQuoteFailed

string

Forbidden

string

FulfillmentConfigurationError

string

FulfillmentError

string

FulfillmentOutOfStockError

string

FulfillmentTransientError

string

HttpMethodNotSupported

string

InternalServerError

string

InvalidAccessToken

string

InvalidFulfillmentRequestParameters

string

InvalidHealthCheckType

string

InvalidLocationId

string

InvalidRefundQuantity

string

InvalidRequestContent

string

InvalidRequestUri

string

InvalidReservationId

string

InvalidReservationOrderId

string

InvalidSingleAppliedScopesCount

string

InvalidSubscriptionId

string

InvalidTenantId

string

MissingAppliedScopesForSingle

string

MissingTenantId

string

NoValidReservationsToReRate

string

NonsupportedAccountId

string

NotSpecified

string

NotSupportedCountry

string

OperationCannotBePerformedInCurrentState

string

OperationFailed

string

PatchValuesSameAsExisting

string

PaymentInstrumentNotFound

string

PurchaseError

string

ReRateOnlyAllowedForEA

string

RefundLimitExceeded

string

ReservationIdNotInReservationOrder

string

ReservationOrderCreationFailed

string

ReservationOrderIdAlreadyExists

string

ReservationOrderNotEnabled

string

ReservationOrderNotFound

string

RiskCheckFailed

string

RoleAssignmentCreationFailed

string

SelfServiceRefundNotSupported

string

ServerTimeout

string

UnauthenticatedRequestsThrottled

string

UnsupportedReservationTerm

string

ExtendedErrorInfo

Utökad felinformation inklusive felkod och felmeddelande

Name Typ Description
code

ErrorResponseCode

Felkod som beskriver orsaken till att tjänsten inte kan bearbeta den inkommande begäran

message

string

ExtendedStatusInfo

Name Typ Description
message

string

Meddelandet som ger detaljerad information om statuskoden.

statusCode

ReservationStatusCode

InstanceFlexibility

Om du aktiverar detta tillämpas reservationsrabatten på andra virtuella datorer i samma vm-storleksgrupp. Ange endast för reserverad resurstyp för VirtualMachines.

Name Typ Description
Off

string

On

string

Kind

Resursprovidertyp som ska reserveras.

Name Typ Description
Microsoft.Compute

string

Patch

Begäran om reservationskorrigering

Name Typ Standardvärde Description
properties.appliedScopeProperties

AppliedScopeProperties

Egenskaper som är specifika för tillämpad omfångstyp. Krävs inte om det inte är tillämpligt. Krävs och måste ange tenantId och managementGroupId om AppliedScopeType är ManagementGroup

properties.appliedScopeType

AppliedScopeType

Typ av tillämpat omfång.

properties.appliedScopes

string[]

Lista över de prenumerationer som förmånen ska tillämpas på. Ange inte om AppliedScopeType är Delat. Den här egenskapen kommer att bli inaktuell och ersättas av appliedScopeProperties i stället för Single AppliedScopeType.

properties.instanceFlexibility

InstanceFlexibility

Om du aktiverar detta tillämpas reservationsrabatten på andra virtuella datorer i samma vm-storleksgrupp. Ange endast för reserverad resurstyp för VirtualMachines.

properties.name

string

Visningsnamn för reservationen

properties.renew

boolean

False

Om du ställer in detta på true köps automatiskt en ny reservation på förfallodatumtiden.

properties.renewProperties

RenewProperties

properties.reviewDateTime

string

Det här är den tidpunkt då Azure Hybrid-förmånen behöver granskas.

PricingCurrencyTotal

Belopp som Microsoft använder för post. Används under återbetalning för att beräkna återbetalningsgränsen. Skatt ingår inte. Det här är låst pris 30 dagar före förfallodatum.

Name Typ Description
amount

number

currencyCode

string

ISO 4217 3-bokstavs valutakod för den valuta som används av den här inköpsposten.

ProvisioningState

Representerar det aktuella tillståndet för reservationen.

Name Typ Description
BillingFailed

string

Cancelled

string

ConfirmedBilling

string

ConfirmedResourceHold

string

Created

string

Creating

string

Expired

string

Failed

string

Merged

string

PendingBilling

string

PendingResourceHold

string

Split

string

Succeeded

string

PurchaseRequest

Begäran om reservationsköp

Name Typ Standardvärde Description
location

string

Den Azure-region där den reserverade resursen finns.

properties.appliedScopeProperties

AppliedScopeProperties

Egenskaper som är specifika för tillämpad omfångstyp. Krävs inte om det inte är tillämpligt. Krävs och måste ange tenantId och managementGroupId om AppliedScopeType är ManagementGroup

properties.appliedScopeType

AppliedScopeType

Typ av tillämpat omfång.

properties.appliedScopes

string[]

Lista över de prenumerationer som förmånen ska tillämpas på. Ange inte om AppliedScopeType är Delat. Den här egenskapen kommer att bli inaktuell och ersättas av appliedScopeProperties i stället för Single AppliedScopeType.

properties.billingPlan

ReservationBillingPlan

Representera faktureringsplanerna.

properties.billingScopeId

string

Prenumeration som debiteras för köp av reservation eller sparplan

properties.displayName

string

Eget namn på reservationen

properties.quantity

integer

Kvantitet för de sku:er som ingår i reservationen.

properties.renew

boolean

False

Om du ställer in detta på true köps automatiskt en ny reservation på förfallodatumtiden.

properties.reservedResourceProperties

ReservedResourceProperties

Egenskaper som är specifika för varje reserverad resurstyp. Krävs inte om det inte är tillämpligt.

properties.reservedResourceType

ReservedResourceType

Typen av resurs som reserveras.

properties.reviewDateTime

string

Det här är den tidpunkt då Azure Hybrid-förmånen behöver granskas.

properties.term

ReservationTerm

Representerar reservationsperioden.

sku

SkuName

Namnet på sku

RenewProperties

Name Typ Description
purchaseProperties

PurchaseRequest

Begäran om reservationsköp

RenewPropertiesResponse

Förnyelseegenskaperna för en reservation.

Name Typ Description
billingCurrencyTotal

BillingCurrencyTotal

Valuta och belopp som kunden debiteras i kundens lokala valuta för förnyelseköp. Skatt ingår inte.

pricingCurrencyTotal

PricingCurrencyTotal

Belopp som Microsoft använder för post. Används under återbetalning för att beräkna återbetalningsgränsen. Skatt ingår inte. Det här är låst pris 30 dagar före förfallodatum.

purchaseProperties

PurchaseRequest

Begäran om reservationsköp

ReservationBillingPlan

Representera faktureringsplanerna.

Name Typ Description
Monthly

string

Upfront

string

ReservationMergeProperties

Egenskaper för reservationssammanslagning

Name Typ Description
mergeDestination

string

Reservationsresurs-ID skapat på grund av sammanslagningen. Formatet för resurs-ID:t är /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

mergeSources

string[]

Resurs-ID:t för källreservationens sammanfogade för att bilda den här reservationen. Formatet för resurs-ID:t är /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationResponse

Definitionen av reservationen.

Name Typ Description
etag

integer

id

string

Fullständigt kvalificerat resurs-ID för resursen. Till exempel "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

kind

Kind

Resursprovidertyp som ska reserveras.

location

string

Den Azure-region där den reserverade resursen finns.

name

string

Namnet på resursen

properties

ReservationsProperties

De egenskaper som är kopplade till den här reservationen

sku

SkuName

SKU-informationen som är associerad med den här reservationen

systemData

systemData

Azure Resource Manager metadata som innehåller createdBy och modifiedBy information.

type

string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

ReservationSplitProperties

Egenskaper för reservationsdelning

Name Typ Description
splitDestinations

string[]

Lista över målresurs-ID som skapas på grund av delning. Formatet för resurs-ID:t är /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

splitSource

string

Resurs-ID för reservationen som detta delas från. Formatet för resurs-ID:t är /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationsProperties

Egenskaperna för reservationerna

Name Typ Standardvärde Description
appliedScopeProperties

AppliedScopeProperties

Egenskaper som är specifika för tillämpad omfångstyp. Krävs inte om det inte är tillämpligt. Krävs och måste ange tenantId och managementGroupId om AppliedScopeType är ManagementGroup

appliedScopeType

AppliedScopeType

Den tillämpade omfångstypen

appliedScopes

string[]

Listan över tillämpade omfång

archived

boolean

Anger om reservationen är arkiverad

benefitStartTime

string

Det här är DateTime när reservationsförmånen startade.

billingPlan

ReservationBillingPlan

Alternativen för faktureringsplan som är tillgängliga för den här SKU:n.

billingScopeId

string

Prenumeration som debiteras för köp av reservation eller sparplan

capabilities

string

Reservationens funktioner

displayName

string

Eget namn för användare som enkelt kan identifiera reservationen

displayProvisioningState

string

Etableringstillståndet för reservationen för visning, t.ex. Lyckades

effectiveDateTime

string

DateTime för reservationen som börjar när den här versionen gäller från.

expiryDate

string

Det här är det datum då reservationen upphör att gälla.

expiryDateTime

string

Det här är den tidpunkt då reservationen upphör att gälla.

extendedStatusInfo

ExtendedStatusInfo

Meddelandet som ger detaljerad information om statuskoden.

instanceFlexibility

InstanceFlexibility

Tillåter att reservationsrabatt tillämpas på sku:er i samma grupp för automatisk anpassning. Det är inte alla sku:er som stöder flexibilitet för instansstorlek.

lastUpdatedDateTime

string

DateTime för senaste gången reservationen uppdaterades.

mergeProperties

ReservationMergeProperties

Egenskaper för reservationssammanslagning

provisioningState

ProvisioningState

Aktuellt tillstånd för reservationen.

provisioningSubState

string

Reservationens etableringsundertillstånd, t.ex. Lyckades

purchaseDate

string

Det här är datumet då reservationen köptes.

purchaseDateTime

string

Det här är den tidpunkt då reservationen köptes.

quantity

integer

Kvantitet för de sku:er som ingår i reservationen.

renew

boolean

False

Om du ställer in detta på true köps automatiskt en ny reservation på förfallodatumtiden.

renewDestination

string

Reservations-ID för reservationen som köps på grund av förnyelse. Formatet för resurs-ID:t är /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}.

renewProperties

RenewPropertiesResponse

Förnyelseegenskaperna för en reservation.

renewSource

string

Reservations-ID för reservationen som reservationen förnyas från. Formatet för resurs-ID:t är /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}.

reservedResourceType

ReservedResourceType

Typen av resurs som reserveras.

reviewDateTime

string

Det här är den tidpunkt då Azure Hybrid-förmån behöver granskas.

skuDescription

string

Beskrivning av sku:n på engelska.

splitProperties

ReservationSplitProperties

Egenskaper för reservationsdelning

swapProperties

ReservationSwapProperties

Egenskaper för reservationsväxling

term

ReservationTerm

Representerar reservationsperioden.

userFriendlyAppliedScopeType

string

Den tillämpade omfångstypen för reservationen för visning, t.ex. Delad

userFriendlyRenewState

string

Förnyelsetillståndet för reservationen för visning, t.ex. På

utilization

Utilization

Reservationsanvändning

ReservationStatusCode

Name Typ Description
Active

string

Expired

string

Merged

string

None

string

PaymentInstrumentError

string

Pending

string

Processing

string

PurchaseError

string

Split

string

Succeeded

string

ReservationSwapProperties

Egenskaper för reservationsväxling

Name Typ Description
swapDestination

string

Reservationsresurs-ID som den ursprungliga resursen växlas till. Formatet för resurs-ID:t är /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

swapSource

string

Resurs-ID för källreservationen som byts ut. Formatet för resurs-ID:t är /providers/microsoft.capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

ReservationTerm

Representerar reservationsperioden.

Name Typ Description
P1Y

string

P3Y

string

P5Y

string

ReservationUtilizationAggregates

Aggregerade värden för reservationsanvändning

Name Typ Description
grain

number

Aggregatets kornighet

grainUnit

string

Kornenheten för aggregeringen

value

number

Aggregeringsvärdet

valueUnit

string

Aggregatets värdeenhet

ReservedResourceProperties

Egenskaper som är specifika för varje reserverad resurstyp. Krävs inte om det inte är tillämpligt.

Name Typ Description
instanceFlexibility

InstanceFlexibility

Om du aktiverar detta tillämpas reservationsrabatten på andra virtuella datorer i samma vm-storleksgrupp. Ange endast för reserverad resurstyp för VirtualMachines.

ReservedResourceType

Typen av resurs som reserveras.

Name Typ Description
AVS

string

AppService

string

AzureDataExplorer

string

AzureFiles

string

BlockBlob

string

CosmosDb

string

DataFactory

string

Databricks

string

DedicatedHost

string

ManagedDisk

string

MariaDb

string

MySql

string

NetAppStorage

string

PostgreSql

string

RedHat

string

RedHatOsa

string

RedisCache

string

SapHana

string

SqlAzureHybridBenefit

string

SqlDataWarehouse

string

SqlDatabases

string

SqlEdge

string

SuseLinux

string

VMwareCloudSimple

string

VirtualMachineSoftware

string

VirtualMachines

string

SkuName

Namnet på sku

Name Typ Description
name

string

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name Typ Description
createdAt

string

Tidsstämpeln för resursskapande (UTC).

createdBy

string

Identiteten som skapade resursen.

createdByType

createdByType

Den typ av identitet som skapade resursen.

lastModifiedAt

string

Tidsstämpeln för resursens senaste ändring (UTC)

lastModifiedBy

string

Identiteten som senast ändrade resursen.

lastModifiedByType

createdByType

Den typ av identitet som senast ändrade resursen.

Utilization

Reservationsanvändning

Name Typ Description
aggregates

ReservationUtilizationAggregates[]

Matrisen med aggregat för en reservations användning

trend

string

senaste 7 dagars användningstrend för en reservation