FreeServices interface

Free Services resource definition

Extends

Properties

billingAccountResourceId

Billing account resource id where the free services metadata is present.

billingProfileResourceId

Billing profile resource id where the free services are scoped to.

customerResourceId

Customer resource id where the free services are scoped to.

endAt

Expiration date and time of the free services

etag

The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.

identity

Managed service identity (system assigned and/or user assigned identities)

kind

Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.

managedBy

The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.

plan

Plan for the resource.

productCode

This is the catalog UPN for the product.

provisioningState

Provisioning state of Free Services as assigned by RPaaS. This indicates the last operation's status. For all practical purposes, this can be ignored. For current status of Free Services resource, refer to FreeServicesStatus.

sku

The resource model definition representing SKU

startAt

Date and time when the free services become active

status

Current status of the free services

systemId

This is the globally unique identifier of the free services which will not change for its lifetime.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

The geo-location where the resource lives

name

The name of the resource

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

tags

Resource tags.

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Property Details

billingAccountResourceId

Billing account resource id where the free services metadata is present.

billingAccountResourceId?: string

Property Value

string

billingProfileResourceId

Billing profile resource id where the free services are scoped to.

billingProfileResourceId?: string

Property Value

string

customerResourceId

Customer resource id where the free services are scoped to.

customerResourceId?: string

Property Value

string

endAt

Expiration date and time of the free services

endAt?: Date

Property Value

Date

etag

The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.

etag?: string

Property Value

string

identity

Managed service identity (system assigned and/or user assigned identities)

identity?: ManagedServiceIdentity

Property Value

kind

Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.

kind?: string

Property Value

string

managedBy

The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.

managedBy?: string

Property Value

string

plan

Plan for the resource.

plan?: Plan

Property Value

productCode

This is the catalog UPN for the product.

productCode?: string

Property Value

string

provisioningState

Provisioning state of Free Services as assigned by RPaaS. This indicates the last operation's status. For all practical purposes, this can be ignored. For current status of Free Services resource, refer to FreeServicesStatus.

provisioningState?: string

Property Value

string

sku

The resource model definition representing SKU

sku?: Sku

Property Value

Sku

startAt

Date and time when the free services become active

startAt?: Date

Property Value

Date

status

Current status of the free services

status?: string

Property Value

string

systemId

This is the globally unique identifier of the free services which will not change for its lifetime.

systemId?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

Inherited From TrackedResource.systemData

tags

Resource tags.

tags?: Record<string, string>

Property Value

Record<string, string>

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From TrackedResource.type