Transfers - Cancel
Bricht eine Übertragungsanforderung ab. Der Vorgang wird nur für Abrechnungskonten mit dem Vertragstyp Microsoft-Kundenvertrag unterstützt.
POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/transfers/{transferName}/cancel?api-version=2024-04-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
billing
|
path | True |
string pattern: ^([0-9]+|([Pp][Cc][Nn]\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$ |
Die ID, die ein Abrechnungskonto eindeutig identifiziert. |
billing
|
path | True |
string pattern: ^[a-zA-Z\d-_]{1,128}$ |
Die ID, die ein Abrechnungsprofil eindeutig identifiziert. |
invoice
|
path | True |
string pattern: ^[a-zA-Z\d-_]{1,128}$ |
Die ID, die einen Rechnungsabschnitt eindeutig identifiziert. |
transfer
|
path | True |
string pattern: ^[a-z0-9]*$ |
Die ID, die eine Übertragungsanforderung eindeutig identifiziert. |
api-version
|
query | True |
string |
Die Version der API, die mit der Clientanforderung verwendet werden soll. Die aktuelle Version ist 2024-04-01. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Details der abgebrochenen Übertragung. |
|
Other Status Codes |
Unerwarteter Fehler. |
Sicherheit
azure_auth
Azure Active Directory OAuth2-Fluss.
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel ihres Benutzerkontos |
Beispiele
TransferCancel
Beispielanforderung
POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy/transfers/aabb123/cancel?api-version=2024-04-01
Beispiel für eine Antwort
{
"id": "/providers/Microsoft.Billing/BillingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx/invoiceSections/yyyy-yyyy-yyy-yyy/transfers/aabb123",
"name": "aabb123",
"type": "Microsoft.Billing/transfers",
"properties": {
"expirationTime": "2018-11-05T17:32:28Z",
"transferStatus": "Pending",
"recipientEmailId": "user@contoso.com",
"initiatorEmailId": "xyz@contoso.com",
"canceledBy": "user@contoso.com"
}
}
Definitionen
Name | Beschreibung |
---|---|
created |
Der Identitätstyp, der die Ressource erstellt hat. |
Detailed |
Detaillierter Übertragungsstatus. |
Error |
Der Ressourcenverwaltungsfehler zusätzliche Informationen. |
Error |
Das Fehlerdetails. |
Error |
Fehlerantwort |
product |
Übertragungsstatus. |
product |
Art des Produkts, das übertragen wird. |
system |
Metadaten zur Erstellung und letzten Änderung der Ressource. |
Transfer |
Details der Übertragung. |
Transfer |
Fehlerdetails für die Übertragung der Ausführung. |
transfer |
Gesamtübertragungsstatus. |
createdByType
Der Identitätstyp, der die Ressource erstellt hat.
Wert | Beschreibung |
---|---|
Application | |
Key | |
ManagedIdentity | |
User |
DetailedTransferStatus
Detaillierter Übertragungsstatus.
Name | Typ | Beschreibung |
---|---|---|
errorDetails |
Fehlerdetails für die Übertragung der Ausführung. |
|
productId |
string |
Die ID des Produkts, das übertragen wird. |
productName |
string |
Der Name des produkts, das übertragen wird. |
productType |
Art des Produkts, das übertragen wird. |
|
skuDescription |
string |
Die SKU des produkts, das übertragen wird. |
transferStatus |
Übertragungsstatus. |
ErrorAdditionalInfo
Der Ressourcenverwaltungsfehler zusätzliche Informationen.
Name | Typ | Beschreibung |
---|---|---|
info |
object |
Die zusätzlichen Informationen. |
type |
string |
Der zusätzliche Informationstyp. |
ErrorDetail
Das Fehlerdetails.
Name | Typ | Beschreibung |
---|---|---|
additionalInfo |
Die zusätzlichen Informationen des Fehlers. |
|
code |
string |
Der Fehlercode. |
details |
Die Fehlerdetails. |
|
message |
string |
Die Fehlermeldung. |
target |
string |
Das Fehlerziel. |
ErrorResponse
Fehlerantwort
Name | Typ | Beschreibung |
---|---|---|
error |
Das Fehlerobjekt. |
productTransferStatus
Übertragungsstatus.
Wert | Beschreibung |
---|---|
Completed | |
Failed | |
InProgress | |
NotStarted |
productType
Art des Produkts, das übertragen wird.
Wert | Beschreibung |
---|---|
AzureReservation | |
AzureSubscription | |
Department | |
SAAS | |
SavingsPlan |
systemData
Metadaten zur Erstellung und letzten Änderung der Ressource.
Name | Typ | Beschreibung |
---|---|---|
createdAt |
string (date-time) |
Der Zeitstempel der Ressourcenerstellung (UTC). |
createdBy |
string |
Die Identität, die die Ressource erstellt hat. |
createdByType |
Der Identitätstyp, der die Ressource erstellt hat. |
|
lastModifiedAt |
string (date-time) |
Der Zeitstempel der letzten Änderung der Ressource (UTC) |
lastModifiedBy |
string |
Die Identität, die die Ressource zuletzt geändert hat. |
lastModifiedByType |
Der Identitätstyp, der die Ressource zuletzt geändert hat. |
TransferDetails
Details der Übertragung.
Name | Typ | Beschreibung |
---|---|---|
id |
string (arm-id) |
Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
name |
string |
Der Name der Ressource |
properties.canceledBy |
string |
Die E-Mail-ID des Benutzers, der die Übertragungsanforderung abgebrochen hat. |
properties.detailedTransferStatus |
Detaillierter Übertragungsstatus. |
|
properties.expirationTime |
string (date-time) |
Der Zeitpunkt, zu dem die Übertragungsanforderung abläuft. |
properties.initiatorEmailId |
string |
Die E-Mail-ID des Benutzers, der die Übertragungsanforderung gesendet hat. |
properties.recipientEmailId |
string |
Die E-Mail-ID des Benutzers, an den die Übertragungsanforderung gesendet wurde. |
properties.transferStatus |
Gesamtübertragungsstatus. |
|
systemData |
Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten. |
|
tags |
object |
Wörterbuch der Metadaten, die der Ressource zugeordnet sind. Möglicherweise wird sie nicht für alle Ressourcentypen aufgefüllt. Maximale Schlüssel-/Wertlänge unterstützt von 256 Zeichen. Schlüssel/Wert dürfen keinen leeren Wert oder null sein. Schlüssel können nicht <> % & \ enthalten? / |
type |
string |
Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts" |
TransferError
Fehlerdetails für die Übertragung der Ausführung.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Fehlercode. |
message |
string |
Fehlermeldung. |
transferStatus
Gesamtübertragungsstatus.
Wert | Beschreibung |
---|---|
Canceled | |
Completed | |
CompletedWithErrors | |
Declined | |
Expired | |
Failed | |
InProgress | |
Pending |