Workspace Subscription - Create Or Update

Referentie

Service:: API Management

API-versie:: 2024-05-01

Hiermee maakt of werkt u het abonnement van de opgegeven gebruiker bij naar het opgegeven product.

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

Met optionele parameters:

PUT 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-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	De naam van de API Management-service.
sid	path	True	string maxLength: 256 pattern: ^[^*#&+:<>?]+$	Abonnementsentiteits-id. De entiteit vertegenwoordigt de koppeling tussen een gebruiker en een product in API Management.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
workspaceId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Werkruimte-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.
appType	query		AppType	Bepaalt het type toepassing dat de aanvraag voor het maken van de gebruiker verzendt. De standaardinstelling is een verouderde uitgeversportal.
notify	query		boolean	Wijziging melden in de abonnementsstatus. Als dit onwaar is, verzendt u geen e-mailmelding voor wijziging van de status van het abonnement Indien waar, stuurt u een e-mailmelding over de wijziging van de status van het abonnement

Aanvraagkoptekst

Name	Vereist	Type	Description
If-Match		string	ETag van de entiteit. Niet vereist bij het maken van een entiteit, maar vereist bij het bijwerken van een entiteit.

Aanvraagbody

Name	Vereist	Type	Description
properties.displayName	True	string minLength: 1 maxLength: 100	Abonnementsnaam.
properties.scope	True	string	Bereik zoals /products/{productId} of /apis of /apis/{apiId}.
properties.allowTracing		boolean	Bepaalt of tracering kan worden ingeschakeld
properties.ownerId		string	Gebruiker (gebruikers-id-pad) voor wie het abonnement wordt gemaakt in de vorm /gebruikers/{userId}
properties.primaryKey		string minLength: 1 maxLength: 256	Primaire abonnementssleutel. Als deze niet is opgegeven tijdens de aanvraagsleutel, wordt automatisch gegenereerd.
properties.secondaryKey		string minLength: 1 maxLength: 256	Secundaire abonnementssleutel. Als deze niet is opgegeven tijdens de aanvraagsleutel, wordt automatisch gegenereerd.
properties.state		SubscriptionState	Initiële abonnementsstatus. Als er geen waarde is opgegeven, wordt het abonnement gemaakt met de status Verzonden. Mogelijke statussen zijn * actief – het abonnement is actief, * opgeschort – het abonnement wordt geblokkeerd en de abonnee kan geen API's van het product aanroepen, * ingediend – de abonnementsaanvraag is ingediend door de ontwikkelaar, maar is nog niet goedgekeurd of afgewezen, * geweigerd – de abonnementsaanvraag is geweigerd door een beheerder, * geannuleerd – het abonnement is geannuleerd door de ontwikkelaar of beheerder, * verlopen – het abonnement heeft de vervaldatum bereikt en is gedeactiveerd.

Antwoorden

Name	Type	Description
200 OK	SubscriptionContract	De gebruiker heeft zich al geabonneerd op het product. Kopteksten ETag: string
201 Created	SubscriptionContract	De gebruiker is geabonneerd op het product. Kopteksten ETag: string
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Name

Type

Description

200 OK

SubscriptionContract

De gebruiker heeft zich al geabonneerd op het product.

Kopteksten

ETag: string

201 Created

SubscriptionContract

De gebruiker is geabonneerd op het product.

Kopteksten

ETag: string

Other Status Codes

ErrorResponse

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

ApiManagementCreateWorkspaceSubscription

Voorbeeldaanvraag

HTTP

PUT 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": {
    "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7",
    "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060002",
    "displayName": "testsub"
  }
}

Voorbeeldrespons

Statuscode:: 201

{
  "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/57127d485157a511ace86ae7",
    "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-02T23:34:03.1055076Z"
  }
}

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/57127d485157a511ace86ae7",
    "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-02T23:34:03.1055076Z"
  }
}

Definities

Name	Description
AppType	Bepaalt het type toepassing dat de aanvraag voor het maken van de gebruiker verzendt. De standaardinstelling is een verouderde portal.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
SubscriptionContract	Abonnementsgegevens.
SubscriptionCreateParameters	Details van abonnement maken.
SubscriptionState	Abonnementsstatus. Mogelijke statussen zijn * actief – het abonnement is actief, * opgeschort – het abonnement wordt geblokkeerd en de abonnee kan geen API's van het product aanroepen, * ingediend – de abonnementsaanvraag is ingediend door de ontwikkelaar, maar is nog niet goedgekeurd of afgewezen, * geweigerd – de abonnementsaanvraag is geweigerd door een beheerder, * geannuleerd – het abonnement is geannuleerd door de ontwikkelaar of beheerder, * verlopen – het abonnement heeft de vervaldatum bereikt en is gedeactiveerd.

AppType

Inventarisatie

Bepaalt het type toepassing dat de aanvraag voor het maken van de gebruiker verzendt. De standaardinstelling is een verouderde portal.

Waarde	Description
developerPortal	De aanvraag voor het maken van gebruikers is verzonden door de nieuwe ontwikkelaarsportal.
portal	Aanvraag voor het maken van gebruikers is verzonden door de verouderde ontwikkelaarsportal.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

SubscriptionContract

Object

Abonnementsgegevens.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	De naam van de resource
properties.allowTracing	boolean	Bepaalt of tracering is ingeschakeld
properties.createdDate	string (date-time)	De aanmaakdatum van het abonnement. De datum voldoet aan de volgende indeling: `yyyy-MM-ddTHH:mm:ssZ` zoals opgegeven door de ISO 8601-standaard.
properties.displayName	string minLength: 0 maxLength: 100	De naam van het abonnement of null als het abonnement geen naam heeft.
properties.endDate	string (date-time)	Datum waarop het abonnement is geannuleerd of verlopen. De instelling is alleen bedoeld voor controledoeleinden en het abonnement wordt niet automatisch geannuleerd. De levenscyclus van het abonnement kan worden beheerd met behulp van de eigenschap `state`. De datum voldoet aan de volgende indeling: `yyyy-MM-ddTHH:mm:ssZ` zoals opgegeven door de ISO 8601-standaard.
properties.expirationDate	string (date-time)	Vervaldatum van abonnement. De instelling is alleen bedoeld voor controledoeleinden en het abonnement is niet automatisch verlopen. De levenscyclus van het abonnement kan worden beheerd met behulp van de eigenschap `state`. De datum voldoet aan de volgende indeling: `yyyy-MM-ddTHH:mm:ssZ` zoals opgegeven door de ISO 8601-standaard.
properties.notificationDate	string (date-time)	Vervaldatum van het geplande abonnement. De datum voldoet aan de volgende indeling: `yyyy-MM-ddTHH:mm:ssZ` zoals opgegeven door de ISO 8601-standaard.
properties.ownerId	string	De gebruikersresource-id van de eigenaar van het abonnement. De waarde is een geldige relatieve URL in de indeling /users/{userId} waarbij {userId} een gebruikers-id is.
properties.primaryKey	string minLength: 1 maxLength: 256	Primaire abonnementssleutel. Deze eigenschap wordt niet ingevuld voor 'GET'-bewerkingen. Gebruik POST-aanvraag '/listSecrets' om de waarde op te halen.
properties.scope	string	Bereik zoals /products/{productId} of /apis of /apis/{apiId}.
properties.secondaryKey	string minLength: 1 maxLength: 256	Secundaire abonnementssleutel. Deze eigenschap wordt niet ingevuld voor 'GET'-bewerkingen. Gebruik POST-aanvraag '/listSecrets' om de waarde op te halen.
properties.startDate	string (date-time)	Activeringsdatum van abonnement. De instelling is alleen bedoeld voor controledoeleinden en het abonnement wordt niet automatisch geactiveerd. De levenscyclus van het abonnement kan worden beheerd met behulp van de eigenschap `state`. De datum voldoet aan de volgende indeling: `yyyy-MM-ddTHH:mm:ssZ` zoals opgegeven door de ISO 8601-standaard.
properties.state	SubscriptionState	Abonnementsstatus. Mogelijke statussen zijn * actief – het abonnement is actief, * opgeschort – het abonnement wordt geblokkeerd en de abonnee kan geen API's van het product aanroepen, * ingediend – de abonnementsaanvraag is ingediend door de ontwikkelaar, maar is nog niet goedgekeurd of afgewezen, * geweigerd – de abonnementsaanvraag is geweigerd door een beheerder, * geannuleerd – het abonnement is geannuleerd door de ontwikkelaar of beheerder, * verlopen – het abonnement heeft de vervaldatum bereikt en is gedeactiveerd.
properties.stateComment	string	Optionele abonnementscommentaar toegevoegd door een beheerder wanneer de status wordt gewijzigd in geweigerd.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

SubscriptionCreateParameters

Object

Details van abonnement maken.

Name	Type	Description
properties.allowTracing	boolean	Bepaalt of tracering kan worden ingeschakeld
properties.displayName	string minLength: 1 maxLength: 100	Abonnementsnaam.
properties.ownerId	string	Gebruiker (gebruikers-id-pad) voor wie het abonnement wordt gemaakt in de vorm /gebruikers/{userId}
properties.primaryKey	string minLength: 1 maxLength: 256	Primaire abonnementssleutel. Als deze niet is opgegeven tijdens de aanvraagsleutel, wordt automatisch gegenereerd.
properties.scope	string	Bereik zoals /products/{productId} of /apis of /apis/{apiId}.
properties.secondaryKey	string minLength: 1 maxLength: 256	Secundaire abonnementssleutel. Als deze niet is opgegeven tijdens de aanvraagsleutel, wordt automatisch gegenereerd.
properties.state	SubscriptionState	Initiële abonnementsstatus. Als er geen waarde is opgegeven, wordt het abonnement gemaakt met de status Verzonden. Mogelijke statussen zijn * actief – het abonnement is actief, * opgeschort – het abonnement wordt geblokkeerd en de abonnee kan geen API's van het product aanroepen, * ingediend – de abonnementsaanvraag is ingediend door de ontwikkelaar, maar is nog niet goedgekeurd of afgewezen, * geweigerd – de abonnementsaanvraag is geweigerd door een beheerder, * geannuleerd – het abonnement is geannuleerd door de ontwikkelaar of beheerder, * verlopen – het abonnement heeft de vervaldatum bereikt en is gedeactiveerd.

SubscriptionState

Inventarisatie

Abonnementsstatus. Mogelijke statussen zijn * actief – het abonnement is actief, * opgeschort – het abonnement wordt geblokkeerd en de abonnee kan geen API's van het product aanroepen, * ingediend – de abonnementsaanvraag is ingediend door de ontwikkelaar, maar is nog niet goedgekeurd of afgewezen, * geweigerd – de abonnementsaanvraag is geweigerd door een beheerder, * geannuleerd – het abonnement is geannuleerd door de ontwikkelaar of beheerder, * verlopen – het abonnement heeft de vervaldatum bereikt en is gedeactiveerd.

Waarde	Description
active
cancelled
expired
rejected
submitted
suspended

Delen via

Workspace Subscription - Create Or Update

URI-parameters

Aanvraagkoptekst

Aanvraagbody

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

ApiManagementCreateWorkspaceSubscription

Voorbeeldaanvraag

Voorbeeldrespons

Definities

AppType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

SubscriptionContract

SubscriptionCreateParameters

SubscriptionState

Aanvullende resources