monitor.azure.com/v1api20230403

Package v1api20230403 contains API Schema definitions for the monitor v1api20230403 API group

Resource Types:

APIVersion (`string` alias)

Value	Description
"2023-04-03"

Account

Generator information: - Generated from: /monitor/resource-manager/Microsoft.Monitor/stable/2023-04-03/monitoringAccounts_API.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Monitor/accounts/{azureMonitorWorkspaceName}

Field Description

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
Account_Spec

`azureName` string	AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.
`location` string	Location: The geo-location where the resource lives
`owner` genruntime.KnownResourceReference	Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource
`publicNetworkAccess` AzureMonitorWorkspace_PublicNetworkAccess	PublicNetworkAccess: Gets or sets allow or disallow public network access to Azure Monitor Workspace
`tags` map[string]string	Tags: Resource tags.

status
Account_STATUS

Account_STATUS

(Appears on:Account)

Field	Description
`accountId` string	AccountId: The immutable Id of the Azure Monitor Workspace. This property is read-only.
`conditions` []genruntime/conditions.Condition	Conditions: The observed state of the resource
`defaultIngestionSettings` IngestionSettings_STATUS	DefaultIngestionSettings: The Data Collection Rule and Endpoint used for ingestion by default.
`etag` string	Etag: Resource entity tag (ETag)
`id` string	Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
`location` string	Location: The geo-location where the resource lives
`metrics` Metrics_STATUS	Metrics: Properties related to the metrics container in the Azure Monitor Workspace
`name` string	Name: The name of the resource
`privateEndpointConnections` []PrivateEndpointConnection_STATUS	PrivateEndpointConnections: List of private endpoint connections
`provisioningState` AzureMonitorWorkspace_ProvisioningState_STATUS	ProvisioningState: The provisioning state of the Azure Monitor Workspace. Set to Succeeded if everything is healthy.
`publicNetworkAccess` AzureMonitorWorkspace_PublicNetworkAccess_STATUS	PublicNetworkAccess: Gets or sets allow or disallow public network access to Azure Monitor Workspace
`systemData` SystemData_STATUS	SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information.
`tags` map[string]string	Tags: Resource tags.
`type` string	Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

Account_STATUS_ARM

Field	Description
`etag` string	Etag: Resource entity tag (ETag)
`id` string	Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
`location` string	Location: The geo-location where the resource lives
`name` string	Name: The name of the resource
`properties` AzureMonitorWorkspace_STATUS_ARM	Properties: Resource properties
`systemData` SystemData_STATUS_ARM	SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information.
`tags` map[string]string	Tags: Resource tags.
`type` string	Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

Account_Spec

(Appears on:Account)

Field	Description
`azureName` string	AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.
`location` string	Location: The geo-location where the resource lives
`owner` genruntime.KnownResourceReference	Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource
`publicNetworkAccess` AzureMonitorWorkspace_PublicNetworkAccess	PublicNetworkAccess: Gets or sets allow or disallow public network access to Azure Monitor Workspace
`tags` map[string]string	Tags: Resource tags.

Account_Spec_ARM

Field	Description
`location` string	Location: The geo-location where the resource lives
`name` string
`properties` AzureMonitorWorkspace_ARM	Properties: Resource properties
`tags` map[string]string	Tags: Resource tags.

AzureMonitorWorkspace_ARM

(Appears on:Account_Spec_ARM)

Properties of an Azure Monitor Workspace

Field	Description
`publicNetworkAccess` AzureMonitorWorkspace_PublicNetworkAccess	PublicNetworkAccess: Gets or sets allow or disallow public network access to Azure Monitor Workspace

AzureMonitorWorkspace_ProvisioningState_STATUS (`string` alias)

(Appears on:Account_STATUS, AzureMonitorWorkspace_STATUS_ARM)

Value	Description
"Canceled"
"Creating"
"Deleting"
"Failed"
"Succeeded"

AzureMonitorWorkspace_PublicNetworkAccess (`string` alias)

(Appears on:Account_Spec, AzureMonitorWorkspace_ARM)

Value	Description
"Disabled"
"Enabled"

AzureMonitorWorkspace_PublicNetworkAccess_STATUS (`string` alias)

(Appears on:Account_STATUS, AzureMonitorWorkspace_STATUS_ARM)

Value	Description
"Disabled"
"Enabled"

AzureMonitorWorkspace_STATUS_ARM

(Appears on:Account_STATUS_ARM)

Properties of an Azure Monitor Workspace

Field	Description
`accountId` string	AccountId: The immutable Id of the Azure Monitor Workspace. This property is read-only.
`defaultIngestionSettings` IngestionSettings_STATUS_ARM	DefaultIngestionSettings: The Data Collection Rule and Endpoint used for ingestion by default.
`metrics` Metrics_STATUS_ARM	Metrics: Properties related to the metrics container in the Azure Monitor Workspace
`privateEndpointConnections` []PrivateEndpointConnection_STATUS_ARM	PrivateEndpointConnections: List of private endpoint connections
`provisioningState` AzureMonitorWorkspace_ProvisioningState_STATUS	ProvisioningState: The provisioning state of the Azure Monitor Workspace. Set to Succeeded if everything is healthy.
`publicNetworkAccess` AzureMonitorWorkspace_PublicNetworkAccess_STATUS	PublicNetworkAccess: Gets or sets allow or disallow public network access to Azure Monitor Workspace

IngestionSettings_STATUS

(Appears on:Account_STATUS)

Settings for data ingestion

Field	Description
`dataCollectionEndpointResourceId` string	DataCollectionEndpointResourceId: The Azure resource Id of the default data collection endpoint for this Azure Monitor Workspace.
`dataCollectionRuleResourceId` string	DataCollectionRuleResourceId: The Azure resource Id of the default data collection rule for this Azure Monitor Workspace.

IngestionSettings_STATUS_ARM

(Appears on:AzureMonitorWorkspace_STATUS_ARM)

Settings for data ingestion

Field	Description
`dataCollectionEndpointResourceId` string	DataCollectionEndpointResourceId: The Azure resource Id of the default data collection endpoint for this Azure Monitor Workspace.
`dataCollectionRuleResourceId` string	DataCollectionRuleResourceId: The Azure resource Id of the default data collection rule for this Azure Monitor Workspace.

Metrics_STATUS

(Appears on:Account_STATUS)

Properties related to the metrics container in the Azure Monitor Workspace

Field	Description
`internalId` string	InternalId: An internal identifier for the metrics container. Only to be used by the system
`prometheusQueryEndpoint` string	PrometheusQueryEndpoint: The Prometheus query endpoint for the Azure Monitor Workspace

Metrics_STATUS_ARM

(Appears on:AzureMonitorWorkspace_STATUS_ARM)

Properties related to the metrics container in the Azure Monitor Workspace

Field	Description
`internalId` string	InternalId: An internal identifier for the metrics container. Only to be used by the system
`prometheusQueryEndpoint` string	PrometheusQueryEndpoint: The Prometheus query endpoint for the Azure Monitor Workspace

PrivateEndpointConnection_STATUS

(Appears on:Account_STATUS)

The private endpoint connection resource.

Field	Description
`id` string	Id: Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”

PrivateEndpointConnection_STATUS_ARM

(Appears on:AzureMonitorWorkspace_STATUS_ARM)

The private endpoint connection resource.

Field	Description
`id` string	Id: Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”

SystemData_CreatedByType_STATUS (`string` alias)

(Appears on:SystemData_STATUS, SystemData_STATUS_ARM)

Value	Description
"Application"
"Key"
"ManagedIdentity"
"User"

SystemData_LastModifiedByType_STATUS (`string` alias)

(Appears on:SystemData_STATUS, SystemData_STATUS_ARM)

Value	Description
"Application"
"Key"
"ManagedIdentity"
"User"

SystemData_STATUS

(Appears on:Account_STATUS)

Metadata pertaining to creation and last modification of the resource.

Field	Description
`createdAt` string	CreatedAt: The timestamp of resource creation (UTC).
`createdBy` string	CreatedBy: The identity that created the resource.
`createdByType` SystemData_CreatedByType_STATUS	CreatedByType: The type of identity that created the resource.
`lastModifiedAt` string	LastModifiedAt: The timestamp of resource last modification (UTC)
`lastModifiedBy` string	LastModifiedBy: The identity that last modified the resource.
`lastModifiedByType` SystemData_LastModifiedByType_STATUS	LastModifiedByType: The type of identity that last modified the resource.

SystemData_STATUS_ARM

(Appears on:Account_STATUS_ARM)

Metadata pertaining to creation and last modification of the resource.

Field	Description
`createdAt` string	CreatedAt: The timestamp of resource creation (UTC).
`createdBy` string	CreatedBy: The identity that created the resource.
`createdByType` SystemData_CreatedByType_STATUS	CreatedByType: The type of identity that created the resource.
`lastModifiedAt` string	LastModifiedAt: The timestamp of resource last modification (UTC)
`lastModifiedBy` string	LastModifiedBy: The identity that last modified the resource.
`lastModifiedByType` SystemData_LastModifiedByType_STATUS	LastModifiedByType: The type of identity that last modified the resource.

monitor.azure.com/v1api20230403