Subscription - Create Or Update

Referens

Tjänst:: API Management

API-version:: 2024-05-01

Skapar eller uppdaterar prenumerationen för den angivna användaren till den angivna produkten.

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Namnet på API Management-tjänsten.
sid	path	True	string maxLength: 256 pattern: ^[^*#&+:<>?]+$	Prenumerationsentitetsidentifierare. Entiteten representerar associationen mellan en användare och en produkt i API Management.
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.
appType	query		AppType	Avgör vilken typ av program som skickar begäran om att skapa användare. Standardvärdet är den äldre utgivarportalen.
notify	query		boolean	Meddela ändring i prenumerationstillstånd. Om det är falskt ska du inte skicka något e-postmeddelande för ändring av prenumerationens tillstånd Om sant skickar du ett e-postmeddelande om ändring av prenumerationens tillstånd

Begärandehuvud

Name	Obligatorisk	Typ	Description
If-Match		string	ETag för entiteten. Krävs inte när du skapar en entitet, men krävs vid uppdatering av en entitet.

Begärandetext

Name	Obligatorisk	Typ	Description
properties.displayName	True	string minLength: 1 maxLength: 100	Prenumerationsnamn.
properties.scope	True	string	Omfång som /products/{productId} eller /apis eller /apis/{apiId}.
properties.allowTracing		boolean	Avgör om spårning kan aktiveras
properties.ownerId		string	Användare (sökväg för användar-ID) för vilken prenumerationen skapas i formuläret /users/{userId}
properties.primaryKey		string minLength: 1 maxLength: 256	Primär prenumerationsnyckel. Om den inte anges under begäran genereras nyckeln automatiskt.
properties.secondaryKey		string minLength: 1 maxLength: 256	Sekundär prenumerationsnyckel. Om den inte anges under begäran genereras nyckeln automatiskt.
properties.state		SubscriptionState	Ursprungligt prenumerationstillstånd. Om inget värde anges skapas prenumerationen med tillståndet Skickat. Möjliga tillstånd är * aktiva – prenumerationen är aktiv, * pausad – prenumerationen blockeras och prenumeranten kan inte anropa några API:er för produkten, * skickad – prenumerationsbegäran har gjorts av utvecklaren, men har ännu inte godkänts eller avvisats, * avvisats – prenumerationsbegäran har nekats av en administratör, * avbrutits – prenumerationen har avbrutits av utvecklaren eller administratören. * har upphört att gälla – prenumerationen nådde sitt utgångsdatum och inaktiverades.

Svar

Name	Typ	Description
200 OK	SubscriptionContract	Användaren prenumererar redan på produkten. Sidhuvuden ETag: string
201 Created	SubscriptionContract	Användaren prenumererade på produkten. Sidhuvuden ETag: string
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Name

Typ

Description

200 OK

SubscriptionContract

Användaren prenumererar redan på produkten.

Sidhuvuden

ETag: string

201 Created

SubscriptionContract

Användaren prenumererade på produkten.

Sidhuvuden

ETag: string

Other Status Codes

ErrorResponse

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

ApiManagementCreateSubscription

Exempelbegäran

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/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/products/5600b59475ff190048060002",
    "displayName": "testsub"
  }
}

Exempelsvar

Statuskod:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/testsub",
  "type": "Microsoft.ApiManagement/service/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/products/5600b59475ff190048060002",
    "displayName": "testsub",
    "state": "submitted",
    "createdDate": "2017-06-02T23:34:03.1055076Z"
  }
}

Statuskod:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/testsub",
  "type": "Microsoft.ApiManagement/service/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/products/5600b59475ff190048060002",
    "displayName": "testsub",
    "state": "submitted",
    "createdDate": "2017-06-02T23:34:03.1055076Z"
  }
}

Definitioner

Name	Description
AppType	Avgör vilken typ av program som skickar begäran om att skapa användare. Standardvärdet är den äldre utgivarportalen.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
SubscriptionContract	Prenumerationsinformation.
SubscriptionCreateParameters	Information om prenumerationsskapande.
SubscriptionState	Prenumerationstillstånd. Möjliga tillstånd är * aktiva – prenumerationen är aktiv, * pausad – prenumerationen blockeras och prenumeranten kan inte anropa några API:er för produkten, * skickad – prenumerationsbegäran har gjorts av utvecklaren, men har ännu inte godkänts eller avvisats, * avvisats – prenumerationsbegäran har nekats av en administratör, * avbrutits – prenumerationen har avbrutits av utvecklaren eller administratören. * har upphört att gälla – prenumerationen nådde sitt utgångsdatum och inaktiverades.

AppType

Uppräkning

Avgör vilken typ av program som skickar begäran om att skapa användare. Standardvärdet är den äldre utgivarportalen.

Värde	Description
developerPortal	Begäran om användarskapning skickades av den nya utvecklarportalen.
portal	Begäran om användarskapning skickades av den äldre utvecklarportalen.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

SubscriptionContract

Objekt

Prenumerationsinformation.

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Namnet på resursen
properties.allowTracing	boolean	Avgör om spårning är aktiverat
properties.createdDate	string (date-time)	Skapandedatum för prenumeration. Datumet överensstämmer med följande format: `yyyy-MM-ddTHH:mm:ssZ` enligt ISO 8601-standarden.
properties.displayName	string minLength: 0 maxLength: 100	Namnet på prenumerationen eller null om prenumerationen inte har något namn.
properties.endDate	string (date-time)	Datum då prenumerationen avbröts eller upphörde att gälla. Inställningen är endast i granskningssyfte och prenumerationen avbryts inte automatiskt. Prenumerationens livscykel kan hanteras med hjälp av egenskapen `state`. Datumet överensstämmer med följande format: `yyyy-MM-ddTHH:mm:ssZ` enligt ISO 8601-standarden.
properties.expirationDate	string (date-time)	Prenumerationens förfallodatum. Inställningen är endast i granskningssyfte och prenumerationen har inte upphört att gälla automatiskt. Prenumerationens livscykel kan hanteras med hjälp av egenskapen `state`. Datumet överensstämmer med följande format: `yyyy-MM-ddTHH:mm:ssZ` enligt ISO 8601-standarden.
properties.notificationDate	string (date-time)	Förfallodatum för kommande prenumeration. Datumet överensstämmer med följande format: `yyyy-MM-ddTHH:mm:ssZ` enligt ISO 8601-standarden.
properties.ownerId	string	Användarens resurs-ID för prenumerationsägaren. Värdet är en giltig relativ URL i formatet /users/{userId} där {userId} är en användaridentifierare.
properties.primaryKey	string minLength: 1 maxLength: 256	Prenumerationens primära nyckel. Den här egenskapen fylls inte i för GET-åtgärder! Använd POST-begäran för "/listSecrets" för att hämta värdet.
properties.scope	string	Omfång som /products/{productId} eller /apis eller /apis/{apiId}.
properties.secondaryKey	string minLength: 1 maxLength: 256	Prenumerationens sekundära nyckel. Den här egenskapen fylls inte i för GET-åtgärder! Använd POST-begäran för "/listSecrets" för att hämta värdet.
properties.startDate	string (date-time)	Aktiveringsdatum för prenumeration. Inställningen är endast i granskningssyfte och prenumerationen aktiveras inte automatiskt. Prenumerationens livscykel kan hanteras med hjälp av egenskapen `state`. Datumet överensstämmer med följande format: `yyyy-MM-ddTHH:mm:ssZ` enligt ISO 8601-standarden.
properties.state	SubscriptionState	Prenumerationstillstånd. Möjliga tillstånd är * aktiva – prenumerationen är aktiv, * pausad – prenumerationen blockeras och prenumeranten kan inte anropa några API:er för produkten, * skickad – prenumerationsbegäran har gjorts av utvecklaren, men har ännu inte godkänts eller avvisats, * avvisats – prenumerationsbegäran har nekats av en administratör, * avbrutits – prenumerationen har avbrutits av utvecklaren eller administratören. * har upphört att gälla – prenumerationen nådde sitt utgångsdatum och inaktiverades.
properties.stateComment	string	Valfri prenumerationskommentation som läggs till av en administratör när tillståndet ändras till "avvisad".
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

SubscriptionCreateParameters

Objekt

Information om prenumerationsskapande.

Name	Typ	Description
properties.allowTracing	boolean	Avgör om spårning kan aktiveras
properties.displayName	string minLength: 1 maxLength: 100	Prenumerationsnamn.
properties.ownerId	string	Användare (sökväg för användar-ID) för vilken prenumerationen skapas i formuläret /users/{userId}
properties.primaryKey	string minLength: 1 maxLength: 256	Primär prenumerationsnyckel. Om den inte anges under begäran genereras nyckeln automatiskt.
properties.scope	string	Omfång som /products/{productId} eller /apis eller /apis/{apiId}.
properties.secondaryKey	string minLength: 1 maxLength: 256	Sekundär prenumerationsnyckel. Om den inte anges under begäran genereras nyckeln automatiskt.
properties.state	SubscriptionState	Ursprungligt prenumerationstillstånd. Om inget värde anges skapas prenumerationen med tillståndet Skickat. Möjliga tillstånd är * aktiva – prenumerationen är aktiv, * pausad – prenumerationen blockeras och prenumeranten kan inte anropa några API:er för produkten, * skickad – prenumerationsbegäran har gjorts av utvecklaren, men har ännu inte godkänts eller avvisats, * avvisats – prenumerationsbegäran har nekats av en administratör, * avbrutits – prenumerationen har avbrutits av utvecklaren eller administratören. * har upphört att gälla – prenumerationen nådde sitt utgångsdatum och inaktiverades.

SubscriptionState

Uppräkning

Prenumerationstillstånd. Möjliga tillstånd är * aktiva – prenumerationen är aktiv, * pausad – prenumerationen blockeras och prenumeranten kan inte anropa några API:er för produkten, * skickad – prenumerationsbegäran har gjorts av utvecklaren, men har ännu inte godkänts eller avvisats, * avvisats – prenumerationsbegäran har nekats av en administratör, * avbrutits – prenumerationen har avbrutits av utvecklaren eller administratören. * har upphört att gälla – prenumerationen nådde sitt utgångsdatum och inaktiverades.

Värde	Description
active
cancelled
expired
rejected
submitted
suspended

Dela via

Subscription - Create Or Update

URI-parametrar

Begärandehuvud

Begärandetext

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

ApiManagementCreateSubscription

Exempelbegäran

Exempelsvar

Definitioner

AppType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

SubscriptionContract

SubscriptionCreateParameters

SubscriptionState

Ytterligare resurser