Workspace Subscription - Update

Referenz

Dienst:: API Management

API-Version:: 2024-05-01

Aktualisiert die Details eines Abonnements, das durch seinen Bezeichner angegeben ist.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions/{sid}?api-version=2024-05-01

Mit optionalen Parametern:

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/subscriptions/{sid}?notify={notify}&api-version=2024-05-01&appType={appType}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Der Name des API-Verwaltungsdiensts.
sid	path	True	string maxLength: 256 pattern: ^[^*#&+:<>?]+$	Abonnemententitätsbezeichner. Die Entität stellt die Zuordnung zwischen einem Benutzer und einem Produkt in der API-Verwaltung dar.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
workspaceId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Arbeitsbereichsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.
appType	query		AppType	Bestimmt den Typ der Anwendung, die die Benutzeranforderung zum Erstellen sendet. Der Standardwert ist das Legacyherausgeberportal.
notify	query		boolean	Änderung im Abonnementstatus benachrichtigen. Wenn falsch, senden Sie keine E-Mail-Benachrichtigung für die Änderung des Status des Abonnements. Wenn wahr, senden Sie eine E-Mail-Benachrichtigung über den Status des Abonnements

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
If-Match	True	string	ETag der Entität. ETag sollte mit dem aktuellen Entitätsstatus aus der Headerantwort der GET-Anforderung übereinstimmen, oder es sollte * für bedingungslose Aktualisierung sein.

Anforderungstext

Name	Typ	Beschreibung
properties.allowTracing	boolean	Bestimmt, ob die Ablaufverfolgung aktiviert werden kann
properties.displayName	string	Abonnementname.
properties.expirationDate	string (date-time)	Ablaufdatum des Abonnements. Die Einstellung dient nur zu Überwachungszwecken, und das Abonnement ist nicht automatisch abgelaufen. Der Abonnementlebenszyklus kann mithilfe der eigenschaft `state` verwaltet werden. Das Datum entspricht dem folgenden Format: `yyyy-MM-ddTHH:mm:ssZ` gemäß der ISO 8601-Norm.
properties.ownerId	string	Benutzerbezeichnerpfad: /users/{userId}
properties.primaryKey	string minLength: 1 maxLength: 256	Primärer Abonnementschlüssel.
properties.scope	string	Bereich wie /products/{productId} oder /apis oder /apis/{apiId}
properties.secondaryKey	string minLength: 1 maxLength: 256	Sekundärer Abonnementschlüssel.
properties.state	SubscriptionState	Abonnementstatus. Mögliche Zustände sind * aktiv – das Abonnement ist aktiv, * ausgesetzt – das Abonnement wird blockiert, und der Abonnent kann keine APIs des Produkts anrufen, * übermittelt – die Abonnementanforderung wurde vom Entwickler vorgenommen, wurde aber noch nicht genehmigt oder abgelehnt, * abgelehnt – die Abonnementanforderung wurde von einem Administrator verweigert * gekündigt – das Abonnement wurde vom Entwickler oder Administrator storniert, * abgelaufen – das Abonnement hat sein Ablaufdatum erreicht und wurde deaktiviert.
properties.stateComment	string	Kommentare zur Beschreibung der Änderung des Abonnementstatus durch den Administrator, wenn der Status in "abgelehnt" geändert wird.

Antworten

Name	Typ	Beschreibung
200 OK	SubscriptionContract	Die Abonnementdetails wurden erfolgreich aktualisiert. Header ETag: string
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Name

Typ

Beschreibung

200 OK

SubscriptionContract

Die Abonnementdetails wurden erfolgreich aktualisiert.

Header

ETag: string

Other Status Codes

ErrorResponse

Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

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

ApiManagementUpdateWorkspaceSubscription

Beispielanforderung

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/subscriptions/testsub?api-version=2024-05-01


{
  "properties": {
    "displayName": "testsub"
  }
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/subscriptions/testsub",
  "type": "Microsoft.ApiManagement/service/workspaces/subscriptions",
  "name": "testsub",
  "properties": {
    "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b",
    "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060002",
    "displayName": "testsub",
    "state": "submitted",
    "createdDate": "2017-06-02T17:59:06.223Z"
  }
}

Definitionen

Name	Beschreibung
AppType	Bestimmt den Typ der Anwendung, die die Benutzeranforderung zum Erstellen sendet. Der Standardwert ist das Legacyportal.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
SubscriptionContract	Abonnementdetails.
SubscriptionState	Abonnementstatus. Mögliche Zustände sind * aktiv – das Abonnement ist aktiv, * ausgesetzt – das Abonnement wird blockiert, und der Abonnent kann keine APIs des Produkts anrufen, * übermittelt – die Abonnementanforderung wurde vom Entwickler vorgenommen, wurde aber noch nicht genehmigt oder abgelehnt, * abgelehnt – die Abonnementanforderung wurde von einem Administrator verweigert * gekündigt – das Abonnement wurde vom Entwickler oder Administrator storniert, * abgelaufen – das Abonnement hat sein Ablaufdatum erreicht und wurde deaktiviert.
SubscriptionUpdateParameters	Details zum Abonnementupdate.

AppType

Enumeration

Bestimmt den Typ der Anwendung, die die Benutzeranforderung zum Erstellen sendet. Der Standardwert ist das Legacyportal.

Wert	Beschreibung
developerPortal	Benutzererstellungsanforderung wurde vom neuen Entwicklerportal gesendet.
portal	Benutzererstellungsanforderung wurde vom älteren Entwicklerportal gesendet.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

SubscriptionContract

Objekt

Abonnementdetails.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.allowTracing	boolean	Bestimmt, ob die Ablaufverfolgung aktiviert ist.
properties.createdDate	string (date-time)	Erstellungsdatum des Abonnements. Das Datum entspricht dem folgenden Format: `yyyy-MM-ddTHH:mm:ssZ` gemäß der ISO 8601-Norm.
properties.displayName	string minLength: 0 maxLength: 100	Der Name des Abonnements oder NULL, wenn das Abonnement keinen Namen hat.
properties.endDate	string (date-time)	Datum, an dem das Abonnement gekündigt oder abgelaufen ist. Die Einstellung dient nur zu Überwachungszwecken, und das Abonnement wird nicht automatisch gekündigt. Der Abonnementlebenszyklus kann mithilfe der eigenschaft `state` verwaltet werden. Das Datum entspricht dem folgenden Format: `yyyy-MM-ddTHH:mm:ssZ` gemäß der ISO 8601-Norm.
properties.expirationDate	string (date-time)	Ablaufdatum des Abonnements. Die Einstellung dient nur zu Überwachungszwecken, und das Abonnement ist nicht automatisch abgelaufen. Der Abonnementlebenszyklus kann mithilfe der eigenschaft `state` verwaltet werden. Das Datum entspricht dem folgenden Format: `yyyy-MM-ddTHH:mm:ssZ` gemäß der ISO 8601-Norm.
properties.notificationDate	string (date-time)	Ablaufdatum des bevorstehenden Abonnements. Das Datum entspricht dem folgenden Format: `yyyy-MM-ddTHH:mm:ssZ` gemäß der ISO 8601-Norm.
properties.ownerId	string	Der Benutzerressourcenbezeichner des Abonnementbesitzers. Der Wert ist eine gültige relative URL im Format von /users/{userId}, wobei {userId} ein Benutzerbezeichner ist.
properties.primaryKey	string minLength: 1 maxLength: 256	Primärschlüssel des Abonnements. Diese Eigenschaft wird für 'GET'-Vorgänge nicht ausgefüllt! Verwenden Sie die POST-Anforderung "/listSecrets", um den Wert abzurufen.
properties.scope	string	Bereich wie /products/{productId} oder /apis oder /apis/{apiId}.
properties.secondaryKey	string minLength: 1 maxLength: 256	Sekundärer Abonnementschlüssel. Diese Eigenschaft wird für 'GET'-Vorgänge nicht ausgefüllt! Verwenden Sie die POST-Anforderung "/listSecrets", um den Wert abzurufen.
properties.startDate	string (date-time)	Datum der Abonnementaktivierung. Die Einstellung dient nur zu Überwachungszwecken, und das Abonnement wird nicht automatisch aktiviert. Der Abonnementlebenszyklus kann mithilfe der eigenschaft `state` verwaltet werden. Das Datum entspricht dem folgenden Format: `yyyy-MM-ddTHH:mm:ssZ` gemäß der ISO 8601-Norm.
properties.state	SubscriptionState	Abonnementstatus. Mögliche Zustände sind * aktiv – das Abonnement ist aktiv, * ausgesetzt – das Abonnement wird blockiert, und der Abonnent kann keine APIs des Produkts anrufen, * übermittelt – die Abonnementanforderung wurde vom Entwickler vorgenommen, wurde aber noch nicht genehmigt oder abgelehnt, * abgelehnt – die Abonnementanforderung wurde von einem Administrator verweigert * gekündigt – das Abonnement wurde vom Entwickler oder Administrator storniert, * abgelaufen – das Abonnement hat sein Ablaufdatum erreicht und wurde deaktiviert.
properties.stateComment	string	Optionaler Abonnementkommentar, der von einem Administrator hinzugefügt wird, wenn der Status in "abgelehnt" geändert wird.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

SubscriptionState

Enumeration

Abonnementstatus. Mögliche Zustände sind * aktiv – das Abonnement ist aktiv, * ausgesetzt – das Abonnement wird blockiert, und der Abonnent kann keine APIs des Produkts anrufen, * übermittelt – die Abonnementanforderung wurde vom Entwickler vorgenommen, wurde aber noch nicht genehmigt oder abgelehnt, * abgelehnt – die Abonnementanforderung wurde von einem Administrator verweigert * gekündigt – das Abonnement wurde vom Entwickler oder Administrator storniert, * abgelaufen – das Abonnement hat sein Ablaufdatum erreicht und wurde deaktiviert.

Wert	Beschreibung
active
cancelled
expired
rejected
submitted
suspended

SubscriptionUpdateParameters

Objekt

Details zum Abonnementupdate.

Name	Typ	Beschreibung
properties.allowTracing	boolean	Bestimmt, ob die Ablaufverfolgung aktiviert werden kann
properties.displayName	string	Abonnementname.
properties.expirationDate	string (date-time)	Ablaufdatum des Abonnements. Die Einstellung dient nur zu Überwachungszwecken, und das Abonnement ist nicht automatisch abgelaufen. Der Abonnementlebenszyklus kann mithilfe der eigenschaft `state` verwaltet werden. Das Datum entspricht dem folgenden Format: `yyyy-MM-ddTHH:mm:ssZ` gemäß der ISO 8601-Norm.
properties.ownerId	string	Benutzerbezeichnerpfad: /users/{userId}
properties.primaryKey	string minLength: 1 maxLength: 256	Primärer Abonnementschlüssel.
properties.scope	string	Bereich wie /products/{productId} oder /apis oder /apis/{apiId}
properties.secondaryKey	string minLength: 1 maxLength: 256	Sekundärer Abonnementschlüssel.
properties.state	SubscriptionState	Abonnementstatus. Mögliche Zustände sind * aktiv – das Abonnement ist aktiv, * ausgesetzt – das Abonnement wird blockiert, und der Abonnent kann keine APIs des Produkts anrufen, * übermittelt – die Abonnementanforderung wurde vom Entwickler vorgenommen, wurde aber noch nicht genehmigt oder abgelehnt, * abgelehnt – die Abonnementanforderung wurde von einem Administrator verweigert * gekündigt – das Abonnement wurde vom Entwickler oder Administrator storniert, * abgelaufen – das Abonnement hat sein Ablaufdatum erreicht und wurde deaktiviert.
properties.stateComment	string	Kommentare zur Beschreibung der Änderung des Abonnementstatus durch den Administrator, wenn der Status in "abgelehnt" geändert wird.

Freigeben über

Workspace Subscription - Update

URI-Parameter

Anforderungsheader

Anforderungstext

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

ApiManagementUpdateWorkspaceSubscription

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AppType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

SubscriptionContract

SubscriptionState

SubscriptionUpdateParameters

Zusätzliche Ressourcen