Offers - Unlink

Unlink a plan from an offer.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Subscriptions.Admin/offers/{offer}/unlink?api-version=2015-11-01

URI Parameters

Name In Required Type Description
offer
path True
  • string

Name of an offer.

resourceGroupName
path True
  • string

The resource group the resource is located under.

subscriptionId
path True
  • string

Subscription credentials which uniquely identify Microsoft Azure subscription.The subscription ID forms part of the URI for every service call.

api-version
query True
  • string

Client Api Version.

Request Body

Name Type Description
maxAcquisitionCount
  • integer

The maximum acquisition count by subscribers

planLinkType

Type of the plan link.

planName
  • string

Name of the plan.

Responses

Name Type Description
200 OK

OK

Security

azure_auth

Azure Active Directory OAuth2 flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Sample Request

POST https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/RG1/providers/Microsoft.Subscriptions.Admin/offers/sampleoffer1/unlink?api-version=2015-11-01
{
  "properties": {
    "planName": "SamplePlan",
    "planLinkType": "Addon"
  }
}

Sample Response

{
  "id": "/subscriptions/36a6bf33-6df4-4acd-a30e-7b92c1c7b322/resourceGroups/RG1/providers/Microsoft.Subscriptions.Admin/offers/sampleoffer1",
  "name": "sampleoffer1",
  "type": "Microsoft.Subscriptions.Admin/offers",
  "location": "local",
  "tags": {},
  "properties": {
    "name": "sampleoffer1",
    "displayName": "sampleoffer1",
    "state": "Public",
    "subscriptionCount": 2,
    "maxSubscriptionsPerAccount": 0,
    "basePlanIds": [
      "/subscriptions/36a6bf33-6df4-4acd-a30e-7b92c1c7b322/resourceGroups/RG1/providers/Microsoft.Subscriptions.Admin/plans/SamplePlan"
    ],
    "addonPlans": []
  }
}

Definitions

AccessibilityState

Represents the state of the offer

AddonPlanDefinition

Contains the name of the desired plan to be linked or unlinked from an offer.

Offer

Represents an offering of services against which a subscription can be created.

PlanLinkDefinition

Definition for linking and unlinking plans to offers.

PlanLinkType

Plan link type.

AccessibilityState

Represents the state of the offer

Name Type Description
Decommissioned
  • string

The offer or plan is decommissioned. Current subscriptions can still consume it but new subscriptions cannot.

Private
  • string

The offer or plan is private. Only an Admin can see and manage it.

Public
  • string

The offer or plan is public. Users can see and self-subscribe to it.

AddonPlanDefinition

Contains the name of the desired plan to be linked or unlinked from an offer.

Name Type Description
maxAcquisitionCount
  • integer

Maximum number of instances that can be acquired by a single subscription. If not specified, the assumed value is 1.

planId
  • string

Plan identifier.

Offer

Represents an offering of services against which a subscription can be created.

Name Type Description
id
  • string

URI of the resource.

location
  • string

Location of the resource

name
  • string

Name of the resource.

properties.addonPlans

References to add-on plans that a tenant can optionally acquire as a part of the offer.

properties.basePlanIds
  • string[]

Identifiers of the base plans that become available to the tenant immediately when a tenant subscribes to the offer.

properties.description
  • string

Description of offer.

properties.displayName
  • string

Display name of offer.

properties.externalReferenceId
  • string

External reference identifier.

properties.maxSubscriptionsPerAccount
  • integer

Maximum subscriptions per account.

properties.name
  • string

Name of the Offer.

properties.state

Offer accessibility state.

properties.subscriptionCount
  • integer

Current subscription count.

tags
  • object

List of key-value pairs.

type
  • string

Type of resource.

PlanLinkDefinition

Definition for linking and unlinking plans to offers.

Name Type Description
maxAcquisitionCount
  • integer

The maximum acquisition count by subscribers

planLinkType

Type of the plan link.

planName
  • string

Name of the plan.

PlanLinkType

Plan link type.

Name Type Description
Addon
  • string
Base
  • string
None
  • string